berachain / beacon-kit

A modular framework for building EVM consensus clients ⛵️✨
https://berachain.com
Other
170 stars 122 forks source link

chore(all): update SSZ dependencies #2153

Closed abi87 closed 2 days ago

abi87 commented 3 days ago

We need to clean up one of the ssz dependencies. This PR achieve this as follow:

Summary by CodeRabbit

coderabbitai[bot] commented 3 days ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant updates to multiple go.mod files across various modules in the github.com/berachain/beacon-kit repository. These changes primarily focus on dependency management, including updates to versions for various packages, the addition of new dependencies, and modifications to existing dependencies. Additionally, several method signatures in the codebase have been altered to enhance size calculation mechanisms related to SSZ (Simple Serialize) encoding, improving how data structures are marshaled and their sizes computed.

Changes

File Path Change Summary
beacond/go.mod Updated dependencies including github.com/karalabe/ssz, github.com/berachain/beacon-kit/mod/config, and various google.golang.org/genproto packages.
build/tools/go.mod Replaced honnef.co/go/tools with github.com/dominikh/go-tools, added github.com/alecthomas/assert/v2, and updated google.golang.org/genproto/googleapis/api.
examples/berad/go.mod Updated cosmossdk.io packages and added new indirect dependencies related to the Cosmos SDK.
examples/berad/pkg/consensus-types/state.go Updated SizeSSZ and MarshalSSZ methods to include *ssz.Sizer parameter for size calculations.
examples/berad/pkg/consensus-types/validator.go Updated SizeSSZ and MarshalSSZ methods to utilize *ssz.Sizer for size calculations.
examples/berad/pkg/state-transition/state_processor_payload.go Simplified ToHeader method call in processExecutionPayload.
mod/beacon/go.mod Added replace directive for google.golang.org/genproto, updated multiple dependencies including github.com/berachain/beacon-kit/mod/config, and added several new indirect dependencies.
mod/cli/go.mod Updated github.com/berachain/beacon-kit/mod/config and removed github.com/berachain/beacon-kit/mod/consensus.
mod/consensus-types/pkg/types/*.go Multiple updates to SizeSSZ and MarshalSSZ methods across various structs to include *ssz.Sizer, enhancing SSZ encoding capabilities.
mod/engine-primitives/pkg/engine-primitives/*.go Updated SizeSSZ methods for Withdrawal, Withdrawals, and Transactions to accept *ssz.Sizer, indicating a shift in how sizes are calculated.
mod/node-core/go.mod Updated github.com/berachain/beacon-kit/mod/config and other dependencies.
mod/state-transition/go.mod Updated github.com/berachain/beacon-kit/mod/config and added new dependency github.com/berachain/beacon-kit/mod/log.
mod/storage/go.mod Updated github.com/berachain/beacon-kit/mod/config and other dependencies.
testing/go.mod Updated github.com/goccy/go-yaml and google.golang.org/genproto/googleapis/api versions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StateProcessor
    participant Payload
    participant Header

    User->>StateProcessor: processExecutionPayload()
    StateProcessor->>Payload: Validate and set header
    Payload->>Header: ToHeader()
    Header-->>StateProcessor: Return header
    StateProcessor-->>User: Execution payload processed

Suggested labels

Merge me daddy

Suggested reviewers

Poem

🐇 In the meadow, changes bloom,
Dependencies updated, clearing the gloom.
With SSZ's size, we hop and play,
Marshaling data in a new way.
Hooray for code, so fresh and bright,
Let's merge this PR, it feels just right! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 3 days ago

Codecov Report

Attention: Patch coverage is 67.50000% with 26 lines in your changes missing coverage. Please review.

Project coverage is 26.28%. Comparing base (240f617) to head (a3ee7ca). Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
examples/berad/pkg/consensus-types/state.go 0.00% 8 Missing :warning:
mod/cli/pkg/commands/genesis/payload.go 0.00% 6 Missing :warning:
mod/da/pkg/types/sidecars.go 0.00% 3 Missing :warning:
examples/berad/pkg/consensus-types/validator.go 0.00% 2 Missing :warning:
mod/consensus-types/pkg/types/deposits.go 0.00% 2 Missing :warning:
mod/consensus-types/pkg/types/validators.go 0.00% 2 Missing :warning:
...e-primitives/pkg/engine-primitives/transactions.go 0.00% 2 Missing :warning:
...ad/pkg/state-transition/state_processor_payload.go 0.00% 1 Missing :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153/graphs/tree.svg?width=650&height=150&src=pr&token=0l5iJ3ZbzV&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain)](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) ```diff @@ Coverage Diff @@ ## main #2153 +/- ## ========================================== + Coverage 26.24% 26.28% +0.04% ========================================== Files 361 360 -1 Lines 16299 16243 -56 Branches 12 12 ========================================== - Hits 4277 4270 -7 + Misses 11752 11705 -47 + Partials 270 268 -2 ``` | [Files with missing lines](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) | Coverage Δ | | |---|---|---| | [mod/consensus-types/pkg/types/attestation\_data.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&filepath=mod%2Fconsensus-types%2Fpkg%2Ftypes%2Fattestation_data.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy10eXBlcy9wa2cvdHlwZXMvYXR0ZXN0YXRpb25fZGF0YS5nbw==) | `79.59% <100.00%> (ø)` | | | [mod/consensus-types/pkg/types/block.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&filepath=mod%2Fconsensus-types%2Fpkg%2Ftypes%2Fblock.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy10eXBlcy9wa2cvdHlwZXMvYmxvY2suZ28=) | `94.33% <100.00%> (ø)` | | | [mod/consensus-types/pkg/types/body.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&filepath=mod%2Fconsensus-types%2Fpkg%2Ftypes%2Fbody.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy10eXBlcy9wa2cvdHlwZXMvYm9keS5nbw==) | `69.38% <100.00%> (ø)` | | | [mod/consensus-types/pkg/types/deposit.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&filepath=mod%2Fconsensus-types%2Fpkg%2Ftypes%2Fdeposit.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy10eXBlcy9wa2cvdHlwZXMvZGVwb3NpdC5nbw==) | `93.50% <100.00%> (ø)` | | | [mod/consensus-types/pkg/types/deposit\_message.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&filepath=mod%2Fconsensus-types%2Fpkg%2Ftypes%2Fdeposit_message.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy10eXBlcy9wa2cvdHlwZXMvZGVwb3NpdF9tZXNzYWdlLmdv) | `93.33% <100.00%> (ø)` | | | [mod/consensus-types/pkg/types/eth1data.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&filepath=mod%2Fconsensus-types%2Fpkg%2Ftypes%2Feth1data.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy10eXBlcy9wa2cvdHlwZXMvZXRoMWRhdGEuZ28=) | `89.13% <100.00%> (ø)` | | | [mod/consensus-types/pkg/types/fork.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&filepath=mod%2Fconsensus-types%2Fpkg%2Ftypes%2Ffork.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy10eXBlcy9wa2cvdHlwZXMvZm9yay5nbw==) | `88.37% <100.00%> (ø)` | | | [mod/consensus-types/pkg/types/fork\_data.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&filepath=mod%2Fconsensus-types%2Fpkg%2Ftypes%2Ffork_data.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy10eXBlcy9wa2cvdHlwZXMvZm9ya19kYXRhLmdv) | `100.00% <100.00%> (ø)` | | | [mod/consensus-types/pkg/types/genesis.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&filepath=mod%2Fconsensus-types%2Fpkg%2Ftypes%2Fgenesis.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy10eXBlcy9wa2cvdHlwZXMvZ2VuZXNpcy5nbw==) | `87.50% <100.00%> (ø)` | | | [mod/consensus-types/pkg/types/header.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree&filepath=mod%2Fconsensus-types%2Fpkg%2Ftypes%2Fheader.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy10eXBlcy9wa2cvdHlwZXMvaGVhZGVyLmdv) | `90.00% <100.00%> (ø)` | | | ... and [18 more](https://app.codecov.io/gh/berachain/beacon-kit/pull/2153?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) | |