Skip to content

feat(RealitioProxy): update contract for V2 #1

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 6 commits into from
Jan 16, 2025
Merged

Conversation

unknownunknown1
Copy link
Contributor

@unknownunknown1 unknownunknown1 commented Feb 28, 2024

  • The main proxy contract wasn't actually modified but replaced with the contract from local repo.
  • Governance functions are removed since we never use governance in RealitioProxies.
  • Metaevidence currently uses the old pattern with template registry as a placeholder.

Summary by CodeRabbit

  • New Features

    • Introduced a new RealitioProxyV2 contract with enhanced arbitration functionalities.
    • Added new interfaces IRealitio and IRealitioArbitrator to facilitate external interactions.
    • Implemented new functions for governors to change arbitration parameters and template registries.
    • Added a requestArbitration function for submitting arbitration requests.
    • Introduced a reportAnswer function for reporting answers after rulings.
  • Improvements

    • Updated constructor parameters and initialization for better configuration.
    • Simplified dispute handling by introducing new structs and enums.
    • Enhanced flexibility of dispute templates with dynamic content insertion.
  • Bug Fixes

    • Enhanced error handling to provide clearer feedback for incorrect operations.

Copy link

coderabbitai bot commented Jul 8, 2024

Warning

Rate limit exceeded

@jaybuidl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 35 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8e8577b and 592facf.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (6)
  • .vscode/contract-decorators.code-snippets (1 hunks)
  • contracts/hardhat.config.ts (1 hunks)
  • contracts/package.json (1 hunks)
  • contracts/src/RealityV2.sol (2 hunks)
  • contracts/src/interfaces/IRealitio.sol (1 hunks)
  • contracts/src/interfaces/IRealitioArbitrator.sol (1 hunks)

Walkthrough

In the RealityV2 contract, major updates have been made, starting with renaming the contract to RealitioProxyV2. Key enhancements include adding new functions, modifiers, enums, and structs to improve arbitration handling, constructor parameter updates, and error handling advancements. Additionally, two interfaces have been introduced (IRealitio and IRealitioArbitrator) to streamline interactions with arbitration processes. The deployment logic has also been modified to utilize a new dynamic dispute template function.

Changes

File Change Summary
contracts/deploy/00-reality-v2.ts Updated disputeTemplate to use disputeTemplateFn function for dynamic content; added disputeTemplateMappings variable.
contracts/src/RealityV2.sol The contract RealityV2 renamed to RealitioProxyV2, added new functions, modifiers, structs, enums, and enhanced storage variables, constructor parameters, and error handling.
contracts/src/interfaces/IRealitio.sol Introduced interface IRealitio with functions for arbitration notifications and answer submissions.
contracts/src/interfaces/IRealitioArbitrator.sol Introduced interface IRealitioArbitrator with functions to access Realitio implementation, metadata, and dispute fees.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RealitioProxyV2
    participant IRealitio
    participant IRealitioArbitrator
    
    User->>RealitioProxyV2: requestArbitration(questionID)
    RealitioProxyV2->>IRealitioArbitrator: getDisputeFee(questionID)
    IRealitioArbitrator-->>RealitioProxyV2: disputeFee
    RealitioProxyV2->>IRealitio: notifyOfArbitrationRequest(questionID)
    IRealitio-->>RealitioProxyV2: confirmation
    RealitioProxyV2-->>User: Arbitration Requested

    User->>RealitioProxyV2: rule(questionID, ruling)
    RealitioProxyV2->>IRealitio: assignWinnerAndSubmitAnswerByArbitrator(questionID, answer, ...)
    IRealitio-->>RealitioProxyV2: confirmation
    RealitioProxyV2-->>User: Ruling Submitted
Loading

Poem

In fields where coders daily strive,
Contract changes come alive.
RealitioProxyV2 stands tall,
Handling disputes, addressing all.
New structs, enums to construct,
In code, the magic's now unstuck.
🐇✨ Here's to progress and the code anew,
Realitio, we'll depend on you!


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

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a8eb00a and a7a943a.

Files selected for processing (3)
  • contracts/src/RealityV2.sol (1 hunks)
  • contracts/src/interfaces/IRealitio.sol (1 hunks)
  • contracts/src/interfaces/IRealitioArbitrator.sol (1 hunks)
Additional comments not posted (15)
contracts/src/interfaces/IRealitioArbitrator.sol (3)

21-21: LGTM!

The function signature adheres to best practices.


28-28: LGTM!

The function signature adheres to best practices.


32-32: LGTM!

The function signature adheres to best practices.

contracts/src/interfaces/IRealitio.sol (2)

23-27: LGTM!

The function signature adheres to best practices.


37-43: LGTM!

The function signature adheres to best practices.

contracts/src/RealityV2.sol (10)

66-98: LGTM!

The constructor initializes all parameters correctly and follows best practices.


103-104: LGTM!

The function logic is correct and follows best practices.


111-122: LGTM!

The function logic is correct and follows best practices.


129-135: LGTM!

The function logic is correct and follows best practices.


141-143: LGTM!

The function logic is correct and follows best practices.


149-170: LGTM!

The function logic is correct and follows best practices.


176-188: LGTM!

The function logic is correct and follows best practices.


197-210: LGTM!

The function logic is correct and follows best practices.


215-220: LGTM!

The function logic is correct and follows best practices.


222-226: LGTM!

The error definitions are correct and follow best practices.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jul 8, 2024
@jaybuidl jaybuidl force-pushed the feat/contract-update branch from 25bd8ab to 8e8577b Compare January 16, 2025 19:32
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: 3

🔭 Outside diff range comments (1)
contracts/deploy/00-reality-v2.ts (1)

Line range hint 51-62: Update deployment arguments to match updated contract constructor.

The constructor of RealitioProxyV2 has been updated to include new parameters: _governor, _realitio, _metadata, and _evidenceModule. The deployment script needs to be adjusted to provide these arguments in the correct order.

Apply this diff to update the deployment script:

 await deploy("RealityV2", {
   from: deployer,
   args: [
+    deployer, // _governor
+    realitioAddress, // _realitio (define or obtain the Realitio contract address)
+    metadata, // _metadata (define as needed)
     klerosCore.address, // _arbitrator
     extraData, // _arbitratorExtraData
+    evidenceModuleAddress, // _evidenceModule (deploy or obtain EvidenceModule address)
     disputeTemplateRegistry.address, // _templateRegistry
     disputeTemplate, // _templateData
     disputeTemplateMappings, // _templateDataMappings
-    600, // feeTimeout: 10 minutes (parameter no longer used)
   ],
   log: true,
 });

Ensure that realitioAddress, metadata, and evidenceModuleAddress are defined or obtained before deployment. The feeTimeout parameter appears to be obsolete with the updated constructor and can be removed.

🧹 Nitpick comments (1)
contracts/src/RealityV2.sol (1)

40-42: Remove resolved TODO comment to enhance code clarity.

The TODO comment on line 40 appears to have been addressed by including templateRegistry in the ArbitrationRequest struct. To improve code readability, consider removing the TODO comment.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a7a943a and 8e8577b.

📒 Files selected for processing (2)
  • contracts/deploy/00-reality-v2.ts (2 hunks)
  • contracts/src/RealityV2.sol (2 hunks)

@jaybuidl jaybuidl merged commit 592facf into master Jan 16, 2025
3 checks passed
@jaybuidl jaybuidl deleted the feat/contract-update branch January 16, 2025 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants