Documentation
    Preparing search index...

    Type Alias SwapEstimates

    A collection of estimated values from quoting a swap.

    Approximate number of input token swapped in the swap

    Approximate number of output token swapped in the swap

    Approximate tick-index the Whirlpool will land on after this swap

    Approximate sqrtPrice the Whirlpool will land on after this swap

    Approximate feeAmount (all fees) charged on this swap

    Approximate minimum fee rate on this swap

    Approximate maximum fee rate on this swap

    type SwapEstimates = {
        estimatedAmountIn: BN;
        estimatedAmountOut: BN;
        estimatedEndSqrtPrice: BN;
        estimatedEndTickIndex: number;
        estimatedFeeAmount: BN;
        estimatedFeeRateMax: number;
        estimatedFeeRateMin: number;
        transferFee: {
            deductedFromEstimatedAmountOut: BN;
            deductingFromEstimatedAmountIn: BN;
        };
    }
    Index

    Properties

    estimatedAmountIn estimatedAmountOut estimatedEndSqrtPrice estimatedEndTickIndex estimatedFeeAmount estimatedFeeRateMax estimatedFeeRateMin transferFee

    Properties

    estimatedAmountIn: BN
    estimatedAmountOut: BN
    estimatedEndSqrtPrice: BN
    estimatedEndTickIndex: number
    estimatedFeeAmount: BN
    estimatedFeeRateMax: number
    estimatedFeeRateMin: number
    transferFee: {
        deductedFromEstimatedAmountOut: BN;
        deductingFromEstimatedAmountIn: BN;
    }

    Settings

    Member Visibility

    On This Page

    Properties