You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: integrations/integration-tools/escrow-sdk.md
+70-71Lines changed: 70 additions & 71 deletions
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,11 @@
2
2
description: A class that lets you create and manage Kleros Escrow transactions.
3
3
---
4
4
5
-
6
5
# Escrow SDK
7
6
8
7
This class lets you create and manage Kleros Escrow transactions. Use this Kleros Escrow SDK to easily integrate on-chain escrow features on your platform.
| court |`string`| The court that will rule over any disputes arising from a transaction. `"general"` or `"blockchain-non-technical"`, or a custom [arbitrable transaction contract](https://github.com/kleros/escrow-contracts) address. |`"blockchain-non-technical"`|
48
-
| currency |`string`| The address of the token the transaction should be paid in. Leave this undefined to use ETH. ||
44
+
| Name | Type | Description | Default |
45
+
|:--- |:--- |:--- |:--- |
46
+
| court |`string`| The court that will rule over any disputes arising from a transaction. `"general"` or `"blockchain-non-technical"`, or a custom [arbitrable transaction contract](https://github.com/kleros/escrow-contracts) address. |`"blockchain-non-technical"`|
47
+
| currency |`string`| The address of the token the transaction should be paid in. Leave this undefined to use ETH. ||
49
48
50
-
####Returns `(Promise)`
49
+
### Returns `(Promise)`
51
50
52
51
A promise that resolves when the court and currency are set.
| recipient\*|`string`| The address of the recipient. ||
107
-
| timeout\*|`number | string | BN` | The time in seconds until the transaction becomes executable. ||
108
-
| metaEvidence\*|`object`| The [meta evidence object](https://github.com/ethereum/EIPs/issues/1497) for any potential disputes arising. You can add an additional `file` property with a buffer, string, or object, and it will be uploaded to IPFS and `fileURI` will be set appropiately. ||
102
+
| Name | Type | Description | Default |||
103
+
|:--- |:--- |:--- |:--- |:--- |:--- |
104
+
| amount\*|\`number | string | BN\`| The amount escrowed. ||
105
+
| recipient\*|`string`| The address of the recipient. ||||
106
+
| timeout\*|\`number | string | BN\`| The time in seconds until the transaction becomes executable. ||
107
+
| metaEvidence\*|`object`| The [meta evidence object](https://github.com/ethereum/EIPs/issues/1497) for any potential disputes arising. You can add an additional `file` property with a buffer, string, or object, and it will be uploaded to IPFS and `fileURI` will be set appropiately. ||||
109
108
110
-
####Returns `(Promise<object>)`
109
+
### Returns `(Promise<object>)`
111
110
112
111
A promise for the transaction's creation transaction.
113
112
114
113
## `klerosEscrow.pay`
115
114
116
115
Pays an amount of an escrowed transaction the current account is a sender in, to the recipient.
| transactionID\*|`string`| The ID of the transaction. ||
149
+
| Name | Type | Description | Default |
150
+
|:--- |:--- |:--- |:--- |
151
+
| transactionID\*|`string`| The ID of the transaction. ||
153
152
154
-
####Returns `(Promise<object>)`
153
+
### Returns `(Promise<object>)`
155
154
156
155
A promise for the execution's transaction.
157
156
158
157
## `klerosEscrow.timeout`
159
158
160
159
Timesout the other party of an escrowed transaction the current account is involved in. This is for when they miss the deadline to pay arbitration fees.
| transactionID\*|`string`| The ID of the transaction. ||
196
-
| evidence\*|`object`| The [evidence object](https://github.com/ethereum/EIPs/issues/1497) for any potential disputes arising. You can add an additional `file` property with a buffer, string, or object, and it will be uploaded to IPFS and `fileURI` will be set appropiately. ||
192
+
| Name | Type | Description | Default |
193
+
|:--- |:--- |:--- |:--- |
194
+
| transactionID\*|`string`| The ID of the transaction. ||
195
+
| evidence\*|`object`| The [evidence object](https://github.com/ethereum/EIPs/issues/1497) for any potential disputes arising. You can add an additional `file` property with a buffer, string, or object, and it will be uploaded to IPFS and `fileURI` will be set appropiately. ||
Copy file name to clipboardExpand all lines: integrations/live-and-upcoming-integrations.md
+26-5Lines changed: 26 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -10,23 +10,44 @@ The Kleros ecosystem lives and breathes through the disputes brought back to the
10
10
11
11
## Live Integrations
12
12
13
-
### Omen
13
+
### ⚖️ Projects using Kleros arbitration directly ⚖️
14
14
15
-
The [Omen](https://omen.eth.link/) prediction market \(on Ethereum mainnet and xDai\):
15
+
### Unslashed Finance
16
16
17
-
* uses the [Kleros Oracle](https://kleros.gitbook.io/docs/products/oracle) solution \(Reality.eth \(bond escalation\) + Kleros Court \(Arbitration\)\) to rule on the outcome of events that are being predicted in their markets. For example, Kleros jurors rules on famous disputes about the number of Covid deaths in the US in July 2020 \([Case 302](https://thedailychain.com/an-important-case-for-the-decentralized-world-with-kleros/)\) and about the winner of 2020 US presidential election \([Case 532](https://twitter.com/jimmyragosa/status/1341293611682553856?lang=en)\)
18
-
* uses a [Kleros Curate](https://curate.kleros.io/tcr/0xb72103eE8819F2480c25d306eEAb7c3382fBA612) list to curate "Verified Markets" that are well written according to acceptance criteria and to display a "Verified" badge next to them on their UI. It allows users to easily be reassured that they are not participating in a "tricky" market designed to fool the outcome shares buyers.
17
+
### Other Arbitrable apps
19
18
20
-
19
+
*[Proof of Humanity](https://kleros.gitbook.io/docs/products/proof-of-humanity)
### 🔮 Projects using Kleros arbitration through Reality.eth oracle 🔮
28
+
29
+
### Omen
30
+
31
+
The [Omen](https://omen.eth.link/) prediction market \(on Ethereum mainnet and xDai\) uses the [Kleros Oracle](https://kleros.gitbook.io/docs/products/oracle) solution \(Reality.eth \(bond escalation\) + Kleros Court \(Arbitration\)\) to rule on the outcome of events that are being predicted in their markets. For example, Kleros jurors rules on famous disputes about the number of Covid deaths in the US in July 2020 \([Case 302](https://thedailychain.com/an-important-case-for-the-decentralized-world-with-kleros/)\) and about the winner of 2020 US presidential election \([Case 532](https://twitter.com/jimmyragosa/status/1341293611682553856?lang=en)\)
21
32
22
33
### Gnosis Safe SafeSnap
23
34
24
35
The [Gnosis Safe](https://gnosis-safe.io/) multi-sig wallet can be used for DAO governance purposes thanks to the [SafeSnap](https://blog.gnosis.pm/introducing-safesnap-the-first-in-a-decentralized-governance-tool-suite-for-the-gnosis-safe-ea67eb95c34f) module. This module is using the [Kleros Oracle](https://kleros.gitbook.io/docs/products/oracle) solution \(Reality.eth \(bond escalation\) + Kleros Court \(Arbitration\)\) to effectively enforce on-chain the implementation and triggering of the proposals voted on by the DAO on Snapshot.
25
36
37
+
### 📝 Projects using Kleros arbitration through Curate TCRs 📝
38
+
26
39
### CLR.fund
27
40
28
41
The [clr.fund](https://clr.fund/) public goods funding protocol uses a [Kleros Curate](https://curate.kleros.io/tcr/0x2E3B10aBf091cdc53cC892A50daBDb432e220398) list to curate public goods projects that are eligible to receive donations through quadratic funding. It enables the open and fair filtering of non-public goods projects that would diminish the matching of donations for compliant projects.
29
42
43
+
### Omen
44
+
45
+
The [Omen](https://omen.eth.link/) prediction market \(on Ethereum mainnet and xDai\) uses a [Kleros Curate](https://curate.kleros.io/tcr/0xb72103eE8819F2480c25d306eEAb7c3382fBA612) list to curate "Verified Markets" that are well written according to acceptance criteria and to display a "Verified" badge next to them on their UI. It allows users to easily be reassured that they are not participating in a "tricky" market designed to fool the outcome shares buyers.
46
+
47
+
48
+
49
+
### 📝 Projects using Kleros arbitration through Tokens TCR
50
+
30
51
### Uniswap / Sushiswap
31
52
32
53
Both [Uniswap](https://uniswap.org/) and [Sushiswap](https://sushi.com/) decentralized exchanges use [Kleros Tokens](https://tokens.kleros.io/tokens) as one of their token lists to be selected to trade on their UIs. This [token list](https://tokenlists.org/token-list?url=t2crtokens.eth) is the only one to be completely open, decentralized, and managed by the community.
Copy file name to clipboardExpand all lines: integrations/types-of-integrations/README.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description: Have a look at the paths to integration
6
6
7
7
Kleros Court is the implementation of an arbitrator as per the [Arbitration standard](https://kleros.gitbook.io/docs/developer/erc-792-arbitration-standard) we developed. Most integrations consist in building or customizing an Arbitrable app so it can request arbitration to Kleros Court. Once you integrate with the Arbitration standard, you \(or your users\) will be able to choose any arbitrator that follows the standard to solve disputes, including Kleros.
0 commit comments