Skip to content

Commit fdc7e99

Browse files
parulgitbook-bot
parul
authored andcommitted
GITBOOK-379: Dispute Resolver documentation
1 parent 3b2123c commit fdc7e99

32 files changed

+189
-10
lines changed
356 KB
Loading
139 KB
Loading

.gitbook/assets/image (1) (1) (1).png

-274 KB
Loading

.gitbook/assets/image (1) (1).png

-115 KB
Loading

.gitbook/assets/image (1).png

-26.1 KB
Loading

.gitbook/assets/image (104).png

37.7 KB
Loading

.gitbook/assets/image (105).png

92.1 KB
Loading

.gitbook/assets/image (106).png

92.1 KB
Loading

.gitbook/assets/image (107).png

67.8 KB
Loading

.gitbook/assets/image (108).png

64.2 KB
Loading

.gitbook/assets/image (109).png

79.3 KB
Loading
2.02 MB
Loading

.gitbook/assets/image (2) (1) (1).png

-1.86 MB
Loading

.gitbook/assets/image (2) (1).png

-123 KB
Loading

.gitbook/assets/image (2).png

57.1 KB
Loading
305 KB
Loading

.gitbook/assets/image (3) (1) (1).png

-292 KB
Loading

.gitbook/assets/image (3) (1).png

688 KB
Loading

.gitbook/assets/image (3).png

-623 KB
Loading

.gitbook/assets/image (4) (1).png

17.3 KB
Loading

.gitbook/assets/image (4).png

24 KB
Loading

.gitbook/assets/image (5) (2).png

30.7 KB
Loading

.gitbook/assets/image (5).png

75 KB
Loading

.gitbook/assets/image.png

-33.2 KB
Loading
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,183 @@
1+
---
2+
description: >-
3+
Create, manage, and resolve disputes with Kleros Court's decentralized
4+
arbitration application
5+
---
6+
17
# Dispute Resolver
28

