Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: merge main to dev #203

Merged
merged 4 commits into from
Jan 9, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: sync both READMEs
MegaRedHand committed Jan 9, 2025

Verified

This commit was signed with the committer’s verified signature.
snyk-bot Snyk bot
commit 106824804f8157becabc835f9710fc7573125194
22 changes: 18 additions & 4 deletions crates/eigensdk/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# eigensdk-rs
# EigenSDK-rs

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

## Installation

@@ -62,18 +62,32 @@ We are actively looking for contributors. Thank you for your interest. We have s
## Branches

- `main` - Points to the latest **mainnet** release of contracts.
- `dev` - Points to the latest **testnet** release of contracts.
- `testnet` - Points to the latest **testnet** release of contracts.
- `dev` - Points to the latest **dev** branch of the contracts.

### PR

To test locally :-

You need `foundry`to successfully to run it.
You need `foundry` to successfully to run it.

```bash
cargo test
```

On Mac, you might need to pull the foundry image manually specifying the platform with:

```bash
docker pull --platform amd64 foundry-rs/foundry
```

Sometimes the bindings fail due to containing botched doctests.
You can exclude them from the test run with:

```bash
cargo test --workspace --exclude eigen-utils
```

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

### lint