@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
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
Returns string
CryptoCurrencyIds
Type: any
registerCryptoCurrency
Parameters
listCryptoCurrencies
Parameters
withDevCrypto
any (optional, default false
)withTerminated
any (optional, default false
)
Returns Array<CryptoCurrency>
findCryptoCurrency
Parameters
Returns (CryptoCurrency | null | undefined)
findCryptoCurrencyByScheme
Parameters
Returns (CryptoCurrency | null | undefined)
findCryptoCurrencyByTicker
Parameters
Returns (CryptoCurrency | null | undefined)
findCryptoCurrencyById
Parameters
Returns (CryptoCurrency | null | undefined)
findCryptoCurrencyByKeyword
Parameters
Returns (CryptoCurrency | null | undefined)
hasCryptoCurrencyId
Parameters
Returns boolean
getCryptoCurrencyById
Parameters
Returns CryptoCurrency
findExchangeCurrencyConfig
Parameters
Returns ({config: string, signature: string} | null | undefined)
hasFiatCurrencyTicker
Parameters
Returns boolean
findFiatCurrencyByTicker
Parameters
Returns (FiatCurrency | null | undefined)
getFiatCurrencyByTicker
Parameters
Returns FiatCurrency
listFiatCurrencies
Returns Array<FiatCurrency>
listTokens
Parameters
options
Partial<TokensListOptions>?
Returns Array<TokenCurrency>
listTokensForCryptoCurrency
Parameters
Returns Array<TokenCurrency>
listTokenTypesForCryptoCurrency
Parameters
Returns Array<string>
findTokenByTicker
Parameters
Returns (TokenCurrency | null | undefined)
findTokenById
Parameters
Returns (TokenCurrency | null | undefined)
findTokenByAddress
Parameters
Returns (TokenCurrency | null | undefined)
hasTokenId
Parameters
Returns boolean
getTokenById
Parameters
Returns TokenCurrency
findCompoundToken
if a given token account is a token that can be used in compound, give the associated compound token (cToken)
Parameters
Returns (TokenCurrency | null | undefined)
Unit
Type: {name: string, code: string, magnitude: number, showAllDigits: boolean?, prefixCode: boolean?}
Properties
CurrencyCommon
Type: {name: string, ticker: string, units: Array<Unit>, symbol: string?, disableCountervalue: boolean?, delisted: boolean?, countervalueTicker: string?}
Properties
TokenCurrency
Type: any
FiatCurrency
Type: any
ExplorerView
Type: {tx: string?, address: string?, token: string?}
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.