Skip to content

Commit

Permalink
Removed unused empty crate chainio/utils (#128)
Browse files Browse the repository at this point in the history
  • Loading branch information
pablodeymo authored Sep 23, 2024
1 parent b9f4edf commit dd4de7f
Show file tree
Hide file tree
Showing 10 changed files with 60 additions and 77 deletions.
6 changes: 0 additions & 6 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 2 additions & 6 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ members = [
"crates/chainio/clients/eth/",
"crates/chainio/clients/fireblocks/",
"crates/chainio/txmanager/",
"crates/chainio/utils/",
"crates/contracts/bindings/",
"crates/crypto/bls/",
"crates/crypto/bn254/",
Expand Down Expand Up @@ -60,7 +59,6 @@ aws-config = "1.5.4"
aws-sdk-kms = "1.37.0"
clap = { version = "4.5.11", features = ["derive"] }
eigen-chainio-txmanager = { path = "crates/chainio/txmanager/" }
eigen-chainio-utils = { path = "crates/chainio/utils/" }
eigen-client-avsregistry = { path = "crates/chainio/clients/avsregistry" }
eigen-client-elcontracts = { path = "crates/chainio/clients/elcontracts" }
eigen-client-eth = { path = "crates/chainio/clients/eth" }
Expand All @@ -79,7 +77,7 @@ eigen-signer = { path = "crates/signer/" }
eigen-testing-utils = { path = "testing/testing-utils" }
eigen-types = { path = "crates/types/" }
eigen-utils = { path = "crates/utils/" }
eigen-nodeapi = {path = "crates/nodeapi/"}
eigen-nodeapi = { path = "crates/nodeapi/" }
eth-keystore = "0.5.0"
ethers = "2.0.14"
ethers-signers = "2.0.14"
Expand Down Expand Up @@ -113,9 +111,7 @@ tracing-subscriber = { version = "0.3", features = ["json"] }
url = "2.5.2"

#misc
rust-bls-bn254 = { version = "0.2.0", features = [
"std",
] }
rust-bls-bn254 = { version = "0.2.0", features = ["std"] }
uuid = { version = "1.10.0", features = ["v4"] }


Expand Down
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ 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-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
Expand All @@ -20,7 +19,6 @@ List of crates in the repository :-
- [eigen-utils](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/utils) - Publicly exportable `m2-mainnet` compatible alloy bindings.
- [eigen-testing-utils](https://github.com/Layr-Labs/eigensdk-rs/tree/main/testing/testing-utils) - Contains publicly exportable anvil , holesky , mainnet addresses for eigen contracts .


## 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 @@ -35,21 +33,23 @@ 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 :-
### PR

To test locally and raise a PR :-

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.

```bash
make pr
```

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

### To run fireblocks tests
### To run fireblocks tests

Add the following variables to your env
Add the following variables to your env

- FIREBLOCKS_API_KEY
- FIREBLOCKS_API_KEY
- FIREBLOCKS_PRIVATE_KEY_PATH
- FIREBLOCKS_API_URL

Expand All @@ -59,40 +59,49 @@ 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.

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%.

Here's how to generate test coverage reports:

Install llvm tools:

```bash
make deps
```

Run the tests with coverage instrumentations:

```bash
make coverage
```

Open the coverage html report in a web browser:

```bash
open target/llvm-cov/html/index.html
```

## Supported Rust Version

Rolling `MSRV` policy of 6 months. The current `MSRV` is 1.79

## Disclaimer

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)

# Security Bugs
Please report security vulnerabilities to [email protected]. Do NOT report security bugs via Github Issues.

Please report security vulnerabilities to <[email protected]>. Do NOT report security bugs via Github Issues.

## Support
Join our [telegram](https://t.me/+0_kYjD7TTCRjMjZh) channel .

Join our [telegram](https://t.me/+0_kYjD7TTCRjMjZh) channel .
11 changes: 0 additions & 11 deletions crates/chainio/utils/Cargo.toml

This file was deleted.

2 changes: 0 additions & 2 deletions crates/chainio/utils/README.md

This file was deleted.

4 changes: 0 additions & 4 deletions crates/chainio/utils/src/lib.rs

This file was deleted.

43 changes: 20 additions & 23 deletions crates/eigensdk/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,26 @@ description = "SDK for eigenlayer"
license-file.workspace = true

[dependencies]
eigen-chainio-txmanager = {workspace = true, optional = true}
eigen-chainio-utils = {workspace = true, optional = true}
eigen-client-avsregistry = {workspace = true, optional = true}
eigen-client-elcontracts = {workspace = true, optional = true}
eigen-client-eth = {workspace = true, optional = true}
eigen-client-fireblocks = {workspace = true, optional = true}
eigen-contract-bindings = {workspace = true, optional = true}
eigen-crypto-bls = {workspace = true, optional = true}
eigen-crypto-bn254 = {workspace = true, optional = true}
eigen-logging = {workspace = true, optional = true}
eigen-metrics = {workspace = true, optional = true}
eigen-metrics-collectors-economic = {workspace = true, optional = true}
eigen-metrics-collectors-rpc-calls = {workspace = true, optional = true}
eigen-services-avsregistry = {workspace = true, optional = true}
eigen-services-blsaggregation = {workspace = true, optional = true}
eigen-services-operatorsinfo = {workspace = true, optional = true}
eigen-signer = {workspace = true, optional = true}
eigen-testing-utils = {workspace = true, optional = true}
eigen-types = {workspace = true, optional = true}
eigen-utils = {workspace = true, optional = true}
eigen-nodeapi = {workspace = true, optional = true}
eigen-chainio-txmanager = { workspace = true, optional = true }
eigen-client-avsregistry = { workspace = true, optional = true }
eigen-client-elcontracts = { workspace = true, optional = true }
eigen-client-eth = { workspace = true, optional = true }
eigen-client-fireblocks = { workspace = true, optional = true }
eigen-contract-bindings = { workspace = true, optional = true }
eigen-crypto-bls = { workspace = true, optional = true }
eigen-crypto-bn254 = { workspace = true, optional = true }
eigen-logging = { workspace = true, optional = true }
eigen-metrics = { workspace = true, optional = true }
eigen-metrics-collectors-economic = { workspace = true, optional = true }
eigen-metrics-collectors-rpc-calls = { workspace = true, optional = true }
eigen-services-avsregistry = { workspace = true, optional = true }
eigen-services-blsaggregation = { workspace = true, optional = true }
eigen-services-operatorsinfo = { workspace = true, optional = true }
eigen-signer = { workspace = true, optional = true }
eigen-testing-utils = { workspace = true, optional = true }
eigen-types = { workspace = true, optional = true }
eigen-utils = { workspace = true, optional = true }
eigen-nodeapi = { workspace = true, optional = true }


# Feature configurations
Expand All @@ -39,7 +38,6 @@ default = []
# Full features set for full usage
full = [
"chainio-txmanager",
"chainio-utils",
"client-avsregistry",
"client-elcontracts",
"client-eth",
Expand All @@ -59,7 +57,6 @@ full = [

# Chain IO related features
chainio-txmanager = ["dep:eigen-chainio-txmanager"]
chainio-utils = ["dep:eigen-chainio-utils"]

# Client-related features
client-avsregistry = ["dep:eigen-client-avsregistry"]
Expand Down
28 changes: 19 additions & 9 deletions crates/eigensdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ 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-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
Expand All @@ -20,7 +19,6 @@ List of crates in the repository :-
- [eigen-utils](https://github.com/Layr-Labs/eigensdk-rs/tree/main/crates/utils) - Publicly exportable `m2-mainnet` compatible alloy bindings.
- [eigen-testing-utils](https://github.com/Layr-Labs/eigensdk-rs/tree/main/testing/testing-utils) - Contains publicly exportable anvil , holesky , mainnet addresses for eigen contracts .


## 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 @@ -35,21 +33,23 @@ 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 :-
### PR

To test locally and raise a PR :-

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.

```bash
make pr
```

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

### To run fireblocks tests
### To run fireblocks tests

Add the following variables to your env
Add the following variables to your env

- FIREBLOCKS_API_KEY
- FIREBLOCKS_API_KEY
- FIREBLOCKS_PRIVATE_KEY_PATH
- FIREBLOCKS_API_URL

Expand All @@ -59,39 +59,49 @@ 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.

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%.

Here's how to generate test coverage reports:

Install llvm tools:

```bash
make deps
```

Run the tests with coverage instrumentations:

```bash
make coverage
```

Open the coverage html report in a web browser:

```bash
open target/llvm-cov/html/index.html
```

## Supported Rust Version

Rolling `MSRV` policy of 6 months. The current `MSRV` is 1.79

## Disclaimer

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)

# Security Bugs
Please report security vulnerabilities to [email protected]. Do NOT report security bugs via Github Issues.

Please report security vulnerabilities to <[email protected]>. Do NOT report security bugs via Github Issues.

## Contact

Telegram - supernovahs444
4 changes: 0 additions & 4 deletions crates/eigensdk/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,6 @@ pub use eigen_testing_utils as testing_utils;
#[doc(inline)]
pub use eigen_chainio_txmanager as chainio_txmanager;

#[cfg(feature = "chainio-utils")]
#[doc(inline)]
pub use eigen_chainio_utils as chainio_utils;

/* ------------------------------------ Metrics Collectors Re-exports -------------------------- */

#[cfg(feature = "metrics-collectors-economic")]
Expand Down
2 changes: 0 additions & 2 deletions examples/avsregistry-write/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ ark-ec = { version = "0.4.2", default-features = false }
ark-ff.workspace = true
ark-serialize = "0.4"
ark-std = { version = "0.4.0", default-features = false }
eigen-chainio-utils.workspace = true
eigen-client-avsregistry.workspace = true
eigen-client-elcontracts.workspace = true
eigen-crypto-bls.workspace = true
Expand All @@ -32,4 +31,3 @@ eigen-utils.workspace = true
eyre.workspace = true
lazy_static = "1.5.0"
tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }

0 comments on commit dd4de7f

Please sign in to comment.