NoTickDataProvider
Throws an error whenever tick data is is required. Useful in cases where tick data is not required.
GitHub File: tickDataProvider.ts
Properties
Private
Property | Type | Modifier | Description |
---|---|---|---|
ERROR_MESSAGE | string | static | Error message to throw whenever tick data is required but has not been provided. |
Methods
getTick() - async
async
Throws a data provider error when tick data is queried.
Parameters
Params | Type | Description |
---|---|---|
_tick | number | The tick index to query. |
Returns
Type | Description |
---|---|
Promise<{ liquidityNet: BigintIsh}> | Data provider error: 'No tick data provider was given' |
nextInitializedTickWithinOneWord() - async
async
Throws a data provider error when searching for the next initialized tick.
Parameters
Params | Type | Description |
---|---|---|
_tick | number | The tick index to query. |
_lte | boolean | Less than or equal to the starting tick. This determines whether to search for the next initialized tick to the left of the current tick. |
_tickSpacing | number | The spacing between usable ticks. |
Returns
Type | Description |
---|---|
Promise<[number, boolean]> | Data provider error: 'No tick data provider was given' |
nextInitializedTickWithinFixedDistance() - async
async
Throws a data provider error when searching for the next initialized tick.
Parameters
Params | Type | Description |
---|---|---|
_tick | number | The tick index to query. |
_lte | boolean | Less than or equal to the starting tick. This determines whether to search for the next initialized tick to the left of the current tick. |
_distance | number | The distance from the current active tick to search. Default is |
Returns
Type | Description |
---|---|
Promise<[number, boolean]> | Data provider error: 'No tick data provider was given' |
Last updated