thirdweb 5.110.6 → 5.111.0-nightly-8ef418c543b89679286a200175a35c41e98240e2-20251031000344

package/dist/types/bridge/Routes.d.ts

@@ -1,166 +0,0 @@
-import type { Address as ox__Address, Hex as ox__Hex } from "ox";
-import type { ThirdwebClient } from "../client/client.js";
-import type { Route } from "./types/Route.js";
-/**
- * Retrieves supported Bridge routes based on the provided filters.
- *
- * When multiple filters are specified, a route must satisfy all filters to be included (it acts as an AND operator).
- *
- * @example
- * ```typescript
- * import { Bridge } from "thirdweb";
- *
- * const routes = await Bridge.routes({
- *   client: thirdwebClient,
- * });
- * ```
- *
- * Returned routes might look something like:
- * ```typescript
- * [
- *    {
- *     destinationToken: {
- *       address: "0x12c88a3C30A7AaBC1dd7f2c08a97145F5DCcD830",
- *       chainId: 1,
- *       decimals: 18,
- *       iconUri: "https://assets.coingecko.com/coins/images/37207/standard/G.jpg",
- *       name: "G7",
- *       symbol: "G7",
- *     },
- *     originToken: {
- *       address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *       chainId: 480,
- *       decimals: 18,
- *       iconUri: "https://assets.relay.link/icons/1/light.png",
- *       name: "Ether",
- *       symbol: "ETH",
- *     }
- *   },
- *   {
- *     destinationToken: {
- *       address: "0x4d224452801ACEd8B2F0aebE155379bb5D594381",
- *       chainId: 1,
- *       decimals: 18,
- *       iconUri: "https://coin-images.coingecko.com/coins/images/24383/large/apecoin.jpg?1696523566",
- *       name: "ApeCoin",
- *       symbol: "APE",
- *     },
- *     originToken: {
- *       address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *       chainId: 480,
- *       decimals: 18,
- *       iconUri: "https://assets.relay.link/icons/1/light.png",
- *       name: "Ether",
- *       symbol: "ETH",
- *     }
- *   }
- * ]
- * ```
- *
- * You can filter for specific chains or tokens:
- * ```typescript
- * import { Bridge } from "thirdweb";
- *
- * // Get all routes starting from mainnet ETH
- * const routes = await Bridge.routes({
- *   originChainId: 1,
- *   originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *   client: thirdwebClient,
- * });
- * ```
- *
- * The returned routes will be limited based on the API. You can paginate through the results using the `limit` and `offset` parameters:
- * ```typescript
- * import { Bridge } from "thirdweb";
- *
- * // Get the first 10 routes starting from mainnet ETH
- * const routes = await Bridge.routes({
- *   originChainId: 1,
- *   originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *   limit: 10,
- *   offset: 0,
- *   client: thirdwebClient,
- * });
- * ```
- *
- * You can sort the returned routes by `popularity`:
- * ```ts
- * import { Bridge } from "thirdweb";
- *
- * // Get the 10 most popular routes starting from mainnet ETH
- * const routes = await Bridge.routes({
- *   originChainId: 1,
- *   originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *   limit: 10,
- *   offset: 0,
- *   sortBy: "popularity",
- *   client: thirdwebClient,
- * });
- * ```
- *
- * @param options - The options for the quote.
- * @param options.client - Your thirdweb client.
- * @param options.originChainId - Filter by a specific origin chain ID.
- * @param options.originTokenAddress - Filter by a specific origin token address.
- * @param options.destinationChainId - Filter by a specific destination chain ID.
- * @param options.destinationTokenAddress - Filter by a specific destination token address.
- * @param options.transactionHash - Filter by a specific transaction hash.
- * @param options.maxSteps - Limit the number of steps returned.
- * @param options.sortBy - Sort the routes by various categories.
- * @param options.limit - Limit the number of routes returned.
- * @param options.offset - Offset the number of routes returned.
- *
- * @returns A promise that resolves to an array of routes.
- *
- * @throws Will throw an error if there is an issue fetching the routes.
- * @bridge
- * @beta
- */
-export declare function routes(options: routes.Options): Promise<routes.Result>;
-/**
- * Namespace containing types for the routes function.
- * @namespace routes
- * @bridge
- */
-export declare namespace routes {
-    /**
-     * Options for fetching available bridge routes.
-     * @interface Options
-     * @bridge
-     */
-    type Options = {
-        /** Your thirdweb client */
-        client: ThirdwebClient;
-        /** The origin chain ID to filter routes by */
-        originChainId?: number;
-        /** The origin token address to filter routes by */
-        originTokenAddress?: ox__Address.Address;
-        /** The destination chain ID to filter routes by */
-        destinationChainId?: number;
-        /** The destination token address to filter routes by */
-        destinationTokenAddress?: ox__Address.Address;
-        /** Transaction hash to filter routes by */
-        transactionHash?: ox__Hex.Hex;
-        /**
-         * Sort routes by popularity
-         * @deprecated
-         */
-        sortBy?: "popularity";
-        /** Maximum number of steps in the route */
-        maxSteps?: number;
-        /** Whether to include price information in the response */
-        includePrices?: boolean;
-        /** Number of results to return (pagination) */
-        limit?: number;
-        /** Number of results to skip (pagination) */
-        offset?: number;
-    };
-    /**
-     * Result returned from fetching bridge routes.
-     * Contains an array of available routes.
-     * @interface Result
-     * @bridge
-     */
-    type Result = Route[];
-}
-//# sourceMappingURL=Routes.d.ts.map

