Merge pull request #2066 from kleros/feat/contracts-disputekits-helper

Feat: Dispute Kits helper in contracts package

Author: jaybuidl

contracts/CHANGELOG.md

@@ -4,7 +4,17 @@ All notable changes to this package will be documented in this file.
 
 The format is based on [Common Changelog](https://common-changelog.org/).
 
-## [0.11.0] - 2025-08-01
+## [0.12.0] - 2025-08-05
+
+### Changed
+
+- **Breaking:** Make `viem` a peer dependency, it should be provided by the consuming package ([`4594536`](https://github.com/kleros/kleros-v2/commit/4594536c))
+
+### Added
+
+- Add helper function `getDisputeKitsViem` to retrieve a deployment's available dispute kit infos including their capabilities (`isShutter`, `isGated`) ([`5a81f9e`](https://github.com/kleros/kleros-v2/commit/5a81f9ec))
+
+## [0.11.0] - 2025-08-02
 
 ### Changed
 
@@ -107,6 +117,7 @@ The format is based on [Common Changelog](https://common-changelog.org/).
 
 ## [0.8.1] - 2025-04-10
 
+[0.12.0]: https://github.com/kleros/kleros-v2/releases/tag/@kleros%2Fkleros-v2-contracts@0.12.0
 [0.11.0]: https://github.com/kleros/kleros-v2/releases/tag/@kleros%2Fkleros-v2-contracts@0.11.0
 [0.10.0]: https://github.com/kleros/kleros-v2/releases/tag/@kleros%2Fkleros-v2-contracts@0.10.0
 [0.9.4]: https://github.com/kleros/kleros-v2/releases/tag/@kleros%2Fkleros-v2-contracts@0.9.4

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/package.json

@@ -121,7 +121,7 @@
     "@types/mocha": "^10.0.10",
     "@types/node": "^20.17.6",
     "@types/sinon": "^17.0.4",
-    "@wagmi/cli": "^2.2.0",
+    "@wagmi/cli": "^2.3.2",
     "abitype": "^0.10.3",
     "chai": "^4.5.0",
     "dotenv": "^16.6.1",
@@ -157,7 +157,14 @@
     "@kleros/vea-contracts": "^0.6.0",
     "@openzeppelin/contracts": "^5.4.0",
     "@shutter-network/shutter-sdk": "0.0.2",
-    "isomorphic-fetch": "^3.0.0",
+    "isomorphic-fetch": "^3.0.0"
+  },
+  "peerDependencies": {
     "viem": "^2.24.1"
+  },
+  "peerDependenciesMeta": {
+    "viem": {
+      "optional": false
+    }
   }
 }

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);
+    });
+}

package.json

@@ -77,7 +77,8 @@
     "elliptic@npm:6.5.4": "npm:6.6.1",
     "word-wrap@npm:~1.2.3": "npm:1.2.5",
     "@codemirror/state": "npm:6.5.2",
-    "undici@npm:7.3.0": "npm:7.5.0"
+    "undici@npm:7.3.0": "npm:7.5.0",
+    "viem@npm:2.x": "npm:^2.23.2"
   },
   "scripts": {
     "check-prerequisites": "scripts/check-prerequisites.sh",