@ledgerhq/cryptoassets
Ledger's material for crypto currencies, tokens and fiats. Also includes signatures required by Nano devices for these tokens.
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
abandonSeedAddresses
these are either "dead"/"burn" addresses OR "abandon" seed addresses.
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
Type: Partial<Record<any, string>>
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
registerCryptoCurrency
Parameters
currency
CryptoCurrencyid
string
Returns void
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
keyword
anytests
(optional, default ["keywords","name","id","ticker","manager"]
)
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
currency
CryptoCurrencyoptions
Partial<TokensListOptions>?
Returns Array<TokenCurrency>
listTokenTypesForCryptoCurrency
Parameters
Returns Array<string>
findTokenByTicker
Parameters
Returns (TokenCurrency | null | undefined)
findTokenById
Parameters
Returns (TokenCurrency | null | undefined)
hasTokenId
Parameters
Returns boolean
getTokenById
Parameters
Returns TokenCurrency
Maintainance notes
Import crypto assets data guide:
https://ledgerhq.atlassian.net/wiki/spaces/WALLETCO/pages/3256516784/How+to+import+crypto-assets+data+in+Ledger+Live
Regenerate data:
node script/crypto-assets-importer/index.js ~/dev/crypto-assets
node script/crypto-assets-importer/tron/sync-trc10-tokens.js
NB: currencies asa, esdt, spl, stellar and trc20 are currently manually maintained.
Update test and snapshots in the monorepo:
https://ledgerhq.atlassian.net/wiki/spaces/WALLETCO/pages/3740205141/CAL+updates