Skip to content

Commit

Permalink
Aesthetic improvements in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
pablodeymo committed Sep 30, 2024
1 parent 425031f commit 0423aad
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions crates/eigensdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

eigensdk-rs is an initiative for rust developers to build AVSs on eigenlayer.


## Installation

```bash
cargo install eigensdk --features full
```
## Overview

## 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-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) - New bls key pair, sign message, conversion utilites between alloy and arkworks bn254.
Expand All @@ -27,7 +27,6 @@ cargo install eigensdk --features full
- [eigen-nodeapi](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/nodeapi) - NodeApi implementation for EigenLayer.
- [eigen-logging](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/logging) - Logging utilities


## Examples

You can run any [example](https://github.com/Layr-Labs/eigensdk-rs/tree/main/examples) using the command `cargo run --example <example-name>`
Expand All @@ -42,22 +41,25 @@ 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
### PR

To test locally :-

You need `foundry`to successfully to run it.

```bash
cargo test
```

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


### lint

```bash
make lint
```
### To run fireblocks tests

### To run fireblocks tests

Add the following variables to your env

Expand Down Expand Up @@ -105,8 +107,8 @@ 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)

- [eigensdk-go](https://github.com/Layr-Labs/eigensdk-go/tree/master)

## Security Bugs

Expand Down

0 comments on commit 0423aad

Please sign in to comment.