Class HandleTokenManager

TokenManager that comes with native, wrapped native, and handle tokens by default. Handle supported token extensions:

isNative: true if token is native for that network (e.g. ETH, MATIC)
isHlpToken: true if the token is a hlp token in a handle Vault contract
isWrappedNative: true if the token is a wrapped version of a native token (e.g. WETH)
isStable: true if the token is a USD stablecoin, false otherwise,
isShortable: true if the token is shortable, false otherwise
isFxToken: true if token is a fx token, false otherwise
isLiquidityToken: true if token is the Handle Liquidity Pool token (symbol hLP), false otherwise

Note

the Handle Liquidity Pool token (symbol hLP) has isHlpToken set to false, as it is not technically in the liquidity pool. Instead, it has isLiquidityToken set to true

Hierarchy

TokenManager
- HandleTokenManager

Constructors

constructor

new HandleTokenManager(config?): HandleTokenManager
Parameters
- config: TokenManagerConfig = DEFAULT_CONFIG
Returns HandleTokenManager
Overrides TokenManager.constructor
- Defined in src/components/token-manager/HandleTokenManager.ts:37

Properties

`Protected` cache

cache: TokenListCache

Caches fetched results indefinitely

`Protected` customTokens

customTokens: TokenInfo[]

initialLoad

initialLoad: Promise<TokenList[]>

onTokensChange

onTokensChange: (() => void)

Type declaration

- (): void
- Called whenever the cache, or custom tokens changes
  
  Returns void

Methods

addCustomTokens

addCustomTokens(tokens): void
Adds custom tokens to the token manager
Parameters
- tokens: TokenInfo[]
  
  tokens to add
Returns void
Inherited from TokenManager.addCustomTokens
- Defined in src/components/token-manager/index.ts:330

checkForHlpNativeToken

checkForHlpNativeToken(token): {
hlpAddress: string;
isNative: boolean;
}
Parses a token into a hLP wrapped native token if it is a native token
Parameters
- token: TokenInfo
  
  the token to check
Returns {
hlpAddress: string;
isNative: boolean;
}
an object with the properties isNative and hlpAddress. If the token is native, isNative is true and hlpAddress is the address of a hlp compatible wrapped native token. If the token is a hLP token, isNative is false and hlpAddress is the address of the hLP token.
- hlpAddress: string
- isNative: boolean
Throws
if the token is neither native, nor a hLP supported token, nor the handle liquidity token

Throws
if the token is native, and no hLP compatible wrapped native token exists

Deprecated
in favour of parseNativeToWrapped
- Defined in src/components/token-manager/HandleTokenManager.ts:167

clearCache

clearCache(): void
Clears the token list cache

Returns void
Inherited from TokenManager.clearCache
- Defined in src/components/token-manager/index.ts:391

clearCustomTokens

clearCustomTokens(): void
Clears all custom tokens

Returns void
Inherited from TokenManager.clearCustomTokens
- Defined in src/components/token-manager/index.ts:338

deleteTokenList

deleteTokenList(key): void
Deletes a tokenList in the cache
Parameters
- key: string
  
  the key in the cache to delete
Returns void
Inherited from TokenManager.deleteTokenList
- Defined in src/components/token-manager/index.ts:383

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
Inherited from TokenManager.fetchTokenList
- Defined in src/components/token-manager/index.ts:305

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
Inherited from TokenManager.fetchTokenLists
- Defined in src/components/token-manager/index.ts:322

getCache

getCache(): TokenListCache
Gets the cache

Returns TokenListCache
the cache
Inherited from TokenManager.getCache
- Defined in src/components/token-manager/index.ts:400

getCustomTokens

getCustomTokens(): TokenInfo[]
Returns TokenInfo[]
all custom tokens
Inherited from TokenManager.getCustomTokens
- Defined in src/components/token-manager/index.ts:355

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
Inherited from TokenManager.getFromCache
- Defined in src/components/token-manager/index.ts:364

getHandleLiquidityToken

getHandleLiquidityToken(network): undefined | TokenInfo
Gets the handle liquidity pool token (symbol hLP) for a network
Parameters
- network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"
  
  the network on which to find the token
Returns undefined | TokenInfo
the handle liquidity pool token if it exists, otherwise undefined
- Defined in src/components/token-manager/HandleTokenManager.ts:150

getHlpTokens

getHlpTokens(network): TokenInfo[]
Gets all hLP tokens for a network
Parameters
- network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"
  
  the network on which to search for tokens
Returns TokenInfo[]
all hLP tokens for the network
- Defined in src/components/token-manager/HandleTokenManager.ts:62

getHlpWrappedNativeToken

getHlpWrappedNativeToken(network): undefined | TokenInfo
Finds the hLP compatible 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
- Defined in src/components/token-manager/HandleTokenManager.ts:139

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
Inherited from TokenManager.getLoadedTokens
- Defined in src/components/token-manager/index.ts:106

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
Inherited from TokenManager.getNativeToken
- Defined in src/components/token-manager/index.ts:212

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
Inherited from TokenManager.getTokenByAddress
- Defined in src/components/token-manager/index.ts:171

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
Inherited from TokenManager.getTokenBySymbol
- Defined in src/components/token-manager/index.ts:133

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
Inherited from TokenManager.getTokensByAddresses
- Defined in src/components/token-manager/index.ts:254

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
Inherited from TokenManager.getTokensBySymbols
- Defined in src/components/token-manager/index.ts:281

`Protected` getTokensFromLists

getTokensFromLists(tokenLists): TokenInfo[]
extracts tokens from the token token lists to a flat array of all the tokens
Parameters
- tokenLists: TokenList[]
  
  token lists to get tokens from
