berachain / beacon-kit

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

perf(state-transition): Skip double payload verification on verified and finalized blocks #2145

Open abi87 opened 6 days ago

abi87 commented 6 days ago

We verified execution payload when we verify a consensus block in ProcessBlock. However we also verify payload when a block finalizes via FinalizeBlock. A block can be made final in two cases:

This PR skips the validation in case the first case (block verified and finalized). Note that a change like this has been attempted in the past. (in https://github.com/berachain/beacon-kit/pull/1234) and reverted later on (https://github.com/berachain/beacon-kit/pull/1369). I don't currently know why this perf optimization was reverted and I am inclined to test and try it again. Wonder what @calbera thinks/knows of this?

Summary by CodeRabbit

coderabbitai[bot] commented 6 days ago

Walkthrough

The changes in this pull request primarily focus on enhancing the handling of payload verification during state transitions in the blockchain process. Key modifications include the introduction of a GetConsensusSyncing method in the ConsensusBlock interface and the addition of a boolean parameter in the ProcessProposal and FinalizeBlock methods to control payload verification based on the consensus syncing state. The executeStateTransition method in process.go has been updated to conditionally skip payload verification when the block is not in consensus syncing mode, while retaining existing error handling and control flow.

Changes

File Path Change Summary
mod/beacon/blockchain/process.go Updated executeStateTransition to conditionally set SkipPayloadVerification based on blk.GetConsensusSyncing(). Comments on OptimisticEngine retained.
mod/beacon/blockchain/types.go Added GetConsensusSyncing() method to ConsensusBlock interface.
mod/consensus/pkg/cometbft/service/middleware/abci.go Modified ProcessProposal and FinalizeBlock methods to include new boolean parameters for payload verification control during synchronization.
mod/consensus/pkg/types/consensus_block.go Added isConsensusSyncing field to ConsensusBlock, updated constructor and added GetConsensusSyncing() method.
mod/node-core/pkg/components/interfaces.go Introduced GetConsensusBlockHeight() and GetConsensusSyncing() methods to ConsensusBlock interface.

Possibly related PRs

Suggested labels

Merge me daddy

Suggested reviewers

🐰 In the blockchain's dance, we now can skip,
Payload checks when syncing takes a trip.
With methods new and logic bright,
Our consensus flows, a joyous sight!
So hop along, let’s celebrate,
For smoother transitions, isn’t it great? 🎉


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 6 days ago

Codecov Report

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

Project coverage is 26.27%. Comparing base (8a04173) to head (66a8ca1).

Files with missing lines Patch % Lines
.../consensus/pkg/cometbft/service/middleware/abci.go 0.00% 6 Missing :warning:
mod/beacon/blockchain/process.go 0.00% 3 Missing :warning:
mod/consensus/pkg/types/consensus_block.go 0.00% 3 Missing :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/berachain/beacon-kit/pull/2145/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/2145?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) ```diff @@ Coverage Diff @@ ## main #2145 +/- ## ========================================== - Coverage 26.28% 26.27% -0.02% ========================================== Files 360 360 Lines 16243 16251 +8 Branches 12 12 ========================================== Hits 4270 4270 - Misses 11705 11713 +8 Partials 268 268 ``` | [Files with missing lines](https://app.codecov.io/gh/berachain/beacon-kit/pull/2145?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) | Coverage Δ | | |---|---|---| | [mod/beacon/blockchain/process.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2145?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/consensus/pkg/types/consensus\_block.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2145?src=pr&el=tree&filepath=mod%2Fconsensus%2Fpkg%2Ftypes%2Fconsensus_block.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy9wa2cvdHlwZXMvY29uc2Vuc3VzX2Jsb2NrLmdv) | `0.00% <0.00%> (ø)` | | | [.../consensus/pkg/cometbft/service/middleware/abci.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2145?src=pr&el=tree&filepath=mod%2Fconsensus%2Fpkg%2Fcometbft%2Fservice%2Fmiddleware%2Fabci.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy9wa2cvY29tZXRiZnQvc2VydmljZS9taWRkbGV3YXJlL2FiY2kuZ28=) | `0.00% <0.00%> (ø)` | |
calbera commented 4 days ago

@abi87 imo adding this change is not absolutely crucial for now