V3Pool

This contract is V3 pools

Code

Github Link: (Will be updated after official launch)

Events, Read-Only Functions, and State-Changing Functions

Events

Events

Initialize​

event Initialize(
    uint160 sqrtPriceX96,
    int24 tick
)

Emitted exactly once by a pool when #initialize is first called on the pool

Mint/Burn/Swap cannot be emitted by the pool before Initialize

Parameters:​

Name	Type	Description
sqrtPriceX96	uint160	The initial sqrt price of the pool, as a Q64.96
tick	int24	The initial tick of the pool, i.e. log base 1.0001 of the starting price of the pool

Mint​

event Mint(
    address sender,
    address owner,
    int24 tickLower,
    int24 tickUpper,
    uint128 amount,
    uint256 amount0,
    uint256 amount1
)

Emitted when liquidity is minted for a given position

Parameters:​

Name	Type	Description
sender	address	The address that minted the liquidity
owner	address	The owner of the position and recipient of any minted liquidity
tickLower	int24	The lower tick of the position
tickUpper	int24	The upper tick of the position
amount	uint128	The amount of liquidity minted to the position range
amount0	uint256	How much token0 was required for the minted liquidity
amount1	uint256	How much token1 was required for the minted liquidity

Collect​

event Collect(
    address owner,
    int24 tickLower,
    int24 tickUpper,
    uint128 amount0,
    uint128 amount1
)

Emitted when fees are collected by the owner of a position

Collect events may be emitted with zero amount0 and amount1 when the caller chooses not to collect fees

Parameters:​

Name	Type	Description
owner	address	The owner of the position for which fees are collected
tickLower	int24	The lower tick of the position
tickUpper	int24	The upper tick of the position
amount0	uint128	The amount of token0 fees collected
amount1	uint128	The amount of token1 fees collected

Burn​

event Burn(
    address owner,
    int24 tickLower,
    int24 tickUpper,
    uint128 amount,
    uint256 amount0,
    uint256 amount1
)

Emitted when a position's liquidity is removed

Does not withdraw any fees earned by the liquidity position, which must be withdrawn via #collect

Parameters:​

Name	Type	Description
owner	address	The owner of the position for which liquidity is removed
tickLower	int24	The lower tick of the position
tickUpper	int24	The upper tick of the position
amount	uint128	The amount of liquidity to remove
amount0	uint256	The amount of token0 withdrawn
amount1	uint256	The amount of token1 withdrawn

Swap​

event Swap(
    address sender,
    address recipient,
    int256 amount0,
    int256 amount1,
    uint160 sqrtPriceX96,
    uint128 liquidity,
    int24 tick
)

Emitted by the pool for any swaps between token0 and token1

Parameters:​

Name	Type	Description
sender	address	The address that initiated the swap call, and that received the callback
recipient	address	The address that received the output of the swap
amount0	int256	The delta of the token0 balance of the pool
amount1	int256	The delta of the token1 balance of the pool
sqrtPriceX96	uint160	The sqrt(price) of the pool after the swap, as a Q64.96
liquidity	uint128	The liquidity of the pool after the swap
tick	int24	The log base 1.0001 of price of the pool after the swap

IncreaseObservationCardinalityNext​

event IncreaseObservationCardinalityNext(
    uint16 observationCardinalityNextOld,
    uint16 observationCardinalityNextNew
)

Emitted by the pool for increases to the number of observations that can be stored

observationCardinalityNext is not the observation cardinality until an observation is written at the index just before a mint/swap/burn.

Parameters:​

Name	Type	Description
observationCardinalityNextOld	uint16	The previous value of the next observation cardinality
observationCardinalityNextNew	uint16	The updated value of the next observation cardinality

Read-Only Functions

Read-Only Functions

factory​

function factory() external view returns (address)

The contract that deployed the pool, which must adhere to the IUniswapV3Factory interface

Return Values:​

Type	Description
address	contract address

token0​

function token0() external view returns (address)

The first of the two tokens of the pool, sorted by address

Return Values:​

Type	Description
address	token contract address

token1​

function token1() external view returns (address)

The second of the two tokens of the pool, sorted by address

Return Values:​

Type	Description
address	token contract address

fee​

function fee() external view returns (uint24)

The pool's fee in hundredths of a bip, i.e. 1e-6

Return Values:​

Type	Description
uint24	fee

tickSpacing​

function tickSpacing() external view returns (int24)

The pool tick spacing

Ticks can only be used at multiples of this value, minimum of 1 and always positive e.g.: a tickSpacing of 3 means ticks can be initialized every 3rd tick, i.e., ..., -6, -3, 0, 3, 6, ... This value is an int24 to avoid casting even though it is always positive.

Return Values:​

Type	Description
int24	tick spacing

maxLiquidityPerTick​

function maxLiquidityPerTick() external view returns (uint128)The maximum amount of position liquidity that can use any tick in the range

This parameter is enforced per tick to prevent liquidity from overflowing a uint128 at any point, and also prevents out-of-range liquidity from being used to prevent adding in-range liquidity to a pool

Return Values:​

Type	Description
uint128	max amount of liquidity per tick

snapshotCumulativesInside​

function snapshotCumulativesInside(
    int24 tickLower,
    int24 tickUpper
) external view 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 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

slot0​

