@codewarriorr/cryptoassets

5.37.11 • Public • Published

@ledgerhq/cryptoassets

library that contains Ledger internal crypto assets list and signatures.

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

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

CryptoCurrencyObjMap

Type: $Exact<$ObjMap<any, F>>

CryptoCurrencyConfig

Type: CryptoCurrencyObjMap<function (any): C>

CryptoCurrencyIds

Type: $Keys<any>

listCryptoCurrencies

Parameters

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

Returns Array<CryptoCurrency>

findCryptoCurrency

Parameters

  • f any

Returns CryptoCurrency?

findCryptoCurrencyByScheme

Parameters

  • scheme any

Returns CryptoCurrency?

findCryptoCurrencyByTicker

Parameters

  • ticker any

Returns CryptoCurrency?

findCryptoCurrencyById

Parameters

  • id any

Returns CryptoCurrency?

findCryptoCurrencyByKeyword

Parameters

  • keyword any

Returns CryptoCurrency?

hasCryptoCurrencyId

Parameters

  • id any

Returns boolean

getCryptoCurrencyById

Parameters

  • id any

Returns CryptoCurrency

findExchangeCurrencyConfig

Parameters

Returns {config: string, signature: string}?

hasFiatCurrencyTicker

Parameters

  • ticker any

Returns boolean

findFiatCurrencyByTicker

Parameters

  • ticker any

Returns FiatCurrency?

getFiatCurrencyByTicker

Parameters

  • ticker any

Returns FiatCurrency

listFiatCurrencies

Returns Array<FiatCurrency>

listTokens

Parameters

  • options $Shape<TokensListOptions>?

Returns Array<TokenCurrency>

listTokensForCryptoCurrency

Parameters

Returns Array<TokenCurrency>

listTokenTypesForCryptoCurrency

Parameters

Returns Array<string>

findTokenByTicker

Parameters

Returns TokenCurrency?

findTokenById

Parameters

Returns TokenCurrency?

findTokenByAddress

Parameters

Returns TokenCurrency?

hasTokenId

Parameters

Returns boolean

getTokenById

Parameters

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?

Unit

Properties

CurrencyCommon

Properties

TokenCurrency

Type: any

FiatCurrency

Type: any

ExplorerView

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.

/@codewarriorr/cryptoassets/

    Package Sidebar

    Install

    npm i @codewarriorr/cryptoassets

    Weekly Downloads

    14

    Version

    5.37.11

    License

    Apache-2.0

    Unpacked Size

    2.46 MB

    Total Files

    66

    Last publish

    Collaborators

    • codewarriorr