search

berachain / beacon-kit

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

feat(ssz): Add type defs #1664

Closed itsdevbear closed 3 months ago

itsdevbear commented 3 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@itsdevbear has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 56 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 4b6038db2851a4793b8ad2156fbcbdd772386c40 and 8dff7600f712db0a2d8b4db54cfb7c64ed4d48d2.

Walkthrough

The changes enhance the type system and functionality for serialization in the ssz package by introducing new type definitions (U8, U16, U32, U64, Byte) and updating interfaces to use these types. The updates also include modifications in the Vector and List types, the Container struct, and the BaseMerkleizer and new VectorMerkleizer and ListMerkleizer interfaces. An entry script was updated to change the chain specification from "devnet" to "testnet."

Changes

Files Change Summary
mod/primitives/pkg/ssz/basic.go Added type definitions (U8, U16, U32, U64, Byte) with methods for size, fixed check, and type return.
mod/primitives/pkg/ssz/constraints.go Refactored interfaces to use types from types package, simplifying Base and Basic interfaces.
mod/primitives/pkg/ssz/interfaces.go Updated BaseMerkleizer type constraint to types.SSZType[T], added VectorMerkleizer and ListMerkleizer interfaces.
mod/primitives/pkg/ssz/list.go Added ListBasic, ListComposite type definitions and functions for element handling and removed duplicate declarations.
mod/primitives/pkg/ssz/container.go Updated methods for Container struct to fit new type definitions and refactored existing methods.
mod/primitives/pkg/ssz/types/types.go Introduced new interfaces and types for SSZ serialization and enumeration (BaseSSZType, SSZType, SSZEnumerable).
mod/.../pkg/engine-primitives/withdrawal.go Added a Type() method to Withdrawal struct to return SSZ type.
testing/files/entrypoint.sh Updated CHAIN_SPEC from "devnet" to "testnet".
mod/primitives/pkg/ssz/vector.go Redefined Vector type, added/updated methods for type checks, serialization, and merkleization.
mod/primitives/pkg/ssz/vector_test.go Renamed test functions to reflect the operations on vector sizes, hash roots, and marshaling/unmarshaling.

Sequence Diagram(s)

(Changes are too varied and specific to include sequence diagrams.)

Poem

Amid the code, where bytes do spread,
We redefine, on vectors tread. 📏
From U8 to U64's might,
Serialization shines so bright. ✨
Testnet chains now come to play,
In fields where data bunnies sway. 🐇💻🌟

[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues.
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 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 70.45%. Comparing base (02f5473) to head (8dff760).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/berachain/beacon-kit/pull/1664/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/1664?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) ```diff @@ Coverage Diff @@ ## main #1664 +/- ## =========================================== + Coverage 22.38% 70.45% +48.07% =========================================== Files 270 8 -262 Lines 11888 88 -11800 Branches 18 18 =========================================== - Hits 2661 62 -2599 + Misses 9107 22 -9085 + Partials 120 4 -116 ``` [see 262 files with indirect coverage changes](https://app.codecov.io/gh/berachain/beacon-kit/pull/1664/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain)