Skip to content

fix(system-contract): Check coinbase during header verification #1128

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

Merged
merged 1 commit into from
Mar 3, 2025

Conversation

Thegaram
Copy link

@Thegaram Thegaram commented Mar 3, 2025

1. Purpose or design rationale of this PR

Adds a strict check so that peers reject blocks with non-zero coinbase field yet. This is necessary because this field is currently not posted to DA.

2. PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • fix: A bug fix

3. Deployment tag versioning

Has the version in params/version.go been updated?

  • Yes

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced validation for critical data consistency checks during processes.
  • Chores

    • Updated the patch version to reflect the latest release improvements.

Copy link

coderabbitai bot commented Mar 3, 2025

Walkthrough

This pull request updates the consensus block header validation in the system contract. It removes the errNonceNotEmpty error and adds a new errInvalidCoinbase error, enforcing that the coinbase value must be empty. Additionally, the patch version in the parameters file is incremented from 16 to 17.

Changes

File Change Summary
consensus/.../consensus.go Removed errNonceNotEmpty, added errInvalidCoinbase for coinbase validations; updated verifyHeader to check coinbase and revised comments.
params/version.go Updated VersionPatch from 16 to 17, reflecting a patch version increment.

Sequence Diagram(s)

sequenceDiagram
    participant B as Block Header
    participant VH as verifyHeader
    B->>VH: Pass block header
    VH->>VH: Check if coinbase is empty
    alt Non-empty coinbase
        VH-->>B: Return errInvalidCoinbase
    else Valid coinbase
        VH-->>B: Continue header validation
    end
Loading

Possibly related PRs

Suggested labels

bump-version

Poem

I'm a hopping rabbit with a coding cheer,
Celebrating changes as the new error draws near.
The nonce has scurried, replaced with clear coinbase might,
Patch versions leap, making our code shine bright.
Through loops and bugs, I bound with delight!
Happy hops in our code this delightful night!

✨ Finishing Touches
  • 📝 Generate Docstrings

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 generate docstrings to generate docstrings for this 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
consensus/system_contract/consensus.go (1)

230-233: Consider adding a comment explaining the consensus requirement.

While the code correctly initializes these fields to zero values, it might be helpful to add a comment explaining why these fields must be empty, especially mentioning the Data Availability layer constraints for future maintainers.

  // Make sure unused fields are empty
+ // These fields must be empty as they are not posted to the Data Availability layer
  header.Coinbase = common.Address{}
  header.Nonce = types.BlockNonce{}
  header.MixDigest = common.Hash{}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1ceb1ba and 062d9dd.

📒 Files selected for processing (2)
  • consensus/system_contract/consensus.go (2 hunks)
  • params/version.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • params/version.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test
🔇 Additional comments (4)
consensus/system_contract/consensus.go (4)

40-41: Added new error for rejecting non-empty coinbase.

This error definition is correctly implemented to enforce the requirement that blocks must have an empty coinbase field.


122-125: LGTM: Implemented proper coinbase verification.

The implementation correctly enforces that the coinbase field must be empty by comparing it against an empty address. This aligns with the PR objective to ensure peers reject blocks containing a non-zero coinbase field, as the coinbase field is not posted to the Data Availability layer.


230-231: Verify the initialization is consistent with validation.

The Prepare method already initializes the coinbase to an empty address, which is consistent with the new validation check. This ensures that blocks created by this node will always pass the new validation rule.


40-44: Ensure error naming conventions are consistent.

The new errInvalidCoinbase error follows a similar pattern to errInvalidNonce. Both errors enforce empty values for their respective fields, which is consistent with the consensus requirements.

@Thegaram Thegaram merged commit 87e1960 into develop Mar 3, 2025
9 checks passed
@Thegaram Thegaram deleted the fix-system-contract-verify-coinbase-zero branch March 3, 2025 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants