Interface CreateSwapQuoteResult

Result of creating a swap quote.

interface CreateSwapQuoteResult {
    blockNumber: bigint;
    execute: (
        options?: ExecuteSwapQuoteOptions,
    ) => Promise<ExecuteSwapQuoteResult>;
    fees: SwapFees;
    fromAmount: bigint;
    fromToken: `0x${string}`;
    issues: SwapIssues;
    liquidityAvailable: true;
    minToAmount: bigint;
    network: EvmSwapsNetwork;
    permit2?: { eip712: EIP712Message };
    toAmount: bigint;
    toToken: `0x${string}`;
    transaction?: {
        data: `0x${string}`;
        gas: bigint;
        gasPrice: bigint;
        to: `0x${string}`;
        value: bigint;
    };
}

Properties

blockNumber execute fees fromAmount fromToken issues liquidityAvailable minToAmount network permit2? toAmount toToken transaction?

Properties

blockNumber

blockNumber: bigint

The block number at which the liquidity conditions were examined.

execute

execute: (options?: ExecuteSwapQuoteOptions) => Promise<ExecuteSwapQuoteResult>

Execute the swap using the quote.

Type declaration

fees

fees: SwapFees

The estimated fees for the swap.

fromAmount

fromAmount: bigint

The amount to send in atomic units of the token.

fromToken

fromToken: `0x${string}`

The token to send (source token).

issues

issues: SwapIssues

Potential issues discovered during validation.

liquidityAvailable

liquidityAvailable: true

Whether liquidity is available for the swap.

minToAmount

minToAmount: bigint

The minimum amount to receive after slippage in atomic units of the token.

network

network: EvmSwapsNetwork

The network for which this swap quote was created.

Optionalpermit2

permit2?: { eip712: EIP712Message }

Permit2 data if required for the swap.

Type declaration

toAmount

toAmount: bigint

The amount to receive in atomic units of the token.

toToken

toToken: `0x${string}`

The token to receive (destination token).

Optionaltransaction

transaction?: {
    data: `0x${string}`;
    gas: bigint;
    gasPrice: bigint;
    to: `0x${string}`;
    value: bigint;
}

The transaction to execute the swap.

Type declaration

  • data: `0x${string}`

    The transaction data.

  • gas: bigint

    The gas limit for the transaction.

  • gasPrice: bigint

    The gas price for the transaction in Wei.

  • to: `0x${string}`

    The contract address to send the transaction to.

  • value: bigint

    The value to send with the transaction in Wei.

Settings

Member Visibility

On This Page

Properties