IUniswapV3PoolImmutables
These parameters are fixed for a pool forever, i.e., the methods will always return the same values
factory
function factory() external view returns (address)The contract that deployed the pool, which must adhere to the IUniswapV3Factory interface
Return Values
| Name | Type | Description |
|---|---|---|
| 0 | address | The contract address |
token0
function token0() external view returns (address)The first of the two tokens of the pool, sorted by address
Return Values
| Name | Type | Description |
|---|---|---|
| 0 | address | The token contract address |
token1
function token1() external view returns (address)The second of the two tokens of the pool, sorted by address
Return Values
| Name | Type | Description |
|---|---|---|
| 0 | address | The 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
| Name | Type | Description |
|---|---|---|
| 0 | uint24 | The 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
| Name | Type | Description |
|---|---|---|
| 0 | int24 | The 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
| Name | Type | Description |
|---|---|---|
| 0 | uint128 | The max amount of liquidity per tick |
IUniswapV3PoolDerivedState
Contains view functions to provide information about the pool that is computed rather than stored on the blockchain. The functions here may have variable gas costs.
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 |
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 |
IUniswapV3PoolState
These methods compose the pool's state, and can change with any frequency including multiple times per transaction
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 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 The index of the last oracle observation that was written, observationCardinality The current maximum number of observations stored in the pool, observationCardinalityNext The next maximum number of observations, to be updated when the observation. feeProtocol The protocol fee for both tokens of the pool. Encoded as two 4 bit values, where the protocol fee of token1 is shifted 4 bits and the protocol fee of token0 is the lower 4 bits. Used as the denominator of a fraction of the swap fee, e.g. 4 means 1/4th of the swap fee. unlocked Whether the pool is currently locked to reentrancy |
| tick | int24 | |
| observationIndex | uint16 | |
| observationCardinality | uint16 | |
| observationCardinalityNext | uint16 | |
| feeProtocol | uint8 | |
| unlocked | bool |
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
protocolFees
function protocolFees() external view returns (uint128 token0, uint128 token1)The amounts of token0 and token1 that are owed to the protocol
Protocol fees will never exceed uint128 max in either token
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)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 how much liquidity changes when the pool price crosses the tick, feeGrowthOutside0X128 the fee growth on the other side of the tick from the current tick in token0, feeGrowthOutside1X128 the fee growth on the other side of the tick from the current tick in token1, tickCumulativeOutside the cumulative tick value on the other side of the tick from the current tick secondsPerLiquidityOutsideX128 the seconds spent per liquidity on the other side of the tick from the current tick, secondsOutside the seconds spent on the other side of the tick from the current tick, initialized Set to true if the tick is initialized, i.e. liquidityGross is greater than 0, otherwise equal to false. Outside 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 must be used only in comparison to previous snapshots for a specific position. |
| liquidityNet | int128 | |
| feeGrowthOutside0X128 | uint256 | |
| feeGrowthOutside1X128 | uint256 | |
| tickCumulativeOutside | int56 | |
| secondsPerLiquidityOutsideX128 | uint160 | |
| secondsOutside | uint32 | |
| initialized | bool |
tickBitmap
function tickBitmap(int16 wordPosition) external view returns (uint256)Returns 256 packed tick initialized boolean values. See TickBitmap for more information
positions
function positions(bytes32 key) external view returns (uint128 _liquidity, uint256 feeGrowthInside0LastX128, uint256 feeGrowthInside1LastX128, uint128 tokensOwed0, uint128 tokensOwed1)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, Returns feeGrowthInside0LastX128 fee growth of token0 inside the tick range as of the last mint/burn/poke, Returns feeGrowthInside1LastX128 fee growth of token1 inside the tick range as of the last mint/burn/poke, Returns tokensOwed0 the computed amount of token0 owed to the position as of the last mint/burn/poke, Returns tokensOwed1 the computed amount of token1 owed to the position as of the last mint/burn/poke |
| feeGrowthInside0LastX128 | uint256 | |
| feeGrowthInside1LastX128 | uint256 | |
| tokensOwed0 | uint128 | |
| tokensOwed1 | uint128 |
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 | uint32 | The timestamp of the observation, Returns tickCumulative the tick multiplied by seconds elapsed for the life of the pool as of the observation timestamp, Returns secondsPerLiquidityCumulativeX128 the seconds per in range liquidity for the life of the pool as of the observation timestamp, Returns initialized whether the observation has been initialized and the values are safe to use |
| tickCumulative | int56 | |
| secondsPerLiquidityCumulativeX128 | uint160 | |
| initialized | bool |
IUniswapV3Pool
A Uniswap pool facilitates swapping and automated market making between any two assets that strictly conform to the ERC20 specification
The pool interface is broken up into many smaller pieces