feat: migrated all the interfaces to the new v2 ones)

Author: jaybuidl

contracts/deploy/00-home-chain-arbitrable.ts

@@ -1,5 +1,6 @@
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
+import disputeTemplate from "../../kleros-sdk/config/v2-disputetemplate/simple/NewDisputeTemplate.simple.json";
 
 enum HomeChains {
   ARBITRUM_ONE = 42161,
@@ -21,12 +22,7 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
 
   await deploy("ArbitrableExample", {
     from: deployer,
-    args: [
-      klerosCore.address,
-      0,
-      "https://cloudflare-ipfs.com/ipfs/bafkreifteme6tusnjwyzajk75fyvzdmtyycxctf7yhfijb6rfigz3n4lvq",
-      weth.address,
-    ],
+    args: [klerosCore.address, disputeTemplate, weth.address],
     log: true,
   });
 

contracts/deploy/03-vea-mock.ts

@@ -1,6 +1,7 @@
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
 import getContractAddress from "../deploy-helpers/getContractAddress";
+import disputeTemplate from "../../kleros-sdk/config/v2-disputetemplate/simple/NewDisputeTemplate.simple.json";
 
 const HARDHAT_NETWORK = 31337;
 
@@ -58,11 +59,9 @@ const deployHomeGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment)
     ethers.BigNumber.from(10).pow(17)
   );
 
-  const metaEvidenceUri = `https://raw.githubusercontent.com/kleros/kleros-v2/master/contracts/deployments/goerli/MetaEvidence_ArbitrableExample.json`;
-
   await deploy("ArbitrableExample", {
     from: deployer,
-    args: [foreignGateway.address, 0, metaEvidenceUri, ethers.constants.AddressZero],
+    args: [foreignGateway.address, disputeTemplate, ethers.constants.AddressZero],
     log: true,
   });
 };

contracts/deploy/04-klerosliquid-to-v2-gnosis.ts

@@ -1,6 +1,7 @@
 import { parseUnits, parseEther } from "ethers/lib/utils";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
