@mgonetwork/ledgerjs-hw-app-mgo
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Ledger Github, Ledger Developer Portal, Ledger Developer Discord

ledgerjs-hw-app-mgo

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

Using LedgerJS for Mgo

Here is a sample app for Node:

const Transport = require('@ledgerhq/hw-transport').default;
const Mgo = require('@mgonetwork/ledgerjs-hw-app-mgo').default;

const getPublicKey = async () => {
	const mgo = new Mgo(await Transport.create());
	return await mgo.getPublicKey("44'/784'/0'/0'/0'");
};

const signTransaction = async () => {
	const mgo = new Mgo(await Transport.create());
	return await mgo.signTransaction("44'/784'/0'/0'/0'", '<transaction contents>');
};

const getVersion = async () => {
	const mgo = new Mgo(await Transport.create());
	return await mgo.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 "Mgo")

Examples

import Mgo from 'ledgerjs-hw-app-mgo';

const transport = await Transport.create();
const mgo = new Mgo(transport);

getPublicKey

Gets the Mgo address for a given BIP-32 path.

Parameters

  • path string a path in BIP-32 format
  • displayOnDevice boolean whether or not to display the address on the Ledger device.

Examples

const publicKey = await mgo.getPublicKey("44'/784'/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 mgo.signTransaction("44'/784'/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 mgo.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.

Package Sidebar

Install

npm i @mgonetwork/ledgerjs-hw-app-mgo

Weekly Downloads

0

Version

1.0.0

License

Apache-2.0

Unpacked Size

60 kB

Total Files

8

Last publish

Collaborators

  • mgonetwork