Interface WhirlpoolAccountFetcherInterface

Fetcher interface for fetching WhirlpoolSupportedTypes from the network

interface WhirlpoolAccountFetcherInterface {
    getAccountRentExempt(refresh?: boolean): Promise<number>;
    getConfig(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | WhirlpoolsConfigData>;
    getConfigExtension(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | WhirlpoolsConfigExtensionData>;
    getConfigExtensions(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, null | WhirlpoolsConfigExtensionData>>;
    getConfigs(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, null | WhirlpoolsConfigData>>;
    getEpoch(refresh?: boolean): Promise<number>;
    getFeeTier(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | FeeTierData>;
    getFeeTiers(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, null | FeeTierData>>;
    getLockConfig(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | LockConfigData>;
    getLockConfigs(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, null | LockConfigData>>;
    getMintInfo(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | MintWithTokenProgram>;
    getMintInfos(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, null | MintWithTokenProgram>>;
    getPool(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | WhirlpoolData>;
    getPools(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, null | WhirlpoolData>>;
    getPosition(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | PositionData>;
    getPositionBundle(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | PositionBundleData>;
    getPositionBundles(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, null | PositionBundleData>>;
    getPositions(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, null | PositionData>>;
    getTickArray(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | TickArrayData>;
    getTickArrays(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<readonly (null | TickArrayData)[]>;
    getTokenBadge(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | TokenBadgeData>;
    getTokenBadges(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, null | TokenBadgeData>>;
    getTokenInfo(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<null | AccountWithTokenProgram>;
    getTokenInfos(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, null | AccountWithTokenProgram>>;
    populateCache<T extends WhirlpoolSupportedTypes>(
        accounts: ReadonlyMap<string, T>,
        parser: ParsableEntity<T>,
        now: number,
    ): void;
}

Implemented by

WhirlpoolAccountFetcher

Methods

getAccountRentExempt

getAccountRentExempt(refresh?: boolean): Promise<number>
Fetch and cache the rent exempt value
Parameters
- Optionalrefresh: boolean
  If true, will always fetch from the network
Returns Promise<number>
- Defined in network/public/fetcher/fetcher-types.ts:75

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>
- Defined in network/public/fetcher/fetcher-types.ts:208

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>
- Defined in network/public/fetcher/fetcher-types.ts:248

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>>
- Defined in network/public/fetcher/fetcher-types.ts:258

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>>
- Defined in network/public/fetcher/fetcher-types.ts:218

getEpoch

getEpoch(refresh?: boolean): Promise<number>
Fetch and cache the current epoch info
Parameters
- Optionalrefresh: boolean
  If true, will always fetch from the network
Returns Promise<number>
- Defined in network/public/fetcher/fetcher-types.ts:81

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>
- Defined in network/public/fetcher/fetcher-types.ts:148

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>>
- Defined in network/public/fetcher/fetcher-types.ts:158

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>
- Defined in network/public/fetcher/fetcher-types.ts:288

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>>
- Defined in network/public/fetcher/fetcher-types.ts:298

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>
- Defined in network/public/fetcher/fetcher-types.ts:188

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>>
- Defined in network/public/fetcher/fetcher-types.ts:198

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>
- Defined in network/public/fetcher/fetcher-types.ts:88

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>>
- Defined in network/public/fetcher/fetcher-types.ts:98

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>
- Defined in network/public/fetcher/fetcher-types.ts:108

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>
- Defined in network/public/fetcher/fetcher-types.ts:228

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>>
- Defined in network/public/fetcher/fetcher-types.ts:238

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>>
- Defined in network/public/fetcher/fetcher-types.ts:118

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>
- Defined in network/public/fetcher/fetcher-types.ts:128

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)[]>
- Defined in network/public/fetcher/fetcher-types.ts:138

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>
- Defined in network/public/fetcher/fetcher-types.ts:268

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>>
- Defined in network/public/fetcher/fetcher-types.ts:278

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>
- Defined in network/public/fetcher/fetcher-types.ts:168

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>>
- Defined in network/public/fetcher/fetcher-types.ts:178

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
- Defined in network/public/fetcher/fetcher-types.ts:309

Interface WhirlpoolAccountFetcherInterface

Implemented by

Index

Methods

Methods

getAccountRentExempt

Parameters

Returns Promise<number>

getConfig

Parameters

Returns Promise<null | WhirlpoolsConfigData>

getConfigExtension

Parameters

Returns Promise<null | WhirlpoolsConfigExtensionData>

getConfigExtensions

Parameters

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

getConfigs

Parameters

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

getEpoch

Parameters

Returns Promise<number>

getFeeTier

Parameters

Returns Promise<null | FeeTierData>

getFeeTiers

Parameters

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

getLockConfig

Parameters

Returns Promise<null | LockConfigData>

getLockConfigs

Parameters

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

getMintInfo

Parameters

Returns Promise<null | MintWithTokenProgram>

getMintInfos

Parameters

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

getPool

Parameters

Returns Promise<null | WhirlpoolData>

getPools

Parameters

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

getPosition

Parameters

Returns Promise<null | PositionData>

getPositionBundle

Parameters

Returns Promise<null | PositionBundleData>

getPositionBundles

Parameters

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

getPositions

Parameters

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

getTickArray

Parameters

Returns Promise<null | TickArrayData>

getTickArrays

Parameters

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

getTokenBadge

Parameters

Returns Promise<null | TokenBadgeData>

getTokenBadges

Parameters

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

getTokenInfo

Parameters

Returns Promise<null | AccountWithTokenProgram>

getTokenInfos

Parameters

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

populateCache

Type Parameters

Parameters