Skip to content

fix(bridge-history): overwrite l2geth dependency by replace #1617

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

Conversation

colinlyguo
Copy link
Member

@colinlyguo colinlyguo commented Mar 11, 2025

Purpose or design rationale of this PR

This PR overwrites l2geth dependency by replace, the dependency is a hotfix commit.

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

Deployment tag versioning

Has tag in common/version.go been updated or have you added bump-version label to this PR?

  • Yes

Breaking change label

Does this PR have the breaking-change label?

  • No, this PR is not a breaking change

Summary by CodeRabbit

  • Chores

    • Improved internal dependency configuration to ensure better compatibility and stability. The update refines how the system manages its integrations, contributing to a smoother experience without altering end-user functionality.
  • Version Update

    • Updated software version from v4.4.94 to v4.4.95, reflecting the latest changes and improvements.

Copy link

coderabbitai bot commented Mar 11, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.

Walkthrough

This change updates the dependency management in the bridge-history-api/go.mod file. The comment previously describing a hotfix for a header hash incompatibility has been removed and replaced by a new replace directive. This directive explicitly sets the dependency for github.com/scroll-tech/go-ethereum to the same version, providing clearer documentation of the hotfix context without altering the version. Additionally, the version tag in common/version/version.go has been updated from "v4.4.94" to "v4.4.95".

Changes

File Change Summary
bridge-history-api/go.mod Removed the inline comment for the hotfix on github.com/scroll-tech/go-ethereum and added a replace directive specifying the dependency to the same version.
common/version/version.go Updated the version tag from "v4.4.94" to "v4.4.95".

Possibly related PRs

  • feat: bump zkvm-prover #1614: The changes in the main PR and this PR both involve updates to the tag variable in the common/version/version.go file, indicating a direct relationship in their modifications.
  • feat: upgrade to euclid-enabled l2geth #1612: The changes in the main PR regarding the go.mod file for bridge-history-api involve a specific version update and replacement directive for github.com/scroll-tech/go-ethereum, while this PR updates the version of the same dependency in the Makefile, indicating a direct relationship at the code level.
  • feat(bridge-history-api): update l2geth dependency for Pectra readiness #1601: The changes in the main PR regarding the go.mod file's dependency management for github.com/scroll-tech/go-ethereum are related to the updates made in this PR, which also modifies the same dependency in the go.mod file.

Suggested reviewers

  • georgehao
  • Thegaram
  • colinlyguo

Poem

I'm just a rabbit, with hops so swift,
Updating dependencies like a breeze, a gentle shift. 🐇
I nibbled through comments, cleared the way,
With a Replace directive, bright as day.
Hop on, sweet coder, let the fixes play!


🪧 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 previously approved these changes Mar 11, 2025
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)
bridge-history-api/go.mod (1)

20-21: Clarify the Replace Directive
The replace directive explicitly overrides github.com/scroll-tech/go-ethereum to the same version, which reinforces the hotfix context for header hash incompatibility. Consider revising the comment to adopt a more formal tone (for example, "Hotfix: header hash incompatibility; update with caution") to improve clarity and future maintainability.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5f79735 and 069b6a1.

📒 Files selected for processing (1)
  • bridge-history-api/go.mod (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: rollup-db-cli
  • GitHub Check: rollup_relayer
  • GitHub Check: gas_oracle
  • GitHub Check: coordinator-cron
  • GitHub Check: coordinator-api
  • GitHub Check: bridgehistoryapi-db-cli
  • GitHub Check: bridgehistoryapi-api
  • GitHub Check: bridgehistoryapi-fetcher
  • GitHub Check: check
  • GitHub Check: test
  • GitHub Check: tests
🔇 Additional comments (1)
bridge-history-api/go.mod (1)

13-13: Confirm Dependency Version Consistency
The dependency version for github.com/scroll-tech/go-ethereum is now explicitly set to v1.10.14-0.20250305084331-57148478e950 in the require block. Please confirm that this version is intentional and consistent with project requirements.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 42.11%. Comparing base (5f79735) to head (069b6a1).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1617   +/-   ##
========================================
  Coverage    42.11%   42.11%           
========================================
  Files          222      222           
  Lines        17741    17741           
========================================
  Hits          7471     7471           
  Misses        9560     9560           
  Partials       710      710           
Flag Coverage Δ
bridge-history-api 8.06% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@colinlyguo colinlyguo changed the title fix(bridge-history): try oevrwriting by replace fix(bridge-history): try overwriting by replace Mar 11, 2025
@colinlyguo colinlyguo added the bump-version Bump the version tag for deployment label Mar 11, 2025
@colinlyguo colinlyguo changed the title fix(bridge-history): try overwriting by replace fix(bridge-history): overwrite l2geth dependency by replace Mar 11, 2025
@colinlyguo colinlyguo requested a review from Thegaram March 11, 2025 11:09
@colinlyguo colinlyguo force-pushed the fix-bridge-history-try-overwriting-by-replace branch from b6548f7 to 035f7b1 Compare March 11, 2025 11:11
@colinlyguo colinlyguo changed the base branch from develop to feat/use-codec-v6 March 11, 2025 11:11
@colinlyguo colinlyguo merged commit eacdc78 into feat/use-codec-v6 Mar 11, 2025
1 check passed
@colinlyguo colinlyguo deleted the fix-bridge-history-try-overwriting-by-replace branch March 11, 2025 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bump-version Bump the version tag for deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants