@ledgerhq/cryptoassets NPM

@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.

Importing CAL tokens in cryptoassets data

pnpm import:cal-tokens

API

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

currencyId any

Returns string

registerCryptoCurrency

Parameters

currency CryptoCurrency
id string

Returns void

listCryptoCurrencies

Parameters

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

Returns Array\

findCryptoCurrency

Parameters

f any

Returns (CryptoCurrency | null | undefined)

findCryptoCurrencyByScheme

Parameters

scheme any

Returns (CryptoCurrency | null | undefined)

findCryptoCurrencyByTicker

Parameters

ticker 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

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\

__clearObject

Only for jest purpose, clean object to be empty

Parameters

obj Record<string, (TokenCurrency | Array\)>

Returns void

__clearAllLists

Only for jest purpose, clear all the init list

Returns void

listTokens

Parameters

options Partial\?

Returns Array\

listTokensForCryptoCurrency

Parameters

currency CryptoCurrency
options Partial\?

Returns Array\

listTokenTypesForCryptoCurrency

Parameters

currency CryptoCurrency

Returns Array [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)

findTokenByTicker

Parameters

ticker string

Returns (TokenCurrency | undefined)

findTokenById

Parameters

id string

Returns (TokenCurrency | undefined)

hasTokenId

Parameters

id string

Returns boolean

getTokenById

Parameters

id string

Returns TokenCurrency

removeTokenFromAllLists

Delete previous token entry to all array

Parameters

token TokenCurrency

id

We clean all the reference of an existing token, if an hash doesn't match. Like this we can update any change from a already added token coming from Dynamic CAL and maintain it up to date without having to release a new version of LLD or LLM