Skip to content

Commit 7b1c2bf

Browse files
jaybuidljaybuidl
committed
docs: interfaces docs update
1 parent 250af2a commit 7b1c2bf

17 files changed

+182
-77
lines changed

kleros-sdk/config/v2-disputetemplate/reality/kip-template.md renamed to kleros-sdk/config/v2-disputetemplate/kip-template.md

File renamed without changes.

kleros-sdk/config/v2-disputetemplate/linguo/dispute-details.linguo.jsonc renamed to kleros-sdk/config/v2-disputetemplate/linguo/DisputeDetails.linguo.jsonc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"$schema": "./dispute-details.linguo.schema.json",
3-
"category": "Translation",
43
"title": "Review a translation from Linguo",
54
"description": "Someone challenged a translation",
65
"question": "Does the translation comply with the required criteria?",
@@ -24,12 +23,14 @@
2423
"reserved": false
2524
}
2625
],
27-
"frontendUrl": "https://linguo.kleros.io/translation/", // SDK should not change it
2826
"policyURI": "/ipfs/QmVabp1VjJNYzXDxbcWFdeK17RvvA9eQy6eJVf1T1AzS1a/linguo-translation-quality-policy.pdf",
27+
"frontendUrl": "https://linguo.kleros.io/translation/0xe78996a233895be74a66f451f1019ca9734205cc/13",
2928
"arbitrableChainID": "100",
3029
"arbitrableAddress": "0xe78996a233895be74a66f451f1019ca9734205cc",
3130
"arbitratorChainID": "421613",
3231
"arbitratorAddress": "0xD08Ab99480d02bf9C092828043f611BcDFEA917b", // KlerosCore
32+
"category": "Translation",
33+
"lang": "en_US",
3334
"specification": "KIP999",
3435
"metadata": {
3536
"linguoAddress": "0xe78996a233895be74a66f451f1019ca9734205cc",
@@ -51,5 +52,10 @@
5152
"linguoTranslator": "0xbcd996a233895be74a66f451f1019ca97342bbbb",
5253
"linguoChallenger": "0xcde996a233895be74a66f451f1019ca97342cccc",
5354
"linguoFrontendUrl": "https://linguo.kleros.io/translation/0x0B928165A67df8254412483ae8C3b8cc7F2b4D36/35",
54-
}
55+
},
56+
"externalDisputeID": "13", // taskID
57+
"arbitrableDisputeID": "7",
58+
"arbitratorDisputeID": "4564",
59+
"disputeTemplateID": "43",
60+
"disputeTemplateHash": "0xD1u9...2254"
5561
}

‎kleros-sdk/config/v2-disputetemplate/linguo/DisputeTemplateInputs.linguo.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
0xe78996a233895be74a66f451f1019ca9734205cc
2+
13

‎kleros-sdk/config/v2-disputetemplate/linguo/NewDispute.linguo.jsonc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"externalDisputeID": "13", // taskID
3+
"arbitrableDisputeID": "7",
4+
"templateID": "43"
5+
}

kleros-sdk/config/v2-disputetemplate/linguo/dispute-template.linguo.jsonc renamed to kleros-sdk/config/v2-disputetemplate/linguo/NewDisputeTemplate.linguo.jsonc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
2-
"$schema": "./dispute-template.linguo.schema.json",
3-
"category": "Translation",
2+
"$schema": "./NewDisputeTemplate.linguo.schema.json",
43
"title": "Review a translation from Linguo",
54
"description": "Someone challenged a translation",
65
"question": "Does the translation comply with the required criteria?",
@@ -9,19 +8,19 @@
98
{
109
"title": "Yes, the translation should be accepted",
1110
"description": "Select this if you think the translation complies with the required criteria.",
12-
"reserved": false
1311
},
1412
{
1513
"title": "No, the translation should not be accepted",
1614
"description": "Select this if you think the translation does not comply with the required criteria.",
17-
"reserved": false
1815
}
1916
],
20-
"frontendUrl": "https://linguo.kleros.io/translation/", // SDK should not change it
2117
"policyURI": "/ipfs/QmVabp1VjJNYzXDxbcWFdeK17RvvA9eQy6eJVf1T1AzS1a/linguo-translation-quality-policy.pdf",
18+
"frontendUrl": "https://linguo.kleros.io/translation/%s/%s",
2219
"arbitrableChainID": "100",
2320
"arbitrableAddress": "0xe78996a233895be74a66f451f1019ca9734205cc",
2421
"arbitratorChainID": "421613",
2522
"arbitratorAddress": "0xD08Ab99480d02bf9C092828043f611BcDFEA917b", // KlerosCore
23+
"lang": "en_US",
24+
"category": "Translation",
2625
"specification": "KIP999"
2726
}

