[SDK] Refactor: Update Pay Functions to use UB (#7064)

Signed-off-by: samina <[email protected]>
Signed-off-by: Maximilian Hubert <[email protected]>
Co-authored-by: Claude <[email protected]>
Co-authored-by: Joaquim Verges <[email protected]>
Co-authored-by: kumaryash90 <[email protected]>
Co-authored-by: Prithvish Baidya <[email protected]>
Co-authored-by: samina <[email protected]>
Co-authored-by: Maximilian Hubert <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jonas Daniels <[email protected]>
Co-authored-by: arcoraven <[email protected]>

Author: 10 people

.changeset/open-readers-do.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+Faster useSendTransaction execution

.changeset/stale-yaks-bathe.md

@@ -0,0 +1,154 @@
+---
+"thirdweb": minor
+---
+
+Adds Bridge.Transfer module for direct token transfers:
+
+```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 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
+  ...
+}
+```

apps/dashboard/src/@/constants/thirdweb.server.ts

@@ -3,6 +3,7 @@ import {
   NEXT_PUBLIC_IPFS_GATEWAY_URL,
 } from "@/constants/public-envs";
 import {
+  THIRDWEB_BRIDGE_URL,
   THIRDWEB_BUNDLER_DOMAIN,
   THIRDWEB_INAPP_WALLET_DOMAIN,
   THIRDWEB_INSIGHT_API_DOMAIN,
@@ -35,6 +36,7 @@ export function getConfiguredThirdwebClient(options: {
       social: THIRDWEB_SOCIAL_API_DOMAIN,
       bundler: THIRDWEB_BUNDLER_DOMAIN,
       insight: THIRDWEB_INSIGHT_API_DOMAIN,
+      bridge: THIRDWEB_BRIDGE_URL,
     });
   }
 

apps/dashboard/src/constants/urls.ts

@@ -26,3 +26,6 @@ export const THIRDWEB_INSIGHT_API_DOMAIN =
 
 export const THIRDWEB_ANALYTICS_DOMAIN =
   process.env.NEXT_PUBLIC_ANALYTICS_URL || "c.thirdweb-dev.com";
+
+export const THIRDWEB_BRIDGE_URL =
+  process.env.NEXT_PUBLIC_BRIDGE_URL || "bridge.thirdweb-dev.com";

apps/login/src/lib/dev-mode.ts

@@ -1,5 +1,6 @@
 import { setThirdwebDomains } from "thirdweb/utils";
 import {
+  THIRDWEB_BRIDGE_DOMAIN,
   THIRDWEB_BUNDLER_DOMAIN,
   THIRDWEB_INAPP_WALLET_DOMAIN,
   THIRDWEB_PAY_DOMAIN,
@@ -19,6 +20,7 @@ export function initDevMode() {
       storage: THIRDWEB_STORAGE_DOMAIN,
       social: THIRDWEB_SOCIAL_API_DOMAIN,
       bundler: THIRDWEB_BUNDLER_DOMAIN,
+      bridge: THIRDWEB_BRIDGE_DOMAIN,
     });
   }
 }

apps/login/src/lib/urls.ts

@@ -16,3 +16,6 @@ export const THIRDWEB_SOCIAL_API_DOMAIN =
 
 export const THIRDWEB_BUNDLER_DOMAIN =
   process.env.NEXT_PUBLIC_BUNDLER_URL || "bundler.thirdweb-dev.com";
+
+export const THIRDWEB_BRIDGE_DOMAIN =
+  process.env.NEXT_PUBLIC_BRIDGE_URL || "bridge.thirdweb-dev.com";

apps/playground-web/src/lib/client.ts

@@ -10,6 +10,7 @@ setThirdwebDomains({
   pay: process.env.NEXT_PUBLIC_PAY_URL,
   analytics: process.env.NEXT_PUBLIC_ANALYTICS_URL,
   insight: process.env.NEXT_PUBLIC_INSIGHT_URL,
+  bridge: process.env.NEXT_PUBLIC_BRIDGE_URL,
 });
 
 const isDev =

packages/thirdweb/.size-limit.json

