Skip to content

Commit 4a1514e

Browse files
jaybuidljaybuidl
committed
docs: examples of metaevidence and dispute templates
1 parent f1555aa commit 4a1514e

32 files changed

+1004
-2
lines changed

kleros-ts/README.md renamed to kleros-sdk/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @kleros/kleros-v2-klerosjs
1+
# @kleros/kleros-v2-sdk
22

33
_Archon's successor_
44

‎kleros-sdk/config/v1-metaevidence/escrow.json‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"subCategory": "General Service",
3+
"arbitrableAddress": "0x0d67440946949fe293b45c52efd8a9b3d51e2522",
4+
"title": "Jenkins the Valet Yacht Licensing Contract",
5+
"description": "Agreement between Bostonbob (bb) and AC (ac). \n\nbb will pay a one time yacht leasing fee of 4 eth to ac.\n\nIn return, ac will lease his yacht to bb by submitting bb’s MAYC and his back story in the Jenkins the valet author portal. Ac’s WAGMI Yacht #1047 will be attached to bb’s MAYC #1353, casting 1353 for a role in the book. \n\nIn addition, a royalty split will be put into place between the two parties. 80% for ac/20% for bb (managed and paid out by Jenkins team at a later date)\n\n*All names in contract are Twitter profile names as of 12/8.",
6+
"sender": "0x45E6564631809F5531fd008f4829f1C5B0c29A7f",
7+
"receiver": "0x45E6564631809F5531fd008f4829f1C5B0c29A7f",
8+
"amount": "4",
9+
"timeout": 8640000000000000,
10+
"token": {
11+
"name": "Ethereum",
12+
"ticker": "ETH",
13+
"symbolURI": "/static/media/eth.33901ab6.png",
14+
"address": null,
15+
"decimals": 18
16+
},
17+
"extraData": {
18+
"Contract Information": "Agreement between Bostonbob (bb) and AC (ac). \n\nbb will pay a one time yacht leasing fee of 4 eth to ac.\n\nIn return, ac will lease his yacht to bb by submitting bb’s MAYC and his back story in the Jenkins the valet author portal. Ac’s WAGMI Yacht #1047 will be attached to bb’s MAYC #1353, casting 1353 for a role in the book. \n\nIn addition, a royalty split will be put into place between the two parties. 80% for ac/20% for bb (managed and paid out by Jenkins team at a later date)\n\n*All names in contract are Twitter profile names as of 12/8."
19+
},
20+
"invoice": true,
21+
"category": "Escrow",
22+
"question": "Which party abided by terms of the contract?",
23+
"rulingOptions": {
24+
"type": "single-select",
25+
"titles": [
26+
"Refund Sender",
27+
"Pay Receiver"
28+
],
29+
"descriptions": [
30+
"Select to return funds to the Sender",
31+
"Select to release funds to the Receiver"
32+
]
33+
},
34+
"evidenceDisplayInterfaceURI": "/ipfs/QmfPnVdcCjApHdiCC8wAmyg5iR246JvVuQGQjQYgtF8gZU/index.html",
35+
"aliases": {
36+
"0x45E6564631809F5531fd008f4829f1C5B0c29A7f": "receiver"
37+
}
38+
}

‎kleros-sdk/config/v1-metaevidence/escrow2.json‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"subCategory": "General Service",
3+
"arbitrableAddress": "0x0d67440946949fe293b45c52efd8a9b3d51e2522",
4+
"title": "Mente Vs Cooperative Kleros",
5+
"description": "\n\nThe challenger believes due to a UI bug they were not able to challenge case 164 and this dispute is against the cooperative for potential lost winnings.\n\n",
6+
"sender": "0x96559b33D6A9042b1C34b3e8978Ca922146cB79a",
7+
"receiver": "0xa07f5Ffd166Ca3Ff7567e96a0430F1496cdb470a",
8+
"amount": "5",
9+
"timeout": 8640000000000000,
10+
"token": {
11+
"name": "Ethereum",
12+
"ticker": "ETH",
13+
"symbolURI": "/static/media/eth.33901ab6.png",
14+
"address": null,
15+
"decimals": 18
16+
},
17+
"extraData": {
18+
"Contract Information": "\n\nThe challenger believes due to a UI bug they were not able to challenge case 164 and this dispute is against the cooperative for potential lost winnings.\n\n"
19+
},
20+
"invoice": false,
21+
"category": "Escrow",
22+
"question": "Which party abided by terms of the contract?",
23+
"rulingOptions": {
24+
"type": "single-select",
25+
"titles": [
26+
"Refund Sender",
27+
"Pay Receiver"
28+
],
29+
"descriptions": [
30+
"Select to return funds to the Sender",
31+
"Select to release funds to the Receiver"
32+
]
33+
},
34+
"evidenceDisplayInterfaceURI": "/ipfs/QmfPnVdcCjApHdiCC8wAmyg5iR246JvVuQGQjQYgtF8gZU/index.html",
35+
"aliases": {
36+
"0x96559b33D6A9042b1C34b3e8978Ca922146cB79a": "sender",
37+
"0xa07f5Ffd166Ca3Ff7567e96a0430F1496cdb470a": "receiver"
38+
}
39+
}

