Skip to content

Commit 2733f62

Browse files
supernovahssupernovahspablodeymo
authored
add eigensdk install command, update crates info, update test command in readme (#135)
Co-authored-by: supernovahs <supernovahs@proton.me> Co-authored-by: Pablo Deymonnaz <deymonnaz@gmail.com>
1 parent 19e5c05 commit 2733f62

File tree

2 files changed

+34
-22
lines changed

2 files changed

+34
-22
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ eigensdk-rs is an initiative for rust developers to build AVSs on eigenlayer.
55

66
## Installation
77

8-
9-
10-
8+
```bash
9+
cargo install eigensdk --features full
10+
```
1111
## Overview
1212

1313
List of crates in the repository :-

crates/eigensdk/README.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
1-
# eigen-rs
1+
# eigensdk-rs
22

3-
Rust <> EigenLayer developer tools
3+
eigensdk-rs is an initiative for rust developers to build AVSs on eigenlayer.
44

5-
![eigen-rs](https://github.com/user-attachments/assets/bf1d1090-db70-487a-a49a-40f727849251)
5+
## Installation
6+
7+
```bash
8+
cargo install eigensdk --features full
9+
```
610

711
## Overview
812

9-
List of crates in the repository :-
13+
List of crates in the repository :-
1014

1115
- [eigen-client-avsregistry](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/chainio/clients/avsregistry) - Read, Write and subscribe methods for AvsRegistry
1216
- [eigen-client-elcontracts](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/chainio/clients/elcontracts) - Convenience methods to call Eigenlayer contracts
1317
- [eigen-contracts-bindings](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/contracts/bindings) - Generate ethers bindings for Eigen Layer.
14-
- [eigen-crypto-bls](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/crypto/bls) - bls utilities
15-
- [eigen-crypto-bn254](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/crypto/bn254) - bn254 utilities
16-
- [eigen-metrics](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/metrics) - performance , rpc and economic metrics
17-
- [eigen-services](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/services) - Spawn tokio services for operators info , bls aggregation
18+
- [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.
19+
- [eigen-crypto-bn254](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/crypto/bn254) - verify message on G2, map to curve.
20+
- [eigen-metrics](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/metrics) - performance, rpc and economic metrics
21+
- [eigen-services](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/services) - Spawn tokio services for operators info, bls aggregation
1822
- [eigen-types](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/types) - Common types
1923
- [eigen-utils](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/utils) - Publicly exportable `m2-mainnet` compatible alloy bindings.
20-
- [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 .
24+
- [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.
25+
- [eigen-chainio-txmanager](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/chainio/txmanager) - Simple transaction manager.
26+
- [eigen-cli](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/eigen-cli) - ECDSA, BLS keystore cli
27+
- [eigen-nodeapi](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/nodeapi) - NodeApi implementation for EigenLayer.
28+
- [eigen-logging](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/logging) - Logging utilities
2129

2230
## Examples
2331

@@ -31,20 +39,26 @@ cargo run --example get_quorum_count
3139

3240
## Contributor Guidelines
3341

34-
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.
42+
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.
3543

3644
### PR
3745

38-
To test locally and raise a PR :-
46+
To test locally :-
3947

40-
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.
48+
You need `foundry`to successfully to run it.
4149

4250
```bash
43-
make pr
51+
cargo test
4452
```
4553

4654
At least 1 `approving` review is required to merge the PR.
4755

56+
### lint
57+
58+
```bash
59+
make lint
60+
```
61+
4862
### To run fireblocks tests
4963

5064
Add the following variables to your env
@@ -60,8 +74,6 @@ make fireblocks-tests
6074

6175
```
6276

63-
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.
64-
6577
### Test Coverage
6678

6779
Test coverage should aim to be around 80%.
@@ -82,7 +94,7 @@ make coverage
8294

8395
Open the coverage html report in a web browser:
8496

85-
```bash
97+
```sh
8698
open target/llvm-cov/html/index.html
8799
```
88100

@@ -96,12 +108,12 @@ This software is `unaudited`.This is experimental software and is provided on an
96108

97109
## Credits
98110

99-
- [Layer-labs](https://github.com/Layr-Labs/eigensdk-go/tree/master)
111+
- [eigensdk-go](https://github.com/Layr-Labs/eigensdk-go/tree/master)
100112

101113
## Security Bugs
102114

103115
Please report security vulnerabilities to <security@eigenlabs.org>. Do NOT report security bugs via Github Issues.
104116

105-
## Contact
117+
## Support
106118

107-
Telegram - supernovahs444
119+
Join our [telegram](https://t.me/+0_kYjD7TTCRjMjZh) channel .

0 commit comments

Comments
 (0)