Class PairProvider

Provides functionality to fetch and cache pairs from a backend API, based on the specified blockchain network.

const pairProvider = new PairProvider(Networks.TESTNET, "https://api.example.com", "api-key", 20);

Constructors

constructor

Properties

_cache _cacheInSeconds _network getPairsFns?

Methods

getAllPairs getPairFromBlockchain resetCache

Constructors

constructor

  • new PairProvider(opts): PairProvider

  • Initializes a new instance of the PairProvider.

    Parameters

    • opts: PairProviderOptions

    Returns PairProvider

Properties

Private _cache

_cache: {
    [x: string]: {
        pairs: Pair[];
        timestamp: number;
    };
}

Type declaration

  • [x: string]: {
        pairs: Pair[];
        timestamp: number;
    }
    • pairs: Pair[]
    • timestamp: number

Private _cacheInSeconds

_cacheInSeconds: number

Private _network

_network: Networks

Optional getPairsFns

getPairsFns?: GetPairsFns

Methods

getAllPairs

  • getAllPairs(address0, address1, factoryAddress, sorobanContext, protocols): Promise<null | Pair[]>

  • Returns pairs wether from backend or blockchain If the network is testnet or public and shouldUseBackend is true, it will try to fetch from the backend first, and if it fails, it will fetch from the blockchain If the network is standalone or futurenet, it will fetch from the blockchain

    Parameters

    • address0: string

      The address of the first token in the pair.

    • address1: string

      The address of the second token in the pair.

    • factoryAddress: undefined | string

      The address of the factory contract.

    • sorobanContext: undefined | SorobanContextType

      The Soroban context to use for the contract invocation.

    • protocols: Protocol[]

      (Optional) The protocols to fetch pairs for, defaulting to SOROSWAP.

    Returns Promise<null | Pair[]>

    A promise that resolves to an array of Pair instances representing the pair fetched from the backend or blockchain, or null in case of an error.

getPairFromBlockchain

  • getPairFromBlockchain(address0, address1, factoryAddress, sorobanContext): Promise<null | Pair[]>

  • Fetches a pair from the blockchain, caching it to reduce API calls. If cached pair is still valid, returns it instead of fetching anew.

    Parameters

    • address0: string

      The address of the first token in the pair.

    • address1: string

      The address of the second token in the pair.

    • factoryAddress: undefined | string

      The address of the factory contract.

    • sorobanContext: undefined | SorobanContextType

      The Soroban context to use for the contract invocation.

    Returns Promise<null | Pair[]>

    A promise that resolves to an array of Pair instances representing the pair fetched from the blockchain, or null in case of an error.

resetCache

  • resetCache(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

constructor_cache_cacheInSeconds_networkgetPairsFnsgetAllPairsgetPairFromBlockchainresetCache