Skip to content

fix(DK): no empty addresses after draw #2060

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 2 commits into from
Aug 1, 2025
Merged

Conversation

unknownunknown1
Copy link
Contributor

@unknownunknown1 unknownunknown1 commented Jul 30, 2025

PR-Codex overview

This PR focuses on enhancing the DisputeKitClassicBase by adding a check to handle cases where no addresses are drawn due to lack of stakes, along with a new test to ensure that empty addresses are not returned during the drawing phase.

Detailed summary

  • Added a check in DisputeKitClassicBase.sol to return drawnAddress if it is address(0).
  • Introduced a new test function test_draw_noEmptyAddresses in KlerosCore.t.sol to verify that no empty addresses are drawn when no one has staked.
  • Validated that nbVoters is 0 in the new test.

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

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling to ensure that empty (zero) addresses are not processed during juror selection.
  • Tests

    • Added a test to verify that no empty addresses are drawn when there are no jurors staked.

Copy link

netlify bot commented Jul 30, 2025

Deploy Preview for kleros-v2-testnet ready!

Name Link
🔨 Latest commit f080264
🔍 Latest deploy log https://app.netlify.com/projects/kleros-v2-testnet/deploys/688cb4081f3f5400088f5c29
😎 Deploy Preview https://deploy-preview-2060--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

netlify bot commented Jul 30, 2025

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

Name Link
🔨 Latest commit f080264
🔍 Latest deploy log https://app.netlify.com/projects/kleros-v2-neo/deploys/688cb408f09143000836bb2e

Copy link

netlify bot commented Jul 30, 2025

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

Name Link
🔨 Latest commit f080264
🔍 Latest deploy log https://app.netlify.com/projects/kleros-v2-university/deploys/688cb4085b713c000817cf0f

Copy link
Contributor

coderabbitai bot commented Jul 30, 2025

Walkthrough

A zero-address check was added to the juror drawing logic in the dispute kit contract, ensuring that post-draw validation is only performed for non-zero addresses. Additionally, a new test was introduced to verify that no empty addresses are drawn when no jurors are staked.

Changes

Cohort / File(s) Change Summary
DisputeKit Draw Logic Update
contracts/src/arbitration/dispute-kits/DisputeKitClassicBase.sol
Added explicit check for zero address in juror drawing; skips post-draw check and vote addition if no juror is drawn.
Test Coverage
contracts/test/foundry/KlerosCore.t.sol
Added test to ensure no empty addresses are drawn when no jurors are staked.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DisputeKit
    participant SortitionModule

    User->>DisputeKit: draw()
    DisputeKit->>SortitionModule: draw()
    SortitionModule-->>DisputeKit: drawnAddress
    alt drawnAddress != address(0)
        DisputeKit->>DisputeKit: _postDrawCheck(drawnAddress)
        alt _postDrawCheck passes
            DisputeKit->>DisputeKit: Add vote, mark address as drawn
        else _postDrawCheck fails
            DisputeKit->>DisputeKit: Reset drawnAddress to zero
        end
    else drawnAddress == address(0)
        DisputeKit->>DisputeKit: Skip post-draw check, return zero
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related issues

Possibly related PRs

Suggested reviewers

  • unknownunknown1

Poem

🐇 In the meadow where the jurors play,
No empty hops will lead astray.
Draws now clean, no zero in sight,
Justice hops forward, swift and bright.
With checks in place, we leap and bound—
Fair verdicts here, on solid ground! 🌿🐰

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 259ecd5 and f080264.

📒 Files selected for processing (1)
  • contracts/src/arbitration/dispute-kits/DisputeKitClassicBase.sol (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • contracts/src/arbitration/dispute-kits/DisputeKitClassicBase.sol
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
  • GitHub Check: Redirect rules - kleros-v2-university
  • GitHub Check: Header rules - kleros-v2-university
  • GitHub Check: Pages changed - kleros-v2-university
  • 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
  • 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: contracts-testing
  • GitHub Check: Analyze (javascript)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/draw-empty-address-bug

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
🪧 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 docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for 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.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jul 30, 2025
Copy link

netlify bot commented Jul 30, 2025

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

Name Link
🔨 Latest commit f080264
🔍 Latest deploy log https://app.netlify.com/projects/kleros-v2-testnet-devtools/deploys/688cb408a3d70d00088e9916
😎 Deploy Preview https://deploy-preview-2060--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

sonarqubecloud bot commented Aug 1, 2025

@jaybuidl jaybuidl merged commit 05c3f28 into dev Aug 1, 2025
15 of 25 checks passed
@jaybuidl jaybuidl deleted the fix/draw-empty-address-bug branch August 1, 2025 12:37
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.

Dispute Kit bug: do not push address(0) in round.votes when there are no juror staked on the requested court
2 participants