Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(state-transition): enforce valid eth1 withdrawal credentials #2231

Merged
merged 7 commits into from
Dec 10, 2024

Conversation

calbera
Copy link
Contributor

@calbera calbera commented Dec 9, 2024

State Transition Changes:

  • Ignore creation of validators with a non 0x01 byte prefix in their withdrawal credentials
  • In statedb ExpectedWithdrawals only convert Credentials to Address if we know for sure it has the 0x01 byte prefix (to avoid erroring out)

No explicit backwards compatibility handling technically required since on bartio and boonet we do not encounter any deposits with a non 0x01 byte prefix in their withdrawal credentials

Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

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.


🪧 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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

Copy link

codecov bot commented Dec 9, 2024

Codecov Report

Attention: Patch coverage is 23.43750% with 49 lines in your changes missing coverage. Please review.

Project coverage is 29.53%. Comparing base (b00e245) to head (be5bb95).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...tate-transition/core/state_processor_validators.go 11.53% 23 Missing ⚠️
state-transition/core/state/statedb.go 25.00% 10 Missing and 2 partials ⚠️
state-transition/core/state_processor_staking.go 11.11% 7 Missing and 1 partial ⚠️
state-transition/core/state_processor_genesis.go 42.85% 4 Missing ⚠️
consensus-types/types/deposit.go 0.00% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2231      +/-   ##
==========================================
- Coverage   29.56%   29.53%   -0.04%     
==========================================
  Files         353      353              
  Lines       16103    16149      +46     
  Branches       20       20              
==========================================
+ Hits         4761     4769       +8     
- Misses      11026    11062      +36     
- Partials      316      318       +2     
Files with missing lines Coverage Δ
consensus-types/types/validator.go 86.02% <100.00%> (+0.20%) ⬆️
consensus-types/types/deposit.go 84.70% <0.00%> (-2.05%) ⬇️
state-transition/core/state_processor_genesis.go 48.78% <42.85%> (-0.38%) ⬇️
state-transition/core/state_processor_staking.go 59.44% <11.11%> (-3.06%) ⬇️
state-transition/core/state/statedb.go 51.68% <25.00%> (-1.24%) ⬇️
...tate-transition/core/state_processor_validators.go 70.16% <11.53%> (-7.48%) ⬇️

Copy link
Collaborator

@abi87 abi87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a major concern about handling of deposit with wrong credentails. I think we should skip them, not fail the whole block

state-transition/core/state/statedb.go Show resolved Hide resolved
Comment on lines 161 to 166
// Verify that the deposit has the ETH1 withdrawal credentials.
if dep.GetWithdrawalCredentials()[0] != types.EthSecp256k1CredentialPrefix {
return errors.New(
"deposit does not have ETH1 withdrawal credentials",
)
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure we should err here. Similarly to what we do with faulty signature, I think this deposit should be skipped and the others be duly processed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@calbera calbera requested a review from abi87 December 10, 2024 01:41
@abi87 abi87 merged commit e70bafa into main Dec 10, 2024
16 checks passed
@abi87 abi87 deleted the enforce-wd-creds branch December 10, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants