feat: show clearer message if out of gas (#432)

* feat: show clearer message if out of gas

* add error to retry flow

* add chain name

* fix build

* simplify processTx a bit to be able to reuse parseTxError

* undo schema

* more cleanup

* remove unneeded try/catch

* move low balance check to be async

* undo blocknumber optimization

* Simulate + Error Message + Process Flow Update (#439)

* updates to handle RPC Calls to get tx data & block-number. Db Config update

* updates

* config updates + retry update (#434)

* updated retry query (#435)

* re-added the gas check as checkout needs this check (#436)

* reverted back the configs to original config as per chain it varies (#438)

* updated to use env

* updates for error message & simulation

* config updates + retry update (#434)

* updated retry query (#435)

* reverted back the configs to original config as per chain it varies (#438)

---------

Co-authored-by: farhanW3 <farhan@thirdweb.com>
Co-authored-by: farhanW3 <132962163+farhanW3@users.noreply.github.com>

Author: arcoraven

package.json

@@ -66,6 +66,7 @@
     "pino": "^8.15.1",
     "pino-pretty": "^10.0.0",
     "prisma": "^5.2.0",
+    "thirdweb": "^1.0.0-beta-0e947333cefd127c2ccda059c775d2975021be33-20240229054327",
     "uuidv4": "^6.2.13",
     "viem": "^1.14.0",
     "zod": "^3.21.4"

src/db/transactions/getQueuedTxs.ts

@@ -1,17 +1,14 @@
 import { Transactions } from "@prisma/client";
-import { Static } from "@sinclair/typebox";
 import { PrismaTransaction } from "../../schema/prisma";
-import { transactionResponseSchema } from "../../server/schemas/transaction";
 import { getConfig } from "../../utils/cache/getConfig";
 import { getPrismaWithPostgresTx } from "../client";
-import { cleanTxs } from "./cleanTxs";
 
 interface GetQueuedTxsParams {
   pgtx?: PrismaTransaction;
 }
 
 export const getQueuedTxs = async ({ pgtx }: GetQueuedTxsParams = {}): Promise<
-  Static<typeof transactionResponseSchema>[]
+  Transactions[]
 > => {
   const prisma = getPrismaWithPostgresTx(pgtx);
   const config = await getConfig();
@@ -35,5 +32,5 @@ export const getQueuedTxs = async ({ pgtx }: GetQueuedTxsParams = {}): Promise<
   FOR UPDATE SKIP LOCKED
   `;
 
-  return cleanTxs(txs);
+  return txs;
 };

src/db/transactions/updateTx.ts

@@ -1,4 +1,4 @@
-import { ethers } from "ethers";
+import { BigNumber, ethers } from "ethers";
 import { PrismaTransaction } from "../../schema/prisma";
 import { TransactionStatusEnum } from "../../server/schemas/transaction";
 import { getPrismaWithPostgresTx } from "../client";
@@ -24,7 +24,7 @@ type UpdateTxData =
       status: TransactionStatusEnum.Submitted;
       sentAt: Date;
       transactionHash: string;
-      res: ethers.providers.TransactionResponse | null;
+      res: ethers.providers.TransactionRequest;
       sentAtBlockNumber: number;
       retryCount?: number;
     }
@@ -90,7 +90,7 @@ export const updateTx = async ({ pgtx, queueId, data }: UpdateTxParams) => {
           transactionHash: data.transactionHash,
           sentAtBlockNumber: data.sentAtBlockNumber,
           retryCount: data.retryCount,
-          nonce: data.res?.nonce,
+          nonce: BigNumber.from(data.res.nonce).toNumber(),
           transactionType: data.res?.type || undefined,
           gasPrice: data.res?.gasPrice?.toString(),
           gasLimit: data.res?.gasLimit?.toString(),

src/server/middleware/error.ts

@@ -59,7 +59,7 @@ export const withErrorHandler = async (server: FastifyInstance) => {
       });
     } else {
       // Handle non-custom errors
-      reply.status(500).send({
+      reply.status(StatusCodes.INTERNAL_SERVER_ERROR).send({
         error: {
           statusCode: 500,
           code: "INTERNAL_SERVER_ERROR",

src/server/routes/transaction/blockchain/sendSignedUserOp.ts

@@ -2,8 +2,8 @@ import { Static, Type } from "@sinclair/typebox";
 import { Value } from "@sinclair/typebox/value";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
-import { thirdwebClientId } from "../../../../utils/api-keys";
 import { env } from "../../../../utils/env";
+import { thirdwebClientId } from "../../../../utils/sdk";
 import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 import { getChainIdFromChain } from "../../../utils/chain";
 

src/utils/date.ts

@@ -0,0 +1,10 @@
+/**
+ * Returns the milliseconds since a given past date.
+ * Returns 0 if the date is in the future.
+ * @param from A past date
+ * @returns number Milliseconds since the `from` date.
+ */
+export const msSince = (from: Date) => {
+  const ms = new Date().getTime() - from.getTime();
+  return Math.min(ms, 0);
+};

src/utils/errors.ts

@@ -0,0 +1,61 @@
+import { Transactions } from ".prisma/client";
+import { getChainByChainIdAsync } from "@thirdweb-dev/chains";
+import { ethers } from "ethers";
+import {
+  createThirdwebClient,
+  prepareTransaction,
+  simulateTransaction,
+} from "thirdweb";
+import { env } from "./env";
+
+interface EthersError {
+  reason: string;
+  code: string;
+  error: any;
+  method: string;
+  transaction: any;
+}
+
+const client = createThirdwebClient({
+  secretKey: env.THIRDWEB_API_SECRET_KEY,
+});
+
+export const parseTxError = async (
+  tx: Transactions,
+  err: any,
+): Promise<string> => {
+  if (!err) {
+    return "Unexpected error.";
+  }
+
+  const chain = await getChainByChainIdAsync(Number(tx.chainId));
+
+  if ((err as EthersError)?.code === ethers.errors.INSUFFICIENT_FUNDS) {
+    return `Insufficient ${chain.nativeCurrency?.symbol} on ${
+      chain.name
+    } in backend wallet ${tx.fromAddress!}.`;
+  }
+
+  if ((err as EthersError)?.code === ethers.errors.UNPREDICTABLE_GAS_LIMIT) {
+    try {
+      const transaction = prepareTransaction({
+        to: tx.toAddress!,
+        value: BigInt(tx.value!),
+        data: tx.data! as `0x${string}`,
+        chain: {
+          id: Number(tx.chainId!),
+          rpc: chain.rpc[0],
+        },
+        client,
+      });
+      await simulateTransaction({ transaction, from: tx.fromAddress! });
+    } catch (simErr: any) {
+      return simErr?.message ?? simErr.toString();
+    }
+  }
+
+  if ("message" in err) {
+    return err.message;
+  }
+  return err.toString();
+};

src/utils/api-keys.ts renamed to src/utils/sdk.ts

@@ -5,9 +5,9 @@ import { FastifyInstance } from "fastify";
 import { contractParamSchema } from "../server/schemas/sharedApiSchemas";
 import { walletParamSchema } from "../server/schemas/wallet";
 import { getChainIdFromChain } from "../server/utils/chain";
-import { thirdwebClientId } from "./api-keys";
 import { env } from "./env";
 import { logger } from "./logger";
+import { thirdwebClientId } from "./sdk";
 
 type CreateHeaderForRequestParams = {
   clientId: string;
@@ -29,7 +29,6 @@ export interface ReportUsageParams {
     extension?: string;
     retryCount?: number;
     provider?: string;
-    transactionValue?: string;
     msSinceQueue?: number;
     msSinceSend?: number;
   };