Skip to main content
Version: 3.0.0

TickListDataProvider

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

Implements#

Constructors#

constructor#

+ new TickListDataProvider(ticks: (Tick | TickConstructorArgs)[], tickSpacing: number): TickListDataProvider

Parameters#

NameType
ticks(Tick | TickConstructorArgs)[]
tickSpacingnumber

Returns: TickListDataProvider

Defined in: entities/tickListDataProvider.ts:10

Methods#

getTick#

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

Return information corresponding to a specific tick

Parameters#

NameType
ticknumber

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

Implementation of: TickDataProvider

Defined in: entities/tickListDataProvider.ts:18


nextInitializedTickWithinOneWord#

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

Return the next tick that is initialized within a single word

Parameters#

NameType
ticknumber
lteboolean
tickSpacingnumber

Returns: Promise<[number, boolean]>

Implementation of: TickDataProvider

Defined in: entities/tickListDataProvider.ts:22