IUniswapV3PoolActions
Overview
License: GPL-2.0-or-later
Contains pool methods that can be called by anyone
Functions info
initialize (0xf637731d)
Sets the initial price for the pool
Price is represented as a sqrt(amountToken1/amountToken0) Q64.96 value
Parameters:
sqrtPriceX96
uint160
the initial sqrt price of the pool as a Q64.96
mint (0x3c8a7d8d)
Adds liquidity for the given recipient/tickLower/tickUpper position
The caller of this method receives a callback in the form of IUniswapV3MintCallback#uniswapV3MintCallback in which they must pay any token0 or token1 owed for the liquidity. The amount of token0/token1 due depends on tickLower, tickUpper, the amount of liquidity, and the current price.
Parameters:
recipient
address
The address for which the liquidity will be created
tickLower
int24
The lower tick of the position in which to add liquidity
tickUpper
int24
The upper tick of the position in which to add liquidity
amount
uint128
The amount of liquidity to mint
data
bytes
Any data that should be passed through to the callback
Return values:
amount0
uint256
The amount of token0 that was paid to mint the given amount of liquidity. Matches the value in the callback
amount1
uint256
The amount of token1 that was paid to mint the given amount of liquidity. Matches the value in the callback
collect (0x4f1eb3d8)
Collects tokens owed to a position
Does not recompute fees earned, which must be done either via mint or burn of any amount of liquidity. Collect must be called by the position owner. To withdraw only token0 or only token1, amount0Requested or amount1Requested may be set to zero. To withdraw all tokens owed, caller may pass any value greater than the actual tokens owed, e.g. type(uint128).max. Tokens owed may be from accumulated swap fees or burned liquidity.
Parameters:
recipient
address
The address which should receive the fees collected
tickLower
int24
The lower tick of the position for which to collect fees
tickUpper
int24
The upper tick of the position for which to collect fees
amount0Requested
uint128
How much token0 should be withdrawn from the fees owed
amount1Requested
uint128
How much token1 should be withdrawn from the fees owed
Return values:
amount0
uint128
The amount of fees collected in token0
amount1
uint128
The amount of fees collected in token1
burn (0xa34123a7)
Burn liquidity from the sender and account tokens owed for the liquidity to the position
Can be used to trigger a recalculation of fees owed to a position by calling with an amount of 0
Parameters:
tickLower
int24
The lower tick of the position for which to burn liquidity
tickUpper
int24
The upper tick of the position for which to burn liquidity
amount
uint128
How much liquidity to burn
Return values:
amount0
uint256
The amount of token0 sent to the recipient
amount1
uint256
The amount of token1 sent to the recipient
swap (0x128acb08)
Swap token0 for token1, or token1 for token0
The caller of this method receives a callback in the form of IUniswapV3SwapCallback#uniswapV3SwapCallback
Parameters:
recipient
address
The address to receive the output of the swap
zeroForOne
bool
The direction of the swap, true for token0 to token1, false for token1 to token0
amountSpecified
int256
The amount of the swap, which implicitly configures the swap as exact input (positive), or exact output (negative)
sqrtPriceLimitX96
uint160
The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this
value after the swap. If one for zero, the price cannot be greater than this value after the swap
data
bytes
Any data to be passed through to the callback
Return values:
amount0
int256
The delta of the balance of token0 of the pool, exact when negative, minimum when positive
amount1
int256
The delta of the balance of token1 of the pool, exact when negative, minimum when positive
flash (0x490e6cbc)
Receive token0 and/or token1 and pay it back, plus a fee, in the callback
The caller of this method receives a callback in the form of IUniswapV3FlashCallback#uniswapV3FlashCallback
Parameters:
recipient
address
The address which will receive the token0 and token1 amounts
amount0
uint256
The amount of token0 to send
amount1
uint256
The amount of token1 to send
data
bytes
Any data to be passed through to the callback
increaseObservationCardinalityNext (0x32148f67)
Increase the maximum number of price and liquidity observations that this pool will store
This method is no-op if the pool already has an observationCardinalityNext greater than or equal to the input observationCardinalityNext.
Parameters:
observationCardinalityNext
uint16
The desired minimum number of observations for the pool to store
Last updated