feat: keeper bot passes the period to Voting before auto-revealing

and support for the Shutter testnet API endpoint

Author: jaybuidl

contracts/scripts/keeperBot.ts

@@ -71,6 +71,16 @@ type CustomError = {
   errorSignature: string;
 };
 
+enum Period {
+  EVIDENCE = "evidence",
+  COMMIT = "commit",
+  VOTE = "vote",
+  APPEAL = "appeal",
+  EXECUTION = "execution",
+}
+
+const PERIODS = Object.values(Period);
+
 enum Phase {
   STAKING = "staking",
   GENERATING = "generating",
@@ -484,6 +494,10 @@ const filterDisputesToSkip = (disputes: Dispute[]) => {
   return disputes.filter((dispute) => !DISPUTES_TO_SKIP.includes(dispute.id));
 };
 
+const filterDisputesByPeriod = (disputes: Dispute[], period: Period) => {
+  return disputes.filter((dispute) => dispute.period === period);
+};
+
 const mapAsync = <T, U>(array: T[], callbackfn: (value: T, index: number, array: T[]) => Promise<U>): Promise<U[]> => {
   return Promise.all(array.map(callbackfn));
 };
@@ -554,14 +568,6 @@ async function main() {
 
   await sendHeartbeat();
 
-  logger.info("Auto-revealing disputes");
-  await shutterAutoReveal(disputeKitShutter, DISPUTES_TO_SKIP);
-  if (SHUTTER_AUTO_REVEAL_ONLY) {
-    logger.debug("Shutter auto-reveal only, skipping other actions");
-    await shutdown();
-    return;
-  }
-
   logger.info(`Current phase: ${PHASES[getNumber(await sortition.phase())]}`);
 
   // Retrieve the disputes which are in a non-final period
@@ -588,6 +594,22 @@ async function main() {
   for (const dispute of disputes) {
     logger.info(`Dispute #${dispute.id}, round #${dispute.currentRoundIndex}, ${dispute.period} period`);
   }
+
+  // ----------------------------------------------- //
+  //                  AUTO-REVEAL                    //
+  // ----------------------------------------------- //
+  logger.info("Auto-revealing disputes");
+  // Ensure that the disputes ready to be auto-revealed are passed to the voting period otherwise they won't be picked up.
+  for (const dispute of filterDisputesByPeriod(filterDisputesToSkip(disputes), Period.COMMIT)) {
+    await passPeriod(dispute);
+  }
+  await shutterAutoReveal(disputeKitShutter, DISPUTES_TO_SKIP);
+  if (SHUTTER_AUTO_REVEAL_ONLY) {
+    logger.debug("Shutter auto-reveal only, skipping other actions");
+    await shutdown();
+    return;
+  }
+
   logger.info(`Disputes needing more jurors: ${disputesWithoutJurors.map((dispute) => dispute.id)}`);
   if ((await hasMinStakingTimePassed()) && disputesWithoutJurors.length > 0) {
     // ----------------------------------------------- //

contracts/scripts/keeperBotShutter.ts

@@ -176,11 +176,13 @@ const getShutterDisputesToReveal = async (disputeKitShutter: DisputeKitShutter):
     };
   });
 
-  // Filter out the votes where commited is false or voted is true
-  const filteredDisputeVotes = disputeVotes.map((item) => ({
-    ...item,
-    votes: item.votes.filter((vote) => vote.commited && !vote.voted),
-  }));
+  // Filter out the disputes without votes and the votes where committed is false or voted is true
+  const filteredDisputeVotes = disputeVotes
+    .map((item) => ({
+      ...item,
+      votes: item.votes.filter((vote) => vote.commited && !vote.voted),
+    }))
+    .filter((item) => item.votes.length > 0);
 
   return filteredDisputeVotes;
 };

contracts/scripts/shutter.ts

@@ -2,10 +2,18 @@ import { encryptData, decrypt as shutterDecrypt } from "@shutter-network/shutter
 import { Hex, stringToHex, hexToString } from "viem";
 import crypto from "crypto";
 import "isomorphic-fetch";
+import env from "./utils/env";
 
 // Time in seconds to wait before the message can be decrypted
 export const DECRYPTION_DELAY = 5;
 
+const SHUTTER_API_URL = {
+  mainnet: "https://shutter-api.shutter.network",
+  testnet: "https://shutter-api.chiado.staging.shutter.network",
+};
+
+const SHUTTER_API = env.optional("SHUTTER_API", "mainnet") as keyof typeof SHUTTER_API_URL;
+
 interface ShutterApiMessageData {
   eon: number;
   identity: string;
@@ -38,7 +46,7 @@ async function fetchShutterData(decryptionTimestamp: number): Promise<ShutterApi
     const identityPrefix = generateRandomBytes32();
     console.log(`Generated identity prefix: ${identityPrefix}`);
 
-    const response = await fetch("https://shutter-api.shutter.network/api/register_identity", {
+    const response = await fetch(`${SHUTTER_API_URL[SHUTTER_API]}/api/register_identity`, {
       method: "POST",
       headers: {
         accept: "application/json",
@@ -88,7 +96,7 @@ async function fetchShutterData(decryptionTimestamp: number): Promise<ShutterApi
 async function fetchDecryptionKey(identity: string): Promise<ShutterDecryptionKeyData> {
   console.log(`Fetching decryption key for identity: ${identity}`);
 
-  const response = await fetch(`https://shutter-api.shutter.network/api/get_decryption_key?identity=${identity}`, {
+  const response = await fetch(`${SHUTTER_API_URL[SHUTTER_API]}/api/get_decryption_key?identity=${identity}`, {
     method: "GET",
     headers: {
       accept: "application/json",
@@ -232,6 +240,7 @@ Examples:
           console.error("Usage: yarn ts-node shutter.ts encrypt <message>");
           process.exit(1);
         }
+        console.log(`Using Shutter API ${SHUTTER_API_URL[SHUTTER_API]}...`);
         const { encryptedCommitment, identity } = await encrypt(message);
         console.log("\nEncrypted Commitment:", encryptedCommitment);
         console.log("Identity:", identity);
@@ -245,6 +254,7 @@ Examples:
           console.error("Note: The identity is the one returned during encryption");
           process.exit(1);
         }
+        console.log(`Using Shutter API ${SHUTTER_API_URL[SHUTTER_API]}...`);
         const decryptedMessage = await decrypt(encryptedMessage, identity);
         console.log("\nDecrypted Message:", decryptedMessage);
         break;