Skip to content

fix(OracleLibrary): add missing @return for liquidity in getBlockStartingTickAndLiquidity NatSpec#450

Open
0xAxiom wants to merge 1 commit into
Uniswap:mainfrom
0xAxiom:fix/oracle-getblockstarting-missing-liquidity-return
Open

fix(OracleLibrary): add missing @return for liquidity in getBlockStartingTickAndLiquidity NatSpec#450
0xAxiom wants to merge 1 commit into
Uniswap:mainfrom
0xAxiom:fix/oracle-getblockstarting-missing-liquidity-return

Conversation

@0xAxiom
Copy link
Copy Markdown

@0xAxiom 0xAxiom commented May 23, 2026

Summary

getBlockStartingTickAndLiquidity returns two values — (int24 tick, uint128 liquidity) — but only the first return value had a NatSpec @return annotation. The @notice also described only the tick, omitting liquidity.

Before:

/// @notice Given a pool, it returns the tick value as of the start of the current block
/// @param pool Address of Uniswap V3 pool
/// @return The tick that the pool was in at the start of the current block
function getBlockStartingTickAndLiquidity(address pool) internal view returns (int24, uint128) {

After:

/// @notice Given a pool, it returns the tick value and liquidity as of the start of the current block
/// @param pool Address of Uniswap V3 pool
/// @return The tick that the pool was in at the start of the current block
/// @return The liquidity of the pool as of the start of the current block
function getBlockStartingTickAndLiquidity(address pool) internal view returns (int24, uint128) {

This mirrors the existing pattern in consult, which properly documents both of its return values with separate @return tags.

Changes

  • contracts/libraries/OracleLibrary.sol: added missing @return for liquidity; expanded @notice to mention both outputs

No logic changes.

…tingTickAndLiquidity NatSpec

The function returns (int24, uint128) — both tick and liquidity — but only
the tick had a @return annotation. The @notice also described only the tick.

- Add missing `@return` for the liquidity value
- Expand `@notice` to mention both tick and liquidity

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant