fix: withdraw and transfer 5xxs (#672)

* fix: withdraw and transfer 5xxs

* remove debug line

* add biome, fix spacing

* wip

* increase gas, log error

* tx overrides

Author: arcoraven

biome.json

@@ -27,4 +27,4 @@
       }
     }
   }
-}
+}

src/server/routes/backend-wallet/transfer.ts

@@ -1,22 +1,23 @@
-import { Static, Type } from "@sinclair/typebox";
-import { FastifyInstance } from "fastify";
+import { Type, type Static } from "@sinclair/typebox";
+import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import {
-  Address,
   NATIVE_TOKEN_ADDRESS,
   ZERO_ADDRESS,
   getContract,
   toWei,
+  type Address,
 } from "thirdweb";
 import { transfer as transferERC20 } from "thirdweb/extensions/erc20";
 import { isContractDeployed, resolvePromisedValue } from "thirdweb/utils";
 import { getChain } from "../../../utils/chain";
 import { maybeBigInt, normalizeAddress } from "../../../utils/primitiveTypes";
 import { thirdwebClient } from "../../../utils/sdk";
 import { insertTransaction } from "../../../utils/transaction/insertTransaction";
-import { InsertedTransaction } from "../../../utils/transaction/types";
+import type { InsertedTransaction } from "../../../utils/transaction/types";
 import { createCustomError } from "../../middleware/error";
 import { AddressSchema } from "../../schemas/address";
+import { TokenAmountStringSchema } from "../../schemas/number";
 import {
   requestQuerystringSchema,
   standardResponseSchema,
@@ -43,10 +44,11 @@ const requestBodySchema = Type.Object({
     description:
       "The token address to transfer. Omit to transfer the chain's native currency (e.g. ETH on Ethereum).",
   }),
-  amount: Type.String({
+  amount: {
+    ...TokenAmountStringSchema,
     description:
       'The amount in ether to transfer. Example: "0.1" to send 0.1 ETH.',
-  }),
+  },
   ...txOverridesWithValueSchema.properties,
 });
 

src/server/routes/backend-wallet/withdraw.ts

@@ -1,21 +1,27 @@
-import { Static, Type } from "@sinclair/typebox";
-import { FastifyInstance } from "fastify";
+import { Type, type Static } from "@sinclair/typebox";
+import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import {
-  Address,
-  estimateGasCost,
-  prepareTransaction,
-  sendTransaction,
+  toSerializableTransaction,
+  toTokens,
+  type Address,
+  type Hex,
 } from "thirdweb";
+import { getChainMetadata } from "thirdweb/chains";
 import { getWalletBalance } from "thirdweb/wallets";
 import { getAccount } from "../../../utils/account";
 import { getChain } from "../../../utils/chain";
+import { logger } from "../../../utils/logger";
+import { getChecksumAddress, maybeBigInt } from "../../../utils/primitiveTypes";
 import { thirdwebClient } from "../../../utils/sdk";
-import { AddressSchema } from "../../schemas/address";
+import { createCustomError } from "../../middleware/error";
+import { AddressSchema, TransactionHashSchema } from "../../schemas/address";
+import { TokenAmountStringSchema } from "../../schemas/number";
 import {
   requestQuerystringSchema,
   standardResponseSchema,
 } from "../../schemas/sharedApiSchemas";
+import { txOverridesSchema } from "../../schemas/txOverrides";
 import {
   walletHeaderSchema,
   walletWithAddressParamSchema,
@@ -29,11 +35,13 @@ const requestBodySchema = Type.Object({
     ...AddressSchema,
     description: "Address to withdraw all funds to",
   },
+  ...txOverridesSchema.properties,
 });
 
 const responseBodySchema = Type.Object({
   result: Type.Object({
-    transactionHash: Type.String(),
+    transactionHash: TransactionHashSchema,
+    amount: TokenAmountStringSchema,
   }),
 });
 
