Class TokenPairAPI

Represents a class for handling TokenPair operations related to the voidnode server.

Hierarchy

BaseAPI
- TokenPairAPI

Index

Constructors

Properties

premia streamIndex

Methods

cancelAllStreams getPair getPairExtended getPairs getPairsExtended getSpotPrice getStrikeInterval

Constructors

constructor

new TokenPairAPI(premia): TokenPairAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns TokenPairAPI
Inherited from BaseAPI.constructor
- Defined in src/api/baseAPI.ts:25

Properties

`Readonly` premia

premia: Premia

The Premia SDK instance.

`Protected` streamIndex

streamIndex: number = 0

The current index of quote streams. Used to cancel stale streams.

Methods

cancelAllStreams

cancelAllStreams(): Promise<void>
Cancels all ongoing streams.

Returns Promise<void>
Inherited from BaseAPI.cancelAllStreams
- Defined in src/api/baseAPI.ts:34

getPair

getPair(pair): Promise<TokenPair>
Fetches data for a token pair from the voidnode server. Uses caching with a one-day time-to-live.
Parameters
- pair: TokenPairOrId
  
  The token pair or id to fetch the data for.
Returns Promise<TokenPair>
The data for the token pair.
- Defined in src/api/tokenPairAPI.ts:71

getPairExtended

getPairExtended(pair): Promise<TokenPairExtended>
Retrieves extended information for a token pair. Uses caching with a one-minute time-to-live.
Parameters
- pair: TokenPairOrId
  
  The token pair to fetch the extended information for.
Returns Promise<TokenPairExtended>
The extended information for the token pair.
- Defined in src/api/tokenPairAPI.ts:83

getPairs

getPairs(pairs): Promise<TokenPair[]>
Fetches data for multiple token pairs. Uses caching with a one-day time-to-live.
Parameters
- pairs: TokenPairOrId[]
  
  An array of token pairs to fetch the data for.
Returns Promise<TokenPair[]>
The data for the specified token pairs.
- Defined in src/api/tokenPairAPI.ts:95

getPairsExtended

getPairsExtended(pairs): Promise<TokenPairExtended[]>
Retrieves extended information for multiple token pairs. Uses caching with a one-minute time-to-live.
Parameters
- pairs: TokenPairOrId[]
  
  An array of token pairs to fetch the extended information for.
Returns Promise<TokenPairExtended[]>
The extended information for the specified token pairs.
- Defined in src/api/tokenPairAPI.ts:107

getSpotPrice

getSpotPrice(pair, provider?): Promise<bigint>
Fetches the current spot price of a token pair from the price oracle. Uses caching with a one-minute time-to-live.
Parameters
- pair: TokenPairOrId
  
  The token pair to fetch the spot price for.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
The current spot price of the token pair.
- Defined in src/api/tokenPairAPI.ts:35

getStrikeInterval

getStrikeInterval(pair, provider?): Promise<bigint>
Gets the strike interval for a token pair based on its spot price.
Parameters
- pair: TokenPairOrId
  
  The token pair to fetch the strike increment for.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<bigint>
The strike increment for the token pair.
- Defined in src/api/tokenPairAPI.ts:54

Generated using TypeDoc