Skip to content

feat: enable p256Verify in EuclidV2 #1111

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 8 commits into from
Feb 6, 2025
Merged

Conversation

colinlyguo
Copy link
Member

@colinlyguo colinlyguo commented Feb 5, 2025

1. Purpose or design rationale of this PR

This PR adds the fork activation of RIP-7212 (p256Verify) precompile in EuclidV2. together with other small tweaks and typos fixes, including:

  • Add RIP-7212 (secp256r1) precompiled contract unit tests to CI.
  • Remove "EIP-7212" naming from precompile comments, which is consistent with the latest version of go implementation here.
  • Fix time-based fork comment: change "block" to "time", which is consistent with the upstream geth's comment style. An example here.

Revisit of the implementation:

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:

  • feat: A new feature

3. Deployment tag versioning

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

  • This PR doesn't involve a new deployment, git tag, docker image tag, and it doesn't affect traces

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change

Summary by CodeRabbit

  • New Features
    • Introduced enhanced support for the EuclidV2 upgrade, expanding smart contract precompilation and improving chain rule processing.
    • Added a new method for checking EuclidV2 fork time.
  • Bug Fixes
    • Clarified existing methods to ensure they operate based on time comparisons rather than block number comparisons.
  • Tests
    • Added new test commands to verify the functionality of the updated contract features.

Copy link

coderabbitai bot commented Feb 5, 2025

Walkthrough

This pull request adds support for the new EuclidV2 release by introducing a new mapping of precompiled contracts. It creates new variables and updates functions in the virtual machine to account for the EuclidV2 chain rule. Additionally, configuration methods and comments are modified to include fork time checks for EuclidV2. These updates span contract mappings, VM control flow modifications, and chain configuration adjustments.

Changes

File(s) Change Summary
core/vm/contracts.go Added PrecompiledContractsEuclidV2 mapping, new PrecompiledAddressesEuclidV2 slice, updated ActivePrecompiles for EuclidV2, and revised comment for p256Verify.
core/vm/evm.go Modified the precompile method to include a branch for the rules.IsEuclidV2 condition, assigning the EuclidV2 precompiled contracts when active.
params/config.go Updated comments for fork time checks, added a new method IsEuclidV2 (with a placeholder implementation), and extended the Rules struct with an IsEuclidV2 field.
Makefile Added a test command for TestPrecompiledP256 in the test target, maintaining the existing structure of the Makefile.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant EVM
    participant ChainConfig
    participant PrecompiledMapping

    Client->>EVM: Call precompile method
    EVM->>ChainConfig: Check fork rule (IsEuclidV2)
    alt EuclidV2 active
        ChainConfig-->>EVM: Return true (EuclidV2)
        EVM->>PrecompiledMapping: Retrieve PrecompiledAddressesEuclidV2
    else Default rules
        ChainConfig-->>EVM: Return false
        EVM->>PrecompiledMapping: Retrieve default precompiled addresses
    end
    PrecompiledMapping-->>EVM: Return addresses
    EVM-->>Client: Process precompiled addresses
Loading

Poem

I'm a rabbit bounding through code so bright,
With EuclidV2 precompiles taking flight.
Address maps and rules in tune,
Config checks under the moon.
Hop, skip, jump — a joyous byte! 🐇✨

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 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 f607c18 and 04b3e40.

📒 Files selected for processing (1)
  • params/config.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • params/config.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test

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. (Beta)
  • @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.

@colinlyguo colinlyguo force-pushed the feat-schedule-RIP-7212 branch from 9a1fa6f to 742f35b Compare February 5, 2025 11:26
Copy link

@Thegaram Thegaram left a comment

Choose a reason for hiding this comment

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

LGTM

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

🔭 Outside diff range comments (1)
params/config.go (1)

771-814: Update String method to include Euclid and EuclidV2.

The String method of ChainConfig should be updated to include the new time-based forks for completeness.

