Skip to main content

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.

Functions#

secondsInside#

function secondsInside(
int24 tickLower,
int24 tickUpper
) external view returns (uint32)

Returns a relative timestamp value representing how long, in seconds, the pool has spent between tickLower and tickUpper

This timestamp is strictly relative. To get a useful elapsed time (i.e., duration) value, the value returned by this method should be checkpointed externally after a position is minted, and again before a position is burned. Thus the external contract must control the lifecycle of the position.

Parameters:#

NameTypeDescription
tickLowerint24The lower tick of the range for which to get the seconds inside
tickUpperint24The upper tick of the range for which to get the seconds inside

Return Values:#

TypeDescription
uint32relative timestamp for how long the pool spent in the tick range

observe#

function observe(
uint32[] secondsAgos
) external view returns (int56[] tickCumulatives, uint160[] liquidityCumulatives)

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

NameTypeDescription
secondsAgosuint32[]From how long ago each cumulative tick and liquidity value should be returned

Return Values:#

NameTypeDescription
tickCumulativesint56[]Cumulative tick values as of each secondsAgos from the current block timestamp
liquidityCumulativesuint160[]Cumulative liquidity-in-range value as of each secondsAgos from the current block

timestamp