Interface WhirlpoolAccountFetcherInterface

Fetcher interface for fetching WhirlpoolSupportedTypes from the network

interface WhirlpoolAccountFetcherInterface {
    getAccountRentExempt(refresh?: boolean): Promise<number>;
    getAdaptiveFeeTier(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<AdaptiveFeeTierData | null>;
    getAdaptiveFeeTiers(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, AdaptiveFeeTierData | null>>;
    getConfig(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<WhirlpoolsConfigData | null>;
    getConfigExtension(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<WhirlpoolsConfigExtensionData | null>;
    getConfigExtensions(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, WhirlpoolsConfigExtensionData | null>>;
    getConfigs(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, WhirlpoolsConfigData | null>>;
    getEpoch(refresh?: boolean): Promise<number>;
    getFeeTier(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<FeeTierData | null>;
    getFeeTiers(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, FeeTierData | null>>;
    getLockConfig(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<LockConfigData | null>;
    getLockConfigs(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, LockConfigData | null>>;
    getMintInfo(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<MintWithTokenProgram | null>;
    getMintInfos(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, MintWithTokenProgram | null>>;
    getOracle(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<OracleData | null>;
    getOracles(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, OracleData | null>>;
    getPool(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<WhirlpoolData | null>;
    getPools(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, WhirlpoolData | null>>;
    getPosition(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<PositionData | null>;
    getPositionBundle(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<PositionBundleData | null>;
    getPositionBundles(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, PositionBundleData | null>>;
    getPositions(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, PositionData | null>>;
    getTickArray(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<TickArrayData | null>;
    getTickArrays(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<readonly (TickArrayData | null)[]>;
    getTokenBadge(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<TokenBadgeData | null>;
    getTokenBadges(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, TokenBadgeData | null>>;
    getTokenInfo(
        address: Address,
        opts?: SimpleAccountFetchOptions,
    ): Promise<AccountWithTokenProgram | null>;
    getTokenInfos(
        addresses: Address[],
        opts?: SimpleAccountFetchOptions,
    ): Promise<ReadonlyMap<string, AccountWithTokenProgram | null>>;
    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:79

getAdaptiveFeeTier

getAdaptiveFeeTier(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<AdaptiveFeeTierData | null>
Fetch and cache the account for a given AdaptiveFeeTier address
Parameters
- address: Address
  The address of the adaptive fee tier account
- Optionalopts: SimpleAccountFetchOptions
Returns Promise<AdaptiveFeeTierData | null>
- Defined in network/public/fetcher/fetcher-types.ts:311

getAdaptiveFeeTiers

getAdaptiveFeeTiers(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, AdaptiveFeeTierData | null>>
Fetch and cache the accounts for a given array of AdaptiveFeeTier addresses
Parameters
- addresses: Address[]
  The array of adaptive fee tier account addresses
- Optionalopts: SimpleAccountFetchOptions
  WhirlpoolAccountFetchOptions instance to dictate fetch behavior
Returns Promise<ReadonlyMap<string, AdaptiveFeeTierData | null>>
- Defined in network/public/fetcher/fetcher-types.ts:321

getConfig

getConfig(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<WhirlpoolsConfigData | null>
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<WhirlpoolsConfigData | null>
- Defined in network/public/fetcher/fetcher-types.ts:212

getConfigExtension

getConfigExtension(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<WhirlpoolsConfigExtensionData | null>
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<WhirlpoolsConfigExtensionData | null>
- Defined in network/public/fetcher/fetcher-types.ts:252

getConfigExtensions

getConfigExtensions(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, WhirlpoolsConfigExtensionData | null>>
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, WhirlpoolsConfigExtensionData | null>>
- Defined in network/public/fetcher/fetcher-types.ts:262

getConfigs

getConfigs(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, WhirlpoolsConfigData | null>>
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, WhirlpoolsConfigData | null>>
- Defined in network/public/fetcher/fetcher-types.ts:222

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:85

getFeeTier

getFeeTier(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<FeeTierData | null>
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<FeeTierData | null>
- Defined in network/public/fetcher/fetcher-types.ts:152

getFeeTiers

getFeeTiers(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, FeeTierData | null>>
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, FeeTierData | null>>
- Defined in network/public/fetcher/fetcher-types.ts:162

getLockConfig

getLockConfig(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<LockConfigData | null>
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<LockConfigData | null>
- Defined in network/public/fetcher/fetcher-types.ts:292

getLockConfigs

getLockConfigs(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, LockConfigData | null>>
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, LockConfigData | null>>
- Defined in network/public/fetcher/fetcher-types.ts:302

getMintInfo

getMintInfo(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<MintWithTokenProgram | null>
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<MintWithTokenProgram | null>
- Defined in network/public/fetcher/fetcher-types.ts:192

getMintInfos

getMintInfos(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, MintWithTokenProgram | null>>
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, MintWithTokenProgram | null>>
- Defined in network/public/fetcher/fetcher-types.ts:202

getOracle

getOracle(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<OracleData | null>
Fetch and cache the account for a given Oracle address
Parameters
- address: Address
  The address of the oracle account
- Optionalopts: SimpleAccountFetchOptions
  WhirlpoolAccountFetchOptions instance to dictate fetch behavior
Returns Promise<OracleData | null>
- Defined in network/public/fetcher/fetcher-types.ts:331

getOracles

getOracles(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, OracleData | null>>
Fetch and cache the accounts for a given array of Oracle addresses
Parameters
- addresses: Address[]
  The array of oracle account addresses
- Optionalopts: SimpleAccountFetchOptions
  WhirlpoolAccountFetchOptions instance to dictate fetch behavior
Returns Promise<ReadonlyMap<string, OracleData | null>>
- Defined in network/public/fetcher/fetcher-types.ts:341

getPool

getPool(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<WhirlpoolData | null>
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<WhirlpoolData | null>
- Defined in network/public/fetcher/fetcher-types.ts:92

getPools

getPools(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, WhirlpoolData | null>>
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, WhirlpoolData | null>>
- Defined in network/public/fetcher/fetcher-types.ts:102

getPosition

getPosition(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<PositionData | null>
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<PositionData | null>
- Defined in network/public/fetcher/fetcher-types.ts:112

getPositionBundle

getPositionBundle(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<PositionBundleData | null>
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<PositionBundleData | null>
- Defined in network/public/fetcher/fetcher-types.ts:232

getPositionBundles

getPositionBundles(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, PositionBundleData | null>>
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, PositionBundleData | null>>
- Defined in network/public/fetcher/fetcher-types.ts:242

getPositions

getPositions(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, PositionData | null>>
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, PositionData | null>>
- Defined in network/public/fetcher/fetcher-types.ts:122

getTickArray

getTickArray(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<TickArrayData | null>
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<TickArrayData | null>
- Defined in network/public/fetcher/fetcher-types.ts:132

getTickArrays

getTickArrays(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<readonly (TickArrayData | null)[]>
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 (TickArrayData | null)[]>
- Defined in network/public/fetcher/fetcher-types.ts:142

getTokenBadge

getTokenBadge(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<TokenBadgeData | null>
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<TokenBadgeData | null>
- Defined in network/public/fetcher/fetcher-types.ts:272

getTokenBadges

getTokenBadges(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, TokenBadgeData | null>>
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, TokenBadgeData | null>>
- Defined in network/public/fetcher/fetcher-types.ts:282

getTokenInfo

getTokenInfo(
address: Address,
opts?: SimpleAccountFetchOptions,
): Promise<AccountWithTokenProgram | null>
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<AccountWithTokenProgram | null>
- Defined in network/public/fetcher/fetcher-types.ts:172

getTokenInfos

getTokenInfos(
addresses: Address[],
opts?: SimpleAccountFetchOptions,
): Promise<ReadonlyMap<string, AccountWithTokenProgram | null>>
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, AccountWithTokenProgram | null>>
- Defined in network/public/fetcher/fetcher-types.ts:182

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:352

Interface WhirlpoolAccountFetcherInterface

Implemented by

Index

Methods

Methods

getAccountRentExempt

Parameters

Returns Promise<number>

getAdaptiveFeeTier

Parameters

Returns Promise<AdaptiveFeeTierData | null>

getAdaptiveFeeTiers

Parameters

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

getConfig

Parameters

Returns Promise<WhirlpoolsConfigData | null>

getConfigExtension

Parameters

Returns Promise<WhirlpoolsConfigExtensionData | null>

getConfigExtensions

Parameters

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

getConfigs

Parameters

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

getEpoch

Parameters

Returns Promise<number>

getFeeTier

Parameters

Returns Promise<FeeTierData | null>

getFeeTiers

Parameters

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

getLockConfig

Parameters

Returns Promise<LockConfigData | null>

getLockConfigs

Parameters

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

getMintInfo

Parameters

Returns Promise<MintWithTokenProgram | null>

getMintInfos

Parameters

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

getOracle

Parameters

Returns Promise<OracleData | null>

getOracles

Parameters

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

getPool

Parameters

Returns Promise<WhirlpoolData | null>

getPools

Parameters

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

getPosition

Parameters

Returns Promise<PositionData | null>

getPositionBundle

Parameters

Returns Promise<PositionBundleData | null>

getPositionBundles

Parameters

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

getPositions

Parameters

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

getTickArray

Parameters

Returns Promise<TickArrayData | null>

getTickArrays

Parameters

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

getTokenBadge

Parameters

Returns Promise<TokenBadgeData | null>