Documentation Index
Fetch the complete documentation index at: https://tech.ramses.xyz/llms.txt
Use this file to discover all available pages before exploring further.
These methods compose the pool’s state, and can change with any frequency including multiple times
per transaction
Functions
slot0
function slot0(
) external view returns (uint160 sqrtPriceX96, int24 tick, uint16 observationIndex, uint16 observationCardinality, uint16 observationCardinalityNext, uint24 feeProtocol, bool unlocked)
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 | uint24 | The protocol fee for the pool, denominated in 1e-6 precision. Determines the fraction of swap fees directed to the protocol. |
unlocked | bool | Whether the pool is currently locked to reentrancy |
feeGrowthGlobal0X128
function feeGrowthGlobal0X128(
) external view returns (uint256)
feeGrowthGlobal1X128
function feeGrowthGlobal1X128(
) external view returns (uint256)
grossFeeGrowthGlobal0X128
function grossFeeGrowthGlobal0X128(
) external view returns (uint256)
grossFeeGrowthGlobal1X128
function grossFeeGrowthGlobal1X128(
) external view returns (uint256)
protocolFees
function protocolFees(
) external view returns (uint128 token0, uint128 token1)
liquidity
function liquidity(
) external view returns (uint128)
ticks
function ticks(
int24 tick
) external view returns (uint128 liquidityGross, int128 liquidityNet, uint256 feeGrowthOutside0X128, uint256 feeGrowthOutside1X128, int56 tickCumulativeOutside, uint160 secondsPerLiquidityOutsideX128, uint32 secondsOutside, bool initialized)
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 | |
tickBitmap
function tickBitmap(
int16 wordPosition
) external view returns (uint256)
positions
function positions(
bytes32 key
) external view returns (uint128 _liquidity, uint256 feeGrowthInside0LastX128, uint256 feeGrowthInside1LastX128, uint128 tokensOwed0, uint128 tokensOwed1)
keccak256(abi.encodePacked(owner, index, tickLower, tickUpper)) — note the extra index parameter compared to Uniswap V3.
Parameters:
| Name | Type | Description |
|---|
key | bytes32 | The position’s key is a hash of a preimage composed by the owner, index, 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 |
observations
function observations(
uint256 index
) external view returns (uint32 blockTimestamp, int56 tickCumulative, uint160 secondsPerLiquidityCumulativeX128, bool initialized)
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 |
positionPeriodSecondsInRange
function positionPeriodSecondsInRange(
uint256 period,
address owner,
uint256 index,
int24 tickLower,
int24 tickUpper
) external view returns (uint256 periodSecondsInsideX96)
Parameters:
| Name | Type | Description |
|---|
period | uint256 | The period number |
owner | address | The position owner address |
index | uint256 | The position index |
tickLower | int24 | Lower bound of range |
tickUpper | int24 | Upper bound of range |
Return Values:
| Name | Type | Description |
|---|
periodSecondsInsideX96 | uint256 | Seconds the position was in range for the period |
periods
The pool maintains an array of period snapshots that store cumulative data per weekly epoch. These are used by the GaugeV3 contract to distribute rewards proportionally based on time-weighted in-range liquidity during each period.