fix: added the arbitrator disputeID to the CrossChainDisputeIncoming event

Also simplified ArbitrableExample.createDispute().

Author: jaybuidl

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

@@ -18,11 +18,13 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   console.log("Deploying to %s with deployer %s", HomeChains[chainId], deployer);
 
   const klerosCore = await deployments.get("KlerosCore");
+  const extraData =
+    "0x00000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000003"; // General court, 3 jurors
   const weth = await deployments.get("WETH");
 
   await deploy("ArbitrableExample", {
     from: deployer,
-    args: [klerosCore.address, disputeTemplate, weth.address],
+    args: [klerosCore.address, disputeTemplate, extraData, weth.address],
     log: true,
   });
 

contracts/deploy/01-foreign-gateway-on-ethereum.ts

@@ -1,6 +1,7 @@
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
 import getContractAddress from "../deploy-helpers/getContractAddress";
+import { KlerosCore__factory } from "../typechain-types";
 
 enum ForeignChains {
   ETHEREUM_MAINNET = 1,
@@ -45,13 +46,13 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
   });
 
   // TODO: disable the gateway until fully initialized with the correct fees OR allow disputeCreators to add funds again if necessary.
-  await execute(
-    "ForeignGatewayOnEthereum",
-    { from: deployer, log: true },
-    "changeCourtJurorFee",
-    0,
-    ethers.BigNumber.from(10).pow(17)
-  );
+  const coreDeployment = await hre.companionNetworks.home.deployments.get("KlerosCore");
+  const core = await KlerosCore__factory.connect(coreDeployment.address, homeChainProvider);
+  // TODO: set up the correct fees for the FORKING_COURT
+  const courtId = await core.GENERAL_COURT();
+  const fee = (await core.courts(courtId)).feeForJuror;
+  await execute("ForeignGatewayOnGnosis", { from: deployer, log: true }, "changeCourtJurorFee", courtId, fee);
+  // TODO: set up the correct fees for the lower courts
 };
 
 deployForeignGateway.tags = ["ForeignGatewayOnEthereum"];

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 { KlerosCore__factory } from "../typechain-types";
 import disputeTemplate from "../../kleros-sdk/config/v2-disputetemplate/simple/NewDisputeTemplate.simple.json";
 
 const HARDHAT_NETWORK = 31337;
@@ -51,17 +52,22 @@ const deployHomeGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment)
     log: true,
   }); // nonce+1
 
-  await execute(
-    "ForeignGatewayOnEthereum",
-    { from: deployer, log: true },
-    "changeCourtJurorFee",
-    0,
-    ethers.BigNumber.from(10).pow(17)
-  );
+  // TODO: disable the gateway until fully initialized with the correct fees OR allow disputeCreators to add funds again if necessary.
+  const signer = (await hre.ethers.getSigners())[0];
+  const core = await KlerosCore__factory.connect(klerosCore.address, signer);
+  // TODO: set up the correct fees for the FORKING_COURT
+  const courtId = await core.GENERAL_COURT();
+  const fee = (await core.courts(courtId)).feeForJuror;
+  await execute("ForeignGatewayOnEthereum", { from: deployer, log: true }, "changeCourtJurorFee", courtId, fee);
+  // TODO: set up the correct fees for the lower courts
 
+  // TODO: debug why this extraData fails but "0x00" works
+  // const extraData =
+  //   "0x00000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000003"; // General court, 3 jurors
+  const extraData = "0x00";
   await deploy("ArbitrableExample", {
     from: deployer,
-    args: [foreignGateway.address, disputeTemplate, ethers.constants.AddressZero],
+    args: [foreignGateway.address, disputeTemplate, extraData, ethers.constants.AddressZero],
     log: true,
   });
 };

contracts/deploy/04-foreign-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 ForeignChains {
   ETHEREUM_MAINNET = 1,
@@ -16,11 +17,13 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
   console.log("Deploying to chainId %s with deployer %s", chainId, deployer);
 
   const foreignGateway = await deployments.get("ForeignGatewayOnEthereum");
-  const metaEvidenceUri = `https://raw.githubusercontent.com/kleros/kleros-v2/master/contracts/deployments/${hre.network.name}/MetaEvidence_ArbitrableExample.json`;
+  // TODO: add the dispute template
+  const extraData =
+    "0x00000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000003"; // General court, 3 jurors
   const weth = await deployments.get("WETH");
   await deploy("ArbitrableExample", {
     from: deployer,
-    args: [foreignGateway.address, 0, metaEvidenceUri, weth.address],
+    args: [foreignGateway.address, disputeTemplate, extraData, weth.address],
     log: true,
   });
 };

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

