feat: rng fallback

Author: jaybuidl

contracts/deploy/00-chainlink-rng.ts

@@ -70,6 +70,8 @@ const deployRng: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
     ],
     log: true,
   });
+
+  console.log("Register this Chainlink consumer here: http://vrf.chain.link/");
 };
 
 deployRng.tags = ["ChainlinkRNG"];

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

@@ -10,9 +10,8 @@ import { ChainlinkRNG, DisputeKitClassic, KlerosCoreNeo, RandomizerRNG } from ".
 
 const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { ethers, deployments, getNamedAccounts, getChainId } = hre;
-  const { deploy, execute } = deployments;
+  const { deploy } = deployments;
   const { ZeroAddress } = hre.ethers;
-  const RNG_LOOKAHEAD = 20;
 
   // fallback to hardhat node signers on local network
   const deployer = (await getNamedAccounts()).deployer ?? (await hre.ethers.getSigners())[0].address;
@@ -50,16 +49,7 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   const maxTotalStaked = PNK(2_000_000);
   const sortitionModule = await deployUpgradable(deployments, "SortitionModuleNeo", {
     from: deployer,
-    args: [
-      deployer,
-      klerosCoreAddress,
-      minStakingTime,
-      maxFreezingTime,
-      rng.target,
-      RNG_LOOKAHEAD,
-      maxStakePerJuror,
-      maxTotalStaked,
-    ],
+    args: [deployer, klerosCoreAddress, minStakingTime, maxFreezingTime, rng.target, maxStakePerJuror, maxTotalStaked],
     log: true,
   }); // nonce (implementation), nonce+1 (proxy)
 
@@ -93,11 +83,11 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
     await disputeKitContract.changeCore(klerosCore.address);
   }
 
-  // rng.changeSortitionModule() only if necessary
-  const rngSortitionModule = await rng.sortitionModule();
-  if (rngSortitionModule !== sortitionModule.address) {
-    console.log(`rng.changeSortitionModule(${sortitionModule.address})`);
-    await rng.changeSortitionModule(sortitionModule.address);
+  // rng.changeConsumer() only if necessary
+  const rngConsumer = await rng.consumer();
+  if (rngConsumer !== sortitionModule.address) {
+    console.log(`rng.changeConsumer(${sortitionModule.address})`);
+    await rng.changeConsumer(sortitionModule.address);
   }
 
   const core = (await hre.ethers.getContract("KlerosCoreNeo")) as KlerosCoreNeo;

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

@@ -12,7 +12,6 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   const { ethers, deployments, getNamedAccounts, getChainId } = hre;
   const { deploy } = deployments;
   const { ZeroAddress } = hre.ethers;
-  const RNG_LOOKAHEAD = 20;
 
   // fallback to hardhat node signers on local network
   const deployer = (await getNamedAccounts()).deployer ?? (await hre.ethers.getSigners())[0].address;
@@ -53,7 +52,7 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   const rng = (await ethers.getContract("ChainlinkRNG")) as ChainlinkRNG;
   const sortitionModule = await deployUpgradable(deployments, "SortitionModule", {
     from: deployer,
-    args: [deployer, klerosCoreAddress, minStakingTime, maxFreezingTime, rng.target, RNG_LOOKAHEAD],
+    args: [deployer, klerosCoreAddress, minStakingTime, maxFreezingTime, rng.target],
     log: true,
   }); // nonce (implementation), nonce+1 (proxy)
 
@@ -86,11 +85,11 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
     await disputeKitContract.changeCore(klerosCore.address);
   }
 
-  // rng.changeSortitionModule() only if necessary
-  const rngSortitionModule = await rng.sortitionModule();
-  if (rngSortitionModule !== sortitionModule.address) {
-    console.log(`rng.changeSortitionModule(${sortitionModule.address})`);
-    await rng.changeSortitionModule(sortitionModule.address);
+  // rng.changeConsumer() only if necessary
+  const rngConsumer = await rng.consumer();
+  if (rngConsumer !== sortitionModule.address) {
+    console.log(`rng.changeConsumer(${sortitionModule.address})`);
+    await rng.changeConsumer(sortitionModule.address);
   }
 
   const core = (await hre.ethers.getContract("KlerosCore")) as KlerosCore;

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

@@ -1,7 +1,6 @@
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
 import { HomeChains, isSkipped } from "./utils";
-import { deployUpgradable } from "./utils/deployUpgradable";
 
 const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { deployments, getNamedAccounts, getChainId } = hre;

contracts/deploy/00-rng.ts

@@ -2,13 +2,12 @@ import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
 import { SortitionModule } from "../typechain-types";
 import { HomeChains, isMainnet, isSkipped } from "./utils";
-import { deployUpgradable } from "./utils/deployUpgradable";
 import { getContractOrDeploy } from "./utils/getContractOrDeploy";
 
 const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { deployments, getNamedAccounts, getChainId, ethers } = hre;
   const { deploy } = deployments;
-  const RNG_LOOKAHEAD = 20;
+  const RNG_LOOKAHEAD_TIME = 30 * 60; // 30 minutes in seconds
 
   // fallback to hardhat node signers on local network
   const deployer = (await getNamedAccounts()).deployer ?? (await hre.ethers.getSigners())[0].address;
@@ -32,11 +31,15 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
 
   const rng2 = await deploy("BlockHashRNG", {
     from: deployer,
-    args: [],
+    args: [
+      deployer, // governor
+      sortitionModule.target, // consumer
+      RNG_LOOKAHEAD_TIME,
+    ],
     log: true,
   });
 
-  await sortitionModule.changeRandomNumberGenerator(rng2.address, RNG_LOOKAHEAD);
+  await sortitionModule.changeRandomNumberGenerator(rng2.address);
 };
 
 deployArbitration.tags = ["RNG"];

