fix: hardhat tests, deploy scripts, unnecessary virtual keyword

Author: jaybuidl

contracts/deploy/00-home-chain-arbitration-neo.ts

@@ -6,7 +6,7 @@ import { changeCurrencyRate } from "./utils/klerosCoreHelper";
 import { HomeChains, isSkipped, isDevnet, PNK, ETH } from "./utils";
 import { getContractOrDeploy, getContractOrDeployUpgradable } from "./utils/getContractOrDeploy";
 import { deployERC20AndFaucet, deployERC721 } from "./utils/deployTokens";
-import { ChainlinkRNG, DisputeKitClassic, KlerosCoreNeo, RNGWithFallback } from "../typechain-types";
+import { ChainlinkRNG, DisputeKitClassic, KlerosCore, RNGWithFallback } from "../typechain-types";
 
 const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { ethers, deployments, getNamedAccounts, getChainId } = hre;
@@ -29,26 +29,25 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   await deployUpgradable(deployments, "EvidenceModule", { from: deployer, args: [deployer], log: true });
 
   const classicDisputeKitID = 1; // Classic DK
-  const disputeKit = await deployUpgradable(deployments, "DisputeKitClassicNeo", {
+  const disputeKit = await deployUpgradable(deployments, "DisputeKitClassic", {
     from: deployer,
-    contract: "DisputeKitClassic",
     args: [deployer, ZeroAddress, weth.target, classicDisputeKitID],
     log: true,
   });
 
-  let klerosCoreAddress = await deployments.getOrNull("KlerosCoreNeo").then((deployment) => deployment?.address);
+  let klerosCoreAddress = await deployments.getOrNull("KlerosCore").then((deployment) => deployment?.address);
   if (!klerosCoreAddress) {
     const nonce = await ethers.provider.getTransactionCount(deployer);
     klerosCoreAddress = getContractAddress(deployer, nonce + 3); // deployed on the 4th tx (nonce+3): SortitionModule Impl tx, SortitionModule Proxy tx, KlerosCore Impl tx, KlerosCore Proxy tx
-    console.log("calculated future KlerosCoreNeo address for nonce %d: %s", nonce + 3, klerosCoreAddress);
+    console.log("calculated future KlerosCore address for nonce %d: %s", nonce + 3, klerosCoreAddress);
   }
   const devnet = isDevnet(hre.network);
   const minStakingTime = devnet ? 180 : 1800;
   const maxFreezingTime = devnet ? 600 : 1800;
   const rngWithFallback = await ethers.getContract<RNGWithFallback>("RNGWithFallback");
   const maxStakePerJuror = PNK(2_000);
   const maxTotalStaked = PNK(2_000_000);
-  const sortitionModule = await deployUpgradable(deployments, "SortitionModuleNeo", {
+  const sortitionModule = await deployUpgradable(deployments, "SortitionModule", {
     from: deployer,
     args: [
       deployer,
@@ -66,7 +65,7 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   const alpha = 10000;
   const feeForJuror = ETH(0.1);
   const jurorsForCourtJump = 256;
-  const klerosCore = await deployUpgradable(deployments, "KlerosCoreNeo", {
+  const klerosCore = await deployUpgradable(deployments, "KlerosCore", {
     from: deployer,
     args: [
       deployer,
@@ -79,14 +78,14 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
       [0, 0, 0, 10], // evidencePeriod, commitPeriod, votePeriod, appealPeriod
       ethers.toBeHex(5), // Extra data for sortition module will return the default value of K
       sortitionModule.address,
-      nft.target,
       weth.target,
+      nft.target,
     ],
     log: true,
   }); // nonce+2 (implementation), nonce+3 (proxy)
 
   // disputeKit.changeCore() only if necessary
-  const disputeKitContract = await hre.ethers.getContract<DisputeKitClassic>("DisputeKitClassicNeo");
+  const disputeKitContract = await hre.ethers.getContract<DisputeKitClassic>("DisputeKitClassic");
   const currentCore = await disputeKitContract.core();
   if (currentCore !== klerosCore.address) {
     console.log(`disputeKit.changeCore(${klerosCore.address})`);
@@ -100,7 +99,7 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
     await rngWithFallback.changeConsumer(sortitionModule.address);
   }
 
-  const core = await hre.ethers.getContract<KlerosCoreNeo>("KlerosCoreNeo");
+  const core = await hre.ethers.getContract<KlerosCore>("KlerosCore");
   try {
     await changeCurrencyRate(core, await weth.getAddress(), true, 1, 1);
   } catch (e) {
@@ -113,9 +112,8 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
     log: true,
   });
 
-  const resolver = await deploy("DisputeResolverNeo", {
+  const resolver = await deploy("DisputeResolver", {
     from: deployer,
-    contract: "DisputeResolver",
     args: [core.target, disputeTemplateRegistry.target],
     log: true,
   });
@@ -157,7 +155,7 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   });
 };
 
-deployArbitration.tags = ["ArbitrationNeo"];
+deployArbitration.tags = ["ArbitrationMainnet"];
 deployArbitration.dependencies = ["ChainlinkRNG"];
 deployArbitration.skip = async ({ network }) => {
   return isSkipped(network, !HomeChains[network.config.chainId ?? 0]);

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

@@ -53,7 +53,15 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   const rngWithFallback = await ethers.getContract<RNGWithFallback>("RNGWithFallback");
   const sortitionModule = await deployUpgradable(deployments, "SortitionModule", {
     from: deployer,
-    args: [deployer, klerosCoreAddress, minStakingTime, maxFreezingTime, rngWithFallback.target],
+    args: [
+      deployer,
+      klerosCoreAddress,
+      minStakingTime,
+      maxFreezingTime,
+      rngWithFallback.target,
+      ethers.MaxUint256, // maxStakePerJuror
+      ethers.MaxUint256, // maxTotalStaked
+    ],
     log: true,
   }); // nonce (implementation), nonce+1 (proxy)
 
@@ -75,6 +83,7 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
       ethers.toBeHex(5), // Extra data for sortition module will return the default value of K
       sortitionModule.address,
       weth.target,
+      ZeroAddress, // jurorNft
     ],
     log: true,
   }); // nonce+2 (implementation), nonce+3 (proxy)

contracts/src/arbitration/KlerosCore.sol

@@ -487,6 +487,12 @@ contract KlerosCore is IArbitratorV2, Initializable, UUPSProxiable {
         emit NewCurrencyRate(_feeToken, _rateInEth, _rateDecimals);
     }
 
+    /// @dev Changes the `jurorNft` storage variable.
+    /// @param _jurorNft The new value for the `jurorNft` storage variable.
+    function changeJurorNft(IERC721 _jurorNft) external onlyByOwner {
+        jurorNft = _jurorNft;
+    }
+
     /// @dev Adds or removes an arbitrable from whitelist.
     /// @param _arbitrable Arbitrable address.
     /// @param _allowed Whether add or remove permission.
@@ -507,7 +513,7 @@ contract KlerosCore is IArbitratorV2, Initializable, UUPSProxiable {
     /// @param _courtID The ID of the court.
     /// @param _newStake The new stake.
     /// Note that the existing delayed stake will be nullified as non-relevant.
-    function setStake(uint96 _courtID, uint256 _newStake) external virtual whenNotPaused {
+    function setStake(uint96 _courtID, uint256 _newStake) external whenNotPaused {
         if (address(jurorNft) != address(0) && jurorNft.balanceOf(msg.sender) == 0) revert NotEligibleForStaking();
         _setStake(msg.sender, _courtID, _newStake, false, OnError.Revert);
     }
@@ -559,7 +565,7 @@ contract KlerosCore is IArbitratorV2, Initializable, UUPSProxiable {
         bytes memory _extraData,
         IERC20 _feeToken,
         uint256 _feeAmount
-    ) internal virtual returns (uint256 disputeID) {
+    ) internal returns (uint256 disputeID) {
         if (arbitrableWhitelistEnabled && !arbitrableWhitelist[msg.sender]) revert ArbitrableNotWhitelisted();
         (uint96 courtID, , uint256 disputeKitID) = _extraDataToCourtIDMinJurorsDisputeKit(_extraData);
         if (!courts[courtID].supportedDisputeKits[disputeKitID]) revert DisputeKitNotSupportedByCourt();
@@ -1236,7 +1242,7 @@ contract KlerosCore is IArbitratorV2, Initializable, UUPSProxiable {
     }
 
     /// @dev It may revert depending on the _onError parameter.
-    function _stakingFailed(OnError _onError, StakingResult _result) internal pure virtual {
+    function _stakingFailed(OnError _onError, StakingResult _result) internal pure {
         if (_onError == OnError.Return) return;
         if (_result == StakingResult.StakingTransferFailed) revert StakingTransferFailed();
         if (_result == StakingResult.UnstakingTransferFailed) revert UnstakingTransferFailed();

contracts/src/arbitration/SortitionModule.sol

@@ -278,7 +278,7 @@ contract SortitionModule is ISortitionModule, Initializable, UUPSProxiable {
         uint96 _courtID,
         uint256 _newStake,
         bool _noDelay
-    ) internal virtual returns (uint256 pnkDeposit, uint256 pnkWithdrawal, StakingResult stakingResult) {
+    ) internal returns (uint256 pnkDeposit, uint256 pnkWithdrawal, StakingResult stakingResult) {
         Juror storage juror = jurors[_account];
         uint256 currentStake = stakeOf(_account, _courtID);
         bool stakeIncrease = _newStake > currentStake;
@@ -319,13 +319,12 @@ contract SortitionModule is ISortitionModule, Initializable, UUPSProxiable {
             totalStaked += stakeChange;
         } else {
             pnkWithdrawal = stakeChange;
-            totalStaked -= stakeChange;
-
-            // Ensure locked tokens remain in the contract. They can only be released during Execution.
             uint256 possibleWithdrawal = juror.stakedPnk > juror.lockedPnk ? juror.stakedPnk - juror.lockedPnk : 0;
             if (pnkWithdrawal > possibleWithdrawal) {
+                // Ensure locked tokens remain in the contract. They can only be released during Execution.
                 pnkWithdrawal = possibleWithdrawal;
             }
+            totalStaked -= pnkWithdrawal;
         }
         return (pnkDeposit, pnkWithdrawal, StakingResult.Successful);
     }
@@ -417,7 +416,7 @@ contract SortitionModule is ISortitionModule, Initializable, UUPSProxiable {
         uint256 _pnkDeposit,
         uint256 _pnkWithdrawal,
         uint256 _newStake
-    ) internal virtual {
+    ) internal {
         Juror storage juror = jurors[_account];
         if (_pnkDeposit > 0) {
             uint256 currentStake = stakeOf(_account, _courtID);

contracts/test/arbitration/staking-neo.ts

@@ -3,8 +3,8 @@ import {
   PNK,
   RandomizerRNG,
   RandomizerMock,
-  SortitionModuleNeo,
-  KlerosCoreNeo,
+  SortitionModule,
+  KlerosCore,
   TestERC721,
   DisputeResolver,
   ChainlinkRNG,
@@ -41,8 +41,8 @@ describe("Staking", async () => {
   let juror: HardhatEthersSigner;
   let guardian: HardhatEthersSigner;
   let pnk: PNK;
-  let core: KlerosCoreNeo;
-  let sortition: SortitionModuleNeo;
+  let core: KlerosCore;
+  let sortition: SortitionModule;
   let rng: ChainlinkRNG;
   let vrfCoordinator: ChainlinkVRFCoordinatorV2Mock;
   let nft: TestERC721;
@@ -52,16 +52,16 @@ describe("Staking", async () => {
   const deployUnhappy = async () => {
     ({ deployer } = await getNamedAccounts());
 
-    await deployments.fixture(["ArbitrationNeo"], {
+    await deployments.fixture(["ArbitrationMainnet"], {
       fallbackToGlobal: true,
       keepExistingDeployments: false,
     });
     pnk = await ethers.getContract<PNK>("PNK");
-    core = await ethers.getContract<KlerosCoreNeo>("KlerosCoreNeo");
-    sortition = await ethers.getContract<SortitionModuleNeo>("SortitionModuleNeo");
+    core = await ethers.getContract<KlerosCore>("KlerosCore");
+    sortition = await ethers.getContract<SortitionModule>("SortitionModule");
     rng = await ethers.getContract<ChainlinkRNG>("ChainlinkRNG");
     vrfCoordinator = await ethers.getContract<ChainlinkVRFCoordinatorV2Mock>("ChainlinkVRFCoordinator");
-    resolver = await ethers.getContract<DisputeResolver>("DisputeResolverNeo");
+    resolver = await ethers.getContract<DisputeResolver>("DisputeResolver");
     nft = await ethers.getContract<TestERC721>("KlerosV2NeoEarlyUser");
 
     // Juror signer setup and funding