Type Alias SwapEstimates

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

A collection of estimated values from quoting a swap.

Type declaration

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

Param: estimatedAmountIn

Approximate number of input token swapped in the swap

Param: estimatedAmountOut

Approximate number of output token swapped in the swap

Param: estimatedEndTickIndex

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

Param: estimatedEndSqrtPrice

Approximate sqrtPrice the Whirlpool will land on after this swap

Param: estimatedFeeAmount

Approximate feeAmount (all fees) charged on this swap

Settings

Member Visibility