thirdweb 5.99.3 → 5.100.0

package/src/bridge/Transfer.ts

@@ -0,0 +1,270 @@
+import type { Address as ox__Address } from "ox";
+import { defineChain } from "../chains/utils.js";
+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 type { PreparedQuote } from "./types/Quote.js";
+
+/**
+ * Prepares a **finalized** Universal Bridge quote for the provided transfer request with transaction data.
+ *
+ * @example
+ * ```typescript
+ * import { Bridge, NATIVE_TOKEN_ADDRESS } from "thirdweb";
+ *
+ * const quote = await Bridge.Transfer.prepare({
+ *   chainId: 1,
+ *   tokenAddress: NATIVE_TOKEN_ADDRESS,
+ *   amount: toWei("0.01"),
+ *   sender: "0x...",
+ *   receiver: "0x...",
+ *   client: thirdwebClient,
+ * });
+ * ```
+ *
+ * This will return a quote that might look like:
+ * ```typescript
+ * {
+ *   originAmount: 10000026098875381n,
+ *   destinationAmount: 10000000000000000n,
+ *   blockNumber: 22026509n,
+ *   timestamp: 1741730936680,
+ *   estimatedExecutionTimeMs: 1000
+ *   steps: [
+ *     {
+ *       originToken: {
+ *         chainId: 1,
+ *         address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
+ *         symbol: "ETH",
+ *         name: "Ethereum",
+ *         decimals: 18,
+ *         priceUsd: 2000,
+ *         iconUri: "https://..."
+ *       },
+ *       destinationToken: {
+ *         chainId: 1,
+ *         address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
+ *         symbol: "ETH",
+ *         name: "Ethereum",
+ *         decimals: 18,
+ *         priceUsd: 2000,
+ *         iconUri: "https://..."
+ *       },
+ *       originAmount: 10000026098875381n,
+ *       destinationAmount: 10000000000000000n,
+ *       estimatedExecutionTimeMs: 1000
+ *       transactions: [
+ *         {
+ *           action: "approval",
+ *           id: "0x",
+ *           to: "0x...",
+ *           data: "0x...",
+ *           chainId: 1,
+ *           type: "eip1559"
+ *         },
+ *         {
+ *           action: "transfer",
+ *           to: "0x...",
+ *           value: 10000026098875381n,
+ *           data: "0x...",
+ *           chainId: 1,
+ *           type: "eip1559"
+ *         }
+ *       ]
+ *     }
+ *   ],
+ *   expiration: 1741730936680,
+ *   intent: {
+ *     chainId: 1,
+ *     tokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
+ *     amount: 10000000000000000n,
+ *     sender: "0x...",
+ *     receiver: "0x..."
+ *   }
+ * }
+ * ```
+ *
+ * ## Sending the transactions
+ * The `transactions` array is a series of [ox](https://oxlib.sh) EIP-1559 transactions that must be executed one after the other in order to fulfill the complete route. There are a few things to keep in mind when executing these transactions:
+ *  - Approvals will have the `approval` action specified. You can perform approvals with `sendAndConfirmTransaction`, then proceed to the next transaction.
+ *  - All transactions are assumed to be executed by the `sender` address, regardless of which chain they are on. The final transaction will use the `receiver` as the recipient address.
+ *  - If an `expiration` timestamp is provided, all transactions must be executed before that time to guarantee successful execution at the specified price.
+ *
+ * NOTE: To get the status of each non-approval transaction, use `Bridge.status` rather than checking for transaction inclusion. This function will ensure full completion of the transfer.
+ *
+ * You can access this functions input and output types with `Transfer.prepare.Options` and `Transfer.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.Transfer.prepare({
+ *   chainId: 1,
+ *   tokenAddress: NATIVE_TOKEN_ADDRESS,
+ *   amount: toWei("0.01"),
+ *   sender: "0x...",
+ *   receiver: "0x...",
+ *   purchaseData: {
+ *     reference: "payment-123",
+ *     metadata: {
+ *       note: "Transfer to Alice"
+ *     }
+ *   },
+ *   client: thirdwebClient,
+ * });
+ * ```
+ *
+ * ## Fees
+ * There may be fees associated with the transfer. These fees are paid by the `feePayer` address, which defaults to the `sender` address. You can specify a different address with the `feePayer` option. If you do not specify an option or explicitly specify `sender`, the fees will be added to the input amount. If you specify the `receiver` as the fee payer the fees will be subtracted from the destination amount.
+ *
+ * For example, if you were to request a transfer with `feePayer` set to `receiver`:
+ * ```typescript
+ * const quote = await Bridge.Transfer.prepare({
+ *   chainId: 1,
+ *   tokenAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
+ *   amount: 100_000_000n, // 100 USDC
+ *   sender: "0x...",
+ *   receiver: "0x...",
+ *   feePayer: "receiver",
+ *   client: thirdwebClient,
+ * });
+ * ```
+ *
+ * The returned quote might look like:
+ * ```typescript
+ * {
+ *   originAmount: 100_000_000n, // 100 USDC
+ *   destinationAmount: 99_970_000n, // 99.97 USDC
+ *   ...
+ * }
+ * ```
+ *
+ * If you were to request a transfer with `feePayer` set to `sender`:
+ * ```typescript
+ * const quote = await Bridge.Transfer.prepare({
+ *   chainId: 1,
+ *   tokenAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
+ *   amount: 100_000_000n, // 100 USDC
+ *   sender: "0x...",
+ *   receiver: "0x...",
+ *   feePayer: "sender",
+ *   client: thirdwebClient,
+ * });
+ * ```
+ *
+ * The returned quote might look like:
+ * ```typescript
+ * {
+ *   originAmount: 100_030_000n, // 100.03 USDC
+ *   destinationAmount: 100_000_000n, // 100 USDC
+ *   ...
+ * }
+ * ```
+ *
+ * @param options - The options for the quote.
+ * @param options.chainId - The chain ID of the token.
+ * @param options.tokenAddress - The address of the token.
+ * @param options.amount - The amount of the token to transfer.
+ * @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 transfer function and included with any webhooks or status calls.
+ * @param options.client - Your thirdweb client.
+ * @param [options.feePayer] - The address that will pay the fees for the transfer. If not specified, the sender will be used. Values can be "sender" or "receiver".
+ *
+ * @returns A promise that resolves to a finalized quote and transactions for the requested transfer.
+ *
+ * @throws Will throw an error if there is an issue fetching the quote.
+ * @bridge Transfer
+ * @beta
+ */
+export async function prepare(
+  options: prepare.Options,
+): Promise<prepare.Result> {
+  const {
+    chainId,
+    tokenAddress,
+    sender,
+    receiver,
+    client,
+    amount,
+    purchaseData,
+    feePayer,
+  } = options;
+
+  const clientFetch = getClientFetch(client);
+  const url = new URL(`${getThirdwebBaseUrl("bridge")}/v1/transfer/prepare`);
+
+  const response = await clientFetch(url.toString(), {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+    },
+    body: stringify({
+      transferAmountWei: amount.toString(), // legacy
+      amount: amount.toString(),
+      chainId: chainId.toString(),
+      tokenAddress,
+      sender,
+      receiver,
+      purchaseData,
+      feePayer,
+    }),
+  });
+  if (!response.ok) {
+    const errorJson = await response.json();
+    throw new Error(
+      `${errorJson.code} | ${errorJson.message} - ${errorJson.correlationId}`,
+    );
+  }
+
+  const { data }: { data: PreparedQuote } = await response.json();
+  return {
+    originAmount: BigInt(data.originAmount),
+    destinationAmount: BigInt(data.destinationAmount),
+    blockNumber: data.blockNumber ? BigInt(data.blockNumber) : undefined,
+    timestamp: data.timestamp,
+    estimatedExecutionTimeMs: data.estimatedExecutionTimeMs,
+    steps: data.steps.map((step) => ({
+      ...step,
+      transactions: step.transactions.map((transaction) => ({
+        ...transaction,
+        value: transaction.value ? BigInt(transaction.value) : undefined,
+        client,
+        chain: defineChain(transaction.chainId),
+      })),
+    })),
+    intent: {
+      chainId,
+      tokenAddress,
+      amount,
+      sender,
+      receiver,
+      feePayer,
+    },
+  };
+}
+
+export declare namespace prepare {
+  type Options = {
+    chainId: number;
+    tokenAddress: ox__Address.Address;
+    sender: ox__Address.Address;
+    receiver: ox__Address.Address;
+    amount: bigint;
+    client: ThirdwebClient;
+    purchaseData?: unknown;
+    feePayer?: "sender" | "receiver";
+  };
+
+  type Result = PreparedQuote & {
+    intent: {
+      chainId: number;
+      tokenAddress: ox__Address.Address;
+      amount: bigint;
+      sender: ox__Address.Address;
+      receiver: ox__Address.Address;
+      purchaseData?: unknown;
+      feePayer?: "sender" | "receiver";
+    };
+  };
+}

