API reference v1.0
Introduction
periphery
tokenomics
Quoter

Quoter

Quoter

Provides quotes for swaps Allows getting the expected amount out or amount in for a given swap without executing the swap Developer note: 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

PeripheryImmutableState

constructor(address,address,address) public

NameTypeDescription
_factoryaddress
_WNativeTokenaddress
_poolDeployeraddress

algebraSwapCallback

algebraSwapCallback(int256,int256,bytes) view external

Called to `msg.sender` after executing a swap via IAlgebraPool#swap.

NameTypeDescription
amount0Deltaint256The 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.
amount1Deltaint256The 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.
pathbytes

quoteExactInputSingle

quoteExactInputSingle(address,address,uint256,uint160) public

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

NameTypeDescription
tokenInaddressThe token being swapped in
tokenOutaddressThe token being swapped out
amountInuint256The desired input amount
limitSqrtPriceuint160The price limit of the pool that cannot be exceeded by the swap

Returns:

NameTypeDescription
amountOutuint256
feeuint16

quoteExactInput

quoteExactInput(bytes,uint256) external

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

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

Returns:

NameTypeDescription
amountOutuint256
feesuint16[]

quoteExactOutputSingle

quoteExactOutputSingle(address,address,uint256,uint160) public

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

NameTypeDescription
tokenInaddressThe token being swapped in
tokenOutaddressThe token being swapped out
amountOutuint256The desired output amount
limitSqrtPriceuint160The price limit of the pool that cannot be exceeded by the swap

Returns:

NameTypeDescription
amountInuint256
feeuint16

quoteExactOutput

quoteExactOutput(bytes,uint256) external

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

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

Returns:

NameTypeDescription
amountInuint256
feesuint16[]