fixup! Add retry delay to fix dropped transaction thrashing

Author: samholmes

src/common/utxobased/engine/UtxoEngineProcessor.ts

@@ -118,12 +118,15 @@ export function makeUtxoEngineProcessor(
   // Track pending timeouts so they can be cleared on stop
   const pendingTimeouts: Set<NodeJS.Timeout> = new Set()
 
-  const clearTaskCache = (): void => {
-    // Clear all pending timeouts
+  // Clear all pending timeouts
+  const clearPendingTimeouts = (): void => {
     for (const timeoutId of pendingTimeouts) {
       clearTimeout(timeoutId)
     }
     pendingTimeouts.clear()
+  }
+
+  const clearTaskCache = (): void => {
     for (const key of Object.keys(taskCache.addressForTransactionsCache)) {
       removeItem(taskCache.addressForTransactionsCache, key)
     }
@@ -367,6 +370,7 @@ export function makeUtxoEngineProcessor(
     async stop(): Promise<void> {
       serverStates.stop()
       clearTaskCache()
+      clearPendingTimeouts()
       running = false
     },
 
@@ -1167,13 +1171,15 @@ async function* processCheckTransactionConfirmation(
     // Delay putting the transaction back into the cache to avoid thrashing
     // on dropped transactions. 10 seconds is a reasonable compromise between
     // thrashing and not waiting too long.
-    const timeoutId = setTimeout(() => {
-      common.pendingTimeouts.delete(timeoutId)
-      common.taskCache.transactionUpdateCache[txId] = {
-        processing: false
-      }
-    }, 10000)
-    common.pendingTimeouts.add(timeoutId)
+    addPendingTimeout(
+      common,
+      () => {
+        common.taskCache.transactionUpdateCache[txId] = {
+          processing: false
+        }
+      },
+      10000
+    )
     return false
   }
 }
@@ -1698,3 +1704,22 @@ const addToDataLayerUtxoCache = (
   dataLayerUtxoCache[scriptPubkey] = dataLayerUtxos
   dataLayerUtxos.full = dataLayerUtxos.utxos.length >= requiredCount
 }
+
+/**
+ * This adds a pending timeout to the common.pendingTimeouts set.
+ * It will call the callback after the timeout.
+ *
+ * This utility is a safe way to add pending timeouts for the processor because
+ * it will clear the timeout when the processor stops.
+ */
+const addPendingTimeout = (
+  common: CommonParams,
+  callback: () => void,
+  timeout: number
+): void => {
+  const timeoutId = setTimeout(() => {
+    common.pendingTimeouts.delete(timeoutId)
+    callback()
+  }, timeout)
+  common.pendingTimeouts.add(timeoutId)
+}