chore: added RandomizerMock, migrated test and deploy scripts

Author: jaybuidl

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

@@ -13,6 +13,11 @@ const pnkByChain = new Map<HomeChains, string>([
  [HomeChains.ARBITRUM_GOERLI, "0x4DEeeFD054434bf6721eF39Aa18EfB3fd0D12610"],
 ]);
 
+const randomizerByChain = new Map<HomeChains, string>([
+ [HomeChains.ARBITRUM_ONE, "0x00"],
+ [HomeChains.ARBITRUM_GOERLI, "0xE1B6CcAc0BB0355C01A049e78909231Bfa13620B"],
+]);
+
 const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
  const { deployments, getNamedAccounts, getChainId } = hre;
  const { deploy, execute } = deployments;
@@ -23,18 +28,47 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
  const chainId = Number(await getChainId());
  console.log("deploying to %s with deployer %s", HomeChains[chainId], deployer);
 
+ if (chainId === HomeChains.HARDHAT) {
+ pnkByChain.set(
+ HomeChains.HARDHAT,
+ (
+ await deploy("PNK", {
+ from: deployer,
+ log: true,
+ })
+ ).address
+ );
+ randomizerByChain.set(
+ HomeChains.HARDHAT,
+ (
+ await deploy("RandomizerMock", {
+ from: deployer,
+ args: [],
+ log: true,
+ })
+ ).address
+ );
+ }
+
  await deploy("PolicyRegistry", {
  from: deployer,
  args: [deployer],
  log: true,
  });
 
