Skip to main content
Version: V3

IQuoterV2

Supports quoting the calculated amounts from exact input or exact output swaps. For each pool also tells you the number of initialized ticks crossed and the sqrt price of the pool after the swap.

These functions are not marked view because they rely on calling non-view functions and reverting to compute the result. They are also not gas efficient and should not be called on-chain.

Functions#

quoteExactInput#

  function quoteExactInput(    bytes path,    uint256 amountIn  ) external returns (uint256 amountOut, uint160[] sqrtPriceX96AfterList, uint32[] initializedTicksCrossedList, uint256 gasEstimate)

Returns the amount out received for a given exact input swap without executing the swap

Parameters:#

NameTypeDescription
pathbytesThe path of the swap, i.e. each token pair and the pool fee
amountInuint256The amount of the first token to swap

Return Values:#

NameTypeDescription
amountOutbytesThe amount of the last token that would be received
sqrtPriceX96AfterListuint256List of the sqrt price after the swap for each pool in the path
initializedTicksCrossedListList of the initialized ticks that the swap crossed for each pool in the path
gasEstimateThe estimate of the gas that the swap consumes

quoteExactInputSingle#

  function quoteExactInputSingle(    struct IQuoterV2.QuoteExactInputSingleParams params  ) external returns (uint256 amountOut, uint160 sqrtPriceX96After, uint32 initializedTicksCrossed, uint256 gasEstimate)

Returns the amount out received for a given exact input but for a swap of a single pool

Parameters:#

NameTypeDescription
paramsstruct IQuoterV2.QuoteExactInputSingleParamsThe params for the quote, encoded as QuoteExactInputSingleParams

tokenIn The token being swapped in tokenOut The token being swapped out fee The fee of the token pool to consider for the pair amountIn The desired input amount sqrtPriceLimitX96 The price limit of the pool that cannot be exceeded by the swap

Return Values:#

NameTypeDescription
amountOutstruct IQuoterV2.QuoteExactInputSingleParamsThe amount of tokenOut that would be received
sqrtPriceX96AfterThe sqrt price of the pool after the swap
initializedTicksCrossedThe number of initialized ticks that the swap crossed
gasEstimateThe estimate of the gas that the swap consumes

quoteExactOutput#

  function quoteExactOutput(    bytes path,    uint256 amountOut  ) external returns (uint256 amountIn, uint160[] sqrtPriceX96AfterList, uint32[] initializedTicksCrossedList, uint256 gasEstimate)

Returns the amount in required for a given exact output swap without executing the swap

Parameters:#

NameTypeDescription
pathbytesThe path of the swap, i.e. each token pair and the pool fee. Path must be provided in reverse order
amountOutuint256The amount of the last token to receive

Return Values:#

NameTypeDescription
amountInbytesThe amount of first token required to be paid
sqrtPriceX96AfterListuint256List of the sqrt price after the swap for each pool in the path
initializedTicksCrossedListList of the initialized ticks that the swap crossed for each pool in the path
gasEstimateThe estimate of the gas that the swap consumes

quoteExactOutputSingle#

  function quoteExactOutputSingle(    struct IQuoterV2.QuoteExactOutputSingleParams params  ) external returns (uint256 amountIn, uint160 sqrtPriceX96After, uint32 initializedTicksCrossed, uint256 gasEstimate)

Returns the amount in required to receive the given exact output amount but for a swap of a single pool

Parameters:#

NameTypeDescription
paramsstruct IQuoterV2.QuoteExactOutputSingleParamsThe params for the quote, encoded as QuoteExactOutputSingleParams

tokenIn The token being swapped in tokenOut The token being swapped out fee The fee of the token pool to consider for the pair amountOut The desired output amount sqrtPriceLimitX96 The price limit of the pool that cannot be exceeded by the swap

Return Values:#

NameTypeDescription
amountInstruct IQuoterV2.QuoteExactOutputSingleParamsThe amount required as the input for the swap in order to receive amountOut
sqrtPriceX96AfterThe sqrt price of the pool after the swap
initializedTicksCrossedThe number of initialized ticks that the swap crossed
gasEstimateThe estimate of the gas that the swap consumes