JSPM

@citadeldao/hw-app-hash

0.1.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q21927F
  • License Apache-2.0

Ledger Hardware Wallet Provenance Application API

Package Exports

  • @citadeldao/hw-app-hash
  • @citadeldao/hw-app-hash/lib/Provenance.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@citadeldao/hw-app-hash) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Github, Ledger OP3N Discord

hw-app-hash

Ledger Hardware Wallet JavaScript bindings for Provenance, based on LedgerJS.

Using LedgerJS for Provenance

Here is a sample app for Node:

const Transport = require("@ledgerhq/hw-transport").default;
const Provenance = require("hw-app-hash_token").default;

const getPublicKey = async () => {
  const hash_token = new Provenance(await Transport.create());
  return await hash_token.getPublicKey("44'/505'/0'/0/0");
};

const signTransaction = async () => {
  const transport = await Transport.create();
  const hash_token = new Provenance(await Transport.create());
  return await hash_token.signTransaction(
    "44'/505'/0'/0/0",
    "<transaction contents>"
  );
};

const getVersion = async () => {
  const transport = await Transport.create();
  const hash_token = new Provenance(await Transport.create());
  return await hash_token.getVersion();
};

const doAll = async () => {
  console.log(await getPublicKey());
  console.log(await signTransaction());
  console.log(await getVersion());
};

doAll().catch(err => console.log(err));

API

Table of Contents

Parameters

  • transport Transport<any>
  • scrambleKey string (optional, default "Provenance")

Examples

import Provenance from "hw-app-hash_token";
const hash_token = new Provenance(transport);

getPublicKey

Get Provenance address for a given BIP-32 path.

Parameters

  • path string a path in BIP-32 format

Examples

const publicKey = await hash_token.getPublicKey("44'/505'/0'/0/0");

Returns Promise<string> an object with a public key.

signTransaction

Sign a transaction with a given BIP-32 path.

Parameters

  • path string a path in BIP-32 format

Examples

const publicKey = await hash_token.signTransaction(
  "44'/505'/0'/0/0",
  "<transaction contents>"
  );

Returns Promise<object> an object with text field containing a signature.

getVersion

Get the version of the application installed on the hardware device.

Examples

console.log(await hash_token.getVersion());

for version 0.1.0, it produces something like

{
  major: 0
  minor: 1
  patch: 0
}

Returns Promise<{object}> an object with major, minor, and patch of the version.