Skip to content
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

refactor(sender): split signer address checks into gas-oracle and rollup-relayer #1568

Merged

Conversation

colinlyguo
Copy link
Member

@colinlyguo colinlyguo commented Dec 5, 2024

Purpose or design rationale of this PR

Decouples the config dependencies so that gas-oracle and rollup-relayer only need to initialize the needed accounts.

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:

  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance

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

  • New Features

    • Simplified error handling for sender address validation in the Layer2 Relayer service.
    • Updated error messages to align with the new validation logic focusing on commit and finalize sender addresses.
  • Bug Fixes

    • Improved control flow and error handling related to sender address configurations.
  • Chores

    • Version updated from v4.4.79 to v4.4.80.

Copy link

coderabbitai bot commented Dec 5, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

level=warning msg="[runner] Can't run linter goanalysis_metalinter: buildir: failed to load package : could not load export data: no export data for "scroll-tech/rollup/mock_bridge""
level=error msg="Running error: can't run linter goanalysis_metalinter\nbuildir: failed to load package : could not load export data: no export data for "scroll-tech/rollup/mock_bridge""

Walkthrough

The changes in this pull request focus on the NewLayer2Relayer function within the l2_relayer.go file. The error handling logic has been simplified to validate only the commit and finalize sender addresses for uniqueness, omitting the gas oracle sender address. This adjustment alters the control flow and error messaging while retaining the initialization of the relevant sender addresses. Additionally, the version number in version.go has been incremented from v4.4.79 to v4.4.80, reflecting an update in the versioning information.

Changes

File Path Change Summary
rollup/internal/controller/relayer/l2_relayer.go Modified the NewLayer2Relayer function to simplify error handling for sender addresses, focusing on commit and finalize addresses. Updated error messages accordingly.
common/version/version.go Updated the version tag from v4.4.79 to v4.4.80.

Possibly related PRs

Suggested reviewers

  • georgehao
  • 0xmountaintop
  • jonastheis

🐇 In the meadow, I hop and play,
With sender addresses, we’ve found a way.
Commit and finalize, now they shine,
Gas oracle's check? No longer a line.
Streamlined paths, we leap with glee,
In the world of code, we're wild and free! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6d7822a and 42e9987.

📒 Files selected for processing (1)
  • rollup/internal/controller/relayer/l2_relayer.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • rollup/internal/controller/relayer/l2_relayer.go

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

🧹 Outside diff range and nitpick comments (1)
rollup/internal/controller/relayer/l2_relayer.go (1)

90-100: LGTM! Consider enhancing the error message.

The address validation logic is well-implemented and aligns with the PR objective of splitting signer checks. However, the error message could be more specific about why the addresses must be different.

-			return nil, fmt.Errorf("commit, and finalize sender addresses must be different. Got: Commit=%s, Finalize=%s", commitSenderAddr.Hex(), finalizeSenderAddr.Hex())
+			return nil, fmt.Errorf("commit and finalize sender addresses must be different to ensure security separation of concerns. Got: Commit=%s, Finalize=%s", commitSenderAddr.Hex(), finalizeSenderAddr.Hex())
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fa2401c and 5dcdbae.

📒 Files selected for processing (1)
  • rollup/internal/controller/relayer/l2_relayer.go (1 hunks)
🔇 Additional comments (1)
rollup/internal/controller/relayer/l2_relayer.go (1)

90-100: Verify contract requirements for address separation.

Let's verify that the L1 rollup contract enforces these address separation requirements.

@codecov-commenter
Copy link

codecov-commenter commented Dec 5, 2024

Codecov Report

Attention: Patch coverage is 18.18182% with 9 lines in your changes missing coverage. Please review.

Project coverage is 52.06%. Comparing base (fa2401c) to head (42e9987).

Files with missing lines Patch % Lines
rollup/internal/controller/relayer/l2_relayer.go 18.18% 6 Missing and 3 partials ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1568   +/-   ##
========================================
  Coverage    52.06%   52.06%           
========================================
  Files          157      157           
  Lines        12479    12472    -7     
========================================
- Hits          6497     6494    -3     
+ Misses        5421     5418    -3     
+ Partials       561      560    -1     
Flag Coverage Δ
rollup 57.15% <18.18%> (+0.02%) ⬆️

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.

@colinlyguo colinlyguo added the bump-version Bump the version tag for deployment label Dec 5, 2024
georgehao
georgehao previously approved these changes Dec 6, 2024
johnsonjie
johnsonjie previously approved these changes Dec 6, 2024
@colinlyguo colinlyguo dismissed stale reviews from johnsonjie and georgehao via 42e9987 December 6, 2024 05:08
@colinlyguo colinlyguo merged commit 968a396 into develop Dec 6, 2024
6 checks passed
@colinlyguo colinlyguo deleted the refactor-sender-split-signer-address-uniqueness-checks branch December 6, 2024 05:22
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.

4 participants