search

berachain / beacon-kit

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

chore(middleware): agane #1649

Closed ocnc closed 1 week ago

ocnc commented 1 week ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The recent updates primarily involve refining the ABCIMiddleware by removing the BeaconState dependency and recalibrating method signatures to align with new struct interfaces. This also includes the addition of a TelemetrySink interface and enhancements in error handling logic. Adjustments in P2P components further simplify interfaces and enhance functionality.

Changes

File Path Summary of Changes
.../middleware.go, .../types.go Removed BeaconState dependency from ABCIMiddleware and updated method signatures accordingly.
.../middleware/abci.go Updated functions within ABCIMiddleware struct affecting parameters for GenesisT, BeaconBlockT, and BlobSidecarsT.
.../middleware/errors.go Refined error handling by removing ErrBadExtractBlockAndBlocks and updating error comments.
.../middleware/middleware.go Stripped out BeaconStateT from various declarations and method receivers.
.../middleware/types.go Removed interfaces related to beacon state, DA service, execution payload header, and storage backend; added TelemetrySink interface.
.../p2p/noop_blob.go Updated NoopBlobHandler struct to remove ReqT type parameter.
.../p2p/noop_block.go Refactored NoopBlockGossipHandler struct and NewNoopBlockGossipHandler function signatures.
.../p2p/types.go Introduced BeaconBlock interface with SSZ marshaling methods.

Sequence Diagram(s)

Sequence diagrams are not applicable for this set of changes.

Poem

In code's vast and endless sea,
Middleware dances, now set free.
The BeaconState fades from the scene,
Sleeker flows, our goal's serene.
With telemetry, we now can sink,
Errors handled, swift as a wink.
Our code now hums, efficient, and bright,
Hopping ahead, in the code's twilight.

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 3 lines in your changes missing coverage. Please review.

Project coverage is 22.88%. Comparing base (b724d2b) to head (230af5a).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/berachain/beacon-kit/pull/1649/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/1649?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) ```diff @@ Coverage Diff @@ ## main #1649 +/- ## ======================================= Coverage 22.88% 22.88% ======================================= Files 268 268 Lines 11840 11840 Branches 18 18 ======================================= Hits 2710 2710 Misses 9001 9001 Partials 129 129 ``` | [Files](https://app.codecov.io/gh/berachain/beacon-kit/pull/1649?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) | Coverage Δ | | |---|---|---| | [mod/runtime/pkg/middleware/abci.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1649?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% <ø> (ø)` | | | [mod/runtime/pkg/p2p/noop\_blob.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1649?src=pr&el=tree&filepath=mod%2Fruntime%2Fpkg%2Fp2p%2Fnoop_blob.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3J1bnRpbWUvcGtnL3AycC9ub29wX2Jsb2IuZ28=) | `0.00% <ø> (ø)` | | | [mod/runtime/pkg/p2p/noop\_block.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1649?src=pr&el=tree&filepath=mod%2Fruntime%2Fpkg%2Fp2p%2Fnoop_block.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3J1bnRpbWUvcGtnL3AycC9ub29wX2Jsb2NrLmdv) | `0.00% <ø> (ø)` | | | [mod/runtime/pkg/middleware/middleware.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1649?src=pr&el=tree&filepath=mod%2Fruntime%2Fpkg%2Fmiddleware%2Fmiddleware.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3J1bnRpbWUvcGtnL21pZGRsZXdhcmUvbWlkZGxld2FyZS5nbw==) | `0.00% <0.00%> (ø)` | | | [mod/node-core/pkg/components/middleware.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1649?src=pr&el=tree&filepath=mod%2Fnode-core%2Fpkg%2Fcomponents%2Fmiddleware.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL25vZGUtY29yZS9wa2cvY29tcG9uZW50cy9taWRkbGV3YXJlLmdv) | `0.00% <0.00%> (ø)` | |