@dfinity/hardware-wallet-cli 0.1.0 → 0.2.1

package/README.md

@@ -2,10 +2,11 @@
 
 A CLI to interact with the Internet Computer App on Ledger Nano S/X devices.
 
-## Installation
+## Quick Start
 
-1. Install `npm >= 6.14`.
-2. Install the CLI: `npm install -g @dfinity/hardware-wallet-cli`
+* Install `npm >= 6.14`.
+* Install the CLI: `npm install -g @dfinity/hardware-wallet-cli`
+* Run the CLI: `ic-hardware-wallet --help`
 
 ## USB connection issues with Ledger Live
 
@@ -15,3 +16,16 @@ Live desktop app running on your computer. If you are facing connection issues
 when doing so, Ledger provides platform-specific
 [troubleshooting instructions](https://support.ledger.com/hc/en-us/articles/115005165269-Fix-USB-connection-issues-with-Ledger-Live?support=true)
 on their support site.
+
+## Development
+
+Clone the repository.
+
+Install dependencies with `npm install`.
+
+To execute a command, you can use `npm run execute -- <args>`.
+
+For example
+
+* The command `ic-hardware-wallet --network https://nnsdapp.dfinity.network icp balance`.
+* Would be `npm run execute -- --network https://nnsdapp.dfinity.network icp balance` for development.

package/build/index.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const identity_1 = require("./src/ledger/identity");
 const nns_1 = require("@dfinity/nns");
+const principal_1 = require("@dfinity/principal");
 const agent_1 = require("@dfinity/agent");
 const chalk_1 = __importDefault(require("chalk"));
 // Add polyfill for `window` for `TransportWebHID` checks to work.
@@ -17,7 +18,6 @@ require("node-window-polyfill/register");
 // Add polyfill for `window.fetch` for agent-js to work.
 // @ts-ignore (no types are available)
 const node_fetch_1 = __importDefault(require("node-fetch"));
-const principal_1 = require("@dfinity/principal");
 global.fetch = node_fetch_1.default;
 window.fetch = node_fetch_1.default;
 const program = new commander_1.Command();
@@ -145,7 +145,7 @@ async function disburseNeuron(neuronId, to, amount) {
     const identity = await identity_1.LedgerIdentity.create();
     const governance = nns_1.GovernanceCanister.create({
         agent: await getAgent(identity),
-        hardwareWallet: false,
+        hardwareWallet: true,
     });
     await governance.disburse({
         neuronId: BigInt(neuronId),
@@ -227,10 +227,18 @@ async function listNeurons() {
         ok("No neurons found.");
     }
 }
+const buf2hex = (buffer) => {
+    return [...new Uint8Array(buffer)]
+        .map((x) => x.toString(16).padStart(2, "0"))
+        .join("");
+};
 /**
  * Fetches the balance of the main account on the wallet.
  */
-async function claimNeurons(hexPubKey) {
+async function claimNeurons() {
+    const identity = await identity_1.LedgerIdentity.create();
+    const bufferKey = identity.getPublicKey();
+    const hexPubKey = buf2hex(bufferKey.toRaw());
     const isHex = hexPubKey.match("^[0-9a-fA-F]+$");
     if (!isHex) {
         throw new Error(`${hexPubKey} is not a hex string.`);
@@ -238,7 +246,6 @@ async function claimNeurons(hexPubKey) {
     if (hexPubKey.length < 130 || hexPubKey.length > 150) {
         throw new Error(`The key must be >= 130 characters and <= 150 characters.`);
     }
-    const identity = await identity_1.LedgerIdentity.create();
     const governance = await nns_1.GenesisTokenCanister.create({
         agent: await getAgent(identity),
     });
@@ -360,8 +367,8 @@ async function main() {
         .requiredOption("--principal <principal>", "Principal", tryParsePrincipal)
         .action((args) => run(() => removeHotkey(args.neuronId, args.principal))))
         .addCommand(new commander_1.Command("claim")
-        .requiredOption("--hex-public-key <public-key>", "Claim the caller's GTC neurons.")
-        .action((args) => run(() => claimNeurons(args.hexPublicKey))));
+        .description("Claim the caller's GTC neurons.")
+        .action((args) => run(() => claimNeurons())));
     const icp = new commander_1.Command("icp")
         .description("Commands for managing ICP.")
         .showSuggestionAfterError()

package/build/src/ledger/identity.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -158,8 +162,6 @@ class LedgerIdentity extends agent_1.SignIdentity {
         return this._publicKey;
     }
     async sign(blob) {
-        console.log("About to sign");
-        console.log(Buffer.from(blob).toString("hex"));
         return await this._executeWithApp(async (app) => {
             const resp = await app.sign(this.derivePath, Buffer.from(blob), this._neuronStakeFlag ? 1 : 0);
             // Remove the "neuron stake" flag, since we already signed the transaction.

package/index.ts

@@ -15,6 +15,8 @@ import {
   InsufficientAmountError,
   InsufficientFundsError,
 } from "@dfinity/nns";
+import { Principal } from "@dfinity/principal";
+import type { Secp256k1PublicKey } from "src/ledger/secp256k1";
 import { Agent, AnonymousIdentity, HttpAgent, Identity } from "@dfinity/agent";
 import chalk from "chalk";
 
@@ -24,7 +26,7 @@ import "node-window-polyfill/register";
 // Add polyfill for `window.fetch` for agent-js to work.
 // @ts-ignore (no types are available)
 import fetch from "node-fetch";
-import { Principal } from "@dfinity/principal";
+
 global.fetch = fetch;
 window.fetch = fetch;
 
@@ -184,7 +186,7 @@ async function disburseNeuron(neuronId: bigint, to?: string, amount?: bigint) {
   const identity = await LedgerIdentity.create();
   const governance = GovernanceCanister.create({
     agent: await getAgent(identity),
-    hardwareWallet: false,
+    hardwareWallet: true,
   });
 
   await governance.disburse({
@@ -285,10 +287,20 @@ async function listNeurons() {
   }
 }
 
+const buf2hex = (buffer: ArrayBuffer): string => {
+  return [...new Uint8Array(buffer)]
+    .map((x) => x.toString(16).padStart(2, "0"))
+    .join("");
+};
+
 /**
  * Fetches the balance of the main account on the wallet.
  */
-async function claimNeurons(hexPubKey: string) {
+async function claimNeurons() {
+  const identity = await LedgerIdentity.create();
+
+  const bufferKey = identity.getPublicKey() as Secp256k1PublicKey;
+  const hexPubKey = buf2hex(bufferKey.toRaw());
   const isHex = hexPubKey.match("^[0-9a-fA-F]+$");
   if (!isHex) {
     throw new Error(`${hexPubKey} is not a hex string.`);
@@ -298,7 +310,6 @@ async function claimNeurons(hexPubKey: string) {
     throw new Error(`The key must be >= 130 characters and <= 150 characters.`);
   }
 
-  const identity = await LedgerIdentity.create();
   const governance = await GenesisTokenCanister.create({
     agent: await getAgent(identity),
   });
@@ -477,11 +488,10 @@ async function main() {
     )
     .addCommand(
       new Command("claim")
-        .requiredOption(
-          "--hex-public-key <public-key>",
+        .description(
           "Claim the caller's GTC neurons."
         )
-        .action((args) => run(() => claimNeurons(args.hexPublicKey)))
+        .action((args) => run(() => claimNeurons()))
     );
 
   const icp = new Command("icp")

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@dfinity/hardware-wallet-cli",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "A CLI to interact with the Internet Computer App on Ledger Nano S/X devices.",
   "main": "./build/index.js",
   "scripts": {
     "format": "prettier --write .",
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc --build",
+    "prepack": "npm run build",
     "clean": "tsc --build --clean",
-    "refresh": "rm -rf ./node_modules ./package-lock.json && npm install"
+    "refresh": "rm -rf ./node_modules ./package-lock.json && npm install",
+    "execute": "ts-node ./index.ts"
   },
   "repository": {
     "type": "git",
@@ -35,7 +37,8 @@
     "@types/google-protobuf": "^3.15.6",
     "@types/node": "^17.0.16",
     "@types/node-hid": "^1.3.1",
-    "prettier": "^2.6.2"
+    "prettier": "^2.6.2",
+    "ts-node": "^10.8.0"
   },
   "bin": {
     "ic-hardware-wallet": "./build/index.js"

package/src/ledger/identity.ts

@@ -165,8 +165,6 @@ export class LedgerIdentity extends SignIdentity {
   }
 
   public async sign(blob: ArrayBuffer): Promise<Signature> {
-    console.log("About to sign");
-    console.log(Buffer.from(blob).toString("hex"));
     return await this._executeWithApp(async (app: LedgerApp) => {
       const resp: ResponseSign = await app.sign(
         this.derivePath,