chore: scripts handling of the governor being a contract

Author: jaybuidl

contracts/scripts/changeGovernor.ts

@@ -6,11 +6,7 @@ const { bold } = print.colors;
 
 task("change-governor", "Changes the governor for all the contracts")
   .addPositionalParam("newGovernor", "The address of the new governor")
-  .addOptionalParam(
-    "coreType",
-    "The type of core to use between base, neo, university (default: base)",
-    Cores.BASE.toString()
-  )
+  .addOptionalParam("coreType", "The type of core to use between base, neo, university (default: base)", Cores.BASE)
   .setAction(async (taskArgs, hre) => {
     const newGovernor = taskArgs.newGovernor;
     print.highlight(`💣 Changing governor to ${bold(newGovernor)}`);
@@ -25,16 +21,22 @@ task("change-governor", "Changes the governor for all the contracts")
       return;
     }
 
-    let coreType = Cores.BASE;
-    coreType = Cores[taskArgs.coreType.toUpperCase() as keyof typeof Cores];
+    const coreType = Cores[taskArgs.coreType.toUpperCase() as keyof typeof Cores];
     if (coreType === undefined) {
       console.error("Invalid core type, must be one of base, neo, university");
       return;
     }
-    console.log("Using core type %s", Cores[coreType]);
+    console.log("Using core type %s", coreType);
 
-    const { core, disputeKitClassic, disputeResolver, disputeTemplateRegistry, chainlinkRng, randomizerRng } =
-      await getContracts(hre, coreType);
+    const {
+      core,
+      disputeKitClassic,
+      disputeResolver,
+      disputeTemplateRegistry,
+      policyRegistry,
+      chainlinkRng,
+      randomizerRng,
+    } = await getContracts(hre, coreType);
 
     const updateGovernor = async (contractName: string, contractInstance: any) => {
       print.info(`Changing governor for ${contractName}`);
@@ -54,12 +56,13 @@ task("change-governor", "Changes the governor for all the contracts")
     };
 
     // TODO: upgrade and add changeGovernor!
-    // await updateGovernor("Sortition", sortition)
+    // await updateGovernor("SortitionModule", sortition)
 
     await updateGovernor("KlerosCore", core);
     await updateGovernor("DisputeKitClassic", disputeKitClassic);
     await updateGovernor("DisputeResolver", disputeResolver);
     await updateGovernor("DisputeTemplateRegistry", disputeTemplateRegistry);
+    await updateGovernor("PolicyRegistry", policyRegistry);
     if (chainlinkRng) await updateGovernor("ChainlinkRNG", chainlinkRng);
     if (randomizerRng) await updateGovernor("RandomizerRNG", randomizerRng);
 

contracts/scripts/populateCourts.ts

@@ -7,6 +7,8 @@ import courtsV2ArbitrumTestnet from "../config/courts.v2.testnet.json";
 import courtsV2ArbitrumDevnet from "../config/courts.v2.devnet.json";
 import courtsV2MainnetNeo from "../config/courts.v2.mainnet-neo.json";
 import { isDevnet } from "../deploy/utils";
+import { execute } from "./utils/execution";
+import { getContracts, Cores } from "./utils/contracts";
 
 enum HomeChains {
   ARBITRUM_ONE = 42161,
@@ -22,12 +24,6 @@ enum Sources {
   V2_MAINNET_NEO,
 }
 
-enum Cores {
-  BASE,
-  NEO,
-  UNIVERSITY,
-}
-
 type Court = {
   id: number;
   parent: number;
@@ -57,11 +53,7 @@ task("populate:courts", "Populates the courts and their parameters")
     undefined,
     types.int
   )
-  .addOptionalParam(
-    "coreType",
-    "The type of core to use between base, neo, university (default: base)",
-    Cores.BASE.toString()
-  )
+  .addOptionalParam("coreType", "The type of core to use between base, neo, university (default: base)", Cores.BASE)
   .addFlag("reverse", "Iterates the courts in reverse order, useful to increase minStake in the child courts first")
   .addFlag("forceV1ParametersToDev", "Use development values for the v1 courts parameters")
   .setAction(async (taskArgs, hre) => {
@@ -90,13 +82,12 @@ task("populate:courts", "Populates the courts and their parameters")
     }
     console.log("Populating from source %s", Sources[from]);
 
-    let coreType = Cores.BASE;
-    coreType = Cores[taskArgs.coreType.toUpperCase() as keyof typeof Cores];
+    const coreType = Cores[taskArgs.coreType.toUpperCase() as keyof typeof Cores];
     if (coreType === undefined) {
       console.error("Invalid core type, must be one of base, neo, university");
       return;
     }
-    console.log("Using core type %s", Cores[coreType]);
+    console.log("Using core type %s", coreType);
 
     const truncateWei = (x: bigint) => (x / TEN_THOUSAND_GWEI) * TEN_THOUSAND_GWEI;
 
@@ -163,21 +154,7 @@ task("populate:courts", "Populates the courts and their parameters")
 
     console.log("courtsV2 = %O", courtsV2);
 
-    let core: KlerosCore | KlerosCoreNeo | KlerosCoreUniversity;
-    switch (coreType) {
-      case Cores.UNIVERSITY:
-        console.log("Using KlerosCoreUniversity");
-        core = (await ethers.getContract("KlerosCoreUniversity")) as KlerosCoreUniversity;
-        break;
-      case Cores.NEO:
-        console.log("Using KlerosCoreNeo");
-        core = (await ethers.getContract("KlerosCoreNeo")) as KlerosCoreNeo;
-        break;
-      default:
-        console.log("Using KlerosCore");
-        core = (await ethers.getContract("KlerosCore")) as KlerosCore;
-        break;
-    }
+    const { core } = await getContracts(hre, coreType);
 
     for (const court of courtsV2) {
       const courtPresent = await core.courts(court.id).catch(() => {});
@@ -244,43 +221,49 @@ task("populate:courts", "Populates the courts and their parameters")
           continue;
         }
         try {
-          await core.changeCourtParameters(
-            court.id,
-            court.hiddenVotes,
-            court.minStake,
-            court.alpha,
-            court.feeForJuror,
-            court.jurorsForCourtJump,
-            [court.timesPerPeriod[0], court.timesPerPeriod[1], court.timesPerPeriod[2], court.timesPerPeriod[3]]
-          );
+          await core.changeCourtParameters
+            .populateTransaction(
+              court.id,
+              court.hiddenVotes,
+              court.minStake,
+              court.alpha,
+              court.feeForJuror,
+              court.jurorsForCourtJump,
+              [court.timesPerPeriod[0], court.timesPerPeriod[1], court.timesPerPeriod[2], court.timesPerPeriod[3]]
+            )
+            .then(execute);
         } catch (error) {
           console.error("Error changing court parameters: %s", error);
         }
       } else {
         console.log("Court %d not found, creating it with", court.id, court);
         if (coreType === Cores.UNIVERSITY) {
-          await (core as KlerosCoreUniversity).createCourt(
-            court.parent,
-            court.hiddenVotes,
-            court.minStake,
-            court.alpha,
-            court.feeForJuror,
-            court.jurorsForCourtJump,
-            [court.timesPerPeriod[0], court.timesPerPeriod[1], court.timesPerPeriod[2], court.timesPerPeriod[3]],
-            [DISPUTE_KIT_CLASSIC]
-          );
+          await (core as KlerosCoreUniversity).createCourt
+            .populateTransaction(
+              court.parent,
+              court.hiddenVotes,
+              court.minStake,
+              court.alpha,
+              court.feeForJuror,
+              court.jurorsForCourtJump,
+              [court.timesPerPeriod[0], court.timesPerPeriod[1], court.timesPerPeriod[2], court.timesPerPeriod[3]],
+              [DISPUTE_KIT_CLASSIC]
+            )
+            .then(execute);
         } else {
-          await (core as KlerosCore).createCourt(
-            court.parent,
-            court.hiddenVotes,
-            court.minStake,
-            court.alpha,
-            court.feeForJuror,
-            court.jurorsForCourtJump,
-            [court.timesPerPeriod[0], court.timesPerPeriod[1], court.timesPerPeriod[2], court.timesPerPeriod[3]],
-            ethers.toBeHex(5), // Not accessible on-chain, but has always been set to the same value so far.
-            [DISPUTE_KIT_CLASSIC]
-          );
+          await (core as KlerosCore).createCourt
+            .populateTransaction(
+              court.parent,
+              court.hiddenVotes,
+              court.minStake,
+              court.alpha,
+              court.feeForJuror,
+              court.jurorsForCourtJump,
+              [court.timesPerPeriod[0], court.timesPerPeriod[1], court.timesPerPeriod[2], court.timesPerPeriod[3]],
+              ethers.toBeHex(5), // Not accessible on-chain, but has always been set to the same value so far.
+              [DISPUTE_KIT_CLASSIC]
+            )
+            .then(execute);
         }
       }
 

contracts/scripts/populatePolicyRegistry.ts

@@ -6,6 +6,7 @@ import policiesV2ArbitrumTestnet from "../config/policies.v2.testnet.json";
 import policiesV2ArbitrumDevnet from "../config/policies.v2.devnet.json";
 import policiesV2MainnetNeo from "../config/policies.v2.mainnet-neo.json";
 import { isDevnet } from "../deploy/utils";
+import { execute } from "./utils/execution";
 
 enum HomeChains {
   ARBITRUM_ONE = 42161,
@@ -109,6 +110,6 @@ task("populate:policy-registry", "Populates the policy registry for each court")
 
     for await (const policy of policiesV2) {
       console.log("Populating policy for %s Court (%d): %s", policy.name, policy.court, policy.uri);
-      await policyRegistry.setPolicy(policy.court, policy.name, policy.uri);
+      await policyRegistry.setPolicy.populateTransaction(policy.court, policy.name, policy.uri).then(execute);
     }
   });

contracts/scripts/utils/contracts.ts

@@ -7,23 +7,28 @@ import {
   DisputeTemplateRegistry,
   KlerosCore,
   KlerosCoreNeo,
+  KlerosCoreUniversity,
   PNK,
+  PolicyRegistry,
   RandomizerRNG,
   SortitionModule,
   SortitionModuleNeo,
+  SortitionModuleUniversity,
   TransactionBatcher,
 } from "../../typechain-types";
 
-export enum Cores {
-  BASE,
-  NEO,
-  UNIVERSITY,
-}
+export const Cores = {
+  BASE: "BASE",
+  NEO: "NEO",
+  UNIVERSITY: "UNIVERSITY",
+} as const;
 
-export const getContracts = async (hre: HardhatRuntimeEnvironment, coreType: Cores) => {
+export type Core = (typeof Cores)[keyof typeof Cores];
+
+export const getContracts = async (hre: HardhatRuntimeEnvironment, coreType: Core) => {
   const { ethers } = hre;
-  let core: KlerosCore | KlerosCoreNeo;
-  let sortition: SortitionModule | SortitionModuleNeo;
+  let core: KlerosCore | KlerosCoreNeo | KlerosCoreUniversity;
+  let sortition: SortitionModule | SortitionModuleNeo | SortitionModuleUniversity;
   let disputeKitClassic: DisputeKitClassic;
   let disputeResolver: DisputeResolver;
   switch (coreType) {
@@ -40,11 +45,16 @@ export const getContracts = async (hre: HardhatRuntimeEnvironment, coreType: Cor
       disputeResolver = (await ethers.getContract("DisputeResolver")) as DisputeResolver;
       break;
     case Cores.UNIVERSITY:
-      throw new Error("University core is not supported");
+      core = (await ethers.getContract("KlerosCoreUniversity")) as KlerosCoreUniversity;
+      sortition = (await ethers.getContract("SortitionModuleUniversity")) as SortitionModuleUniversity;
+      disputeKitClassic = (await ethers.getContract("DisputeKitClassicUniversity")) as DisputeKitClassic;
+      disputeResolver = (await ethers.getContract("DisputeResolverUniversity")) as DisputeResolver;
+      break;
     default:
-      throw new Error("Invalid core type, must be one of base, neo");
+      throw new Error("Invalid core type, must be one of BASE, NEO, or UNIVERSITY");
   }
   const disputeTemplateRegistry = (await ethers.getContract("DisputeTemplateRegistry")) as DisputeTemplateRegistry;
+  const policyRegistry = (await ethers.getContract("PolicyRegistry")) as PolicyRegistry;
   const batcher = (await ethers.getContract("TransactionBatcher")) as TransactionBatcher;
   const chainlinkRng = await ethers.getContractOrNull<ChainlinkRNG>("ChainlinkRNG");
   const randomizerRng = await ethers.getContractOrNull<RandomizerRNG>("RandomizerRNG");
@@ -56,6 +66,7 @@ export const getContracts = async (hre: HardhatRuntimeEnvironment, coreType: Cor
     disputeKitClassic,
     disputeResolver,
     disputeTemplateRegistry,
+    policyRegistry,
     chainlinkRng,
     randomizerRng,
     blockHashRNG,

contracts/scripts/utils/execution.ts

@@ -0,0 +1,34 @@
+import { type ContractTransaction } from "ethers";
+
+const governableAbi = [
+  {
+    inputs: [],
+    name: "governor",
+    outputs: [
+      {
+        internalType: "address",
+        name: "",
+        type: "address",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+];
+
+export const execute = async (tx: ContractTransaction) => {
+  const hre = require("hardhat");
+  const { ethers } = hre;
+
+  const contract = await ethers.getContractAt(governableAbi, tx.to);
+  const governor = await contract.governor();
+  const isContract = (await ethers.provider.getCode(governor)).length > 2;
+  if (isContract) {
+    // Don't execute, just log the tx. It must be submitted for execution separately.
+    console.log("tx = %O", tx);
+  } else {
+    // Execute the tx
+    const signer = (await ethers.getSigners())[0];
+    await signer.sendTransaction(tx);
+  }
+};