3-
In progress, please come back later.\
4-
\
9+
🔨 [Dispute Resolver](https://resolve.kleros.io/) 🔨
10+
11+
Kleros Dispute Resolver allows users to create, manage, and interact with disputes on the Kleros protocol. It provides a user-friendly interface for creating custom disputes, submitting evidence, funding appeals, and following the progress of disputes through the arbitration process.
12+
13+
It allows users to:
14+
15+
* Create disputes by filling out a form
16+
* List and view open disputes
17+
* See dispute details
18+
* Submit evidence
19+
* Fund appeals
20+
* Track dispute progress
21+
22+
The application serves as a bridge between users and the Kleros Court system, allowing for decentralized arbitration without requiring users to write their own smart contracts.
23+
24+
### When to Use Dispute Resolver
25+
26+
You should consider using Kleros Dispute Resolver in the following scenarios:
27+
28+
1. **Need for Neutral Arbitration**: When you need a neutral third party to resolve a dispute.
29+
2. **Standalone Disputes**: When you want to create a dispute without integrating with an existing dApp or application.
30+
3. **Off-chain Disputes**: For disputes involving off-chain activities that cannot be trustlessly integrated with Kleros.
31+
4. **Cross-chain Arbitration**: When Kleros Court is not yet available on your specific blockchain/L2.
32+
5. **Limited Resources**: When you lack the resources for a full smart contract integration.
33+
6. **Custom Arbitrable Contracts**: For protocols with a custom arbitrable contract which don't have their own frontend to submit evidence or fund appeals. If the arbitrable contract implements the IDisputeResolver interface (available as an [NPM package](https://www.npmjs.com/package/@kleros/dispute-resolver-interface-contract)), it can take advantage of the Dispute Resolver frontend.
34+
35+
### Main Features
36+
37+
<figure><img src="../../../../.gitbook/assets/image (4).png" alt=""><figcaption></figcaption></figure>
38+
39+
#### 1. Ongoing Disputes
40+
41+
View all active disputes currently in progress within the system. This section allows you to browse disputes based on different phases:
42+
43+
* Evidence submission
44+
* Commit phase
45+
* Voting phase
46+
* Appeal phase
47+
48+
#### 2. Create Dispute
49+
50+
The application provides a user-friendly form to create custom disputes. You can:
51+
52+
* Select a specialized Kleros court
53+
* Choose the number of jurors
54+
* Define the dispute title, description, and category
55+
* Specify the question type (multiple choice, numeric, date)
56+
* Set ruling options
57+
* Add party information (aliases and addresses)
58+
* Upload supporting documentation
59+
60+
<figure><img src="../../../../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
61+
62+
#### 3. Interact
63+
64+
This section allows users to:
65+
66+
* View detailed information about specific disputes
67+
* Submit evidence to ongoing disputes
68+
* Fund appeals for disputes in the appeal phase
69+
* Withdraw rewards after disputes are resolved
70+
71+
72+
73+
<figure><img src="../../../../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>
74+
75+
### Using the Application
76+
77+
#### Connecting Your Wallet
78+
79+
To interact with Dispute Resolver, you need to:
80+
81+
1. Have a Web3-compatible wallet (like MetaMask) installed
82+
2. Connect your wallet to the application
83+
3. Ensure you have sufficient funds for dispute creation and appeal funding
84+
85+
#### Viewing Ongoing Disputes
86+
87+
1. Navigate to the "Ongoing Disputes" tab
88+
2. Browse the list of active disputes
89+
3. Filter disputes by their current phase if necessary
90+
4. Click on a dispute to view more details
91+
92+
<figure><img src="../../../../.gitbook/assets/image (104).png" alt=""><figcaption><p>A sample Dispute </p></figcaption></figure>
93+
94+
#### Creating a New Dispute
95+
96+
1. Navigate to the "Create" tab
97+
2. Fill out the dispute creation form:
98+
* Select the appropriate court for your dispute
99+
* Specify the number of jurors (more jurors = higher cost but potentially more thorough arbitration)
100+
* Enter a title and description for the dispute
101+
* Select the question type (this determines how jurors will vote)
102+
* Enter the specific question to be resolved
103+
* Define the ruling options
104+
* Add party information if relevant
105+
* Upload any primary documentation (up to 4MB)
106+
3. Review the arbitration cost displayed
107+
4. Submit the form to create the dispute\
108+
109+
110+
<figure><img src="../../../../.gitbook/assets/image (106).png" alt=""><figcaption><p>A sample dispute for Klers Solidity court</p></figcaption></figure>
111+
112+
**Question Types:**
113+
114+
* **Multiple choice: single select**: Standard question with multiple options where jurors select one answer
115+
* **Multiple choice: multiple select**: Question where jurors can select multiple options
116+
* **Non-negative number**: Asks for a numerical answer (≥ 0)
117+
* **Date**: Asks for a date as an answer
118+
119+
**Interacting with Existing Disputes**
120+
121+
1. Navigate to the "Interact" tab or click on a specific dispute
122+
2. Review the dispute timeline showing its current phase
123+
3. Explore the accordion sections for:
124+
* Appeal information
125+
* Question details
126+
* Evidence timeline\
127+
128+
129+
<figure><img src="../../../../.gitbook/assets/image (107).png" alt=""><figcaption><p>Interact with the sample dispute </p></figcaption></figure>
130+
131+
#### Submitting Evidence
132+
133+
1. Open the dispute details page
134+
2. Navigate to the "Evidence" section (available only during the Evidence phase)
135+
3. Click to submit new evidence
136+
4. Enter a title and description for your evidence
137+
5. Upload supporting files if necessary
138+
6. Specify which side your evidence supports
139+
7. Submit the evidence
140+
141+
<figure><img src="../../../../.gitbook/assets/image (108).png" alt=""><figcaption></figcaption></figure>
142+
143+
<figure><img src="../../../../.gitbook/assets/image (109).png" alt=""><figcaption></figcaption></figure>
144+
145+
#### Funding Appeals
146+
147+
1. Open the dispute details page
148+
2. Navigate to the "Appeal" section (available only during the appeal phase)
149+
3. Choose which ruling option you want to support
150+
4. View funding progress, suggested contribution, and potential return on investment
151+
5. Enter the amount you wish to contribute
152+
6. Confirm the transaction
153+
154+
When a ruling is appealed:
155+
156+
* Both sides (winner and loser) need to provide funds
157+
* If only one side is fully funded, that side wins by default
158+
* If both sides are fully funded, the case goes to a new round with more jurors
159+
160+
### [Recognition of Jurisdiction (RoJ) Setup](../use-cases/1.-dispute-resolution-integration-plan/)
161+
162+
For cases where the dispute ruling is not enforced onchain, you can use a Recognition-of-Jurisdiction (RoJ) setup:
163+
164+
1. Create standalone disputes on resolve.kleros.io
165+
2. Your service/platform pledges to enforce Kleros rulings
166+
3. Share the dispute link with relevant parties
167+
168+
This approach allows you to:
169+
170+
* Quickly introduce Kleros arbitration into your process
171+
* Test the system before investing in development
172+
* Handle off-chain disputes that cannot be trustlessly integrated
173+
174+
### For Developers with Custom Arbitrable Contracts
175+
176+
If you have developed a custom arbitrable contract and need a user interface for your users to interact with disputes:
177+
178+
1. Implement the IDisputeResolver interface in your arbitrable contract (available as an [NPM package](https://www.npmjs.com/package/@kleros/dispute-resolver-interface-contract))
179+
2. The Dispute Resolver application will then be fully compatible with your contract
180+
3. Users can use Dispute Resolver to submit evidence and fund appeals for disputes created through your contract
181+
4. This eliminates the need to build your own dispute management frontend
182+
183+
The `IDisputeResolver` interface standardizes crowdfunded appeals and evidence submission, making it easier to integrate with the Kleros ecosystem.

products/court/kleros-juror-tutorial.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Once you’ve taken a look at the courts, what remains is to stake your PNK and
5757

5858
## The Kleros court process
5959

60-
![Kleros Court process](<../../.gitbook/assets/image (1) (1) (1) (1).png>)
60+
![Kleros Court process](<../../.gitbook/assets/image (1) (1) (1) (1) (1).png>)
6161

6262
**Important note: before you vote, review the policies carefully.**
6363

products/curate/kleros-scout/kleros-scout-metamask-snaps/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ Step 2: Head to [https://contract-insight-snap.kleros.builders/](https://contrac
2828

2929
Step 3: Search for _**@kleros/scout-snap**_
3030

31-
<figure><img src="../../../../.gitbook/assets/image (1) (1).png" alt=""><figcaption></figcaption></figure>
31+
<figure><img src="../../../../.gitbook/assets/image (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
3232

3333
Step 4: Install _**@kleros/scout-snap**!_ It’s that easy :)
3434

3535
## 2. How to use the Snap's features?
3636

3737
Once you install the Kleros Scout Snap, with every txn/contract interaction, you will see a tab which provides you with insights around the same. Upon installation, If you see this, you are already using community curated contract insights for secure dapp interaction - the most important feature of the Kleros Scout Snap.
3838

39-
<figure><img src="../../../../.gitbook/assets/image (2) (1).png" alt="" width="357"><figcaption></figcaption></figure>
39+
<figure><img src="../../../../.gitbook/assets/image (2) (1) (1).png" alt="" width="357"><figcaption></figcaption></figure>
4040

4141
## 3. What does the Kleros Scout Snap do?
4242

products/curate/kleros-scout/partnerships.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >-
88

99
Many of the most important Web3 partners already use data from Kleros Scout, recognizing the value of fully decentralized and permissionless data curation, and supporting a safer blockchain ecosystem.
1010

11-
<figure><img src="../../../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure>
11+
<figure><img src="../../../.gitbook/assets/image (2) (1).png" alt=""><figcaption></figcaption></figure>
1212

1313
## Why Integrate data from Kleros Scout?
1414

products/linguo/step-by-step-tutorial/reviewing-translations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ description: >-
1818
Please make sure you do the self-assessment accurately as this would ensure you get matched to jobs that you are most suited for.
1919
{% endhint %}
2020

21-
<figure><img src="../../../.gitbook/assets/image (1) (1) (1).png" alt=""><figcaption><p>Enter all languages you are comfortable with and hit save.</p></figcaption></figure>
21+
<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1).png" alt=""><figcaption><p>Enter all languages you are comfortable with and hit save.</p></figcaption></figure>
2222

2323
3\. Now you will see all open translations for review.\
2424

products/moderate/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: Social media content moderation with Reality.eth x Kleros
1111
Supports
1212

1313
* Telegram <img src="../../.gitbook/assets/image (1) (3).png" alt="" data-size="line">: ⚖️ [Susie | Kleros Moderator](https://t.me/SusieTheKlerosModeratorBot?start) ⚖️
14-
* Discord <img src="../../.gitbook/assets/image (3) (1).png" alt="" data-size="line">: **Soon**
14+
* Discord <img src="../../.gitbook/assets/image (3) (1) (1).png" alt="" data-size="line">: **Soon**
1515

1616
How does it work?
1717

products/tokens.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ hidden: true
99

1010
**Kleros Tokens** is an open and decentralized curated registry of tokens. In other words, it is a community-managed list of ERC-20 tokens (including their name, ticker, logo and address) open to any project and curated by the power of Kleros arbitration and economic incentives.
1111

12-
<figure><img src="../.gitbook/assets/image (3).png" alt=""><figcaption></figcaption></figure>
12+
<figure><img src="../.gitbook/assets/image (3) (1).png" alt=""><figcaption></figcaption></figure>
1313

1414
## Why does the ecosystem need a decentralized and open list of tokens?
1515

they-talk-about-kleros.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: What people have to say about Kleros decentralized courts
88

99
{% embed url="https://twitter.com/VitalikButerin/status/1348894491793494018" %}
1010

11-
!["Just Use Kleros"](<.gitbook/assets/image (2) (1) (1).png>)
11+
!["Just Use Kleros"](<.gitbook/assets/image (2) (1) (1) (1).png>)
1212

1313
## Naval Ravikant
1414

0 commit comments

Comments
 (0)