feat: add dry run mode for transaction validation in multisig proposal (#92)

Author: gfournierPro

.github/workflows/propose-safe-multisig-tx.yml

@@ -23,6 +23,11 @@ on:
         description: 'Transaction data/calldata'
         required: true
         type: string
+      dry-run:
+        description: 'If true, validate and prepare the transaction without proposing it'
+        required: false
+        default: false
+        type: boolean
     secrets:
       safe-proposer-private-key:
         description: 'Private key of the proposer wallet'
@@ -75,4 +80,5 @@ jobs:
           TRANSACTION_DATA: ${{ inputs.transaction-data }}
           SAFE_PROPOSER_PRIVATE_KEY: ${{ secrets.safe-proposer-private-key }}
           SAFE_API_KEY: ${{ secrets.safe-api-key }}
+          DRY_RUN: ${{ inputs.dry-run }}
         id: safe-transaction

propose-safe-multisig-tx/src/env.ts

@@ -50,6 +50,13 @@ const envSchema = z.object({
 
   // Safe API key for transaction service
   SAFE_API_KEY: z.string().min(1, "Safe API key is required"),
+
+  // Dry run mode - validate without proposing
+  DRY_RUN: z
+    .string()
+    .optional()
+    .default("false")
+    .transform((val) => val === "true" || val === "1"),
 });
 
 export const env = envSchema.parse(process.env);

propose-safe-multisig-tx/src/index.ts

@@ -15,9 +15,10 @@ async function run() {
     TRANSACTION_DATA: transactionData,
     SAFE_PROPOSER_PRIVATE_KEY: safeProposerPrivateKey,
     SAFE_API_KEY: safeApiKey,
+    DRY_RUN: dryRun,
   } = env;
 
-  core.info(`🚀 Starting Safe transaction proposal...`);
+  core.info(`🚀 Starting Safe transaction ${dryRun ? 'validation (DRY RUN)' : 'proposal'}...`);
   core.info(`📍 Safe Address: ${safeAddress}`);
   core.info(`🎯 Target Address: ${transactionTo}`);
 
@@ -60,24 +61,47 @@ async function run() {
 
   core.info(`🔐 Transaction signed - hash: ${safeTxHash}`);
 
-  await apiKit.proposeTransaction({
-    safeAddress: safeAddress,
-    safeTransactionData: safeTransaction.data,
-    safeTxHash: safeTxHash,
-    senderAddress: account.address,
-    senderSignature: signature.data,
-    origin: "GitHub Action - Propose Safe Multisig Transaction",
-  });
-
-  const transaction = await apiKit.getTransaction(safeTxHash);
-
-  core.setOutput("tx-hash", safeTxHash);
-  core.setOutput("tx-details", JSON.stringify(transaction));
-
-  core.info(`✅ Transaction proposed successfully!`);
-  core.info(`🔗 Transaction Hash: ${safeTxHash}`);
-  core.info(`⏳ Waiting for other owners to sign and execute...`);
-  core.info(`📋 Transaction Details: ${JSON.stringify(transaction, null, 2)}`);
+  if (dryRun) {
+    core.info(`🧪 DRY RUN MODE - Transaction validated but not proposed`);
+    core.info(`📋 Transaction Preview:`);
+    core.info(`   To: ${safeTransactionData.to}`);
+    core.info(`   Value: ${safeTransactionData.value}`);
+    core.info(`   Data: ${safeTransactionData.data}`);
+    core.info(`   Operation: ${safeTransactionData.operation}`);
+    
+    core.setOutput("tx-hash", safeTxHash);
+    core.setOutput("tx-details", JSON.stringify({
+      to: safeTransactionData.to,
+      value: safeTransactionData.value,
+      data: safeTransactionData.data,
+      operation: safeTransactionData.operation,
+      safeTxHash: safeTxHash,
+      senderAddress: account.address,
+      dryRun: true,
+    }));
+
+    core.info(`✅ Transaction validated successfully (not proposed)`);
+    core.info(`🔗 Transaction Hash (would be): ${safeTxHash}`);
+  } else {
+    await apiKit.proposeTransaction({
+      safeAddress: safeAddress,
+      safeTransactionData: safeTransaction.data,
+      safeTxHash: safeTxHash,
+      senderAddress: account.address,
+      senderSignature: signature.data,
+      origin: "GitHub Action - Propose Safe Multisig Transaction",
+    });
+
+    const transaction = await apiKit.getTransaction(safeTxHash);
+
+    core.setOutput("tx-hash", safeTxHash);
+    core.setOutput("tx-details", JSON.stringify(transaction));
+
+    core.info(`✅ Transaction proposed successfully!`);
+    core.info(`🔗 Transaction Hash: ${safeTxHash}`);
+    core.info(`⏳ Waiting for other owners to sign and execute...`);
+    core.info(`📋 Transaction Details: ${JSON.stringify(transaction, null, 2)}`);
+  }
 }
 
 run().catch((error) => {