@dfinity/hardware-wallet-cli 0.1.1 → 0.2.2

package/.github/CODEOWNERS

@@ -1,2 +1,2 @@
 # The codebase is owned by the Governance & Identity Experience team at DFINITY
-*   @dfinity/gix
+# For questions, reach out to: <gix@dfinity.org>

package/README.md

@@ -16,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();
@@ -39,16 +39,24 @@ async function getAgent(identity) {
     }
     return agent;
 }
+async function getLedgerIdentity() {
+    const principalPath = tryParseInt(program.opts().principal);
+    if (principalPath < 0 || principalPath > 255) {
+        throw new commander_1.InvalidArgumentError("Principal path must be between 0 and 255 inclusive.");
+    }
+    return identity_1.LedgerIdentity.create(`m/44'/223'/0'/0/${principalPath}`);
+}
 /**
  * Fetches the balance of the main account on the wallet.
  */
 async function getBalance() {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const accountIdentifier = nns_1.AccountIdentifier.fromPrincipal({
         principal: identity.getPrincipal(),
     });
     const ledger = nns_1.LedgerCanister.create({
         agent: await getAgent(new agent_1.AnonymousIdentity()),
+        hardwareWallet: true,
     });
     const balance = await ledger.accountBalance({
         accountIdentifier: accountIdentifier,
@@ -62,9 +70,10 @@ async function getBalance() {
  * @param amount Amount to send in e8s.
  */
 async function sendICP(to, amount) {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const ledger = nns_1.LedgerCanister.create({
         agent: await getAgent(identity),
+        hardwareWallet: true,
     });
     const blockHeight = await ledger.transfer({
         to: to,
@@ -77,12 +86,14 @@ async function sendICP(to, amount) {
  * Shows the principal and account idenifier on the terminal and on the wallet's screen.
  */
 async function showInfo(showOnDevice) {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const accountIdentifier = nns_1.AccountIdentifier.fromPrincipal({
         principal: identity.getPrincipal(),
     });
+    const publicKey = identity.getPublicKey();
     log(chalk_1.default.bold(`Principal: `) + identity.getPrincipal());
     log(chalk_1.default.bold(`Address (${identity.derivePath}): `) + accountIdentifier.toHex());
+    log(chalk_1.default.bold('Public key: ') + publicKey.toHex());
     if (showOnDevice) {
         log("Displaying the principal and the address on the device...");
         await identity.showAddressAndPubKeyOnDevice();
@@ -94,7 +105,7 @@ async function showInfo(showOnDevice) {
  * @param amount Amount to stake in e8s.
  */
 async function stakeNeuron(stake) {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const ledger = nns_1.LedgerCanister.create({
         agent: await getAgent(identity),
     });
@@ -126,7 +137,7 @@ async function stakeNeuron(stake) {
     }
 }
 async function increaseDissolveDelay(neuronId, years, days, minutes, seconds) {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const governance = nns_1.GovernanceCanister.create({
         agent: await getAgent(identity),
         hardwareWallet: true,
@@ -142,7 +153,7 @@ async function increaseDissolveDelay(neuronId, years, days, minutes, seconds) {
     ok();
 }
 async function disburseNeuron(neuronId, to, amount) {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const governance = nns_1.GovernanceCanister.create({
         agent: await getAgent(identity),
         hardwareWallet: true,
@@ -155,7 +166,7 @@ async function disburseNeuron(neuronId, to, amount) {
     ok();
 }
 async function spawnNeuron(neuronId, controller) {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const governance = nns_1.GovernanceCanister.create({
         agent: await getAgent(identity),
         hardwareWallet: true,
@@ -167,7 +178,7 @@ async function spawnNeuron(neuronId, controller) {
     ok(`Spawned neuron with ID ${spawnedNeuronId}`);
 }
 async function startDissolving(neuronId) {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const governance = nns_1.GovernanceCanister.create({
         agent: await getAgent(identity),
         hardwareWallet: true,
@@ -176,7 +187,7 @@ async function startDissolving(neuronId) {
     ok();
 }
 async function stopDissolving(neuronId) {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const governance = nns_1.GovernanceCanister.create({
         agent: await getAgent(identity),
         hardwareWallet: true,
@@ -185,7 +196,7 @@ async function stopDissolving(neuronId) {
     ok();
 }
 async function addHotkey(neuronId, principal) {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const governance = nns_1.GovernanceCanister.create({
         agent: await getAgent(identity),
         hardwareWallet: true,
@@ -197,7 +208,7 @@ async function addHotkey(neuronId, principal) {
     ok();
 }
 async function removeHotkey(neuronId, principal) {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const governance = nns_1.GovernanceCanister.create({
         agent: await getAgent(identity),
         hardwareWallet: true,
@@ -209,7 +220,7 @@ async function removeHotkey(neuronId, principal) {
     ok();
 }
 async function listNeurons() {
-    const identity = await identity_1.LedgerIdentity.create();
+    const identity = await getLedgerIdentity();
     const governance = nns_1.GovernanceCanister.create({
         agent: await getAgent(identity),
         hardwareWallet: true,
@@ -230,20 +241,15 @@ async function listNeurons() {
 /**
  * Fetches the balance of the main account on the wallet.
  */
-async function claimNeurons(hexPubKey) {
-    const isHex = hexPubKey.match("^[0-9a-fA-F]+$");
-    if (!isHex) {
-        throw new Error(`${hexPubKey} is not a hex string.`);
-    }
-    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();
+async function claimNeurons() {
+    const identity = await getLedgerIdentity();
+    const publicKey = identity.getPublicKey();
+    const hexPubKey = publicKey.toHex();
     const governance = await nns_1.GenesisTokenCanister.create({
         agent: await getAgent(identity),
     });
     const claimedNeuronIds = await governance.claimNeurons({
-        hexPubKey: hexPubKey,
+        hexPubKey,
     });
     ok(`Successfully claimed the following neurons: ${claimedNeuronIds}`);
 }
@@ -360,8 +366,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()
@@ -381,6 +387,7 @@ async function main() {
         .addOption(new commander_1.Option("--network <network>", "The IC network to talk to.")
         .default("https://ic0.app")
         .env("IC_NETWORK"))
+        .addOption(new commander_1.Option("--principal <principal>", "The derivation path to use for the principal.\n(e.g. --principal 123 will result in a derivation path of m/44'/223'/0'/0/123)\nMust be >= 0 && <= 255").default(0))
         .addCommand(new commander_1.Command("info")
         .option("-n --no-show-on-device")
         .description("Show the wallet's principal, address, and balance.")

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];

package/build/src/ledger/secp256k1.js

@@ -14,6 +14,11 @@ function equals(b1, b2) {
     }
     return true;
 }
+const buf2hex = (buffer) => {
+    return [...new Uint8Array(buffer)]
+        .map((x) => x.toString(16).padStart(2, "0"))
+        .join("");
+};
 // This implementation is adjusted from the Ed25519PublicKey.
 // The RAW_KEY_LENGTH and DER_PREFIX are modified accordingly
 class Secp256k1PublicKey {
@@ -58,6 +63,17 @@ class Secp256k1PublicKey {
     toRaw() {
         return this.rawKey;
     }
+    toHex() {
+        const hexPubKey = buf2hex(this.toRaw());
+        const isHex = hexPubKey.match("^[0-9a-fA-F]+$");
+        if (!isHex) {
+            throw new Error(`${hexPubKey} is not a hex string.`);
+        }
+        if (hexPubKey.length < 130 || hexPubKey.length > 150) {
+            throw new Error(`The key must be >= 130 characters and <= 150 characters.`);
+        }
+        return hexPubKey;
+    }
 }
 exports.Secp256k1PublicKey = Secp256k1PublicKey;
 // The length of secp256k1 public keys is always 65 bytes.

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;
 
@@ -54,17 +56,28 @@ async function getAgent(identity: Identity): Promise<Agent> {
   return agent;
 }
 
+async function getLedgerIdentity(): Promise<LedgerIdentity> {
+  const principalPath = tryParseInt(program.opts().principal);
+  if (principalPath < 0 || principalPath > 255) {
+    throw new InvalidArgumentError(
+      "Principal path must be between 0 and 255 inclusive."
+    );
+  }
+  return LedgerIdentity.create(`m/44'/223'/0'/0/${principalPath}`);
+}
+
 /**
  * Fetches the balance of the main account on the wallet.
  */
 async function getBalance() {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const accountIdentifier = AccountIdentifier.fromPrincipal({
     principal: identity.getPrincipal(),
   });
 
   const ledger = LedgerCanister.create({
     agent: await getAgent(new AnonymousIdentity()),
+    hardwareWallet: true,
   });
 
   const balance = await ledger.accountBalance({
@@ -81,9 +94,10 @@ async function getBalance() {
  * @param amount Amount to send in e8s.
  */
 async function sendICP(to: AccountIdentifier, amount: ICP) {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const ledger = LedgerCanister.create({
     agent: await getAgent(identity),
+    hardwareWallet: true,
   });
 
   const blockHeight = await ledger.transfer({
@@ -99,15 +113,19 @@ async function sendICP(to: AccountIdentifier, amount: ICP) {
  * Shows the principal and account idenifier on the terminal and on the wallet's screen.
  */
 async function showInfo(showOnDevice?: boolean) {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const accountIdentifier = AccountIdentifier.fromPrincipal({
     principal: identity.getPrincipal(),
   });
+  const publicKey = identity.getPublicKey() as Secp256k1PublicKey;
 
   log(chalk.bold(`Principal: `) + identity.getPrincipal());
   log(
     chalk.bold(`Address (${identity.derivePath}): `) + accountIdentifier.toHex()
   );
+  log(
+    chalk.bold('Public key: ') + publicKey.toHex()
+  )
 
   if (showOnDevice) {
     log("Displaying the principal and the address on the device...");
@@ -121,7 +139,7 @@ async function showInfo(showOnDevice?: boolean) {
  * @param amount Amount to stake in e8s.
  */
 async function stakeNeuron(stake: ICP) {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const ledger = LedgerCanister.create({
     agent: await getAgent(identity),
   });
@@ -160,7 +178,7 @@ async function increaseDissolveDelay(
   minutes: number,
   seconds: number
 ) {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const governance = GovernanceCanister.create({
     agent: await getAgent(identity),
     hardwareWallet: true,
@@ -181,7 +199,7 @@ async function increaseDissolveDelay(
 }
 
 async function disburseNeuron(neuronId: bigint, to?: string, amount?: bigint) {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const governance = GovernanceCanister.create({
     agent: await getAgent(identity),
     hardwareWallet: true,
@@ -197,7 +215,7 @@ async function disburseNeuron(neuronId: bigint, to?: string, amount?: bigint) {
 }
 
 async function spawnNeuron(neuronId: string, controller?: Principal) {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const governance = GovernanceCanister.create({
     agent: await getAgent(identity),
     hardwareWallet: true,
@@ -211,7 +229,7 @@ async function spawnNeuron(neuronId: string, controller?: Principal) {
 }
 
 async function startDissolving(neuronId: bigint) {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const governance = GovernanceCanister.create({
     agent: await getAgent(identity),
     hardwareWallet: true,
@@ -223,7 +241,7 @@ async function startDissolving(neuronId: bigint) {
 }
 
 async function stopDissolving(neuronId: bigint) {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const governance = GovernanceCanister.create({
     agent: await getAgent(identity),
     hardwareWallet: true,
@@ -235,7 +253,7 @@ async function stopDissolving(neuronId: bigint) {
 }
 
 async function addHotkey(neuronId: bigint, principal: Principal) {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const governance = GovernanceCanister.create({
     agent: await getAgent(identity),
     hardwareWallet: true,
@@ -250,7 +268,7 @@ async function addHotkey(neuronId: bigint, principal: Principal) {
 }
 
 async function removeHotkey(neuronId: bigint, principal: Principal) {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const governance = GovernanceCanister.create({
     agent: await getAgent(identity),
     hardwareWallet: true,
@@ -265,7 +283,7 @@ async function removeHotkey(neuronId: bigint, principal: Principal) {
 }
 
 async function listNeurons() {
-  const identity = await LedgerIdentity.create();
+  const identity = await getLedgerIdentity();
   const governance = GovernanceCanister.create({
     agent: await getAgent(identity),
     hardwareWallet: true,
@@ -288,23 +306,18 @@ async function listNeurons() {
 /**
  * Fetches the balance of the main account on the wallet.
  */
-async function claimNeurons(hexPubKey: string) {
-  const isHex = hexPubKey.match("^[0-9a-fA-F]+$");
-  if (!isHex) {
-    throw new Error(`${hexPubKey} is not a hex string.`);
-  }
+async function claimNeurons() {
+  const identity = await getLedgerIdentity();
 
-  if (hexPubKey.length < 130 || hexPubKey.length > 150) {
-    throw new Error(`The key must be >= 130 characters and <= 150 characters.`);
-  }
+  const publicKey = identity.getPublicKey() as Secp256k1PublicKey;
+  const hexPubKey = publicKey.toHex();
 
-  const identity = await LedgerIdentity.create();
   const governance = await GenesisTokenCanister.create({
     agent: await getAgent(identity),
   });
 
   const claimedNeuronIds = await governance.claimNeurons({
-    hexPubKey: hexPubKey,
+    hexPubKey,
   });
 
   ok(`Successfully claimed the following neurons: ${claimedNeuronIds}`);
@@ -477,11 +490,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")
@@ -518,6 +530,11 @@ async function main() {
         .default("https://ic0.app")
         .env("IC_NETWORK")
     )
+    .addOption(
+      new Option("--principal <principal>", "The derivation path to use for the principal.\n(e.g. --principal 123 will result in a derivation path of m/44'/223'/0'/0/123)\nMust be >= 0 && <= 255").default(
+        0
+      )
+    )
     .addCommand(
       new Command("info")
         .option("-n --no-show-on-device")

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "@dfinity/hardware-wallet-cli",
-  "version": "0.1.1",
+  "version": "0.2.2",
   "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",
+    "update:nns": "npm update @dfinity/nns"
   },
   "repository": {
     "type": "git",
@@ -22,7 +25,7 @@
   "homepage": "https://github.com/dfinity/hardware-wallet-cli#readme",
   "dependencies": {
     "@dfinity/agent": "^0.11.2",
-    "@dfinity/nns": "^0.4.2",
+    "@dfinity/nns": "nightly",
     "@ledgerhq/hw-transport-node-hid-noevents": "^6.3.0",
     "@ledgerhq/hw-transport-webhid": "^6.27.1",
     "@zondax/ledger-icp": "^0.6.0",
@@ -35,7 +38,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/secp256k1.ts

@@ -15,6 +15,12 @@ function equals(b1: ArrayBuffer, b2: ArrayBuffer): boolean {
   return true;
 }
 
+const buf2hex = (buffer: ArrayBuffer): string => {
+  return [...new Uint8Array(buffer)]
+    .map((x) => x.toString(16).padStart(2, "0"))
+    .join("");
+};
+
 // This implementation is adjusted from the Ed25519PublicKey.
 // The RAW_KEY_LENGTH and DER_PREFIX are modified accordingly
 export class Secp256k1PublicKey implements PublicKey {
@@ -93,4 +99,19 @@ export class Secp256k1PublicKey implements PublicKey {
   public toRaw(): ArrayBuffer {
     return this.rawKey;
   }
+
+  public toHex(): string {
+    const hexPubKey = buf2hex(this.toRaw());
+
+    const isHex = hexPubKey.match("^[0-9a-fA-F]+$");
+    if (!isHex) {
+      throw new Error(`${hexPubKey} is not a hex string.`);
+    }
+  
+    if (hexPubKey.length < 130 || hexPubKey.length > 150) {
+      throw new Error(`The key must be >= 130 characters and <= 150 characters.`);
+    }
+
+    return hexPubKey;
+  }
 }