contracts/deploy/change-sortition-module-rng.ts

@@ -23,11 +23,11 @@ const task: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
     sortitionModule = await ethers.getContract<SortitionModule>("SortitionModule");
   }
 
-  console.log(`chainlinkRng.changeSortitionModule(${sortitionModule.target})`);
-  await chainlinkRng.changeSortitionModule(sortitionModule.target);
+  console.log(`chainlinkRng.changeConsumer(${sortitionModule.target})`);
+  await chainlinkRng.changeConsumer(sortitionModule.target);
 
-  console.log(`sortitionModule.changeRandomNumberGenerator(${chainlinkRng.target}, 0)`);
-  await sortitionModule.changeRandomNumberGenerator(chainlinkRng.target, 0);
+  console.log(`sortitionModule.changeRandomNumberGenerator(${chainlinkRng.target})`);
+  await sortitionModule.changeRandomNumberGenerator(chainlinkRng.target);
 };
 
 task.tags = ["ChangeSortitionModuleRNG"];

contracts/src/arbitration/SortitionModule.sol

@@ -2,7 +2,7 @@
 
 pragma solidity ^0.8.24;
 
-import {SortitionModuleBase, KlerosCore, RNG} from "./SortitionModuleBase.sol";
+import {SortitionModuleBase, KlerosCore, IRNG} from "./SortitionModuleBase.sol";
 
 /// @title SortitionModule
 /// @dev A factory of trees that keeps track of staked values for sortition.
@@ -24,16 +24,14 @@ contract SortitionModule is SortitionModuleBase {
     /// @param _minStakingTime Minimal time to stake
     /// @param _maxDrawingTime Time after which the drawing phase can be switched
     /// @param _rng The random number generator.
-    /// @param _rngLookahead Lookahead value for rng.
     function initialize(
         address _governor,
         KlerosCore _core,
         uint256 _minStakingTime,
         uint256 _maxDrawingTime,
-        RNG _rng,
-        uint256 _rngLookahead
+        IRNG _rng
     ) external reinitializer(1) {
-        __SortitionModuleBase_initialize(_governor, _core, _minStakingTime, _maxDrawingTime, _rng, _rngLookahead);
+        __SortitionModuleBase_initialize(_governor, _core, _minStakingTime, _maxDrawingTime, _rng);
     }
 
     function initialize4() external reinitializer(4) {

contracts/src/arbitration/SortitionModuleBase.sol

@@ -7,7 +7,7 @@ import {ISortitionModule} from "./interfaces/ISortitionModule.sol";
 import {IDisputeKit} from "./interfaces/IDisputeKit.sol";
 import {Initializable} from "../proxy/Initializable.sol";
 import {UUPSProxiable} from "../proxy/UUPSProxiable.sol";
-import {RNG} from "../rng/RNG.sol";
+import {IRNG} from "../rng/IRNG.sol";
 import "../libraries/Constants.sol";
 
 /// @title SortitionModuleBase
@@ -50,11 +50,9 @@ abstract contract SortitionModuleBase is ISortitionModule, Initializable, UUPSPr
     uint256 public minStakingTime; // The time after which the phase can be switched to Drawing if there are open disputes.
     uint256 public maxDrawingTime; // The time after which the phase can be switched back to Staking.
     uint256 public lastPhaseChange; // The last time the phase was changed.
-    uint256 public randomNumberRequestBlock; // Number of the block when RNG request was made.
     uint256 public disputesWithoutJurors; // The number of disputes that have not finished drawing jurors.
-    RNG public rng; // The random number generator.
+    IRNG public rng; // The random number generator.
     uint256 public randomNumber; // Random number returned by RNG.
-    uint256 public rngLookahead; // Minimal block distance between requesting and obtaining a random number.
     uint256 public delayedStakeWriteIndex; // The index of the last `delayedStake` item that was written to the array. 0 index is skipped.
     uint256 public delayedStakeReadIndex; // The index of the next `delayedStake` item that should be processed. Starts at 1 because 0 index is skipped.
     mapping(bytes32 treeHash => SortitionSumTree) sortitionSumTrees; // The mapping trees by keys.
@@ -104,16 +102,14 @@ abstract contract SortitionModuleBase is ISortitionModule, Initializable, UUPSPr
         KlerosCore _core,
         uint256 _minStakingTime,
         uint256 _maxDrawingTime,
-        RNG _rng,
-        uint256 _rngLookahead
+        IRNG _rng
     ) internal onlyInitializing {
         governor = _governor;
         core = _core;
         minStakingTime = _minStakingTime;
         maxDrawingTime = _maxDrawingTime;
         lastPhaseChange = block.timestamp;
         rng = _rng;
-        rngLookahead = _rngLookahead;
         delayedStakeReadIndex = 1;
     }
 
@@ -153,15 +149,12 @@ abstract contract SortitionModuleBase is ISortitionModule, Initializable, UUPSPr
         maxDrawingTime = _maxDrawingTime;
     }
 
