fix(contracts): remove court and subcourt naming inconsistencies

alcercu · jaybuidl · commit 1ee8762cf790 · 2022-12-16T20:25:02.000Z
diff --git a/contracts/scripts/populateCourts.ts b/contracts/scripts/populateCourts.ts
@@ -41,70 +41,70 @@ async function main() {
   const core = (await ethers.getContractAt("KlerosCore", klerosCoreDeployment.address)) as KlerosCore;
 
   for (const court of courtsV2) {
-    const subcourtPresent = await core.courts(court.id).catch(() => {});
-    if (subcourtPresent) {
-      console.log("Subcourt %d found: %O", court.id, subcourtPresent);
+    const courtPresent = await core.courts(court.id).catch(() => {});
+    if (courtPresent) {
+      console.log("Court %d found: %O", court.id, courtPresent);
 
-      // Subcourt.parent and sortitionSumTreeK cannot be changed.
+      // Court.parent and sortitionSumTreeK cannot be changed.
 
-      if (subcourtPresent.hiddenVotes !== court.hiddenVotes) {
+      if (courtPresent.hiddenVotes !== court.hiddenVotes) {
         console.log(
-          "Subcourt %d: changing hiddenVotes from %d to %d",
+          "Court %d: changing hiddenVotes from %d to %d",
           court.id,
-          subcourtPresent.hiddenVotes,
+          courtPresent.hiddenVotes,
           court.hiddenVotes
         );
-        await core.changeSubcourtHiddenVotes(court.id, court.hiddenVotes);
+        await core.changeCourtHiddenVotes(court.id, court.hiddenVotes);
       }
 
-      if (!subcourtPresent.minStake.eq(court.minStake)) {
-        console.log("Subcourt %d: changing minStake from %d to %d", court.id, subcourtPresent.minStake, court.minStake);
-        await core.changeSubcourtMinStake(court.id, court.minStake);
+      if (!courtPresent.minStake.eq(court.minStake)) {
+        console.log("Court %d: changing minStake from %d to %d", court.id, courtPresent.minStake, court.minStake);
+        await core.changeCourtMinStake(court.id, court.minStake);
       }
 
-      if (!subcourtPresent.alpha.eq(court.alpha)) {
-        console.log("Subcourt %d: changing alpha from %d to %d", court.id, subcourtPresent.alpha, court.alpha);
-        await core.changeSubcourtAlpha(court.id, court.alpha);
+      if (!courtPresent.alpha.eq(court.alpha)) {
+        console.log("Court %d: changing alpha from %d to %d", court.id, courtPresent.alpha, court.alpha);
+        await core.changeCourtAlpha(court.id, court.alpha);
       }
 
-      if (!subcourtPresent.feeForJuror.eq(court.feeForJuror)) {
+      if (!courtPresent.feeForJuror.eq(court.feeForJuror)) {
         console.log(
-          "Subcourt %d: changing feeForJuror from %d to %d",
+          "Court %d: changing feeForJuror from %d to %d",
           court.id,
-          subcourtPresent.feeForJuror,
+          courtPresent.feeForJuror,
           court.feeForJuror
         );
-        await core.changeSubcourtJurorFee(court.id, court.feeForJuror);
+        await core.changeCourtJurorFee(court.id, court.feeForJuror);
       }
 
-      if (!subcourtPresent.jurorsForCourtJump.eq(court.jurorsForCourtJump)) {
+      if (!courtPresent.jurorsForCourtJump.eq(court.jurorsForCourtJump)) {
         console.log(
-          "Subcourt %d: changing jurorsForCourtJump from %d to %d",
+          "Court %d: changing jurorsForCourtJump from %d to %d",
           court.id,
-          subcourtPresent.jurorsForCourtJump,
+          courtPresent.jurorsForCourtJump,
           court.jurorsForCourtJump
         );
-        await core.changeSubcourtJurorsForJump(court.id, court.jurorsForCourtJump);
+        await core.changeCourtJurorsForJump(court.id, court.jurorsForCourtJump);
       }
 
       const timesPerPeriodPresent = (await core.getTimesPerPeriod(court.id)).map((bn) => bn.toNumber());
       if (!timesPerPeriodPresent.every((val, index) => val === court.timesPerPeriod[index])) {
         console.log(
-          "Subcourt %d: changing timesPerPeriod from %O to %O",
+          "Court %d: changing timesPerPeriod from %O to %O",
           court.id,
           timesPerPeriodPresent,
           court.timesPerPeriod
         );
-        await core.changeSubcourtTimesPerPeriod(court.id, [
+        await core.changeCourtTimesPerPeriod(court.id, [
           court.timesPerPeriod[0],
           court.timesPerPeriod[1],
           court.timesPerPeriod[2],
           court.timesPerPeriod[3],
         ]);
       }
     } else {
-      console.log("Subcourt %d not found, creating it with", court.id, court);
-      await core.createSubcourt(
+      console.log("Court %d not found, creating it with", court.id, court);
+      await core.createCourt(
         court.parent,
         court.hiddenVotes,
         court.minStake,
diff --git a/contracts/src/arbitration/KlerosCore.sol b/contracts/src/arbitration/KlerosCore.sol
diff --git a/contracts/src/arbitration/PolicyRegistry.sol b/contracts/src/arbitration/PolicyRegistry.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8;
 /**
  *  @title PolicyRegistry
  *  @author Enrique Piqueras - <epiquerass@gmail.com>
- *  @dev A contract to maintain a policy for each subcourt.
+ *  @dev A contract to maintain a policy for each court.
  */
 contract PolicyRegistry {
     // ************************************* //
@@ -13,10 +13,10 @@ contract PolicyRegistry {
 
     /**
      *  @dev Emitted when a policy is updated.
-     *  @param _subcourtID The ID of the policy's subcourt.
+     *  @param _courtID The ID of the policy's court.
      *  @param _policy The URI of the policy JSON.
      */
-    event PolicyUpdate(uint256 indexed _subcourtID, string _policy);
+    event PolicyUpdate(uint256 indexed _courtID, string _policy);
 
     // ************************************* //
     // *             Storage               * //
@@ -65,12 +65,12 @@ contract PolicyRegistry {
     // ************************************* //
 
     /**
-     *  @dev Sets the policy for the specified subcourt.
-     *  @param _subcourtID The ID of the specified subcourt.
+     *  @dev Sets the policy for the specified court.
+     *  @param _courtID The ID of the specified court.
      *  @param _policy The URI of the policy JSON.
      */
-    function setPolicy(uint256 _subcourtID, string calldata _policy) external onlyByGovernor {
-        policies[_subcourtID] = _policy;
-        emit PolicyUpdate(_subcourtID, policies[_subcourtID]);
+    function setPolicy(uint256 _courtID, string calldata _policy) external onlyByGovernor {
+        policies[_courtID] = _policy;
+        emit PolicyUpdate(_courtID, policies[_courtID]);
     }
 }
diff --git a/contracts/src/arbitration/dispute-kits/DisputeKitClassic.sol b/contracts/src/arbitration/dispute-kits/DisputeKitClassic.sol
@@ -226,8 +226,8 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {
         Dispute storage dispute = disputes[coreDisputeIDToLocal[_coreDisputeID]];
         Round storage round = dispute.rounds[dispute.rounds.length - 1];
 
-        (uint96 subcourtID, , , , ) = core.disputes(_coreDisputeID);
-        bytes32 key = bytes32(uint256(subcourtID)); // Get the ID of the tree.
+        (uint96 courtID, , , , ) = core.disputes(_coreDisputeID);
+        bytes32 key = bytes32(uint256(courtID)); // Get the ID of the tree.
 
         (uint256 K, uint256 nodesLength, ) = core.getSortitionSumTree(key, 0);
         uint256 treeIndex = 0;
@@ -319,16 +319,16 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {
         require(_choice <= dispute.numberOfChoices, "Choice out of bounds");
 
         Round storage round = dispute.rounds[dispute.rounds.length - 1];
-        (uint96 subcourtID, , , , ) = core.disputes(_coreDisputeID);
-        (, bool hiddenVotes, , , , ) = core.courts(subcourtID);
+        (uint96 courtID, , , , ) = core.disputes(_coreDisputeID);
+        (, bool hiddenVotes, , , , ) = core.courts(courtID);
 
         //  Save the votes.
         for (uint256 i = 0; i < _voteIDs.length; i++) {
             require(round.votes[_voteIDs[i]].account == msg.sender, "The caller has to own the vote.");
             require(
                 !hiddenVotes ||
                     round.votes[_voteIDs[i]].commit == keccak256(abi.encodePacked(_choice, _justification, _salt)),
-                "The commit must match the choice in subcourts with hidden votes."
+                "The commit must match the choice in courts with hidden votes."
             );
             require(!round.votes[_voteIDs[i]].voted, "Vote already cast.");
             round.votes[_voteIDs[i]].choice = _choice;
@@ -645,13 +645,13 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {
      *  @return Whether the address can be drawn or not.
      */
     function postDrawCheck(uint256 _coreDisputeID, address _juror) internal view override returns (bool) {
-        (uint96 subcourtID, , , , ) = core.disputes(_coreDisputeID);
+        (uint96 courtID, , , , ) = core.disputes(_coreDisputeID);
         (uint256 lockedAmountPerJuror, , , , , ) = core.getRoundInfo(
             _coreDisputeID,
             core.getNumberOfRounds(_coreDisputeID) - 1
         );
-        (uint256 stakedTokens, uint256 lockedTokens) = core.getJurorBalance(_juror, subcourtID);
-        (, , uint256 minStake, , , ) = core.courts(subcourtID);
+        (uint256 stakedTokens, uint256 lockedTokens) = core.getJurorBalance(_juror, courtID);
+        (, , uint256 minStake, , , ) = core.courts(courtID);
         return stakedTokens >= lockedTokens + lockedAmountPerJuror && stakedTokens >= minStake;
     }
 
diff --git a/contracts/src/arbitration/dispute-kits/DisputeKitSybilResistant.sol b/contracts/src/arbitration/dispute-kits/DisputeKitSybilResistant.sol
@@ -251,8 +251,8 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {
         Dispute storage dispute = disputes[coreDisputeIDToLocal[_coreDisputeID]];
         Round storage round = dispute.rounds[dispute.rounds.length - 1];
 
-        (uint96 subcourtID, , , , ) = core.disputes(_coreDisputeID);
-        bytes32 key = bytes32(uint256(subcourtID)); // Get the ID of the tree.
+        (uint96 courtID, , , , ) = core.disputes(_coreDisputeID);
+        bytes32 key = bytes32(uint256(courtID)); // Get the ID of the tree.
 
         (uint256 K, uint256 nodesLength, ) = core.getSortitionSumTree(key, 0);
         uint256 treeIndex = 0;
@@ -345,16 +345,16 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {
         require(_choice <= dispute.numberOfChoices, "Choice out of bounds");
 
         Round storage round = dispute.rounds[dispute.rounds.length - 1];
-        (uint96 subcourtID, , , , ) = core.disputes(_coreDisputeID);
-        (, bool hiddenVotes, , , , ) = core.courts(subcourtID);
+        (uint96 courtID, , , , ) = core.disputes(_coreDisputeID);
+        (, bool hiddenVotes, , , , ) = core.courts(courtID);
 
         //  Save the votes.
         for (uint256 i = 0; i < _voteIDs.length; i++) {
             require(round.votes[_voteIDs[i]].account == msg.sender, "The caller has to own the vote.");
             require(
                 !hiddenVotes ||
                     round.votes[_voteIDs[i]].commit == keccak256(abi.encodePacked(_choice, _justification, _salt)),
-                "The commit must match the choice in subcourts with hidden votes."
+                "The commit must match the choice in courts with hidden votes."
             );
             require(!round.votes[_voteIDs[i]].voted, "Vote already cast.");
             round.votes[_voteIDs[i]].choice = _choice;
@@ -671,13 +671,13 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {
      *  @return Whether the address can be drawn or not.
      */
     function postDrawCheck(uint256 _coreDisputeID, address _juror) internal view override returns (bool) {
-        (uint96 subcourtID, , , , ) = core.disputes(_coreDisputeID);
+        (uint96 courtID, , , , ) = core.disputes(_coreDisputeID);
         (uint256 lockedAmountPerJuror, , , , , ) = core.getRoundInfo(
             _coreDisputeID,
             core.getNumberOfRounds(_coreDisputeID) - 1
         );
-        (uint256 stakedTokens, uint256 lockedTokens) = core.getJurorBalance(_juror, subcourtID);
-        (, , uint256 minStake, , , ) = core.courts(subcourtID);
+        (uint256 stakedTokens, uint256 lockedTokens) = core.getJurorBalance(_juror, courtID);
+        (, , uint256 minStake, , , ) = core.courts(courtID);
         if (stakedTokens < lockedTokens + lockedAmountPerJuror || stakedTokens < minStake) {
             return false;
         } else {
diff --git a/contracts/src/gateway/ForeignGateway.sol b/contracts/src/gateway/ForeignGateway.sol
@@ -43,7 +43,7 @@ contract ForeignGateway is IForeignGateway {
         address arbitrable
     );
 
-    event ArbitrationCostModified(uint96 indexed _subcourtID, uint256 _feeForJuror);
+    event ArbitrationCostModified(uint96 indexed _courtID, uint256 _feeForJuror);
 
     // ************************************* //
     // *             Storage               * //
@@ -53,7 +53,7 @@ contract ForeignGateway is IForeignGateway {
     uint256 public immutable override senderChainID;
     address public immutable override senderGateway;
     uint256 internal localDisputeID = 1; // The disputeID must start from 1 as the KlerosV1 proxy governor depends on this implementation. We now also depend on localDisputeID not ever being zero.
-    mapping(uint96 => uint256) public feeForJuror; // feeForJuror[subcourtID], it mirrors the value on KlerosCore.
+    mapping(uint96 => uint256) public feeForJuror; // feeForJuror[courtID], it mirrors the value on KlerosCore.
     address public governor;
     IFastBridgeReceiver public fastBridgeReceiver;
     IFastBridgeReceiver public depreciatedFastbridge;
@@ -107,13 +107,13 @@ contract ForeignGateway is IForeignGateway {
     }
 
     /**
-     * @dev Changes the `feeForJuror` property value of a specified subcourt.
-     * @param _subcourtID The ID of the subcourt.
+     * @dev Changes the `feeForJuror` property value of a specified court.
+     * @param _courtID The ID of the court.
      * @param _feeForJuror The new value for the `feeForJuror` property value.
      */
-    function changeSubcourtJurorFee(uint96 _subcourtID, uint256 _feeForJuror) external onlyByGovernor {
-        feeForJuror[_subcourtID] = _feeForJuror;
-        emit ArbitrationCostModified(_subcourtID, _feeForJuror);
+    function changeSubcourtJurorFee(uint96 _courtID, uint256 _feeForJuror) external onlyByGovernor {
+        feeForJuror[_courtID] = _feeForJuror;
+        emit ArbitrationCostModified(_courtID, _feeForJuror);
     }
 
     // ************************************* //
@@ -156,8 +156,8 @@ contract ForeignGateway is IForeignGateway {
     }
 
     function arbitrationCost(bytes calldata _extraData) public view override returns (uint256 cost) {
-        (uint96 subcourtID, uint256 minJurors) = extraDataToSubcourtIDMinJurors(_extraData);
-        cost = feeForJuror[subcourtID] * minJurors;
+        (uint96 courtID, uint256 minJurors) = extraDataToSubcourtIDMinJurors(_extraData);
+        cost = feeForJuror[courtID] * minJurors;
     }
 
     /**
@@ -206,18 +206,18 @@ contract ForeignGateway is IForeignGateway {
 
     function extraDataToSubcourtIDMinJurors(
         bytes memory _extraData
-    ) internal view returns (uint96 subcourtID, uint256 minJurors) {
+    ) internal view returns (uint96 courtID, uint256 minJurors) {
         // Note that here we ignore DisputeKitID
         if (_extraData.length >= 64) {
             assembly {
                 // solium-disable-line security/no-inline-assembly
-                subcourtID := mload(add(_extraData, 0x20))
+                courtID := mload(add(_extraData, 0x20))
                 minJurors := mload(add(_extraData, 0x40))
             }
-            if (feeForJuror[subcourtID] == 0) subcourtID = 0;
+            if (feeForJuror[courtID] == 0) courtID = 0;
             if (minJurors == 0) minJurors = MIN_JURORS;
         } else {
-            subcourtID = 0;
+            courtID = 0;
             minJurors = MIN_JURORS;
         }
     }
diff --git a/contracts/src/gateway/single-message/ForeignGatewayOnEthereum.sol b/contracts/src/gateway/single-message/ForeignGatewayOnEthereum.sol
@@ -29,7 +29,7 @@ contract ForeignGatewayOnEthereum is IForeignGatewaySingleMessage {
     // at any point.
     uint256 internal localDisputeID = 1;
 
-    // feeForJuror by subcourtID
+    // feeForJuror by courtID
     uint256[] internal feeForJuror;
     uint256 public chainID;
     uint256 public homeChainID;
@@ -84,12 +84,12 @@ contract ForeignGatewayOnEthereum is IForeignGatewaySingleMessage {
         }
     }
 
-    /** @dev Changes the `feeForJuror` property value of a specified subcourt.
-     *  @param _subcourtID The ID of the subcourt.
+    /** @dev Changes the `feeForJuror` property value of a specified court.
+     *  @param _courtID The ID of the court.
      *  @param _feeForJuror The new value for the `feeForJuror` property value.
      */
-    function changeSubcourtJurorFee(uint96 _subcourtID, uint256 _feeForJuror) external onlyByGovernor {
-        feeForJuror[_subcourtID] = _feeForJuror;
+    function changeCourtJurorFee(uint96 _courtID, uint256 _feeForJuror) external onlyByGovernor {
+        feeForJuror[_courtID] = _feeForJuror;
     }
 
     function createDispute(uint256 _choices, bytes calldata _extraData) external payable returns (uint256 disputeID) {
@@ -121,19 +121,15 @@ contract ForeignGatewayOnEthereum is IForeignGatewaySingleMessage {
     }
 
     function arbitrationCost(bytes calldata _extraData) public view returns (uint256 cost) {
-        (uint96 subcourtID, uint256 minJurors) = extraDataToSubcourtIDMinJurors(_extraData);
+        (uint96 courtID, uint256 minJurors) = extraDataToCourtIDMinJurors(_extraData);
 
-        cost = feeForJuror[subcourtID] * minJurors;
+        cost = feeForJuror[courtID] * minJurors;
     }
 
     /**
      * Relay the rule call from the home gateway to the arbitrable.
      */
-    function relayRule(
-        bytes32 _disputeHash,
-        uint256 _ruling,
-        address _relayer
-    ) external onlyFromFastBridge {
+    function relayRule(bytes32 _disputeHash, uint256 _ruling, address _relayer) external onlyFromFastBridge {
         DisputeData storage dispute = disputeHashtoDisputeData[_disputeHash];
 
         require(dispute.id != 0, "Dispute does not exist");
@@ -160,22 +156,20 @@ contract ForeignGatewayOnEthereum is IForeignGatewaySingleMessage {
         return disputeHashtoDisputeData[_disputeHash].id;
     }
 
-    function extraDataToSubcourtIDMinJurors(bytes memory _extraData)
-        internal
-        view
-        returns (uint96 subcourtID, uint256 minJurors)
-    {
+    function extraDataToCourtIDMinJurors(
+        bytes memory _extraData
+    ) internal view returns (uint96 courtID, uint256 minJurors) {
         // Note that here we ignore DisputeKitID
         if (_extraData.length >= 64) {
             assembly {
                 // solium-disable-line security/no-inline-assembly
-                subcourtID := mload(add(_extraData, 0x20))
+                courtID := mload(add(_extraData, 0x20))
                 minJurors := mload(add(_extraData, 0x40))
             }
-            if (subcourtID >= feeForJuror.length) subcourtID = 0;
+            if (courtID >= feeForJuror.length) courtID = 0;
             if (minJurors == 0) minJurors = MIN_JURORS;
         } else {
-            subcourtID = 0;
+            courtID = 0;
             minJurors = MIN_JURORS;
         }
     }
diff --git a/contracts/test/arbitration/index.ts b/contracts/test/arbitration/index.ts
diff --git a/contracts/test/arbitration/unstake.ts b/contracts/test/arbitration/unstake.ts