function slot0() external view returns (
    uint160 sqrtPriceX96, 
    int24 tick, 
    uint16 observationIndex, 
    uint16 observationCardinality, 
    uint16 observationCardinalityNext, 
    uint8 feeProtocol, 
    bool unlocked
)

The 0th storage slot in the pool stores many values, and is exposed as a single method to save gas when accessed externally.

Return Values:​

Name	Type	Description
sqrtPriceX96	uint160	The current price of the pool as a sqrt(token1/token0) Q64.96 value
tick	int24	The current tick of the pool, i.e. according to the last tick transition that was run. This value may not always be equal to SqrtTickMath getTickAtSqrtRatio(sqrtPriceX96) if the price is on a tick boundary.
observationIndex	uint16	The index of the last oracle observation that was written,
observationCardinality	uint16	The current maximum number of observations stored in the pool,
observationCardinalityNext	uint16	The next maximum number of observations, to be updated when the observation.
feeProtocol	uint8	* unused *
unlocked	bool	Whether the pool is currently locked to reentrancy

feeGrowthGlobal0X128​

function feeGrowthGlobal0X128() external view returns (uint256)

The fee growth as a Q128.128 fees of token0 collected per unit of liquidity for the entire life of the pool

This value can overflow the uint256

feeGrowthGlobal1X128​

function feeGrowthGlobal1X128() external view returns (uint256)

The fee growth as a Q128.128 fees of token1 collected per unit of liquidity for the entire life of the pool

This value can overflow the uint256

liquidity​

function liquidity() external view returns (uint128)

The currently in range liquidity available to the pool

This value has no relationship to the total liquidity across all ticks

ticks​

function ticks(
    int24 tick
) external view returns (
    uint128 liquidityGross, 
    int128 liquidityNet, 
    uint256 feeGrowthOutside0X128, 
    uint256 feeGrowthOutside1X128, 
    int56 tickCumulativeOutside, 
    uint160 secondsPerLiquidityOutsideX128, 
    uint32 secondsOutside, 
    bool initialized,
    uint256 rewardGrowthOutsideX128
)

Look up information about a specific tick in the pool

Parameters:​

Name	Type	Description
tick	int24	The tick to look up

Return Values:​

Name	Type	Description
liquidityGross	uint128	the total amount of position liquidity that uses the pool either as tick lower or tick upper,
liquidityNet	int128	how much liquidity changes when the pool price crosses the tick,
feeGrowthOutside0X128	uint256	the fee growth on the other side of the tick from the current tick in token0,
feeGrowthOutside1X128	uint256	the fee growth on the other side of the tick from the current tick in token1, feeGrowthOutsideX128 values can only be used if the tick is initialized, i.e. if liquidityGross is greater than 0. In addition, these values are only relative and are used to compute snapshots.
tickCumulativeOutside	int56
secondsPerLiquidityOutsideX128	uint160
secondsOutside	uint32
initialized	bool
rewardGrowthOutsideX128	uint256	the reward growth on the other side of the tick from the current tick

positions​

function positions(
    bytes32 key
) external view returns (
    uint128 liquidity, 
    uint256 feeGrowthInside0LastX128, 
    uint256 feeGrowthInside1LastX128, 
    uint128 tokensOwed0, 
    uint128 tokensOwed1,
    uint256 rewardGrowthInsideLastX128,
    uint128 rewardOwed
)

Returns the information about a position by the position's key

Parameters:​

Name	Type	Description
key	bytes32	The position's key is a hash of a preimage composed by the owner, tickLower and tickUpper

Return Values:​

Name	Type	Description
liquidity	uint128	The amount of liquidity in the position,
feeGrowthInside0LastX128	uint256	fee growth of token0 inside the tick range as of the last mint/burn/poke,
feeGrowthInside1LastX128	uint256	fee growth of token1 inside the tick range as of the last mint/burn/poke,
tokensOwed0	uint128	the computed amount of token0 owed to the position as of the last mint/burn/poke,
tokensOwed1	uint128	the computed amount of token1 owed to the position as of the last mint/burn/poke
rewardGrowthInsideLastX128	uint256	reward growth inside the tick range as of the last mint/burn/poke,
rewardOwed	uint128	the computed amount of reward owed to the position as of the last mint/burn/poke,

observe​

function observe(
    uint32[] secondsAgos
) external view 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

observations​

function observations(
    uint256 index
) external view returns (
    uint32 blockTimestamp, 
    int56 tickCumulative, 
    uint160 secondsPerLiquidityCumulativeX128, 
    bool initialized
)

Returns data about a specific observation index

You most likely want to use #observe() instead of this method to get an observation as of some amount of time ago, rather than at a specific index in the array.

Parameters:​

Name	Type	Description
index	uint256	The element of the observations array to fetch

Return Values:​

Name	Type	Description
blockTimestamp	uint256	The timestamp of the observation,
tickCumulative	int56	the tick multiplied by seconds elapsed for the life of the pool as of the observation timestamp,
secondsPerLiquidityCumulativeX128	uint160	the seconds per in range liquidity for the life of the pool as of the observation timestamp
initialized	bool	whether the observation has been initialized and the values are safe to use

State-Changing Functions

State-Changing Functions

increaseObservationCardinalityNext​

function increaseObservationCardinalityNext(
    uint16 observationCardinalityNext
) external; 

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;

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 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 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 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 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

snapshotCumulativesInside​

function snapshotCumulativesInside(
    int24 tickLower,
    int24 tickUpper
) external 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