refactor: extracted deployment-specific wagmi configs

Author: jaybuidl

contracts/package.json

@@ -25,7 +25,10 @@
     "deploy-local": "hardhat deploy --tags Arbitration,HomeArbitrable --network localhost",
     "simulate": "hardhat simulate:all",
     "simulate-local": "hardhat simulate:all --network localhost",
-    "viem:generate": "NODE_NO_WARNINGS=1 wagmi generate",
+    "viem:generate-devnet": "NODE_NO_WARNINGS=1 wagmi generate -c wagmi.config.devnet.ts",
+    "viem:generate-testnet": "NODE_NO_WARNINGS=1 wagmi generate -c wagmi.config.testnet.ts",
+    "viem:generate-mainnet": "NODE_NO_WARNINGS=1 wagmi generate -c wagmi.config.mainnet.ts",
+    "viem:generate-hardhat": "NODE_NO_WARNINGS=1 wagmi generate -c wagmi.config.hardhat.ts",
     "viem:test": "NODE_NO_WARNINGS=1 NODE_OPTIONS=--experimental-fetch ts-node ./scripts/viem-test.ts",
     "bot:keeper": "NODE_NO_WARNINGS=1 NODE_OPTIONS=--experimental-fetch hardhat run ./scripts/keeperBot.ts",
     "bot:relayer-from-chiado": "NODE_NO_WARNINGS=1 NODE_OPTIONS=--experimental-fetch hardhat run ./scripts/disputeRelayerBotFromChiado.ts",

contracts/tsconfig.json

@@ -5,7 +5,8 @@
     "./scripts",
     "./test",
     "./typechain-types",
-    "./deploy"
+    "./deploy",
+    "./viem"
   ],
   "files": [
     "./hardhat.config.ts"

contracts/wagmi.config.devnet.ts

@@ -0,0 +1,30 @@
+import { Config, defineConfig } from "@wagmi/cli";
+import IHomeGateway from "@kleros/kleros-v2-contracts/artifacts/src/gateway/interfaces/IHomeGateway.sol/IHomeGateway.json" assert { type: "json" };
+import { getAbi, readArtifacts, merge } from "./scripts/wagmiHelpers";
+
+const getConfig = async (): Promise<Config> => {
+  const arbitrumSepoliaContracts = await readArtifacts("arbitrumSepolia", "arbitrumSepoliaDevnet");
+  arbitrumSepoliaContracts.forEach((c) => console.log("✔ Found arbitrumSepolia artifact: %s", c.name));
+  let contracts = arbitrumSepoliaContracts;
+
+  const chiadoContracts = await readArtifacts("gnosisChiado", "chiadoDevnet"); // renaming the Hardhat network improves this but breaks many other scripts
+  chiadoContracts.forEach((c) => console.log("✔ Found chiado artifact: %s", c.name));
+  contracts = merge(contracts, chiadoContracts);
+
+  const sepoliaContracts = await readArtifacts("sepolia", "sepoliaDevnet");
+  sepoliaContracts.forEach((c) => console.log("✔ Found sepolia artifact: %s", c.name));
+  contracts = merge(contracts, sepoliaContracts);
+
+  return {
+    out: "viem/generated.devnet.ts",
+    contracts: [
+      ...contracts,
+      {
+        name: "IHomeGateway",
+        abi: getAbi(IHomeGateway),
+      },
+    ],
+  };
+};
+
+export default defineConfig(getConfig);

contracts/wagmi.config.hardhat.ts

@@ -1,12 +1,14 @@
 import { defineConfig } from "@wagmi/cli";
 import { hardhat } from "@wagmi/cli/plugins";
 
+// Useful for contracts which are not deployed yet
 export default defineConfig({
   out: "viem/generated.hardhat.ts",
-  contracts: [],
   plugins: [
     hardhat({
       project: ".",
+      namePrefix: "Hardhat",
+      exclude: ["Initializable.json", "UpgradedByRewrite.json"], // These artifacts crash the wagmi cli name generator
     }),
   ],
 });

contracts/wagmi.config.mainnet.ts

@@ -0,0 +1,30 @@
+import { Config, defineConfig } from "@wagmi/cli";
+import IHomeGateway from "@kleros/kleros-v2-contracts/artifacts/src/gateway/interfaces/IHomeGateway.sol/IHomeGateway.json" assert { type: "json" };
+import { getAbi, readArtifacts, merge } from "./scripts/wagmiHelpers";
+
+const getConfig = async (): Promise<Config> => {
+  const arbitrumContracts = await readArtifacts("arbitrum");
+  arbitrumContracts.forEach((c) => console.log("✔ Found arbitrum artifact: %s", c.name));
+  let contracts = arbitrumContracts;
+
+  const gnosisContracts = await readArtifacts("gnosis", "gnosischain");
+  gnosisContracts.forEach((c) => console.log("✔ Found gnosis artifact: %s", c.name));
+  contracts = merge(contracts, gnosisContracts);
+
+  const mainnetContracts = await readArtifacts("mainnet");
+  mainnetContracts.forEach((c) => console.log("✔ Found mainnet artifact: %s", c.name));
+  contracts = merge(contracts, mainnetContracts);
+
+  return {
+    out: "viem/generated.mainnet.ts",
+    contracts: [
+      ...contracts,
+      {
+        name: "IHomeGateway",
+        abi: getAbi(IHomeGateway),
+      },
+    ],
+  };
+};
+
+export default defineConfig(getConfig);

contracts/wagmi.config.testnet.ts

@@ -0,0 +1,30 @@
+import { Config, defineConfig } from "@wagmi/cli";
+import IHomeGateway from "@kleros/kleros-v2-contracts/artifacts/src/gateway/interfaces/IHomeGateway.sol/IHomeGateway.json" assert { type: "json" };
+import { getAbi, readArtifacts, merge } from "./scripts/wagmiHelpers";
+
+const getConfig = async (): Promise<Config> => {
+  const arbitrumSepoliaContracts = await readArtifacts("arbitrumSepolia");
+  arbitrumSepoliaContracts.forEach((c) => console.log("✔ Found arbitrumSepolia artifact: %s", c.name));
+  let contracts = arbitrumSepoliaContracts;
+
+  const chiadoContracts = await readArtifacts("gnosisChiado", "chiado"); // renaming the Hardhat network improves this but breaks many other scripts
+  chiadoContracts.forEach((c) => console.log("✔ Found chiado artifact: %s", c.name));
+  contracts = merge(contracts, chiadoContracts);
+
+  const sepoliaContracts = await readArtifacts("sepolia");
+  sepoliaContracts.forEach((c) => console.log("✔ Found sepolia artifact: %s", c.name));
+  contracts = merge(contracts, sepoliaContracts);
+
+  return {
+    out: "viem/generated.testnet.ts",
+    contracts: [
+      ...contracts,
+      {
+        name: "IHomeGateway",
+        abi: getAbi(IHomeGateway),
+      },
+    ],
+  };
+};
+
+export default defineConfig(getConfig);