‎kleros-sdk/config/v1-metaevidence/lgtcr1.json‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"title": "Add a list to Consensus Layer Withdrawal Protection enabled badges",
3+
"description": "Someone requested to add a list to Consensus Layer Withdrawal Protection enabled badges.",
4+
"rulingOptions": {
5+
"titles": [
6+
"Yes, Add It",
7+
"No, Don't Add It"
8+
],
9+
"descriptions": [
10+
"Select this if you think the list complies with the required criteria and should be added.",
11+
"Select this if you think the list does not comply with the required criteria and should not be added."
12+
]
13+
},
14+
"category": "Curated Lists",
15+
"question": "Does the list comply with the required criteria?",
16+
"fileURI": "/ipfs/QmZ7RVU7re1g8nXDbAFMHV99pyie3dn4cY7Ga2X4h8mDpV/reject-all-policy.pdf",
17+
"evidenceDisplayInterfaceURI": "/ipfs/QmQjJio59WkrQDzPC5kSP3EiGaqrWxjGfkvhmD2mWwm41M/index.html",
18+
"metadata": {
19+
"tcrTitle": "Consensus Layer Withdrawal Protection enabled badges",
20+
"tcrDescription": "A List of lists related to Consensus Layer Withdrawal Protection",
21+
"columns": [
22+
{
23+
"label": "Address",
24+
"description": "The Badges list address",
25+
"type": "GTCR address",
26+
"isIdentifier": true
27+
},
28+
{
29+
"label": "Match File URI",
30+
"description": "The URI to the JSON file for matching columns for each list.",
31+
"type": "text"
32+
}
33+
],
34+
"itemName": "list",
35+
"itemNamePlural": "lists",
36+
"isConnectedTCR": true,
37+
"requireRemovalEvidence": true,
38+
"isTCRofTCRs": true,
39+
"parentTCRAddress": "0x479083b5343aB89bb39608e3176D750c8A6957B5",
40+
"relTcrDisabled": true
41+
},
42+
"_v": "1.0.0",
43+
"evidenceDisplayInterfaceRequiredParams": [
44+
"disputeID",
45+
"arbitrableContractAddress",
46+
"arbitratorContractAddress",
47+
"arbitrableChainID",
48+
"arbitrableJsonRpcUrl"
49+
]
50+
}

‎kleros-sdk/config/v1-metaevidence/lgtcr2.json‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"title": "Remove a list from Consensus Layer Withdrawal Protection enabled badges",
3+
"description": "Someone requested to remove a list from Consensus Layer Withdrawal Protection enabled badges.",
4+
"rulingOptions": {
5+
"titles": [
6+
"Yes, Remove It",
7+
"No, Don't Remove It"
8+
],
9+
"descriptions": [
10+
"Select this if you think the list does not comply with the required criteria and should be removed.",
11+
"Select this if you think the list complies with the required criteria and should not be removed."
12+
]
13+
},
14+
"category": "Curated Lists",
15+
"question": "Does the list comply with the required criteria?",
16+
"fileURI": "/ipfs/QmZ7RVU7re1g8nXDbAFMHV99pyie3dn4cY7Ga2X4h8mDpV/reject-all-policy.pdf",
17+
"evidenceDisplayInterfaceURI": "/ipfs/QmQjJio59WkrQDzPC5kSP3EiGaqrWxjGfkvhmD2mWwm41M/index.html",
18+
"metadata": {
19+
"tcrTitle": "Consensus Layer Withdrawal Protection enabled badges",
20+
"tcrDescription": "A List of lists related to Consensus Layer Withdrawal Protection",
21+
"columns": [
22+
{
23+
"label": "Address",
24+
"description": "The Badges list address",
25+
"type": "GTCR address",
26+
"isIdentifier": true
27+
},
28+
{
29+
"label": "Match File URI",
30+
"description": "The URI to the JSON file for matching columns for each list.",
31+
"type": "text"
32+
}
33+
],
34+
"itemName": "list",
35+
"itemNamePlural": "lists",
36+
"isConnectedTCR": true,
37+
"requireRemovalEvidence": true,
38+
"isTCRofTCRs": true,
39+
"parentTCRAddress": "0x479083b5343aB89bb39608e3176D750c8A6957B5",
40+
"relTcrDisabled": true
41+
},
42+
"_v": "1.0.0",
43+
"evidenceDisplayInterfaceRequiredParams": [
44+
"disputeID",
45+
"arbitrableContractAddress",
46+
"arbitratorContractAddress",
47+
"arbitrableChainID",
48+
"arbitrableJsonRpcUrl"
49+
]
50+
}