Returns TokenInfo[]
the tokens from all token lists
Inherited from TokenManager.getTokensFromLists
- Defined in src/components/token-manager/index.ts:66

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
Inherited from TokenManager.getTokensFromUrls
- Defined in src/components/token-manager/index.ts:77

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
Inherited from TokenManager.getWrappedNativeToken
- Defined in src/components/token-manager/index.ts:223

isHlpStableTokenByAddress

isHlpStableTokenByAddress(address, network): boolean
Checks if the token is a stable hLP token
Parameters
- address: string
  
  the address of the token to check
- network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"
  
  the network on which to check the token
Returns boolean
whether there exists a stable hLP token with the given address
- Defined in src/components/token-manager/HandleTokenManager.ts:123

isHlpStableTokenBySymbol

isHlpStableTokenBySymbol(symbol, network): boolean
Checks if the token is a stable hLP token
Parameters
- symbol: string
  
  the symbol of the token to check
- network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"
  
  the network on which to check the token
Returns boolean
whether there exists a stable hLP token with the given symbol
- Defined in src/components/token-manager/HandleTokenManager.ts:108

isHlpTokenByAddress

isHlpTokenByAddress(address, network): boolean
Checks if a token is a supported hLP token by its address
Parameters
- address: string
  
  the address of the token to check
- network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"
  
  the network on which to check the token
Returns boolean
wheteher the token is a hlpToken
- Defined in src/components/token-manager/HandleTokenManager.ts:92

isHlpTokenBySymbol

isHlpTokenBySymbol(symbol, network): boolean
Checks if a token is a supported hLP token by its symbol
Parameters
- symbol: string
  
  the symbol of the token to check
- network: number | "base" | "ethereum" | "arbitrum" | "polygon" | "arbitrum-sepolia"
  
  the network on which to check the token
Returns boolean
wheteher the token is a hlpToken
- Defined in src/components/token-manager/HandleTokenManager.ts:78

parseNativeToWrapped

parseNativeToWrapped(token): {
isInputNative: boolean;
parsedToken: TokenInfo;
}
Parses a token into a wrapped native token if it is native
Parameters
- token: TokenInfo
  
  the token to parse
Returns {
isInputNative: boolean;
parsedToken: TokenInfo;
}
an object with the properties isInputNative and parsedToken. If the token passed into the function is native, isInputNative will be set to true, and parsedToken will be the native wrapped token for the network. If the token passed in is not native, isInputNative will be set to false and parsedToken will be the token passed into the function
- isInputNative: boolean
- parsedToken: TokenInfo
- Defined in src/components/token-manager/HandleTokenManager.ts:196

setCustomTokens

setCustomTokens(tokens): void
Sets custom tokens as a list of tokens
Parameters
- tokens: TokenInfo[]
  
  tokens to set
Returns void
Inherited from TokenManager.setCustomTokens
- Defined in src/components/token-manager/index.ts:347

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
Inherited from TokenManager.setTokenList
- Defined in src/components/token-manager/index.ts:373

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
Inherited from TokenManager.tryGetTokenByAddress
- Defined in src/components/token-manager/index.ts:195

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
Inherited from TokenManager.tryGetTokenBySymbol
- Defined in src/components/token-manager/index.ts:154

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
Inherited from TokenManager.tryGetWrappedNativeToken
- Defined in src/components/token-manager/index.ts:237

`Static` from

from(tokenManager): HandleTokenManager
Creates an instance of HandleTokenList from a TokenList instance.
Parameters
- tokenManager: TokenManager
  
  the tokenList from which to construct the HandleTokenList
Returns HandleTokenManager
an instance of HandleTokenList with the cache of the tokenList
- Defined in src/components/token-manager/HandleTokenManager.ts:51

`Static` `Protected` removeDuplicates

removeDuplicates(tokens): TokenInfo[]
Removes tokens that are duplicates of each other by comparing their symbol and chainId
Parameters
- tokens: TokenInfo[]
  
  tokens from which to remove duplicates
Returns TokenInfo[]
the tokens with duplicates removed
Inherited from TokenManager.removeDuplicates
- Defined in src/components/token-manager/index.ts:89

Class HandleTokenManager

Note

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: TokenManagerConfig = DEFAULT_CONFIG

Returns HandleTokenManager

Properties

Protected cache

Protected customTokens

initialLoad

onTokensChange

Type declaration

Returns void

Methods

addCustomTokens

Parameters

tokens: TokenInfo[]

Returns void

checkForHlpNativeToken

Parameters

token: TokenInfo

Returns { hlpAddress: string; isNative: boolean; }

hlpAddress: string

isNative: boolean

Throws

Throws

Deprecated

clearCache

Returns void

clearCustomTokens

Returns void

deleteTokenList

Parameters

key: string

Returns void

fetchTokenList

Parameters

url: string

Returns Promise<TokenList>

Throws

fetchTokenLists

Parameters

urls: string[]

Returns Promise<TokenList[]>

getCache

Returns TokenListCache

getCustomTokens

Returns TokenInfo[]

getFromCache

Parameters

key: string

Returns undefined | TokenList

getHandleLiquidityToken

Parameters

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

Returns undefined | TokenInfo

getHlpTokens

Parameters

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

Returns TokenInfo[]

getHlpWrappedNativeToken

Parameters

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

Returns undefined | TokenInfo

getLoadedTokens

Parameters

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

removeDuplicates: boolean = true

Returns TokenInfo[]

getNativeToken

Parameters

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

Returns undefined | TokenInfo

getTokenByAddress

`Protected` cache

`Protected` customTokens

Returns {
hlpAddress: string;
isNative: boolean;
}

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

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

Returns TokenInfo & {
symbol: Symbol;
}

`Protected` getTokensFromLists

Returns {
isInputNative: boolean;
parsedToken: TokenInfo;
}