0xtrails 0.16.2 → 0.17.1

package/dist/hooks/useQuote.d.ts

@@ -1,611 +0,0 @@
-import { TransactionReceipt, WalletClient } from 'viem';
-import { IntentTransaction, FeeOption, RouteProvider, PriceImpactDetails, IntentProtocolVersion } from '@0xtrails/api';
-import { FundMethod } from '../transactionIntent/types.js';
-import { Chain } from '../chains.js';
-import { Token } from '../tokens.js';
-import { TransactionState } from '../transactions.js';
-import { PrepareSendFees } from '../prepareSend.js';
-import { TrailsFeeBreakdown } from '../fees.js';
-import { CheckoutOnHandlers } from './useCheckout.js';
-import { OnrampTrackingData } from '../widget/types/analytics.js';
-import { ActionItem, Call } from '../actions/types.js';
-import { ChainIdentifier } from '../widget/shared/types.js';
-import { QuoteError } from '../quoteError.js';
-export { QuoteError } from '../quoteError.js';
-export type { QuoteErrorCode } from '../quoteError.js';
-export declare const quoteKeys: {
-    readonly all: readonly ["trails"];
-    readonly quotes: () => readonly ["trails", "quote"];
-    readonly quote: (params: {
-        senderAddress: string | null | undefined;
-        fromToken: string | null;
-        fromChainId: number | null;
-        toToken: string | null;
-        toChainId: number | null;
-        amount: string | null;
-        isAmountRaw: boolean;
-        recipient: string | null;
-        calldata: string | null;
-        tradeType: string | null;
-        slippage: string | number | null | undefined;
-        swapProvider: string | null | undefined;
-        bridgeProvider: string | null | undefined;
-        swapProviderFallback: boolean | undefined;
-        bridgeProviderFallback: boolean | undefined;
-        intentProtocolVersion: string | null | undefined;
-        apiKey: string | null | undefined;
-        isSmartWallet: boolean | null | undefined;
-        fundMethod: string | null | undefined;
-    }) => readonly ["trails", "quote", {
-        senderAddress: string | null | undefined;
-        fromToken: string | null;
-        fromChainId: number | null;
-        toToken: string | null;
-        toChainId: number | null;
-        amount: string | null;
-        isAmountRaw: boolean;
-        recipient: string | null;
-        calldata: string | null;
-        tradeType: string | null;
-        slippage: string | number | null | undefined;
-        swapProvider: string | null | undefined;
-        bridgeProvider: string | null | undefined;
-        swapProviderFallback: boolean | undefined;
-        bridgeProviderFallback: boolean | undefined;
-        intentProtocolVersion: string | null | undefined;
-        apiKey: string | null | undefined;
-        isSmartWallet: boolean | null | undefined;
-        fundMethod: string | null | undefined;
-    }];
-};
-/**
- * Configuration options for the `useQuote` hook.
- *
- * All parameters are optional, but the hook will not fetch a quote until all required
- * parameters are provided (connected wallet account or walletAddress, `from.token`,
- * `from.chain`, `to.token`, `to.chain`, exactly one of
- * `from.amount`/`from.amountRaw`/`to.amount`/`to.amountRaw`, and a
- * destination recipient or owner address).
- */
-export type QuoteFrom = {
-    /** Token address or symbol (e.g. "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" or "USDC"). Use zero address or native symbol (e.g. "ETH") for native tokens. Symbols are resolved against the supported token list for the specified chain. */
-    token: string;
-    /** Chain ID, name (e.g. "base"), or viem Chain object. */
-    chain: ChainIdentifier;
-    /**
-     * Amount to spend, as a human-readable decimal string (e.g. `"1.5"`).
-     * Scaled to the source token's decimals internally via `parseUnits`.
-     *
-     * If provided, this is an EXACT_INPUT quote. Mutually exclusive with `to.amount`,
-     * `to.amountRaw`, and `from.amountRaw`.
-     *
-     * Precision matches the token's decimals exactly — for an 18-decimal token
-     * you can pass values down to `"0.000000000000000001"` (1 wei) without loss.
-     * If you already have a raw wei value, prefer `amountRaw` to skip the
-     * `formatUnits` → `parseUnits` round-trip and the decimals lookup.
-     */
-    amount?: string;
-    /**
-     * Raw amount in the source token's smallest unit (wei) as a `bigint` or
-     * integer-only numeric string (e.g. `1000000n` or `"1000000"` for 1 USDC).
-     *
-     * If provided, this is an EXACT_INPUT quote. Mutually exclusive with
-     * `from.amount`, `to.amount`, and `to.amountRaw`.
-     *
-     * Pass this when you already have a raw on-chain value (e.g. from a balance
-     * query, contract event, or another bigint source) — it skips the internal
-     * `parseUnits` step and avoids the supported-tokens registry / on-chain
-     * `decimals()` lookup that exists solely to scale `amount`. Pair with
-     * `decimals` if you also want to bypass decimals resolution downstream.
-     */
-    amountRaw?: bigint | string;
-    /**
-     * Optional decimals override for the source token.
-     *
-     * Use this to skip the cold-path RPC for tokens not in the registry, or
-     * as a fallback when the RPC is unreliable.
-     */
-    decimals?: number;
-};
-export type QuoteTo = {
-    /** Token address or symbol (e.g. "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" or "USDC"). Use zero address or native symbol (e.g. "ETH") for native tokens. Symbols are resolved against the supported token list for the specified chain. */
-    token: string;
-    /** Chain ID, name (e.g. "arbitrum"), or viem Chain object. */
-    chain: ChainIdentifier;
-    /**
-     * Recipient address for the destination token. Defaults to the connected
-     * wallet address or walletAddress when omitted.
-     *
-     * Not supported with composable destination execution (`actions` or
-     * `to.calls`). In those modes, use per-action recipient fields instead.
-     */
-    recipient?: string | null;
-    /** Address to approve the destination token to. */
-    approve?: string | null;
-    /**
-     * @deprecated Use `to.calls` for raw custom calls or the top-level `actions` prop for pre-built DeFi actions (swap, lend, deposit, …).
-     *
-     * A single ABI-encoded calldata blob to execute on the destination chain after the funds land. Retained for backwards compatibility and will be removed in a future major release.
-     */
-    calldata?: string | null;
-    /**
-     * Amount to receive, as a human-readable decimal string (e.g. `"1.5"`).
-     * Scaled to the destination token's decimals internally via `parseUnits`.
-     *
-     * If provided, this is an EXACT_OUTPUT quote. Mutually exclusive with
-     * `from.amount`, `from.amountRaw`, and `to.amountRaw`.
-     *
-     * Precision matches the token's decimals exactly — for an 18-decimal token
-     * you can pass values down to `"0.000000000000000001"` (1 wei) without loss.
-     * If you already have a raw wei value, prefer `amountRaw` to skip the
-     * `formatUnits` → `parseUnits` round-trip and the decimals lookup.
-     */
-    amount?: string;
-    /**
-     * Raw amount in the destination token's smallest unit (wei) as a `bigint`
-     * or integer-only numeric string (e.g. `1000000n` or `"1000000"` for 1
-     * USDC).
-     *
-     * If provided, this is an EXACT_OUTPUT quote. Mutually exclusive with
-     * `to.amount`, `from.amount`, and `from.amountRaw`.
-     *
-     * Pass this when you already have a raw on-chain value (e.g. from a
-     * balance query, contract event, or another bigint source) — it skips the
-     * internal `parseUnits` step and avoids the supported-tokens registry /
-     * on-chain `decimals()` lookup that exists solely to scale `amount`. Pair
-     * with `decimals` if you also want to bypass decimals resolution
-     * downstream.
-     */
-    amountRaw?: bigint | string;
-    /**
-     * Optional decimals override for the destination token.
-     *
-     * Resolution order: this field → supported-tokens registry → on-chain
-     * `decimals()` read → throw.
-     *
-     * Use this to skip the cold-path RPC for tokens not in the registry, or
-     * as a fallback when the RPC is unreliable. **You are responsible for
-     * passing the correct value** — a mismatch will silently produce
-     * wrong-magnitude amounts.
-     */
-    decimals?: number;
-    /**
-     * Raw destination calls to execute on the destination chain after the funds land.
-     *
-     * Prefer the top-level `actions` prop for high-level DeFi primitives (swap, lend, deposit, …), reach for `calls` when you need to hand-roll ABI-encoded calls.
-     */
-    calls?: (Call | Call[])[] | null;
-};
-export type UseQuoteProps = {
-    /** Optional connected viem wallet client override. If present, `walletClient.account.address` is the quote owner and takes priority over `walletAddress`. If omitted, the hook reads from the Trails wallet runtime when available. Required for executing swaps via `send()`. */
-    walletClient?: WalletClient | null;
-    /** Explicit wallet address. Used as the quote owner only when `walletClient.account.address` is unavailable. Pass this to show quote previews before or without a wallet connection. */
-    walletAddress?: string | null;
-    /** Source token and chain configuration. */
-    from: QuoteFrom;
-    /** Destination token and chain configuration. */
-    to: QuoteTo;
-    slippageTolerance?: string | number | null;
-    onStatusUpdate?: ((transactionStates: TransactionState[]) => void) | null;
-    /** Swap provider (e.g. "LIFI", "CCTP", "RELAY"). */
-    swapProvider?: RouteProvider | null;
-    /** Bridge provider (e.g. "LIFI", "CCTP", "RELAY"). */
-    bridgeProvider?: RouteProvider | null;
-    swapProviderFallback?: boolean;
-    bridgeProviderFallback?: boolean;
-    checkoutOnHandlers?: Partial<CheckoutOnHandlers>;
-    /** Optional fee option selection (e.g., user selects USDC as the fee token instead of ETH) */
-    selectedFeeOption?: FeeOption | null;
-    abortSignal?: AbortSignal;
-    apiKey?: string | null;
-    nodeGatewayEnv?: "prod" | "dev" | "local" | "cors-anywhere";
-    isSmartWallet?: boolean | null;
-    fundMethod?: FundMethod | null;
-    onramp?: OnrampTrackingData | null;
-    mode?: "pay" | "fund" | "earn" | "swap" | "withdraw" | null;
-    intentProtocolVersion?: IntentProtocolVersion | null;
-    /**
-     * Composable destination actions (`swap`, `lend`, `deposit`, `custom`,
-     * `assertCondition`). Resolved into destination calls internally.
-     *
-     * Mutually exclusive with `to.calls` and the deprecated `to.calldata`.
-     *
-     * @example
-     * ```ts
-     * import { swap, lend } from "0xtrails"
-     *
-     * const actions = [
-     *   swap({
-     *     tokenIn: "WETH",
-     *     tokenOut: "USDC",
-     *     amountOut: "1000",
-     *     fee: "0.3"
-     *   }),
-     *   lend({ marketId: "base-usdc-aave-v3-lending", amount: "1000" }),
-     * ]
-     * ```
-     */
-    actions?: ActionItem[];
-};
-/**
- * Result returned by the `send` function from {@link useQuote}.
- *
- * Contains information about both the origin and destination transactions,
- * including transaction hashes, explorer URLs, and receipts.
- */
-export type SwapReturn = {
-    originTransaction: {
-        transactionHash?: string | null;
-        explorerUrl?: string | null;
-        receipt: TransactionReceipt | IntentTransaction | null;
-    };
-    destinationTransaction: {
-        transactionHash?: string | null;
-        explorerUrl?: string | null;
-        receipt: IntentTransaction | null;
-    };
-    totalCompletionSeconds?: number;
-};
-/**
- * Information about a quote provider (LiFi, CCTP, Relay, etc.) used for routing the swap.
- */
-export type RouteProviderInfo = {
-    id: string;
-    name: string;
-    url: string;
-};
-/**
- * A quote object containing all the details about a Trails intent transaction.
- *
- * Includes token amounts, fees, price impact, estimated completion time,
- * and other relevant information for displaying to the user.
- */
-export type Quote = {
-    /** Raw origin amount in smallest unit (wei). */
-    originAmount: string;
-    /** Minimum origin amount after slippage. */
-    originAmountMin: string;
-    /** Raw destination amount in smallest unit (wei). */
-    destinationAmount: string;
-    /** Minimum destination amount after slippage. */
-    destinationAmountMin: string;
-    /** Origin amount formatted as USD string (e.g. "$1.23"). */
-    originAmountUsdDisplay: string;
-    /** Destination amount formatted as USD string. */
-    destinationAmountUsdDisplay: string;
-    /** Human-readable origin amount (e.g. "1.5"). */
-    originAmountDisplay: string;
-    /** Human-readable destination amount. */
-    destinationAmountDisplay: string;
-    originAmountMinDisplay: string;
-    originAmountMinUsdFormatted: string;
-    originAmountMinUsdDisplay: string;
-    destinationAmountMinDisplay: string;
-    destinationAmountMinUsdFormatted: string;
-    destinationAmountMinUsdDisplay: string;
-    originAmountUsdFormatted: string;
-    destinationAmountUsdFormatted: string;
-    /** Human-readable origin amount formatted with user locale. */
-    originAmountFormattedLocale?: string;
-    /** Origin amount in USD formatted with user locale. */
-    originAmountUsdLocaleDisplay?: string;
-    /** Human-readable destination amount formatted with user locale. */
-    destinationAmountFormattedLocale?: string;
-    /** Destination amount in USD formatted with user locale. */
-    destinationAmountUsdLocaleDisplay?: string;
-    /** Origin amount as a numeric USD value for calculations. */
-    originAmountUsd?: number;
-    /** Human-readable origin amount (e.g. "1.5 USDC"). */
-    originAmountFormatted: string;
-    /** Human-readable destination amount (e.g. "0.001 ETH"). */
-    destinationAmountFormatted: string;
-    /** Intent protocol used for this quote. */
-    intentProtocol: string;
-    originToken: Token;
-    destinationToken: Token;
-    originChain: Chain;
-    destinationChain: Chain;
-    fees: PrepareSendFees;
-    slippageTolerance: string;
-    priceImpact: string;
-    priceImpactUsd: string | null;
-    priceImpactUsdDisplay: string;
-    priceImpactUsdLocaleDisplay?: string;
-    completionEstimateSeconds: number;
-    completionEstimateDisplay: string;
-    transactionStates: TransactionState[];
-    originTokenRate: string;
-    routeProviders: RouteProviderInfo[];
-    destinationTokenRate: string;
-    originTokenPriceUsd: number;
-    destinationTokenPriceUsd: number;
-    gasCostUsd: number | null;
-    gasCostUsdDisplay: string;
-    gasCost: string;
-    gasCostFormatted: string;
-    totalFeesUsd: number | null;
-    totalFeesUsdDisplay: string;
-    totalGasUsd: number | null;
-    totalGasUsdDisplay: string;
-    intentId: string | null;
-    originDepositAddress: string;
-    destinationDepositAddress: string;
-    destinationAddress: string;
-    destinationApproveAddress: string;
-    destinationCalldata: string;
-    trailsFeeBreakdown: TrailsFeeBreakdown | null;
-    originGasUsd: number | null;
-    originGasUsdDisplay: string;
-    destinationGasUsd: number | null;
-    destinationGasUsdDisplay: string;
-    providerFeeUsd: number | null;
-    providerFeeUsdDisplay: string;
-    trailsFeeUsd: number | null;
-    trailsFeeUsdDisplay: string;
-    totalProviderFeesUsd: number | null;
-    totalProviderFeesUsdDisplay: string;
-    totalGasUsdLocaleDisplay?: string;
-    originGasUsdLocaleDisplay?: string;
-    destinationGasUsdLocaleDisplay?: string;
-    totalProviderFeesUsdLocaleDisplay?: string;
-    providerFeeUsdLocaleDisplay?: string;
-    trailsFeeUsdLocaleDisplay?: string;
-    noSufficientBalance: boolean;
-    expiresAt: string | null;
-    priceImpactDetails: PriceImpactDetails | null;
-    passthroughEligible?: boolean;
-    passthroughTransactionStates?: TransactionState[];
-};
-/**
- * Return type for the {@link useQuote} hook.
- *
- * Provides the quote data, send function, loading state, error information,
- * and utility functions for managing the quote lifecycle.
- */
-export type SendOptions = {
-    /** Override the fee option for this transaction (e.g., pay gas in USDC instead of ETH). */
-    selectedFeeOption?: FeeOption | null;
-    /** Callback called when the wallet signature is confirmed and transaction is submitted. */
-    onOriginSend?: () => void;
-    /** For onramp-meld flow, provide the deposit transaction hash directly. */
-    depositTransactionHash?: string;
-    /** Skip committing the intent (used when intent is already committed). */
-    skipCommit?: boolean;
-};
-export type UseQuoteReturn = {
-    /** The quote object with transaction details, or `null` if not available. */
-    quote: Quote | null;
-    /** A function to execute the transaction, or `null` if not available. Returns a Promise that resolves to transaction result with receipts. Accepts optional SendOptions to override fee option. */
-    send: ((options?: SendOptions) => Promise<SwapReturn | null>) | null;
-    /** Boolean indicating if a quote is currently being fetched. */
-    isLoadingQuote: boolean;
-    /** Typed error with a `code` property for programmatic handling, or `null`. */
-    quoteError: QuoteError | null;
-    /** A user-friendly error message string (empty string when no error). */
-    quoteErrorPrettified: string;
-    /** Function to manually refetch the quote (useful for refreshing stale quotes). */
-    refetchQuote: () => Promise<void>;
-    /** Function to abort any in-flight quote requests. */
-    abort: () => void;
-    /** Fee options available for this quote (e.g., pay gas in different tokens). */
-    feeOptions: FeeOption[];
-    /** Whether the recipient address is a contract (null if not yet checked). */
-    isRecipientContract: boolean | null;
-    /** Whether the sender address is a contract on the origin chain (null if not yet checked). */
-    isSenderContractOnOrigin: boolean | null;
-    /** Whether the sender address is a contract on the destination chain (null if not yet checked). */
-    isSenderContractOnDestination: boolean | null;
-};
-export declare function resolveQuoteOwnerAddress({ walletClientAccountAddress, walletAddress, }: {
-    walletClientAccountAddress?: string | null;
-    walletAddress?: string | null;
-}): string | null;
-/**
- * React hook for fetching quotes and executing cross-chain or same-chain intent transactions.
- *
- * This hook provides a simple interface to get quotes for intent transactions and execute them.
- * It handles both cross-chain and same-chain intent transactions, automatically fetching token balances,
- * calculating fees, and providing transaction state updates.
- *
- * ## Required providers
- *
- * This hook **must** be rendered inside the following providers:
- *
- * 1. **`QueryClientProvider`** (@tanstack/react-query) — supplies the React Query cache
- * 2. **`TrailsProvider`** — supplies the API key, SDK configuration, and wallet integration
- *
- * `TrailsProvider` mounts the built-in wallet runtime by default, so
- * address-driven reads work without extra setup and execution can light up
- * once a wallet connects. Add `config.adapters` only when this hook should
- * share a host-owned wallet runtime instead.
- *
- * ```tsx
- * import { TrailsProvider } from '0xtrails'
- *
- * <QueryClientProvider client={queryClient}>
- *   <TrailsProvider config={{ trailsApiKey: 'YOUR_KEY' }}>
- *     <YourComponent />
- *   </TrailsProvider>
- * </QueryClientProvider>
- * ```
- *
- * Optional host-runtime integration:
- *
- * ```tsx
- * import { TrailsProvider } from '0xtrails'
- * import { wagmiAdapter } from '@0xtrails/adapter-wagmi'
- *
- * <QueryClientProvider client={queryClient}>
- *   <TrailsProvider
- *     config={{
- *       trailsApiKey: 'YOUR_KEY',
- *       adapters: [wagmiAdapter({ wagmiConfig })],
- *     }}
- *   >
- *     <YourComponent />
- *   </TrailsProvider>
- * </QueryClientProvider>
- * ```
- *
- * ## Destination execution modes
- *
- * Three mutually-exclusive ways to execute logic on the destination chain after the funds land:
- *
- * 1. **`actions`** (recommended, composable) — high-level DeFi primitives
- *    (`swap`, `lend`, `deposit`, `custom`, `assertCondition`). Resolved into destination calls internally.
- * 2. **`to.calls`** — array of raw `{ to, data, value }` calls when you need hand-rolled
- *    ABI-encoded transactions. Use for bespoke integrations not covered by the action factories.
- * 3. **`to.calldata`** — ⚠️ **deprecated**. A single ABI-encoded calldata blob. Retained for
- *    backwards compatibility; migrate to `calls` (or `actions`) in new code.
- *
- * Specifying more than one of these at a time throws a configuration error.
- *
- * ## Error handling
- *
- * The `quoteError` field is a {@link QuoteError} instance with a typed `code` property.
- * Use `quoteError.code` to programmatically distinguish failure modes:
- *
- * ```ts
- * if (quoteError?.code === 'INSUFFICIENT_LIQUIDITY') { ... }
- * if (quoteError?.code === 'NO_ROUTE') { ... }
- * ```
- *
- * @example
- * Exact input (spend 1 USDC from Base) — human-readable string:
- * ```tsx
- * const { quote, send } = useQuote({
- *   from: {
- *     token: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913', // USDC
- *     chain: 8453, // Base
- *     amount: '1', // 1 USDC — EXACT_INPUT
- *   },
- *   to: {
- *     token: '0x0000000000000000000000000000000000000000', // ETH
- *     chain: 42161, // Arbitrum
- *     recipient: address,
- *   },
- *   slippageTolerance: '0.005',
- *   onStatusUpdate: (states) => console.log(states),
- * })
- * ```
- *
- * @example
- * Exact output (receive 0.001 ETH on Arbitrum):
- * ```tsx
- * const { quote, send } = useQuote({
- *   from: {
- *     token: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913',
- *     chain: 8453,
- *   },
- *   to: {
- *     token: '0x0000000000000000000000000000000000000000',
- *     chain: 42161,
- *     recipient: address,
- *     amount: '0.001', // 0.001 ETH — EXACT_OUTPUT
- *   },
- * })
- * ```
- *
- * @example
- * Using token symbols instead of addresses:
- * ```tsx
- * const { quote, send } = useQuote({
- *   from: {
- *     token: 'USDC',
- *     chain: 'base',
- *     amount: '1', // 1 USDC
- *   },
- *   to: {
- *     token: 'ETH',
- *     chain: 'arbitrum',
- *     recipient: address,
- *   },
- * })
- * ```
- *
- * @example
- * Raw bigint amounts — skips `parseUnits` and the decimals registry/RPC
- * lookup when paired with `from.decimals`. Pass this when you already have
- * a raw on-chain value (e.g. from a balance query or contract event):
- * ```tsx
- * const { quote, send } = useQuote({
- *   from: {
- *     token: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913', // USDC
- *     chain: 8453,
- *     amountRaw: 1_000_000n, // 1 USDC (6 decimals) — EXACT_INPUT
- *     decimals: 6,
- *   },
- *   to: {
- *     token: '0x0000000000000000000000000000000000000000',
- *     chain: 42161,
- *     recipient: address,
- *   },
- * })
- * ```
- *
- * @example
- * Composable actions on the destination chain (swap + lend):
- * ```tsx
- * import { swap, lend } from '0xtrails'
- *
- * const { quote, send } = useQuote({
- *   from: { token: 'USDC', chain: 'base' },
- *   to: {
- *     token: 'USDC',
- *     chain: 'arbitrum',
- *     amount: '50', // 50 USDC
- *   },
- *   actions: [
- *     swap({
- *       tokenIn: 'USDC',
- *       tokenOut: 'WETH',
- *       amountIn: '25', // EXACT_INPUT (inferred)
- *     }),
- *     lend({
- *       marketId: 'arbitrum-usdc-aave-v3-lending',
- *       amount: '25',
- *     }),
- *   ],
- * })
- * ```
- *
- * @param props - Configuration options for the quote
- * @param props.walletClient - Optional viem `WalletClient` override. If provided, its account address is the quote owner. If omitted, uses the connected wallet client from the Trails wallet runtime when available.
- * @param props.walletAddress - Optional owner address for quote previews before or without a wallet connection. Ignored when a wallet client account address is available.
- * @param props.from - Source token, chain, and optional `amount` (human-readable decimal string) or `amountRaw` (bigint | integer-only string in wei) for EXACT_INPUT
- * @param props.to - Destination token, chain, recipient, and optional `amount` or `amountRaw` for EXACT_OUTPUT
- * @param props.actions - Optional composable destination actions built with the `swap`/`lend`/`deposit`/`custom`/`assertCondition` factories (mutually exclusive with `to.calls` and the deprecated `to.calldata`)
- * @param props.slippageTolerance - Slippage tolerance as a decimal string or number (e.g., '0.005' for 0.5%)
- * @param props.onStatusUpdate - Optional callback for transaction state updates
- * @param props.swapProvider - Optional swap provider ID
- * @param props.bridgeProvider - Optional bridge provider ID
- * @param props.abortSignal - Optional AbortSignal to cancel the quote request
- *
- * @returns An object containing:
- * - `quote` — The quote object with transaction details, or `null` if not available
- * - `send` — A function to execute the transaction, or `null` if not available
- * - `isLoadingQuote` — Boolean indicating if a quote is currently being fetched
- * - `quoteError` — A {@link QuoteError} with a typed `code`, or `null`
- * - `quoteErrorPrettified` — A user-friendly error message string
- * - `refetchQuote` — Function to manually refetch the quote
- * - `abort` — Function to abort any in-flight quote requests
- * - `feeOptions` — Fee options available for this quote
- *
- * @remarks
- * - The hook uses React Query internally, so quotes are cached and automatically refetched based on query key changes
- * - The hook will not fetch a quote until all required parameters are provided (connected wallet account or walletAddress, source/destination tokens and chains, one amount side, and a destination recipient or owner address). Missing parameters are logged as a console warning.
- * - `walletAddress` supports quote previews without a wallet connection. `send` remains unavailable until a real wallet client is connected.
- * - For native tokens (ETH, MATIC, etc.), use the zero address (`0x0000000000000000000000000000000000000000`) or the native currency symbol (e.g. `"ETH"`)
- * - Token symbols are resolved against the supported token list for the specified chain. If a symbol is not found, the quote will not fire. Prefer addresses in production for deterministic asset selection
- *
- * @throws {QuoteError} When the quote request fails. The error `code` discriminates the failure mode.
- *
- * @see {@link QuoteError} for the error class
- * @see {@link QuoteErrorCode} for available error codes
- * @see {@link Quote} for the quote object structure
- * @see {@link SwapReturn} for the swap result structure
- *
- * For more information go to {@link https://docs.trails.build/sdk/hooks#usequote-hook}
- */
-export declare function useQuote({ walletClient, walletAddress, from, to, actions, slippageTolerance, onStatusUpdate, checkoutOnHandlers, swapProvider, bridgeProvider, swapProviderFallback, bridgeProviderFallback, selectedFeeOption, nodeGatewayEnv, abortSignal: externalAbortSignal, apiKey, isSmartWallet, fundMethod, onramp, mode, intentProtocolVersion, }: UseQuoteProps): UseQuoteReturn;
-//# sourceMappingURL=useQuote.d.ts.map