@@ -54,6 +54,8 @@ const deployKlerosLiquid: DeployFunction = async (hre: HardhatRuntimeEnvironment
   const jurorsForCourtJump = 9999999;
   const sortitionSumTreeK = 3;
   const foreignGateway = await deployments.get("ForeignGatewayOnGnosis");
+  const extraData =
+    "0x00000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000003"; // General court, 3 jurors
   const weth = await deployments.get("WETH");
 
   console.log("Using: \nwPNK at %s, \nForeignGateway at %s", wPnkAddress, foreignGateway.address, weth.address);
@@ -99,7 +101,7 @@ const deployKlerosLiquid: DeployFunction = async (hre: HardhatRuntimeEnvironment
   // const xKlerosLiquidV2 = await deployments.get("xKlerosLiquidV2");
   await deploy("ArbitrableExample", {
     from: deployer,
-    args: [xKlerosLiquidV2.address, 0, disputeTemplate, weth.address],
+    args: [xKlerosLiquidV2.address, 0, disputeTemplate, extraData, weth.address],
     log: true,
     maxFeePerGas: ONE_GWEI,
     maxPriorityFeePerGas: ONE_GWEI,

contracts/hardhat.config.ts

@@ -37,6 +37,10 @@ const config: HardhatUserConfig = {
       saveDeployments: true,
       allowUnlimitedContractSize: true,
       tags: ["test", "local"],
+      companionNetworks: {
+        home: "hardhat",
+        foreign: "hardhat",
+      },
     },
     localhost: {
       url: `http://127.0.0.1:8545`,

contracts/src/arbitration/arbitrables/ArbitrableExample.sol

@@ -25,6 +25,7 @@ contract ArbitrableExample is IArbitrableV2 {
     address public immutable governor;
     IArbitratorV2 public arbitrator; // Arbitrator is set in constructor.
     uint256 public disputeTemplates; // The number of dispute templates created.
+    bytes public arbitratorExtraData; // Extra data to set up the arbitration.
     IERC20 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].
@@ -37,9 +38,15 @@ contract ArbitrableExample is IArbitrableV2 {
     /// @param _arbitrator The arbitrator to rule on created disputes.
     /// @param _templateData The dispute template data.
     /// @param _weth The WETH token.
-    constructor(IArbitratorV2 _arbitrator, string memory _templateData, IERC20 _weth) {
+    constructor(
+        IArbitratorV2 _arbitrator,
+        string memory _templateData,
+        bytes memory _arbitratorExtraData,
+        IERC20 _weth
+    ) {
         governor = msg.sender;
         arbitrator = _arbitrator;
+        arbitratorExtraData = _arbitratorExtraData;
         weth = _weth;
         emit DisputeTemplate(disputeTemplates++, "", _templateData);
     }
@@ -58,47 +65,39 @@ contract ArbitrableExample is IArbitrableV2 {
         arbitrator = _arbitrator;
     }
 
+    function changeArbitratorExtraData(bytes calldata _arbitratorExtraData) external {
+        require(msg.sender == governor, "Not authorized: governor only.");
+        arbitratorExtraData = _arbitratorExtraData;
+    }
+
     // ************************************* //
     // *         State Modifiers           * //
     // ************************************* //
 
     /// @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.
     /// @return disputeID Dispute id (on arbitrator side) of the dispute created.
-    function createDispute(
-        uint256 _templateId,
-        string calldata _action,
-        bytes calldata _arbitratorExtraData
-    ) external payable returns (uint256 disputeID) {
+    function createDispute(string calldata _action) external payable returns (uint256 disputeID) {
         emit Action(_action);
 
         uint256 numberOfRulingOptions = 2;
         uint256 localDisputeID = disputes.length;
         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;
 
         uint256 externalDisputeID = uint256(keccak256(abi.encodePacked(_action)));
-        emit DisputeRequest(arbitrator, disputeID, externalDisputeID, _templateId, "");
+        emit DisputeRequest(arbitrator, disputeID, externalDisputeID, disputeTemplates - 1, "");
     }
 
     /// @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 _feeInWeth Amount of fees in WETH for the arbitrator.
     /// @return disputeID Dispute id (on arbitrator side) of the dispute created.
-    function createDispute(
-        uint256 _templateId,
-        string calldata _action,
-        bytes calldata _arbitratorExtraData,
-        uint256 _feeInWeth
-    ) external payable returns (uint256 disputeID) {
+    function createDispute(string calldata _action, uint256 _feeInWeth) external payable returns (uint256 disputeID) {
         emit Action(_action);
 
         uint256 numberOfRulingOptions = 2;
@@ -108,11 +107,11 @@ contract ArbitrableExample is IArbitrableV2 {
         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;
 
         uint256 externalDisputeID = uint256(keccak256(abi.encodePacked(_action)));
-        emit DisputeRequest(arbitrator, disputeID, externalDisputeID, _templateId, "");
+        emit DisputeRequest(arbitrator, disputeID, externalDisputeID, disputeTemplates - 1, "");
     }
 
     /// @dev To be called by the arbitrator of the dispute, to declare the winning ruling.

contracts/src/gateway/HomeGateway.sol

@@ -135,6 +135,7 @@ contract HomeGateway is IHomeGateway {
             _params.foreignChainID,
             _params.foreignArbitrable,
             _params.foreignDisputeID,
+            disputeID,
             _params.externalDisputeID,
             _params.templateId,
             _params.templateUri
@@ -168,13 +169,15 @@ contract HomeGateway is IHomeGateway {
         disputeHashtoID[disputeHash] = disputeID;
         relayedData.relayer = msg.sender;
 
+        // Not strictly necessary for functionality, only to satisfy IArbitrableV2
         emit DisputeRequest(arbitrator, disputeID, _params.externalDisputeID, _params.templateId, _params.templateUri);
 
         emit CrossChainDisputeIncoming(
             arbitrator,
             _params.foreignChainID,
             _params.foreignArbitrable,
             _params.foreignDisputeID,
+            disputeID,
             _params.externalDisputeID,
             _params.templateId,
             _params.templateUri

contracts/src/gateway/interfaces/IHomeGateway.sol

@@ -18,14 +18,16 @@ interface IHomeGateway is IArbitrableV2, ISenderGateway {
     /// @param _arbitrableChainId The chain identifier where the Arbitrable contract is deployed.
     /// @param _arbitrable The address of the Arbitrable contract.
     /// @param _arbitrableDisputeID The identifier of the dispute in the Arbitrable contract.
+    /// @param _arbitratorDisputeID The identifier of the dispute in the Arbitrator contract.
     /// @param _externalDisputeID An identifier created outside Kleros by the protocol requesting arbitration.
     /// @param _templateId The identifier 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 CrossChainDisputeIncoming(
-        IArbitratorV2 indexed _arbitrator,
+        IArbitratorV2 _arbitrator,
         uint256 _arbitrableChainId,
         address indexed _arbitrable,
         uint256 indexed _arbitrableDisputeID,
+        uint256 indexed _arbitratorDisputeID,
         uint256 _externalDisputeID,
         uint256 _templateId,
         string _templateUri

contracts/test/arbitration/draw.ts

@@ -94,7 +94,7 @@ describe("Draw Benchmark", async () => {
     }
 
     // Create a dispute
-    const tx = await arbitrable.functions["createDispute(uint256,string,bytes)"](0, "future of france", "0x00", {
+    const tx = await arbitrable.functions["createDispute(string)"]("future of france", {
       value: arbitrationCost,
     });
     const trace = await network.provider.send("debug_traceTransaction", [tx.hash]);

contracts/test/integration/index.ts

@@ -96,7 +96,7 @@ describe("Integration tests", async () => {
       expect(result.locked).to.equal(0);
       logJurorBalance(result);
     });
-    const tx = await arbitrable.functions["createDispute(uint256,string,bytes)"](0, "future of france", "0x00", {
+    const tx = await arbitrable.functions["createDispute(string)"]("future of france", {
       value: arbitrationCost,
     });
     const trace = await network.provider.send("debug_traceTransaction", [tx.hash]);