README.md

@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
• getAbandonSeedAddress
  • Parameters
• registerCryptoCurrency
  • Parameters
• listCryptoCurrencies
  • Parameters
• findCryptoCurrency
  • Parameters
• findCryptoCurrencyByScheme
  • Parameters
• findCryptoCurrencyByTicker
  • Parameters
• findCryptoCurrencyById
  • Parameters
• findCryptoCurrencyByKeyword
  • Parameters
• hasCryptoCurrencyId
  • Parameters
• getCryptoCurrencyById
  • Parameters
• findExchangeCurrencyConfig
  • Parameters
• hasFiatCurrencyTicker
  • Parameters
• findFiatCurrencyByTicker
  • Parameters
• getFiatCurrencyByTicker
  • Parameters
• listFiatCurrencies
• listTokens
  • Parameters
• listTokensForCryptoCurrency
  • Parameters
• listTokenTypesForCryptoCurrency
  • Parameters
• findTokenByTicker
  • Parameters
• findTokenById
  • Parameters
• hasTokenId
  • Parameters
• getTokenById
  • Parameters
• findCompoundToken
  • Parameters

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: Record<string, 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

• currencyId any

Returns string

registerCryptoCurrency

Parameters

• id string
• currency CryptoCurrency

Returns void

listCryptoCurrencies

Parameters

• withDevCrypto any (optional, default false)
• withTerminated any (optional, default false)

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
• tests (optional, default ["keywords","name","id","ticker","manager"])

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

Returns Array<string>

findTokenByTicker

Parameters

• ticker string

Returns (TokenCurrency | null | undefined)

findTokenById

Parameters

• id 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)

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, trc20 and asa are currently manually maintained.

Update test and snapshots in the monorepo:

https://ledgerhq.atlassian.net/wiki/spaces/WALLETCO/pages/3740205141/CAL+updates