@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
- getAbandonSeedAddress
- CryptoCurrencyIds
- registerCryptoCurrency
- 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
CryptoCurrencyIds
Type: any
registerCryptoCurrency
Parameters
-
id
string -
currency
CryptoCurrency
listCryptoCurrencies
Parameters
-
withDevCrypto
any (optional, defaultfalse
) -
withTerminated
any (optional, defaultfalse
)
Returns Array<CryptoCurrency>
findCryptoCurrency
Parameters
-
f
any
Returns (CryptoCurrency | null | undefined)
findCryptoCurrencyByScheme
Parameters
-
scheme
any
Returns (CryptoCurrency | null | undefined)
findCryptoCurrencyByTicker
Parameters
-
ticker
any
Returns (CryptoCurrency | null | undefined)
findCryptoCurrencyById
Parameters
-
id
any
Returns (CryptoCurrency | null | undefined)
findCryptoCurrencyByKeyword
Parameters
-
keyword
any
Returns (CryptoCurrency | null | undefined)
hasCryptoCurrencyId
Parameters
-
id
any
Returns boolean
getCryptoCurrencyById
Parameters
-
id
any
Returns CryptoCurrency
findExchangeCurrencyConfig
Parameters
-
id
string
Returns ({config: string, signature: string} | null | undefined)
hasFiatCurrencyTicker
Parameters
-
ticker
any
Returns boolean
findFiatCurrencyByTicker
Parameters
-
ticker
any
Returns (FiatCurrency | null | undefined)
getFiatCurrencyByTicker
Parameters
-
ticker
any
Returns FiatCurrency
listFiatCurrencies
Returns Array<FiatCurrency>
listTokens
Parameters
-
options
Partial<TokensListOptions>?
Returns Array<TokenCurrency>
listTokensForCryptoCurrency
Parameters
-
currency
CryptoCurrency -
options
Partial<TokensListOptions>?
Returns Array<TokenCurrency>
listTokenTypesForCryptoCurrency
Parameters
-
currency
CryptoCurrency
findTokenByTicker
Parameters
-
ticker
string
Returns (TokenCurrency | null | undefined)
findTokenById
Parameters
-
id
string
Returns (TokenCurrency | null | undefined)
findTokenByAddress
Parameters
-
address
string
Returns (TokenCurrency | null | undefined)
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 | 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
-
name
string -
ticker
string -
units
Array<Unit> -
symbol
string? -
disableCountervalue
boolean? -
delisted
boolean? -
countervalueTicker
string?
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.