feat(ssz): ByteVector[WIP]

itsdevbear commented 3 months ago

Summary by CodeRabbit

New Features
- Introduced constants for transaction size limits, logs bloom filter bytes, and maximum extra data bytes.
- Added Default and IsZero methods for various primitive types.
Bug Fixes
- Corrected transaction handling by switching to BartioTransactionsFromBytes method, ensuring accurate transaction root calculations.
Optimizations
- Enhanced HashTreeRootWith method for VectorBasic type, optimizing performance.
Refactor
- Renamed package from ssz to constants for better clarity.
- Adjusted interfaces by relocating IsFixed() to Base and removing it from Composite.

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 (a35bdb8) to head (db4ac1b). Report is 1 commits behind head on main.

Additional details and impacted files

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

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes primarily involve updating transaction handling in various Go files, transitioning from the Transactions method to the BartioTransactionsFromBytes method. Additionally, new constants, methods, and interface modifications were introduced to enhance functionality and optimize performance.

Changes

Files/Paths	Change Summary
`mod/cli/pkg/commands/genesis/payload.go`	Updated function call from `Transactions` to `BartioTransactionsFromBytes` for txsRoot calculation.
`mod/consensus-types/pkg/genesis/genesis.go`	Replaced `engineprimitives.Transactions{}` with `engineprimitives.BartioTransactions{}` in a function.
`mod/consensus-types/pkg/types/payload.go`	Changed method call to `BartioTransactionsFromBytes` and adjusted subsequent method chaining.
`mod/engine-primitives/pkg/engine-primitives/transactions.go`	Updated `Transactions` to use `ssz.ListComposite`, added `TransactionsFromBytes` function, adjusted `TxsMerkleizer`.
`mod/engine-primitives/pkg/engine-primitives/transactions_test.go`	Updated transaction initialization in tests to use `BartioTransactionsFromBytes`.
`mod/primitives/pkg/constants/payload.go`	Added constants for transaction size limits, bytes in logs bloom filter, and maximum extra data bytes.
`mod/primitives/pkg/ssz/basic.go`	Added `Default` and `IsZero` methods for various primitive types.
`mod/primitives/pkg/ssz/constants/constants.go`	Changed package name from `ssz` to `constants`.
`mod/primitives/pkg/ssz/constraints.go`	Added `IsFixed()` to `Base` interface, removed `IsFixed()` from `Composite` interface.
`mod/primitives/pkg/ssz/vector.go`	Optimized `HashTreeRootWith` method for `VectorBasic` type, added specialized merkleizer for `Vector` of `Bytes`.

Poem

Amid the bytes and lines of Go,
Transactions learnt a brand new show,
From Bartio bytes they now do spring,
Constants and defaults, they all now sing.
Hash roots and vectors, optimized anew,
Code rabbits cheer with a hippity-hop hue.
🎉✨🐇👩‍💻

[!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. - 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.

berachain / beacon-kit