@blooo/hw-app-velas v1.0.1

Github, Ledger Devs Slack

@blooo/hw-app-velas

Ledger Hardware Wallet Velas JavaScript bindings.

Notes

To run speculos-smoke test make sure Speculos running (apdu port 9999 and api rest endpoint http://0.0.0.0:5000) with Velas app installed on it. Then run the command from root workspace:

$ yarn run ts-node packages/hw-app-velas/tests/speculos-smoke.ts

Troubleshooting

If ledger returns error 6808 - enable blind signature in settings (not needed for unit testing).

API

Table of Contents

• @blooo/hw-app-velas
• Notes
• Troubleshooting
• API
  • Table of Contents
  • Velas
    • Parameters
    • Examples
    • getAddress
      • Parameters
      • Examples
    • signTransaction
      • Parameters
      • Examples
    • getAppConfiguration
      • Examples

Velas

Velas API

Parameters

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

Examples

import Velas from "@blooo/hw-app-velas";
const velas = new Velas(transport);

getAddress

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

Because Velas uses Ed25519 keypairs, as per SLIP-0010 all derivation-path indexes will be promoted to hardened indexes.

Parameters

• path string a BIP32 path
• display boolean flag to show display (optional, default false)

Examples

velas.getAddress("44'/501'/0'").then(r => r.address)

Returns Promise<{address: Buffer}> an object with the address field

signTransaction

Sign a Velas transaction.

Parameters

• path string a BIP32 path
• txBuffer Buffer serialized transaction

Examples

velas.signTransaction("44'/501'/0'", txBuffer).then(r => r.signature)

Returns Promise<{signature: Buffer}> an object with the signature field

getAppConfiguration

Get application configuration.

Examples

velas.getAppConfiguration().then(r => r.version)

Returns Promise\ application config object