Class TokenManager

constructor

• new TokenManager(__namedParameters?): TokenManager

• Parameters

  • __namedParameters: TokenManagerConfig = DEFAULT_CONFIG

  Returns TokenManager

initialLoad

onTokensChange

addCustomTokens

• addCustomTokens(tokens): void

• Adds custom tokens to the token manager

  Parameters

  • tokens: TokenInfo[]

    tokens to add

  Returns void

clearCache

• clearCache(): void

• Clears the token list cache

  Returns void

clearCustomTokens

• clearCustomTokens(): void

• Clears all custom tokens

  Returns void

deleteTokenList

• deleteTokenList(key): void

• Deletes a tokenList in the cache

  Parameters

  • key: string

    the key in the cache to delete

  Returns void

fetchTokenList

• fetchTokenList(url): Promise<TokenList>

• fetches a token list

  Parameters

  • url: string

    url to fetch

  Returns Promise<TokenList>

  the token list

  Throws

  if the token list is invalid

fetchTokenLists

• fetchTokenLists(urls): Promise<TokenList[]>

• Fetches a list of tokenLists from the given urls

  Parameters

  • urls: string[]

    urls to fetch

  Returns Promise<TokenList[]>

  The fetched token lists

getCache

• getCache(): TokenListCache

• Gets the cache

  Returns TokenListCache

  the cache

getCustomTokens

• getCustomTokens(): TokenInfo[]

• Returns TokenInfo[]

  all custom tokens

getFromCache

• getFromCache(key): undefined | TokenList

• Gets a token list from the cache

  Parameters

  • key: string

    the key of the token list in the cache

  Returns undefined | TokenList

  the token list with the given key

getLoadedTokens

• getLoadedTokens(network?, removeDuplicates?): TokenInfo[]

• Parameters

  • Optional network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"

    Optional

  • removeDuplicates: boolean = true

  Returns TokenInfo[]

  all tokens from all cached token lists

getNativeToken

• getNativeToken(network): undefined | TokenInfo

• Finds the native token for a network

  Parameters

  • network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"

    the network from which to get the token

  Returns undefined | TokenInfo

  the native token if one exists, otherwise undefined

getTokenByAddress

• getTokenByAddress(address, network, find?): TokenInfo

• Parameters

  • address: string

    address of the token to get

  • network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"

    the network to get the token from

  • Optional find: ((t) => boolean)

    optional function to find the token with specific criteria

    Optional
    • • (t): boolean

      • Parameters

        • t: TokenInfo

        Returns boolean

  Returns TokenInfo

  the first occurence of the token with the given address, or undefined if not found

getTokenBySymbol

• getTokenBySymbol<Symbol>(symbol, network): TokenInfo & {
      symbol: Symbol;
  }

• Type Parameters

  • Symbol extends string

  Parameters

  • symbol: Symbol

    symbol of the token to get

  • network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"

    the network to get the token from

  Returns TokenInfo & {
      symbol: Symbol;
  }

  the first occurence of the token with the given symbol, or undefined if not found

getTokensByAddresses

• getTokensByAddresses(search): TokenInfo[]

• Returns an array of tokens with the given addresses. Order is not guaranteed. If a token cannot be found with the given address, it will be omitted from the array. If multiple tokens are found with the same address and network, they will all be included.

  Parameters

  • search: SearchTokenAddress[]

    an array of objects with address as the address of the token, and network as the network of the token

  Returns TokenInfo[]

  an array of tokens with the given addresses.

  Note

  this is not optimised for large addresses arrays

getTokensBySymbols

• getTokensBySymbols(search): TokenInfo[]

• Returns an array of tokens with the given symbol. Order is not guaranteed. If a token cannot be found with the given address, it will be omitted from the array. If multiple tokens are found with the same address and network, they will all be included.

  Parameters

  • search: SearchTokenSymbols[]

    an array of objects with address as the address of the token, and network as the network of the token

  Returns TokenInfo[]

  an array of tokens with the given symbol.

  Note

  this is not optimised for large symbol arrays

getTokensFromUrls

• getTokensFromUrls(urls): Promise<TokenInfo[]>

• Parameters

  • urls: string[]

    urls to fetch

  Returns Promise<TokenInfo[]>

  cached token lists if the cached urls exist, otherwise fetches and returns the tokenlist

getWrappedNativeToken

• getWrappedNativeToken(network): TokenInfo

• Gets the wrapped native token for a network

  Parameters

  • network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"

    the network from which to get the token

  Returns TokenInfo

  the wrapped native token if one exists, otherwise undefined

setCustomTokens

• setCustomTokens(tokens): void

• Sets custom tokens as a list of tokens

  Parameters

  • tokens: TokenInfo[]

    tokens to set

  Returns void

setTokenList

• setTokenList(key, tokenList): void

• Sets a cache key to a token list

  Parameters

  • key: string

    the key in the cache for which to set the tokenList

  • tokenList: TokenList

    the tokenList to set

  Returns void

tryGetTokenByAddress

• tryGetTokenByAddress(address, network, find?): undefined | TokenInfo

• Parameters

  • address: string

    address of the token to get

  • network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"

    the network to get the token from

  • Optional find: ((t) => boolean)

    optional function to find the token with specific criteria

    Optional
    • • (t): boolean

      • Parameters

        • t: TokenInfo

        Returns boolean

  Returns undefined | TokenInfo

  the first occurence of the token with the given address, or undefined if not found

tryGetTokenBySymbol

• tryGetTokenBySymbol<Symbol>(symbol, network): undefined | TokenInfo & {
      symbol: Symbol;
  }

• Type Parameters

  • Symbol extends string

  Parameters

  • symbol: Symbol

    symbol of the token to get

  • network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"

    the network to get the token from

  Returns undefined | TokenInfo & {
      symbol: Symbol;
  }

  the first occurence of the token with the given symbol, or undefined if not found

tryGetWrappedNativeToken

• tryGetWrappedNativeToken(network): undefined | TokenInfo

• Tries to get the wrapped native token for a network

  Parameters

  • network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"

    the network from which to get the token

  Returns undefined | TokenInfo

  the wrapped native token if one exists, otherwise undefined