mina-ledger-js

Mina Ledger JS

This package provides a client library to communicate with ledger-app-mina running on the Ledger Nano S/X.

Install

Add the ledger client to your application:

yarn add mina-ledger-js

and a transporter of your choice. For node: @ledgerhq/hw-transport-node-hid

Usage

import { MinaLedgerJS } from "mina-ledger-js";
import TransportNodeHid from "@ledgerhq/hw-transport-node-hid";

(async () => {
  const transport = await TransportNodeHid.create();
  const instance = new MinaLedgerJS(transport);

  const response = await instance.getAppVersion();
  console.log(`Installed version is ${response.version}`);
})();

API

constructor

Acceptes a transporter and optionally a scramble key. Returns the instance of the MinaLedgerJS.

const instance = new MinaLedgerJS(transport);

getAppVersion

Returns the installed ledger version.

const version = await instance.getAppVersion();
console.log(version);

getAppName

Returns the name and version of the running ledger app (any ledger app). Useful for checking if the user is using the right app, or for ping purposes.

const nameVersion = await instance.getAppName();
console.log(nameVersion);

getAddress

Returns the public key for the given account.

const address = await instance.getAddress(0);
console.log(address);

signTransaction

Signs the transaction for the given transaction.

const signature = await instance.signTransaction({
  txType: TxType.PAYMENT,
  senderAccount: 0,
  senderAddress: "B62qoBEWahYw3CzeFLBkekmT8B7Z1YsfhNcP32cantDgApQ97RNUMhT",
  receiverAddress: "B62qoBEWahYw3CzeFLBkekmT8B7Z1YsfhNcP32cantDgApQ97RNUMhT",
  amount: 3000000,
  fee: 1000000000,
  nonce: 1,
  memo: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  networkId: Networks.DEVNET,
});
console.log(signature);

Types

See src/types.ts

Example

On node: Open the ledger-app-mina on the Ledger device and run npm install @ledgerhq/hw-transport-node-hid-singleton && npx ts-node example/index.ts to see the methods running. Note, this will add @ledgerhq/hw-transport-node-hid-singleton to the package.json. Do not commit this change. This is just for example purposes.

Thanks

Thank you to Jspada for debug support and for building ledger-app-mina

License

Copyright 2021 Carbonara

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.