fix: resolves #2767

wevm · Sep 25, 2024 · aadeada · aadeada
1 parent 5b22f60
commit aadeada
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/.changeset/many-pants-hear.md b/.changeset/many-pants-hear.md
@@ -0,0 +1,5 @@
+---
+"viem": patch
+---
+
+Added default `timeout` to `waitForTransactionReceipt`.
diff --git a/site/pages/docs/actions/public/waitForTransactionReceipt.md b/site/pages/docs/actions/public/waitForTransactionReceipt.md
@@ -134,6 +134,7 @@ const transaction = await publicClient.waitForTransactionReceipt(
 ### timeout (optional)
 
 - **Type:** `number`
+- **Default:** `180_000`
 
 Optional timeout (in milliseconds) to wait before stopping polling.
 

diff --git a/src/actions/public/waitForTransactionReceipt.ts b/src/actions/public/waitForTransactionReceipt.ts
@@ -75,7 +75,10 @@ export type WaitForTransactionReceiptParameters<
    * @default `({ count }) => ~~(1 << count) * 200` (exponential backoff)
    */
   retryDelay?: WithRetryParameters['delay'] | undefined
-  /** Optional timeout (in milliseconds) to wait before stopping polling. */
+  /**
+   * Optional timeout (in milliseconds) to wait before stopping polling.
+   * @default 180_000
+   */
   timeout?: number | undefined
 }
 
@@ -136,12 +139,11 @@ export async function waitForTransactionReceipt<
     pollingInterval = client.pollingInterval,
     retryCount = 6,
     retryDelay = ({ count }) => ~~(1 << count) * 200, // exponential backoff
-    timeout,
+    timeout = 180_000,
   }: WaitForTransactionReceiptParameters<chain>,
 ): Promise<WaitForTransactionReceiptReturnType<chain>> {
   const observerId = stringify(['waitForTransactionReceipt', client.uid, hash])
 
-  let count = 0
   let transaction: GetTransactionReturnType<chain> | undefined
   let replacedTransaction: GetTransactionReturnType<chain> | undefined
   let receipt: GetTransactionReceiptReturnType<chain>
@@ -177,12 +179,6 @@ export async function waitForTransactionReceipt<
             let blockNumber = blockNumber_
 
             if (retrying) return
-            if (count > retryCount)
-              done(() =>
-                emit.reject(
-                  new WaitForTransactionReceiptTimeoutError({ hash }),
-                ),
-              )
 
             try {
               // If we already have a valid receipt, let's check if we have enough
@@ -332,8 +328,6 @@ export async function waitForTransactionReceipt<
               } else {
                 done(() => emit.reject(err))
               }
-            } finally {
-              count++
             }
           },
         })