‎kleros-sdk/config/v2-disputetemplate/linguo/dispute-template-inputs.linguo.txt‎

Whitespace-only changes.

kleros-sdk/config/v2-disputetemplate/reality/dispute-details.reality.schema.json renamed to kleros-sdk/config/v2-disputetemplate/reality/DisputeDetails.reality.schema.json

Lines changed: 92 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
{
22
"$schema": "https://json-schema.org/draft/2019-09/schema",
3-
"$id": "dispute-details.schema.json",
3+
"$id": "DisputeDetails.reality.schema.json",
44
"title": "Root Schema",
55
"description": "The root schema is the schema that comprises the entire JSON document.",
66
"type": "object",
77
"default": {},
88
"required": [
99
"category",
10+
"lang",
1011
"title",
1112
"description",
1213
"question",
@@ -19,9 +20,14 @@
1920
"arbitratorChainID",
2021
"arbitratorAddress",
2122
"specification",
22-
"metadata"
23+
"metadata",
24+
"externalDisputeID",
25+
"arbitrableDisputeID",
26+
"arbitratorDisputeID",
27+
"disputeTemplateID",
28+
"disputeTemplateHash"
2329
],
24-
"additionalProperties": true,
30+
"additionalProperties": false,
2531
"properties": {
2632
"category": {
2733
"title": "The category Schema",
@@ -32,6 +38,14 @@
3238
"Oracle"
3339
]
3440
},
41+
"lang": {
42+
"type": "string",
43+
"default": "",
44+
"title": "The lang Schema",
45+
"examples": [
46+
"en_US"
47+
]
48+
},
3549
"title": {
3650
"title": "The title Schema",
3751
"description": "An explanation about the purpose of this instance.",
@@ -211,112 +225,118 @@
211225
]
212226
},
213227
"metadata": {
214-
"title": "The metadata Schema",
215-
"description": "An explanation about the purpose of this instance.",
216228
"type": "object",
217229
"default": {},
230+
"title": "The metadata Schema",
218231
"required": [
219232
"realityAddress",
220233
"realityTemplateID",
221234
"realityQuestionID",
222235
"realityUser",
236+
"realityType",
223237
"realityCategory",
224238
"realityLang",
239+
"realityFormat",
225240
"realityTimeout",
226241
"realityOpeningTime",
227242
"realityCreationTime",
228-
"realityFrontendUrl"
243+
"realityNonce"
229244
],
230-
"additionalProperties": true,
231245
"properties": {
232246
"realityAddress": {
233-
"title": "The realityAddress Schema",
234-
"description": "An explanation about the purpose of this instance.",
235247
"type": "string",
236248
"default": "",
249+
"title": "The realityAddress Schema",
237250
"examples": [
238251
"0xe78996a233895be74a66f451f1019ca9734205cc"
239252
]
240253
},
241254
"realityTemplateID": {
242-
"title": "The realityTemplateID Schema",
243-
"description": "An explanation about the purpose of this instance.",
244255
"type": "string",
245256
"default": "",
257+
"title": "The realityTemplateID Schema",
246258
"examples": [
247259
"76"
248260
]
249261
},
250262
"realityQuestionID": {
251-
"title": "The realityQuestionID Schema",
252-
"description": "An explanation about the purpose of this instance.",
253263
"type": "string",
254264
"default": "",
265+
"title": "The realityQuestionID Schema",
255266
"examples": [
256267
"0xe2a3bd38e3ad4e22336ac35b221bbbdd808d716209f84014c7bc3bf62f8e3b39"
257268
]
258269
},
259270
"realityUser": {
260-
"title": "The realityUser Schema",
261-
"description": "An explanation about the purpose of this instance.",
262271
"type": "string",
263272
"default": "",
273+
"title": "The realityUser Schema",
264274
"examples": [
265275
"0xe0441ecf50205d3548456b29fde2a3010f9a61f3"
266276
]
267277
},
278+
"realityType": {
279+
"type": "string",
280+
"default": "",
281+
"title": "The realityType Schema",
282+
"examples": [
283+
"bool"
284+
]
285+
},
268286
"realityCategory": {
269-
"title": "The realityCategory Schema",
270-
"description": "An explanation about the purpose of this instance.",
271287
"type": "string",
272288
"default": "",
289+
"title": "The realityCategory Schema",
273290
"examples": [
274291
"content moderation"
275292
]
276293
},
277294
"realityLang": {
278-
"title": "The realityLang Schema",
279-
"description": "An explanation about the purpose of this instance.",
280295
"type": "string",
281296
"default": "",
297+
"title": "The realityLang Schema",
282298
"examples": [
283299
"en_US"
284300
]
285301
},
302+
"realityFormat": {
303+
"type": "string",
304+
"default": "",
305+
"title": "The realityFormat Schema",
306+
"examples": [
307+
"text/markdown"
308+
]
309+
},
286310
"realityTimeout": {
287-
"title": "The realityTimeout Schema",
288-
"description": "An explanation about the purpose of this instance.",
289311
"type": "string",
290312
"default": "",
313+
"title": "The realityTimeout Schema",
291314
"examples": [
292315
"86400"
293316
]
294317
},
295318
"realityOpeningTime": {
296-
"title": "The realityOpeningTime Schema",
297-
"description": "An explanation about the purpose of this instance.",
298319
"type": "string",
299320
"default": "",
321+
"title": "The realityOpeningTime Schema",
300322
"examples": [
301323
"1681263978"
302324
]
303325
},
304326
"realityCreationTime": {
305-
"title": "The realityCreationTime Schema",
306-
"description": "An explanation about the purpose of this instance.",
307327
"type": "string",
308328
"default": "",
329+
"title": "The realityCreationTime Schema",
309330
"examples": [
310331
"1681263995"
311332
]
312333
},
313-
"realityFrontendUrl": {
314-
"title": "The realityFrontendUrl Schema",
315-
"description": "An explanation about the purpose of this instance.",
334+
"realityNonce": {
316335
"type": "string",
317336
"default": "",
337+
"title": "The realityNonce Schema",
318338
"examples": [
319-
"https://reality.eth.link/app/#!/question/0xe78996a233895be74a66f451f1019ca9734205cc-0xe2a3bd38e3ad4e22336ac35b221bbbdd808d716209f84014c7bc3bf62f8e3b39"
339+
"3"
320340
]
321341
}
322342
},
@@ -326,14 +346,56 @@
326346
"realityTemplateID": "76",
327347
"realityQuestionID": "0xe2a3bd38e3ad4e22336ac35b221bbbdd808d716209f84014c7bc3bf62f8e3b39",
328348
"realityUser": "0xe0441ecf50205d3548456b29fde2a3010f9a61f3",
349+
"realityType": "bool",
329350
"realityCategory": "content moderation",
330351
"realityLang": "en_US",
352+
"realityFormat": "text/markdown",
331353
"realityTimeout": "86400",
332354
"realityOpeningTime": "1681263978",
333355
"realityCreationTime": "1681263995",
334-
"realityFrontendUrl": "https://reality.eth.link/app/#!/question/0xe78996a233895be74a66f451f1019ca9734205cc-0xe2a3bd38e3ad4e22336ac35b221bbbdd808d716209f84014c7bc3bf62f8e3b39"
356+
"realityNonce": "3"
335357
}
336358
]
359+
},
360+
"externalDisputeID": {
361+
"type": "string",
362+
"default": "",
363+
"title": "The externalDisputeID Schema",
364+
"examples": [
365+
"0xe2a3bd38e3ad4e22336ac35b221bbbdd808d716209f84014c7bc3bf62f8e3b39"
366+
]
367+
},
368+
"arbitrableDisputeID": {
369+
"type": "string",
370+
"default": "",
371+
"title": "The arbitrableDisputeID Schema",
372+
"examples": [
373+
"245"
374+
]
375+
},
376+
"arbitratorDisputeID": {
377+
"type": "string",
378+
"default": "",
379+
"title": "The arbitratorDisputeID Schema",
380+
"examples": [
381+
"4563"
382+
]
383+
},
384+
"disputeTemplateID": {
385+
"type": "string",
386+
"default": "",
387+
"title": "The disputeTemplateID Schema",
388+
"examples": [
389+
"42"
390+
]
391+
},
392+
"disputeTemplateHash": {
393+
"type": "string",
394+
"default": "",
395+
"title": "The disputeTemplateHash Schema",
396+
"examples": [
397+
"0xB5u9...2240"
398+
]
337399
}
338400
}
339401
}

