Skip to content

Commit

Permalink
Contract Bindings section in the README (#178)
Browse files Browse the repository at this point in the history
Co-authored-by: tomasarrachea <[email protected]>
  • Loading branch information
pablodeymo and TomasArrachea authored Jan 3, 2025
1 parent fadbe67 commit 6f19a60
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,26 @@ Example :
cargo run --example get_quorum_count
```

## Contract Bindings

The main branch of this repo is intended to be syncronized with mainnet version of core contracts.

To update the bindings of this repo:

- Inside the `crates/contracts` folder, run:

```bash
forge bind --alloy --bindings-path <path-eigensdk-rs>/crates/utils --overwrite -C src/contracts
```

where `path-eigensdk-rs` is the full path to the eigensdk-rs (this) repo.

This command will generate the bindings files in the folder: `<path-eigensdk-rs>/crates/utils`.

⚠️ It rewrites Cargo.toml file, this file must be restored to the current version.

- Fix all compilation warnings.

## 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.
Expand Down Expand Up @@ -105,7 +125,6 @@ Rolling `MSRV` policy of 6 months. The current `MSRV` is 1.79

🚧 Eigensdk-rs is under active development and has not been audited. Eigensdk-rs is rapidly being upgraded, features may be added, removed or otherwise improved or modified and interfaces will have breaking changes. Eigensdk-rs should be used only for testing purposes and not in production. Eigensdk-rs is provided "as is" and Eigen Labs, Inc. does not guarantee its functionality or provide support for its use in production. 🚧


## Credits

- [eigensdk-go](https://github.com/Layr-Labs/eigensdk-go/tree/master)
Expand Down
20 changes: 20 additions & 0 deletions crates/eigensdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,26 @@ Example :
cargo run --example get_quorum_count
```

## Contract Bindings

The main branch of this repo is intended to be syncronized with mainnet version of core contracts.

To update the bindings of this repo:

- Inside the `crates/contracts` folder, run:

```bash
forge bind --alloy --bindings-path <path-eigensdk-rs>/crates/utils --overwrite -C src/contracts
```

where `path-eigensdk-rs` is the full path to the eigensdk-rs (this) repo.

This command will generate the bindings files in the folder: `<path-eigensdk-rs>/crates/utils`.

⚠️ It rewrites Cargo.toml file, this file must be restored to the current version.

- Fix all compilation warnings.

## 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.
Expand Down

0 comments on commit 6f19a60

Please sign in to comment.