search

berachain / beacon-kit

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

chore(ssz): Remove unused #1631

Closed itsdevbear closed 1 week ago

itsdevbear commented 1 week ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

These changes focus on improving the SSZ (Simple Serialize) functionality for handling binary encoding, marshalling, and generating Merkle roots. This includes adding new basic types, simplifying serialization methods, and testing with fuzz functions. The updates make the SSZ processes more streamlined, flexible, and robust, adhering to SSZ format specifications.

Changes

Files Change Summary
mod/primitives/pkg/ssz/merkleizer_test.go Modified MarshalSSZ method in BasicItem struct to use binary encoding.
mod/primitives/pkg/ssz/serialization.go Removed specific unmarshalling and marshalling functions; lean towards a generic serialization approach.
mod/primitives/pkg/ssz/serialization_test.go Replaced individual test functions with fuzz testing functions for various types.
mod/primitives/pkg/ssz/types/basic.go Introduced basic types and their SSZ serialization/deserialization methods.
mod/primitives/pkg/ssz/types/constants.go Added constants for byte and bit sizes used in chunk processing and serialization.
mod/primitives/pkg/ssz/types/interfaces.go Defined the Merkleizer interface for merkleizing various SSZ types.
mod/primitives/pkg/ssz/types/list_basic.go Added functionality for handling lists of basic types (SSZListBasic) with serialization and Merkle root methods.
mod/primitives/pkg/ssz/types/vector_basic.go Introduced functionality for handling vectors of basic types (SSZVectorBasic).
mod/primitives/pkg/ssz/types/vector_basic_test.go Added test cases for SSZ vectors of various basic types, covering size calculation, hashing, and marshaling.

Poem

🐰 "In bytes and bits, a tale we spin,
Marshaled now from deep within,
With roots of Merkle, strong and bright,
Our SSZ shines in data's night.
Constant bytes, anew they gleam,
Our code now seamless as a dream." 🌟

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.