block confirmation options for useScaffoldContractWrite

README.md

@@ -164,6 +164,12 @@ const { writeAsync, isLoading, isMining } = useScaffoldContractWrite({
   args: ["The value to set"],
   // For payable functions, expressed in ETH
   value: "0.01",
+  // The number of block confirmations to wait for before considering transaction to be confirmed (default : 1).
+  blockConfirmations: 1,
+  // The callback function to execute when the transaction is confirmed.
+  onBlockConfirmation: (txnReceipt) => {
+    console.log("Transaction blockHash", txnReceipt.blockHash);
+  },
 });
 ```
 

packages/nextjs/components/example-ui/ContractInteraction.tsx

@@ -14,6 +14,9 @@ export const ContractInteraction = () => {
     functionName: "setGreeting",
     args: [newGreeting],
     value: "0.01",
+    onBlockConfirmation: txnReceipt => {
+      console.log("📦 Transaction blockHash", txnReceipt.blockHash);
+    },
   });
 
   return (

packages/nextjs/hooks/scaffold-eth/useScaffoldContractWrite.ts

@@ -23,6 +23,8 @@ export const useScaffoldContractWrite = <
   functionName,
   args,
   value,
+  onBlockConfirmation,
+  blockConfirmations,
   ...writeConfig
 }: UseScaffoldWriteConfig<TContractName, TFunctionName>) => {
   const { data: deployedContractData } = useDeployedContractInfo(contractName);
@@ -61,7 +63,7 @@ export const useScaffoldContractWrite = <
     if (wagmiContractWrite.writeAsync) {
       try {
         setIsMining(true);
-        await writeTx(wagmiContractWrite.writeAsync());
+        await writeTx(wagmiContractWrite.writeAsync(), { onBlockConfirmation, blockConfirmations });
       } catch (e: any) {
         const message = getParsedEthersError(e);
         notification.error(message);

packages/nextjs/hooks/scaffold-eth/useTransactor.tsx

@@ -8,7 +8,10 @@ import { getBlockExplorerTxLink, notification } from "~~/utils/scaffold-eth";
 
 type TTransactionFunc = (
   tx: Promise<SendTransactionResult> | Deferrable<TransactionRequest> | undefined,
-  callback?: ((_param: any) => void) | undefined,
+  options?: {
+    onBlockConfirmation?: (txnReceipt: TransactionReceipt) => void;
+    blockConfirmations?: number;
+  },
 ) => Promise<Record<string, any> | undefined>;
 
 /**
@@ -39,15 +42,14 @@ export const useTransactor = (_signer?: Signer): TTransactionFunc => {
     signer = data;
   }
 
-  const result: TTransactionFunc = async (tx, callback) => {
+  const result: TTransactionFunc = async (tx, options) => {
     if (!signer) {
       notification.error("Wallet/Signer not connected");
       console.error("⚡️ ~ file: useTransactor.tsx ~ error");
       return;
     }
 
     let notificationId = null;
-    let transactionReceipt: TransactionReceipt | undefined;
     let transactionResponse: SendTransactionResult | TransactionResponse | undefined;
     try {
       const provider = signer.provider;
@@ -69,7 +71,8 @@ export const useTransactor = (_signer?: Signer): TTransactionFunc => {
       notificationId = notification.loading(
         <TxnNotification message="Waiting for transaction to complete." blockExplorerLink={blockExplorerTxURL} />,
       );
-      transactionReceipt = await transactionResponse.wait();
+
+      const transactionReceipt = await transactionResponse.wait(options?.blockConfirmations);
       notification.remove(notificationId);
 
       notification.success(
@@ -79,11 +82,7 @@ export const useTransactor = (_signer?: Signer): TTransactionFunc => {
         },
       );
 
-      if (transactionReceipt) {
-        if (callback != null && transactionReceipt.blockHash != null && transactionReceipt.confirmations >= 1) {
-          callback({ ...transactionResponse, ...transactionReceipt });
-        }
-      }
+      if (options?.onBlockConfirmation) options.onBlockConfirmation(transactionReceipt);
     } catch (error: any) {
       if (notificationId) {
         notification.remove(notificationId);

packages/nextjs/utils/scaffold-eth/contract.ts

@@ -1,3 +1,4 @@
+import { TransactionReceipt } from "@ethersproject/abstract-provider";
 import {
   Abi,
   AbiParameterToPrimitiveType,
@@ -151,6 +152,8 @@ export type UseScaffoldWriteConfig<
 > = {
   contractName: TContractName;
   value?: string;
+  onBlockConfirmation?: (txnReceipt: TransactionReceipt) => void;
+  blockConfirmations?: number;
 } & IsContractsFileMissing<
   Partial<UseContractWriteConfig> & { args?: unknown[] },
   {