Hooks - Trails

All hooks and utilities are available from the 0xtrails package unless stated otherwise.

TrailsProvider

Required for Hooks: The TrailsProvider must wrap your application when using any Trails hooks. This provider configures the necessary context for all hook functionality.

import { TrailsProvider } from '0xtrails'

<TrailsProvider
  config={{
    trailsApiKey: "...",
    trailsApiUrl: "...", // optional
    sequenceIndexerUrl: "...", // optional
    sequenceNodeGatewayUrl: "..." // optional
  }}
>
  <App />
</TrailsProvider>

Configuration Options

Option	Type	Required	Description
`trailsApiKey`	`string`	Yes	Your Trails API key. Join the Trails Telegram group to request access.
`trailsApiUrl`	`string`	No	Custom API endpoint URL if using a self-hosted instance.
`sequenceIndexerUrl`	`string`	No	Custom Sequence indexer URL.
`sequenceNodeGatewayUrl`	`string`	No	Custom Sequence node gateway URL.
`sequenceMetadataUrl`	`string`	No	Custom Sequence metadata URL.
`sequenceApiUrl`	`string`	No	Custom Sequence API URL.
`walletConnectProjectId`	`string`	No	WalletConnect project ID for wallet connections.
`slippageTolerance`	`string \| number`	No	Default slippage tolerance for swaps (e.g., `0.005` for 0.5%).
`debug`	`boolean`	No	Enable debug logging (default: `false`).

Chains

import { getSupportedChains, useSupportedChains } from '0xtrails'

getSupportedChains(): Promise<Chain[]>
useSupportedChains(): { supportedChains: Chain[], isLoadingChains: boolean }

Utility Functions

import { getChainInfo, getAllChains } from '0xtrails'

// Get info for specific chain
const chain = getChainInfo(8453) // Base chain info

// Get all chains (including unsupported)
const allChains = getAllChains()

Chain Type

type Chain = {
  id: number
  name: string
  chainId: number
  rpcUrls: string[]
  nativeCurrency: {
    name: string
    symbol: string
    decimals: number
  }
  blockExplorerUrls?: string[]
  imageUrl?: string
}

Tokens

import { getSupportedTokens, useSupportedTokens, useTokenList } from '0xtrails'

useTokenList(): { tokens: Token[] | undefined, isLoadingTokens: boolean }
useSupportedTokens({ chainId?: number }): { supportedTokens: Token[], isLoadingTokens: boolean }
getSupportedTokens(): Promise<Token[]>

Additional Helpers

import { useTokenInfo, useTokenAddress } from '0xtrails'

// Returns basic info for an ERC-20 by address and chainId
const { tokenInfo, isLoading, error } = useTokenInfo({
  address: '0x...',
  chainId: 8453
})

// Get token address by symbol and chain
const tokenAddress = useTokenAddress({
  chainId: 8453,
  tokenSymbol: 'USDC'
})

Token Type

The unified Token type is used throughout the Trails SDK:

type Token = {
  // Required properties
  symbol: string
  name: string
  decimals: number
  contractAddress: string // Use zeroAddress for native tokens

  // Optional properties
  tokenId?: string
  chainId?: number
  chainName?: string
  imageUrl?: string
  isCustomToken?: boolean
  isSufficientBalance?: boolean
  isNativeToken?: boolean

  // Balance fields (raw → formatted → display)
  balance?: string // Raw big number string (e.g., "1000000000000000000")
  balanceFormatted?: string // Formatted number without commas (e.g., "1.0")
  balanceDisplay?: string // Formatted with commas (e.g., "1,000.00")

  // USD Balance fields
  balanceUsd?: number // Raw number (e.g., 1000.50)
  balanceUsdFormatted?: string // Without commas/symbol (e.g., "1000.50")
  balanceUsdDisplay?: string // With commas/symbol (e.g., "$1,000.50")

  // Price fields (raw → formatted → display)
  priceUsd?: number // Raw number (e.g., 1.50)
  priceUsdFormatted?: string // Without commas/symbol (e.g., "1.50")
  priceUsdDisplay?: string // With commas/symbol (e.g., "$1.50")
}

