Class WhirlpoolAccountFetcher

constructor

• new WhirlpoolAccountFetcher(
      connection: Connection,
      fetcher: AccountFetcher<WhirlpoolSupportedTypes, SimpleAccountFetchOptions>,
  ): WhirlpoolAccountFetcher

  Parameters

  • connection: Connection
  • fetcher: AccountFetcher<WhirlpoolSupportedTypes, SimpleAccountFetchOptions>

  Returns WhirlpoolAccountFetcher

Readonlyconnection

Readonlyfetcher

getAccountRentExempt

• getAccountRentExempt(refresh?: boolean): Promise<number>

  Fetch and cache the rent exempt value

  Parameters

  • refresh: boolean = false

    If true, will always fetch from the network

  Returns Promise<number>

getConfig

• getConfig(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | WhirlpoolsConfigData>

  Fetch and cache the account for a given WhirlpoolConfig address

  Parameters

  • address: Address

    The address of the WhirlpoolConfig account
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | WhirlpoolsConfigData>

getConfigExtension

• getConfigExtension(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | WhirlpoolsConfigExtensionData>

  Fetch and cache the account for a given WhirlpoolConfigExtension address

  Parameters

  • address: Address

    The address of the WhirlpoolConfigExtension account
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | WhirlpoolsConfigExtensionData>

getConfigExtensions

• getConfigExtensions(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<ReadonlyMap<string, null | WhirlpoolsConfigExtensionData>>

  Fetch and cache the accounts for a given array of WhirlpoolConfigExtension addresses

  Parameters

  • addresses: Address[]

    The array of WhirlpoolConfigExtension account addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<ReadonlyMap<string, null | WhirlpoolsConfigExtensionData>>

getConfigs

• getConfigs(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<ReadonlyMap<string, null | WhirlpoolsConfigData>>

  Fetch and cache the accounts for a given array of WhirlpoolConfig addresses

  Parameters

  • addresses: Address[]

    The array of WhirlpoolConfig account addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<ReadonlyMap<string, null | WhirlpoolsConfigData>>

getEpoch

• getEpoch(refresh?: boolean): Promise<number>

  Fetch and cache the current epoch info

  Parameters

  • refresh: boolean = false

    If true, will always fetch from the network

  Returns Promise<number>

getFeeTier

• getFeeTier(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | FeeTierData>

  Fetch and cache the account for a given FeeTier address

  Parameters

  • address: Address

    The address of the fee tier account
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | FeeTierData>

getFeeTiers

• getFeeTiers(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<ReadonlyMap<string, null | FeeTierData>>

  Fetch and cache the accounts for a given array of FeeTier addresses

  Parameters

  • addresses: Address[]

    The array of fee tier account addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<ReadonlyMap<string, null | FeeTierData>>

getLockConfig

• getLockConfig(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | LockConfigData>

  Fetch and cache the account for a given LockConfig address

  Parameters

  • address: Address

    The address of the LockConfig account
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | LockConfigData>

getLockConfigs

• getLockConfigs(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<ReadonlyMap<string, null | LockConfigData>>

  Fetch and cache the accounts for a given array of LockConfig addresses

  Parameters

  • addresses: Address[]

    The array of LockConfig account addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<ReadonlyMap<string, null | LockConfigData>>

getMintInfo

• getMintInfo(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | MintWithTokenProgram>

  Fetch and cache the account for a given Mint address

  Parameters

  • address: Address

    The address of the mint account
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | MintWithTokenProgram>

getMintInfos

• getMintInfos(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<ReadonlyMap<string, null | MintWithTokenProgram>>

  Fetch and cache the accounts for a given array of Mint addresses

  Parameters

  • addresses: Address[]

    The array of mint account addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<ReadonlyMap<string, null | MintWithTokenProgram>>

getPool

• getPool(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | WhirlpoolData>

  Fetch and cache the account for a given Whirlpool addresses

  Parameters

  • address: Address

    The mint address
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | WhirlpoolData>

getPools

• getPools(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<ReadonlyMap<string, null | WhirlpoolData>>

  Fetch and cache the accounts for a given array of Whirlpool addresses

  Parameters

  • addresses: Address[]

    The array of mint addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<ReadonlyMap<string, null | WhirlpoolData>>

getPosition

• getPosition(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | PositionData>

  Fetch and cache the account for a given Position address

  Parameters

  • address: Address

    The address of the position account
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | PositionData>

getPositionBundle

• getPositionBundle(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | PositionBundleData>

  Fetch and cache the account for a given PositionBundle address

  Parameters

  • address: Address

    The address of the position bundle account
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | PositionBundleData>

getPositionBundles

• getPositionBundles(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<ReadonlyMap<string, null | PositionBundleData>>

  Fetch and cache the accounts for a given array of PositionBundle addresses

  Parameters

  • addresses: Address[]

    The array of position bundle account addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<ReadonlyMap<string, null | PositionBundleData>>

getPositions

• getPositions(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<ReadonlyMap<string, null | PositionData>>

  Fetch and cache the accounts for a given array of Position addresses

  Parameters

  • addresses: Address[]

    The array of position account addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<ReadonlyMap<string, null | PositionData>>

getTickArray

• getTickArray(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | TickArrayData>

  Fetch and cache the account for a given TickArray address.

  Parameters

  • address: Address

    The address of the tick array account
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | TickArrayData>

getTickArrays

• getTickArrays(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<readonly (null | TickArrayData)[]>

  Fetch and cache the accounts for a given array of TickArray addresses

  Parameters

  • addresses: Address[]

    The array of tick array account addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<readonly (null | TickArrayData)[]>

getTokenBadge

• getTokenBadge(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | TokenBadgeData>

  Fetch and cache the account for a given TokenBadge address

  Parameters

  • address: Address

    The address of the TokenBadge account
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | TokenBadgeData>

getTokenBadges

• getTokenBadges(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<ReadonlyMap<string, null | TokenBadgeData>>

  Fetch and cache the accounts for a given array of TokenBadge addresses

  Parameters

  • addresses: Address[]

    The array of TokenBadge account addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<ReadonlyMap<string, null | TokenBadgeData>>

getTokenInfo

• getTokenInfo(
      address: Address,
      opts?: SimpleAccountFetchOptions,
  ): Promise<null | AccountWithTokenProgram>

  Fetch and cache the account for a given TokenAccount address

  Parameters

  • address: Address

    The address of the token account
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<null | AccountWithTokenProgram>

getTokenInfos

• getTokenInfos(
      addresses: Address[],
      opts?: SimpleAccountFetchOptions,
  ): Promise<ReadonlyMap<string, null | AccountWithTokenProgram>>

  Fetch and cache the accounts for a given array of TokenAccount addresses

  Parameters

  • addresses: Address[]

    The array of token account addresses
  • Optionalopts: SimpleAccountFetchOptions

    WhirlpoolAccountFetchOptions instance to dictate fetch behavior

  Returns Promise<ReadonlyMap<string, null | AccountWithTokenProgram>>

populateCache

• populateCache<T extends WhirlpoolSupportedTypes>(
      accounts: ReadonlyMap<string, T>,
      parser: ParsableEntity<T>,
      now?: number,
  ): void

  Populate the fetcher's cache with the given WhirlpoolsData accounts

  Type Parameters

  • T extends WhirlpoolSupportedTypes

  Parameters

  • accounts: ReadonlyMap<string, T>

    The map of addresses to on-chain account data
  • parser: ParsableEntity<T>

    The ParsableEntity instance to parse the accounts
  • now: number = ...

    The current timestamp to use for the cache

  Returns void