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
For guidance on creating your own dispute policy document, please refer to our [Policy Writing Guide](https://docs.kleros.io/integrations/policy-writing-guide).
128
-
*`evidenceDisplayInterfaceURI`: The URI to a display interface that should be used to render the facts of a case in an iframe by the Arbitrator.
128
+
*`evidenceDisplayInterfaceURI`: This field provides a URI that points to a display interface for rendering evidence in a more user-friendly way for arbitrators.
129
+
130
+
**Core purpose:**
131
+
132
+
* Creates a custom UI for presenting evidence within the arbitration interface
133
+
* Allows for branded, styled presentation of dispute evidence
134
+
* Renders in an iframe within the arbitrator's interface
135
+
136
+
**The query parameters passed to it include:**
137
+
138
+
*`disputeID`: Identifier for the specific dispute
139
+
*`chainID`: The blockchain network ID
140
+
*`arbitratorContractAddress`: Address of the arbitrator contract
141
+
*`arbitratorJsonRpcUrl`: JSON-RPC endpoint for the arbitrator's blockchain
142
+
*`arbitratorChainID`: Chain ID for the arbitrator
143
+
*`arbitrableContractAddress`: Address of the arbitrable contract
144
+
*`arbitrableChainID`: Chain ID for the arbitrable contract
145
+
*`arbitrableJsonRpcUrl`: JSON-RPC endpoint for the arbitrable contract's blockchain
146
+
*`jsonRpcUrl`: General JSON-RPC URL for the arbitrator's environment (typically Ethereum mainnet or Gnosis Chain)
147
+
148
+
While there are no hard limits to the amount of content that can be displayed, it's recommended to keep the interface under 360px in height to ensure it's easily readable within the court interface.
149
+
150
+
**When to use it:**
151
+
152
+
1.**Complex Financial Transactions**: For payment histories, multi-party transactions, or time-series data that benefits from visualization.
153
+
2.**Evidence Context and Relationships**: Standard evidence attachments are recommended for both textual and non-textual evidence, but the display interface can organize these attachments, provide context, and visualize relationships between different evidence elements.
154
+
3.**Branded Experience**: When maintaining your application's visual identity throughout the dispute resolution process is important. \
155
+
**Examples:**[escrow](https://github.com/kleros/escrow-evidence-display), [reality same chain](https://github.com/kleros/realitio-interface), [reality cross-chain](https://github.com/kleros/cross-chain-realitio-proxy/tree/master/evidence-display), [curate](https://github.com/kleros/gtcr-injected-uis)
156
+
*`dynamicScriptURI`: This field provides a URI to a script that can dynamically update the MetaEvidence when it's fetched by an arbitrator interface. This script must expose a function called `getMetaEvidence` that returns JSON data, which is then merged with the original MetaEvidence JSON.
157
+
158
+
**Core purpose:**
159
+
160
+
* Makes MetaEvidence more dynamic without requiring on-chain updates
161
+
* Reduces gas costs by avoiding repeated on-chain MetaEvidence updates
162
+
* Provides flexibility for disputes with changing content or context
163
+
164
+
**When to use it:**
165
+
166
+
1.**Template-Based Disputes**: For similar disputes with different parameters.
167
+
2.**Gas Optimization**: When emitting new MetaEvidence events for each dispute would be prohibitively expensive.
168
+
3.**Dynamic Content**: When dispute details aren't fully known at contract creation time but follow a predictable pattern.\
169
+
**Examples:**[reality same chain](https://github.com/kleros/realitio-script), [reality cross-chain](https://github.com/kleros/cross-chain-realitio-proxy/tree/master/dynamic-script)
| Show relationships between evidence | evidenceDisplayInterfaceURI |
175
+
| Maintain brand identity in disputes | evidenceDisplayInterfaceURI |
176
+
| Handle many similar disputes | dynamicScriptURI |
177
+
| Reduce gas costs for many disputes | dynamicScriptURI |
178
+
| Adapt MetaEvidence at runtime | dynamicScriptURI |
179
+
| Complex visualization + dynamic content | Both fields together |
180
+
181
+
**Using Both Fields Together**
182
+
183
+
When your dispute resolution needs are complex, you can use both fields together in the same MetaEvidence. This allows you to have both dynamic content and custom visualization.
184
+
185
+
129
186
130
187
Here's an example of a MetaEvidence JSON:
131
188
@@ -155,22 +212,7 @@ Below you will find a diagram that shows how the elements in the MetaEvidence JS
155
212
156
213
<figure><imgsrc="../../.gitbook/assets/metaevidence_diagram.jpg"alt=""><figcaption><p>A screenshot of <ahref="https://resolve.kleros.io/cases/1213">Case #1213 on resolve.kleros.io</a>, showcasing all the important elements in the MetaEvidence JSON of this case.</p></figcaption></figure>
157
214
158
-
#### Additional information about the evidenceDisplayInterfaceURI
159
215
160
-
The `evidenceDisplayInterfaceURI` can be used to display dynamic information in an iframe on the court interface about each case, including the details of the disputants, images or any other related information. There are no hard limits to the amount of content that can be displayed here, though a rule of thumb is to keep this page under 360px in height to make it easily readable on the court interface.
161
-
162
-
\
163
-
When loading the iframe, the `evidenceDisplayInterfaceURI` will be called with a URL-encoded JSON query string as the payload, with the following keys to allow the page to display and retrieve content dynamically:
164
-
165
-
*`disputeID`
166
-
*`chainID`
167
-
*`arbitratorContractAddress`
168
-
*`arbitratorJsonRpcUrl`
169
-
*`arbitratorChainID`
170
-
*`arbitrableContractAddress`
171
-
*`arbitrableChainID`
172
-
*`arbitrableJsonRpcUrl`
173
-
*`jsonRpcUrl`
174
216
175
217
Here is an example of the URL with query string used by the iframe on the Arbitrator interface:
0 commit comments