package/dist/types/bridge/Routes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Routes.d.ts","sourceRoot":"","sources":["../../../src/bridge/Routes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,IAAI,WAAW,EAAE,GAAG,IAAI,OAAO,EAAE,MAAM,IAAI,CAAC;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAI1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkHG;AACH,wBAAsB,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAyD5E;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B;;;;OAIG;IACH,KAAK,OAAO,GAAG;QACb,2BAA2B;QAC3B,MAAM,EAAE,cAAc,CAAC;QACvB,8CAA8C;QAC9C,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,mDAAmD;QACnD,kBAAkB,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;QACzC,mDAAmD;QACnD,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,wDAAwD;QACxD,uBAAuB,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;QAC9C,2CAA2C;QAC3C,eAAe,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC;QAC9B;;;WAGG;QACH,MAAM,CAAC,EAAE,YAAY,CAAC;QACtB,2CAA2C;QAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,2DAA2D;QAC3D,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,6CAA6C;QAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IAEF;;;;;OAKG;IACH,KAAK,MAAM,GAAG,KAAK,EAAE,CAAC;CACvB"}

package/dist/types/react/core/hooks/useBridgeRoutes.d.ts

@@ -1,29 +0,0 @@
-import type { routes as RoutesTypes } from "../../../bridge/Routes.js";
-/**
- * Parameters for the useBridgeRoutes hook
- */
-export type UseBridgeRoutesParams = RoutesTypes.Options & {
-    /**
-     * Whether to enable the query. Useful for conditional fetching.
-     * @default true
-     */
-    enabled?: boolean;
-};
-/**
- * Hook that fetches available bridge routes with caching and retry logic
- *
- * @param params - Parameters for fetching routes including client and filter options
- * @returns React Query result with routes data, loading state, and error handling
- *
- * @example
- * ```tsx
- * const { data: routes, isLoading, error } = useBridgeRoutes({
- *   client: thirdwebClient,
- *   originChainId: 1,
- *   destinationChainId: 137,
- *   originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE"
- * });
- * ```
- */
-export declare function useBridgeRoutes(params: UseBridgeRoutesParams): import("@tanstack/react-query").UseQueryResult<RoutesTypes.Result, Error>;
-//# sourceMappingURL=useBridgeRoutes.d.ts.map

