@ledgerhq/cryptoassets
library that contains Ledger internal crypto assets list and signatures.
DO NOT EDIT because this library is generated.
Usage
There are two modes of usage of this library.
- The all-in way: you want to have all the data available (ERC20 token loaded,...). To do this, you simply import
@ledgerhq/cryptoassets
- The custom way: you can import individual data piece from
@ledgerhq/cryptoassets/data/*
. For instance, importing the ERC20 signatures can be done with@ledgerhq/cryptoassets/data/erc20-signatures
sub module.
API
Table of Contents
- getAbandonSeedAddress
- CryptoCurrencyObjMap
- CryptoCurrencyConfig
- CryptoCurrencyIds
- listCryptoCurrencies
- findCryptoCurrency
- findCryptoCurrencyByScheme
- findCryptoCurrencyByTicker
- findCryptoCurrencyById
- findCryptoCurrencyByKeyword
- hasCryptoCurrencyId
- getCryptoCurrencyById
- findExchangeCurrencyConfig
- hasFiatCurrencyTicker
- findFiatCurrencyByTicker
- getFiatCurrencyByTicker
- listFiatCurrencies
- listTokens
- listTokensForCryptoCurrency
- listTokenTypesForCryptoCurrency
- findTokenByTicker
- findTokenById
- findTokenByAddress
- hasTokenId
- getTokenById
- findCompoundToken
- Unit
- CurrencyCommon
- TokenCurrency
- FiatCurrency
- ExplorerView
- CryptoCurrency
- Currency
getAbandonSeedAddress
Returns a valid address for a given currency. These addresses are PUBLIC addresses We use them for tests and also for dry-run estimations DO NOT USE AS RECIPIENT OR SIGN TRANSACTIONS INTO THEM
Parameters
-
currencyId
any
Returns string
CryptoCurrencyObjMap
Type: $Exact<$ObjMap<any, F>>
CryptoCurrencyConfig
Type: CryptoCurrencyObjMap<function (any): C>
CryptoCurrencyIds
Type: $Keys<any>
listCryptoCurrencies
Parameters
-
withDevCrypto
any (optional, defaultfalse
) -
withTerminated
any (optional, defaultfalse
)
Returns Array<CryptoCurrency>
findCryptoCurrency
Parameters
-
f
any
Returns CryptoCurrency?
findCryptoCurrencyByScheme
Parameters
-
scheme
any
Returns CryptoCurrency?
findCryptoCurrencyByTicker
Parameters
-
ticker
any
Returns CryptoCurrency?
findCryptoCurrencyById
Parameters
-
id
any
Returns CryptoCurrency?
findCryptoCurrencyByKeyword
Parameters
-
keyword
any
Returns CryptoCurrency?
hasCryptoCurrencyId
Parameters
-
id
any
Returns boolean
getCryptoCurrencyById
Parameters
-
id
any
Returns CryptoCurrency
findExchangeCurrencyConfig
Parameters
-
id
string
Returns {config: string, signature: string}?
hasFiatCurrencyTicker
Parameters
-
ticker
any
Returns boolean
findFiatCurrencyByTicker
Parameters
-
ticker
any
Returns FiatCurrency?
getFiatCurrencyByTicker
Parameters
-
ticker
any
Returns FiatCurrency
listFiatCurrencies
Returns Array<FiatCurrency>
listTokens
Parameters
-
options
$Shape<TokensListOptions>?
Returns Array<TokenCurrency>
listTokensForCryptoCurrency
Parameters
-
currency
CryptoCurrency -
options
$Shape<TokensListOptions>?
Returns Array<TokenCurrency>
listTokenTypesForCryptoCurrency
Parameters
-
currency
CryptoCurrency
findTokenByTicker
Parameters
-
ticker
string
Returns TokenCurrency?
findTokenById
Parameters
-
id
string
Returns TokenCurrency?
findTokenByAddress
Parameters
-
address
string
Returns TokenCurrency?
hasTokenId
Parameters
-
id
string
Returns boolean
getTokenById
Parameters
-
id
string
Returns TokenCurrency
findCompoundToken
if a given token account is a token that can be used in compound, give the associated compound token (cToken)
Parameters
-
token
any
Returns TokenCurrency?
Unit
Properties
CurrencyCommon
Properties
-
name
string -
ticker
string -
units
Array<Unit> -
symbol
string? -
disableCountervalue
boolean? -
delisted
boolean? -
countervalueTicker
string?
TokenCurrency
Type: any
FiatCurrency
Type: any
ExplorerView
Properties
CryptoCurrency
Type: any
Currency
Type: (FiatCurrency | CryptoCurrency | TokenCurrency)
Maintainance notes
To regenerate data:
node script/crypto-assets-importer/index.js ~/dev/crypto-assets
node script/crypto-assets-importer/tron/sync-trc10-tokens.js
NB: currencies, trc20 and asa are currently manually maintained.