‎kleros-sdk/config/v1-metaevidence/lgtcr3.json‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"title": "Add a validator to Consensus Layer Withdrawal Protection",
3+
"description": "Someone requested to add a validator to Consensus Layer Withdrawal Protection",
4+
"rulingOptions": {
5+
"titles": [
6+
"Yes, Add It",
7+
"No, Don't Add It"
8+
],
9+
"descriptions": [
10+
"Select this if you think the validator complies with the required criteria and should be added.",
11+
"Select this if you think the validator does not comply with the required criteria and should not be added."
12+
]
13+
},
14+
"category": "Curated Lists",
15+
"question": "Does the validator comply with the required criteria?",
16+
"fileURI": "/ipfs/QmPtXtFKfVc3w5aGVNYrmBZWEHBLpk2XMLkYCnEioxwy43/clwp-acceptance-policy.pdf",
17+
"evidenceDisplayInterfaceURI": "/ipfs/QmQjJio59WkrQDzPC5kSP3EiGaqrWxjGfkvhmD2mWwm41M/index.html",
18+
"metadata": {
19+
"tcrTitle": "Consensus Layer Withdrawal Protection",
20+
"tcrDescription": "Ethereum validators using CLWP to set their withdrawal address",
21+
"columns": [
22+
{
23+
"label": "validator_index",
24+
"description": "The validator in question (integer) [required]",
25+
"type": "number",
26+
"isIdentifier": true
27+
},
28+
{
29+
"label": "from_bls_pubkey",
30+
"description": "The public key of the validator withdrawal key (string) [required]",
31+
"type": "text",
32+
"isIdentifier": true
33+
},
34+
{
35+
"label": "to_execution_address",
36+
"description": "An Ethereum execution layer withdrawal address (address) [required]",
37+
"type": "address",
38+
"isIdentifier": true
39+
},
40+
{
41+
"label": "CLWP File",
42+
"description": "A text file which is named as the validator_index.json (file) [required]",
43+
"type": "file",
44+
"allowedFileTypes": "json"
45+
},
46+
{
47+
"label": "Item to supersede",
48+
"description": "In case there is already an entry on the list for the same validator_index, this field needs to be populated with the ItemID of the other item in this Kleros Curate registry that this entry is meant to supersede. (string) [optional]",
49+
"type": "text",
50+
"isIdentifier": true
51+
},
52+
{
53+
"label": "Additional Information",
54+
"description": "A .pdf file containing any evidence and proof to prove that you are the rightful owner of the validator node. (file) [optional]",
55+
"type": "file",
56+
"allowedFileTypes": "pdf"
57+
}
58+
],
59+
"itemName": "validator",
60+
"itemNamePlural": "validators",
61+
"logoURI": "/ipfs/QmXkGcS9Nw7jqaSaZZoKh3UQo8pwE8LWsdoUtjx1zTFLmJ/clwp-100-100-px-.svg",
62+
"requireRemovalEvidence": true,
63+
"isTCRofTCRs": false,
64+
"relTcrDisabled": true
65+
}
66+
}