Balances

import {
  useTokenBalances,
  getAccountTotalBalanceUsd,
  useAccountTotalBalanceUsd,
  getHasSufficientBalanceToken,
  useHasSufficientBalanceToken,
  getHasSufficientBalanceUsd,
  useHasSufficientBalanceUsd,
} from '0xtrails'

Balance hooks and utilities:

useTokenBalances(address): Returns sorted token balances enriched with USD price
useAccountTotalBalanceUsd(address): Returns total USD balance across tokens
useHasSufficientBalanceUsd(address, targetUsd): Check if account has sufficient USD balance
useHasSufficientBalanceToken(address, tokenAddress, tokenAmount, chainId): Check token balance

Example Usage

import { useTokenBalances, useAccountTotalBalanceUsd } from '0xtrails'
import type { Token } from '0xtrails'

const WalletBalance = ({ address }: { address: string }) => {
  const { sortedTokens, isLoadingBalances } = useTokenBalances(address)
  const { totalBalanceUsd, totalBalanceUsdFormatted } = useAccountTotalBalanceUsd(address)

  if (isLoadingBalances) return <div>Loading balances...</div>

  return (
    <div>
      <h3>Total Balance: {totalBalanceUsdFormatted}</h3>
      {sortedTokens.map((token: Token) => (
        <div key={`${token.chainId}-${token.contractAddress}`}>
          {token.symbol}: {token.balanceDisplay} ({token.balanceUsdDisplay})
        </div>
      ))}
    </div>
  )
}

useTokenBalances Return Type

type UseTokenBalancesReturn = {
  sortedTokens: Token[] // Tokens sorted by USD balance (highest first)
  isLoadingBalances: boolean
  isLoadingPrices: boolean
  isLoadingSortedTokens: boolean
  balanceError: Error | null
}

Token balances are returned as Token[] with balance fields populated. See the Token Type above for all available fields including balance, balanceFormatted, balanceDisplay, balanceUsd, etc.

Quotes and Swapping

import { 
  useQuote, 
  TradeType,
  type UseQuoteReturn,
  type UseQuoteProps,
  type SwapReturn,
  type Quote
} from '0xtrails'

useQuote Hook

The useQuote hook provides real-time quotes for token swaps, cross-chain transfers and ability to pass in calldata for executions - enabling you to use Trails headlessly.

Usage Example

import { useEffect } from 'react'
import { useQuote, TradeType } from '0xtrails'
import { useWalletClient, useAccount } from 'wagmi'