@@ -8,7 +8,7 @@
   {
     "name": "thirdweb (cjs)",
     "path": "./dist/cjs/exports/thirdweb.js",
-    "limit": "200 kB"
+    "limit": "350 kB"
   },
   {
     "name": "thirdweb (minimal + tree-shaking)",

packages/thirdweb/src/bridge/Buy.ts

@@ -1,9 +1,9 @@
 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 { UNIVERSAL_BRIDGE_URL } from "./constants.js";
 import type { PreparedQuote, Quote } from "./types/Quote.js";
 
 /**
@@ -113,12 +113,13 @@ export async function quote(options: quote.Options): Promise<quote.Result> {
     "buyAmountWei" in options ? options.buyAmountWei : options.amount;
 
   const clientFetch = getClientFetch(client);
-  const url = new URL(`${UNIVERSAL_BRIDGE_URL}/buy/quote`);
+  const url = new URL(`${getThirdwebBaseUrl("bridge")}/v1/buy/quote`);
   url.searchParams.set("originChainId", originChainId.toString());
   url.searchParams.set("originTokenAddress", originTokenAddress);
   url.searchParams.set("destinationChainId", destinationChainId.toString());
   url.searchParams.set("destinationTokenAddress", destinationTokenAddress);
   url.searchParams.set("buyAmountWei", amount.toString());
+  url.searchParams.set("amount", amount.toString());
   if (maxSteps) {
     url.searchParams.set("maxSteps", maxSteps.toString());
   }
@@ -199,7 +200,7 @@ export declare namespace quote {
  * This will return a quote that might look like:
  * ```typescript
  * {
- *   originAmount: 10000026098875381n,
+ *   originAmount: 2000030000n,
  *   destinationAmount: 1000000000000000000n,
  *   blockNumber: 22026509n,
  *   timestamp: 1741730936680,
@@ -208,11 +209,11 @@ export declare namespace quote {
  *     {
  *       originToken: {
  *         chainId: 1,
- *         address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
- *         symbol: "ETH",
- *         name: "Ethereum",
- *         decimals: 18,
- *         priceUsd: 2000,
+ *         address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+ *         symbol: "USDC",
+ *         name: "USDC",
+ *         decimals: 6,
+ *         priceUsd: 1,
  *         iconUri: "https://..."
  *       },
  *       destinationToken: {
@@ -224,7 +225,7 @@ export declare namespace quote {
  *         priceUsd: 2000,
  *         iconUri: "https://..."
  *       },
- *       originAmount: 10000026098875381n,
+ *       originAmount: 2000030000n,
  *       destinationAmount: 1000000000000000000n,
  *       estimatedExecutionTimeMs: 1000
  *       transactions: [
@@ -250,7 +251,7 @@ export declare namespace quote {
  *   expiration: 1741730936680,
  *   intent: {
  *     originChainId: 1,
- *     originTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
+ *     originTokenAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  *     destinationChainId: 10,
  *     destinationTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
  *     amount: 1000000000000000000n
@@ -334,15 +335,16 @@ export async function prepare(
   } = options;
 
   const clientFetch = getClientFetch(client);
-  const url = new URL(`${UNIVERSAL_BRIDGE_URL}/buy/prepare`);
+  const url = new URL(`${getThirdwebBaseUrl("bridge")}/v1/buy/prepare`);
 
   const response = await clientFetch(url.toString(), {
     method: "POST",
     headers: {
       "Content-Type": "application/json",
     },
     body: stringify({
-      buyAmountWei: amount.toString(),
+      buyAmountWei: amount.toString(), // legacy
+      amount: amount.toString(),
       originChainId: originChainId.toString(),
       originTokenAddress,
       destinationChainId: destinationChainId.toString(),
@@ -382,6 +384,8 @@ export async function prepare(
       destinationChainId,
       destinationTokenAddress,
       amount,
+      sender,
+      receiver,
     },
   };
 }
@@ -407,6 +411,8 @@ export declare namespace prepare {
       destinationChainId: number;
       destinationTokenAddress: ox__Address.Address;
       amount: bigint;
+      sender: ox__Address.Address;
+      receiver: ox__Address.Address;
       purchaseData?: unknown;
     };
   };

packages/thirdweb/src/bridge/Chains.ts

@@ -1,6 +1,6 @@
 import type { ThirdwebClient } from "../client/client.js";
+import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
-import { UNIVERSAL_BRIDGE_URL } from "./constants.js";
 import type { Chain } from "./types/Chain.js";
 
 /**
@@ -54,7 +54,7 @@ export async function chains(options: chains.Options): Promise<chains.Result> {
   const { client } = options;
 
   const clientFetch = getClientFetch(client);
-  const url = new URL(`${UNIVERSAL_BRIDGE_URL}/chains`);
+  const url = new URL(`${getThirdwebBaseUrl("bridge")}/v1/chains`);
 
   const response = await clientFetch(url.toString());
   if (!response.ok) {

packages/thirdweb/src/bridge/Routes.ts

@@ -1,7 +1,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 { UNIVERSAL_BRIDGE_URL } from "./constants.js";
 import type { Route } from "./types/Route.js";
 
 /**
@@ -133,7 +133,7 @@ export async function routes(options: routes.Options): Promise<routes.Result> {
   } = options;
 
   const clientFetch = getClientFetch(client);
-  const url = new URL(`${UNIVERSAL_BRIDGE_URL}/routes`);
+  const url = new URL(`${getThirdwebBaseUrl("bridge")}/v1/routes`);
   if (originChainId) {
     url.searchParams.set("originChainId", originChainId.toString());
   }