better handle rpc error

Author: arcoraven

src/utils/error.ts

@@ -26,3 +26,13 @@ export const prettifyError = async (
 
   return error.message;
 };
+
+export const isNonceAlreadyUsedError = (error: unknown) =>
+  (error instanceof Error &&
+    error.message.toLowerCase().includes("nonce too low")) ||
+  isEthersErrorCode(error, ethers.errors.NONCE_EXPIRED);
+
+export const isReplacementGasFeeTooLow = (error: unknown) =>
+  (error instanceof Error &&
+    error.message.toLowerCase().includes("replacement fee too low")) ||
+  isEthersErrorCode(error, ethers.errors.REPLACEMENT_UNDERPRICED);

src/worker/index.ts

@@ -9,7 +9,7 @@ import {
 } from "./listeners/webhookListener";
 
 // Init workers.
-import "./tasks/cancelUnusedNoncesWorker";
+import "./tasks/cancelRecycledNoncesWorker";
 import "./tasks/mineTransactionWorker";
 import "./tasks/processEventLogsWorker";
 import "./tasks/processTransactionReceiptsWorker";

src/worker/queues/cancelUnusedNoncesQueue.ts renamed to src/worker/queues/cancelRecycledNoncesQueue.ts

@@ -2,9 +2,9 @@ import { Queue } from "bullmq";
 import { redis } from "../../utils/redis/redis";
 import { defaultJobOptions } from "./queues";
 
-export const CANCEL_UNUSED_NONCES_QUEUE_NAME = "cancel-unused-nonces";
+export const CANCEL_RECYCLED_NONCES_QUEUE_NAME = "cancel-recycled-nonces";
 
-const _queue = new Queue<string>(CANCEL_UNUSED_NONCES_QUEUE_NAME, {
+const _queue = new Queue<string>(CANCEL_RECYCLED_NONCES_QUEUE_NAME, {
   connection: redis,
   defaultJobOptions,
 });
@@ -13,5 +13,5 @@ _queue.setGlobalConcurrency(1);
 _queue.add("hourly-cron", "", {
   repeat: { pattern: "* * * * *" },
   // Use a constant jobId to not insert multiple repeatable jobs.
-  jobId: "billing-reporter-hourly-cron",
+  jobId: "cancel-recycled-nonces-cron",
 });

src/worker/tasks/cancelUnusedNoncesWorker.ts renamed to src/worker/tasks/cancelRecycledNoncesWorker.ts

@@ -1,12 +1,11 @@
 import { Job, Processor, Worker } from "bullmq";
-import { ethers } from "ethers";
 import { Address } from "thirdweb";
 import { recycleNonce } from "../../db/wallets/walletNonce";
-import { isEthersErrorCode } from "../../utils/ethers";
+import { isNonceAlreadyUsedError } from "../../utils/error";
 import { logger } from "../../utils/logger";
 import { redis } from "../../utils/redis/redis";
 import { sendCancellationTransaction } from "../../utils/transaction/cancelTransaction";
-import { CANCEL_UNUSED_NONCES_QUEUE_NAME } from "../queues/cancelUnusedNoncesQueue";
+import { CANCEL_RECYCLED_NONCES_QUEUE_NAME } from "../queues/cancelRecycledNoncesQueue";
 import { logWorkerExceptions } from "../queues/queues";
 
 /**
@@ -33,9 +32,9 @@ const handler: Processor<any, void, string> = async (job: Job<string>) => {
             nonce,
           });
           success.push(nonce);
-        } catch (e: unknown) {
+        } catch (error: unknown) {
           // Release the nonce if it has not expired.
-          if (isEthersErrorCode(e, ethers.errors.NONCE_EXPIRED)) {
+          if (isNonceAlreadyUsedError(error)) {
             ignore.push(nonce);
           } else {
             job.log(`Recycling nonce: ${nonce}`);
@@ -73,7 +72,7 @@ const getAndDeleteUnusedNonces = async (key: string) => {
 };
 
 // Worker
-const _worker = new Worker(CANCEL_UNUSED_NONCES_QUEUE_NAME, handler, {
+const _worker = new Worker(CANCEL_RECYCLED_NONCES_QUEUE_NAME, handler, {
   concurrency: 1,
   connection: redis,
 });

src/worker/tasks/sendTransactionWorker.ts

@@ -1,6 +1,5 @@
 import assert from "assert";
 import { Job, Processor, Worker } from "bullmq";
-import { ethers } from "ethers";
 import superjson from "superjson";
 import { Hex, toSerializableTransaction } from "thirdweb";
 import { stringify } from "thirdweb/utils";
@@ -14,8 +13,11 @@ import { getBlockNumberish } from "../../utils/block";
 import { getChain } from "../../utils/chain";
 import { msSince } from "../../utils/date";
 import { env } from "../../utils/env";
-import { prettifyError } from "../../utils/error";
-import { isEthersErrorCode } from "../../utils/ethers";
+import {
+  isNonceAlreadyUsedError,
+  isReplacementGasFeeTooLow,
+  prettifyError,
+} from "../../utils/error";
 import { redis } from "../../utils/redis/redis";
 import { thirdwebClient } from "../../utils/sdk";
 import {
@@ -75,7 +77,11 @@ const handler: Processor<any, void, string> = async (job: Job<string>) => {
     if (resultTransaction.status === "sent") {
       job.log(`Transaction sent: ${stringify(resultTransaction)}.`);
       await MineTransactionQueue.add({ queueId: resultTransaction.queueId });
-      await _reportUsageSuccess(resultTransaction);
+
+      // Report usage only on the first transaction send.
+      if (transaction.status === "queued") {
+        await _reportUsageSuccess(resultTransaction);
+      }
     } else if (resultTransaction.status === "errored") {
       _reportUsageError(resultTransaction);
     }
@@ -161,8 +167,7 @@ const _sendTransaction = async (
     transactionHash = sendTransactionResult.transactionHash;
     job.log(`Sent transaction: ${transactionHash}`);
   } catch (error: unknown) {
-    // NONCE_EXPIRED indicates the nonce was already used onchain. Do not recycle it.
-    if (!isEthersErrorCode(error, ethers.errors.NONCE_EXPIRED)) {
+    if (!isNonceAlreadyUsedError(error)) {
       job.log(`Recycling nonce: ${nonce}`);
       await recycleNonce(chainId, from, nonce);
     }
@@ -234,19 +239,14 @@ const _resendTransaction = async (
     );
     transactionHash = sendTransactionResult.transactionHash;
     job.log(`Sent transaction: ${transactionHash}`);
-  } catch (error: unknown) {
-    // NONCE_EXPIRED indicates that this transaction was already mined.
-    // This is not an error.
-    if (!isEthersErrorCode(error, ethers.errors.NONCE_EXPIRED)) {
+  } catch (error) {
+    if (isNonceAlreadyUsedError(error)) {
       job.log(
-        `Nonce used. This transaction was likely already mined. Do not resend.`,
+        "Nonce used. This transaction was likely already mined. Do not resend.",
       );
       return null;
     }
-    // REPLACEMENT_UNDERPRICED indicates the mempool is already aware of this transaction
-    // with >= gas fees. Wait for that one to be mined instead.
-    // This is not an error.
-    if (!isEthersErrorCode(error, ethers.errors.REPLACEMENT_UNDERPRICED)) {
+    if (isReplacementGasFeeTooLow(error)) {
       job.log("A pending transaction exists with >= gas fees. Do not resend.");
       return null;
     }