fix: stringify unknown errors better (#712)

<!-- start pr-codex -->

## PR-Codex overview
This PR focuses on enhancing error handling in the codebase by introducing a new `prettifyError` function and updating existing error formatting to use this function. It also adds a `prettifyTransactionError` function for transaction-specific errors.

### Detailed summary
- Added `prettifyError` function in `src/utils/error.ts` for improved error message formatting.
- Removed the old `formatError` function in `src/server/middleware/error.ts`.
- Updated error handling in `src/utils/transaction/queueTransaction.ts` to use `prettifyError`.
- Updated error handling in `src/server/routes/contract/write/write.ts` to use `prettifyError`.
- Updated error message formatting in `src/worker/tasks/sendTransactionWorker.ts` to use `prettifyError`.
- Introduced `prettifyTransactionError` function in `src/utils/error.ts` for transaction error handling.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

<!-- end pr-codex -->

Author: arcoraven

src/server/middleware/error.ts

@@ -1,6 +1,5 @@
 import type { FastifyInstance } from "fastify";
 import { ReasonPhrases, StatusCodes } from "http-status-codes";
-import { stringify } from "thirdweb/utils";
 import { ZodError } from "zod";
 import { env } from "../../utils/env";
 import { parseEthersError } from "../../utils/ethers";
@@ -22,13 +21,6 @@ export const createCustomError = (
   code,
 });
 
-export function formatError(error: unknown) {
-  if (error instanceof Error) {
-    return error.message;
-  }
-  return stringify(error);
-}
-
 export const customDateTimestampError = (date: string): CustomError =>
   createCustomError(
     `Invalid date: ${date}. Needs to new Date() / new Date().toISOstring() / new Date().getTime() / Unix Epoch`,

src/server/routes/contract/write/write.ts

@@ -1,11 +1,12 @@
-import { type Static, Type } from "@sinclair/typebox";
+import { Type, type Static } from "@sinclair/typebox";
 import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { prepareContractCall, resolveMethod } from "thirdweb";
 import type { AbiFunction } from "thirdweb/utils";
 import { getContractV5 } from "../../../../utils/cache/getContractv5";
+import { prettifyError } from "../../../../utils/error";
 import { queueTransaction } from "../../../../utils/transaction/queueTransation";
-import { createCustomError, formatError } from "../../../middleware/error";
+import { createCustomError } from "../../../middleware/error";
 import { abiArraySchema } from "../../../schemas/contract";
 import {
   contractParamSchema,
@@ -85,7 +86,7 @@ export async function writeToContract(fastify: FastifyInstance) {
         method = await resolveMethod(functionName)(contract);
       } catch (e) {
         throw createCustomError(
-          formatError(e),
+          prettifyError(e),
           StatusCodes.BAD_REQUEST,
           "BAD_REQUEST",
         );

src/utils/error.ts

@@ -1,11 +1,19 @@
 import { ethers } from "ethers";
 import { getChainMetadata } from "thirdweb/chains";
+import { stringify } from "thirdweb/utils";
 import { getChain } from "./chain";
 import { isEthersErrorCode } from "./ethers";
 import { doSimulateTransaction } from "./transaction/simulateQueuedTransaction";
 import type { AnyTransaction } from "./transaction/types";
 
-export const prettifyError = async (
+export const prettifyError = (error: unknown): string => {
+  if (error instanceof Error) {
+    return error.message;
+  }
+  return stringify(error);
+};
+
+export const prettifyTransactionError = async (
   transaction: AnyTransaction,
   error: Error,
 ): Promise<string> => {

src/utils/transaction/queueTransation.ts

@@ -6,10 +6,10 @@ import {
   type PreparedTransaction,
   encode,
 } from "thirdweb";
-import { stringify } from "thirdweb/utils";
 import { createCustomError } from "../../server/middleware/error";
 import type { txOverridesWithValueSchema } from "../../server/schemas/txOverrides";
 import { parseTransactionOverrides } from "../../server/utils/transactionOverrides";
+import { prettifyError } from "../error";
 import { insertTransaction } from "./insertTransaction";
 import type { InsertedTransaction } from "./types";
 
@@ -43,7 +43,7 @@ export async function queueTransaction(args: QueuedTransactionParams) {
     data = await encode(transaction);
   } catch (e) {
     throw createCustomError(
-      stringify(e),
+      prettifyError(e),
       StatusCodes.BAD_REQUEST,
       "BAD_REQUEST",
     );

src/worker/tasks/sendTransactionWorker.ts

@@ -21,6 +21,7 @@ import {
   isNonceAlreadyUsedError,
   isReplacementGasFeeTooLow,
   prettifyError,
+  prettifyTransactionError,
 } from "../../utils/error";
 import { getChecksumAddress } from "../../utils/primitiveTypes";
 import { recordMetrics } from "../../utils/prometheus";
@@ -151,7 +152,7 @@ const _sendUserOp = async (
     const erroredTransaction: ErroredTransaction = {
       ...queuedTransaction,
       status: "errored",
-      errorMessage: stringify(e),
+      errorMessage: prettifyError(e),
     };
     job.log(
       `Failed to populate transaction: ${erroredTransaction.errorMessage}`,
@@ -231,7 +232,7 @@ const _sendTransaction = async (
     const erroredTransaction: ErroredTransaction = {
       ...queuedTransaction,
       status: "errored",
-      errorMessage: stringify(e),
+      errorMessage: prettifyError(e),
     };
     job.log(
       `Failed to populate transaction: ${erroredTransaction.errorMessage}`,
@@ -476,7 +477,7 @@ export const initSendTransactionWorker = () => {
         const erroredTransaction: ErroredTransaction = {
           ...transaction,
           status: "errored",
-          errorMessage: await prettifyError(transaction, error),
+          errorMessage: await prettifyTransactionError(transaction, error),
         };
         job.log(`Transaction errored: ${stringify(erroredTransaction)}`);