-    /// @dev Changes the `_rng` and `_rngLookahead` storage variables.
-    /// @param _rng The new value for the `RNGenerator` storage variable.
-    /// @param _rngLookahead The new value for the `rngLookahead` storage variable.
-    function changeRandomNumberGenerator(RNG _rng, uint256 _rngLookahead) external onlyByGovernor {
+    /// @dev Changes the `rng` storage variable.
+    /// @param _rng The new random number generator.
+    function changeRandomNumberGenerator(IRNG _rng) external onlyByGovernor {
         rng = _rng;
-        rngLookahead = _rngLookahead;
         if (phase == Phase.generating) {
-            rng.requestRandomness(block.number + rngLookahead);
-            randomNumberRequestBlock = block.number;
+            rng.requestRandomness();
         }
     }
 
@@ -176,11 +169,10 @@ abstract contract SortitionModuleBase is ISortitionModule, Initializable, UUPSPr
                 "The minimum staking time has not passed yet."
             );
             require(disputesWithoutJurors > 0, "There are no disputes that need jurors.");
-            rng.requestRandomness(block.number + rngLookahead);
-            randomNumberRequestBlock = block.number;
+            rng.requestRandomness();
             phase = Phase.generating;
         } else if (phase == Phase.generating) {
-            randomNumber = rng.receiveRandomness(randomNumberRequestBlock + rngLookahead);
+            randomNumber = rng.receiveRandomness();
             require(randomNumber != 0, "Random number is not ready yet");
             phase = Phase.drawing;
         } else if (phase == Phase.drawing) {

contracts/src/arbitration/SortitionModuleNeo.sol

@@ -2,7 +2,7 @@
 
 pragma solidity ^0.8.24;
 
-import {SortitionModuleBase, KlerosCore, RNG, StakingResult} from "./SortitionModuleBase.sol";
+import {SortitionModuleBase, KlerosCore, IRNG, StakingResult} from "./SortitionModuleBase.sol";
 
 /// @title SortitionModuleNeo
 /// @dev A factory of trees that keeps track of staked values for sortition.
@@ -32,20 +32,18 @@ contract SortitionModuleNeo is SortitionModuleBase {
     /// @param _minStakingTime Minimal time to stake
     /// @param _maxDrawingTime Time after which the drawing phase can be switched
     /// @param _rng The random number generator.
-    /// @param _rngLookahead Lookahead value for rng.
     /// @param _maxStakePerJuror The maximum amount of PNK a juror can stake in a court.
     /// @param _maxTotalStaked The maximum amount of PNK that can be staked in all courts.
     function initialize(
         address _governor,
         KlerosCore _core,
         uint256 _minStakingTime,
         uint256 _maxDrawingTime,
-        RNG _rng,
-        uint256 _rngLookahead,
+        IRNG _rng,
         uint256 _maxStakePerJuror,
         uint256 _maxTotalStaked
     ) external reinitializer(2) {
-        __SortitionModuleBase_initialize(_governor, _core, _minStakingTime, _maxDrawingTime, _rng, _rngLookahead);
+        __SortitionModuleBase_initialize(_governor, _core, _minStakingTime, _maxDrawingTime, _rng);
         maxStakePerJuror = _maxStakePerJuror;
         maxTotalStaked = _maxTotalStaked;
     }