kleros / kleros-v2

Kleros version 2
https://v2.kleros.builders
MIT License
61 stars 43 forks source link

feat(DisputeKit): add flushing feature #1653

Open unknownunknown1 opened 2 months ago

unknownunknown1 commented 2 months ago

PR-Codex overview

The focus of this PR is to enhance the arbitration system by allowing unstaking of ineligible jurors and adding functionality to set stakes for dispute kits.

Detailed summary

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

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The updates enhance the management of dispute kits within the Kleros arbitration framework by introducing a disputeKitIDs mapping in the KlerosCoreBase contract. Additionally, the DisputeKitSybilResistant contract now features a flush function to efficiently unstake ineligible jurors. These improvements aim to streamline the jury selection process, ensuring that only qualified jurors participate, thus optimizing the overall arbitration system.

Changes

File Path Change Summary
contracts/src/arbitration/KlerosCoreBase.sol Added mapping(IDisputeKit => uint256) public disputeKitIDs for enhanced dispute kit management. Renamed setStakeBySortitionModule to setStakeBySortitionModuleOrDK and updated error handling.
contracts/src/arbitration/SortitionModuleBase.sol Replaced instances of setStakeBySortitionModule with setStakeBySortitionModuleOrDK to reflect updated authorization.
contracts/src/arbitration/dispute-kits/DisputeKitSybilResistant.sol Introduced a flush function to unstake ineligible jurors, improving jury selection efficiency.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DisputeKitSybilResistant
    participant KlerosCoreBase

    User ->> DisputeKitSybilResistant: flush(_juror, _courts)
    DisputeKitSybilResistant ->> KlerosCoreBase: check eligibility
    KlerosCoreBase -->> DisputeKitSybilResistant: eligibility status
    DisputeKitSybilResistant ->> KlerosCoreBase: unstake(_juror) if ineligible

Possibly related issues

Poem

In codes we weave, in bytes we trust,
To keep the jurors fair and just.
Dispute kits now with IDs clear,
And jurors unstaked, we hold dear.
A Sybil's touch, we now resist,
Efficiency in our midst.
With every line, our justice grows,
In blockchain's realm, the fairness shows.


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
netlify[bot] commented 2 months ago

Deploy Preview for kleros-v2-neo ready!

Name Link
Latest commit 748c9b0a551bae9a395b0f4531b3e8da61ebee8f
Latest deploy log https://app.netlify.com/sites/kleros-v2-neo/deploys/66a9fb55e8e2450008b3a8e8
Deploy Preview https://deploy-preview-1653--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 site configuration.

netlify[bot] commented 2 months ago

Deploy Preview for kleros-v2-testnet ready!

Name Link
Latest commit 748c9b0a551bae9a395b0f4531b3e8da61ebee8f
Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet/deploys/66a9fb559fedff000866d709
Deploy Preview https://deploy-preview-1653--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 site configuration.

netlify[bot] commented 2 months ago

Deploy Preview for kleros-v2-university ready!

Name Link
Latest commit 748c9b0a551bae9a395b0f4531b3e8da61ebee8f
Latest deploy log https://app.netlify.com/sites/kleros-v2-university/deploys/66a9fb55a7dac50008c1b41b
Deploy Preview https://deploy-preview-1653--kleros-v2-university.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 site configuration.

sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

codeclimate[bot] commented 1 month ago

Code Climate has analyzed commit 748c9b0a and detected 0 issues on this pull request.

View more on Code Climate.