thirdweb 5.96.9-nightly-2c6bd620b508ad50535b0ec44916741a8c0a6a26-20250506000341 → 5.97.0

package/src/bridge/Sell.ts

@@ -2,6 +2,7 @@ import type { Address as ox__Address } from "ox";
 import { defineChain } from "../chains/utils.js";
 import type { ThirdwebClient } from "../client/client.js";
 import { getClientFetch } from "../utils/fetch.js";
+import { stringify } from "../utils/json.js";
 import { UNIVERSAL_BRIDGE_URL } from "./constants.js";
 import type { PreparedQuote, Quote } from "./types/Quote.js";
 
@@ -70,12 +71,27 @@ import type { PreparedQuote, Quote } from "./types/Quote.js";
  *
  * You can access this functions input and output types with `Sell.quote.Options` and `Sell.quote.Result`, respectively.
  *
+ * To limit quotes to routes that have a certain number of steps involved, use the `maxSteps` option.
+ *
+ * ```ts
+ * const quote = await Bridge.Sell.quote({
+ *   originChainId: 1,
+ *   originTokenAddress: NATIVE_TOKEN_ADDRESS,
+ *   destinationChainId: 10,
+ *   destinationTokenAddress: NATIVE_TOKEN_ADDRESS,
+ *   amount: toWei("0.01"),
+ *   maxSteps: 2, // Will only return a quote for routes with 2 or fewer steps
+ *   client: thirdwebClient,
+ * });
+ * ```
+ *
  * @param options - The options for the quote.
  * @param options.originChainId - The chain ID of the origin token.
  * @param options.originTokenAddress - The address of the origin token.
  * @param options.destinationChainId - The chain ID of the destination token.
  * @param options.destinationTokenAddress - The address of the destination token.
  * @param options.amount - The amount of the origin token to sell.
+ * @param [options.maxSteps] - Limit the number of total steps in the route.
  * @param options.client - Your thirdweb client.
  *
  * @returns A promise that resolves to a non-finalized quote for the requested sell.
@@ -92,6 +108,7 @@ export async function quote(options: quote.Options): Promise<quote.Result> {
     destinationTokenAddress,
     amount,
     client,
+    maxSteps,
   } = options;
 
   const clientFetch = getClientFetch(client);
