refactor: extracted some constants, tweaked contract size optimizations

Author: jaybuidl

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

@@ -2,7 +2,7 @@ import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
 import getContractAddress from "./utils/getContractAddress";
 import { KlerosCore__factory } from "../typechain-types";
-import { ForeignChains, isSkipped } from "./utils";
+import { Courts, ForeignChains, isSkipped } from "./utils";
 import { deployUpgradable } from "./utils/deployUpgradable";
 
 const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
@@ -46,9 +46,8 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
   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("ForeignGatewayOnEthereum", { from: deployer, log: true }, "changeCourtJurorFee", courtId, fee);
+  const fee = (await core.courts(Courts.GENERAL)).feeForJuror;
+  await execute("ForeignGatewayOnEthereum", { from: deployer, log: true }, "changeCourtJurorFee", Courts.GENERAL, fee);
   // TODO: set up the correct fees for the lower courts
 };
 

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

@@ -3,7 +3,7 @@ import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
 import getContractAddress from "./utils/getContractAddress";
 import { KlerosCore__factory } from "../typechain-types";
-import { ForeignChains, isSkipped } from "./utils";
+import { Courts, ForeignChains, isSkipped } from "./utils";
 import { deployUpgradable } from "./utils/deployUpgradable";
 
 const ONE_GWEI = parseUnits("1", "gwei");
@@ -50,9 +50,8 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
   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);
+  const fee = (await core.courts(Courts.GENERAL)).feeForJuror;
+  await execute("ForeignGatewayOnGnosis", { from: deployer, log: true }, "changeCourtJurorFee", Courts.GENERAL, fee);
   // TODO: set up the correct fees for the lower courts
 };
 

contracts/deploy/03-vea-mock.ts

@@ -3,7 +3,7 @@ import { DeployFunction } from "hardhat-deploy/types";
 import getContractAddress from "./utils/getContractAddress";
 import { KlerosCore__factory } from "../typechain-types";
 import disputeTemplate from "../test/fixtures/DisputeTemplate.simple.json";
-import { HardhatChain, isSkipped } from "./utils";
+import { Courts, HardhatChain, isSkipped } from "./utils";
 import { deployUpgradable } from "./utils/deployUpgradable";
 
 // TODO: use deterministic deployments
@@ -58,9 +58,8 @@ const deployHomeGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   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);
+  const fee = (await core.courts(Courts.GENERAL)).feeForJuror;
+  await execute("ForeignGatewayOnEthereum", { from: deployer, log: true }, "changeCourtJurorFee", Courts.GENERAL, fee);
   // TODO: set up the correct fees for the lower courts
 
   const disputeTemplateRegistry = await deployUpgradable(hre, "DisputeTemplateRegistry", {

contracts/deploy/utils/index.ts

@@ -20,6 +20,11 @@ export enum ForeignChains {
   HARDHAT = HardhatChain.HARDHAT,
 }
 
+export enum Courts {
+  FORKING = 0,
+  GENERAL = 1,
+}
+
 export const isSkipped = async (network: Network, skip: boolean) => {
   if (skip) {
     console.error(`Error: incompatible network ${network.name} for this deployment script`);

contracts/src/arbitration/KlerosCore.sol

@@ -16,6 +16,7 @@ import "./interfaces/IDisputeKit.sol";
 import "../rng/RNG.sol";
 import "../proxy/UUPSProxiable.sol";
 import "../proxy/Initializable.sol";
+import "../libraries/Constants.sol";
 
 /// @title SortitionModule
 /// @dev A factory of trees that keeps track of staked values for sortition.
@@ -254,7 +255,7 @@ contract SortitionModule is ISortitionModule, UUPSProxiable, Initializable {
         while (!finished) {
             // Tokens are also implicitly staked in parent courts through sortition module to increase the chance of being drawn.
             _set(bytes32(uint256(currenCourtID)), _value, stakePathID);
-            if (currenCourtID == core.GENERAL_COURT()) {
+            if (currenCourtID == Constants.GENERAL_COURT) {
                 finished = true;
             } else {
                 (currenCourtID, , , , , , ) = core.courts(currenCourtID);

contracts/src/arbitration/SortitionModule.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity 0.8.18;
+
+/// @title Constants
+library Constants {
+    // Courts
+    uint96 public constant FORKING_COURT = 0; // Index of the forking court.
+    uint96 public constant GENERAL_COURT = 1; // Index of the default (general) court.
+
+    // Dispute Kits
+    uint256 public constant NULL_DISPUTE_KIT = 0; // Null pattern to indicate a top-level DK which has no parent.
+    uint256 public constant DISPUTE_KIT_CLASSIC = 1; // Index of the default DK. 0 index is skipped.
+
+    // Defaults
+    uint256 public constant DEFAULT_NB_OF_JURORS = 3; // The default number of jurors in a dispute.
+}

contracts/src/libraries/Constants.sol

@@ -11,6 +11,7 @@ import {
 } from "../../typechain-types";
 import { expect } from "chai";
 import { DrawEvent } from "../../typechain-types/src/kleros-v1/kleros-liquid-xdai/XKlerosLiquidV2";
+import { Courts } from "../../deploy/utils";
 
 /* eslint-disable no-unused-vars */
 /* eslint-disable no-unused-expressions */ // https://github.com/standard/standard/issues/690#issuecomment-278533482
@@ -67,10 +68,7 @@ describe("Draw Benchmark", async () => {
     arbitrable = (await ethers.getContract("ArbitrableExample")) as ArbitrableExample;
     sortitionModule = (await ethers.getContract("SortitionModule")) as SortitionModule;
 
-    parentCourtMinStake = await core
-      .GENERAL_COURT()
-      .then((courtId) => core.courts(courtId))
-      .then((court) => court.minStake);
+    parentCourtMinStake = await core.courts(Courts.GENERAL).then((court) => court.minStake);
 
     childCourtMinStake = BigNumber.from(10).pow(20).mul(3); // 300 PNK