‎kleros-sdk/config/v1-metaevidence/lgtcr4.json‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"title": "Remove a validator from Consensus Layer Withdrawal Protection",
3+
"description": "Someone requested to remove a validator from Consensus Layer Withdrawal Protection",
4+
"rulingOptions": {
5+
"titles": [
6+
"Yes, Remove It",
7+
"No, Don't Remove It"
8+
],
9+
"descriptions": [
10+
"Select this if you think the validator does not comply with the required criteria and should be removed.",
11+
"Select this if you think the validator complies with the required criteria and should not be removed."
12+
]
13+
},
14+
"category": "Curated Lists",
15+
"question": "Does the validator comply with the required criteria?",
16+
"fileURI": "/ipfs/QmPtXtFKfVc3w5aGVNYrmBZWEHBLpk2XMLkYCnEioxwy43/clwp-acceptance-policy.pdf",
17+
"evidenceDisplayInterfaceURI": "/ipfs/QmQjJio59WkrQDzPC5kSP3EiGaqrWxjGfkvhmD2mWwm41M/index.html",
18+
"metadata": {
19+
"tcrTitle": "Consensus Layer Withdrawal Protection",
20+
"tcrDescription": "Ethereum validators using CLWP to set their withdrawal address",
21+
"columns": [
22+
{
23+
"label": "validator_index",
24+
"description": "The validator in question (integer) [required]",
25+
"type": "number",
26+
"isIdentifier": true
27+
},
28+
{
29+
"label": "from_bls_pubkey",
30+
"description": "The public key of the validator withdrawal key (string) [required]",
31+
"type": "text",
32+
"isIdentifier": true
33+
},
34+
{
35+
"label": "to_execution_address",
36+
"description": "An Ethereum execution layer withdrawal address (address) [required]",
37+
"type": "address",
38+
"isIdentifier": true
39+
},
40+
{
41+
"label": "CLWP File",
42+
"description": "A text file which is named as the validator_index.json (file) [required]",
43+
"type": "file",
44+
"allowedFileTypes": "json"
45+
},
46+
{
47+
"label": "Item to supersede",
48+
"description": "In case there is already an entry on the list for the same validator_index, this field needs to be populated with the ItemID of the other item in this Kleros Curate registry that this entry is meant to supersede. (string) [optional]",
49+
"type": "text",
50+
"isIdentifier": true
51+
},
52+
{
53+
"label": "Additional Information",
54+
"description": "A .pdf file containing any evidence and proof to prove that you are the rightful owner of the validator node. (file) [optional]",
55+
"type": "file",
56+
"allowedFileTypes": "pdf"
57+
}
58+
],
59+
"itemName": "validator",
60+
"itemNamePlural": "validators",
61+
"logoURI": "/ipfs/QmXkGcS9Nw7jqaSaZZoKh3UQo8pwE8LWsdoUtjx1zTFLmJ/clwp-100-100-px-.svg",
62+
"requireRemovalEvidence": true,
63+
"isTCRofTCRs": false,
64+
"relTcrDisabled": true
65+
}
66+
}

‎kleros-sdk/config/v1-metaevidence/linguo-meta-evidence1.json‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"title": "Review a translation from Linguo",
3+
"description": "Someone challenged a translation",
4+
"rulingOptions": {
5+
"titles": [
6+
"Yes, the translation should be accepted",
7+
"No, the translation should not be accepted"
8+
],
9+
"descriptions": [
10+
"Select this if you think the translation complies with the required criteria.",
11+
"Select this if you think the translation does not comply with the required criteria."
12+
]
13+
},
14+
"aliases": {
15+
"0xc3600bfC9Ec2c20E4c7d22c9235b6ddE63BA99a8": "Requester"
16+
},
17+
"category": "Translation",
18+
"question": "Does the translation comply with the required criteria?",
19+
"fileURI": "/ipfs/QmVabp1VjJNYzXDxbcWFdeK17RvvA9eQy6eJVf1T1AzS1a/linguo-translation-quality-policy.pdf",
20+
"evidenceDisplayInterfaceURI": "/ipfs/Qmb5n6PgbshktJqGpwMAxP1moXEPaqq7ZvRufeXXhSPXxW/linguo-evidence-display/index.html",
21+
"dynamicScriptURI": "/ipfs/QmPAHCRtSU844fdjNoEws8AgTpzzwsYwMF2wydtpvXAcoZ/linguo-script.js",
22+
"dynamicScriptRequiredParams": [
23+
"disputeID",
24+
"arbitrableContractAddress",
25+
"arbitratorContractAddress",
26+
"chainID",
27+
"jsonRpcUrl"
28+
],
29+
"metadata": {
30+
"deadline": 1680307199,
31+
"minPrice": "0",
32+
"maxPrice": "500000000000000000000",
33+
"sourceLanguage": "en-us",
34+
"targetLanguage": "es",
35+
"expectedQuality": "professional",
36+
"title": "What do I think about network states?",
37+
"wordCount": 7900,
38+
"originalTextUrl": "https://vitalik.ca/general/2022/07/13/networkstates.html",
39+
"originalTextFile": "/ipfs/QmY16SsM1uk7i2TLxGhUZR8iW74w4Luphry3SJeN6XyCTf/What do I think about network states.docx",
40+
"__v": "1"
41+
},
42+
"arbitrableChainID": 100,
43+
"_v": "1.0.0"
44+
}

0 commit comments

Comments
 (0)