Typescript SDK

Sell.prepare

Prepares a finalized Bridge quote for the provided sell request with transaction data. This function will return everything quote does, with the addition of a series of prepared transactions and the associated expiration timestamp.

Example


import { Bridge, NATIVE_TOKEN_ADDRESS } from "thirdweb";
 
const quote = await Bridge.Sell.prepare({
  originChainId: 1,
  originTokenAddress: NATIVE_TOKEN_ADDRESS,
  destinationChainId: 10,
  destinationTokenAddress: NATIVE_TOKEN_ADDRESS,
  amount: toWei("0.01"),
  client: thirdwebClient,
});

This will return a quote that might look like:


{
  originAmount: 2000000000n,
  destinationAmount:  9980000000000000000n,
  blockNumber: 22026509n,
  timestamp: 1741730936680,
  estimatedExecutionTimeMs: 1000
  steps: [
    {
      originToken: {
        chainId: 1,
        address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        symbol: "USDC",
        name: "USDC",
        decimals: 6,
        priceUsd: 1,
        iconUri: "https://..."
      },
      destinationToken: {
        chainId: 10,
        address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
        symbol: "ETH",
        name: "Ethereum",
        decimals: 18,
        priceUsd: 2000,
        iconUri: "https://..."
      },
      originAmount: 2000000000n,
      destinationAmount:  9980000000000000000n,
      estimatedExecutionTimeMs: 1000
    }
    transactions: [
      {
        id: "0x...",
        action: "approval",
        to: "0x...",
        data: "0x...",
        chainId: 10,
        type: "eip1559"
      },
      {
        id: "0x...",
        action: "sell",
        to: "0x...",
        data: "0x...",
        chainId: 10,
        type: "eip1559"
      }
    ],
  ],
  expiration: 1741730936680,
  intent: {
    originChainId: 1,
    originTokenAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    destinationChainId: 10,
    destinationTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
    amount: 2000000000n
  }
}

Sending the transactions

The transactions array is a series of transactions ready to be executed (with sendTransaction) 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 bridge completion on the destination chain.

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.


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.


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,
});


function prepare(options: Options): Promise<Result>;

Parameters

The options for the quote.

Type


let options: Options;

Returns


let returnType: Promise<Result>;

A promise that resolves to a finalized quote and transactions for the requested sell.