-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
supernovahs
committed
Sep 26, 2024
1 parent
405c5f8
commit d9f0c38
Showing
1 changed file
with
26 additions
and
20 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,23 +1,27 @@ | ||
| # eigen-rs | ||
| # eigensdk-rs | ||
|
|
||
| Rust <> EigenLayer developer tools | ||
| eigensdk-rs is an initiative for rust developers to build AVSs on eigenlayer. | ||
|
|
||
|  | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| cargo install eigensdk --features full | ||
| ``` | ||
| ## Overview | ||
|
|
||
| List of crates in the repository :- | ||
|
|
||
| - [eigen-client-avsregistry](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/chainio/clients/avsregistry) - Read, Write and subscribe methods for AvsRegistry | ||
| - [eigen-client-elcontracts](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/chainio/clients/elcontracts) - Convenience methods to call Eigenlayer contracts | ||
| - [eigen-contracts-bindings](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/contracts/bindings) - Generate ethers bindings for Eigen Layer. | ||
| - [eigen-crypto-bls](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/crypto/bls) - bls utilities | ||
| - [eigen-crypto-bn254](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/crypto/bn254) - bn254 utilities | ||
| - [eigen-metrics](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/metrics) - performance , rpc and economic metrics | ||
| - [eigen-services](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/services) - Spawn tokio services for operators info , bls aggregation | ||
| - [eigen-crypto-bls](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/crypto/bls) - New bls key pair, sign message, conversion utilites between alloy and arkworks bn254. | ||
| - [eigen-crypto-bn254](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/crypto/bn254) - verify message on G2, map to curve. | ||
| - [eigen-metrics](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/metrics) - performance, rpc and economic metrics | ||
| - [eigen-services](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/services) - Spawn tokio services for operators info, bls aggregation | ||
| - [eigen-types](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/types) - Common types | ||
| - [eigen-utils](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/utils) - Publicly exportable `m2-mainnet` compatible alloy bindings. | ||
| - [eigen-testing-utils](https://github.com/Layr-Labs/eigensdk-rs/tree/main/testing/testing-utils) - Contains publicly exportable anvil , holesky , mainnet addresses for eigen contracts . | ||
| - [eigen-testing-utils](https://github.com/Layr-Labs/eigensdk-rs/tree/main/testing/testing-utils) - Contains publicly exportable anvil, holesky, mainnet addresses for eigen contracts. | ||
|
|
||
| ## Examples | ||
|
|
||
|
|
@@ -31,21 +35,25 @@ cargo run --example get_quorum_count | |
|
|
||
| ## Contributor Guidelines | ||
|
|
||
| We are actively looking for contributors. Thank you for your interest. We have strict ci checks in place. In case of any questions and support , feel free to raise an issue. | ||
| We are actively looking for contributors. Thank you for your interest. We have strict ci checks in place. In case of any questions and support, feel free to raise an issue. | ||
|
|
||
| ### PR | ||
| ### PR | ||
| To test locally :- | ||
|
|
||
| To test locally and raise a PR :- | ||
|
|
||
| You need `foundry` , `docker` and `make` and `nightly rust` to successfully run it. Also, the `docker` engine has to be running for all the tests to execute correctly. | ||
|
|
||
| ```bash | ||
| You need `foundry` , `docker` and `make` to successfully run it. Also, the `docker` engine has to be running for all the tests to execute correctly. | ||
| ``` | ||
| make pr | ||
| ``` | ||
|
|
||
| At least 1 `approving` review is required to merge the PR. | ||
|
|
||
| ### To run fireblocks tests | ||
|
|
||
| ### lint | ||
| ``` | ||
| make lint | ||
| ``` | ||
| ### To run fireblocks tests | ||
|
|
||
| Add the following variables to your env | ||
|
|
||
|
|
@@ -60,8 +68,6 @@ make fireblocks-tests | |
|
|
||
| ``` | ||
|
|
||
| Note: The tests were written using sandbox environment , you would need to modify the testing parameters according to your own asset id's , tx-id etc. | ||
|
|
||
| ### Test Coverage | ||
|
|
||
| Test coverage should aim to be around 80%. | ||
|
|
@@ -95,13 +101,13 @@ Rolling `MSRV` policy of 6 months. The current `MSRV` is 1.79 | |
| This software is `unaudited`.This is experimental software and is provided on an "as is" and "as available" basis and may not work at all. It should not be used in production. | ||
|
|
||
| ## Credits | ||
| - [eigensdk-go](https://github.com/Layr-Labs/eigensdk-go/tree/master) | ||
|
|
||
| - [Layer-labs](https://github.com/Layr-Labs/eigensdk-go/tree/master) | ||
|
|
||
| ## Security Bugs | ||
|
|
||
| Please report security vulnerabilities to <[email protected]>. Do NOT report security bugs via Github Issues. | ||
|
|
||
| ## Contact | ||
| ## Support | ||
|
|
||
| Telegram - supernovahs444 | ||
| Join our [telegram](https://t.me/+0_kYjD7TTCRjMjZh) channel . | ||