- const rng = await deploy("BlockHashRNG", {
+ await deploy("BlockHashRNG", {
  from: deployer,
  args: [],
  log: true,
  });
 
+ const randomizer = randomizerByChain.get(Number(await getChainId())) ?? AddressZero;
+ const rng = await deploy("RandomizerRNG", {
+ from: deployer,
+ args: [randomizer],
+ log: true,
+ });
+
  const disputeKit = await deploy("DisputeKitClassic", {
  from: deployer,
  args: [deployer, AddressZero, rng.address],
@@ -46,17 +80,6 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
  log: true,
  });
 
- if (chainId === HomeChains.HARDHAT) {
- pnkByChain.set(
- HomeChains.HARDHAT,
- (
- await deploy("PNK", {
- from: deployer,
- log: true,
- })
- ).address
- );
- }
  const pnk = pnkByChain.get(Number(await getChainId())) ?? AddressZero;
  const minStake = BigNumber.from(10).pow(20).mul(2);
  const alpha = 10000;

contracts/src/rng/mock/RandomizerMock.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8;
+
+import "../RandomizerRNG.sol";
+
+contract RandomizerMock is IRandomizer {
+ uint256 private id;
+
+ function request(uint256 callbackGasLimit) external override returns (uint256) {
+ return id++;
+ }
+
+ function clientWithdrawTo(address _to, uint256 _amount) external override {
+ revert("Not Implemented");
+ }
+
+ function relay(RandomizerRNG _rng, uint128 _id, bytes32 _value) external {
+ _rng.randomizerCallback(_id, _value);
+ }
+}

contracts/test/arbitration/draw.ts

@@ -1,7 +1,15 @@
 import { anyValue } from "@nomicfoundation/hardhat-chai-matchers/withArgs";
 import { deployments, ethers, getNamedAccounts, network } from "hardhat";
 import { BigNumber } from "ethers";
-import { PNK, KlerosCore, ArbitrableExample, HomeGatewayToEthereum, DisputeKitClassic } from "../../typechain-types";
+import {
+ PNK,
+ KlerosCore,
+ ArbitrableExample,
+ HomeGatewayToEthereum,
+ DisputeKitClassic,
+ RandomizerRNG,
+ RandomizerMock,
+} from "../../typechain-types";
 import { expect } from "chai";
 
 /* eslint-disable no-unused-vars */
@@ -38,6 +46,8 @@ describe("Draw Benchmark", async () => {
  let core;
  let arbitrable;
  let homeGateway;
+ let rng;
+ let randomizer;
 
  beforeEach("Setup", async () => {
  deployer = (await getNamedAccounts()).deployer;
@@ -55,6 +65,8 @@ describe("Draw Benchmark", async () => {
  core = (await ethers.getContract("KlerosCore")) as KlerosCore;
  homeGateway = (await ethers.getContract("HomeGatewayToEthereum")) as HomeGatewayToEthereum;
  arbitrable = (await ethers.getContract("ArbitrableExample")) as ArbitrableExample;
+ rng = (await ethers.getContract("RandomizerRNG")) as RandomizerRNG;
+ randomizer = (await ethers.getContract("RandomizerMock")) as RandomizerMock;
  });
 
  it("Draw Benchmark", async () => {
@@ -96,8 +108,9 @@ describe("Draw Benchmark", async () => {
  }
  await disputeKit.passPhase(); // Resolving -> Generating
  for (let index = 0; index < 20; index++) {
- await network.provider.send("evm_mine"); // RNG lookahead
+ await network.provider.send("evm_mine"); // RNG lookahead, TODO: remove this for RandomizerRNG
  }
+ await randomizer.relay(rng.address, 0, ethers.utils.randomBytes(32));
  await disputeKit.passPhase(); // Generating -> Drawing
 
  await expect(core.draw(0, 1000, { gasLimit: 1000000 }))

contracts/test/arbitration/unstake.ts

@@ -1,6 +1,6 @@
 import { ethers, getNamedAccounts, network, deployments } from "hardhat";
 import { BigNumber } from "ethers";
-import { PNK, KlerosCore, DisputeKitClassic } from "../../typechain-types";
+import { PNK, KlerosCore, DisputeKitClassic, RandomizerRNG, RandomizerMock } from "../../typechain-types";
 import { expect } from "chai";
 
 /* eslint-disable no-unused-vars */
@@ -18,6 +18,8 @@ describe("Unstake juror", async () => {
  let disputeKit;
  let pnk;
  let core;
+ let rng;
+ let randomizer;
 
  beforeEach("Setup", async () => {
  ({ deployer } = await getNamedAccounts());
@@ -32,6 +34,8 @@ describe("Unstake juror", async () => {
  disputeKit = (await ethers.getContract("DisputeKitClassic")) as DisputeKitClassic;
  pnk = (await ethers.getContract("PNK")) as PNK;
  core = (await ethers.getContract("KlerosCore")) as KlerosCore;
+ rng = (await ethers.getContract("RandomizerRNG")) as RandomizerRNG;
+ randomizer = (await ethers.getContract("RandomizerMock")) as RandomizerMock;
  });
 
  it("Unstake inactive juror", async () => {
@@ -55,8 +59,9 @@ describe("Unstake juror", async () => {
  }
  await disputeKit.passPhase(); // Resolving -> Generating
  for (let index = 0; index < 20; index++) {
- await network.provider.send("evm_mine"); // RNG lookahead
+ await network.provider.send("evm_mine"); // RNG lookahead, TODO: remove this for RandomizerRNG
  }
+ await randomizer.relay(rng.address, 0, ethers.utils.randomBytes(32));
  await disputeKit.passPhase(); // Generating -> Drawing
 
  await core.draw(0, 5000);

contracts/test/integration/index.ts

@@ -1,15 +1,16 @@
 import { expect } from "chai";
 import { deployments, ethers, getNamedAccounts, network } from "hardhat";
-import { BigNumber, utils } from "ethers";
+import { BigNumber } from "ethers";
 import {
- BlockHashRNG,
  PNK,
  KlerosCore,
  ForeignGatewayOnEthereum,
  ArbitrableExample,
  HomeGatewayToEthereum,
  VeaMock,
  DisputeKitClassic,
+ RandomizerRNG,
+ RandomizerMock,
 } from "../../typechain-types";
 
 /* eslint-disable no-unused-vars */
@@ -41,7 +42,7 @@ describe("Integration tests", async () => {
  }
 
  let deployer;
- let rng, disputeKit, pnk, core, vea, foreignGateway, arbitrable, homeGateway;
+ let rng, randomizer, disputeKit, pnk, core, vea, foreignGateway, arbitrable, homeGateway;
 
  beforeEach("Setup", async () => {
  ({ deployer } = await getNamedAccounts());
@@ -53,7 +54,8 @@ describe("Integration tests", async () => {
  fallbackToGlobal: true,
  keepExistingDeployments: false,
  });
- rng = (await ethers.getContract("BlockHashRNG")) as BlockHashRNG;
+ rng = (await ethers.getContract("RandomizerRNG")) as RandomizerRNG;
+ randomizer = (await ethers.getContract("RandomizerMock")) as RandomizerMock;
  disputeKit = (await ethers.getContract("DisputeKitClassic")) as DisputeKitClassic;
  pnk = (await ethers.getContract("PNK")) as PNK;
  core = (await ethers.getContract("KlerosCore")) as KlerosCore;
@@ -63,18 +65,6 @@ describe("Integration tests", async () => {
  homeGateway = (await ethers.getContract("HomeGatewayToEthereum")) as HomeGatewayToEthereum;
  });
 
- it("RNG", async () => {
- let tx = await rng.receiveRandomness(9876543210);
- let trace = await network.provider.send("debug_traceTransaction", [tx.hash]);
- let [rn] = ethers.utils.defaultAbiCoder.decode(["uint"], `0x${trace.returnValue}`);
- expect(rn).to.equal(0); // requested a block number in the future, so return 0.
-
- tx = await rng.receiveRandomness(5);
- trace = await network.provider.send("debug_traceTransaction", [tx.hash]);
- [rn] = ethers.utils.defaultAbiCoder.decode(["uint"], `0x${trace.returnValue}`);
- expect(rn).to.not.equal(0); // requested a block number in the past, so return non-zero.
- });
-
  it("Honest Claim - No Challenge - Bridger paid", async () => {
  const arbitrationCost = ONE_TENTH_ETH.mul(3);
  const [bridger, challenger, relayer] = await ethers.getSigners();
@@ -153,7 +143,8 @@ describe("Integration tests", async () => {
  expect(await disputeKit.phase()).to.equal(DisputeKitPhase.generating);
  console.log("KC phase: %d, DK phase: ", await core.phase(), await disputeKit.phase());
 
- await mineBlocks(20); // Wait for RNG lookahead
+ await mineBlocks(20); // Wait for RNG lookahead, TODO: remove this for RandomizerRNG
+ await randomizer.relay(rng.address, 0, ethers.utils.randomBytes(32));
  await disputeKit.passPhase(); // Generating -> Drawing
  expect(await disputeKit.phase()).to.equal(DisputeKitPhase.drawing);
  console.log("KC phase: %d, DK phase: ", await core.phase(), await disputeKit.phase());

contracts/test/rng/index.ts

@@ -1,20 +1,47 @@
 import { expect } from "chai";
-import { ethers } from "hardhat";
+import { ethers, network } from "hardhat";
 import { BigNumber } from "ethers";
+import { IncrementalNG, BlockHashRNG } from "../../typechain-types";
+
+let rng, rngFactory;
+const initialNg = 424242;
 
 describe("IncrementalNG", async () => {
+ beforeEach("Setup", async () => {
+ rngFactory = await ethers.getContractFactory("IncrementalNG");
+ rng = (await rngFactory.deploy(initialNg)) as IncrementalNG;
+ await rng.deployed();
+ });
+
  it("Should return a number incrementing each time", async () => {
- const IncrementalNG = await ethers.getContractFactory("IncrementalNG");
- const initialNg = 424242;
- const incrementalNG = await IncrementalNG.deploy(initialNg);
- await incrementalNG.deployed();
+ expect(await rng.callStatic.receiveRandomness(689376)).to.equal(initialNg);
+ await rng.receiveRandomness(29543);
+ expect(await rng.callStatic.receiveRandomness(5894382)).to.equal(initialNg + 1);
+ await rng.receiveRandomness(0);
+ expect(await rng.callStatic.receiveRandomness(3465)).to.equal(initialNg + 2);
+ await rng.receiveRandomness(BigNumber.from(2).pow(255));
+ expect(await rng.callStatic.receiveRandomness(0)).to.equal(initialNg + 3);
+ });
+});
+
+describe("BlockHashRNG", async () => {
+ beforeEach("Setup", async () => {
+ rngFactory = await ethers.getContractFactory("BlockHashRNG");
+ rng = (await rngFactory.deploy()) as BlockHashRNG;
+ await rng.deployed();
+ });
+
+ it("Should return a non-zero number for a block number in the past", async () => {
+ const tx = await rng.receiveRandomness(9876543210);
+ const trace = await network.provider.send("debug_traceTransaction", [tx.hash]);
+ const [rn] = ethers.utils.defaultAbiCoder.decode(["uint"], `0x${trace.returnValue}`);
+ expect(rn).to.equal(0);
+ });
 
- expect(await incrementalNG.callStatic.receiveRandomness(689376)).to.equal(initialNg);
- await incrementalNG.receiveRandomness(29543);
- expect(await incrementalNG.callStatic.receiveRandomness(5894382)).to.equal(initialNg + 1);
- await incrementalNG.receiveRandomness(0);
- expect(await incrementalNG.callStatic.receiveRandomness(3465)).to.equal(initialNg + 2);
- await incrementalNG.receiveRandomness(BigNumber.from(2).pow(255));
- expect(await incrementalNG.callStatic.receiveRandomness(0)).to.equal(initialNg + 3);
+ it("Should return zero for a block number in the future", async () => {
+ const tx = await rng.receiveRandomness(5);
+ const trace = await network.provider.send("debug_traceTransaction", [tx.hash]);
+ const [rn] = ethers.utils.defaultAbiCoder.decode(["uint"], `0x${trace.returnValue}`);
+ expect(rn).to.not.equal(0);
  });
 });