search

berachain / beacon-kit

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

chore(consensus): generic validator update #1634

Closed archbear closed 1 week ago

archbear commented 1 week ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes involve major refactoring of the comet package to cometbft with the introduction of generics to enhance flexibility and type safety. Modules and function signatures have been updated to integrate these improvements. New error handling mechanisms and clearer byte slice initializations were also added. Dependencies on the gogoproto module have been adjusted for direct inclusion.

Changes

File/Path Change Summary
mod/consensus/go.mod Added gogoproto v1.5.0 as a direct dependency.
.../consensus/pkg/cometbft/consensus.go Renamed package to cometbft, refactored Consensus to ConsensusEngine, incorporated generics. Updated function signatures.
.../pkg/cometbft/errors.go Renamed package to cometbft.
.../pkg/cometbft/helpers.go Renamed package to cometbft, modified convertValidatorUpdate to use generics.
.../pkg/cometbft/types.go Introduced Middleware interface with new methods for consensus operations.
.../pkg/builder/builder.go Updated imports from comet to cometbft, adjusted instantiations to use NewConsensusEngine.
.../pkg/components/module/module.go Updated imports, function signatures to match new cometbft and appmodule conventions.
.../pkg/hex/bytes_test.go Enhanced readability of byte slice initialization without logic changes.
mod/runtime/go.mod Adjusted gogoproto dependency from indirect to direct.
.../pkg/middleware/abci.go Updated imports and function signatures for ABCIMiddleware.
.../pkg/middleware/errors.go Added new error variables for specific invalid request types.

Sequence Diagram

sequenceDiagram
    participant Middleware
    participant ConsensusEngine
    participant ValidatorUpdateT
    participant HandleErrors

    Middleware->>+ConsensusEngine: NewConsensusEngine[ValidatorUpdateT](m Middleware)
    ConsensusEngine->>ValidatorUpdateT: InitGenesis(ctx, genesisBz)
    ValidatorUpdateT-->>ConsensusEngine: ValidatorUpdate Data
    ConsensusEngine-->>Middleware: Initialized ConsensusEngine

    Middleware->>+ConsensusEngine: PrepareProposal(ctx, req)
    ConsensusEngine-->>Middleware: ProposalPreparation Response

    Middleware->>ConsensusEngine: ProcessProposal(ctx, req)
    ConsensusEngine->>ValidatorUpdateT: Process Proposal
    ValidatorUpdateT-->>ConsensusEngine: Proposal Process Response
    ConsensusEngine-->>Middleware: Proposal Processed Response

    Middleware->>ConsensusEngine: PreBlock(ctx, req)
    ConsensusEngine-->>Middleware: PreBlock processed

    Middleware->>ConsensusEngine: EndBlock(ctx)
    ConsensusEngine->>ValidatorUpdateT: End Block operations
    ValidatorUpdateT-->>ConsensusEngine: Validator Updates
    ConsensusEngine-->>Middleware: End Block completed

Poem

Changes swept across the code, A cosmic shift, a lighter load. With cometbft, the stars align, Generics dance, the types entwine. Errors now more clearly found, As code in elegance is crowned.

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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 1 week ago

Codecov Report

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

Project coverage is 23.02%. Comparing base (624c8bd) to head (d8cc562).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/berachain/beacon-kit/pull/1634/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/1634?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) ```diff @@ Coverage Diff @@ ## main #1634 +/- ## ========================================== - Coverage 23.05% 23.02% -0.04% ========================================== Files 261 261 Lines 11453 11469 +16 Branches 18 18 ========================================== Hits 2641 2641 - Misses 8686 8702 +16 Partials 126 126 ``` | [Files](https://app.codecov.io/gh/berachain/beacon-kit/pull/1634?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/builder/builder.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1634?src=pr&el=tree&filepath=mod%2Fnode-core%2Fpkg%2Fbuilder%2Fbuilder.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL25vZGUtY29yZS9wa2cvYnVpbGRlci9idWlsZGVyLmdv) | `0.00% <0.00%> (ø)` | | | [mod/consensus/pkg/cometbft/helpers.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1634?src=pr&el=tree&filepath=mod%2Fconsensus%2Fpkg%2Fcometbft%2Fhelpers.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy9wa2cvY29tZXRiZnQvaGVscGVycy5nbw==) | `0.00% <0.00%> (ø)` | | | [mod/node-core/pkg/components/module/module.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1634?src=pr&el=tree&filepath=mod%2Fnode-core%2Fpkg%2Fcomponents%2Fmodule%2Fmodule.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL25vZGUtY29yZS9wa2cvY29tcG9uZW50cy9tb2R1bGUvbW9kdWxlLmdv) | `0.00% <0.00%> (ø)` | | | [mod/runtime/pkg/middleware/abci.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1634?src=pr&el=tree&filepath=mod%2Fruntime%2Fpkg%2Fmiddleware%2Fabci.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3J1bnRpbWUvcGtnL21pZGRsZXdhcmUvYWJjaS5nbw==) | `0.00% <0.00%> (ø)` | | | [mod/consensus/pkg/cometbft/consensus.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1634?src=pr&el=tree&filepath=mod%2Fconsensus%2Fpkg%2Fcometbft%2Fconsensus.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL2NvbnNlbnN1cy9wa2cvY29tZXRiZnQvY29uc2Vuc3VzLmdv) | `0.00% <0.00%> (ø)` | |