MaverickV2Quoter

Inherits: IMaverickV2Quoter

Quoter contract that provides swap and addLiquidity quotes.

The calculate functions in this contract use the pool's revert functionality to compute price and therefore are not view functions. They can be called offchain using a staticcall and will operate like view functions.

Functions

calculateAddLiquidity

Computes the token amounts required for a given set of addLiquidity parameters. The gas estimate is only a rough estimate and may not match a add's gas.

function calculateAddLiquidity(IMaverickV2Pool pool, IMaverickV2Pool.AddLiquidityParams calldata params)
    public
    returns (uint256 amountA, uint256 amountB, uint256 gasEstimate);

calculateMultiHopSwap

Calculates a multihop swap and returns the resulting amount and estimated gas. The gas estimate is only a rough estimate and may not match a swap's gas.

function calculateMultiHopSwap(bytes memory path, uint256 amount, bool exactOutput)
    external
    returns (uint256 returnAmount, uint256 gasEstimate);

Parameters

Name	Type	Description
path	bytes	The path of pools to swap through. Path is given by an packed array of (pool, tokenAIn) tuples. So each step in the path is 160 + 8 = 168 bits of data. e.g. path = abi.encodePacked(pool1, true, pool2, false);
amount	uint256	The input amount.
exactOutput	bool	A boolean indicating if exact output is required.

calculateSwap

Calculates a swap on a MaverickV2Pool and returns the resulting amount and estimated gas. The gas estimate is only a rough estimate and may not match a swap's gas.

function calculateSwap(IMaverickV2Pool pool, uint128 amount, bool tokenAIn, bool exactOutput, int32 tickLimit)
    public
    returns (uint256 amountIn, uint256 amountOut, uint256 gasEstimate);

Parameters

Name	Type	Description
pool	IMaverickV2Pool	The MaverickV2Pool to swap on.
amount	uint128	The input amount.
tokenAIn	bool	Indicates if token A is the input token.
exactOutput	bool	Indicates if the amount is the output amount (true) or input amount (false). If the tickLimit is reached, the full value of the exactOutput may not be returned because the pool will stop swapping before the whole order is filled.
tickLimit	int32	The tick limit for the swap. Once the swap lands in this tick, it will stop and return the output amount swapped up to that tick.

poolSqrtPrice

Pool's sqrt price.

function poolSqrtPrice(IMaverickV2Pool pool) public view returns (uint256 sqrtPrice);

maverickV2AddLiquidityCallback

function maverickV2AddLiquidityCallback(IERC20, IERC20, uint256 amountA, uint256 amountB, bytes calldata)
    external
    pure;

maverickV2SwapCallback

function maverickV2SwapCallback(IERC20, uint256 amountIn, uint256 amountOut, bytes calldata) external pure;