chore: deployment script support for RNGWithFallback

Author: jaybuidl

contracts/deploy/00-ethereum-pnk.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 } from "../typechain-types";
+import { ChainlinkRNG, DisputeKitClassic, KlerosCoreNeo, RNGWithFallback } from "../typechain-types";
 
 const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { ethers, deployments, getNamedAccounts, getChainId } = hre;
@@ -44,12 +44,20 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   const devnet = isDevnet(hre.network);
   const minStakingTime = devnet ? 180 : 1800;
   const maxFreezingTime = devnet ? 600 : 1800;
-  const rng = (await ethers.getContract("ChainlinkRNG")) as ChainlinkRNG;
+  const rngWithFallback = await ethers.getContract<RNGWithFallback>("RNGWithFallback");
   const maxStakePerJuror = PNK(2_000);
   const maxTotalStaked = PNK(2_000_000);
   const sortitionModule = await deployUpgradable(deployments, "SortitionModuleNeo", {
     from: deployer,
-    args: [deployer, klerosCoreAddress, minStakingTime, maxFreezingTime, rng.target, maxStakePerJuror, maxTotalStaked],
+    args: [
+      deployer,
+      klerosCoreAddress,
+      minStakingTime,
+      maxFreezingTime,
+      rngWithFallback.target,
+      maxStakePerJuror,
+      maxTotalStaked,
+    ],
     log: true,
   }); // nonce (implementation), nonce+1 (proxy)
 
@@ -84,11 +92,11 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
     await disputeKitContract.changeCore(klerosCore.address);
   }
 
-  // rng.changeConsumer() only if necessary
-  const rngConsumer = await rng.consumer();
+  // rngWithFallback.changeConsumer() only if necessary
+  const rngConsumer = await rngWithFallback.consumer();
   if (rngConsumer !== sortitionModule.address) {
-    console.log(`rng.changeConsumer(${sortitionModule.address})`);
-    await rng.changeConsumer(sortitionModule.address);
+    console.log(`rngWithFallback.changeConsumer(${sortitionModule.address})`);
+    await rngWithFallback.changeConsumer(sortitionModule.address);
   }
 
   const core = (await hre.ethers.getContract("KlerosCoreNeo")) as KlerosCoreNeo;

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

@@ -6,7 +6,7 @@ import { changeCurrencyRate } from "./utils/klerosCoreHelper";
 import { HomeChains, isSkipped, isDevnet, PNK, ETH, Courts } from "./utils";
 import { getContractOrDeploy, getContractOrDeployUpgradable } from "./utils/getContractOrDeploy";
 import { deployERC20AndFaucet } from "./utils/deployTokens";
-import { ChainlinkRNG, DisputeKitClassic, KlerosCore } from "../typechain-types";
+import { ChainlinkRNG, DisputeKitClassic, KlerosCore, RNGWithFallback } from "../typechain-types";
 
 const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { ethers, deployments, getNamedAccounts, getChainId } = hre;
@@ -49,10 +49,10 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   const devnet = isDevnet(hre.network);
   const minStakingTime = devnet ? 180 : 1800;
   const maxFreezingTime = devnet ? 600 : 1800;
-  const rng = (await ethers.getContract("ChainlinkRNG")) as ChainlinkRNG;
+  const rngWithFallback = await ethers.getContract<RNGWithFallback>("RNGWithFallback");
   const sortitionModule = await deployUpgradable(deployments, "SortitionModule", {
     from: deployer,
-    args: [deployer, klerosCoreAddress, minStakingTime, maxFreezingTime, rng.target],
+    args: [deployer, klerosCoreAddress, minStakingTime, maxFreezingTime, rngWithFallback.target],
     log: true,
   }); // nonce (implementation), nonce+1 (proxy)
 
@@ -79,18 +79,18 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   }); // nonce+2 (implementation), nonce+3 (proxy)
 
   // disputeKit.changeCore() only if necessary
