Skip to content

Commit

Permalink
chore:release 0.3.0 (#351)
Browse files Browse the repository at this point in the history 
releases 0.3.0

### What Changed?
<!-- Describe the changes made in this pull request -->

### Reviewer Checklist

- [ ] New features are tested and documented
- [ ] PR updates the changelog with a description of changes
- [ ] PR has one of the `changelog-X` labels (if applies)
- [ ] Code deprecates any old functionality before removing it

---------

Co-authored-by: Tomás Grüner <[email protected]>
  • Loading branch information
@supernovahs @MegaRedHand
supernovahs and MegaRedHand authored Feb 11, 2025
1 parent 14b03b6 commit 4cf1969
Show file tree
Hide file tree
Showing 5 changed files with 204 additions and 62 deletions.
1 change: 1 addition & 0 deletions .github/workflows/release-plz.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ on:
push:
branches:
- main
- dev

jobs:

Expand Down
160 changes: 147 additions & 13 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,23 @@ Each version will have a separate `Breaking Changes` section as well. To describ
Those changes in added, changed or breaking changes, should include usage examples to add clarity to the sdk user.

## [Unreleased]

### Security 🔒

### Added 🎉

### Breaking Changes 🛠

### Deprecated ⚠️

### Removed 🗑

### Documentation 📚

### Other Changes

## [0.3.0] - 2025-02-11
### Added
* Added `eigen_common` dependency to the `eigensdk` crate when "full" feature is enabled in [#249](https://github.com/Layr-Labs/eigensdk-rs/pull/249).
* Added bindings for `ECDSAStakeRegistry` and `ECDSAServiceManagerBase` in [#269](https://github.com/Layr-Labs/eigensdk-rs/pull/269).
* Added release-plz in ci in [#275](https://github.com/Layr-Labs/eigensdk-rs/pull/275).
* Added new method `set_slashable_stake_lookahead` in `avsregistry/writer` in [#278](https://github.com/Layr-Labs/eigensdk-rs/pull/278).
```rust
let quorum_number = 0_u8;
Expand Down Expand Up @@ -64,9 +77,37 @@ Those changes in added, changed or breaking changes, should include usage exampl
.status();
// tx_status should be true
```

* Added custom configuration for release-plz in [#281](https://github.com/Layr-Labs/eigensdk-rs/pull/281).
* Added Rewards2.1 support in [#323](https://github.com/Layr-Labs/eigensdk-rs/pull/323).

* Set an operator's split on an operator set.

```rust
let operator_set = OperatorSet {
avs: avs_address,
id: 0,
};

let new_split = 5;
let tx_hash = el_chain_writer
.set_operator_set_split(OPERATOR_ADDRESS, operator_set.clone(), new_split)
.await
.unwrap();
```

* Get an operator's split on an operator set.

```rust
let operator_set = OperatorSet {
avs: avs_address,
id: 0,
};
let split = el_chain_writer
.el_chain_reader
.get_operator_set_split(OPERATOR_ADDRESS, operator_set)
.await
.unwrap();
```

* Added new method `set_operator_set_param` in `avsregistry/writer` in [#327](https://github.com/Layr-Labs/eigensdk-rs/pull/327).

```rust
Expand Down Expand Up @@ -99,7 +140,7 @@ Those changes in added, changed or breaking changes, should include usage exampl
```rust
let operator_set_quourm = avs_reader.is_operator_set_quorum(0).await.unwrap();
```

* Added version explicitly in crates in [#322](https://github.com/Layr-Labs/eigensdk-rs/pull/322).
* Added new method `set_account_identifier` in `avsregistry/writer` in [#329](https://github.com/Layr-Labs/eigensdk-rs/pull/329).

```rust
Expand All @@ -110,12 +151,7 @@ Those changes in added, changed or breaking changes, should include usage exampl
```

### Changed
* Changes in the way bindings are generated in [#243](https://github.com/Layr-Labs/eigensdk-rs/pull/243).
* The `bindings` target now generates the bindings using Docker with Foundry v0.3.0.
* The previous `bindings` target was renamed to `bindings_host`, as it runs without Docker. However the `bindings_host` target is for CI use only. To generate the bindings, please use the `bindings` target.
* Fixed the rewardsv2 bindings version in readme to 0.5.4 in [#246](https://github.com/Layr-Labs/eigensdk-rs/pull/246).
* Fixed typo in release-plz toml file in [#284](https://github.com/Layr-Labs/eigensdk-rs/pull/284).
* Fixed incorrect package name in Cargo.toml for examples in [#285](https://github.com/Layr-Labs/eigensdk-rs/pull/285).


### Breaking changes
* refactor: update interface on `bls aggregation` in [#254](https://github.com/Layr-Labs/eigensdk-rs/pull/254)
Expand Down Expand Up @@ -188,11 +224,109 @@ Those changes in added, changed or breaking changes, should include usage exampl
* Slashing UAM changes in [#248](https://github.com/Layr-Labs/eigensdk-rs/pull/248).

### Removed

## [0.2.0] - 2025-02-06

### Security 🔒

* chore(deps): bump openssl from 0.10.68 to 0.10.70 in the cargo group across 1 directory by @dependabot in <https://github.com/Layr-Labs/eigensdk-rs/pull/291>

### Added 🎉

* Added `eigen_common` dependency to the `eigensdk` crate when "full" feature is enabled in [#249](https://github.com/Layr-Labs/eigensdk-rs/pull/249).
* Now when enabling the "full" feature:

```toml
eigensdk = { version = "0.2", features = ["full"] }
```

You can use access the `eigen-common` crate as a submodule of `eigensdk`:

```rust
use eigensdk::common::*;
```

* Added bindings for `ECDSAStakeRegistry` and `ECDSAServiceManagerBase` in [#269](https://github.com/Layr-Labs/eigensdk-rs/pull/269).
* These bindings can be accessed from:

```rust
// From `eigensdk`
use eigensdk::utils::middleware::ecdsaservicemanagerbase;
use eigensdk::utils::middleware::ecdsastakeregistry;
// From `eigen_utils`
use eigen_utils::middleware::ecdsaservicemanagerbase;
use eigen_utils::middleware::ecdsastakeregistry;
```

* Starting on this release, we're using [`release-plz`](https://github.com/release-plz/release-plz) to streamline our release process.
* Added release-plz in ci in [#275](https://github.com/Layr-Labs/eigensdk-rs/pull/275).
* Added custom configuration for release-plz in [#281](https://github.com/Layr-Labs/eigensdk-rs/pull/281).
* Fixed typo in release-plz toml file in [#284](https://github.com/Layr-Labs/eigensdk-rs/pull/284).

### Breaking Changes 🛠

* fix: use rewards coordinator on get operator avs/pi split methods by @maximopalopoli in <https://github.com/Layr-Labs/eigensdk-rs/pull/250>

* The parameters of `ChainReader::new` changed, and it now receives the address of the rewards coordinator.

It was previously called this way:

```rust
let el_chain_reader = ELChainReader::new(
logger,
SLASHER_ADDRESS,
DELEGATION_MANAGER_ADDRESS,
AVS_DIRECTORY_ADDRESS,
provider_url,
);
```

Now, it's called this way:

```rust
let el_chain_reader = ELChainReader::new(
logger,
SLASHER_ADDRESS,
DELEGATION_MANAGER_ADDRESS,
REWARDS_COORDINATOR,
AVS_DIRECTORY_ADDRESS,
provider_url,
);
```

### Removed 🗑

* Removed homepage from testing-utils crate in [#266](https://github.com/Layr-Labs/eigensdk-rs/pull/266).
* Removed changelog generation by release-plz in [#281](https://github.com/Layr-Labs/eigensdk-rs/pull/281).
* Removed examples packages from workspace.dependencies in Cargo.toml in [#287](https://github.com/Layr-Labs/eigensdk-rs/pull/287).
* Removed release-plz-pr workflow in release-plz in [#292](https://github.com/Layr-Labs/eigensdk-rs/pull/292).

### Documentation 📚

* Fixed the rewardsv2 bindings version in readme to 0.5.4 in [#246](https://github.com/Layr-Labs/eigensdk-rs/pull/246).
* docs: improve changelog by adding examples by @maximopalopoli in <https://github.com/Layr-Labs/eigensdk-rs/pull/251>

### Other Changes

* Changes in the way bindings are generated in [#243](https://github.com/Layr-Labs/eigensdk-rs/pull/243).
* The `bindings` target now generates the bindings using Docker with Foundry v0.3.0.
* The previous `bindings` target was renamed to `bindings_host`, as it runs without Docker. However the `bindings_host` target is for CI use only. To generate the bindings, please use the `bindings` target.
* Fixed incorrect package name in Cargo.toml for examples in [#285](https://github.com/Layr-Labs/eigensdk-rs/pull/285).
* docs: add mention of updated bindings to changelog by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/233>
* chore: format contracts by @ricomateo in <https://github.com/Layr-Labs/eigensdk-rs/pull/235>
* ci: add foundry workflow by @ricomateo in <https://github.com/Layr-Labs/eigensdk-rs/pull/236>
* ci: add CI job to check whether anvil state is up to date by @ricomateo in <https://github.com/Layr-Labs/eigensdk-rs/pull/237>
* chore: remove existing bindings when generating new ones by @ricomateo in <https://github.com/Layr-Labs/eigensdk-rs/pull/242>
* chore: remove alloy reexported crates from dependencies by @ricomateo in <https://github.com/Layr-Labs/eigensdk-rs/pull/244>
* docs: sync root and `crates/eigensdk/` READMEs by @ricomateo in <https://github.com/Layr-Labs/eigensdk-rs/pull/245>
* ci: add workflow to enforce updates to the changelog by @ricomateo in <https://github.com/Layr-Labs/eigensdk-rs/pull/239>
* docs: add `RELEASE.md` by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/231>
* ci: fix check bindings job by @pablodeymo in <https://github.com/Layr-Labs/eigensdk-rs/pull/247>
* ci: fix job that checks anvil state is up-to-date by @ricomateo in <https://github.com/Layr-Labs/eigensdk-rs/pull/252>
* refactor: move bindings generation to script by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/271>
* fix: simplify Cargo.toml by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/282>
* ci: split tests and coverage by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/286>

## [0.1.3] - 2024-01-17
### Added 🎉
* feat: add rewards-v2 related functionality by @supernovahs in https://github.com/Layr-Labs/eigensdk-rs/pull/221
Expand Down Expand Up @@ -312,4 +446,4 @@ Those changes in added, changed or breaking changes, should include usage exampl
## Previous versions

This changelog was introduced in-between v0.1.2 and v0.1.3.
For changes from previous releases, you can check on our GitHub repo's releases page: [github.com/Layr-Labs/eigensdk-rs/releases](https://github.com/Layr-Labs/eigensdk-rs/releases)
For changes from previous releases, you can check on our GitHub repo's releases page: [github.com/Layr-Labs/eigensdk-rs/releases](https://github.com/Layr-Labs/eigensdk-rs/releases)
Loading

0 comments on commit 4cf1969

Please sign in to comment.