Class PriceModuleUtils

A list of utility functions for the price module.

Deprecated

PriceModule will be removed in the future release. Please use endpoint which provides prices.

Index

Constructors

Methods

fetchDecimalsForMints fetchPoolDataFromMints fetchTickArraysForPools

Constructors

constructor

new PriceModuleUtils(): PriceModuleUtils
Returns PriceModuleUtils

Methods

`Static`fetchDecimalsForMints

fetchDecimalsForMints(
    fetcher: WhirlpoolAccountFetcherInterface,
    mints: Address[],
    opts?: SimpleAccountFetchOptions,
): Promise<DecimalsMap>
Fetch the decimals to token mapping for the given mints.
Parameters
- fetcher: WhirlpoolAccountFetcherInterface
  WhirlpoolAccountFetcherInterface
- mints: Address[]
  The mints to fetch decimals for.
- opts: SimpleAccountFetchOptions = IGNORE_CACHE
  an WhirlpoolAccountFetchOptions object to define fetch and cache options when accessing on-chain accounts
Returns Promise<DecimalsMap>
A DecimalsMap of mint addresses to decimals.

Deprecated
PriceModule will be removed in the future release. Please use endpoint which provides prices.
- Defined in prices/price-module.ts:389

`Static`fetchPoolDataFromMints

fetchPoolDataFromMints(
    fetcher: WhirlpoolAccountFetcherInterface,
    mints: Address[],
    config?: GetPricesConfig,
    opts?: SimpleAccountFetchOptions,
): Promise<PoolMap>
Fetch pool data for the given mints by deriving the PDA from all combinations of mints & tick-arrays. Note that this method can be slow.
Parameters
- fetcher: WhirlpoolAccountFetcherInterface
  WhirlpoolAccountFetcherInterface
- mints: Address[]
  The mints to fetch pool data for.
- config: GetPricesConfig = defaultGetPricesConfig
  The configuration for the price calculation.
- opts: SimpleAccountFetchOptions = IGNORE_CACHE
  an WhirlpoolAccountFetchOptions object to define fetch and cache options when accessing on-chain accounts
Returns Promise<PoolMap>
A PoolMap of pool addresses to pool data.

Deprecated
PriceModule will be removed in the future release. Please use endpoint which provides prices.
- Defined in prices/price-module.ts:282

`Static`fetchTickArraysForPools

fetchTickArraysForPools(
    fetcher: WhirlpoolAccountFetcherInterface,
    pools: PoolMap,
    config?: GetPricesConfig,
    opts?: SimpleAccountFetchOptions,
): Promise<TickArrayMap>
Fetch tick-array data for the given pools
Parameters
- fetcher: WhirlpoolAccountFetcherInterface
  WhirlpoolAccountFetcherInterface
- pools: PoolMap
  The pools to fetch tick-array data for.
- config: GetPricesConfig = defaultGetPricesConfig
  The configuration for the price calculation.
- opts: SimpleAccountFetchOptions = IGNORE_CACHE
  an WhirlpoolAccountFetchOptions object to define fetch and cache options when accessing on-chain accounts
Returns Promise<TickArrayMap>
A TickArrayMap of tick-array addresses to tick-array data.

Deprecated
PriceModule will be removed in the future release. Please use endpoint which provides prices.
- Defined in prices/price-module.ts:330