-  const disputeKitContract = (await ethers.getContract("DisputeKitClassic")) as DisputeKitClassic;
+  const disputeKitContract = await ethers.getContract<DisputeKitClassic>("DisputeKitClassic");
   const currentCore = await disputeKitContract.core();
   if (currentCore !== klerosCore.address) {
     console.log(`disputeKit.changeCore(${klerosCore.address})`);
     await disputeKitContract.changeCore(klerosCore.address);
   }
 
-  // rng.changeConsumer() only if necessary
-  const rngConsumer = await rng.consumer();
+  // rngWithFallback.changeConsumer() only if necessary
+  const rngConsumer = await rngWithFallback.consumer();
   if (rngConsumer !== sortitionModule.address) {
-    console.log(`rng.changeConsumer(${sortitionModule.address})`);
-    await rng.changeConsumer(sortitionModule.address);
+    console.log(`rngWithFallback.changeConsumer(${sortitionModule.address})`);
+    await rngWithFallback.changeConsumer(sortitionModule.address);
   }
 
   const core = (await hre.ethers.getContract("KlerosCore")) as KlerosCore;

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

@@ -1,6 +1,7 @@
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
 import { HomeChains, isSkipped } from "./utils";
+import { getContractOrDeploy } from "./utils/getContractOrDeploy";
 
 const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { deployments, getNamedAccounts, getChainId } = hre;
@@ -14,7 +15,7 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   const klerosCore = await deployments.get("KlerosCore");
   const disputeTemplateRegistry = await deployments.get("DisputeTemplateRegistry");
 
