add link to explorer page for listed transactions

NomicFoundation · Dec 17, 2024 · 6678bfe · 6678bfe
1 parent c56e784
commit 6678bfe
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 32 deletions.
diff --git a/packages/core/src/list-transactions.ts b/packages/core/src/list-transactions.ts
@@ -77,7 +77,7 @@ export async function listTransactions(
       (tx) => tx.hash === message.transaction.hash
     );
 
-    const browserURL = builtinChains.find(
+    const browserUrl = builtinChains.find(
       ({ chainId }) => chainId === deploymentState.chainId
     );
 
@@ -102,10 +102,7 @@ export async function listTransactions(
               : undefined,
           params: exState.constructorArgs,
           value: networkInteraction.value,
-          transactionLink: getTransactionLink(
-            transaction.hash,
-            browserURL?.urls.browserURL
-          ),
+          browserUrl: browserUrl?.urls.browserURL,
         });
 
         break;
@@ -127,10 +124,7 @@ export async function listTransactions(
           to: networkInteraction.to,
           params: exState.args,
           value: networkInteraction.value,
-          transactionLink: getTransactionLink(
-            transaction.hash,
-            browserURL?.urls.browserURL
-          ),
+          browserUrl: browserUrl?.urls.browserURL,
         });
 
         break;
@@ -146,10 +140,7 @@ export async function listTransactions(
           ),
           to: networkInteraction.to,
           value: networkInteraction.value,
-          transactionLink: getTransactionLink(
-            transaction.hash,
-            browserURL?.urls.browserURL
-          ),
+          browserUrl: browserUrl?.urls.browserURL,
         });
 
         break;
@@ -191,14 +182,3 @@ function getTransactionStatus(
 
   return TransactionStatus.FAILURE;
 }
-
-function getTransactionLink(
-  txHash: string,
-  browserURL?: string
-): string | undefined {
-  if (browserURL === undefined) {
-    return undefined;
-  }
-
-  return `\\033]8;;${browserURL}/tx/${txHash}\\\\033\\\\🔗 view on block explorer\\033]8;;\\033\\\\\\n`;
-}
diff --git a/packages/core/src/types/list-transactions.ts b/packages/core/src/types/list-transactions.ts
@@ -27,7 +27,7 @@ export interface TransactionInfo {
   address?: string;
   params?: SolidityParameterType[];
   value?: bigint;
-  transactionLink?: string;
+  browserUrl?: string;
 }
 
 /**

diff --git a/packages/hardhat-plugin/src/index.ts b/packages/hardhat-plugin/src/index.ts
@@ -58,6 +58,7 @@ extendConfig((config, userConfig) => {
       maxPriorityFeePerGas: userNetworkConfig.ignition?.maxPriorityFeePerGas,
       gasPrice: userNetworkConfig.ignition?.gasPrice,
       disableFeeBumping: userNetworkConfig.ignition?.disableFeeBumping,
+      explorerUrl: userNetworkConfig.ignition?.explorerUrl,
     };
   });
 
@@ -717,7 +718,11 @@ ignitionScope
     }
 
     console.log(
-      calculateListTransactionsDisplay(deploymentId, listTransactionsResult)
+      calculateListTransactionsDisplay(
+        deploymentId,
+        listTransactionsResult,
+        hre.config.networks[hre.network.name]?.ignition?.explorerUrl
+      )
     );
   });
 

diff --git a/packages/hardhat-plugin/src/type-extensions.ts b/packages/hardhat-plugin/src/type-extensions.ts
@@ -19,6 +19,7 @@ declare module "hardhat/types/config" {
       maxPriorityFeePerGas?: bigint;
       gasPrice?: bigint;
       disableFeeBumping?: boolean;
+      explorerUrl?: string;
     };
   }
 
@@ -28,6 +29,7 @@ declare module "hardhat/types/config" {
       maxPriorityFeePerGas?: bigint;
       gasPrice?: bigint;
       disableFeeBumping?: boolean;
+      explorerUrl?: string;
     };
   }
 
@@ -37,6 +39,7 @@ declare module "hardhat/types/config" {
       maxPriorityFeePerGas?: bigint;
       gasPrice?: bigint;
       disableFeeBumping?: boolean;
+      explorerUrl?: string;
     };
   }
 
@@ -46,6 +49,7 @@ declare module "hardhat/types/config" {
       maxPriorityFeePerGas?: bigint;
       gasPrice?: bigint;
       disableFeeBumping?: boolean;
+      explorerUrl?: string;
     };
   }
 

diff --git a/packages/hardhat-plugin/src/ui/helpers/calculate-list-transactions-display.ts b/packages/hardhat-plugin/src/ui/helpers/calculate-list-transactions-display.ts
@@ -4,16 +4,18 @@ import { stringify } from "json5";
 
 export function calculateListTransactionsDisplay(
   deploymentId: string,
-  listTransactionsResult: ListTransactionsResult
+  listTransactionsResult: ListTransactionsResult,
+  configUrl?: string
 ): string {
   let text = `Logging transactions for deployment ${deploymentId}\n\n`;
 
   for (const [index, transaction] of listTransactionsResult.entries()) {
-    text += `Transaction ${index + 1}${
-      transaction.transactionLink !== undefined
-        ? ` (${transaction.transactionLink}):`
-        : ":"
-    }\n`;
+    const txLink = getTransactionLink(
+      transaction.txHash,
+      configUrl ?? transaction.browserUrl
+    );
+
+    text += `Transaction ${index + 1}${txLink === undefined ? "" : txLink}:\n`;
     text += `  - Type: ${transactionTypeToDisplayType(transaction.type)}\n`;
     text += `  - Status: ${transaction.status}\n`;
     text += `  - TxHash: ${transaction.txHash}\n`;
@@ -74,3 +76,14 @@ export function transactionDisplaySerializeReplacer(
 
   return value;
 }
+
+function getTransactionLink(
+  txHash: string,
+  browserURL?: string
+): string | undefined {
+  if (browserURL === undefined) {
+    return undefined;
+  }
+
+  return `\x1b]8;;${browserURL}/tx/${txHash}\x1b\\ (🔗 view on block explorer)\x1b]8;;\x1b\\`;
+}