https://github.com/limechain/avalanche-client
https://github.com/limechain/avalanche-client
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/limechain/avalanche-client
- Owner: LimeChain
- Created: 2023-10-16T07:02:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-17T11:00:52.000Z (over 2 years ago)
- Last Synced: 2025-01-23T08:18:04.042Z (over 1 year ago)
- Language: Rust
- Size: 44.9 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# avalanche-client
A Rust client for Avalanche based on [avalanche-rs](https://github.com/ava-labs/avalanche-rs)
## Client Capabilities
At the moment, the client can:
- Establish TLS connection to a **local** peer
- Compose and send `Version` message
- Receive and validate the peer's `Version` message
- Receive and deserialize `PeerList` message
- Listen and decode other inbound network messages(no message handlers have been implemented yet)
At some point, the client won't respond to the `Ping` message and the peer will disconnect.
## Running Locally
To run the client locally, you'll need to have a local avalanchego(v1.10.11) node running. You can see how to run such a node [here](https://github.com/ava-labs/avalanchego).
Note that the README requires you to have go version 1.20.8 or higher, but it actually doesn't build with 1.20.8 and with 1.21.x so your version needs to be: 1.20.10 <= GO_VERSION < 1.21.0
Change the first mainnet in `genesis/bootstrappers.json` to have the localhost address `127.0.0.1:9651`, you can then run `cargo run` to run the Rust client in debug mode.