export const SwapComponent = () => {
  const { data: walletClient } = useWalletClient()
  const { address } = useAccount()

  const { quote, swap, isLoadingQuote, quoteError, refetchQuote } = useQuote({
    walletClient,
    fromTokenAddress: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', // USDC
    fromChainId: 1, // Ethereum
    toTokenAddress: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913', // USDC
    toChainId: 8453, // Base
    swapAmount: '1000000', // 1 USDC
    tradeType: TradeType.EXACT_INPUT,
    toRecipient: address,
    slippageTolerance: '0.005', // 0.5%
    onStatusUpdate: (states) => {
      console.log('Transaction states:', states)
    },
    checkoutOnHandlers: {
      triggerCheckoutStart: () => {
        console.log("Checkout started")
      },
      triggerCheckoutSignatureConfirmed: () => {
        console.log("Signature confirmed")
      },
      triggerCheckoutSignatureRequest: () => {
        console.log("Signature request")
      },
      triggerCheckoutComplete: (
        txStatus: "success" | "fail",
        accountAddress?: string,
      ) => {
        console.log(`Checkout complete for account ${accountAddress}: ${txStatus}`)
      },
      triggerCheckoutStatusUpdate: (transactionStates: TransactionState[]) => {
        console.log("Transaction states updated:", transactionStates)
      },
      triggerCheckoutQuote: (quote: any) => {
        console.log("Quote received:", quote)
      },
      triggerCheckoutSignatureRejected: (error: any) => {
        console.log("Signature rejected:", error)
      },
    }
  })

  // Quotes can become stale; refetch every ~30 seconds
  useEffect(() => {
    const id = setInterval(() => {
      refetchQuote?.()
    }, 30000)
    return () => clearInterval(id)
  }, [refetchQuote])

  const handleSwap = async () => {
    if (!swap) return
    
    try {
      const result = await swap()
      console.log('Swap completed:', result)
    } catch (error) {
      console.error('Swap failed:', error)
    }
  }

  if (isLoadingQuote) return <div>Getting quote...</div>
  if (quoteError) return <div>Error: {String(quoteError)}</div>
  if (!quote) return <div>No quote available</div>

  return (
    <div>
      <div>
        From: {quote.fromAmount} {quote.originToken.symbol}
      </div>
      <div>
          To: {quote.toAmount} {quote.destinationToken.symbol}
      </div>
      <div>
          Fee: {quote.fees?.totalFeeAmountUsdDisplay}
      </div>
      <button onClick={handleSwap}>
        Execute Swap
      </button>
    </div>
  )
}

Types

type UseQuoteProps = {
  walletClient?: any 
  fromTokenAddress?: string | null
  fromChainId?: number | null
  toTokenAddress?: string | null
  toChainId?: number | null
  toCalldata?: string | null
  swapAmount?: string | bigint
  toRecipient?: string | null
  tradeType?: TradeType | null
  slippageTolerance?: string | number | null
  onStatusUpdate?: ((transactionStates: TransactionState[]) => void) | null
  swapProvider?: RouteProvider | null
  bridgeProvider?: RouteProvider | null
  checkoutOnHandlers?: Partial<CheckoutOnHandlers>
  paymasterUrl?: string
  selectedFeeOption?: FeeOption | null
  abortSignal?: AbortSignal
  apiKey?: string | null
  nodeGatewayEnv?: 'prod' | 'dev' | 'local' | 'cors-anywhere'
  isSmartWallet?: boolean | null
}

type UseQuoteReturn = {
  quote: Quote | null
  swap: (() => Promise<SwapReturn | null>) | null
  isLoadingQuote: boolean
  quoteError: unknown
  quoteErrorPrettified: string
  refetchQuote: () => void
  abort: () => void
}

enum TradeType {
  EXACT_INPUT = 'EXACT_INPUT',  // User specifies exact input amount
  EXACT_OUTPUT = 'EXACT_OUTPUT' // User specifies exact output amount
}

enum RouteProvider {
  AUTO = 'AUTO',
  CCTP = 'CCTP',
  LIFI = 'LIFI',
  RELAY = 'RELAY',
  SUSHI = 'SUSHI',
  ZEROX = 'ZEROX'
}

useTrailsSendTransaction

A powerful hook for creating, signing, and sending transactions using Trails SDK. Provides a wagmi-compatible API for sending transactions with automatic cross-chain orchestration.

Required Components: When using useTrailsSendTransaction, you must render TrailsHookModal inside your WagmiProvider for the modal UI to work properly.

Setup

import { TrailsProvider, TrailsHookModal } from '0xtrails'
import { WagmiProvider } from 'wagmi'

function App() {
  return (
    <WagmiProvider config={wagmiConfig}>
      <TrailsProvider config={{ trailsApiKey: 'YOUR_API_KEY' }}>
        <TrailsHookModal />
        <YourApp />
      </TrailsProvider>
    </WagmiProvider>
  )
}

Usage Examples

import { useTrailsSendTransaction } from '0xtrails'
import { parseEther } from 'viem'

