OracleFacet API Reference

The OracleFacet maintains an internal TWAP (Time-Weighted Average Price) oracle using a ring buffer of price observations.

Functions

Get the time-weighted average tick over a period.

solidity

function consultTWAP(bytes32 poolId, uint32 period) external view returns (int24 arithmeticMeanTick)

Parameters:

Name	Type	Description
poolId	bytes32	Pool identifier
period	uint32	Lookback period in seconds

Get the current spot tick.

solidity

function getSpotTick(bytes32 poolId) external view returns (int24 tick)

Get historical tick cumulative values at specific timestamps.

solidity

function observe(bytes32 poolId, uint32[] calldata secondsAgos)
    external view returns (int56[] memory tickCumulatives)

Expand the observation buffer capacity to store more historical data.

solidity

function increaseObservationCardinalityNext(bytes32 poolId, uint16 observationCardinalityNext) external

Every swap records an observation: (timestamp, tickCumulative, secondsPerLiquidityCumulative)
tickCumulative += currentTick * elapsed_seconds
TWAP over period T: arithmeticMeanTick = (tickCumNow - tickCumTAgo) / T
Ring buffer stores up to 65535 observations (expandable)

Licensed under the GNU General Public License v3.0--see LICENSE for terms.

Copyright (C) 2026 PaxLabs Inc.
SPDX-License-Identifier: GPL-3.0-only