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

refactor: bls_aggr encapsulate task initialization params in TaskMetadata #254

Open
wants to merge 26 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
f361cff
Create new struct for encapsulate initialize_new_task params
damiramirez Jan 30, 2025
44f2b4c
Create new() method and fix tests
damiramirez Jan 30, 2025
3440dd5
Fix integration test with new func
damiramirez Jan 30, 2025
820be8a
Add docs to the new struct
damiramirez Jan 30, 2025
3721a0e
Add docs to methods of TaskMetadata
damiramirez Jan 30, 2025
4884537
Fix typo
damiramirez Jan 30, 2025
d1231e1
Change interface of single_task_aggregator. Now it expects the new st…
damiramirez Jan 30, 2025
4cc09ad
Change some docs
damiramirez Jan 30, 2025
8f214d6
Complete CHANGELOG.md
damiramirez Jan 30, 2025
aad5ef9
Improve docs
damiramirez Jan 30, 2025
7cb81ab
Merge branch 'main' into refactor/task-metadata
MegaRedHand Jan 30, 2025
70c3ab7
Update crates/services/bls_aggregation/src/bls_agg.rs
damiramirez Jan 30, 2025
847c27a
Update crates/services/bls_aggregation/src/bls_agg.rs
damiramirez Jan 30, 2025
bcf260e
Update crates/services/bls_aggregation/src/bls_agg.rs
damiramirez Jan 30, 2025
4a957d6
Update crates/services/bls_aggregation/src/bls_agg.rs
damiramirez Jan 30, 2025
90e8540
Update crates/services/bls_aggregation/src/bls_agg.rs
damiramirez Jan 30, 2025
89034b7
Update crates/services/bls_aggregation/src/bls_agg.rs
damiramirez Jan 30, 2025
cdbf9f2
Update crates/services/bls_aggregation/src/bls_agg.rs
damiramirez Jan 30, 2025
109da17
Update CHANGELOG.md
damiramirez Jan 30, 2025
653eb6d
Update crates/services/bls_aggregation/src/bls_agg.rs
damiramirez Jan 30, 2025
68f0149
Add doc to TaskMetadata
damiramirez Jan 30, 2025
1c1931b
Move metadata.task_index to a variable
damiramirez Jan 30, 2025
6b775a7
Move method single_task_aggregator private
damiramirez Jan 30, 2025
7730ed1
Add before and after examples in CHANGELOG
damiramirez Jan 30, 2025
f80b50f
Use task_index variable in multiple places within the method
damiramirez Jan 30, 2025
1e4bcb6
Fix some comments
damiramirez Jan 30, 2025
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
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,23 @@ Each version will have a separate `Breaking Changes` section as well. To describ
* Fixed the rewardsv2 bindings version in readme to 0.5.4 in [#246](https://github.com/Layr-Labs/eigensdk-rs/pull/246).

### Breaking changes
* refactor: update interface on `bls aggregation` in [#254](https://github.com/Layr-Labs/eigensdk-rs/pull/254)
* Introduces a new struct `TaskMetadata` with a constructor `TaskMetadata::new` to initialize a new task and a method `with_window_duration` to set the window duration.
* Refactors `initialize_new_task` and `single_task_aggregator` to accept a `TaskMetadata` struct instead of multiple parameters.
* Removes `initialize_new_task_with_window` since `window_duration` is now included in `TaskMetadata`.
damiramirez marked this conversation as resolved.
Show resolved Hide resolved

```rust
let metadata = TaskMetadata::new(
task_index,
block_number,
quorum_numbers,
quorum_threshold_percentages,
time_to_expiry,
)
.with_window_duration(window_duration);
bls_agg_service.initialize_new_task(metadata).await.unwrap();
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have before and after examples here. One for initialize_new_task and another with initialize_new_task_with_window

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 7730ed1! What do you think about the format?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "before" and "after" don't render correctly in markdown. We could have them as code comments instead

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really good format otherwise!


### Removed

## [0.1.3] - 2024-01-17
Expand Down
Loading