export const SendTransaction = () => {
  const { sendTransaction, isPending, isSuccess } = useTrailsSendTransaction({
    onSuccess: (data) => console.log('Transaction successful:', data),
    onError: (error) => console.error('Transaction failed:', error),
  })

  // Simple native token send (wagmi-compatible)
  const handleSendNative = () => {
    sendTransaction({
      to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      value: parseEther('0.01'),
    })
  }

  // Cross-chain transaction with specific destination token
  // Modal opens for user to select origin token/chain
  const handleCrossChain = () => {
    sendTransaction({
      to: '0xaavePoolAddress',
      tokenAddress: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913', // USDC on Base
      tokenAmount: '3000000', // 3 USDC (6 decimals)
      data: '0x...', // Optional contract calldata
    })
  }

  return (
    <div>
      <button onClick={handleSendNative} disabled={isPending}>
        Send 0.01 ETH
      </button>
      <button onClick={handleCrossChain} disabled={isPending}>
        Deposit 3 USDC to AAVE
      </button>
      {isSuccess && <p>Transaction completed!</p>}
    </div>
  )
}

Types

type TrailsSendTransactionVariables = {
  to?: Address
  value?: bigint // Native token amount (wagmi-compatible)
  data?: Hex // Contract calldata
  
  // Destination token requirements
  tokenAddress?: Address // Destination token address
  tokenAmount?: string // Destination token amount (in smallest units)
  
  // Origin token parameters (optional - modal opens if not provided)
  fromTokenAddress?: Address // Origin token address
  fromChainId?: number // Origin chain ID
  fromAmount?: string // Origin token amount
}

type UseTrailsSendTransactionParameters = {
  onSuccess?: (data: SwapReturn, variables: TrailsSendTransactionVariables) => void
  onError?: (error: Error, variables: TrailsSendTransactionVariables) => void
  onSettled?: (data: SwapReturn | undefined, error: Error | null, variables: TrailsSendTransactionVariables) => void
  receiptActionButtonText?: string // Custom text for receipt button (default: "Transact Again")
  onReceiptAction?: () => void // Custom callback for receipt button
  // ... plus all UseQuoteProps options (slippageTolerance, paymasterUrl, etc.)
}

type UseTrailsSendTransactionReturnType = {
  sendTransaction: (variables: TrailsSendTransactionVariables, callbacks?: {...}) => void
  sendTransactionAsync: (variables: TrailsSendTransactionVariables, callbacks?: {...}) => Promise<SwapReturn>
  retry: () => void
  data: SwapReturn | undefined
  error: Error | null
  isPending: boolean
  isSuccess: boolean
  isError: boolean
  isIdle: boolean
  status: 'idle' | 'pending' | 'error' | 'success'
  reset: () => void
  variables: TrailsSendTransactionVariables | undefined
}

Constants

import { TRAILS_ROUTER_PLACEHOLDER_AMOUNT } from '0xtrails'

TRAILS_ROUTER_PLACEHOLDER_AMOUNT

This constant provides a placeholder value for amounts when encoding calldata in fund mode. It’s used to replace dynamic output amounts during contract execution. Use Case: When creating calldata for fund mode transactions where the final amount isn’t known until execution time, use this placeholder in your encoded function calls. The Trails system will replace it with the actual dynamic amount during contract execution. Example:

import { TrailsWidget } from "0xtrails"

import { encodeFunctionData } from 'viem'
import { TRAILS_ROUTER_PLACEHOLDER_AMOUNT } from '0xtrails'

export const Example = () => {
    const calldata = encodeFunctionData({
        abi: stakingABI,
        functionName: 'stake',
        args: [TRAILS_ROUTER_PLACEHOLDER_AMOUNT] // Will be replaced with actual amount
    })

    return (
        // Use in fund mode widget
        <TrailsWidget
            apiKey="YOUR_API_KEY"
            mode="fund"
            toAddress="0x..." // Staking contract
            toCalldata={calldata}
            toChainId={1}
            toToken="ETH"
        >
            <button>Stake ETH</button>
        </TrailsWidget >
    )
}

