thirdweb 5.110.5 → 5.111.0-nightly-8ef418c543b89679286a200175a35c41e98240e2-20251031000344

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[];
-}

package/src/react/core/hooks/useBridgeRoutes.test.ts

@@ -1,137 +0,0 @@
-import {
-  beforeEach,
-  describe,
-  expect,
-  it,
-  type MockedFunction,
-  vi,
-} from "vitest";
-import { routes } from "../../../bridge/Routes.js";
-import { ApiError } from "../../../bridge/types/Errors.js";
-import type { Route } from "../../../bridge/types/Route.js";
-import type { ThirdwebClient } from "../../../client/client.js";
-import type { UseBridgeRoutesParams } from "./useBridgeRoutes.js";
-
-// Mock the Bridge routes function
-vi.mock("../../../bridge/Routes.js", () => ({
-  routes: vi.fn(),
-}));
-
-const mockRoutes = routes as MockedFunction<typeof routes>;
-
-// Mock client
-const mockClient = { clientId: "test" } as ThirdwebClient;
-
-// Mock route data
-const mockRouteData: Route[] = [
-  {
-    destinationToken: {
-      address: "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619",
-      chainId: 137,
-      decimals: 18,
-      name: "Wrapped Ethereum",
-      priceUsd: 2000.0,
-      symbol: "WETH",
-    },
-    originToken: {
-      address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-      chainId: 1,
-      decimals: 18,
-      name: "Ethereum",
-      priceUsd: 2000.0,
-      symbol: "ETH",
-    },
-  },
-];
-
-describe("useBridgeRoutes", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it("should export correct hook parameters type", () => {
-    // Type-only test to verify UseBridgeRoutesParams interface
-    const params: UseBridgeRoutesParams = {
-      client: mockClient,
-      destinationChainId: 137,
-      enabled: true,
-      originChainId: 1,
-    };
-
-    expect(params).toBeDefined();
-    expect(params.client).toBe(mockClient);
-    expect(params.originChainId).toBe(1);
-    expect(params.destinationChainId).toBe(137);
-    expect(params.enabled).toBe(true);
-  });
-
-  it("should handle different parameter combinations", () => {
-    const fullParams: UseBridgeRoutesParams = {
-      client: mockClient,
-      destinationChainId: 137,
-      destinationTokenAddress: "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619",
-      enabled: false,
-      limit: 10,
-      maxSteps: 3,
-      offset: 0,
-      originChainId: 1,
-      originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
-      sortBy: "popularity",
-    };
-
-    expect(fullParams).toBeDefined();
-    expect(fullParams.sortBy).toBe("popularity");
-    expect(fullParams.maxSteps).toBe(3);
-    expect(fullParams.limit).toBe(10);
-    expect(fullParams.offset).toBe(0);
-  });
-
-  it("should have optional enabled parameter defaulting to true", () => {
-    const paramsWithoutEnabled: UseBridgeRoutesParams = {
-      client: mockClient,
-      destinationChainId: 137,
-      originChainId: 1,
-    };
-
-    expect(paramsWithoutEnabled.enabled).toBeUndefined(); // Should be optional
-  });
-
-  it("should validate that Bridge.routes would be called with correct parameters", async () => {
-    const testParams = {
-      client: mockClient,
-      destinationChainId: 137,
-      originChainId: 1,
-      originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE" as const,
-    };
-
-    // Mock the routes function to return our test data
-    mockRoutes.mockResolvedValue(mockRouteData);
-
-    // Directly call the routes function to verify it works with our parameters
-    const result = await routes(testParams);
-
-    expect(mockRoutes).toHaveBeenCalledWith(testParams);
-    expect(result).toEqual(mockRouteData);
-  });
-
-  it("should handle API errors properly", async () => {
-    const apiError = new ApiError({
-      code: "INVALID_INPUT",
-      message: "Invalid parameters",
-      statusCode: 400,
-    });
-
-    mockRoutes.mockRejectedValue(apiError);
-
-    try {
-      await routes({
-        client: mockClient,
-        destinationChainId: 137,
-        originChainId: 1,
-      });
-    } catch (error) {
-      expect(error).toBe(apiError);
-      expect(error).toBeInstanceOf(ApiError);
-    }
-  });
-});

package/src/react/core/hooks/useBridgeRoutes.ts

@@ -1,75 +0,0 @@
-import { useQuery } from "@tanstack/react-query";
-import type { routes as RoutesTypes } from "../../../bridge/Routes.js";
-import { routes } from "../../../bridge/Routes.js";
-import { ApiError } from "../../../bridge/types/Errors.js";
-import { mapBridgeError } from "../errors/mapBridgeError.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 function useBridgeRoutes(params: UseBridgeRoutesParams) {
-  const { enabled = true, ...routeParams } = params;
-
-  return useQuery({
-    enabled: enabled && !!routeParams.client,
-    gcTime: 10 * 60 * 1000,
-    queryFn: () => routes(routeParams),
-    queryKey: [
-      "bridge-routes",
-      {
-        destinationChainId: routeParams.destinationChainId,
-        destinationTokenAddress: routeParams.destinationTokenAddress,
-        limit: routeParams.limit,
-        maxSteps: routeParams.maxSteps,
-        offset: routeParams.offset,
-        originChainId: routeParams.originChainId,
-        originTokenAddress: routeParams.originTokenAddress,
-        sortBy: routeParams.sortBy,
-      },
-    ], // 5 minutes - routes are relatively stable
-    retry: (failureCount, error) => {
-      // Handle both ApiError and generic Error instances
-      if (error instanceof ApiError) {
-        const bridgeError = mapBridgeError(error);
-
-        // Don't retry on client-side errors (4xx)
-        if (
-          bridgeError.statusCode &&
-          bridgeError.statusCode >= 400 &&
-          bridgeError.statusCode < 500
-        ) {
-          return false;
-        }
-      }
-
-      // Retry up to 3 times for server errors or network issues
-      return failureCount < 3;
-    }, // 10 minutes garbage collection
-    retryDelay: (attemptIndex) => Math.min(1000 * 2 ** attemptIndex, 30000),
-    staleTime: 5 * 60 * 1000, // Exponential backoff, max 30s
-  });
-}