Skip to content

fix: print Euclid genesis config on startup #1118

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
Feb 14, 2025

Conversation

Thegaram
Copy link

@Thegaram Thegaram commented Feb 14, 2025

1. Purpose or design rationale of this PR

Add missing Euclid config logs.

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?

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

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change
  • Yes

Summary by CodeRabbit

  • New Features
    • Added enhanced upgrade tracking with new fields for upgrade timing.
    • Introduced evaluation methods to determine when upgrade thresholds are reached.
    • Improved display output to reflect the additional upgrade timing details.

Copy link

coderabbitai bot commented Feb 14, 2025

Walkthrough

The update introduces two new timestamp fields into the configuration structure to track upgrade timings. The string representation method has been modified to output these new fields. Additionally, two new validation methods check whether a provided time meets or exceeds the upgrade thresholds for Euclid and Euclid V2. These changes enhance the configuration's ability to record and assess the blockchain upgrade timelines.

Changes

File(s) Change Summary
params/config.go - Added EuclidTime and EuclidV2Time fields to ChainConfig
- Updated the String() method to include new fields
- Introduced IsEuclid and IsEuclidV2 methods

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant ChainConfig
    Caller->>ChainConfig: Call String()
    ChainConfig-->>Caller: Return string with EuclidTime & EuclidV2Time

    Caller->>ChainConfig: Call IsEuclid(now)
    alt now >= EuclidTime
        ChainConfig-->>Caller: true
    else
        ChainConfig-->>Caller: false
    end

    Caller->>ChainConfig: Call IsEuclidV2(now)
    alt now >= EuclidV2Time
        ChainConfig-->>Caller: true
    else
        ChainConfig-->>Caller: false
    end
Loading

Suggested reviewers

  • georgehao
  • omerfirmak

Poem

Hoppity, hoppity, I scurry with delight,
EuclidTime fields gleam in code so bright.
Upgrades bloom like carrots in a row,
With checks that ensure the timelines flow.
CodeRabbit cheers—let the improvements glow! 🐇


📜 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 7de11ed and 3df92f5.

📒 Files selected for processing (1)
  • params/config.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test
🔇 Additional comments (5)
params/config.go (5)

641-642: LGTM! New time fields for Euclid forks.

The addition of EuclidTime and EuclidV2Time fields follows the established pattern for fork timing configuration.


789-796: LGTM! String method updated to include Euclid fork times.

The String method is properly updated to handle the new Euclid fork times, maintaining consistency with other fork time representations.


923-931: LGTM! Fork time check methods for Euclid.

The IsEuclid and IsEuclidV2 methods correctly implement the fork time validation using the existing isForkedTime helper.


1145-1145: LGTM! Rules struct and method updated for Euclid.

The Rules struct and method are properly updated to include Euclid fork states, maintaining consistency with other fork flags.

Also applies to: 1171-1172


641-1174:

❓ Verification inconclusive

Verify fork timing configuration.

Please ensure that the Euclid fork timing values are correctly set in the network configurations (e.g., ScrollSepoliaChainConfig, ScrollMainnetChainConfig) where applicable.


🏁 Script executed:

#!/bin/bash
# Search for Euclid time configurations in chain configs
rg -A 5 'EuclidTime.*=' params/

Length of output: 892


Fork Timing Configuration Verification

The configuration file correctly defines EuclidTime and EuclidV2Time in params/config.go. However, please double-check that the network-specific configurations (e.g., ScrollSepoliaChainConfig, ScrollMainnetChainConfig) correctly set these values as intended.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@Thegaram Thegaram merged commit b8c5c74 into develop Feb 14, 2025
9 checks passed
@Thegaram Thegaram deleted the fix-print-euclid-genesis-config branch February 14, 2025 11:49
@coderabbitai coderabbitai bot mentioned this pull request Feb 14, 2025
3 tasks
@coderabbitai coderabbitai bot mentioned this pull request Mar 21, 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.

1 participant