feat(OptimismProxy): bridging check

[unknownunknown1]

Summary by CodeRabbit

• New Features

  • Introduced a new arbitration status to track when a ruling has been relayed.
  • Enhanced the arbitration process to allow multiple relay attempts while ensuring disputes are processed correctly.

• Bug Fixes

  • Adjusted the handling of failed dispute actions to preserve deposits and maintain proper status.

• Tests

  • Updated validations and error checks to align with the improved arbitration logic and outcome expectations.

[coderabbitai]

Walkthrough

The changes update the arbitration handling in the RealitioForeignProxyOptimism contract by adding a new Relayed status in the Status enum and introducing a new relayRule function. The logic in handleFailedDisputeCreation has been modified to retain deposits and allow multiple invocations, and the calculation of the ruling now uses arbitration.answer. Additionally, the emitted events have been updated. Corresponding test cases have been adjusted to reflect these new status expectations and error handling.

Changes

File(s)	Change Summary
contracts/src/0.8/RealitioForeignProxyOptimism.sol	- Added new enum member Relayed in Status - Introduced relayRule function to relay rulings - Modified handleFailedDisputeCreation to retain deposit and allow repeated calls - Updated ruling calculation and event emissions to reflect relaying functionality
contracts/test/foreign-proxy-optimism.test.js	- Updated status assertions (e.g., from 4 to 5, and 0 to 5) for failed dispute creation and ruling process - Added assertion for revert with "Failed TxToL1" - Streamlined event checks, including for the new RulingRelayed event

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Proxy as RealitioForeignProxyOptimism
    participant Home as Home Proxy
    User->>Proxy: Call relayRule(questionID, requester)
    Proxy->>Proxy: Verify arbitration status (Ruled or Relayed)
    Proxy->>Home: Relay ruling using arbitration.answer
    Home-->>Proxy: Confirm ruling receipt
    Proxy->>User: Emit RulingRelayed event

Loading

Possibly related PRs

• Feat/gnosis proxy compiler bump #54: Addresses similar functionality regarding the handling of relay functions in arbitration, offering context for changes related to the relayRule modifications.

Suggested reviewers

• jaybuidl

Poem

Hop along, dear coder, in the field of change,
I’m a bunny with updates, rearranging the range.
New statuses bloom and rules now relay,
In smart contract meadows where events brightly play.
With a skip and a hop, I celebrate the code today! 🐇

Happy coding in a whimsical way!

---

📜 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 3ad842a and 2c7a027.

📒 Files selected for processing (2)

• contracts/src/0.8/RealitioForeignProxyOptimism.sol (3 hunks)
• contracts/test/foreign-proxy-optimism.test.js (4 hunks)

🔇 Additional comments (10)

contracts/src/0.8/RealitioForeignProxyOptimism.sol (5)

43-43: LGTM! Adding Relayed status improves state tracking

The addition of the Relayed status to the enum improves the contract's ability to track the state of arbitration requests after a ruling has been relayed to the home proxy.

---

241-243: Good approach to prevent intentional blocking

The modification to retain the status instead of nullifying it allows the function to be called multiple times, effectively preventing malicious actors from intentionally blocking the arbitration process. The comment explaining this is helpful.

---

417-418: LGTM! Event emission for ruling

Properly emitting the Ruling event with the correct parameters.

---

420-441: Well-designed relay mechanism with appropriate safeguards

The new relayRule function effectively separates the ruling process from the relay process, improving modularity. The check for either Status.Ruled or Status.Relayed provides resilience by allowing multiple relay attempts if needed, preventing potential blocking attacks.

---

432-433: LGTM! Consistent ruling calculation

Using arbitration.answer instead of finalRuling is consistent with the new architecture where the ruling is stored in the arbitration structure, making the code more maintainable.

contracts/test/foreign-proxy-optimism.test.js (5)

278-278: LGTM! Updated status assertion

Correctly updated the expected status check to match the new Status enum values.

---

293-294: LGTM! Test updated to reflect retained status

The test now correctly expects the status to remain as Failed (5) after handling a failed dispute creation, matching the contract modification to not nullify the status.

---

300-302: Good test for repeated function call

Adding a test to verify that calling handleFailedDisputeCreation a second time reverts properly ensures the function behaves as expected when dealing with multiple attempts.

---

320-332: LGTM! Properly testing the new relay functionality

The test case has been updated to verify the new relayRule function, checking that it properly updates the status to Relayed (4) and emits the correct events.

---

346-348: Good defensive test for multiple relay attempts

This test ensures that attempting to relay a rule multiple times after the arbitration has been finalized properly reverts, which is important for ensuring the contract handles edge cases correctly.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 plan to trigger planning for file edits and PR creation.
• @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 or @coderabbitai title 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.