Node's Play Mate

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

    6.29.2 • Public • Published

    GitHub, Ledger Devs Discord, Developer Portal

    @ledgerhq/hw-app-helium

    Ledger Hardware Wallet Helium JavaScript bindings.


    Are you adding Ledger support to your software wallet?

    You may be using this package to communicate with the Helium Nano App.

    For a smooth and quick integration:

    • See the developers’ documentation on the Developer Portal and
    • Go on Discord to chat with developer support and the developer community.

    API

    Table of Contents

    Helium

    Helium API

    Parameters

    • transport Transport a transport for sending commands to a device
    • scrambleKey a scramble key (optional, default "helium_default_scramble_key")

    Examples

    import Helium from "@ledgerhq/hw-app-helium";
    const helium = new Helium(transport);

    getVersion

    Get application version.

    Examples
    helium.getVersion().then(r => r.version)

    Returns Promise<{version: string}> version object

    getAddress

    Get Helium address (public key) for a BIP32 path.

    Parameters
    • path string a BIP32 path
    • display boolean? flag to show display
    • accountIndex index of account address (optional, default 0)
    Examples
    helium.getAddress("44'/904'/0'/0'/0'").then(r => r.address)

    Returns Promise<{index: number, address: string, publicKey: string}> an object with the address field

    signPaymentV2

    Sign a Helium PaymentV2 transaction.

    Parameters
    • txn PaymentV2 a PaymentV2 transaction
    • accountIndex index of account address (optional, default 0)
    Examples
    import { PaymentV2 } from '@helium/transactions'
    const txn = new PaymentV2({ ... })
    helium.signTransaction(txn).then(r => r.signature)

    Returns Promise<{signature: Buffer, txn: PaymentV2}> an object with the signed transaction and signature

    signTokenBurnV1

    Sign a Helium TokenBurnV1 transaction.

    Parameters
    • txn TokenBurnV1 a TokenBurnV1 transaction
    • accountIndex index of account address (optional, default 0)
    Examples
    import { TokenBurnV1 } from '@helium/transactions'
    const txn = new TokenBurnV1({ ... })
    helium.signTransaction(txn).then(r => r.signature)

    Returns Promise<{signature: Buffer, txn: TokenBurnV1}> an object with the signed transaction and signature

    signStakeValidatorV1

    Sign a Helium StakeValidatorV1 transaction.

    Parameters
    • txn StakeValidatorV1 a StakeValidatorV1 transaction
    • accountIndex index of account address (optional, default 0)
    Examples
    import { StakeValidatorV1 } from '@helium/transactions'
    const txn = new StakeValidatorV1({ ... })
    helium.signTransaction(txn).then(r => r.signature)

    Returns Promise<{signature: Buffer, txn: StakeValidatorV1}> an object with the signed transaction and signature

    signUnstakeValidatorV1

    Sign a Helium UnstakeValidatorV1 transaction.

    Parameters
    • txn UnstakeValidatorV1 a UnstakeValidatorV1 transaction
    • accountIndex index of account address (optional, default 0)
    Examples
    import { UnstakeValidatorV1 } from '@helium/transactions'
    const txn = new UnstakeValidatorV1({ ... })
    helium.signTransaction(txn).then(r => r.signature)

    Returns Promise<{signature: Buffer, txn: UnstakeValidatorV1}> an object with the signed transaction and signature

    signTransferValidatorStakeV1

    Sign a Helium TransferValidatorStakeV1 transaction.

    Parameters
    • txn TransferValidatorStakeV1 a TransferValidatorStakeV1 transaction
    • ownerType ("old" | "new") whether to sign as the old or new owner in the transfer
    • accountIndex index of account address (optional, default 0)
    Examples
    import { TransferValidatorStakeV1 } from '@helium/transactions'
    const txn = new TransferValidatorStakeV1({ ... }, 'old')
    helium.signTransaction(txn).then(r => r.signature)

    Returns Promise<{signature: Buffer, txn: TransferValidatorStakeV1}> an object with the signed transaction and signature

    signSecurityExchangeV1

    Sign a Helium SecurityExchangeV1 transaction.

    Parameters
    • txn SecurityExchangeV1 a SecurityExchangeV1 transaction
    • accountIndex index of account address (optional, default 0)
    Examples
    import { SecurityExchangeV1 } from '@helium/transactions'
    const txn = new SecurityExchangeV1({ ... })
    helium.signTransaction(txn).then(r => r.signature)

    Returns Promise<{signature: Buffer, txn: SecurityExchangeV1}> an object with the signed transaction and signature

    Install

    npm i @ledgerhq/hw-app-helium

    DownloadsWeekly Downloads

    141

    Version

    6.29.2

    License

    Apache-2.0

    Unpacked Size

    136 kB

    Total Files

    26

    Last publish

    Collaborators

    • sergii-shkolin
    • yogh
    • haammar-ledger
    • kvn-ledger
    • ofreyssinet
    • jelbaz-ledger
    • achabrolin-ledger
    • gre
    • btchip
    • meriadec
    • flocks
    • amougel
    • juan-cortes
    • val_pinkman
    • iammorrow
    • phenry-ledger
    • jdecussy-ledger
    • lfbarreto
    • junsugiura
    • hzheng_ledger