package/dist/hooks/useQuote.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useQuote.d.ts","sourceRoot":"","sources":["../../src/hooks/useQuote.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAW,kBAAkB,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAoCrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAEtD,OAAO,KAAK,EAEV,UAAU,EACX,MAAM,+BAA+B,CAAA;AACtC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAGpD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AAC1D,OAAO,KAAK,EACV,SAAS,EACT,aAAa,EACb,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,eAAe,CAAA;AACtB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,KAAK,EACV,UAAU,EACV,IAAI,EAEL,MAAM,qBAAqB,CAAA;AAQ5B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAIhE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAoCtD,eAAO,MAAM,SAAS;;;6BAGJ;QACd,aAAa,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;QACxC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;QACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;QAC1B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;QACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;QACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;QACrB,WAAW,EAAE,OAAO,CAAA;QACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;QACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;QACxB,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;QAC5C,YAAY,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;QACvC,cAAc,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;QACzC,oBAAoB,EAAE,OAAO,GAAG,SAAS,CAAA;QACzC,sBAAsB,EAAE,OAAO,GAAG,SAAS,CAAA;QAC3C,qBAAqB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;QAChD,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;QACjC,aAAa,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAA;QACzC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;KACtC;uBAnBgB,MAAM,GAAG,IAAI,GAAG,SAAS;mBAC7B,MAAM,GAAG,IAAI;qBACX,MAAM,GAAG,IAAI;iBACjB,MAAM,GAAG,IAAI;mBACX,MAAM,GAAG,IAAI;gBAChB,MAAM,GAAG,IAAI;qBACR,OAAO;mBACT,MAAM,GAAG,IAAI;kBACd,MAAM,GAAG,IAAI;mBACZ,MAAM,GAAG,IAAI;kBACd,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;sBAC9B,MAAM,GAAG,IAAI,GAAG,SAAS;wBACvB,MAAM,GAAG,IAAI,GAAG,SAAS;8BACnB,OAAO,GAAG,SAAS;gCACjB,OAAO,GAAG,SAAS;+BACpB,MAAM,GAAG,IAAI,GAAG,SAAS;gBACxC,MAAM,GAAG,IAAI,GAAG,SAAS;uBAClB,OAAO,GAAG,IAAI,GAAG,SAAS;oBAC7B,MAAM,GAAG,IAAI,GAAG,SAAS;;CAE/B,CAAA;AAMV;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,8OAA8O;IAC9O,KAAK,EAAE,MAAM,CAAA;IACb,0DAA0D;IAC1D,KAAK,EAAE,eAAe,CAAA;IACtB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC3B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,8OAA8O;IAC9O,KAAK,EAAE,MAAM,CAAA;IACb,8DAA8D;IAC9D,KAAK,EAAE,eAAe,CAAA;IACtB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC3B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,IAAI,GAAG,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,kRAAkR;IAClR,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;IAClC,wLAAwL;IACxL,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,4CAA4C;IAC5C,IAAI,EAAE,SAAS,CAAA;IACf,iDAAiD;IACjD,EAAE,EAAE,OAAO,CAAA;IACX,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;IAC1C,cAAc,CAAC,EAAE,CAAC,CAAC,iBAAiB,EAAE,gBAAgB,EAAE,KAAK,IAAI,CAAC,GAAG,IAAI,CAAA;IACzE,oDAAoD;IACpD,YAAY,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;IACnC,sDAAsD;IACtD,cAAc,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;IACrC,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,kBAAkB,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAChD,8FAA8F;IAC9F,iBAAiB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IACpC,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,eAAe,CAAA;IAC3D,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC9B,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAC9B,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;IAClC,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,IAAI,CAAA;IAC3D,qBAAqB,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACpD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAA;CACvB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,iBAAiB,EAAE;QACjB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC3B,OAAO,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,IAAI,CAAA;KACvD,CAAA;IACD,sBAAsB,EAAE;QACtB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC3B,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAA;KAClC,CAAA;IACD,sBAAsB,CAAC,EAAE,MAAM,CAAA;CAChC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,gDAAgD;IAChD,YAAY,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,eAAe,EAAE,MAAM,CAAA;IACvB,qDAAqD;IACrD,iBAAiB,EAAE,MAAM,CAAA;IACzB,iDAAiD;IACjD,oBAAoB,EAAE,MAAM,CAAA;IAC5B,4DAA4D;IAC5D,sBAAsB,EAAE,MAAM,CAAA;IAC9B,kDAAkD;IAClD,2BAA2B,EAAE,MAAM,CAAA;IACnC,iDAAiD;IACjD,mBAAmB,EAAE,MAAM,CAAA;IAC3B,yCAAyC;IACzC,wBAAwB,EAAE,MAAM,CAAA;IAChC,sBAAsB,EAAE,MAAM,CAAA;IAC9B,2BAA2B,EAAE,MAAM,CAAA;IACnC,yBAAyB,EAAE,MAAM,CAAA;IACjC,2BAA2B,EAAE,MAAM,CAAA;IACnC,gCAAgC,EAAE,MAAM,CAAA;IACxC,8BAA8B,EAAE,MAAM,CAAA;IACtC,wBAAwB,EAAE,MAAM,CAAA;IAChC,6BAA6B,EAAE,MAAM,CAAA;IACrC,+DAA+D;IAC/D,2BAA2B,CAAC,EAAE,MAAM,CAAA;IACpC,uDAAuD;IACvD,4BAA4B,CAAC,EAAE,MAAM,CAAA;IACrC,oEAAoE;IACpE,gCAAgC,CAAC,EAAE,MAAM,CAAA;IACzC,4DAA4D;IAC5D,iCAAiC,CAAC,EAAE,MAAM,CAAA;IAC1C,6DAA6D;IAC7D,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,sDAAsD;IACtD,qBAAqB,EAAE,MAAM,CAAA;IAC7B,4DAA4D;IAC5D,0BAA0B,EAAE,MAAM,CAAA;IAClC,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE,KAAK,CAAA;IAClB,gBAAgB,EAAE,KAAK,CAAA;IACvB,WAAW,EAAE,KAAK,CAAA;IAClB,gBAAgB,EAAE,KAAK,CAAA;IACvB,IAAI,EAAE,eAAe,CAAA;IACrB,iBAAiB,EAAE,MAAM,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,qBAAqB,EAAE,MAAM,CAAA;IAC7B,2BAA2B,CAAC,EAAE,MAAM,CAAA;IACpC,yBAAyB,EAAE,MAAM,CAAA;IACjC,yBAAyB,EAAE,MAAM,CAAA;IACjC,iBAAiB,EAAE,gBAAgB,EAAE,CAAA;IACrC,eAAe,EAAE,MAAM,CAAA;IACvB,cAAc,EAAE,iBAAiB,EAAE,CAAA;IACnC,oBAAoB,EAAE,MAAM,CAAA;IAC5B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,iBAAiB,EAAE,MAAM,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;IACf,gBAAgB,EAAE,MAAM,CAAA;IACxB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,yBAAyB,EAAE,MAAM,CAAA;IACjC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,yBAAyB,EAAE,MAAM,CAAA;IACjC,mBAAmB,EAAE,MAAM,CAAA;IAC3B,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAA;IAC7C,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,wBAAwB,EAAE,MAAM,CAAA;IAChC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,qBAAqB,EAAE,MAAM,CAAA;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,2BAA2B,EAAE,MAAM,CAAA;IAEnC,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,8BAA8B,CAAC,EAAE,MAAM,CAAA;IACvC,iCAAiC,CAAC,EAAE,MAAM,CAAA;IAC1C,2BAA2B,CAAC,EAAE,MAAM,CAAA;IACpC,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,mBAAmB,EAAE,OAAO,CAAA;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAA;IAE7C,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,4BAA4B,CAAC,EAAE,gBAAgB,EAAE,CAAA;CAClD,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,2FAA2F;IAC3F,iBAAiB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IACpC,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,IAAI,CAAA;IACzB,2EAA2E;IAC3E,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,0EAA0E;IAC1E,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,6EAA6E;IAC7E,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;IACnB,mMAAmM;IACnM,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAA;IACpE,gEAAgE;IAChE,cAAc,EAAE,OAAO,CAAA;IACvB,+EAA+E;IAC/E,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;IAC7B,yEAAyE;IACzE,oBAAoB,EAAE,MAAM,CAAA;IAC5B,mFAAmF;IACnF,YAAY,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACjC,sDAAsD;IACtD,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,gFAAgF;IAChF,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,6EAA6E;IAC7E,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAAA;IACnC,8FAA8F;IAC9F,wBAAwB,EAAE,OAAO,GAAG,IAAI,CAAA;IACxC,mGAAmG;IACnG,6BAA6B,EAAE,OAAO,GAAG,IAAI,CAAA;CAC9C,CAAA;AAED,wBAAgB,wBAAwB,CAAC,EACvC,0BAA0B,EAC1B,aAAa,GACd,EAAE;IACD,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1C,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B,GAAG,MAAM,GAAG,IAAI,CAEhB;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8MG;AACH,wBAAgB,QAAQ,CAAC,EACvB,YAAY,EACZ,aAAa,EACb,IAAI,EACJ,EAAE,EACF,OAAO,EACP,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,WAAW,EAAE,mBAAmB,EAChC,MAAM,EACN,aAAa,EACb,UAAU,EACV,MAAM,EACN,IAAI,EACJ,qBAAqB,GACtB,EAAE,aAAa,GAAG,cAAc,CAkuChC"}