-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Initial readme template * Add Eiger section * Marcin fixes
- Loading branch information
Showing
1 changed file
with
56 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,41 @@ | ||
# Solana Axelar Interoperability | ||
# Solana-Axelar Interoperability | ||
|
||
Monorepo for code around Solana Axelar interoperatbility. | ||
This repository contains the under-development integration work between Solana and Axelar, enabling seamless cross-chain communication. The project includes General Message Passing (GMP) contracts and off-chain services for event monitoring and transaction broadcasting. | ||
|
||
## Table of Contents | ||
|
||
- [Repository contents](#repository-contents) | ||
- [EVM Smart Contracts](#evm-smart-contracts) | ||
- [Solana contracts](#solana-contracts) | ||
- [Offchain microservices](#offchain-microservices) | ||
- [Getting Started](#getting-started) | ||
- [Prerequisites](#prerequisites) | ||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
|
||
|
||
## Repository contents | ||
|
||
### EVM Smart Contracts | ||
- **placeholder Contract name**: [Description Needed] | ||
- **placeholder Contract name**: [Description Needed] | ||
|
||
### Solana contracts | ||
- **Event Listener**: [Description Needed] | ||
|
||
### Offchain microservices | ||
- **Relayer**: [Description Needed] | ||
|
||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
- [List of prerequisites, e.g., Rust, Solana CLI, Axelar SDK, etc.] | ||
|
||
### Installation | ||
|
||
```bash | ||
# Clone the repo (& init submodules) | ||
|
@@ -9,3 +44,22 @@ git clone --recurse-submodules <repo url> | |
# if the repo has already been cloned you need to fetch the submodules | ||
git submodule update --init --recursive | ||
``` | ||
|
||
### Usage | ||
|
||
- [Instructions on how to run the project, deploy contracts, etc.] | ||
|
||
## Contributing | ||
|
||
- [Guidelines for contributing to the repo, including pull request processes, coding standards, etc.] | ||
|
||
## License | ||
|
||
- [Details about the licensing of the project] | ||
|
||
## About [Eiger](https://www.eiger.co) | ||
|
||
We are engineers. We contribute to various ecosystems by building low level implementations and core components. We work on several Axelar and Solana projects and believe that connecting these two is a very important goal to achieve cross-chain execution. | ||
|
||
Contact us at [email protected] | ||
Follow us on [X/Twitter](https://x.com/eiger_co) |