kleros-sdk/config/v2-disputetemplate/reality/dispute-details.reality1.jsonc renamed to kleros-sdk/config/v2-disputetemplate/reality/DisputeDetails.reality1.jsonc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
2-
"$schema": "./dispute-details.reality.schema.json",
3-
"category": "Oracle",
2+
"$schema": "./DisputeDetails.reality.schema.json",
43
"title": "A reality.eth question",
54
"description": "A reality.eth question has been raised to arbitration.",
65
"question": "# [Kleros Moderate](https://kleros.io/moderate)\n---\nDid the user, **degenape6** (ID: 1554345080), break the Telegram group, ***[Kleros Trading Group]()*** (ID: -1001151472172), ***[rules](https://ipfs.kleros.io/ipfs/Qme3Qbj9rKUNHUe9vj9rqCLnTVUCWKy2YfveQF8HiuWQSu/Kleros%20Moderate%20Community%20Rules.pdf)*** due to conduct related to the ***[message](https://t.me/c/1151472172/116662)*** (***[backup](https://ipfs.kleros.io/ipfs/QmVbFrZR1bcyQzZjvLyXwL9ekDxrqHERykdreRxXrw4nqg/animations_file_23.mp4)***)?",
@@ -25,31 +24,34 @@
2524
"id": "0x02",
2625
"title": "No",
2726
"reserved": false
28-
},
27+
}
2928
],
30-
"frontendUrl": "https://reality.eth.link/app/#!/question/", // SDK should not change it
3129
"policyURI": "/ipfs/QmW4zDA8X95cyfAsW9Nq1t7XNTyP3sMQAWNRFoQhMpgAv7/Kleros%2520Moderate%2520x%2520Reality.eth%2520Oracle%2520-%2520Telegram%2520Content%2520Moderation%2520Question%2520Resolution%2520Policy.pdf",
30+
"frontendUrl": "https://reality.eth.link/app/#!/question/0xe78996a233895be74a66f451f1019ca9734205cc-0xe2a3bd38e3ad4e22336ac35b221bbbdd808d716209f84014c7bc3bf62f8e3b39",
3231
"arbitrableChainID": "100",
3332
"arbitrableAddress": "0x2e39b8f43d0870ba896f516f78f57cde773cf805", // Realitio_v2_1_ArbitratorWithAppeals
3433
"arbitratorChainID": "421613",
3534
"arbitratorAddress": "0xD08Ab99480d02bf9C092828043f611BcDFEA917b", // KlerosCore
35+
"category": "Oracle",
36+
"lang": "en_US",
3637
"specification": "KIP99",
3738
"metadata": {
3839
"realityAddress": "0xe78996a233895be74a66f451f1019ca9734205cc",
3940
"realityTemplateID": "76",
4041
"realityQuestionID": "0xe2a3bd38e3ad4e22336ac35b221bbbdd808d716209f84014c7bc3bf62f8e3b39",
4142
"realityUser": "0xe0441ecf50205d3548456b29fde2a3010f9a61f3",
43+
"realityType": "bool",
4244
"realityCategory": "content moderation",
4345
"realityLang": "en_US",
46+
"realityFormat": "text/markdown",
4447
"realityTimeout": "86400",
4548
"realityOpeningTime": "1681263978",
4649
"realityCreationTime": "1681263995",
47-
"realityFrontendUrl": "https://reality.eth.link/app/#!/question/0xe78996a233895be74a66f451f1019ca9734205cc-0xe2a3bd38e3ad4e22336ac35b221bbbdd808d716209f84014c7bc3bf62f8e3b39"
50+
"realityNonce": "3"
4851
},
4952
"externalDisputeID": "0xe2a3bd38e3ad4e22336ac35b221bbbdd808d716209f84014c7bc3bf62f8e3b39",
50-
"arbitrableDisputeID": "23",
53+
"arbitrableDisputeID": "245",
5154
"arbitratorDisputeID": "4563",
5255
"disputeTemplateID": "42",
53-
"disputeTemplateHash": "",
54-
"disputeTemplateInputsHash": ""
56+
"disputeTemplateHash": "0xB5u9...2240"
5557
}

0 commit comments

Comments
 (0)