Merge pull request #2051 from aeternity/new-ledger-app

Experimental support of Ledger app v1.0.0

Author: davidyuk

examples/browser/aepp/src/components/ConnectLedger.vue

@@ -85,6 +85,7 @@ export default {
         transport = await (isBle ? TransportWebBleAndroidFix : TransportWebUsb).create();
         transport.on('disconnect', () => this.reset());
         const factory = new AccountLedgerFactory(transport);
+        factory._enableExperimentalLedgerAppSupport = true;
         await factory.ensureReady();
         this.accountFactory = factory;
         this.status = '';

src/account/LedgerFactory.ts

@@ -23,15 +23,22 @@ export default class AccountLedgerFactory extends AccountBaseFactory {
 
   #ensureReadyPromise?: Promise<void>;
 
+  // TODO: remove after release Ledger app v1.0.0
+  _enableExperimentalLedgerAppSupport = false;
+
   /**
    * It throws an exception if Aeternity app on Ledger has an incompatible version, not opened or
    * not installed.
    */
   async ensureReady(): Promise<void> {
     const { version } = await this.#getAppConfiguration();
-    const args = [version, '0.4.4', '0.5.0'] as const;
-    if (!semverSatisfies(...args))
-      throw new UnsupportedVersionError('Aeternity app on Ledger', ...args);
+    const oldApp = [version, '0.4.4', '0.5.0'] as const;
+    const newApp = [version, '1.0.0', '2.0.0'] as const;
+    if (
+      !semverSatisfies(...oldApp) &&
+      (!this._enableExperimentalLedgerAppSupport || !semverSatisfies(...newApp))
+    )
+      throw new UnsupportedVersionError('Aeternity app on Ledger', ...oldApp);
     this.#ensureReadyPromise = Promise.resolve();
   }
 
@@ -41,9 +48,10 @@ export default class AccountLedgerFactory extends AccountBaseFactory {
   }
 
   async #getAppConfiguration(): Promise<AppConfiguration> {
-    const response = await this.transport.send(CLA, GET_APP_CONFIGURATION, 0x00, 0x00);
+    let response = await this.transport.send(CLA, GET_APP_CONFIGURATION, 0x00, 0x00);
+    if (response.length === 6) response = response.subarray(1);
     return {
-      version: [response[1], response[2], response[3]].join('.'),
+      version: [response[0], response[1], response[2]].join('.'),
     };
   }
 

test/unit/ledger.ts

@@ -1,4 +1,5 @@
-import { describe, it } from 'mocha';
+import { createInterface } from 'node:readline/promises';
+import { describe, it, before, after } from 'mocha';
 import { expect } from 'chai';
 import '..';
 import {
@@ -10,7 +11,7 @@ import type Transport from '@ledgerhq/hw-transport';
 import TransportNodeHid from '@ledgerhq/hw-transport-node-hid-singleton';
 import {
   AccountLedger,
-  AccountLedgerFactory,
+  AccountLedgerFactory as AccountLedgerFactoryOriginal,
   buildTx,
   Node,
   Tag,
@@ -26,38 +27,56 @@ import { indent } from '../utils';
 const compareWithRealDevice = false; // switch to true for manual testing
 // ledger should be initialized with mnemonic:
 // eye quarter chapter suit cruel scrub verify stuff volume control learn dust
-let recordStore: RecordStore;
-let expectedRecordStore = '';
-
-async function initTransport(s: string, ignoreRealDevice = false): Promise<Transport> {
-  expectedRecordStore = s;
-  if (compareWithRealDevice && !ignoreRealDevice) {
-    const t = await TransportNodeHid.create();
-    recordStore = new RecordStore();
-    const TransportRecorder = createTransportRecorder(t, recordStore);
-    return new TransportRecorder(t);
+
+async function initTransport(
+  expectedRecordStore: string,
+  ignoreRealDevice = false,
+): Promise<Transport> {
+  if (!compareWithRealDevice || ignoreRealDevice) {
+    return openTransportReplayer(RecordStore.fromString(expectedRecordStore));
   }
-  recordStore = RecordStore.fromString(expectedRecordStore);
-  return openTransportReplayer(recordStore);
-}
 
-afterEach(async () => {
-  if (compareWithRealDevice) {
+  // TODO: remove after solving https://github.com/LedgerHQ/ledger-live/issues/9462
+  const Transport =
+    'default' in TransportNodeHid
+      ? (TransportNodeHid.default as typeof TransportNodeHid)
+      : TransportNodeHid;
+  const t = await Transport.create();
+  const recordStore = new RecordStore();
+  const TransportRecorder = createTransportRecorder(t, recordStore);
+  after(() => {
     expect(recordStore.toString().trim()).to.equal(expectedRecordStore);
-  }
-  expectedRecordStore = '';
-});
+  });
+  return new TransportRecorder(t);
+}
 
-describe('Ledger HW', function () {
+function genLedgerTests(this: Mocha.Suite, isNewApp = false): void {
   this.timeout(compareWithRealDevice ? 60000 : 300);
 
+  before(async () => {
+    if (!compareWithRealDevice) return;
+    const rl = createInterface({
+      input: process.stdin,
+      output: process.stdout,
+    });
+    await rl.question(`Open aeternity@${isNewApp ? '1.0.0' : '0.4.4'} on Ledger and press enter`);
+    rl.close();
+  });
+
+  class AccountLedgerFactory extends AccountLedgerFactoryOriginal {
+    constructor(transport: Transport) {
+      super(transport);
+      this._enableExperimentalLedgerAppSupport = isNewApp;
+    }
+  }
+
   describe('factory', () => {
     it('gets app version', async () => {
       const transport = await initTransport(indent`
         => e006000000
-        <= 000004049000`);
+        <= ${isNewApp ? '0100009000' : '000004049000'}`);
       const factory = new AccountLedgerFactory(transport);
-      expect((await factory.getAppConfiguration()).version).to.equal('0.4.4');
+      expect((await factory.getAppConfiguration()).version).to.equal(isNewApp ? '1.0.0' : '0.4.4');
     });
 
     it('ensures that app version is compatible', async () => {
@@ -68,6 +87,7 @@ describe('Ledger HW', function () {
         true,
       );
       const factory = new AccountLedgerFactory(transport);
+      factory._enableExperimentalLedgerAppSupport = false;
       await expect(factory.getAddress(42)).to.be.rejectedWith(
         'Unsupported Aeternity app on Ledger version 1.4.4. Supported: >= 0.4.4 < 0.5.0',
       );
@@ -76,7 +96,7 @@ describe('Ledger HW', function () {
     it('gets address', async () => {
       const transport = await initTransport(indent`
         => e006000000
-        <= 000004049000
+        <= ${isNewApp ? '0100009000' : '000004049000'}
         => e0020000040000002a
         <= 35616b5f3248746565756a614a7a75744b65465a69416d59547a636167536f5245725358704246563137397859677154347465616b769000`);
       const factory = new AccountLedgerFactory(transport);
@@ -88,7 +108,7 @@ describe('Ledger HW', function () {
     it('gets address with verification', async () => {
       const transport = await initTransport(indent`
         => e006000000
-        <= 000004049000
+        <= ${isNewApp ? '0100009000' : '000004049000'}
         => e0020100040000002a
         <= 35616b5f3248746565756a614a7a75744b65465a69416d59547a636167536f5245725358704246563137397859677154347465616b769000`);
       const factory = new AccountLedgerFactory(transport);
@@ -100,7 +120,7 @@ describe('Ledger HW', function () {
     it('gets address with verification rejected', async () => {
       const transport = await initTransport(indent`
         => e006000000
-        <= 000004049000
+        <= ${isNewApp ? '0100009000' : '000004049000'}
         => e0020100040000002a
         <= 6985`);
       const factory = new AccountLedgerFactory(transport);
@@ -112,7 +132,7 @@ describe('Ledger HW', function () {
     it('initializes an account', async () => {
       const transport = await initTransport(indent`
         => e006000000
-        <= 000004049000
+        <= ${isNewApp ? '0100009000' : '000004049000'}
         => e0020000040000002a
         <= 35616b5f3248746565756a614a7a75744b65465a69416d59547a636167536f5245725358704246563137397859677154347465616b769000`);
       const factory = new AccountLedgerFactory(transport);
@@ -147,7 +167,7 @@ describe('Ledger HW', function () {
     it('discovers accounts', async () => {
       const transport = await initTransport(indent`
         => e006000000
-        <= 000004049000
+        <= ${isNewApp ? '0100009000' : '000004049000'}
         => e00200000400000000
         <= 35616b5f327377684c6b674250656541447856544156434a6e5a4c59354e5a744346694d39334a787345614d754335396575754652519000
         => e00200000400000001
@@ -166,7 +186,7 @@ describe('Ledger HW', function () {
     it('discovers accounts on unused ledger', async () => {
       const transport = await initTransport(indent`
         => e006000000
-        <= 000004049000
+        <= ${isNewApp ? '0100009000' : '000004049000'}
         => e00200000400000000
         <= 35616b5f327377684c6b674250656541447856544156434a6e5a4c59354e5a744346694d39334a787345614d754335396575754652519000`);
       const node = new NodeMock();
@@ -179,7 +199,7 @@ describe('Ledger HW', function () {
   describe('account', () => {
     const address = 'ak_2swhLkgBPeeADxVTAVCJnZLY5NZtCFiM93JxsEaMuC59euuFRQ';
     it('fails on calling raw signing', async () => {
-      const transport = await initTransport('\n');
+      const transport = await initTransport('');
       const account = new AccountLedger(transport, 0, address);
       await expect(account.unsafeSign()).to.be.rejectedWith('RAW signing using Ledger HW');
     });
@@ -224,11 +244,12 @@ describe('Ledger HW', function () {
     it('signs message', async () => {
       const transport = await initTransport(indent`
         => e00800002f0000000000000027746573742d6d6573736167652c746573742d6d6573736167652c746573742d6d6573736167652c
-        <= 78397e186058f278835b8e3e866960e4418dc1e9f00b3a2423f57c16021c88720119ebb3373a136112caa1c9ff63870092064659eb2c641dd67767f15c80350c9000`);
+        <= ${isNewApp ? '78397e186058f278835b8e3e866960e4418dc1e9f00b3a2423f57c16021c88720119ebb3373a136112caa1c9ff63870092064659eb2c641dd67767f15c80350c9000' : '63a9410fa235e4b1f0204cc4d36322e666662da5873b399b076961eced2907f502cd3f91b95bbcfd8e235e194888d469bb15ab4382705aa887c2e0c4e6cb1a0b9000'}`);
       const account = new AccountLedger(transport, 0, address);
       const signature = await account.signMessage(message);
       expect(signature).to.be.an.instanceOf(Uint8Array);
-      expect(verifyMessage(message, signature, address)).to.equal(true);
+      // FIXME: correct signature after releasing https://github.com/LedgerHQ/app-aeternity/pull/13
+      expect(verifyMessage(message, signature, address)).to.equal(isNewApp);
     });
 
     it('signs message rejected', async () => {
@@ -241,4 +262,12 @@ describe('Ledger HW', function () {
       );
     });
   });
+}
+
+describe('Ledger HW v0.4.4', function () {
+  genLedgerTests.call(this, false);
+});
+
+describe('Ledger HW v1.0.0', function () {
+  genLedgerTests.call(this, true);
 });