feat: interfaces wip

Author: jaybuidl

contracts/src/arbitration/IArbitrableV2.sol

@@ -12,18 +12,32 @@ import "./IArbitratorV2.sol";
  * - Allow dispute creation. For this a function must call arbitrator.createDispute{value: _fee}(_choices,_extraData);
  */
 interface IArbitrableV2 {
+    /**
+     * @dev To be emitted when a new dispute template is created.
+     * @param _templateId The ID of the dispute template.
+     * @param _templateTag An optional tag for the dispute template, such as "registration" or "removal".
+     * @param data The template data.
+     */
+    event NewDisputeTemplate(
+        uint256 indexed _templateId,
+        string indexed _templateTag,
+        string data
+    );
+
     /**
      * @dev To be emitted when a dispute is created to link the correct meta-evidence to the disputeID.
      * @param _arbitrator The arbitrator of the contract.
-     * @param _disputeID ID of the dispute in the Arbitrator contract.
-     * @param _externalDisputeID Unique identifier from the dispute creator that is linked to this dispute.
-     * @param _disputeContextUri IPFS path to dispute context, example: '/ipfs/Qmarwkf7C9RuzDEJNnarT3WZ7kem5bk8DZAzx78acJjMFH/disputecontext.json'
+     * @param _arbitrableDisputeID The ID of the dispute in the Arbitrable contract.
+     * @param _externalDisputeID An identifier created outside Kleros by the protocol requesting arbitration.
+     * @param _templateId The ID of the dispute template. Should not be used with _templateUri.
+     * @param _templateUri IPFS path to the dispute template starting with '/ipfs/'. Should not be used with _templateId.
      */
-    event Dispute(
+    event NewDisputeRequest(
         IArbitrableV2 indexed _arbitrator,
-        uint256 indexed _disputeID,
+        uint256 indexed _arbitrableDisputeID,
         uint256 _externalDisputeID,
-        string _disputeContextUri
+        uint256 _templateId,
+        string _templateUri
     );
 
     /**

contracts/src/arbitration/IArbitratorV2.sol

@@ -7,7 +7,7 @@ import "./IArbitrableV2.sol";
 /**
  * @title Arbitrator
  * Arbitrator interface that implements the new arbitration standard.
- * Unlike the ERC-792 this standard doesn't have anything related to appeals, so each arbitrator can implement an appeal system that suits it the most.
+ * Unlike the ERC-792 this standard is not concerned with appeals, so each arbitrator can implement an appeal system that suits it the most.
  * When developing arbitrator contracts we need to:
  * - Define the functions for dispute creation (createDispute). Don't forget to store the arbitrated contract and the disputeID (which should be unique, may nbDisputes).
  * - Define the functions for cost display (arbitrationCost).

contracts/src/arbitration/dispute-kits/DisputeKitClassic.sol

@@ -375,11 +375,11 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {
         }
     }
 
-    /// @dev Submits evidence.
-    /// @param _evidenceGroupID Unique identifier of the evidence group the evidence belongs to. It's the submitter responsability to submit the right evidence group ID.
+    /// @dev Submits evidence for a dispute.
+    /// @param _externalDisputeID Unique identifier for this dispute outside Kleros. It's the submitter responsability to submit the right evidence group ID.
     /// @param _evidence IPFS path to evidence, example: '/ipfs/Qmarwkf7C9RuzDEJNnarT3WZ7kem5bk8DZAzx78acJjMFH/evidence.json'.
-    function submitEvidence(uint256 _evidenceGroupID, string calldata _evidence) external {
-        emit Evidence(_evidenceGroupID, msg.sender, _evidence);
+    function submitEvidence(uint256 _externalDisputeID, string calldata _evidence) external {
+        emit Evidence(_externalDisputeID, msg.sender, _evidence);
     }
 
     // ************************************* //

contracts/src/arbitration/dispute-kits/DisputeKitSybilResistant.sol

@@ -395,11 +395,11 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {
         }
     }
 
-    /// @dev Submits evidence.
-    /// @param _evidenceGroupID Unique identifier of the evidence group the evidence belongs to. It's the submitter responsability to submit the right evidence group ID.
+    /// @dev Submits evidence for a dispute.
+    /// @param _externalDisputeID Unique identifier for this dispute outside Kleros. It's the submitter responsability to submit the right evidence group ID.
     /// @param _evidence IPFS path to evidence, example: '/ipfs/Qmarwkf7C9RuzDEJNnarT3WZ7kem5bk8DZAzx78acJjMFH/evidence.json'.
-    function submitEvidence(uint256 _evidenceGroupID, string calldata _evidence) external {
-        emit Evidence(_evidenceGroupID, msg.sender, _evidence);
+    function submitEvidence(uint256 _externalDisputeID, string calldata _evidence) external {
+        emit Evidence(_externalDisputeID, msg.sender, _evidence);
     }
 
     // ************************************* //

contracts/src/evidence/IEvidence.sol

@@ -7,8 +7,8 @@ import "../arbitration/IArbitrator.sol";
 /// @title IEvidence
 interface IEvidence {
     /// @dev To be raised when evidence is submitted. Should point to the resource (evidences are not to be stored on chain due to gas considerations).
-    /// @param _evidenceGroupID Unique identifier of the evidence group the evidence belongs to.
+    /// @param _externalDisputeID Unique identifier for this dispute outside Kleros. It's the submitter responsability to submit the right evidence group ID.
     /// @param _party The address of the party submiting the evidence. Note that 0x0 refers to evidence not submitted by any party.
     /// @param _evidence IPFS path to evidence, example: '/ipfs/Qmarwkf7C9RuzDEJNnarT3WZ7kem5bk8DZAzx78acJjMFH/evidence.json'
-    event Evidence(uint256 indexed _evidenceGroupID, address indexed _party, string _evidence);
+    event Evidence(uint256 indexed _externalDisputeID, address indexed _party, string _evidence);
 }

contracts/src/evidence/IEvidenceV2.sol

@@ -0,0 +1,51 @@
+# V2 BREAKING CHANGES
+
+## Onchain changes
+
+### IArbitrator
+
+#### The appeal events and functions have been removed
+
+The appeal concerns are deemed implementation-specific so they have been removed from the Arbitrator interface.
+
+The following have been removed from the Arbitrator interface but are available directly on KlerosCore:
+
+```solidity
+function appealCost(uint256 _disputeID) external view returns (uint256 cost);
+
+function appealPeriod(uint256 _disputeID) external view returns (uint256 start, uint256 end);
+```
+
+The following have been removed entirely:
+
+```solidity
+event AppealPossible(uint256 indexed _disputeID, IArbitrableV1 indexed _arbitrable);
+event AppealDecision(uint256 indexed _disputeID, IArbitrableV1 indexed _arbitrable);
+function appeal(uint256 _disputeID, bytes calldata _extraData) external payable;
+```
+
+The appeal requests are now the responsibility of the DisputeKit implementation. For example in the DisputeKitClassic there is now:
+
+```solidity
+// DisputeKitClassic.sol
+function fundAppeal(uint256 _coreDisputeID, uint256 _choice) payable;
+
+function getFundedChoices(uint256 _coreDisputeID) view returns (uint256[] memory fundedChoices);
+```
+
+#### `DisputeStatus` has been removed
+
+It was deemed redundant. An equivalent behavior can be emulated as follow:
+
+```solidity
+// for a particular disputeID
+(,,IArbitrator.Period period,,) = arbitrator.disputes(disputeID);
+
+if (period < IArbitratorV2.Period.appeal)
+    // Do DisputeStatus.Waiting stuffs
+else if (_period < IArbitratorV2.Period.execution)
+    // Do DisputeStatus.Appealable stuffs
+else
+    // Do DisputeStatus.Solved stuffs
+}
+```

kleros-sdk/config/v2-disputetemplate/README.md

@@ -51,7 +51,7 @@
     "linguoRequester": "0xabc996a233895be74a66f451f1019ca97342aaaa",
     "linguoTranslator": "0xbcd996a233895be74a66f451f1019ca97342bbbb",
     "linguoChallenger": "0xcde996a233895be74a66f451f1019ca97342cccc",
-    "linguoFrontendUrl": "https://linguo.kleros.io/translation/0x0B928165A67df8254412483ae8C3b8cc7F2b4D36/35",
+    "linguoFrontendUrl": "https://linguo.kleros.io/translation/0x0B928165A67df8254412483ae8C3b8cc7F2b4D36/35"
   },
   "externalDisputeID": "13", // taskID
   "arbitrableDisputeID": "7",

kleros-sdk/config/v2-disputetemplate/linguo/DisputeDetails.linguo.jsonc

@@ -6,11 +6,11 @@
   "answers": [
     {
       "title": "Yes, the translation should be accepted",
-      "description": "Select this if you think the translation complies with the required criteria.",
+      "description": "Select this if you think the translation complies with the required criteria."
     },
     {
       "title": "No, the translation should not be accepted",
-      "description": "Select this if you think the translation does not comply with the required criteria.",
+      "description": "Select this if you think the translation does not comply with the required criteria."
     }
   ],
   "policyURI": "/ipfs/QmVabp1VjJNYzXDxbcWFdeK17RvvA9eQy6eJVf1T1AzS1a/linguo-translation-quality-policy.pdf",

kleros-sdk/config/v2-disputetemplate/linguo/NewDisputeTemplate.linguo.jsonc

@@ -0,0 +1,18 @@
+# Dispute Standard for Reality.eth
+
+[Specs](./kip-99.md)
+[New dispute template](./NewDisputeTemplate.reality.jsonc)
+[Dispute details schema](./DisputeDetails.reality.schema.json) (optional)
+SDK implementation (TODO)
+
+## Example 1: Kleros Moderate Question
+
+[New dispute parameters](./example1/NewDispute.reality1.jsonc)
+[Inputs for the dispute template](./example1/DisputeTemplateInputs.reality1.txt)
+[Dispute details output](./example1/DisputeDetails.reality1.jsonc)
+
+## Example 2: Formula1 Question
+
+[New dispute parameters](./example2/NewDispute.reality2.jsonc)
+[Inputs for the dispute template](./example2/DisputeTemplateInputs.reality2.txt)
+[Dispute details output](./example2/DisputeDetails.reality2.jsonc)