UniswapV3Pool
Functions
_blockTimestamp
function _blockTimestamp(
) internal view virtual returns (uint32)
Returns the block timestamp truncated to 32 bits, i.e. mod 2**32. This method is overridden in tests.
snapshotCumulativesInside
function snapshotCumulativesInside(
int24 tickLower,
int24 tickUpper
) external view override noDelegateCall returns (int56 tickCumulativeInside, uint160 secondsPerLiquidityInsideX128, uint32 secondsInside)
Returns a snapshot of the tick cumulative, seconds per liquidity and seconds inside a tick range
Snapshots must only be compared to other snapshots, taken over a period for which a position existed. I.e., snapshots cannot be compared if a position is not held for the entire period between when the first snapshot is taken and the second snapshot is taken.
Parameters:
| Name | Type | Description |
|---|---|---|
tickLower | int24 | The lower tick of the range |
tickUpper | int24 | The upper tick of the range |
Return Values:
| Name | Type | Description |
|---|---|---|
tickCumulativeInside | int56 | The snapshot of the tick accumulator for the range |
secondsPerLiquidityInsideX128 | uint160 | The snapshot of seconds per liquidity for the range |
secondsInside | uint32 | The snapshot of seconds per liquidity for the range |
observe
function observe(
uint32[] secondsAgos
) external view override noDelegateCall returns (int56[] tickCumulatives, uint160[] secondsPerLiquidityCumulativeX128s)
Returns the cumulative tick and liquidity as of each timestamp secondsAgo from the current block timestamp
To get a time weighted average tick or liquidity-in-range, you must call this with two values, one representing the beginning of the period and another for the end of the period. E.g., to get the last hour time-weighted average tick, you must call it with secondsAgos = [3600, 0]. The time weighted average tick represents the geometric time weighted average price of the pool, in log base sqrt(1.0001) of token1 / token0. The TickMath library can be used to go from a tick value to a ratio.
Parameters:
| Name | Type | Description |
|---|---|---|
secondsAgos | uint32[] | From how long ago each cumulative tick and liquidity value should be returned |
Return Values:
| Name | Type | Description |
|---|---|---|
tickCumulatives | int56[] | Cumulative tick values as of each secondsAgos from the current block timestamp |
secondsPerLiquidityCumulativeX128s | uint160[] | Cumulative seconds per liquidity-in-range value as of each secondsAgos from the current block |
timestamp
increaseObservationCardinalityNext
function increaseObservationCardinalityNext(
uint16 observationCardinalityNext
) external override lock noDelegateCall
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:
| Name | Type | Description |
|---|---|---|
observationCardinalityNext | uint16 | The desired minimum number of observations for the pool to store |
initialize
function initialize(
uint160 sqrtPriceX96
) external override
Sets the initial price for the pool
not locked because it initializes unlocked
Parameters:
| Name | Type | Description |
|---|---|---|
sqrtPriceX96 | uint160 | the initial sqrt price of the pool as a Q64.96 |
mint
function mint(
address recipient,
int24 tickLower,
int24 tickUpper,
uint128 amount,
bytes data
) external override lock returns (uint256 amount0, uint256 amount1)
Adds liquidity for the given recipient/tickLower/tickUpper position
noDelegateCall is applied indirectly via _modifyPosition
Parameters:
| Name | Type | Description |
|---|---|---|
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:
| Name | Type | Description |
|---|---|---|
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
function collect(
address recipient,
int24 tickLower,
int24 tickUpper,
uint128 amount0Requested,
uint128 amount1Requested
) external override lock returns (uint128 amount0, uint128 amount1)
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:
| Name | Type | Description |
|---|---|---|
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:
| Name | Type | Description |
|---|---|---|
amount0 | uint128 | The amount of fees collected in token0 |
amount1 | uint128 | The amount of fees collected in token1 |
burn
function burn(
int24 tickLower,
int24 tickUpper,
uint128 amount
) external override lock returns (uint256 amount0, uint256 amount1)
Burn liquidity from the sender and account tokens owed for the liquidity to the position
noDelegateCall is applied indirectly via _modifyPosition
Parameters:
| Name | Type | Description |
|---|---|---|
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:
| Name | Type | Description |
|---|---|---|
amount0 | uint256 | The amount of token0 sent to the recipient |
amount1 | uint256 | The amount of token1 sent to the recipient |
swap
function swap(
address recipient,
bool zeroForOne,
int256 amountSpecified,
uint160 sqrtPriceLimitX96,
bytes data
) external override noDelegateCall returns (int256 amount0, int256 amount1)
Swap token0 for token1, or token1 for token0
The caller of this method receives a callback in the form of IUniswapV3SwapCallback#uniswapV3SwapCallback
Parameters:
| Name | Type | Description |
|---|---|---|
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:
| Name | Type | Description |
|---|---|---|
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
function flash(
address recipient,
uint256 amount0,
uint256 amount1,
bytes data
) external override lock noDelegateCall
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 Can be used to donate underlying tokens pro-rata to currently in-range liquidity providers by calling with 0 amount{0,1} and sending the donation amount(s) from the callback
Parameters:
| Name | Type | Description |
|---|---|---|
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 |
setFeeProtocol
function setFeeProtocol(
uint8 feeProtocol0,
uint8 feeProtocol1
) external override lock onlyFactoryOwner
Set the denominator of the protocol's % share of the fees
Parameters:
| Name | Type | Description |
|---|---|---|
feeProtocol0 | uint8 | new protocol fee for token0 of the pool |
feeProtocol1 | uint8 | new protocol fee for token1 of the pool |
collectProtocol
function collectProtocol(
address recipient,
uint128 amount0Requested,
uint128 amount1Requested
) external override lock onlyFactoryOwner returns (uint128 amount0, uint128 amount1)
Collect the protocol fee accrued to the pool
Parameters:
| Name | Type | Description |
|---|---|---|
recipient | address | The address to which collected protocol fees should be sent |
amount0Requested | uint128 | The maximum amount of token0 to send, can be 0 to collect fees in only token1 |
amount1Requested | uint128 | The maximum amount of token1 to send, can be 0 to collect fees in only token0 |
Return Values:
| Name | Type | Description |
|---|---|---|
amount0 | uint128 | The protocol fee collected in token0 |
amount1 | uint128 | The protocol fee collected in token1 |