-  await deploy("DisputeResolver", {
+  await getContractOrDeploy(hre, "DisputeResolver", {
     from: deployer,
     args: [klerosCore.address, disputeTemplateRegistry.address],
     log: true,

contracts/deploy/00-home-chain-pnk-faucet.ts

@@ -2,10 +2,10 @@ import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
 import { HomeChains, isSkipped } from "./utils";
 import { getContractOrDeploy } from "./utils/getContractOrDeploy";
+import { RNGWithFallback } from "../typechain-types";
 
 const deployRng: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
-  const { deployments, getNamedAccounts, getChainId } = hre;
-  const { deploy } = deployments;
+  const { getNamedAccounts, getChainId, ethers } = hre;
 
   // fallback to hardhat node signers on local network
   const deployer = (await getNamedAccounts()).deployer ?? (await hre.ethers.getSigners())[0].address;
@@ -57,11 +57,16 @@ const deployRng: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const requestConfirmations = 200; // between 1 and 200 L2 blocks
   const callbackGasLimit = 100000;
 
-  await deploy("ChainlinkRNG", {
+  const oldRng = await ethers.getContractOrNull("ChainlinkRNG");
+  if (!oldRng) {
+    console.log("Register this Chainlink consumer here: http://vrf.chain.link/");
+  }
+
+  const rng = await getContractOrDeploy(hre, "ChainlinkRNG", {
     from: deployer,
     args: [
       deployer,
-      deployer, // The consumer is configured as the SortitionModule later
+      deployer, // The consumer is configured as the RNGWithFallback later
       ChainlinkVRFCoordinator.target,
       keyHash,
       subscriptionId,
@@ -71,7 +76,25 @@ const deployRng: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
     log: true,
   });
 
-  console.log("Register this Chainlink consumer here: http://vrf.chain.link/");
+  const fallbackTimeoutSeconds = 30 * 60; // 30 minutes
+  await getContractOrDeploy(hre, "RNGWithFallback", {
+    from: deployer,
+    args: [
+      deployer,
+      deployer, // The consumer is configured as the SortitionModule later
+      fallbackTimeoutSeconds,
+      rng.target,
+    ],
+    log: true,
+  });
+
+  // rng.changeConsumer() only if necessary
+  const rngWithFallback = await ethers.getContract<RNGWithFallback>("RNGWithFallback");
+  const rngConsumer = await rng.consumer();
+  if (rngConsumer !== rngWithFallback.target) {
+    console.log(`rng.changeConsumer(${rngWithFallback.target})`);
+    await rng.changeConsumer(rngWithFallback.target);
+  }
 };
 
 deployRng.tags = ["ChainlinkRNG"];

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

@@ -2,10 +2,10 @@ import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
 import { HomeChains, isSkipped } from "./utils";
 import { getContractOrDeploy } from "./utils/getContractOrDeploy";
+import { RNGWithFallback } from "../typechain-types";
 
 const deployRng: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
-  const { deployments, getNamedAccounts, getChainId } = hre;
-  const { deploy } = deployments;
+  const { getNamedAccounts, getChainId, ethers } = hre;
 
   // fallback to hardhat node signers on local network
   const deployer = (await getNamedAccounts()).deployer ?? (await hre.ethers.getSigners())[0].address;
@@ -20,11 +20,35 @@ const deployRng: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
     log: true,
   });
 
-  await getContractOrDeploy(hre, "RandomizerRNG", {
+  const rng = await getContractOrDeploy(hre, "RandomizerRNG", {
     from: deployer,
-    args: [deployer, deployer, randomizerOracle.target], // The consumer is configured as the SortitionModule later
+    args: [
+      deployer,
+      deployer, // The consumer is configured as the RNGWithFallback later
+      randomizerOracle.target,
+    ],
     log: true,
   });
+
+  const fallbackTimeoutSeconds = 30 * 60; // 30 minutes
+  await getContractOrDeploy(hre, "RNGWithFallback", {
+    from: deployer,
+    args: [
+      deployer,
+      deployer, // The consumer is configured as the SortitionModule later
+      fallbackTimeoutSeconds,
+      rng.target,
+    ],
+    log: true,
+  });
+
+  // rng.changeConsumer() only if necessary
+  const rngWithFallback = await ethers.getContract<RNGWithFallback>("RNGWithFallback");
+  const rngConsumer = await rng.consumer();
+  if (rngConsumer !== rngWithFallback.target) {
+    console.log(`rng.changeConsumer(${rngWithFallback.target})`);
+    await rng.changeConsumer(rngWithFallback.target);
+  }
 };
 
 deployRng.tags = ["RandomizerRNG"];

contracts/deploy/00-chainlink-rng.ts renamed to contracts/deploy/00-rng-chainlink.ts

@@ -1,5 +1,5 @@
 import { expect } from "chai";
-import { deployments, ethers, network } from "hardhat";
+import { deployments, ethers, getNamedAccounts, network } from "hardhat";
 import {
   IncrementalNG,
   BlockHashRNG,
@@ -11,6 +11,7 @@ import {
 
 const initialNg = 424242;
 const abiCoder = ethers.AbiCoder.defaultAbiCoder();
+let deployer: string;
 
 describe("IncrementalNG", async () => {
   let rng: IncrementalNG;
@@ -85,12 +86,16 @@ describe("ChainlinkRNG", async () => {
   let vrfCoordinator: ChainlinkVRFCoordinatorV2Mock;
 
   beforeEach("Setup", async () => {
+    ({ deployer } = await getNamedAccounts());
+
     await deployments.fixture(["ChainlinkRNG"], {
       fallbackToGlobal: true,
       keepExistingDeployments: false,
     });
     rng = (await ethers.getContract("ChainlinkRNG")) as ChainlinkRNG;
     vrfCoordinator = (await ethers.getContract("ChainlinkVRFCoordinator")) as ChainlinkVRFCoordinatorV2Mock;
+
+    await rng.changeConsumer(deployer);
   });
 
   it("Should return a non-zero random number", async () => {
@@ -144,12 +149,16 @@ describe("RandomizerRNG", async () => {
   let randomizer: RandomizerMock;
 
   beforeEach("Setup", async () => {
+    ({ deployer } = await getNamedAccounts());
+
     await deployments.fixture(["RandomizerRNG"], {
       fallbackToGlobal: true,
       keepExistingDeployments: false,
     });
     rng = (await ethers.getContract("RandomizerRNG")) as RandomizerRNG;
     randomizer = (await ethers.getContract("RandomizerOracle")) as RandomizerMock;
+
+    await rng.changeConsumer(deployer);
   });
 
   it("Should return a non-zero random number", async () => {