search

berachain / beacon-kit

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

fix(state-transition): fix deposit index upon genesis processing #2116

Closed abi87 closed 2 weeks ago

abi87 commented 2 weeks ago

Fixes https://github.com/berachain/beacon-kit/issues/1538

The more general cleanup to drop Eth1Data is deferred to a future PR

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 weeks ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces several changes across multiple files, focusing on enhancing mock generation, testing capabilities, and state processing in the blockchain environment. Key updates include the addition of a new package in the .mockery.yaml for generating mocks of the ExecutionEngine, the creation of a testing setup in helpers_test.go, and modifications to the StateProcessor struct to track genesis processing. Furthermore, new interfaces and error handling improvements are implemented to refine the state transition logic.

Changes

File Path Change Summary
.mockery.yaml Added package github.com/berachain/beacon-kit/mod/state-transition/pkg/core with specific configuration.
mod/state-transition/pkg/core/helpers_test.go Introduced testing types and functions for state transitions, including TestKVStoreService and initTestStore.
mod/state-transition/pkg/core/mocks/execution_engine.mock.go Added mock implementation for ExecutionEngine with methods for simulating behavior during tests.
mod/state-transition/pkg/core/state_processor.go Added processingGenesis boolean field to StateProcessor struct for genesis initialization tracking.
mod/state-transition/pkg/core/state_processor_genesis.go Updated InitializePreminedBeaconStateFromEth1 to include processingGenesis logic.
mod/state-transition/pkg/core/state_processor_genesis_test.go Created test suite for validating state processor functionality with Ethereum 1.0 data.
mod/state-transition/pkg/core/state_processor_staking.go Enhanced error handling and control flow in deposit processing functions.
mod/state-transition/pkg/core/types.go Introduced new Withdrawals interface and updated ExecutionEngine to reference it.

Assessment against linked issues

Objective Addressed Explanation
Fix eth1 deposit index to start at 0 (1538) ✅

Possibly related PRs

Suggested reviewers

Poem

🐇 In the land of code where bunnies hop,
New mocks and tests, we never stop!
With states and transitions, we play all day,
Building a future in a blockchain way.
So here’s to the changes, both big and small,
Together we code, together we stand tall! 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 80.00000% with 6 lines in your changes missing coverage. Please review.

Project coverage is 24.81%. Comparing base (4a9fe1c) to head (f4c7519). Report is 3 commits behind head on state-transition-add-UTs.

Files with missing lines Patch % Lines
...ate-transition/pkg/core/state_processor_staking.go 63.63% 3 Missing and 1 partial :warning:
...ate-transition/pkg/core/state_processor_genesis.go 89.47% 0 Missing and 2 partials :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/berachain/beacon-kit/pull/2116/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/2116?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) ```diff @@ Coverage Diff @@ ## state-transition-add-UTs #2116 +/- ## ============================================================ + Coverage 24.75% 24.81% +0.06% ============================================================ Files 357 357 Lines 16047 16057 +10 Branches 12 12 ============================================================ + Hits 3972 3985 +13 + Misses 11879 11878 -1 + Partials 196 194 -2 ``` | [Files with missing lines](https://app.codecov.io/gh/berachain/beacon-kit/pull/2116?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain) | Coverage Δ | | |---|---|---| | [mod/state-transition/pkg/core/state\_processor.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2116?src=pr&el=tree&filepath=mod%2Fstate-transition%2Fpkg%2Fcore%2Fstate_processor.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3N0YXRlLXRyYW5zaXRpb24vcGtnL2NvcmUvc3RhdGVfcHJvY2Vzc29yLmdv) | `4.72% <ø> (ø)` | | | [...ate-transition/pkg/core/state\_processor\_genesis.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2116?src=pr&el=tree&filepath=mod%2Fstate-transition%2Fpkg%2Fcore%2Fstate_processor_genesis.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3N0YXRlLXRyYW5zaXRpb24vcGtnL2NvcmUvc3RhdGVfcHJvY2Vzc29yX2dlbmVzaXMuZ28=) | `48.95% <89.47%> (+6.73%)` | :arrow_up: | | [...ate-transition/pkg/core/state\_processor\_staking.go](https://app.codecov.io/gh/berachain/beacon-kit/pull/2116?src=pr&el=tree&filepath=mod%2Fstate-transition%2Fpkg%2Fcore%2Fstate_processor_staking.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=berachain#diff-bW9kL3N0YXRlLXRyYW5zaXRpb24vcGtnL2NvcmUvc3RhdGVfcHJvY2Vzc29yX3N0YWtpbmcuZ28=) | `25.43% <63.63%> (+1.76%)` | :arrow_up: |