Skip to content

fix: avoid unnecessary calls draw() when no juror is available #2002

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

jaybuidl
Copy link
Member

@jaybuidl jaybuidl commented May 19, 2025

⚠️ Requires upgrading KlerosCore


PR-Codex overview

This PR focuses on upgrading the KlerosCore and KlerosCoreNeo contracts to a new version and updating related initialization functions. It also enhances the draw function in KlerosCoreBase to return the number of drawn jurors and introduces logic in the keeperBot script for handling juror draws.

Detailed summary

  • Updated KlerosCore and KlerosCoreNeo contracts' version from 0.9.3 and 0.8.0 to 0.9.4.
  • Changed initialization function name from initialize4 to initialize5 in both KlerosCore and KlerosCoreNeo.
  • Modified draw function in KlerosCoreBase to return nbDrawnJurors.
  • Added logic in keeperBot for simulating draw iterations and logging juror availability.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • New Features

    • The draw function now returns the total number of jurors drawn, providing more transparency after each operation.
  • Bug Fixes

    • Improved the juror drawing process to avoid unnecessary draw attempts when no additional jurors can be drawn, reducing wasted transactions.
  • Chores

    • Updated contract versions to 0.9.4.
    • Changed the contract upgrade process to use a new initializer.

Copy link

netlify bot commented May 19, 2025

Deploy Preview for kleros-v2-testnet-devtools ready!

Name Link
🔨 Latest commit 9e8aa9e
🔍 Latest deploy log https://app.netlify.com/projects/kleros-v2-testnet-devtools/deploys/682b4e9c1216e30008288f20
😎 Deploy Preview https://deploy-preview-2002--kleros-v2-testnet-devtools.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented May 19, 2025

Deploy Preview for kleros-v2-neo ready!

Name Link
🔨 Latest commit 9e8aa9e
🔍 Latest deploy log https://app.netlify.com/projects/kleros-v2-neo/deploys/682b4e9caeab6b0008ab42b9
😎 Deploy Preview https://deploy-preview-2002--kleros-v2-neo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented May 19, 2025

Deploy Preview for kleros-v2-testnet ready!

Name Link
🔨 Latest commit 9e8aa9e
🔍 Latest deploy log https://app.netlify.com/projects/kleros-v2-testnet/deploys/682b4e9c08204b0008f79756
😎 Deploy Preview https://deploy-preview-2002--kleros-v2-testnet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented May 19, 2025

"""

Walkthrough

The changes update the core contract's upgrade process to use a new initializer, revise the draw function in KlerosCoreBase to return the number of jurors drawn, and enhance the keeper bot script to simulate and pre-check juror draws before executing transactions. The contract version is incremented accordingly.

Changes

File(s) Change Summary
contracts/deploy/upgrade-all.ts Modified the core contract upgrade to use the "initialize5" initializer instead of "initialize4".
contracts/scripts/keeperBot.ts Introduced a simulation step before juror draws: added a constant for max draw calls, simulated draws to estimate juror availability, and added logic to avoid unnecessary draw transactions if no jurors are available.
contracts/src/arbitration/KlerosCoreBase.sol Updated the draw function to return a uint256 representing the number of jurors drawn in the current round, changing its signature and adding a return statement.
contracts/src/arbitration/KlerosCoreNeo.sol Updated contract version from "0.8.0" to "0.9.4"; renamed initializer function from initialize4() (reinitializer 4) to initialize5() (reinitializer 5), with no changes to the function body.
contracts/src/arbitration/KlerosCore.sol Updated contract version from "0.9.3" to "0.9.4"; renamed the reinitializer function from initialize4() (reinitializer 4) to initialize5() (reinitializer 5), with no changes to the function body.

Sequence Diagram(s)

sequenceDiagram
    participant KeeperBot
    participant CoreContract

    KeeperBot->>CoreContract: staticcall draw(disputeID, simulatedIterations)
    CoreContract-->>KeeperBot: returns simulated drawn jurors
    KeeperBot->>CoreContract: get current number of drawn jurors
    KeeperBot->>KeeperBot: calculate extraJurors
    alt extraJurors > 0
        KeeperBot->>CoreContract: draw(disputeID, iterations)
        CoreContract-->>KeeperBot: returns number of jurors drawn
    else extraJurors <= 0
        KeeperBot->>KeeperBot: log warning, skip draw
    end
Loading

Possibly related PRs

Poem

A hop, a skip, a juror drawn,
The core upgrades, the bot moves on.
Version bumps and checks anew,
Only drawing when jurors accrue.
With every round, the logic’s tight—
Justice leaps by day and night!
🐇✨
"""

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 7123f43 and 9e8aa9e.

📒 Files selected for processing (2)
  • contracts/src/arbitration/KlerosCore.sol (2 hunks)
  • contracts/src/arbitration/KlerosCoreNeo.sol (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • contracts/src/arbitration/KlerosCore.sol
  • contracts/src/arbitration/KlerosCoreNeo.sol
⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: Redirect rules - kleros-v2-neo
  • GitHub Check: Header rules - kleros-v2-neo
  • GitHub Check: Pages changed - kleros-v2-neo
  • GitHub Check: Redirect rules - kleros-v2-testnet-devtools
  • GitHub Check: Header rules - kleros-v2-testnet-devtools
  • GitHub Check: Pages changed - kleros-v2-testnet-devtools
  • GitHub Check: SonarCloud
  • GitHub Check: Analyze (javascript)
  • GitHub Check: contracts-testing

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in 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 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.

@jaybuidl jaybuidl added Type: Bug 🐛 Compatibility: ABI change 🗯 Smart contract ABI is changing. Package: Contracts Court smart contracts Package: Bots Court bots labels May 19, 2025
@jaybuidl jaybuidl self-assigned this May 19, 2025
@jaybuidl jaybuidl requested a review from unknownunknown1 May 19, 2025 15:23
coderabbitai[bot]
coderabbitai bot previously approved these changes May 19, 2025
Copy link

netlify bot commented May 19, 2025

Deploy Preview for kleros-v2-university failed. Why did it fail? →

Name Link
🔨 Latest commit 9e8aa9e
🔍 Latest deploy log https://app.netlify.com/projects/kleros-v2-university/deploys/682b4e9c04340c0008ce1c5a

Copy link

codeclimate bot commented May 19, 2025

Code Climate has analyzed commit 7123f43 and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category Count
Complexity 1

View more on Code Climate.

coderabbitai[bot]
coderabbitai bot previously approved these changes May 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Compatibility: ABI change 🗯 Smart contract ABI is changing. Package: Bots Court bots Package: Contracts Court smart contracts Type: Bug 🐛
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Keeper bot: do not call draw() if no juror are available to be drawn
1 participant