@ledgerhq/cryptoassets
TypeScript icon, indicating that this package has built-in type declarations

13.1.1 • Public • Published

@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

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

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

findCryptoCurrencyByKeyword

Parameters

  • keyword any
  • tests (optional, default ["keywords","name","id","ticker","manager"])

Returns (CryptoCurrency | null | undefined)

hasCryptoCurrencyId

Parameters

  • id any

Returns boolean

findExchangeCurrencyConfig

Parameters

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>

__clearObject

Only for jest purpose, clean object to be empty

Parameters

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

Returns void

__clearAllLists

Only for jest purpose, clear all the init list

Returns void

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

Returns (TokenCurrency | undefined)

findTokenById

Parameters

Returns (TokenCurrency | undefined)

hasTokenId

Parameters

Returns boolean

getTokenById

Parameters

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

Readme

Keywords

Package Sidebar

Install

npm i @ledgerhq/cryptoassets

Weekly Downloads

41,011

Version

13.1.1

License

Apache-2.0

Unpacked Size

58.6 MB

Total Files

1396

Last publish

Collaborators

  • ledger-releaser
  • thomas.coudray
  • ldg-github-ci
  • aboissiere
  • vbouzon
  • gbrahm-ledger
  • sergii-shkolin
  • phenry-ledger