This pattern is essential for fund mode transactions where users choose their input amount, but the contract needs to receive the exact output amount after any swaps or bridging operations.

Transaction History

import {
  useIntentTransactionHistory,
  getAccountTransactionHistory,
  useAccountTransactionHistory,
  useIntentTransactionHistory,
  getTxTimeDiff,
} from '0xtrails'

getAccountTransactionHistory

Gets transaction history for a wallet address interacting with Trails. Signature:

function getAccountTransactionHistory(params: {
  chainId: number
  accountAddress: string
  pageSize?: number
  includeMetadata?: boolean
  page?: number
}): Promise<TransactionHistoryResponse>

Usage:

const history = await getAccountTransactionHistory({
  chainId: 1,
  accountAddress: '0x...',
  pageSize: 10,
})

useAccountTransactionHistory

Hook for fetching transaction history from a user’s wallet address for a specific chain.

import { useAccountTransactionHistory } from '0xtrails'

Usage

import { useAccountTransactionHistory } from '0xtrails'

export const TransactionList = () => {
    const { data, isLoading, error } = useAccountTransactionHistory({
        chainId: 1,
        accountAddress: '0x123...',
        // Optional:
        // pageSize: 10,
        // includeMetadata: true,
        // page: 0,
        // abortSignal: new AbortController().signal,
    })

    if (isLoading) return <div>Loading...</div>
    if (error) return <div>Error: {String(error)}</div>

    return (
        <div>
            {data?.transactions?.map(tx => (
                <div key={tx.txnHash}>
                    Transaction: {tx.txnHash} | Block: {tx.blockNumber} | Time: {tx.timestamp}
                </div>
            ))}
        </div>
    )
}

Types

type TransactionHistoryItemFromAPI = {
  txnHash: string
  blockNumber: number
  blockHash: string
  chainId: number
  metaTxnID: string | null
  transfers: Transfer[]
  timestamp: string
}

type TransactionHistoryItem = TransactionHistoryItemFromAPI & {
  explorerUrl?: string
  chainName?: string
}

type TransactionHistoryResponse = {
  page: {
    column: string
    pageSize: number
    more: boolean
  }
  transactions: TransactionHistoryItem[]
}

type GetAccountTransactionHistoryParams = {
  chainId: number
  accountAddress: string
  pageSize?: number
  includeMetadata?: boolean
  page?: number
  abortSignal?: AbortSignal
}

useIntentTransactionHistory

React hook for fetching transaction history for a specific intent address. Usage:

const {
    transactions: transactionHistory,
    loading: isLoadingHistory,
    error: historyError,
    refetch: refetchIntentHistory,
  } = useIntentTransactionHistory({
      accountAddress: '0x123...',
      pageSize: 10,
      enabled: true,
  })

getTxTimeDiff

Gets the time difference for a transaction in human-readable format. Signature: (timestamp: string | number) => string Usage:

const timeDiff = getTxTimeDiff(transaction.timestamp)
console.log(timeDiff) // "5 minutes ago"

Encoders

import { getERC20TransferData } from '0xtrails'

getERC20TransferData

Encodes ERC20 transfer calldata for token transfers. Signature: (params: { recipient: string, amount: bigint }) => string Usage:

const transferData = getERC20TransferData(
  {
    recipient: '0x1234567890123456789012345678901234567890',
    amount: 1000000n,
  }
)

Error Handling

import {
  InsufficientBalanceError,
  UserRejectionError,
  getIsUserRejectionError,
  getIsBalanceTooLowError,
  getIsApiError,
  getIsRateLimitedError,
  getIsRequiredAmountNotMetError,
  getIsNoAvailableQuoteError,
  getIsQuoteFailedError,
  getIsQuoteTokenError,
  getIsQuoteInputError,
  getIsInsufficientLiquidityError,
  getIsWalletAlreadyConnectedError,
  getPrettifiedErrorMessage,
} from '0xtrails'

Error Classes

InsufficientBalanceError

