Skip to main content

NoTickDataProvider

@pegasys-fi/v3-sdk / Exports / NoTickDataProvider

Class: NoTickDataProvider

This tick data provider does not know how to fetch any tick data. It throws whenever it is required. Useful if you do not need to load tick data for your use case.

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new NoTickDataProvider()

Properties

ERROR_MESSAGE

Static Private ERROR_MESSAGE: string = 'No tick data provider was given'

Defined in

entities/tickDataProvider.ts:27

Methods

getTick

getTick(_tick): Promise<{ liquidityNet: BigintIsh }>

Return information corresponding to a specific tick

Parameters

NameTypeDescription
_ticknumberthe tick to load

Returns

Promise<{ liquidityNet: BigintIsh }>

Implementation of

TickDataProvider.getTick

Defined in

entities/tickDataProvider.ts:28


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/tickDataProvider.ts:32