Skip to content

fix(system-contract): Ensure header.coinbase is not set #1127

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

Coinbase must be empty so that L1 follower nodes can reconstruct block hashes.

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

  • Refactor
    • We have enhanced core system processes by refining the initialization and validation steps. These improvements help ensure smoother and more consistent operations, bolstering overall system performance.
  • Chores
    • The patch version has been updated to reflect the latest maintenance and improvements, ensuring you benefit from a more robust and secure release.

Copy link

coderabbitai bot commented Mar 3, 2025

Walkthrough

This pull request updates the consensus system contract and versioning. In the consensus package, the Prepare method now explicitly zeroes fields (Coinbase, Nonce, and MixDigest) and sets the Difficulty to 1, while the Finalize method assigns the Root and UncleHash fields properly. Additionally, the redundant assignment in FinalizeAndAssemble has been removed. In the parameters package, the VersionPatch constant is incremented from 15 to 16.

Changes

File(s) Change Summary
consensus/.../consensus.go Modified Prepare to reset Coinbase, Nonce, and MixDigest, and set Difficulty to 1; updated Finalize to assign Root and UncleHash; removed redundant Root assignment in FinalizeAndAssemble.
params/version.go Incremented the VersionPatch constant from 15 to 16.

Sequence Diagram(s)

sequenceDiagram
    participant BH as BlockHeader
    participant SC as SystemContract

    BH->>SC: Call Prepare()
    SC-->>BH: Zeroes Coinbase, Nonce, MixDigest & sets Difficulty = 1
    BH->>SC: Call Finalize()
    SC-->>BH: Sets Root from intermediate state and calculates UncleHash
    BH->>SC: Call FinalizeAndAssemble()
    SC-->>BH: Uses pre-set Root (redundant assignment removed)
Loading

Suggested labels

bump-version

Suggested reviewers

  • colinlyguo

Poem

Hopping through the code I roam,
Fields reset in a refined home.
Zeroed values and a patch so fine,
Every block now in perfect line.
With a twitch of whiskers, I cheer the flow,
A rabbit’s leap in code, a joyful show!
🐰✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1dedddb and 030c586.

📒 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)

222-226: Explicitly zeroing header fields to ensure correct block hash calculation.

This change properly initializes unused header fields to empty values, which is crucial for consistent block hash generation. This directly addresses the PR objective of ensuring the coinbase field is not set, which L1 follower nodes need for accurate block hash reconstruction.


227-231: LGTM: Clear EuclidV2 field initialization.

The comment provides helpful context about the purpose of these fields. The code correctly initializes EuclidV2-related header fields consistently.


243-245: Explicit difficulty setting aligns with validation requirements.

This addition ensures the difficulty is consistently set to 1, which matches the validation check at lines 136-138. This further enhances block header consistency.


254-255: Proper initialization of Root and UncleHash in Finalize method.

These additions correctly set essential header fields in the Finalize method, ensuring these values are properly initialized before block creation. The Root is set from the state's intermediate root, and UncleHash is properly set to represent empty uncles.

This change likely moves this initialization from FinalizeAndAssemble to Finalize, which is more appropriate since Finalize is called by FinalizeAndAssemble. This ensures these fields are consistently set regardless of how the blocks are created.

✨ 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.

@Thegaram Thegaram merged commit 1ceb1ba into develop Mar 3, 2025
9 checks passed
@Thegaram Thegaram deleted the fix-system-contract-ensure-coinbase-empty branch March 3, 2025 08:53
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.

1 participant