Error thrown when a user has insufficient balance to complete a transaction.

try {
  await swap()
} catch (error) {
  if (error instanceof InsufficientBalanceError) {
    console.error('Insufficient balance for this transaction')
  }
}

UserRejectionError

Error thrown when a user rejects a transaction in their wallet.

try {
  await swap()
} catch (error) {
  if (error instanceof UserRejectionError) {
    console.log('User rejected the transaction')
  }
}

Error Detection Utilities

All error detection functions have the same signature: (error: unknown) => boolean

Function	Description
`getIsUserRejectionError`	User rejected the transaction in their wallet
`getIsBalanceTooLowError`	Insufficient balance for the transaction
`getIsApiError`	API returned an error
`getIsRateLimitedError`	Request was rate limited
`getIsRequiredAmountNotMetError`	Required minimum amount not met
`getIsNoAvailableQuoteError`	No quote available for the requested swap
`getIsQuoteFailedError`	Quote request failed
`getIsQuoteTokenError`	Invalid token in quote request
`getIsQuoteInputError`	Invalid input parameters for quote
`getIsInsufficientLiquidityError`	Insufficient liquidity for the swap
`getIsWalletAlreadyConnectedError`	Wallet is already connected

getPrettifiedErrorMessage

Converts any error into a user-friendly message string. Signature: (error: unknown) => string

try {
  await swap()
} catch (error) {
  const userMessage = getPrettifiedErrorMessage(error)
  showNotification(userMessage)
  // e.g., "Insufficient balance" instead of technical error details
}

Example: Comprehensive Error Handling

import {
  getIsUserRejectionError,
  getIsBalanceTooLowError,
  getIsNoAvailableQuoteError,
  getIsRateLimitedError,
  getPrettifiedErrorMessage,
} from '0xtrails'

async function handleSwap() {
  try {
    await swap()
  } catch (error) {
    if (getIsUserRejectionError(error)) {
      // User cancelled - don't show error notification
      return
    }
    
    if (getIsBalanceTooLowError(error)) {
      showNotification('Not enough balance. Please add funds.')
      return
    }
    
    if (getIsNoAvailableQuoteError(error)) {
      showNotification('No route available for this swap. Try a different token pair.')
      return
    }
    
    if (getIsRateLimitedError(error)) {
      showNotification('Too many requests. Please wait a moment.')
      return
    }
    
    // Fallback to prettified message
    showNotification(getPrettifiedErrorMessage(error))
  }
}

useGetIntent

Hook to fetch intent data from the Trails API.

import { useGetIntent, type UseGetIntentParams, type UseGetIntentReturn } from '0xtrails'

Usage

import { useGetIntent } from '0xtrails'

export const IntentDetails = ({ intentId }: { intentId: string }) => {
  const { intent, isLoading, isError, error, refetch } = useGetIntent({
    intentId,
    enabled: true,
  })

  if (isLoading) return <div>Loading intent...</div>
  if (isError) return <div>Error: {error?.message}</div>
  if (!intent) return <div>Intent not found</div>

  return (
    <div>
      <p>Intent ID: {intent.intentId}</p>
      <p>Status: {intent.status}</p>
      <p>Origin Chain: {intent.quoteRequest.originChainId}</p>
      <p>Destination Chain: {intent.quoteRequest.destinationChainId}</p>
      <button onClick={refetch}>Refresh</button>
    </div>
  )
}

Types

type UseGetIntentParams = {
  intentId: string | undefined
  enabled?: boolean
}

type UseGetIntentReturn = {
  intent: Intent | null
  isLoading: boolean
  isError: boolean
  error: Error | null
  refetch: () => void
}

useTrailsRefund

Hook for handling refunds from stuck or failed intent transactions. Trails will automatically refund upon reverting, however this can be used in situations where funds are stuck without an explicit revert. This hook provides utilities to sign and execute refund transactions to recover funds from intent addresses.

