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

op-proposer: check at least one of DGFAddress or L2OOAddress was provided #10528

Merged
merged 1 commit into from
May 14, 2024

Conversation

zhiqiangxu
Copy link
Contributor

No description provided.

@zhiqiangxu zhiqiangxu requested a review from a team as a code owner May 13, 2024 23:11
@zhiqiangxu zhiqiangxu requested a review from ajsutton May 13, 2024 23:11
Copy link
Contributor

coderabbitai bot commented May 13, 2024

Walkthrough

Walkthrough

A new validation check has been added to the config.go file within the op-proposer module. This check ensures that either the DisputeGameFactory address or the L2OutputOracle address is provided, but not both or neither. This change helps enforce correct configuration and prevent potential conflicts or misconfigurations.

Changes

File Change Summary
op-proposer/proposer/config.go Added a validation check in Check() to ensure only one address is provided: either DisputeGameFactory or L2OutputOracle.

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 97a4ca8 and aeb4319.
Files selected for processing (1)
  • op-proposer/proposer/config.go (1 hunks)

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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
Contributor

@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: 2

Out of diff range and nitpick comments (2)
op-proposer/proposer/config.go (2)

Line range hint 85-86: Ensure error messages are consistent and clear.

The error message "the DisputeGameFactory address was provided but the ProposalInterval was not set" could be simplified for clarity. Consider rephrasing it to "the DisputeGameFactory address requires a ProposalInterval".

- return errors.New("the `DisputeGameFactory` address was provided but the `ProposalInterval` was not set")
+ return errors.New("the `DisputeGameFactory` address requires a `ProposalInterval`")

Line range hint 87-88: Ensure error messages are consistent and clear.

The error message "the ProposalInterval was provided but the DisputeGameFactory address was not set" could be simplified for clarity. Consider rephrasing it to "the ProposalInterval requires a DisputeGameFactory address".

- return errors.New("the `ProposalInterval` was provided but the `DisputeGameFactory` address was not set")
+ return errors.New("the `ProposalInterval` requires a `DisputeGameFactory` address")

op-proposer/proposer/config.go Show resolved Hide resolved
op-proposer/proposer/config.go Show resolved Hide resolved
@ajsutton ajsutton enabled auto-merge May 14, 2024 00:20
@ajsutton ajsutton added this pull request to the merge queue May 14, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 14, 2024
@tynes tynes added this pull request to the merge queue May 14, 2024
Merged via the queue into ethereum-optimism:develop with commit 6e98522 May 14, 2024
69 checks passed
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