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

    6.8.0 • 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.

    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

    CryptoCurrencyIds

    Type: any

    registerCryptoCurrency

    Parameters

    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

    Returns (CryptoCurrency | null | undefined)

    hasCryptoCurrencyId

    Parameters

    • id any

    Returns boolean

    getCryptoCurrencyById

    Parameters

    • id any

    Returns CryptoCurrency

    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>

    listTokens

    Parameters

    • options Partial<TokensListOptions>?

    Returns Array<TokenCurrency>

    listTokensForCryptoCurrency

    Parameters

    Returns Array<TokenCurrency>

    listTokenTypesForCryptoCurrency

    Parameters

    Returns Array<string>

    findTokenByTicker

    Parameters

    Returns (TokenCurrency | null | undefined)

    findTokenById

    Parameters

    Returns (TokenCurrency | null | undefined)

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

    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.

    Keywords

    Install

    npm i @ledgerhq/cryptoassets

    DownloadsWeekly Downloads

    12,909

    Version

    6.8.0

    License

    Apache-2.0

    Unpacked Size

    3.53 MB

    Total Files

    102

    Last publish

    Collaborators

    • haammar-ledger
    • achabrolin-ledger
    • mortalkastor
    • gre
    • btchip
    • meriadec
    • flocks
    • amougel
    • juan-cortes
    • val_pinkman
    • iammorrow
    • phenry-ledger
    • jdecussy-ledger
    • lfbarreto
    • junsugiura
    • hzheng_ledger
    • machard-ledger
    • glethuillier_ledger