package/dist/types/react/core/hooks/useBridgeRoutes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useBridgeRoutes.d.ts","sourceRoot":"","sources":["../../../../../src/react/core/hooks/useBridgeRoutes.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,IAAI,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAKvE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,WAAW,CAAC,OAAO,GAAG;IACxD;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,qBAAqB,6EAyC5D"}

package/src/bridge/Routes.test.ts

@@ -1,161 +0,0 @@
-import { http, passthrough } from "msw";
-import { setupServer } from "msw/node";
-import { afterAll, afterEach, beforeAll, describe, expect, it } from "vitest";
-import { TEST_CLIENT } from "~test/test-clients.js";
-import { routes } from "./Routes.js";
-
-const server = setupServer(
-  http.get("https://bridge.thirdweb.com/v1/routes", () => {
-    passthrough();
-  }),
-);
-
-describe.runIf(process.env.TW_SECRET_KEY)("Bridge.routes", () => {
-  beforeAll(() => server.listen());
-  afterEach(() => server.resetHandlers());
-  afterAll(() => server.close());
-
-  it("should get a valid list of routes", async () => {
-    const allRoutes = await routes({
-      client: TEST_CLIENT,
-    });
-
-    expect(allRoutes).toBeDefined();
-    expect(Array.isArray(allRoutes)).toBe(true);
-  });
-
-  it("should filter routes by origin chain", async () => {
-    const filteredRoutes = await routes({
-      client: TEST_CLIENT,
-      originChainId: 1,
-    });
-
-    expect(filteredRoutes).toBeDefined();
-    expect(Array.isArray(filteredRoutes)).toBe(true);
-    expect(
-      filteredRoutes.every((route) => route.originToken.chainId === 1),
-    ).toBe(true);
-  });
-
-  it("should filter routes by destination chain", async () => {
-    const filteredRoutes = await routes({
-      client: TEST_CLIENT,
-      destinationChainId: 1,
-    });
-
-    expect(filteredRoutes).toBeDefined();
-    expect(Array.isArray(filteredRoutes)).toBe(true);
-    expect(
-      filteredRoutes.every((route) => route.destinationToken.chainId === 1),
-    ).toBe(true);
-  });
-
-  it("should filter routes by origin token", async () => {
-    const filteredRoutes = await routes({
-      client: TEST_CLIENT,
-      originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-    });
-
-    expect(filteredRoutes).toBeDefined();
-    expect(Array.isArray(filteredRoutes)).toBe(true);
-    expect(
-      filteredRoutes.every(
-        (route) =>
-          route.originToken.address ===
-          "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-      ),
-    ).toBe(true);
-  });
-
-  it("should filter routes by destination token", async () => {
-    const filteredRoutes = await routes({
-      client: TEST_CLIENT,
-      destinationTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-    });
-
-    expect(filteredRoutes).toBeDefined();
-    expect(Array.isArray(filteredRoutes)).toBe(true);
-    expect(
-      filteredRoutes.every(
-        (route) =>
-          route.destinationToken.address ===
-          "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-      ),
-    ).toBe(true);
-  });
-
-  it("should combine filters", async () => {
-    const filteredRoutes = await routes({
-      client: TEST_CLIENT,
-      destinationChainId: 10,
-      destinationTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-      originChainId: 1,
-      originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-    });
-
-    expect(filteredRoutes).toBeDefined();
-    expect(Array.isArray(filteredRoutes)).toBe(true);
-    expect(filteredRoutes.length).toBeGreaterThan(0);
-    expect(
-      filteredRoutes.every(
-        (route) =>
-          route.originToken.chainId === 1 &&
-          route.destinationToken.chainId === 10 &&
-          route.originToken.address ===
-            "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE" &&
-          route.destinationToken.address ===
-            "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-      ),
-    ).toBe(true);
-  });
-
-  it("should respect limit and offset", async () => {
-    const page1Routes = await routes({
-      client: TEST_CLIENT,
-      limit: 1,
-      offset: 1,
-    });
-
-    expect(page1Routes).toBeDefined();
-    expect(Array.isArray(page1Routes)).toBe(true);
-    expect(page1Routes.length).toBe(1);
-
-    const page2Routes = await routes({
-      client: TEST_CLIENT,
-      limit: 1,
-      offset: 2,
-    });
-
-    expect(page2Routes).toBeDefined();
-    expect(Array.isArray(page2Routes)).toBe(true);
-    expect(page2Routes.length).toBe(1);
-
-    expect(JSON.stringify(page1Routes)).not.toEqual(
-      JSON.stringify(page2Routes),
-    );
-  });
-
-  it("should surface any errors", async () => {
-    server.use(
-      http.get("https://bridge.thirdweb.com/v1/routes", () => {
-        return Response.json(
-          {
-            code: "InvalidRoutesRequest",
-            message: "The provided request is invalid.",
-          },
-          { status: 400 },
-        );
-      }),
-    );
-
-    await expect(
-      routes({
-        client: TEST_CLIENT,
-        limit: 1000,
-        offset: 1000,
-      }),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(
-      "[Error: The provided request is invalid.]",
-    );
-  });
-});

package/src/bridge/Routes.ts

@@ -1,228 +0,0 @@
-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";
-
-/**
- * Retrieves supported Bridge routes based on the provided filters.
- *
- * When multiple filters are specified, a route must satisfy all filters to be included (it acts as an AND operator).
- *
- * @example
- * ```typescript
- * import { Bridge } from "thirdweb";
- *
- * const routes = await Bridge.routes({
- *   client: thirdwebClient,
- * });
- * ```
- *
- * Returned routes might look something like:
- * ```typescript
- * [
- *    {
- *     destinationToken: {
- *       address: "0x12c88a3C30A7AaBC1dd7f2c08a97145F5DCcD830",
- *       chainId: 1,
- *       decimals: 18,
- *       iconUri: "https://assets.coingecko.com/coins/images/37207/standard/G.jpg",
- *       name: "G7",
- *       symbol: "G7",
- *     },
- *     originToken: {
- *       address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *       chainId: 480,
- *       decimals: 18,
- *       iconUri: "https://assets.relay.link/icons/1/light.png",
- *       name: "Ether",
- *       symbol: "ETH",
- *     }
- *   },
- *   {
- *     destinationToken: {
- *       address: "0x4d224452801ACEd8B2F0aebE155379bb5D594381",
- *       chainId: 1,
- *       decimals: 18,
- *       iconUri: "https://coin-images.coingecko.com/coins/images/24383/large/apecoin.jpg?1696523566",
- *       name: "ApeCoin",
- *       symbol: "APE",
- *     },
- *     originToken: {
- *       address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *       chainId: 480,
- *       decimals: 18,
- *       iconUri: "https://assets.relay.link/icons/1/light.png",
- *       name: "Ether",
- *       symbol: "ETH",
- *     }
- *   }
- * ]
- * ```
- *
- * You can filter for specific chains or tokens:
- * ```typescript
- * import { Bridge } from "thirdweb";
- *
- * // Get all routes starting from mainnet ETH
- * const routes = await Bridge.routes({
- *   originChainId: 1,
- *   originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *   client: thirdwebClient,
- * });
- * ```
- *
- * The returned routes will be limited based on the API. You can paginate through the results using the `limit` and `offset` parameters:
- * ```typescript
- * import { Bridge } from "thirdweb";
- *
- * // Get the first 10 routes starting from mainnet ETH
- * const routes = await Bridge.routes({
- *   originChainId: 1,
- *   originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *   limit: 10,
- *   offset: 0,
- *   client: thirdwebClient,
- * });
- * ```
- *
- * You can sort the returned routes by `popularity`:
- * ```ts
- * import { Bridge } from "thirdweb";
- *
- * // Get the 10 most popular routes starting from mainnet ETH
- * const routes = await Bridge.routes({
- *   originChainId: 1,
- *   originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *   limit: 10,
- *   offset: 0,
- *   sortBy: "popularity",
- *   client: thirdwebClient,
- * });
- * ```
- *
- * @param options - The options for the quote.
- * @param options.client - Your thirdweb client.
- * @param options.originChainId - Filter by a specific origin chain ID.
- * @param options.originTokenAddress - Filter by a specific origin token address.
- * @param options.destinationChainId - Filter by a specific destination chain ID.
- * @param options.destinationTokenAddress - Filter by a specific destination token address.
- * @param options.transactionHash - Filter by a specific transaction hash.
- * @param options.maxSteps - Limit the number of steps returned.
- * @param options.sortBy - Sort the routes by various categories.
- * @param options.limit - Limit the number of routes returned.
- * @param options.offset - Offset the number of routes returned.
- *
- * @returns A promise that resolves to an array of routes.
- *
- * @throws Will throw an error if there is an issue fetching the routes.
- * @bridge
- * @beta
- */
-export async function routes(options: routes.Options): Promise<routes.Result> {
-  const {
-    client,
-    originChainId,
-    originTokenAddress,
-    destinationChainId,
-    destinationTokenAddress,
-    maxSteps,
-    sortBy,
-    limit,
-    offset,
-    includePrices,
-  } = options;
-
-  const clientFetch = getClientFetch(client);
-  const url = new URL(`${getThirdwebBaseUrl("bridge")}/v1/routes`);
-  if (originChainId) {
-    url.searchParams.set("originChainId", originChainId.toString());
-  }
-  if (originTokenAddress) {
-    url.searchParams.set("originTokenAddress", originTokenAddress);
-  }
-  if (destinationChainId) {
-    url.searchParams.set("destinationChainId", destinationChainId.toString());
-  }
-  if (destinationTokenAddress) {
-    url.searchParams.set("destinationTokenAddress", destinationTokenAddress);
-  }
-  if (maxSteps) {
-    url.searchParams.set("maxSteps", maxSteps.toString());
-  }
-  if (limit) {
-    url.searchParams.set("limit", limit.toString());
-  }
-  if (offset) {
-    url.searchParams.set("offset", offset.toString());
-  }
-  if (sortBy) {
-    url.searchParams.set("sortBy", sortBy);
-  }
-  if (includePrices) {
-    url.searchParams.set("includePrices", includePrices.toString());
-  }
-
-  const response = await clientFetch(url.toString());
-  if (!response.ok) {
-    const errorJson = await response.json();
-    throw new ApiError({
-      code: errorJson.code || "UNKNOWN_ERROR",
-      correlationId: errorJson.correlationId || undefined,
-      message: errorJson.message || response.statusText,
-      statusCode: response.status,
-    });
-  }
-
-  const { data }: { data: Route[] } = await response.json();
-  return data;
-}
-
-/**
- * Namespace containing types for the routes function.
- * @namespace routes
- * @bridge
- */
-export declare namespace routes {
-  /**
-   * Options for fetching available bridge routes.
-   * @interface Options
-   * @bridge
-   */
-  type Options = {
-    /** Your thirdweb client */
-    client: ThirdwebClient;
-    /** The origin chain ID to filter routes by */
-    originChainId?: number;
-    /** The origin token address to filter routes by */
-    originTokenAddress?: ox__Address.Address;
-    /** The destination chain ID to filter routes by */
-    destinationChainId?: number;
-    /** The destination token address to filter routes by */
-    destinationTokenAddress?: ox__Address.Address;
-    /** Transaction hash to filter routes by */
-    transactionHash?: ox__Hex.Hex;
-    /**
-     * Sort routes by popularity
-     * @deprecated
-     */
-    sortBy?: "popularity";
-    /** Maximum number of steps in the route */
-    maxSteps?: number;
-    /** Whether to include price information in the response */
-    includePrices?: boolean;
-    /** Number of results to return (pagination) */
-    limit?: number;
-    /** Number of results to skip (pagination) */
-    offset?: number;
-  };
-
-  /**
-   * Result returned from fetching bridge routes.
-   * Contains an array of available routes.
-   * @interface Result
-   * @bridge
-   */
-  type Result = Route[];
-}