readme wip

README.md

@@ -1,8 +1,12 @@
-# eigen-rs
+# eigensdk-rs
+
+eigensdk-rs is an initiative for rust developers to build AVSs on eigenlayer.
+
+
+## Installation
+
 
-Rust <> EigenLayer developer tools
 
-![eigen-rs](https://github.com/user-attachments/assets/bf1d1090-db70-487a-a49a-40f727849251)
 
 ## Overview
 
@@ -12,8 +16,8 @@ List of crates in the repository :-
 - [eigen-client-elcontracts](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/chainio/clients/elcontracts) - Convenience methods to call Eigenlayer contracts
 - [eigen-chainio-utils](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/chainio/utils)
 - [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-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
@@ -36,15 +40,20 @@ cargo run --example get_quorum_count
 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 
-To test locally and raise a PR :-
+To test locally :-
 
 
-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.
+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.
 
+
+### lint
+```
+make lint
+```
 ### To run fireblocks tests 
 
 Add the following variables to your env 
@@ -59,7 +68,6 @@ Add the following variables to your env
 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%.
@@ -88,7 +96,7 @@ 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
-- [Layer-labs](https://github.com/Layr-Labs/eigensdk-go/tree/master)
+- [eigensdk-go](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.