feat(bot): keeper bot support gated and gated shutter dk

Author: jaybuidl

contracts/scripts/keeperBot.ts

@@ -1,6 +1,13 @@
 import hre from "hardhat";
 import { toBigInt, BigNumberish, getNumber, BytesLike } from "ethers";
-import { DisputeKitClassic, DisputeKitShutter, SortitionModule, SortitionModuleNeo } from "../typechain-types";
+import {
+  DisputeKitClassic,
+  DisputeKitGated,
+  DisputeKitGatedShutter,
+  DisputeKitShutter,
+  SortitionModule,
+  SortitionModuleNeo,
+} from "../typechain-types";
 import env from "./utils/env";
 import loggerFactory from "./utils/logger";
 import { Cores, getContracts as getContractsForCoreType } from "./utils/contracts";
@@ -92,14 +99,14 @@ const getDisputeKit = async (
   coreDisputeId: string,
   coreRoundId: string
 ): Promise<{
-  disputeKit: DisputeKitClassic | DisputeKitShutter;
+  disputeKit: DisputeKitClassic | DisputeKitShutter | DisputeKitGated | DisputeKitGatedShutter;
   localDisputeId: bigint;
   localRoundId: bigint;
 }> => {
-  const { core, disputeKitClassic, disputeKitShutter } = await getContracts();
+  const { core, disputeKitClassic, disputeKitShutter, disputeKitGated, disputeKitGatedShutter } = await getContracts();
   const round = await core.getRoundInfo(coreDisputeId, coreRoundId);
   const disputeKitAddress = await core.disputeKits(round.disputeKitID);
-  let disputeKit: DisputeKitClassic | DisputeKitShutter;
+  let disputeKit: DisputeKitClassic | DisputeKitShutter | DisputeKitGated | DisputeKitGatedShutter;
   switch (disputeKitAddress) {
     case disputeKitClassic.target:
       disputeKit = disputeKitClassic;
@@ -108,6 +115,14 @@ const getDisputeKit = async (
       if (!disputeKitShutter) throw new Error(`DisputeKitShutter not deployed`);
       disputeKit = disputeKitShutter;
       break;
+    case disputeKitGated?.target:
+      if (!disputeKitGated) throw new Error(`DisputeKitGated not deployed`);
+      disputeKit = disputeKitGated;
+      break;
+    case disputeKitGatedShutter?.target:
+      if (!disputeKitGatedShutter) throw new Error(`DisputeKitGatedShutter not deployed`);
+      disputeKit = disputeKitGatedShutter;
+      break;
     default:
       throw new Error(`Unknown dispute kit: ${disputeKitAddress}`);
   }
@@ -527,7 +542,7 @@ const shutdown = async () => {
 };
 
 async function main() {
-  const { core, sortition, disputeKitShutter } = await getContracts();
+  const { core, sortition, disputeKitShutter, disputeKitGatedShutter } = await getContracts();
 
   const getBlockTime = async () => {
     return await ethers.provider.getBlock("latest").then((block) => {
@@ -604,6 +619,7 @@ async function main() {
     await passPeriod(dispute);
   }
   await shutterAutoReveal(disputeKitShutter, DISPUTES_TO_SKIP);
+  await shutterAutoReveal(disputeKitGatedShutter, DISPUTES_TO_SKIP);
   if (SHUTTER_AUTO_REVEAL_ONLY) {
     logger.debug("Shutter auto-reveal only, skipping other actions");
     await shutdown();

contracts/scripts/keeperBotShutter.ts

@@ -1,13 +1,17 @@
 import hre from "hardhat";
 import { getBytes } from "ethers";
-import { DisputeKitShutter, SortitionModule, SortitionModuleNeo } from "../typechain-types";
+import { DisputeKitGatedShutter, DisputeKitShutter, SortitionModule, SortitionModuleNeo } from "../typechain-types";
 import { decrypt } from "./shutter";
 import env from "./utils/env";
 import loggerFactory from "./utils/logger";
 import { Cores, getContracts as getContractsForCoreType } from "./utils/contracts";
 
 const SUBGRAPH_URL = env.require("SUBGRAPH_URL");
 const CORE_TYPE = env.optional("CORE_TYPE", "base");
+const DISPUTES_TO_SKIP = env
+  .optional("DISPUTES_TO_SKIP", "")
+  .split(",")
+  .map((s) => s.trim());
 
 const loggerOptions = env.optionalNoDefault("LOGTAIL_TOKEN_KEEPER_BOT")
   ? {
@@ -23,15 +27,6 @@ const loggerOptions = env.optionalNoDefault("LOGTAIL_TOKEN_KEEPER_BOT")
     };
 const logger = loggerFactory.createLogger(loggerOptions);
 
-const getContracts = async () => {
-  const coreType = Cores[CORE_TYPE.toUpperCase() as keyof typeof Cores];
-  if (coreType === Cores.UNIVERSITY) {
-    throw new Error("University is not supported yet");
-  }
-  const contracts = await getContractsForCoreType(hre, coreType);
-  return { ...contracts, sortition: contracts.sortition as SortitionModule | SortitionModuleNeo };
-};
-
 /**
  * Decodes a message string into its component parts
  * @param message The message to decode
@@ -77,7 +72,9 @@ type DisputeVotes = {
   };
 };
 
-const getShutterDisputesToReveal = async (disputeKitShutter: DisputeKitShutter): Promise<DisputeVotes[]> => {
+const getShutterDisputesToReveal = async (
+  disputeKitShutter: DisputeKitShutter | DisputeKitGatedShutter
+): Promise<DisputeVotes[]> => {
   const { gql, request } = await import("graphql-request"); // workaround for ESM import
   const query = gql`
     query DisputeToAutoReveal($shutterDisputeKit: Bytes) {
@@ -191,7 +188,10 @@ const getShutterDisputesToReveal = async (disputeKitShutter: DisputeKitShutter):
   return filteredDisputeVotes;
 };
 
-export const shutterAutoReveal = async (disputeKitShutter: DisputeKitShutter | null, disputesToSkip: string[]) => {
+export const shutterAutoReveal = async (
+  disputeKitShutter: DisputeKitShutter | DisputeKitGatedShutter | null,
+  disputesToSkip: string[]
+) => {
   if (!disputeKitShutter) {
     logger.debug("No Shutter dispute kit found, skipping auto-reveal");
     return [];
@@ -307,10 +307,20 @@ export const shutterAutoReveal = async (disputeKitShutter: DisputeKitShutter | n
   }
 };
 
+const getContracts = async () => {
+  const coreType = Cores[CORE_TYPE.toUpperCase() as keyof typeof Cores];
+  if (coreType === Cores.UNIVERSITY) {
+    throw new Error("University is not supported yet");
+  }
+  const contracts = await getContractsForCoreType(hre, coreType);
+  return { ...contracts, sortition: contracts.sortition as SortitionModule | SortitionModuleNeo };
+};
+
 async function main() {
   logger.debug("Starting...");
-  const { disputeKitShutter } = await getContracts();
-  await shutterAutoReveal(disputeKitShutter, ["44", "45", "51", "54"]);
+  const { disputeKitShutter, disputeKitGatedShutter } = await getContracts();
+  await shutterAutoReveal(disputeKitShutter, DISPUTES_TO_SKIP);
+  await shutterAutoReveal(disputeKitGatedShutter, DISPUTES_TO_SKIP);
 }
 
 if (require.main === module) {