package/src/bridge/index.ts

@@ -1,10 +1,19 @@
 export * as Buy from "./Buy.js";
 export * as Sell from "./Sell.js";
+export * as Transfer from "./Transfer.js";
+export * as Onramp from "./Onramp.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";
+export type { Quote, PreparedQuote } from "./types/Quote.js";
+export type {
+  Route,
+  RouteQuoteStep,
+  RouteStep,
+  RouteTransaction,
+} 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";

package/src/bridge/types/BridgeAction.ts

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

package/src/bridge/types/Quote.ts

@@ -1,6 +1,4 @@
-import type { Hex as ox__Hex } from "ox";
-import type { Chain } from "../../chains/types.js";
-import type { ThirdwebClient } from "../../client/client.js";
+import type { RouteQuoteStep, RouteStep } from "./Route.js";
 
 export type Quote = {
   /**
@@ -26,29 +24,7 @@ export type Quote = {
   /**
    * The steps required to complete the quote.
    */
-  steps: Array<{
-    originToken: {
-      chainId: number;
-      address: ox__Hex.Hex;
-      symbol: string;
-      name: string;
-      decimals: number;
-      priceUsd: number;
-      iconUri: string;
-    };
-    destinationToken: {
-      chainId: number;
-      address: ox__Hex.Hex;
-      symbol: string;
-      name: string;
-      decimals: number;
-      priceUsd: number;
-      iconUri: string;
-    };
-    originAmount: bigint;
-    destinationAmount: bigint;
-    estimatedExecutionTimeMs: number;
-  }>;
+  steps: RouteQuoteStep[];
 };
 
 export type PreparedQuote = {
@@ -79,43 +55,5 @@ export type PreparedQuote = {
   /**
    * A series of steps required to complete the quote, along with the transactions to execute in order.
    */
-  steps: Array<{
-    originToken: {
-      chainId: number;
-      address: ox__Hex.Hex;
-      symbol: string;
-      name: string;
-      decimals: number;
-      priceUsd: number;
-      iconUri: string;
-    };
-    destinationToken: {
-      chainId: number;
-      address: ox__Hex.Hex;
-      symbol: string;
-      name: string;
-      decimals: number;
-      priceUsd: number;
-      iconUri: string;
-    };
-    originAmount: bigint;
-    destinationAmount: bigint;
-    estimatedExecutionTimeMs: number;
-    transactions: Array<{
-      data: ox__Hex.Hex;
-      to: ox__Hex.Hex;
-      value?: bigint | undefined;
-      chainId: number;
-      /**
-       * The action this transaction performs. This can be "approval", "transfer", "buy", or "sell".
-       */
-      action: "approval" | "transfer" | "buy" | "sell";
-      /**
-       * The transaction ID, used for tracking purposes.
-       */
-      id: ox__Hex.Hex;
-      client: ThirdwebClient;
-      chain: Chain;
-    }>;
-  }>;
+  steps: RouteStep[];
 };

package/src/bridge/types/Route.ts

@@ -1,20 +1,45 @@
-import type { Address as ox__Address } from "ox";
+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 { Token } from "./Token.js";
 
 export type Route = {
-  originToken: {
-    chainId: number;
-    address: ox__Address.Address;
-    decimals: number;
-    symbol: string;
-    name: string;
-    iconUri?: string;
-  };
-  destinationToken: {
-    chainId: number;
-    address: string;
-    decimals: number;
-    symbol: string;
-    name: string;
-    iconUri?: string;
-  };
+  originToken: Token;
+  destinationToken: Token;
+};
+
+export type RouteQuoteStep = {
+  originToken: Token;
+  destinationToken: Token;
+  originAmount: bigint;
+  destinationAmount: bigint;
+  estimatedExecutionTimeMs: number;
+};
+
+export type RouteStep = {
+  originToken: Token;
+  destinationToken: Token;
+  originAmount: bigint;
+  destinationAmount: bigint;
+  estimatedExecutionTimeMs: number;
+  transactions: RouteTransaction[];
+};
+
+export type RouteTransaction = {
+  data: ox__Hex.Hex;
+  to: ox__Hex.Hex;
+  value?: bigint | undefined;
+  chainId: number;
+
+  /**
+   * The action this transaction performs. This can be "approval", "transfer", "buy", or "sell".
+   */
+  action: BridgeAction;
+  /**
+   * The transaction ID, used for tracking purposes.
+   */
+  id: ox__Hex.Hex;
+  client: ThirdwebClient;
+  chain: Chain;
 };

package/src/bridge/types/Status.ts

@@ -1,14 +1,19 @@
 import type { Address as ox__Address, Hex as ox__Hex } from "ox";
-
+import type { Token } from "./Token.js";
 export type Status =
   | {
       status: "COMPLETED";
+      paymentId: string;
       originAmount: bigint;
       destinationAmount: bigint;
       originChainId: number;
       destinationChainId: number;
       originTokenAddress: ox__Address.Address;
       destinationTokenAddress: ox__Address.Address;
+      originToken: Token;
+      destinationToken: Token;
+      sender: ox__Address.Address;
+      receiver: ox__Address.Address;
       transactions: Array<{
         chainId: number;
         transactionHash: ox__Hex.Hex;
@@ -17,24 +22,33 @@ export type Status =
     }
   | {
       status: "PENDING";
+      paymentId: string;
       originAmount: bigint;
       originChainId: number;
       destinationChainId: number;
       originTokenAddress: ox__Address.Address;
       destinationTokenAddress: ox__Address.Address;
+      originToken: Token;
+      destinationToken: Token;
+      sender: ox__Address.Address;
+      receiver: ox__Address.Address;
       transactions: Array<{
         chainId: number;
         transactionHash: ox__Hex.Hex;
       }>;
+      purchaseData?: unknown;
     }
   | {
       status: "FAILED";
+      paymentId: string;
       transactions: Array<{
         chainId: number;
         transactionHash: ox__Hex.Hex;
       }>;
+      purchaseData?: unknown;
     }
   | {
       status: "NOT_FOUND";
+      paymentId: string;
       transactions: [];
     };

package/src/bridge/types/Token.ts

@@ -0,0 +1,11 @@
+import type { Address as ox__Address } from "ox";
+
+export type Token = {
+  chainId: number;
+  address: ox__Address.Address;
+  decimals: number;
+  symbol: string;
+  name: string;
+  iconUri?: string;
+  priceUsd: number;
+};

package/src/extensions/ens/resolve-l2-name.ts

@@ -4,7 +4,6 @@ import * as ox__Bytes from "ox/Bytes";
 import * as ox__Ens from "ox/Ens";
 import * as ox__Hash from "ox/Hash";
 import * as ox__Hex from "ox/Hex";
-import { keccak256 } from "viem";
 import type { Chain } from "../../chains/types.js";
 import type { ThirdwebClient } from "../../client/client.js";
 import { getContract } from "../../contract/contract.js";
@@ -47,7 +46,6 @@ const convertReverseNodeToBytes = (address: Address, chainId: number) => {
       [reverseNode, addressNode],
     ),
   );
-  keccak256;
   return addressReverseNode;
 };
 

package/src/pay/buyWithCrypto/commonTypes.ts

@@ -10,16 +10,6 @@ export type QuoteTokenInfo = {
   symbol?: string;
 };
 
-export type QuoteTransactionRequest = {
-  data: string;
-  to: string;
-  value: string;
-  from: string;
-  chainId: number;
-  gasPrice: string;
-  gasLimit: string;
-};
-
 export type QuoteApprovalInfo = {
   chainId: number;
   tokenAddress: string;