feat: dispute kit helper

Author: jaybuidl

contracts/deployments/disputeKitsViem.ts

@@ -0,0 +1,85 @@
+import { getContracts } from "./contractsViem";
+import { Abi, AbiEvent, getAbiItem, PublicClient } from "viem";
+import { DeploymentName } from "./utils";
+
+export type DisputeKitContracts = ReturnType<typeof getContracts>;
+export type DisputeKit =
+  | NonNullable<DisputeKitContracts["disputeKitClassic"]>
+  | NonNullable<DisputeKitContracts["disputeKitShutter"]>
+  | NonNullable<DisputeKitContracts["disputeKitGated"]>
+  | NonNullable<DisputeKitContracts["disputeKitGatedShutter"]>
+  | null;
+export type DisputeKitInfos = {
+  address: `0x${string}`;
+  contract: DisputeKit;
+  isGated: boolean;
+  isShutter: boolean;
+};
+export type DisputeKitByIds = Record<string, DisputeKitInfos>;
+
+const fetchDisputeKits = async (client: PublicClient, klerosCoreAddress: `0x${string}`, klerosCoreAbi: Abi) => {
+  const DisputeKitCreated = getAbiItem({
+    abi: klerosCoreAbi,
+    name: "DisputeKitCreated",
+  }) as AbiEvent;
+  const logs = await client.getLogs({
+    address: klerosCoreAddress,
+    event: DisputeKitCreated,
+    fromBlock: 0n,
+    toBlock: "latest",
+  });
+  return Object.fromEntries(
+    logs
+      .filter((log) => {
+        const args = log.args as Record<string, unknown>;
+        return "_disputeKitID" in args && "_disputeKitAddress" in args;
+      })
+      .map((log) => {
+        const { _disputeKitID, _disputeKitAddress } = log.args as {
+          _disputeKitID: bigint;
+          _disputeKitAddress: string;
+        };
+        return {
+          disputeKitID: _disputeKitID,
+          disputeKitAddress: _disputeKitAddress,
+        };
+      })
+      .map(({ disputeKitID, disputeKitAddress }) => [disputeKitID!.toString(), disputeKitAddress as `0x${string}`])
+  );
+};
+
+export const getDisputeKits = async (client: PublicClient, deployment: DeploymentName): Promise<DisputeKitByIds> => {
+  const { klerosCore, disputeKitClassic, disputeKitShutter, disputeKitGated, disputeKitGatedShutter } = getContracts({
+    publicClient: client,
+    deployment: deployment,
+  });
+
+  const isDefined = <T>(kit: T): kit is NonNullable<T> => kit != null;
+  const disputeKitContracts = [disputeKitClassic, disputeKitShutter, disputeKitGated, disputeKitGatedShutter].filter(
+    isDefined
+  );
+  const shutterEnabled = [disputeKitShutter, disputeKitGatedShutter].filter(isDefined);
+  const gatedEnabled = [disputeKitGated, disputeKitGatedShutter].filter(isDefined);
+
+  const disputeKitMap = await fetchDisputeKits(client, klerosCore.address, klerosCore.abi);
+
+  return Object.fromEntries(
+    Object.entries(disputeKitMap).map(([disputeKitID, address]) => {
+      const contract =
+        disputeKitContracts.find((contract) => contract.address.toLowerCase() === address.toLowerCase()) ?? null;
+      return [
+        disputeKitID,
+        {
+          address,
+          contract: contract satisfies DisputeKit,
+          isGated: contract
+            ? gatedEnabled.some((gated) => contract.address.toLowerCase() === gated.address.toLowerCase())
+            : false,
+          isShutter: contract
+            ? shutterEnabled.some((shutter) => contract.address.toLowerCase() === shutter.address.toLowerCase())
+            : false,
+        },
+      ];
+    })
+  );
+};

contracts/deployments/index.ts

@@ -17,3 +17,6 @@ export * from "./utils";
 // Contracts getters
 export { getContracts as getContractsEthers } from "./contractsEthers";
 export { getContracts as getContractsViem } from "./contractsViem";
+
+// Dispute kits getters
+export { getDisputeKits as getDisputeKitsViem, type DisputeKitByIds, type DisputeKitInfos } from "./disputeKitsViem";

contracts/scripts/getDisputeKits.ts

@@ -0,0 +1,33 @@
+import { getDisputeKits } from "../deployments/disputeKitsViem";
+import { createPublicClient, http } from "viem";
+import { arbitrumSepolia } from "viem/chains";
+
+const rpc = process.env.ARBITRUM_SEPOLIA_RPC;
+if (!rpc) {
+  throw new Error("ARBITRUM_SEPOLIA_RPC is not set");
+}
+
+const client = createPublicClient({
+  chain: arbitrumSepolia,
+  transport: http(rpc),
+});
+
+async function main() {
+  try {
+    console.log("Fetching DisputeKitCreated events...");
+    const disputeKitResult = await getDisputeKits(client, "devnet");
+    console.log(disputeKitResult);
+  } catch (error) {
+    console.error("Error fetching events:", error);
+    throw error;
+  }
+}
+
+if (require.main === module) {
+  main()
+    .then(() => process.exit(0))
+    .catch((error) => {
+      console.error(error);
+      process.exit(1);
+    });
+}