Quoter

Allows getting the expected amount out or amount in for a given swap without executing the swap These functions are not gas efficient and should not be called on chain. Instead, optimistically execute the swap and check the amounts in the callback.

Functions

constructor

  function constructor(
  ) public

uniswapV3SwapCallback

  function uniswapV3SwapCallback(
    int256 amount0Delta,
    int256 amount1Delta,
    bytes data
  ) external

Called to msg.sender after executing a swap via IRamsesV3Pool#swap. In the implementation you must pay the pool tokens owed for the swap. The caller of this method must be checked to be a RamsesV3Pool deployed by the canonical RamsesV3Factory. amount0Delta and amount1Delta can both be 0 if no tokens were swapped.

Parameters:

Name	Type	Description
`amount0Delta`	int256	The amount of token0 that was sent (negative) or must be received (positive) by the pool by

the end of the swap. If positive, the callback must send that amount of token0 to the pool. |amount1Delta | int256 | The amount of token1 that was sent (negative) or must be received (positive) by the pool by the end of the swap. If positive, the callback must send that amount of token1 to the pool. |data | bytes | Any data passed through by the caller via the IRamsesV3PoolActions#swap call

quoteExactInputSingle

  function quoteExactInputSingle(
    address tokenIn,
    address tokenOut,
    int24 tickSpacing,
    uint256 amountIn,
    uint160 sqrtPriceLimitX96
  ) public returns (uint256 amountOut)

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

Parameters:

Name	Type	Description
`tokenIn`	address	The token being swapped in
`tokenOut`	address	The token being swapped out
`tickSpacing`	int24	The tick spacing of the pool
`amountIn`	uint256	The desired input amount
`sqrtPriceLimitX96`	uint160	The price limit of the pool that cannot be exceeded by the swap

Return Values:

Name	Type	Description
`amountOut`	uint256	The amount of `tokenOut` that would be received

quoteExactInput

  function quoteExactInput(
    bytes path,
    uint256 amountIn
  ) external returns (uint256 amountOut)

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

Parameters:

Name	Type	Description
`path`	bytes	The path of the swap, i.e. each token pair and the pool fee
`amountIn`	uint256	The amount of the first token to swap

Return Values:

Name	Type	Description
`amountOut`	uint256	The amount of the last token that would be received

quoteExactOutputSingle

  function quoteExactOutputSingle(
    address tokenIn,
    address tokenOut,
    int24 tickSpacing,
    uint256 amountOut,
    uint160 sqrtPriceLimitX96
  ) public returns (uint256 amountIn)

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

Parameters:

Name	Type	Description
`tokenIn`	address	The token being swapped in
`tokenOut`	address	The token being swapped out
`tickSpacing`	int24	The tick spacing of the pool
`amountOut`	uint256	The desired output amount
`sqrtPriceLimitX96`	uint160	The price limit of the pool that cannot be exceeded by the swap

Return Values:

Name	Type	Description
`amountIn`	uint256	The amount required as the input for the swap in order to receive `amountOut`

quoteExactOutput

  function quoteExactOutput(
    bytes path,
    uint256 amountOut
  ) external returns (uint256 amountIn)

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

Parameters:

Name	Type	Description
`path`	bytes	The path of the swap, i.e. each token pair and the pool fee
`amountOut`	uint256	The amount of the last token to receive

Return Values:

Name	Type	Description
`amountIn`	uint256	The amount of first token required to be paid

Overview

Guides

Reference

Functions

constructor

uniswapV3SwapCallback

Parameters:

quoteExactInputSingle

Parameters:

Return Values:

quoteExactInput

Parameters:

Return Values:

quoteExactOutputSingle

Parameters:

Return Values:

quoteExactOutput

Parameters:

Return Values:

​Functions

​constructor

​uniswapV3SwapCallback

​Parameters:

​quoteExactInputSingle

​Parameters:

​Return Values:

​quoteExactInput

​Parameters:

​Return Values:

​quoteExactOutputSingle

​Parameters:

​Return Values:

​quoteExactOutput

​Parameters:

​Return Values:

Functions

constructor

uniswapV3SwapCallback

Parameters:

quoteExactInputSingle

Parameters:

Return Values:

quoteExactInput

Parameters:

Return Values:

quoteExactOutputSingle

Parameters:

Return Values:

quoteExactOutput

Parameters:

Return Values: