From 6f19a60d3ddb7963eff728fa02243c13558afc1c Mon Sep 17 00:00:00 2001 From: Pablo Deymonnaz Date: Fri, 3 Jan 2025 15:00:22 -0300 Subject: [PATCH] Contract Bindings section in the README (#178) Co-authored-by: tomasarrachea --- README.md | 21 ++++++++++++++++++++- crates/eigensdk/README.md | 20 ++++++++++++++++++++ 2 files changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c8e5649..ef90011f 100644 --- a/README.md +++ b/README.md @@ -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 /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: `/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. @@ -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) diff --git a/crates/eigensdk/README.md b/crates/eigensdk/README.md index 29afde54..3c960d13 100644 --- a/crates/eigensdk/README.md +++ b/crates/eigensdk/README.md @@ -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 /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: `/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.