@@ -101,6 +118,9 @@ export async function quote(options: quote.Options): Promise<quote.Result> {
   url.searchParams.set("destinationChainId", destinationChainId.toString());
   url.searchParams.set("destinationTokenAddress", destinationTokenAddress);
   url.searchParams.set("sellAmountWei", amount.toString());
+  if (typeof maxSteps !== "undefined") {
+    url.searchParams.set("maxSteps", maxSteps.toString());
+  }
 
   const response = await clientFetch(url.toString());
   if (!response.ok) {
@@ -136,6 +156,7 @@ export declare namespace quote {
     destinationTokenAddress: ox__Address.Address;
     amount: bigint;
     client: ThirdwebClient;
+    maxSteps?: number;
   };
 
   type Result = Quote & {
@@ -238,6 +259,37 @@ export declare namespace quote {
  *
  * You can access this functions input and output types with `Sell.prepare.Options` and `Sell.prepare.Result`, respectively.
  *
+ * You can include arbitrary data to be included on any webhooks and status responses with the `purchaseData` option.
+ *
+ * ```ts
+ * const quote = await Bridge.Sell.prepare({
+ *   originChainId: 1,
+ *   originTokenAddress: NATIVE_TOKEN_ADDRESS,
+ *   destinationChainId: 10,
+ *   destinationTokenAddress: NATIVE_TOKEN_ADDRESS,
+ *   amount: toWei("0.01"),
+ *   purchaseData: {
+ *     size: "large",
+ *     shippingAddress: "123 Main St, New York, NY 10001",
+ *   },
+ *   client: thirdwebClient,
+ * });
+ * ```
+ *
+ * To limit quotes to routes that have a certain number of steps involved, use the `maxSteps` option.
+ *
+ * ```ts
+ * const quote = await Bridge.Sell.prepare({
+ *   originChainId: 1,
+ *   originTokenAddress: NATIVE_TOKEN_ADDRESS,
+ *   destinationChainId: 10,
+ *   destinationTokenAddress: NATIVE_TOKEN_ADDRESS,
+ *   amount: toWei("0.01"),
+ *   maxSteps: 2, // Will only return a quote for routes with 2 or fewer steps
+ *   client: thirdwebClient,
+ * });
+ * ```
+ *
  * @param options - The options for the quote.
  * @param options.originChainId - The chain ID of the origin token.
  * @param options.originTokenAddress - The address of the origin token.
@@ -247,6 +299,7 @@ export declare namespace quote {
  * @param options.sender - The address of the sender.
  * @param options.receiver - The address of the recipient.
  * @param options.purchaseData - Arbitrary data to be passed to the purchase function and included with any webhooks or status calls.
+ * @param [options.maxSteps] - Limit the number of total steps in the route.
  * @param options.client - Your thirdweb client.
  *
  * @returns A promise that resolves to a finalized quote and transactions for the requested sell.
@@ -268,6 +321,7 @@ export async function prepare(
     receiver,
     client,
     purchaseData,
+    maxSteps,
   } = options;
 
   const clientFetch = getClientFetch(client);
@@ -278,7 +332,7 @@ export async function prepare(
     headers: {
       "Content-Type": "application/json",
     },
-    body: JSON.stringify({
+    body: stringify({
       sellAmountWei: amount.toString(),
       originChainId: originChainId.toString(),
       originTokenAddress,
@@ -287,6 +341,7 @@ export async function prepare(
       sender,
       receiver,
       purchaseData,
+      maxSteps,
     }),
   });
   if (!response.ok) {
@@ -335,6 +390,7 @@ export declare namespace prepare {
     receiver: ox__Address.Address;
     client: ThirdwebClient;
     purchaseData?: unknown;
+    maxSteps?: number;
   };
 
   type Result = PreparedQuote & {

package/src/bridge/index.ts

@@ -2,7 +2,9 @@ export * as Buy from "./Buy.js";
 export * as Sell from "./Sell.js";
 export { status } from "./Status.js";
 export { routes } from "./Routes.js";
+export { chains } from "./Chains.js";
 
 export type { Status } from "./types/Status.js";
 export type { Route } from "./types/Route.js";
 export type { Quote, PreparedQuote } from "./types/Quote.js";
+export type { Chain } from "./types/Chain.js";

package/src/bridge/types/Chain.ts

@@ -0,0 +1,40 @@
+/**
+ * Represents a blockchain chain in the Universal Bridge.
+ * @public
+ */
+export interface Chain {
+  /**
+   * The chain ID of the chain.
+   */
+  chainId: number;
+
+  /**
+   * The name of the chain.
+   */
+  name: string;
+
+  /**
+   * The URL of the chain's icon.
+   */
+  icon: string;
+
+  /**
+   * Information about the native currency of the chain.
+   */
+  nativeCurrency: {
+    /**
+     * The name of the native currency.
+     */
+    name: string;
+
+    /**
+     * The symbol of the native currency.
+     */
+    symbol: string;
+
+    /**
+     * The number of decimals used by the native currency.
+     */
+    decimals: number;
+  };
+}

package/src/pay/buyWithCrypto/getHistory.ts

@@ -61,6 +61,7 @@ export type BuyWithCryptoHistoryData = {
  * const status = await getBuyWithCryptoHistory(params)
  * ```
  * @returns Object of type [`BuyWithCryptoHistoryData`](https://portal.thirdweb.com/references/typescript/v5/BuyWithCryptoHistoryData)
+ * @deprecated
  * @buyCrypto
  */
 export async function getBuyWithCryptoHistory(

package/src/pay/buyWithCrypto/getQuote.ts

@@ -208,6 +208,7 @@ export type BuyWithCryptoQuote = {
  *  maxSlippageBPS: 50, // optional: max 0.5% slippage
  * });
  * ```
+ * @deprecated
  * @buyCrypto
  */
 export async function getBuyWithCryptoQuote(

package/src/pay/buyWithCrypto/getStatus.ts

@@ -123,6 +123,7 @@ export type ValidBuyWithCryptoStatus = Exclude<
  * }});
  * ```
  * @returns Object of type [`BuyWithCryptoStatus`](https://portal.thirdweb.com/references/typescript/v5/BuyWithCryptoStatus)
+ * @deprecated
  * @buyCrypto
  */
 export async function getBuyWithCryptoStatus(

package/src/pay/buyWithCrypto/getTransfer.ts

@@ -119,6 +119,7 @@ export type BuyWithCryptoTransfer = {
  *  }
  * });
  * ```
+ * @deprecated
  * @buyCrypto
  */
 export async function getBuyWithCryptoTransfer(

package/src/pay/buyWithFiat/getHistory.ts

@@ -5,6 +5,7 @@ import type { BuyWithFiatStatus } from "./getStatus.js";
 
 /**
  * The parameters for [`getBuyWithFiatHistory`](https://portal.thirdweb.com/references/typescript/v5/getBuyWithFiatHistory) function
+ * @deprecated
  * @buyCrypto
  */
 export type BuyWithFiatHistoryParams = {
@@ -60,6 +61,7 @@ export type BuyWithFiatHistoryData = {
  * })
  * ```
  * @returns Object of type [`BuyWithFiatHistoryData`](https://portal.thirdweb.com/references/typescript/v5/BuyWithFiatHistoryData)
+ * @deprecated
  * @buyCrypto
  */
 export async function getBuyWithFiatHistory(

package/src/pay/buyWithFiat/getPostOnRampQuote.ts

@@ -55,6 +55,7 @@ export type GetPostOnRampQuoteParams = {
  *  });
  * }
  * ```
+ * @deprecated
  * @buyCrypto
  */
 export async function getPostOnRampQuote({

package/src/pay/buyWithFiat/getQuote.ts

@@ -6,6 +6,7 @@ import type { FiatProvider, PayTokenInfo } from "../utils/commonTypes.js";
 import { getPayBuyWithFiatQuoteEndpoint } from "../utils/definitions.js";
 /**
  * Parameters for [`getBuyWithFiatQuote`](https://portal.thirdweb.com/references/typescript/v5/getBuyWithFiatQuote) function
+ * @deprecated
  * @buyCrypto
  */
 export type GetBuyWithFiatQuoteParams = {
@@ -102,6 +103,7 @@ export type GetBuyWithFiatQuoteParams = {
  * - The on-ramp and destination token information.
  * - Processing fees
  *
+ * @deprecated
  * @buyCrypto
  */
 export type BuyWithFiatQuote = {

package/src/pay/buyWithFiat/getStatus.ts

@@ -8,6 +8,7 @@ import { getPayBuyWithFiatStatusEndpoint } from "../utils/definitions.js";
 
 /**
  * Parameters for the [`getBuyWithFiatStatus`](https://portal.thirdweb.com/references/typescript/v5/getBuyWithFiatStatus) function
+ * @deprecated
  * @buyCrypto
  */
 export type GetBuyWithFiatStatusParams = {
@@ -172,6 +173,7 @@ export type BuyWithFiatStatus =
  * // when the fiatStatus.status is "ON_RAMP_TRANSFER_COMPLETED" - the process is complete
  * // when the fiatStatus.status is "CRYPTO_SWAP_REQUIRED" - start the swap process
  * ```
+ * @deprecated
  * @buyCrypto
  */
 export async function getBuyWithFiatStatus(

package/src/pay/buyWithFiat/isSwapRequiredPostOnramp.ts

@@ -12,6 +12,7 @@ import type { BuyWithFiatQuote } from "./getQuote.js";
  *
  * @param buyWithFiatQuote - The quote of type [`BuyWithFiatQuote`](https://portal.thirdweb.com/references/typescript/v5/BuyWithFiatQuote) returned
  * by the [`getBuyWithFiatQuote`](https://portal.thirdweb.com/references/typescript/v5/getBuyWithFiatQuote) function.
+ * @deprecated
  * @buyCrypto
  */
 export function isSwapRequiredPostOnramp(

package/src/react/core/hooks/pay/useBuyWithCryptoHistory.ts

@@ -34,6 +34,7 @@ export type BuyWithCryptoHistoryQueryOptions = Omit<
  *  return <div> ... </div>
  * }
  * ```
+ * @deprecated
  * @buyCrypto
  */
 export function useBuyWithCryptoHistory(

package/src/react/core/hooks/pay/useBuyWithCryptoQuote.ts

@@ -71,6 +71,7 @@ export type BuyWithCryptoQuoteQueryOptions = Omit<
  *  return <button onClick={handleBuyWithCrypto}>Swap</button>
  * }
  * ```
+ * @deprecated
  * @buyCrypto
  */
 export function useBuyWithCryptoQuote(

package/src/react/core/hooks/pay/useBuyWithCryptoStatus.ts

@@ -52,6 +52,7 @@ import {
  *  return <button onClick={handleBuyWithCrypto}>Swap</button>
  * }
  * ```
+ * @deprecated
  * @buyCrypto
  */
 export function useBuyWithCryptoStatus(params?: BuyWithCryptoTransaction) {

package/src/react/core/hooks/pay/useBuyWithFiatHistory.ts

@@ -34,6 +34,7 @@ export type BuyWithFiatHistoryQueryOptions = Omit<
  *  return <div> ... </div>
  * }
  * ```
+ * @deprecated
  * @buyCrypto
  */
 export function useBuyWithFiatHistory(

package/src/react/core/hooks/pay/useBuyWithFiatQuote.ts

@@ -60,6 +60,7 @@ export type BuyWithFiatQuoteQueryOptions = Omit<
  *   );
  * }
  * ```
+ * @deprecated
  * @buyCrypto
  */
 export function useBuyWithFiatQuote(

package/src/react/core/hooks/pay/useBuyWithFiatStatus.ts

@@ -32,6 +32,7 @@ import type { WithPickedOnceQueryOptions } from "../types.js";
  *   return <div>...</div>;
  * }
  * ```
+ * @deprecated
  * @buyCrypto
  */
 export function useBuyWithFiatStatus(

package/src/version.ts

@@ -1 +1 @@
-export const version = "5.96.9-nightly-2c6bd620b508ad50535b0ec44916741a8c0a6a26-20250506000341";
+export const version = "5.97.0";