@@ -62,45 +70,69 @@ export async function withdraw(fastify: FastifyInstance) {
     },
     handler: async (request, reply) => {
       const { chain: chainQuery } = request.params;
-      const { toAddress } = request.body;
-      const {
-        "x-backend-wallet-address": walletAddress,
-        "x-idempotency-key": idempotencyKey,
-      } = request.headers as Static<typeof walletHeaderSchema>;
+      const { toAddress, txOverrides } = request.body;
+      const { "x-backend-wallet-address": walletAddress } =
+        request.headers as Static<typeof walletHeaderSchema>;
 
       const chainId = await getChainIdFromChain(chainQuery);
       const chain = await getChain(chainId);
-      const from = walletAddress as Address;
+      const from = getChecksumAddress(walletAddress);
+
+      // Populate a transfer transaction with 2x gas.
+      const populatedTransaction = await toSerializableTransaction({
+        from,
+        transaction: {
+          to: toAddress,
+          chain,
+          client: thirdwebClient,
+          data: "0x",
+          // Dummy value, replaced below.
+          value: 1n,
+          gas: maybeBigInt(txOverrides?.gas),
+          maxFeePerGas: maybeBigInt(txOverrides?.maxFeePerGas),
+          maxPriorityFeePerGas: maybeBigInt(txOverrides?.maxPriorityFeePerGas),
+        },
+      });
+
+      // Compute the maximum amount to withdraw taking into account gas fees.
+      const value = await getWithdrawValue(from, populatedTransaction);
+      populatedTransaction.value = value;
 
       const account = await getAccount({ chainId, from });
-      const value = await getWithdrawValue({ chainId, from });
+      let transactionHash: Hex | undefined;
+      try {
+        const res = await account.sendTransaction(populatedTransaction);
+        transactionHash = res.transactionHash;
+      } catch (e) {
+        logger({
+          level: "warn",
+          message: `Error withdrawing funds: ${e}`,
+          service: "server",
+        });
 
-      const transaction = prepareTransaction({
-        to: toAddress,
-        chain,
-        client: thirdwebClient,
-        value,
-      });
-      const { transactionHash } = await sendTransaction({
-        account,
-        transaction,
-      });
+        const metadata = await getChainMetadata(chain);
+        throw createCustomError(
+          `Insufficient ${metadata.nativeCurrency?.symbol} on ${metadata.name} in ${from}. Try again when network gas fees are lower. See: https://portal.thirdweb.com/engine/troubleshooting`,
+          StatusCodes.BAD_REQUEST,
+          "INSUFFICIENT_FUNDS",
+        );
+      }
 
       reply.status(StatusCodes.OK).send({
         result: {
           transactionHash,
+          amount: toTokens(value, 18),
         },
       });
     },
   });
 }
 
-const getWithdrawValue = async (args: {
-  chainId: number;
-  from: Address;
-}): Promise<bigint> => {
-  const { chainId, from } = args;
-  const chain = await getChain(chainId);
+const getWithdrawValue = async (
+  from: Address,
+  populatedTransaction: Awaited<ReturnType<typeof toSerializableTransaction>>,
+): Promise<bigint> => {
+  const chain = await getChain(populatedTransaction.chainId);
 
   // Get wallet balance.
   const { value: balanceWei } = await getWalletBalance({
@@ -109,17 +141,13 @@ const getWithdrawValue = async (args: {
     chain,
   });
 
-  // Estimate gas for a transfer.
-  const transaction = prepareTransaction({
-    chain,
-    client: thirdwebClient,
-    value: 1n, // dummy value
-    to: from, // dummy value
-  });
-  const { wei: transferCostWei } = await estimateGasCost({ transaction });
-
-  // Add a +20% buffer for gas variance.
-  const buffer = transferCostWei / 5n;
+  // Set the withdraw value to be the amount of gas that isn't reserved to send the transaction.
+  const gasPrice =
+    populatedTransaction.maxFeePerGas ?? populatedTransaction.gasPrice;
+  if (!gasPrice) {
+    throw new Error("Unable to estimate gas price for withdraw request.");
+  }
 
-  return balanceWei - transferCostWei - buffer;
+  const transferCostWei = populatedTransaction.gas * gasPrice;
+  return balanceWei - transferCostWei;
 };

src/server/schemas/number.ts

@@ -0,0 +1,11 @@
+import { Type } from "@sinclair/typebox";
+
+export const TokenAmountStringSchema = Type.RegExp(/^\d+(\.\d+)?$/, {
+  description: 'An amount in native token (decimals allowed). Example: "1.5"',
+  examples: ["0.1"],
+});
+
+export const WeiAmountStringSchema = Type.RegExp(/^\d+$/, {
+  description: 'An amount in wei (no decimals). Example: "100000000"',
+  examples: ["0"],
+});

src/utils/error.ts

@@ -3,14 +3,14 @@ import { getChainMetadata } from "thirdweb/chains";
 import { getChain } from "./chain";
 import { isEthersErrorCode } from "./ethers";
 import { doSimulateTransaction } from "./transaction/simulateQueuedTransaction";
-import { AnyTransaction } from "./transaction/types";
+import type { AnyTransaction } from "./transaction/types";
 
 export const prettifyError = async (
   transaction: AnyTransaction,
   error: Error,
 ): Promise<string> => {
   if (!transaction.isUserOp) {
-    if (isEthersErrorCode(error, ethers.errors.INSUFFICIENT_FUNDS)) {
+    if (isInsufficientFundsError(error)) {
       const chain = await getChain(transaction.chainId);
       const metadata = await getChainMetadata(chain);
       return `Insufficient ${metadata.nativeCurrency?.symbol} on ${metadata.name} in ${transaction.from}.`;
@@ -51,3 +51,14 @@ export const isReplacementGasFeeTooLow = (error: unknown) => {
   }
   return isEthersErrorCode(error, ethers.errors.REPLACEMENT_UNDERPRICED);
 };
+
+export const isInsufficientFundsError = (error: unknown) => {
+  const message = _parseMessage(error);
+  if (message) {
+    return (
+      message.includes("insufficient funds for gas * price + value") ||
+      message.includes("insufficient funds for intrinsic transaction cost")
+    );
+  }
+  return isEthersErrorCode(error, ethers.errors.INSUFFICIENT_FUNDS);
+};