feat(web): dispute-maintenance-buttons

Harman-singh-waraich commented 1 month ago

adds dispute maintenance buttons to manually do operations in case bots fails or in development.
The ripple shows when a Period is over or Execution is pending. Not showing it for rewards distribution, since that is not straightforward to determine and want to keep these buttons minimal.

closes #1601

Summary by CodeRabbit

New Features
- Introduced MaintenanceButtons component for managing maintenance actions related to disputes.
- Added action buttons including DrawButton, ExecuteRulingButton, and PassPeriodButton.
- Implemented DistributeRewards component for reward distribution management.
- Added useTransactionBatcher custom hook to facilitate batching of contract transactions.
Enhancements
- Updated the CaseDetails page structure to incorporate the MaintenanceButtons.
- Added nbVotes field to the disputeDetailsQuery for improved tracking of disputes.
- Enhanced GraphQL schema with new fields related to fee management and dispute resolution.

PR-Codex overview

This PR introduces various updates related to dispute details, maintenance, and contract batching.

Detailed summary

Added new fields jurorsDrawn and jurorRewardsDispersed to rounds
Implemented TransactionBatcher contract for batch transactions
Updated UI components for maintenance buttons and case details

The following files were skipped due to too many changes: web/src/pages/Cases/CaseDetails/MaintenanceButtons/MenuButton.tsx, web/src/pages/Cases/CaseDetails/MaintenanceButtons/ExecuteRuling.tsx, subgraph/core/src/KlerosCore.ts, web/src/hooks/useTransactionBatcher.tsx, web/src/pages/Cases/CaseDetails/MaintenanceButtons/DrawButton.tsx, web/src/pages/Cases/CaseDetails/MaintenanceButtons/PassPeriodButton.tsx, web/src/pages/Cases/CaseDetails/MaintenanceButtons/DistributeRewards.tsx, web/src/pages/Cases/CaseDetails/MaintenanceButtons/index.tsx, web/src/pages/Cases/CaseDetails/MaintenanceButtons/WithdrawAppealFees.tsx, contracts/deployments/arbitrum/TransactionBatcher.json, contracts/deployments/arbitrumSepoliaDevnet/TransactionBatcher.json

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

coderabbitai[bot] commented 1 month ago

Walkthrough

The updates enhance the user interface by introducing maintenance buttons for managing disputes, allowing users to pass periods, execute rulings, and distribute rewards. These components integrate with Kleros Core contracts and utilize new hooks for improved state management. Additionally, a new field, nbVotes, has been added to the currentRound object in the disputeDetailsQuery GraphQL query to enrich the dispute details.

Changes

Files / Directories	Change Summary
`web/src/hooks/queries/useDisputeDetailsQuery.ts`	Added a new field `nbVotes` to the `currentRound` object in the `disputeDetailsQuery` GraphQL query.
`web/src/pages/Cases/CaseDetails/index.tsx`	Added `MaintenanceButtons` import, created `HeaderContainer` styled component, and updated structure to include `MaintenanceButtons`.
`web/src/pages/Cases/CaseDetails/MaintenanceButtons/*.tsx`	Introduced new components for various dispute actions: `MaintenanceButtons`, `DrawButton`, `ExecuteRulingButton`, `PassPeriodButton`, and `WithdrawAppealFees`.
`web/src/hooks/useTransactionBatcher.tsx`	Implemented `useTransactionBatcher` custom hook for facilitating batch transactions in a blockchain context.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI as MaintenanceButtons UI
    participant Contract as Kleros Core Contracts

    User ->> UI: Click Pass Period Button
    UI ->> Contract: passPeriod(dispute.id)
    Contract ->> UI: Confirmation

    User ->> UI: Click Execute Ruling Button
    UI ->> Contract: executeRuling(dispute.id)
    Contract ->> UI: Confirmation

    User ->> UI: Click Distribute Rewards Button
    UI ->> Contract: execute(dispute.id, dispute.currentRoundIndex, 20)
    Contract ->> UI: Confirmation

Assessment against linked issues

Objective	Addressed	Explanation
Add maintenance buttons for dispute actions (#1601)	✅
Disable button if prepareCall fails (#1601)	✅
Display error message for failed prepareCall (#1601)	❓	Unclear if error messages are implemented in the UI.

Poem

In the realm where disputes arise,
Maintenance buttons now surprise,
With actions swift and seamless flair,
Passing periods, rulings fair.
Rewards now flow, no task too tall,
Contracts heed the maintenance call.
Cheers to progress, big and small! 🌟

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 1 month ago

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

Name	Link
Latest commit	097bbaa4fced855bac4812720dc771f3df1b3a73
Latest deploy log	https://app.netlify.com/sites/kleros-v2-university/deploys/66b0a2df7dbbb600089d5ee8

netlify[bot] commented 1 month ago

Deploy Preview for kleros-v2-testnet ready!

Name	Link
Latest commit
Latest deploy log	https://app.netlify.com/sites/kleros-v2-testnet/deploys/66b34bdde38124b2613b9819
Deploy Preview	https://deploy-preview-1645--kleros-v2-testnet.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.