import {
  useTrailsRefund,
  type UseTrailsRefundParams,
  type UseTrailsRefundReturn,
} from '0xtrails'

Usage

import { useTrailsRefund } from '0xtrails'
import { useWalletClient, useAccount } from 'wagmi'

export const RefundComponent = ({ intentId }: { intentId: string }) => {
  const { data: walletClient } = useWalletClient()
  const { address } = useAccount()

  const {
    intent,
    isLoadingIntent,
    hasIntentBalance,
    signPayload,
    getRefundTx,
    intentError,
  } = useTrailsRefund({
    intentId,
    walletClient,
    refundToAddress: address, // Optional: defaults to connected wallet
  })

  const handleRefund = async () => {
    try {
      // Step 1: Sign the refund payload
      const { signature, payload } = await signPayload()
      
      // Step 2: Get the refund transaction
      const refundTx = await getRefundTx({
        signedHash: signature,
        payload,
      })
      
      // Step 3: Execute the refund transaction
      const txHash = await walletClient.sendTransaction({
        to: refundTx.to,
        data: refundTx.data,
        chain: refundTx.chain,
      })
      
      console.log('Refund transaction sent:', txHash)
    } catch (error) {
      console.error('Refund failed:', error)
    }
  }

  if (isLoadingIntent) return <div>Loading intent...</div>
  if (intentError) return <div>Error: {intentError.message}</div>
  if (!hasIntentBalance) return <div>No balance to refund</div>

  return (
    <button onClick={handleRefund}>
      Refund Funds
    </button>
  )
}

Types

type UseTrailsRefundParams = {
  intentId: string | undefined
  walletClient?: WalletClient
  refundToAddress?: string // Optional: address to receive refund (defaults to wallet address)
}

type UseTrailsRefundReturn = {
  intent: Intent | null
  isLoadingIntent: boolean
  isLoadingBalances: boolean
  intentError: Error | null
  balancesError: Error | null
  hasIntentBalance: boolean
  refetchIntent: () => void
  signPayload: () => Promise<{
    signature: string
    payload: Payload
    refundCall: PayloadCall
  }>
  getRefundTx: (params: {
    signedHash: string
    payload: Payload
  }) => Promise<{
    to: `0x${string}`
    data: `0x${string}`
    chainId: number
    chain: Chain
  }>
}

useCommitIntent / useExecuteIntent

Mutation hooks for committing and executing intents. These are lower-level hooks for advanced users who need direct control over the intent lifecycle.

import { useCommitIntent, useExecuteIntent } from '0xtrails'

useCommitIntent

const { mutate: commitIntent, isPending, isError, error, data } = useCommitIntent()

// Commit an intent
commitIntent(intent)

useExecuteIntent

const { mutate: executeIntent, isPending, isError, error, data } = useExecuteIntent()

// Execute an intent with deposit signature
executeIntent({
  intent,
  depositSignature,
})

TrailsClient

For advanced use cases, you can access the underlying Trails API client directly.

import { getTrailsClient, useTrailsClient, TrailsClient } from '0xtrails'

useTrailsClient Hook

import { useTrailsClient } from '0xtrails'

function MyComponent() {
  const trailsClient = useTrailsClient()

  const fetchIntent = async (intentId: string) => {
    const response = await trailsClient.getIntent({ intentId })
    return response.intent
  }

  // Use client for direct API calls
}

getTrailsClient Function

For non-React contexts:

import { getTrailsClient } from '0xtrails'

const client = getTrailsClient({
  apiKey: 'YOUR_API_KEY',
  hostname: 'https://api.trails.xyz', // optional
})

// Direct API calls
const quote = await client.quoteIntent({
  originChainId: 1,
  destinationChainId: 8453,
  // ... other params
})

Advanced: Intent Functions

These are advanced functions for direct intent management. Most developers should use the TrailsWidget or useQuote hook instead.

import {
  calculateIntentAddress,
  calculateOriginAndDestinationIntentAddresses,
  commitIntent,
  sendOriginTransaction,
} from '0xtrails'