+import disputeTemplate from "../../kleros-sdk/config/v2-disputetemplate/simple/NewDisputeTemplate.simple.json";
 
 enum ForeignChains {
   GNOSIS_MAINNET = 100,
@@ -98,29 +99,11 @@ const deployKlerosLiquid: DeployFunction = async (hre: HardhatRuntimeEnvironment
   // const xKlerosLiquidV2 = await deployments.get("xKlerosLiquidV2");
   await deploy("ArbitrableExample", {
     from: deployer,
-    args: [
-      xKlerosLiquidV2.address,
-      0,
-      "/ipfs/bafkreifteme6tusnjwyzajk75fyvzdmtyycxctf7yhfijb6rfigz3n4lvq", // PoH registration
-      weth.address,
-    ],
+    args: [xKlerosLiquidV2.address, 0, disputeTemplate, weth.address],
     log: true,
     maxFeePerGas: ONE_GWEI,
     maxPriorityFeePerGas: ONE_GWEI,
   });
-
-  await execute(
-    "ArbitrableExample",
-    {
-      from: deployer,
-      log: true,
-      maxFeePerGas: ONE_GWEI,
-      maxPriorityFeePerGas: ONE_GWEI,
-    },
-    "changeMetaEvidence",
-    1,
-    "/ipfs/bafkreibiuxwejijwg4pxco7fqszawcwmpt26itbdxeqgh7cvpeuwtmlhoa" // PoH clearing
-  );
 };
 
 // TODO: mock deployment on the hardhat network

contracts/src/arbitration/IArbitrableV2.sol

@@ -13,8 +13,8 @@ interface IArbitrableV2 {
     /// @dev To be emitted when a new dispute template is created.
     /// @param _templateId The identifier of the dispute template.
     /// @param _templateTag An optional tag for the dispute template, such as "registration" or "removal".
-    /// @param data The template data.
-    event DisputeTemplate(uint256 indexed _templateId, string indexed _templateTag, string data);
+    /// @param _templateData The template data.
+    event DisputeTemplate(uint256 indexed _templateId, string indexed _templateTag, string _templateData);
 
     /// @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.

contracts/src/arbitration/KlerosGovernor.sol

@@ -7,12 +7,11 @@
 
 pragma solidity 0.8.18;
 
-import "./IArbitrable.sol";
-import "../evidence/IMetaEvidence.sol";
+import {IArbitrableV2, IArbitratorV2} from "./IArbitrableV2.sol";
 import "../libraries/CappedMath.sol";
 
 /// @title KlerosGovernor for V2. Note that appeal functionality and evidence submission will be handled by the court.
-contract KlerosGovernor is IArbitrable, IMetaEvidence {
+contract KlerosGovernor is IArbitrableV2 {
     using CappedMath for uint256;
 
     // ************************************* //
@@ -52,9 +51,9 @@ contract KlerosGovernor is IArbitrable, IMetaEvidence {
         uint256 approvalTime; // The time when the list was approved.
     }
 
-    IArbitrator public arbitrator; // Arbitrator contract.
+    IArbitratorV2 public arbitrator; // Arbitrator contract.
     bytes public arbitratorExtraData; // Extra data for arbitrator.
-    uint256 public metaEvidenceUpdates; // The number of times the meta evidence has been updated. Used to track the latest meta evidence ID.
+    uint256 public disputeTemplates; // The number of dispute templates created.
 
     uint256 public submissionBaseDeposit; // The base deposit in wei that needs to be paid in order to submit the list.
     uint256 public submissionTimeout; // Time in seconds allowed for submitting the lists. Once it's passed the contract enters the approval period.
@@ -115,15 +114,15 @@ contract KlerosGovernor is IArbitrable, IMetaEvidence {
     /// @dev Constructor.
     /// @param _arbitrator The arbitrator of the contract.
     /// @param _arbitratorExtraData Extra data for the arbitrator.
-    /// @param _metaEvidence The URI of the meta evidence file.
+    /// @param _templateData The dispute template data.
     /// @param _submissionBaseDeposit The base deposit required for submission.
     /// @param _submissionTimeout Time in seconds allocated for submitting transaction list.
     /// @param _executionTimeout Time in seconds after approval that allows to execute transactions of the approved list.
     /// @param _withdrawTimeout Time in seconds after submission that allows to withdraw submitted list.
     constructor(
-        IArbitrator _arbitrator,
+        IArbitratorV2 _arbitrator,
         bytes memory _arbitratorExtraData,
-        string memory _metaEvidence,
+        string memory _templateData,
         uint256 _submissionBaseDeposit,
         uint256 _submissionTimeout,
         uint256 _executionTimeout,
@@ -139,7 +138,7 @@ contract KlerosGovernor is IArbitrable, IMetaEvidence {
         withdrawTimeout = _withdrawTimeout;
         sessions.push();
 
-        emit MetaEvidence(metaEvidenceUpdates, _metaEvidence);
+        emit DisputeTemplate(disputeTemplates++, "", _templateData);
     }
 
     /// @dev Changes the value of the base deposit required for submitting a list.
@@ -171,18 +170,17 @@ contract KlerosGovernor is IArbitrable, IMetaEvidence {
     /// @param _arbitrator The new trusted arbitrator.
     /// @param _arbitratorExtraData The extra data used by the new arbitrator.
     function changeArbitrator(
-        IArbitrator _arbitrator,
+        IArbitratorV2 _arbitrator,
         bytes memory _arbitratorExtraData
     ) external onlyByGovernor duringSubmissionPeriod {
         arbitrator = _arbitrator;
         arbitratorExtraData = _arbitratorExtraData;
     }
 
-    /// @dev Update the meta evidence used for disputes.
-    /// @param _metaEvidence URI to the new meta evidence file.
-    function changeMetaEvidence(string memory _metaEvidence) external onlyByGovernor {
-        metaEvidenceUpdates++;
-        emit MetaEvidence(metaEvidenceUpdates, _metaEvidence);
+    /// @dev Update the dispute template data.
+    /// @param _templateData The new dispute template data.
+    function changeDisputeTemplate(string memory _templateData) external onlyByGovernor {
+        emit DisputeTemplate(disputeTemplates++, "", _templateData);
     }
 
     /// @dev Creates transaction list based on input parameters and submits it for potential approval and execution.
@@ -296,7 +294,7 @@ contract KlerosGovernor is IArbitrable, IMetaEvidence {
             session.sumDeposit = session.sumDeposit.subCap(arbitrationCost);
 
             reservedETH = reservedETH.subCap(arbitrationCost);
-            emit Dispute(arbitrator, session.disputeID, metaEvidenceUpdates, sessions.length - 1);
+            emit DisputeRequest(arbitrator, session.disputeID, sessions.length - 1, disputeTemplates, "");
         }
     }
 
@@ -325,7 +323,7 @@ contract KlerosGovernor is IArbitrable, IMetaEvidence {
         session.ruling = _ruling;
         sessions.push();
 
-        emit Ruling(IArbitrator(msg.sender), _disputeID, _ruling);
+        emit Ruling(IArbitratorV2(msg.sender), _disputeID, _ruling);
     }
 
     /// @dev Executes selected transactions of the list.

contracts/src/arbitration/arbitrables/ArbitrableExample.sol

@@ -2,32 +2,22 @@
 
 pragma solidity 0.8.18;
 
+import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "../IArbitrable.sol";
 import "../../evidence/IMetaEvidence.sol";
-import "../../libraries/SafeERC20.sol";
 
 /// @title ArbitrableExample
 /// An example of an arbitrable contract which connects to the arbitator that implements the updated interface.
 contract ArbitrableExample is IArbitrable, IMetaEvidence {
-    using SafeERC20 for IERC20;
-
-    // ************************************* //
-    // *         Enums / Structs           * //
-    // ************************************* //
-
     struct DisputeStruct {
         bool isRuled; // Whether the dispute has been ruled or not.
         uint256 ruling; // Ruling given by the arbitrator.
         uint256 numberOfRulingOptions; // The number of choices the arbitrator can give.
     }
 
-    // ************************************* //
-    // *             Storage               * //
-    // ************************************* //
-
     address public immutable governor;
     IArbitrator public arbitrator; // Arbitrator is set in constructor and never changed.
-    IERC20 public immutable weth; // The WETH token.
+    ERC20 public immutable weth; // The WETH token.
     mapping(uint256 => uint256) public externalIDtoLocalID; // Maps external (arbitrator side) dispute IDs to local dispute IDs.
     DisputeStruct[] public disputes; // Stores the disputes' info. disputes[disputeID].
 
@@ -39,11 +29,11 @@ contract ArbitrableExample is IArbitrable, IMetaEvidence {
     /// @param _arbitrator The arbitrator to rule on created disputes.
     /// @param _metaEvidenceID Unique identifier of meta-evidence.
     /// @param _metaEvidence The URI of the meta evidence object for evidence submissions requests.
-    constructor(IArbitrator _arbitrator, uint256 _metaEvidenceID, string memory _metaEvidence, IERC20 _weth) {
+    constructor(IArbitrator _arbitrator, uint256 _metaEvidenceID, string memory _metaEvidence, ERC20 _weth) {
         governor = msg.sender;
         arbitrator = _arbitrator;
         weth = _weth;
-        emit MetaEvidence(_metaEvidenceID, _metaEvidence);
+        emit DisputeTemplate(disputeTemplates++, "", _templateData);
     }
 
     // ************************************* //
@@ -66,55 +56,56 @@ contract ArbitrableExample is IArbitrable, IMetaEvidence {
 
     /// @dev Calls createDispute function of the specified arbitrator to create a dispute.
     /// Note that we don’t need to check that msg.value is enough to pay arbitration fees as it’s the responsibility of the arbitrator contract.
-    /// @param _numberOfRulingOptions Number of ruling options. Must be greater than 1, otherwise there is nothing to choose from.
+    /// @param _templateId The identifier of the dispute template. Should not be used with _templateUri.
+    /// @param _action The action that requires arbitration.
     /// @param _arbitratorExtraData Extra data for the arbitrator.
-    /// @param _metaEvidenceID Unique identifier of meta-evidence.
-    /// @param _evidenceGroupID Unique identifier of the evidence group that is linked to this dispute.
     /// @return disputeID Dispute id (on arbitrator side) of the dispute created.
     function createDispute(
-        uint256 _numberOfRulingOptions,
-        bytes calldata _arbitratorExtraData,
-        uint256 _metaEvidenceID,
-        uint256 _evidenceGroupID
+        uint256 _templateId,
+        string calldata _action,
+        bytes calldata _arbitratorExtraData
     ) external payable returns (uint256 disputeID) {
-        require(_numberOfRulingOptions > 1, "Incorrect number of choices");
+        emit Action(_action);
 
+        uint256 numberOfRulingOptions = 2;
         uint256 localDisputeID = disputes.length;
-        disputes.push(DisputeStruct({isRuled: false, ruling: 0, numberOfRulingOptions: _numberOfRulingOptions}));
+        disputes.push(DisputeStruct({isRuled: false, ruling: 0, numberOfRulingOptions: numberOfRulingOptions}));
+
+        disputeID = arbitrator.createDispute{value: msg.value}(numberOfRulingOptions, _arbitratorExtraData);
 
-        disputeID = arbitrator.createDispute{value: msg.value}(_numberOfRulingOptions, _arbitratorExtraData);
         externalIDtoLocalID[disputeID] = localDisputeID;
 
-        emit Dispute(arbitrator, disputeID, _metaEvidenceID, _evidenceGroupID);
+        uint256 externalDisputeID = uint256(keccak256(abi.encodePacked(_action)));
+        emit DisputeRequest(arbitrator, disputeID, externalDisputeID, _templateId, "");
     }
 
-    /// @dev TRUSTED. Creates a dispute with the arbitrator and pays for the fees in WETH token.
-    /// Note that we don’t need to check that _feeInWeth is enough to pay arbitration fees as it’s the responsibility of the arbitrator contract.
-    /// @param _numberOfRulingOptions Number of ruling options. Must be greater than 1, otherwise there is nothing to choose from.
+    /// @dev Calls createDispute function of the specified arbitrator to create a dispute.
+    /// Note that we don’t need to check that msg.value is enough to pay arbitration fees as it’s the responsibility of the arbitrator contract.
+    /// @param _templateId The identifier of the dispute template. Should not be used with _templateUri.
+    /// @param _action The action that requires arbitration.
     /// @param _arbitratorExtraData Extra data for the arbitrator.
-    /// @param _metaEvidenceID Unique identifier of meta-evidence.
-    /// @param _evidenceGroupID Unique identifier of the evidence group that is linked to this dispute.
     /// @param _feeInWeth Amount of fees in WETH for the arbitrator.
     /// @return disputeID Dispute id (on arbitrator side) of the dispute created.
     function createDispute(
-        uint256 _numberOfRulingOptions,
+        uint256 _templateId,
+        string calldata _action,
         bytes calldata _arbitratorExtraData,
-        uint256 _metaEvidenceID,
-        uint256 _evidenceGroupID,
         uint256 _feeInWeth
     ) external payable returns (uint256 disputeID) {
-        require(_numberOfRulingOptions > 1, "Incorrect number of choices");
+        emit Action(_action);
 
+        uint256 numberOfRulingOptions = 2;
         uint256 localDisputeID = disputes.length;
-        disputes.push(DisputeStruct({isRuled: false, ruling: 0, numberOfRulingOptions: _numberOfRulingOptions}));
+        disputes.push(DisputeStruct({isRuled: false, ruling: 0, numberOfRulingOptions: numberOfRulingOptions}));
 
         require(weth.safeTransferFrom(msg.sender, address(this), _feeInWeth), "Transfer failed");
         require(weth.increaseAllowance(address(arbitrator), _feeInWeth), "Allowance increase failed");
 
-        disputeID = arbitrator.createDispute(_numberOfRulingOptions, _arbitratorExtraData, weth, _feeInWeth);
+        disputeID = arbitrator.createDispute(numberOfRulingOptions, _arbitratorExtraData, weth, _feeInWeth);
         externalIDtoLocalID[disputeID] = localDisputeID;
 
-        emit Dispute(arbitrator, disputeID, _metaEvidenceID, _evidenceGroupID);
+        uint256 externalDisputeID = uint256(keccak256(abi.encodePacked(_action)));
+        emit DisputeRequest(arbitrator, disputeID, externalDisputeID, _templateId, "");
     }
 
     /// @dev To be called by the arbitrator of the dispute, to declare the winning ruling.
@@ -130,6 +121,16 @@ contract ArbitrableExample is IArbitrable, IMetaEvidence {
         dispute.isRuled = true;
         dispute.ruling = _ruling;
 
-        emit Ruling(IArbitrator(msg.sender), _externalDisputeID, dispute.ruling);
+        emit Ruling(IArbitratorV2(msg.sender), _externalDisputeID, dispute.ruling);
+    }
+
+    function changeMetaEvidence(uint256 _metaEvidenceID, string memory _metaEvidence) external {
+        require(msg.sender == governor, "Not authorized: governor only.");
+        emit MetaEvidence(_metaEvidenceID, _metaEvidence);
+    }
+
+    function changeArbitrator(IArbitrator _arbitrator) external {
+        require(msg.sender == governor, "Not authorized: governor only.");
+        arbitrator = _arbitrator;
     }
 }