Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 3.83 KB

ticklens.md

File metadata and controls

74 lines (49 loc) · 3.83 KB
Raw

TickLens

Tick Lens contract

Developer note: Credit to Uniswap Labs under GPL-2.0-or-later license: https://github.com/Uniswap/v3-periphery

Inherits: ITickLens

Functions

getPopulatedTicksInWord

function getPopulatedTicksInWord(address pool, int16 tickTableIndex) public view returns (struct ITickLens.PopulatedTick[] populatedTicks)

Selector: 0x351fb478

Get all the tick data for the populated ticks from a word of the tick bitmap of a pool

Name Type Description
pool address The address of the pool for which to fetch populated tick data
tickTableIndex int16 The index of the word in the tick bitmap for which to parse the bitmap and fetch all the populated ticks

Returns:

Name Type Description
populatedTicks struct ITickLens.PopulatedTick[] An array of tick data for the given word in the tick bitmap

getClosestActiveTicks

function getClosestActiveTicks(address pool, int24 targetTick) public view returns (struct ITickLens.PopulatedTick[2] populatedTicks)

Selector: 0xec92d7fa

Get closest initialized ticks around `targetTick`

Name Type Description
pool address The address of the pool for which to fetch populated tick data
targetTick int24 The tick around which the nearest ticks will be searched

Returns:

Name Type Description
populatedTicks struct ITickLens.PopulatedTick[2] An array of two ticks: before or at targetTick and after targetTick

getNextActiveTicks

function getNextActiveTicks(address pool, int24 startingTick, uint256 amount, bool upperDirection) public view returns (struct ITickLens.PopulatedTick[] populatedTicks)

Selector: 0xc5493f77

Get all the tick data for the `amount` (or less) of populated ticks after `startingTick` (including `startingTick` itself)

Name Type Description
pool address The address of the pool for which to fetch populated tick data
startingTick int24 The starting tick index. Must be populated tick
amount uint256 The maximum amount of ticks requested
upperDirection bool The direction of search. Will fetch 'next' ticks in direction of price increase if true

Returns:

Name Type Description
populatedTicks struct ITickLens.PopulatedTick[] An array of tick data for fetched ticks (amount or less)