diff --git a/contracts/interfaces/pool/IUniswapV3PoolState.sol b/contracts/interfaces/pool/IUniswapV3PoolState.sol index 620256c31..fe1a92e32 100644 --- a/contracts/interfaces/pool/IUniswapV3PoolState.sol +++ b/contracts/interfaces/pool/IUniswapV3PoolState.sol @@ -8,16 +8,16 @@ interface IUniswapV3PoolState { /// @notice The 0th storage slot in the pool stores many values, and is exposed as a single method to save gas /// when accessed externally. /// @return sqrtPriceX96 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. + /// @return 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 + /// @return observationIndex The index of the last oracle observation that was written + /// @return observationCardinality The current maximum number of observations stored in the pool + /// @return observationCardinalityNext The next maximum number of observations, to be updated when the observation + /// @return 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. + /// @return unlocked Whether the pool is currently locked to reentrancy function slot0() external view @@ -49,18 +49,14 @@ interface IUniswapV3PoolState { /// @notice Look up information about a specific tick in the pool /// @param tick The tick to look up - /// @return liquidityGross 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. + /// @return liquidityGross The total amount of position liquidity that uses the pool either as tick lower or tick upper + /// @return liquidityNet How much liquidity changes when the pool price crosses the tick + /// @return feeGrowthOutside0X128 The fee growth on the other side of the tick from the current tick in token0 + /// @return feeGrowthOutside1X128 The fee growth on the other side of the tick from the current tick in token1 + /// @return tickCumulativeOutside The cumulative tick value on the other side of the tick from the current tick + /// @return secondsPerLiquidityOutsideX128 The seconds spent per liquidity on the other side of the tick from the current tick + /// @return secondsOutside The seconds spent on the other side of the tick from the current tick + /// @return initialized Set to true if the tick is initialized, i.e. liquidityGross is greater than 0, otherwise equal to false function ticks(int24 tick) external view