feat: generate a tx batch file for the transaction builder Safe app

Author: jaybuidl

contracts/scripts/populateCourts.ts

@@ -7,7 +7,7 @@ import courtsV2ArbitrumTestnet from "../config/courts.v2.testnet.json";
 import courtsV2ArbitrumDevnet from "../config/courts.v2.devnet.json";
 import courtsV2MainnetNeo from "../config/courts.v2.mainnet-neo.json";
 import { isDevnet } from "../deploy/utils";
-import { execute } from "./utils/execution";
+import { execute, writeTransactionBatch } from "./utils/execution";
 import { getContracts, Cores } from "./utils/contracts";
 
 enum HomeChains {
@@ -269,4 +269,6 @@ task("populate:courts", "Populates the courts and their parameters")
 
       await new Promise((resolve) => setTimeout(resolve, 100));
     }
+
+    writeTransactionBatch({ name: "populate-courts" });
   });

contracts/scripts/populatePolicyRegistry.ts

@@ -6,7 +6,7 @@ import policiesV2ArbitrumTestnet from "../config/policies.v2.testnet.json";
 import policiesV2ArbitrumDevnet from "../config/policies.v2.devnet.json";
 import policiesV2MainnetNeo from "../config/policies.v2.mainnet-neo.json";
 import { isDevnet } from "../deploy/utils";
-import { execute } from "./utils/execution";
+import { execute, writeTransactionBatch } from "./utils/execution";
 
 enum HomeChains {
   ARBITRUM_ONE = 42161,
@@ -112,4 +112,6 @@ task("populate:policy-registry", "Populates the policy registry for each court")
       console.log("Populating policy for %s Court (%d): %s", policy.name, policy.court, policy.uri);
       await policyRegistry.setPolicy.populateTransaction(policy.court, policy.name, policy.uri).then(execute);
     }
+
+    writeTransactionBatch({ name: "populate-policy-registry" });
   });

contracts/scripts/utils/execution.ts

@@ -1,4 +1,6 @@
 import { type ContractTransaction } from "ethers";
+import fs from "fs";
+import { type BuilderTransaction, template, transaction, transactionBuilderUrl } from "./tx-builder";
 
 const governableAbi = [
   {
@@ -16,6 +18,8 @@ const governableAbi = [
   },
 ];
 
+const transactions: BuilderTransaction[] = [];
+
 export const execute = async (tx: ContractTransaction) => {
   const hre = require("hardhat");
   const { ethers } = hre;
@@ -25,10 +29,30 @@ export const execute = async (tx: ContractTransaction) => {
   const isContract = (await ethers.provider.getCode(governor)).length > 2;
   if (isContract) {
     // Don't execute, just log the tx. It must be submitted for execution separately.
+    const { to, value, data } = tx;
+    transactions.push(transaction({ to, value, data }));
     console.log("tx = %O", tx);
   } else {
     // Execute the tx
     const signer = (await ethers.getSigners())[0];
     await signer.sendTransaction(tx);
   }
 };
+
+export function writeTransactionBatch({ name, outputPath = "tx-batch.json" }: { name: string; outputPath?: string }) {
+  if (!name?.trim()) throw new Error("Batch name is required");
+
+  if (!transactions?.length) {
+    console.log("No transaction batch to write");
+    return;
+  }
+
+  try {
+    const templateObject = template({ name, transactions });
+    fs.writeFileSync(outputPath, JSON.stringify(templateObject, null, 2));
+    console.log(`Transaction batch written to ${outputPath}`);
+    console.log(`The batch can be submitted to the Safe app at: ${transactionBuilderUrl}`);
+  } catch (error) {
+    throw new Error(`Failed to write transaction batch: ${(error as Error).message}`);
+  }
+}

contracts/scripts/utils/tx-builder.ts

@@ -0,0 +1,44 @@
+// Transaction batch example: https://github.com/safe-global/safe-wallet-monorepo/blob/8bbf3b82edc347b70a038629cd9afd45eb1ed38a/apps/web/cypress/fixtures/test-working-batch.json
+
+const governor = "0x66e8DE9B42308c6Ca913D1EE041d6F6fD037A57e";
+const deployer = "0xf1C7c037891525E360C59f708739Ac09A7670c59";
+
+export const template = ({ name, transactions }: { name: string; transactions: BuilderTransaction[] }) => ({
+  version: "1.0",
+  chainId: "42161", // Arbitrum One
+  createdAt: Date.now(),
+  meta: {
+    name,
+    description: "", // Not used because the Safe app doesn't show it
+    txBuilderVersion: "1.18.0",
+    createdFromSafeAddress: governor,
+    createdFromOwnerAddress: deployer,
+  },
+  transactions,
+});
+
+export const transaction = ({
+  to,
+  value,
+  data,
+}: {
+  to: string;
+  value: bigint | undefined;
+  data: string;
+}): BuilderTransaction => ({
+  to,
+  value: value?.toString() ?? "0",
+  data,
+  contractMethod: null,
+  contractInputsValues: null,
+});
+
+export interface BuilderTransaction {
+  to: string;
+  value: string;
+  data: string;
+  contractMethod: null;
+  contractInputsValues: null;
+}
+
+export const transactionBuilderUrl = `https://app.safe.global/apps/open?safe=arb1:${governor}&appUrl=https%3A%2F%2Fapps-portal.safe.global%2Ftx-builder`;