Apply this diff to add the missing forks:

 func (c *ChainConfig) String() string {
     var engine interface{}
     switch {
     case c.Ethash != nil:
         engine = c.Ethash
     case c.Clique != nil:
         engine = c.Clique
     default:
         engine = "unknown"
     }
     darwinTime := "<nil>"
     if c.DarwinTime != nil {
         darwinTime = fmt.Sprintf("@%v", *c.DarwinTime)
     }
     darwinV2Time := "<nil>"
     if c.DarwinV2Time != nil {
         darwinV2Time = fmt.Sprintf("@%v", *c.DarwinV2Time)
     }
+    euclidTime := "<nil>"
+    if c.EuclidTime != nil {
+        euclidTime = fmt.Sprintf("@%v", *c.EuclidTime)
+    }
+    euclidV2Time := "<nil>"
+    if c.EuclidV2Time != nil {
+        euclidV2Time = fmt.Sprintf("@%v", *c.EuclidV2Time)
+    }
-    return fmt.Sprintf("{ChainID: %v Homestead: %v DAO: %v DAOSupport: %v EIP150: %v EIP155: %v EIP158: %v Byzantium: %v Constantinople: %v Petersburg: %v Istanbul: %v, Muir Glacier: %v, Berlin: %v, London: %v, Arrow Glacier: %v, Archimedes: %v, Shanghai: %v, Bernoulli: %v, Curie: %v, Darwin: %v, DarwinV2: %v, Engine: %v, Scroll config: %v}",
+    return fmt.Sprintf("{ChainID: %v Homestead: %v DAO: %v DAOSupport: %v EIP150: %v EIP155: %v EIP158: %v Byzantium: %v Constantinople: %v Petersburg: %v Istanbul: %v, Muir Glacier: %v, Berlin: %v, London: %v, Arrow Glacier: %v, Archimedes: %v, Shanghai: %v, Bernoulli: %v, Curie: %v, Darwin: %v, DarwinV2: %v, Euclid: %v, EuclidV2: %v, Engine: %v, Scroll config: %v}",
🧹 Nitpick comments (3)
params/config.go (3)

903-921: Consider updating the comment for IsEuclid method.

The comment for IsEuclid method incorrectly references "Darwin fork time" instead of "Euclid fork time".

Apply this diff to fix the comment:

-// IsEuclid returns whether time is either equal to the Darwin fork time or greater.
+// IsEuclid returns whether time is either equal to the Euclid fork time or greater.

931-996: Consider updating CheckConfigForkOrder to include time-based forks.

The CheckConfigForkOrder method currently only checks block-based forks. Consider extending it to validate the ordering of time-based forks (Darwin, DarwinV2, Euclid, EuclidV2) to ensure they are properly ordered.


998-1061: Consider updating checkCompatible for time-based forks.

The checkCompatible method should be extended to validate compatibility of time-based forks (Darwin, DarwinV2, Euclid, EuclidV2) when upgrading chain configurations.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1d7bf30 and f607c18.

📒 Files selected for processing (1)
  • params/config.go (4 hunks)
🔇 Additional comments (4)
params/config.go (4)

641-642: LGTM! Field addition follows the established pattern.

The EuclidV2Time field is correctly defined with proper type and JSON tag, maintaining consistency with other time-based fork configurations.


918-921: LGTM! Method implementation is consistent and well-documented.

The IsEuclidV2 method follows the established pattern for time-based fork checks, using the shared isForkedTime helper function.


1135-1135: LGTM! Rules struct update maintains consistency.

The IsEuclidV2 flag is correctly added to the Rules struct, maintaining alphabetical order and grouped with related flags.


1162-1162: LGTM! Rules method update is properly implemented.

The IsEuclidV2 flag is correctly set based on the time check, consistent with other time-based fork flags.

@colinlyguo colinlyguo merged commit ea43834 into develop Feb 6, 2025
9 checks passed
@colinlyguo colinlyguo deleted the feat-schedule-RIP-7212 branch February 6, 2025 08:37
@coderabbitai coderabbitai bot mentioned this pull request Feb 7, 2025
3 tasks
@coderabbitai coderabbitai bot mentioned this pull request Mar 20, 2025
3 tasks
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.

3 participants