Merge pull request #5 from kleros/feat/safe-tx-batcher

Safe transaction batcher

Author: jaybuidl

snapshots/cli.js

@@ -6,10 +6,9 @@ import { hideBin } from "yargs/helpers";
 import dayjs from "dayjs";
 import utc from "dayjs/plugin/utc.js";
 import { createSnapshotCreator } from "./src/create-snapshot-from-block-limits.js";
-import { formatEther } from "ethers/lib/utils.js";
 import fs from "fs";
 import { fileToIpfs } from "./src/fileToIpfs.js";
-
+import { addTransactionToBatch, writeTransactionBatch } from "./src/helpers/tx-builder.js";
 dotenv.config();
 
 dayjs.extend(utc);
@@ -18,24 +17,28 @@ const chains = [
   // ONLY uncomment Arbitrum Sepolia if you are testing
   // {
   //   chainId: 421614,
+  //   chainShortName: "arb-sep", // https://chainid.network/shortNameMapping.json
   //   blocksPerSecond: 0.268,
   //   klerosCoreAddress: "0xA54e7A16d7460e38a8F324eF46782FB520d58CE8",
   //   token: "0x34B944D42cAcfC8266955D07A80181D2054aa225",
   //   pnkDropRatio: BigNumber.from("1000000000"),
   //   fromBlock: 3638878,
   //   provider: getDefaultProvider(process.env.INFURA_ARB_SEPOLIA_RPC),
   //   merkleDropAddress: "0x93024F2D53D180074F4575818dE3E8dcE8147CF2",
+  //   safeAddress: "0x66e8DE9B42308c6Ca913D1EE041d6F6fD037A57e", // Safe not supported on Arbitrum Sepolia
   // },
   {
     chainId: 42161,
+    chainShortName: "arb", // https://chainid.network/shortNameMapping.json
     blocksPerSecond: 0.26,
     klerosCoreAddress: "0x991d2df165670b9cac3B022f4B68D65b664222ea",
     token: "0x330bD769382cFc6d50175903434CCC8D206DCAE5",
     pnkDropRatio: BigNumber.from("1000000000"),
     fromBlock: 272063254,
     provider: getDefaultProvider(process.env.INFURA_ARB_ONE_RPC),
-    merkleDropAddress: "0x2a23B84078b287753A91C522c3bB3b6B32f6F8f1"
-  }
+    merkleDropAddress: "0x2a23B84078b287753A91C522c3bB3b6B32f6F8f1",
+    safeAddress: "0x66e8DE9B42308c6Ca913D1EE041d6F6fD037A57e",
+  },
 ];
 
 const argv = yargs(hideBin(process.argv))
@@ -167,7 +170,9 @@ const main = async () => {
     const snapshot = await createSnapshot({ fromBlock: c.fromBlock, startDate, endDate });
     snapshotInfos.push({
       // edit when arbitrum inclusion
-      filename: `${c.chainId == "42161" ? "arbitrum-" : "arbitrumSepolia-"}snapshot-${startDate.toISOString().slice(0, 7)}.json`,
+      filename: `${c.chainId == "42161" ? "arbitrum-" : "arbitrumSepolia-"}snapshot-${startDate
+        .toISOString()
+        .slice(0, 7)}.json`,
       chain: c,
       snapshot,
       period: periods[c.chainId],
@@ -185,27 +190,29 @@ const main = async () => {
   // txs to run sequentially, hardcoded section.
   console.log("PNK should be already approved to MerkleRedeem contract for each chain");
 
-  const merkleDropABI = [
-    "function seedAllocations(uint _month, bytes32 _merkleRoot, uint _totalAllocation) external"
-  ];
-
-  // Helper function to generate transaction URLs
-  const txToUrl = (tx, chainId) =>
-    `https://greenlucid.github.io/lame-tx-prompt/site?to=${tx.to}&data=${tx.data}&value=0&chainId=${chainId}`;
+  const merkleDropABI = ["function seedAllocations(uint _month, bytes32 _merkleRoot, uint _totalAllocation) external"];
 
   // Loop through snapshotInfos to generate transactions for each chain
   for (const sinfo of snapshotInfos) {
     const merkleContract = new Contract(sinfo.chain.merkleDropAddress, merkleDropABI);
 
     // Populate the seedAllocations transaction
     const tx = await merkleContract.populateTransaction.seedAllocations(
-      sinfo.period,              // The period (month) for this snapshot
+      sinfo.period, // The period (month) for this snapshot
       sinfo.snapshot.merkleTree.root, // The Merkle root from the snapshot
-      sinfo.snapshot.droppedAmount    // The total allocation to drop
+      sinfo.snapshot.droppedAmount // The total allocation to drop
     );
 
-    // Log the transaction URL for this chain
-    console.log(`Transaction for chain ${sinfo.chain.chainId}:`, txToUrl(tx, sinfo.chain.chainId));
+    addTransactionToBatch(tx);
+
+    const { chainId, chainShortName, safeAddress } = sinfo.chain;
+    writeTransactionBatch({
+      name: "Seed allocations",
+      chainId,
+      chainShortName,
+      safeAddress,
+      outputPath: `tx-batch-${chainShortName}.json`,
+    });
   }
 };
 

snapshots/src/helpers/tx-builder.js

@@ -0,0 +1,57 @@
+import fs from "fs";
+
+// Transaction batch example: https://github.com/safe-global/safe-wallet-monorepo/blob/8bbf3b82edc347b70a038629cd9afd45eb1ed38a/apps/web/cypress/fixtures/test-working-batch.json
+
+const signer = "0xBe7ee23877D530b8a17971CfDA7B5925b57e87B1";
+const transactions = [];
+
+const template = ({ name, chainId, safeAddress, transactions }) => ({
+  version: "1.0",
+  chainId,
+  createdAt: Date.now(),
+  meta: {
+    name,
+    description: "", // Not used because the Safe app doesn't show it
+    txBuilderVersion: "1.18.0",
+    createdFromSafeAddress: safeAddress,
+    createdFromOwnerAddress: signer,
+  },
+  transactions,
+});
+
+const transaction = ({ to, value, data }) => ({
+  to,
+  value: value?.toString() ?? "0",
+  data,
+  contractMethod: null,
+  contractInputsValues: null,
+});
+
+const transactionBuilderUrl = ({ chainShortName, safeAddress }) =>
+  `https://app.safe.global/apps/open?safe=${chainShortName}:${safeAddress}&appUrl=https%3A%2F%2Fapps-portal.safe.global%2Ftx-builder`;
+
+export const addTransactionToBatch = (tx) => {
+  const { to, value, data } = tx;
+  transactions.push(transaction({ to, value, data }));
+  console.log("tx = %O", tx);
+};
+
+export function writeTransactionBatch({ name, chainId, chainShortName, safeAddress, outputPath = "tx-batch.json" }) {
+  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, chainId, safeAddress, 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({ chainShortName, safeAddress })}`
+    );
+  } catch (error) {
+    throw new Error(`Failed to write transaction batch: ${error.message}`);
+  }
+}