TickListDataProvider
@pegasys-fi/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
| Name | Type |
|---|---|
ticks | (Tick | TickConstructorArgs)[] |
tickSpacing | number |
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
| Name | Type | Description |
|---|---|---|
tick | number | the tick to load |
Returns
Promise<{ liquidityGross: BigintIsh ; liquidityNet: BigintIsh }>
Implementation of
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
| Name | Type | Description |
|---|---|---|
tick | number | The current tick |
lte | boolean | Whether the next tick should be lte the current tick |
tickSpacing | number | The tick spacing of the pool |
Returns
Promise<[number, boolean]>
Implementation of
TickDataProvider.nextInitializedTickWithinOneWord