fix(state-transition): Withdrawals backward compatibility with Bartio #2148

abi87 · 2024-11-12T11:31:29Z

This PR:

Makes changes introduced in perf(state-transition): reduce amount of withdrawals processed #2110 backward compatible
Hardens Equals methods to handle nil pointer cases (uncovered crash while testing)

coderabbitai · 2024-11-12T11:31:36Z

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.

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, 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 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 for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2024-11-12T11:33:46Z

Codecov Report

Attention: Patch coverage is 31.39535% with 59 lines in your changes missing coverage. Please review.

Project coverage is 26.23%. Comparing base (9cbce04) to head (81d6082).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...ate-transition/pkg/core/state_processor_payload.go	36.36%	14 Missing ⚠️
mod/beacon/blockchain/execution_engine.go	0.00%	12 Missing ⚠️
mod/state-transition/pkg/core/state/statedb.go	14.28%	11 Missing and 1 partial ⚠️
mod/consensus-types/pkg/types/header.go	63.63%	4 Missing ⚠️
...ine-primitives/pkg/engine-primitives/withdrawal.go	63.63%	4 Missing ⚠️
mod/beacon/validator/block_builder.go	0.00%	3 Missing ⚠️
mod/consensus/pkg/types/common.go	0.00%	2 Missing ⚠️
mod/primitives/pkg/transition/context.go	0.00%	2 Missing ⚠️
beacond/cmd/defaults.go	0.00%	1 Missing ⚠️
mod/beacon/blockchain/process.go	0.00%	1 Missing ⚠️
... and 4 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2148      +/-   ##
==========================================
- Coverage   26.24%   26.23%   -0.02%     
==========================================
  Files         360      360              
  Lines       16241    16302      +61     
  Branches       12       12              
==========================================
+ Hits         4263     4277      +14     
- Misses      11709    11755      +46     
- Partials      269      270       +1

Files with missing lines	Coverage Δ
mod/state-transition/pkg/core/state_processor.go	`26.69% <100.00%> (+0.31%)`	⬆️
...ate-transition/pkg/core/state_processor_staking.go	`54.78% <100.00%> (ø)`
beacond/cmd/defaults.go	`0.00% <0.00%> (ø)`
mod/beacon/blockchain/process.go	`0.00% <0.00%> (ø)`
mod/beacon/blockchain/receive.go	`0.00% <0.00%> (ø)`
mod/consensus-types/pkg/types/payload.go	`92.15% <0.00%> (-0.02%)`	⬇️
mod/node-core/pkg/components/state_processor.go	`0.00% <0.00%> (ø)`
...ate-transition/pkg/core/state_processor_genesis.go	`50.00% <50.00%> (ø)`
mod/consensus/pkg/types/common.go	`0.00% <0.00%> (ø)`
mod/primitives/pkg/transition/context.go	`0.00% <0.00%> (ø)`
... and 6 more

…ackward-compatibility-with-bartio

Signed-off-by: aBear <[email protected]>

abi87 · 2024-11-12T13:45:13Z

mod/consensus-types/pkg/types/header.go

-		b.ParentBlockRoot == rhs.ParentBlockRoot &&
-		b.StateRoot == rhs.StateRoot &&
-		b.BodyRoot == rhs.BodyRoot
+	switch {


not strictly related to the fix, but helpful to harden all the custom Equals functions we wrote

…ackward-compatibility-with-bartio

abi87 · 2024-11-12T15:54:52Z

mod/state-transition/pkg/core/state/statedb.go

@@ -266,6 +269,18 @@ func (s *StateDB[

 			// Increment the withdrawal index to process the next withdrawal.
 			withdrawalIndex++
+		} else if s.cs.DepositEth1ChainID() == spec.BartioChainID {


add empty withdrawals for backward compatibility in Bartio.

calbera

makes sense

…ackward-compatibility-with-bartio

abi87 added 7 commits November 12, 2024 09:38

skipped execution payload timestamp validator on Bartio

1e120b3

add logging to state transitions

5d2cd2c

logged consensus height along with payload height

675abd4

wrong test sign

d32eae0

nits

73b7780

nit typo

94e55ee

withdrawals backward compatibility on Bartio

b18ef77

abi87 requested a review from itsdevbear as a code owner November 12, 2024 11:31

abi87 self-assigned this Nov 12, 2024

abi87 added 5 commits November 12, 2024 12:38

appease gosec

f4555ac

simplified heights and timestamps logging

d7fad67

Merge branch 'feature-flag-timestamp-verification' into withdrawals-b…

d53e6c6

…ackward-compatibility-with-bartio

fixed withdrawals append length

2c9308b

let withdrawal Equals handle nil cases

983bde6

Signed-off-by: aBear <[email protected]>

abi87 force-pushed the withdrawals-backward-compatibility-with-bartio branch from 503450a to 983bde6 Compare November 12, 2024 13:39

abi87 commented Nov 12, 2024

View reviewed changes

hardened beacon block header Equals

947777d

abi87 force-pushed the withdrawals-backward-compatibility-with-bartio branch from bb57118 to 947777d Compare November 12, 2024 13:48

abi87 added the Ready for Review label Nov 12, 2024

abi87 added 3 commits November 12, 2024 15:26

some more log fixing

25c5633

Merge branch 'feature-flag-timestamp-verification' into withdrawals-b…

0b3df63

…ackward-compatibility-with-bartio

revert feature flag on withdrawals

3f9495c

abi87 changed the title ~~fix(state-transition): Withdrawals backward compatibility with Bartio~~ fix(state-transition): Hardened Equals methods Nov 12, 2024

fixed backward compatibility

55c5bde

abi87 commented Nov 12, 2024

View reviewed changes

abi87 changed the title ~~fix(state-transition): Hardened Equals methods~~ fix(state-transition): Withdrawals backward compatibility with Bartio Nov 12, 2024

abi87 requested a review from calbera November 12, 2024 17:59

calbera approved these changes Nov 12, 2024

View reviewed changes

abi87 added 4 commits November 13, 2024 10:27

fixed consensus block height initialization

6a21637

Merge branch 'feature-flag-timestamp-verification' into withdrawals-b…

a31d703

…ackward-compatibility-with-bartio

setting block timestamp in a backward compatible manner for Bartio

7480048

Merge branch 'feature-flag-timestamp-verification' into withdrawals-b…

81d6082

…ackward-compatibility-with-bartio

Base automatically changed from feature-flag-timestamp-verification to main November 13, 2024 10:53

abi87 merged commit 666ec28 into main Nov 13, 2024
36 checks passed

abi87 deleted the withdrawals-backward-compatibility-with-bartio branch November 13, 2024 10:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(state-transition): Withdrawals backward compatibility with Bartio #2148

fix(state-transition): Withdrawals backward compatibility with Bartio #2148

abi87 commented Nov 12, 2024 •

edited

Loading

coderabbitai bot commented Nov 12, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Nov 12, 2024 •

edited

Loading

abi87 Nov 12, 2024

abi87 Nov 12, 2024

calbera left a comment

fix(state-transition): Withdrawals backward compatibility with Bartio #2148

fix(state-transition): Withdrawals backward compatibility with Bartio #2148

Conversation

abi87 commented Nov 12, 2024 • edited Loading

coderabbitai bot commented Nov 12, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Nov 12, 2024 • edited Loading

Codecov Report

abi87 Nov 12, 2024

Choose a reason for hiding this comment

abi87 Nov 12, 2024

Choose a reason for hiding this comment

calbera left a comment

Choose a reason for hiding this comment

abi87 commented Nov 12, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Nov 12, 2024 •

edited

Loading