[SDK] Improve error handling in PayEmbed

.changeset/blue-comics-doubt.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+Better error messages in PayEmbed

packages/thirdweb/src/bridge/Buy.ts

@@ -4,6 +4,7 @@ import type { ThirdwebClient } from "../client/client.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
 import { stringify } from "../utils/json.js";
+import { ApiError } from "./types/Errors.js";
 import type { PreparedQuote, Quote } from "./types/Quote.js";
 
 /**
@@ -127,9 +128,12 @@ export async function quote(options: quote.Options): Promise<quote.Result> {
   const response = await clientFetch(url.toString());
   if (!response.ok) {
     const errorJson = await response.json();
-    throw new Error(
-      `${errorJson.code} | ${errorJson.message} - ${errorJson.correlationId}`,
-    );
+    throw new ApiError({
+      code: errorJson.code || "UNKNOWN_ERROR",
+      message: errorJson.message || response.statusText,
+      correlationId: errorJson.correlationId || undefined,
+      statusCode: response.status,
+    });
   }
 
   const { data }: { data: Quote } = await response.json();
@@ -357,9 +361,12 @@ export async function prepare(
   });
   if (!response.ok) {
     const errorJson = await response.json();
-    throw new Error(
-      `${errorJson.code} | ${errorJson.message} - ${errorJson.correlationId}`,
-    );
+    throw new ApiError({
+      code: errorJson.code || "UNKNOWN_ERROR",
+      message: errorJson.message || response.statusText,
+      correlationId: errorJson.correlationId || undefined,
+      statusCode: response.status,
+    });
   }
 
   const { data }: { data: PreparedQuote } = await response.json();

packages/thirdweb/src/bridge/Chains.ts

@@ -2,6 +2,7 @@
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
 import type { Chain } from "./types/Chain.js";
+import { ApiError } from "./types/Errors.js";
 
 /**
  * Retrieves supported Universal Bridge chains.
@@ -59,7 +60,12 @@
   const response = await clientFetch(url.toString());
   if (!response.ok) {
     const errorJson = await response.json();
-    throw new Error(`${errorJson.code} | ${errorJson.message}`);
+    throw new ApiError({
+      code: errorJson.code || "UNKNOWN_ERROR",
+      message: errorJson.message || response.statusText,
+      correlationId: errorJson.correlationId || undefined,
+      statusCode: response.status,
+    });
   }
 
   const { data }: { data: Chain[] } = await response.json();

packages/thirdweb/src/bridge/Onramp.ts

@@ -3,6 +3,7 @@ import type { ThirdwebClient } from "../client/client.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
 import { stringify } from "../utils/json.js";
+import { ApiError } from "./types/Errors.js";
 import type { RouteStep } from "./types/Route.js";
 import type { Token } from "./types/Token.js";
 
@@ -191,9 +192,12 @@ export async function prepare(
 
   if (!response.ok) {
     const errorJson = await response.json();
-    throw new Error(
-      `${errorJson.code || response.status} | ${errorJson.message || response.statusText} - ${errorJson.correlationId || "N/A"}`,
-    );
+    throw new ApiError({
+      code: errorJson.code || "UNKNOWN_ERROR",
+      message: errorJson.message || response.statusText,
+      correlationId: errorJson.correlationId || undefined,
+      statusCode: response.status,
+    });
   }
 
   const { data }: { data: OnrampPrepareQuoteResponseData } =

packages/thirdweb/src/bridge/OnrampStatus.ts

@@ -2,6 +2,7 @@
 import type { ThirdwebClient } from "../client/client.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
+import { ApiError } from "./types/Errors.js";
 
 /**
  * Retrieves the status of an Onramp session created via {@link Bridge.Onramp.prepare}. The
@@ -72,9 +73,12 @@
   const response = await clientFetch(url.toString());
   if (!response.ok) {
     const errorJson = await response.json();
-    throw new Error(
-      `${errorJson.code || response.status} | ${errorJson.message || response.statusText} - ${errorJson.correlationId || "N/A"}`,
-    );
+    throw new ApiError({
+      code: errorJson.code || "UNKNOWN_ERROR",
+      message: errorJson.message || response.statusText,
+      correlationId: errorJson.correlationId || undefined,
+      statusCode: response.status,
+    });
   }
 
   const { data }: { data: status.Result } = await response.json();

packages/thirdweb/src/bridge/Routes.test.ts

@@ -155,7 +155,7 @@ describe.runIf(process.env.TW_SECRET_KEY)("Bridge.routes", () => {
         offset: 1000,
       }),
     ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `[Error: InvalidRoutesRequest | The provided request is invalid.]`,
+      "[Error: The provided request is invalid.]",
     );
   });
 });

packages/thirdweb/src/bridge/Routes.ts

@@ -2,6 +2,7 @@ import type { Address as ox__Address, Hex as ox__Hex } from "ox";
 import type { ThirdwebClient } from "../client/client.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
+import { ApiError } from "./types/Errors.js";
 import type { Route } from "./types/Route.js";
 
 /**
@@ -162,7 +163,12 @@ export async function routes(options: routes.Options): Promise<routes.Result> {
   const response = await clientFetch(url.toString());
   if (!response.ok) {
     const errorJson = await response.json();
-    throw new Error(`${errorJson.code} | ${errorJson.message}`);
+    throw new ApiError({
+      code: errorJson.code || "UNKNOWN_ERROR",
+      message: errorJson.message || response.statusText,
+      correlationId: errorJson.correlationId || undefined,
+      statusCode: response.status,
+    });
   }
 
   const { data }: { data: Route[] } = await response.json();

packages/thirdweb/src/bridge/Sell.ts

@@ -4,6 +4,7 @@ import type { ThirdwebClient } from "../client/client.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
 import { stringify } from "../utils/json.js";
+import { ApiError } from "./types/Errors.js";
 import type { PreparedQuote, Quote } from "./types/Quote.js";
 
 /**
@@ -126,9 +127,12 @@ export async function quote(options: quote.Options): Promise<quote.Result> {
   const response = await clientFetch(url.toString());
   if (!response.ok) {
     const errorJson = await response.json();
-    throw new Error(
-      `${errorJson.code} | ${errorJson.message} - ${errorJson.correlationId}`,
-    );
+    throw new ApiError({
+      code: errorJson.code || "UNKNOWN_ERROR",
+      message: errorJson.message || response.statusText,
+      correlationId: errorJson.correlationId || undefined,
+      statusCode: response.status,
+    });
   }
 
   const { data }: { data: Quote } = await response.json();
@@ -348,9 +352,12 @@ export async function prepare(
   });
   if (!response.ok) {
     const errorJson = await response.json();
-    throw new Error(
-      `${errorJson.code} | ${errorJson.message} - ${errorJson.correlationId}`,
-    );
+    throw new ApiError({
+      code: errorJson.code || "UNKNOWN_ERROR",
+      message: errorJson.message || response.statusText,
+      correlationId: errorJson.correlationId || undefined,
+      statusCode: response.status,
+    });
   }
 
   const { data }: { data: PreparedQuote } = await response.json();

packages/thirdweb/src/bridge/Status.ts

@@ -3,6 +3,7 @@
 import type { ThirdwebClient } from "../client/client.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
+import { ApiError } from "./types/Errors.js";
 import type { Status } from "./types/Status.js";
 
 /**
@@ -115,9 +116,12 @@
   const response = await clientFetch(url.toString());
   if (!response.ok) {
     const errorJson = await response.json();
-    throw new Error(
-      `${errorJson.code} | ${errorJson.message} - ${errorJson.correlationId}`,
-    );
+    throw new ApiError({
+      code: errorJson.code || "UNKNOWN_ERROR",
+      message: errorJson.message || response.statusText,
+      correlationId: errorJson.correlationId || undefined,
+      statusCode: response.status,
+    });
   }
 
   const { data }: { data: Status } = await response.json();

packages/thirdweb/src/bridge/Transfer.ts

@@ -4,6 +4,7 @@ import type { ThirdwebClient } from "../client/client.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
 import { stringify } from "../utils/json.js";
+import { ApiError } from "./types/Errors.js";
 import type { PreparedQuote } from "./types/Quote.js";
 
 /**
@@ -212,9 +213,12 @@ export async function prepare(
   });
   if (!response.ok) {
     const errorJson = await response.json();
-    throw new Error(
-      `${errorJson.code} | ${errorJson.message} - ${errorJson.correlationId}`,
-    );
+    throw new ApiError({
+      code: errorJson.code || "UNKNOWN_ERROR",
+      message: errorJson.message || response.statusText,
+      correlationId: errorJson.correlationId || undefined,
+      statusCode: response.status,
+    });
   }
 
   const { data }: { data: PreparedQuote } = await response.json();

packages/thirdweb/src/bridge/index.ts

@@ -16,4 +16,5 @@ export type {
 } from "./types/Route.js";
 export type { Status } from "./types/Status.js";
 export type { Token } from "./types/Token.js";
-export type { BridgeAction } from "./types/BridgeAction.js";
+export type { Action } from "./types/BridgeAction.js";
+export type { ApiError } from "./types/Errors.js";

packages/thirdweb/src/bridge/types/BridgeAction.ts

@@ -1 +1 @@
-export type BridgeAction = "approval" | "transfer" | "buy" | "sell";
+export type Action = "approval" | "transfer" | "buy" | "sell";

packages/thirdweb/src/bridge/types/Errors.ts

@@ -0,0 +1,24 @@
+type ErrorCode =
+  | "INVALID_INPUT"
+  | "ROUTE_NOT_FOUND"
+  | "AMOUNT_TOO_LOW"
+  | "AMOUNT_TOO_HIGH"
+  | "UNKNOWN_ERROR";
+
+export class ApiError extends Error {
+  code: ErrorCode;
+  correlationId?: string;
+  statusCode: number;
+
+  constructor(args: {
+    code: ErrorCode;
+    message: string;
+    statusCode: number;
+    correlationId?: string;
+  }) {
+    super(args.message);
+    this.code = args.code;
+    this.correlationId = args.correlationId;
+    this.statusCode = args.statusCode;
+  }
+}

packages/thirdweb/src/bridge/types/Route.ts

@@ -1,7 +1,7 @@
 import type { Hex as ox__Hex } from "ox";
 import type { Chain } from "../../chains/types.js";
 import type { ThirdwebClient } from "../../client/client.js";
-import type { BridgeAction } from "./BridgeAction.js";
+import type { Action } from "./BridgeAction.js";
 import type { Token } from "./Token.js";
 
 export type Route = {
@@ -35,7 +35,7 @@ export type RouteTransaction = {
   /**
    * The action this transaction performs. This can be "approval", "transfer", "buy", or "sell".
    */
-  action: BridgeAction;
+  action: Action;
   /**
    * The transaction ID, used for tracking purposes.
    */

packages/thirdweb/src/react/web/ui/ConnectWallet/screens/Buy/PayWIthCreditCard.tsx

@@ -85,7 +85,7 @@
             {props.value
               ? `${props.currency.symbol}${formatNumber(
                   Number(props.value),
-                  6,
+                  2,
                 )}`
               : "--"}
           </Text>