berachain / beacon-kit

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

bug(blockchain): make block finalization wait on sidecar availability #2118

Open abi87 opened 2 weeks ago

abi87 commented 2 weeks ago

When we finalize a block, we verify that its associated sidecar has been stored. However block and sidecar finalization are handled concurrently, so we need wait for the blob to be persisted before checking. This PR solves the issue

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces modifications to the blockchain processing logic, particularly in the management of blob sidecars. The ProcessBeaconBlock method now uses asynchronous verification for blob availability through the verifyFinalBlobAvailability method. The Service struct has been updated to include new channels for blob finalization events. Improvements to event handling are made across various components, including the introduction of a new event constant for blob finalization.

Changes

File Change Summary
mod/beacon/blockchain/process.go - Transitioned to asynchronous blob availability verification using verifyFinalBlobAvailability.
- Adjusted error handling for blob verification.
- Revised comments for clarity.
mod/beacon/blockchain/service.go - Added blobFinalized and subBlobFinalized channels to Service struct.
- Updated NewService to initialize these channels.
- Modified Start method to subscribe to BlobSidecarsFinalized events.
mod/da/pkg/da/service.go - Implemented publishing of BlobSidecarsFinalized event in handleFinalSidecarsReceived.
- Enhanced error handling in handleSidecarsReceived.
mod/node-core/pkg/components/dispatcher.go - Registered event handling for async.BlobSidecarsFinalized in ProvideDispatcher.
mod/primitives/pkg/async/id.go - Added constant BlobSidecarsFinalized with value "blob-sidecars-finalized".

Possibly related PRs

Suggested reviewers

Poem

🐇 In the land of code where rabbits hop,
New blobs are checked, no need to stop.
With channels and events, we dance and play,
Asynchronous joy brightens the day!
Hooray for the changes, let’s celebrate,
In the world of blocks, we innovate! 🌟

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint level=warning msg="[linters_context] running gomodguard failed: unable to read module file go.mod: current working directory must have a go.mod file: if you are not using go modules it is suggested to disable this linter" level=error msg="[linters_context] typechecking error: pattern ./...: directory prefix . does not contain modules listed in go.work or their selected dependencies"

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://coderabbit.ai/docs) 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 2 weeks ago

Codecov Report

Attention: Patch coverage is 0% with 33 lines in your changes missing coverage. Please review.

Project coverage is 26.20%. Comparing base (9cbce04) to head (b26afa8).

Files with missing lines Patch % Lines
mod/beacon/blockchain/service.go 0.00% 21 Missing :warning:
mod/da/pkg/da/service.go 0.00% 9 Missing :warning:
mod/beacon/blockchain/process.go 0.00% 2 Missing :warning:
mod/node-core/pkg/components/dispatcher.go 0.00% 1 Missing :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/berachain/beacon-kit/pull/2118/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/2118?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) ```diff @@ Coverage Diff @@ ## main #2118 +/- ## ========================================== - Coverage 26.24% 26.20% -0.05% ========================================== Files 360 360 Lines 16241 16268 +27 Branches 12 12 ========================================== Hits 4263 4263 - Misses 11709 11736 +27 Partials 269 269 ``` | [Files with missing lines](https://app.codecov.io/gh/berachain/beacon-kit/pull/2118?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) | Coverage Δ | | |---|---|---| | [mod/node-core/pkg/components/dispatcher.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2118?src=pr&el=tree&filepath=mod%2Fnode-core%2Fpkg%2Fcomponents%2Fdispatcher.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL25vZGUtY29yZS9wa2cvY29tcG9uZW50cy9kaXNwYXRjaGVyLmdv) | `0.00% <0.00%> (ø)` | | | [mod/beacon/blockchain/process.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2118?src=pr&el=tree&filepath=mod%2Fbeacon%2Fblockchain%2Fprocess.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2JlYWNvbi9ibG9ja2NoYWluL3Byb2Nlc3MuZ28=) | `0.00% <0.00%> (ø)` | | | [mod/da/pkg/da/service.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2118?src=pr&el=tree&filepath=mod%2Fda%2Fpkg%2Fda%2Fservice.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2RhL3BrZy9kYS9zZXJ2aWNlLmdv) | `0.00% <0.00%> (ø)` | | | [mod/beacon/blockchain/service.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2118?src=pr&el=tree&filepath=mod%2Fbeacon%2Fblockchain%2Fservice.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2JlYWNvbi9ibG9ja2NoYWluL3NlcnZpY2UuZ28=) | `0.00% <0.00%> (ø)` | |