search

berachain / beacon-kit

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

feat(ssz): More updates #1654

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 6 minutes and 8 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 d39ca8801bd582b5080fd40cdd4decbbf11b7ffe and 66405dc21fe04c4aae16605150acfdccd75651bc.

Walkthrough

The recent updates refactor and optimize the SSZ merkleization process, adding systematic vector and list handling while enhancing the SSZObject interface to include SSZ marshalling. Key functions are renamed for consistency, improving readability and usability within the merkleizer framework.

Changes

Files Change Summary
mod/.../ssz/merkleizer/merkleizer.go Simplified New function initialization, renamed functions, and refactored pack method.
mod/.../ssz/merkleizer/merkleizer_vector.go Introduced MerkleizeVectorBasic and MerkleizeVectorComposite functions for SSZ merkleization.
mod/.../ssz/merkleizer/pack.go Added functions for packing SSZ-marshallable elements, chunkifying, and packing bitlists.
mod/.../ssz/merkleizer/merkelizer_list.go Updated MerkleizeListBasic method with new packing process and a return value.
mod/.../ssz/types.go Added MarshalSSZ method to SSZObject interface for SSZ format marshalling.
mod/.../ssz/vector.go Renamed methods for hashing operations, added new methods, and updated type and method signatures.
mod/.../ssz/list.go Renamed internal fields, updated method signatures, added new methods, and updated existing ones.

Poem

In bytes and bits, we mend and weave, Sealing secrets with a Merkle leaf. Vectors and lists in SSZ, Pack and hash in a nimble way. Now our code flows like the breeze, Efficient and swift, with elegant ease. 🚀

[!TIP]

Early access features - OpenAI `gpt-4o` model for reviews and chat. Note: - You can disable early access features from the CodeRabbit UI or by setting `early_access: false` in the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are always opted into early access features.
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

Attention: Patch coverage is 5.55556% with 170 lines in your changes missing coverage. Please review.

Project coverage is 22.38%. Comparing base (e7570f4) to head (66405dc).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/berachain/beacon-kit/pull/1654/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/1654?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) ```diff @@ Coverage Diff @@ ## main #1654 +/- ## ========================================== - Coverage 22.99% 22.38% -0.61% ========================================== Files 268 270 +2 Lines 11840 11885 +45 Branches 18 18 ========================================== - Hits 2723 2661 -62 - Misses 8989 9104 +115 + Partials 128 120 -8 ``` | [Files](https://app.codecov.io/gh/berachain/beacon-kit/pull/1654?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) | Coverage Δ | | |---|---|---| | [mod/primitives/pkg/bytes/b32.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1654?src=pr&el=tree&filepath=mod%2Fprimitives%2Fpkg%2Fbytes%2Fb32.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3ByaW1pdGl2ZXMvcGtnL2J5dGVzL2IzMi5nbw==) | `72.22% <0.00%> (-9.03%)` | :arrow_down: | | [mod/primitives/pkg/ssz/merkleizer/merkleizer.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1654?src=pr&el=tree&filepath=mod%2Fprimitives%2Fpkg%2Fssz%2Fmerkleizer%2Fmerkleizer.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3ByaW1pdGl2ZXMvcGtnL3Nzei9tZXJrbGVpemVyL21lcmtsZWl6ZXIuZ28=) | `0.00% <0.00%> (-51.67%)` | :arrow_down: | | [...d/primitives/pkg/ssz/merkleizer/merkelizer\_list.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1654?src=pr&el=tree&filepath=mod%2Fprimitives%2Fpkg%2Fssz%2Fmerkleizer%2Fmerkelizer_list.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3ByaW1pdGl2ZXMvcGtnL3Nzei9tZXJrbGVpemVyL21lcmtlbGl6ZXJfbGlzdC5nbw==) | `0.00% <0.00%> (ø)` | | | [...primitives/pkg/ssz/merkleizer/merkleizer\_vector.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1654?src=pr&el=tree&filepath=mod%2Fprimitives%2Fpkg%2Fssz%2Fmerkleizer%2Fmerkleizer_vector.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3ByaW1pdGl2ZXMvcGtnL3Nzei9tZXJrbGVpemVyL21lcmtsZWl6ZXJfdmVjdG9yLmdv) | `0.00% <0.00%> (ø)` | | | [mod/primitives/pkg/ssz/merkleizer/pack.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1654?src=pr&el=tree&filepath=mod%2Fprimitives%2Fpkg%2Fssz%2Fmerkleizer%2Fpack.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3ByaW1pdGl2ZXMvcGtnL3Nzei9tZXJrbGVpemVyL3BhY2suZ28=) | `0.00% <0.00%> (ø)` | | | [mod/primitives/pkg/ssz/vector.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1654?src=pr&el=tree&filepath=mod%2Fprimitives%2Fpkg%2Fssz%2Fvector.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3ByaW1pdGl2ZXMvcGtnL3Nzei92ZWN0b3IuZ28=) | `22.95% <20.40%> (-9.61%)` | :arrow_down: | | [mod/primitives/pkg/ssz/list.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/1654?src=pr&el=tree&filepath=mod%2Fprimitives%2Fpkg%2Fssz%2Flist.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3ByaW1pdGl2ZXMvcGtnL3Nzei9saXN0Lmdv) | `0.00% <0.00%> (ø)` | |