Skip to main content
Helpful?

TickListDataProvider

@uniswap/v3-sdk / Exports / TickListDataProvider

Class: TickListDataProvider

A data provider for ticks that is backed by an in-memory array of ticks.

Implements​

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new TickListDataProvider(ticks, tickSpacing)

Parameters​

NameType
ticks(Tick | TickConstructorArgs)[]
tickSpacingnumber

Defined in​

entities/tickListDataProvider.ts:12

Properties​

ticks​

• Private ticks: readonly Tick[]

Defined in​

entities/tickListDataProvider.ts:10

Methods​

getTick​

▸ getTick(tick): Promise<{ liquidityGross: BigintIsh ; liquidityNet: BigintIsh }>

Return information corresponding to a specific tick

Parameters​

NameTypeDescription
ticknumberthe tick to load

Returns​

Promise<{ liquidityGross: BigintIsh ; liquidityNet: BigintIsh }>

Implementation of​

TickDataProvider.getTick

Defined in​

entities/tickListDataProvider.ts:18


nextInitializedTickWithinOneWord​

▸ nextInitializedTickWithinOneWord(tick, lte, tickSpacing): Promise<[number, boolean]>

Return the next tick that is initialized within a single word

Parameters​

NameTypeDescription
ticknumberThe current tick
ltebooleanWhether the next tick should be lte the current tick
tickSpacingnumberThe tick spacing of the pool

Returns​

Promise<[number, boolean]>

Implementation of​

TickDataProvider.nextInitializedTickWithinOneWord

Defined in​

entities/tickListDataProvider.ts:22

Helpful?