Types

type OriginCallParams = {
  to: string
  value: bigint
  data: string
  chainId: number
}

type RouteProvider = 'AUTO' | 'CCTP' | 'LIFI' | 'RELAY' | 'SUSHI' | 'ZEROX'

type TrailsFee = {
  amount: bigint
  amountUsd: number
  token: Token
}

calculateIntentAddress

Calculates the intent contract address for a given set of parameters. Signature: (params: IntentParams) => Promise<string> Usage:

const intentAddress = await calculateIntentAddress({
  fromChainId: 1,
  toChainId: 8453,
  // ... other params
})

calculateOriginAndDestinationIntentAddresses

Calculates both origin and destination intent addresses. Signature:

function calculateOriginAndDestinationIntentAddresses(
  params: IntentParams
): Promise<{ originAddress: string; destinationAddress: string }>

Usage:

const { originAddress, destinationAddress } = 
  await calculateOriginAndDestinationIntentAddresses(params)

commitIntent

Commits an intent to the blockchain. Signature: (params: CommitIntentParams) => Promise<CommitIntentResult> Usage:

const result = await commitIntent({
  walletClient,
  fromChainId: 1,
  toChainId: 8453,
  // ... other params
})

sendOriginTransaction

Sends the origin transaction for an intent. Signature: (params: SendOriginTxParams) => Promise<string> Usage:

const txHash = await sendOriginTransaction({
  walletClient,
  intentAddress: '0x...',
  // ... other params
})

SDK Documentation

​TrailsProvider

​Configuration Options

​Chains

​Utility Functions

​Chain Type

​Tokens

​Additional Helpers

​Token Type

​Balances

​Example Usage

​useTokenBalances Return Type

​Quotes and Swapping

​useQuote Hook

​Usage Example

​Types

​useTrailsSendTransaction

​Setup

​Usage Examples

​Types

​Constants

​TRAILS_ROUTER_PLACEHOLDER_AMOUNT

​Transaction History

​getAccountTransactionHistory

​useAccountTransactionHistory

​Usage

​Types

​useIntentTransactionHistory

​getTxTimeDiff

​Encoders

​getERC20TransferData

​Error Handling

​Error Classes

​InsufficientBalanceError

​UserRejectionError

​Error Detection Utilities

​getPrettifiedErrorMessage

​Example: Comprehensive Error Handling

​useGetIntent

​Usage

​Types

​useTrailsRefund

​Usage

​Types

​useCommitIntent / useExecuteIntent

​useCommitIntent

​useExecuteIntent

​TrailsClient

​useTrailsClient Hook

​getTrailsClient Function

​Advanced: Intent Functions

​Types

​calculateIntentAddress

​calculateOriginAndDestinationIntentAddresses

​commitIntent

​sendOriginTransaction

TrailsProvider

Configuration Options

Chains

Utility Functions

Chain Type

Tokens

Additional Helpers

Token Type

Balances

Example Usage

useTokenBalances Return Type

Quotes and Swapping

useQuote Hook

Usage Example

Types

useTrailsSendTransaction

Setup

Usage Examples

Types

Constants

TRAILS_ROUTER_PLACEHOLDER_AMOUNT

Transaction History

getAccountTransactionHistory

useAccountTransactionHistory

Usage

Types

useIntentTransactionHistory

getTxTimeDiff

Encoders

getERC20TransferData

Error Handling

Error Classes

InsufficientBalanceError

UserRejectionError

Error Detection Utilities

getPrettifiedErrorMessage

Example: Comprehensive Error Handling

useGetIntent

Usage

Types

useTrailsRefund

Usage

Types

useCommitIntent / useExecuteIntent

useCommitIntent

useExecuteIntent

TrailsClient

useTrailsClient Hook

getTrailsClient Function

Advanced: Intent Functions

Types

calculateIntentAddress

calculateOriginAndDestinationIntentAddresses

commitIntent

sendOriginTransaction