Merge pull request #2860 from input-output-hk/fix/ddw-926-trezor-error-handling

Author: danielmain

CHANGELOG.md

@@ -85,6 +85,7 @@
 
 ### Fixes
 
+- Improved error handling for incorrect passphrase and incorrect hardware wallet error ([PR 2860](https://github.com/input-output-hk/daedalus/pull/2860)) 
 - Fixed rewards CSV export issues ([PR 2885](https://github.com/input-output-hk/daedalus/pull/2885))
 - Fixed behaviour of wallet settings option of the app menu ([PR 2838](https://github.com/input-output-hk/daedalus/pull/2838))
 - Fixed styling of ITN rewards feature ([PR 2861](https://github.com/input-output-hk/daedalus/pull/2861))

gulpfile.js

@@ -177,7 +177,9 @@ gulp.task(
     'clean:dist',
     'server:create:dev',
     'build:renderer:html',
-    'build:main:watch',
+    process.argv.includes('--disable-electron-reload')
+      ? 'build:main'
+      : 'build:main:watch',
     'build:renderer:watch'
   )
 );

source/main/ipc/getHardwareWalletChannel.ts

@@ -27,6 +27,9 @@ import {
 import { HardwareWalletChannels } from './createHardwareWalletIPCChannels';
 import { Device } from './hardwareWallets/ledger/deviceDetection/types';
 import { DeviceDetectionPayload } from './hardwareWallets/ledger/deviceDetection/deviceDetection';
+import { initTrezorConnect, reinitTrezorConnect } from '../trezor/connection';
+import { manifest } from '../trezor/manifest';
+import { buildTrezorDeviceParams } from '../utils/buildTrezorDeviceParams';
 
 type ListenerType = {
   unsubscribe: (...args: Array<any>) => any;
@@ -169,6 +172,8 @@ export const handleHardwareWalletRequests = async (
     TrezorConnect.removeAllListeners();
     // Initialize new device listeners
     TrezorConnect.on(UI_EVENT, (event) => {
+      logger.info('[TREZOR-CONNECT] Received UI_EVENT: ' + event.type);
+
       if (event.type === UI.REQUEST_PASSPHRASE) {
         // ui-request_passphrase
         if (event.payload && event.payload.device) {
@@ -180,11 +185,20 @@ export const handleHardwareWalletRequests = async (
               passphraseOnDevice: true,
             },
           });
+
+          logger.info(
+            '[TREZOR-CONNECT] Called TrezorConnect.uiResponse - requested to provide passphrase on device'
+          );
         }
       }
     });
     TrezorConnect.on(TRANSPORT_EVENT, (event) => {
       if (event.type === TRANSPORT.ERROR) {
+        logger.info(
+          '[TREZOR-CONNECT] Received TRANSPORT_EVENT: transport-error',
+          event.payload
+        );
+
         // Send Transport error to Renderer
         getHardwareWalletConnectionChannel.send(
           {
@@ -198,6 +212,8 @@ export const handleHardwareWalletRequests = async (
       }
     });
     TrezorConnect.on(DEVICE_EVENT, (event) => {
+      logger.info('[TREZOR-CONNECT] Received DEVICE_EVENT: ' + event.type);
+
       const connectionChanged =
         event.type === DEVICE.CONNECT ||
         event.type === DEVICE.DISCONNECT ||
@@ -250,13 +266,13 @@ export const handleHardwareWalletRequests = async (
   getHardwareWalletTransportChannel.onRequest(
     async (request: HardwareWalletTransportDeviceRequest) => {
       const { isTrezor, devicePath } = request;
-      // @ts-ignore ts-migrate(2345) FIXME: Argument of type 'string' is not assignable to par... Remove this comment to see the full error message
-      logger.info('[HW-DEBUG] getHardwareWalletTransportChannel', devicePath);
+      logger.info('[HW-DEBUG] getHardwareWalletTransportChannel', {
+        devicePath,
+      });
       // Connected Trezor device info
       let deviceFeatures;
 
       if (isTrezor) {
-        // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
         logger.info('[HW-DEBUG] getHardwareWalletTransportChannel::TREZOR ');
 
         try {
@@ -265,10 +281,12 @@ export const handleHardwareWalletRequests = async (
               path: devicePath,
             },
           });
-          // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
-          logger.info('[HW-DEBUG] Trezor connect success');
+
+          logger.info('[TREZOR-CONNECT] Called TrezorConnect.getFeatures()');
 
           if (deviceFeatures && deviceFeatures.success) {
+            logger.info('[HW-DEBUG] Trezor connect success');
+
             const {
               major_version: majorVersion,
               minor_version: minorVersion,
@@ -291,19 +309,16 @@ export const handleHardwareWalletRequests = async (
 
           throw deviceFeatures.payload; // Error is in payload
         } catch (e) {
-          // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
           logger.info('[HW-DEBUG] Trezor connect error');
           throw e;
         }
       }
 
       try {
-        // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
         logger.info('[HW-DEBUG] getHardwareWalletTransportChannel:: LEDGER');
         const transportList = await TransportNodeHid.list();
         let hw;
         let lastConnectedPath;
-        // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
         logger.info(
           `[HW-DEBUG] getHardwareWalletTransportChannel::transportList=${JSON.stringify(
             transportList
@@ -336,14 +351,12 @@ export const handleHardwareWalletRequests = async (
         if (transportList && !transportList.length) {
           // Establish connection with last device
           try {
-            // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
             logger.info('[HW-DEBUG] INIT NEW transport');
 
             const { device } = await waitForDevice();
 
             await openTransportLayer(device.path, device);
           } catch (e) {
-            // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
             logger.info('[HW-DEBUG] INIT NEW transport - ERROR');
             throw e;
           }
@@ -362,7 +375,6 @@ export const handleHardwareWalletRequests = async (
             throw new Error('Device not connected!');
           }
         } else {
-          // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
           logger.info('[HW-DEBUG] USE CURRENT CONNECTION');
           hw = devicesMemo[devicePath].transport;
           deviceConnection = get(devicesMemo, [devicePath, 'AdaConnection']);
@@ -394,41 +406,19 @@ export const handleHardwareWalletRequests = async (
 
         throw new Error('Missing device info');
       } catch (error) {
-        // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
         logger.info('[HW-DEBUG] ERROR on getHardwareWalletTransportChannel');
         throw error;
       }
     }
   );
+
   handleInitTrezorConnectChannel.onRequest(async () => {
-    // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
     logger.info('[HW-DEBUG] INIT TREZOR');
     resetTrezorListeners();
-    TrezorConnect.manifest({
-      email: '[email protected]',
-      appUrl: 'http://your.application.com',
-    });
-    TrezorConnect.init({
-      popup: false,
-      // render your own UI
-      webusb: false,
-      // webusb is not supported in electron
-      debug: true,
-      // see what's going on inside connect
-      // lazyLoad: true, // set to "false" (default) if you want to start communication with bridge on application start (and detect connected device right away)
-      // set it to "true", then trezor-connect will not be initialized until you call some TrezorConnect.method()
-      // this is useful when you don't know if you are dealing with Trezor user
-      manifest: {
-        email: '[email protected]',
-        // @TODO
-        appUrl: 'http://your.application.com', // @TODO
-      },
-    })
-      .then(() => {})
-      .catch((error) => {
-        throw error;
-      });
+    TrezorConnect.manifest(manifest);
+    await initTrezorConnect();
   });
+
   handleInitLedgerConnectChannel.onRequest(async () => {
     logger.info('[HW-DEBUG] INIT LEDGER');
     observer = new EventObserver({
@@ -483,16 +473,17 @@ export const handleHardwareWalletRequests = async (
 
     try {
       deviceConnection = get(devicesMemo, [devicePath, 'AdaConnection']);
-      // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+
       logger.info('[HW-DEBUG] DERIVE ADDRESS');
 
       if (isTrezor) {
+        logger.info(
+          '[TREZOR-CONNECT] Called TrezorConnect.cardanoGetAddress()'
+        );
+
         const result = await TrezorConnect.cardanoGetAddress({
-          device: {
-            path: devicePath,
-            // @ts-ignore ts-migrate(2769) FIXME: No overload matches this call.
-            showOnTrezor: true,
-          },
+          showOnTrezor: true,
+          device: buildTrezorDeviceParams(devicePath),
           addressParameters: {
             addressType,
             path: `m/${spendingPathStr}`,
@@ -548,7 +539,7 @@ export const handleHardwareWalletRequests = async (
 
     try {
       deviceConnection = get(devicesMemo, [devicePath, 'AdaConnection']);
-      // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+
       logger.info('[HW-DEBUG] SHOW ADDRESS');
 
       if (isTrezor) {
@@ -641,14 +632,13 @@ export const handleHardwareWalletRequests = async (
         };
       }
 
-      // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
       logger.info(`[HW-DEBUG] GET CARDANO APP path:${path}`);
       deviceConnection = devicesMemo[path].AdaConnection;
       const { version } = await deviceConnection.getVersion();
-      // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+
       logger.info('[HW-DEBUG] getCardanoAdaAppChannel:: appVersion');
       const { serialHex } = await deviceConnection.getSerial();
-      // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+
       logger.info(
         `[HW-DEBUG] getCardanoAdaAppChannel:: deviceSerial: ${serialHex}`
       );
@@ -686,6 +676,12 @@ export const handleHardwareWalletRequests = async (
         const hasPathChanged = !includes(devicePaths, oldPath);
         const newPath = hasPathChanged ? last(devicePaths) : oldPath;
 
+        if (hasPathChanged) {
+          logger.info(
+            `[HW-DEBUG] Device path changed from ${oldPath} to ${newPath}`
+          );
+        }
+
         if (!newPath) {
           logger.info(
             '[HW-DEBUG] ERROR in Cardano App (Device paths list is empty)',
@@ -749,20 +745,26 @@ export const handleHardwareWalletRequests = async (
   getExtendedPublicKeyChannel.onRequest(async (params) => {
     // Params example:
     // { path: "1852'/1815'/0'", isTrezor: false, devicePath: null }
-    // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+
     logger.info('[HW-DEBUG] getExtendedPublicKeyChannel');
     const { path, isTrezor, devicePath } = params;
 
     try {
       if (isTrezor) {
-        // Check if Trezor instantiated
+        // We re-initialize the Trezor Connect session to give the user the chance to provide
+        // a different passphrase, in case they want to switch to a different
+        // hidden wallet or just if they provided a wrong one.
+        await reinitTrezorConnect();
+
+        logger.info('[TREZOR-CONNECT] Calling TrezorConnect.getFeatures()');
         const deviceFeatures = await TrezorConnect.getFeatures({
-          device: {
-            path: devicePath,
-          },
+          device: buildTrezorDeviceParams(devicePath),
         });
 
         if (deviceFeatures.success) {
+          logger.info(
+            '[TREZOR-CONNECT] Calling TrezorConnect.cardanoGetPublicKey()'
+          );
           const extendedPublicKeyResponse = await TrezorConnect.cardanoGetPublicKey(
             {
               path: `m/${path}`,
@@ -774,15 +776,13 @@ export const handleHardwareWalletRequests = async (
             throw extendedPublicKeyResponse.payload;
           }
 
-          const extendedPublicKey = get(
-            extendedPublicKeyResponse,
-            ['payload', 'node'],
-            {}
-          );
+          const extendedPublicKey = get(extendedPublicKeyResponse, [
+            'payload',
+            'node',
+          ]);
+
           return Promise.resolve({
-            // @ts-ignore ts-migrate(2339) FIXME: Property 'public_key' does not exist on type '{} |... Remove this comment to see the full error message
             publicKeyHex: extendedPublicKey.public_key,
-            // @ts-ignore ts-migrate(2339) FIXME: Property 'chain_code' does not exist on type '{} |... Remove this comment to see the full error message
             chainCodeHex: extendedPublicKey.chain_code,
           });
         }
@@ -791,7 +791,7 @@ export const handleHardwareWalletRequests = async (
       }
 
       deviceConnection = get(devicesMemo, [devicePath, 'AdaConnection']);
-      // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+
       logger.info('[HW-DEBUG] EXPORT KEY');
 
       // Check if Ledger instantiated
@@ -829,7 +829,7 @@ export const handleHardwareWalletRequests = async (
       signingMode,
       additionalWitnessPaths,
     } = params;
-    // @ts-ignore ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+
     logger.info('[HW-DEBUG] SIGN Ledger transaction');
     deviceConnection = devicePath
       ? devicesMemo[devicePath].AdaConnection
@@ -897,19 +897,25 @@ export const handleHardwareWalletRequests = async (
         auxiliaryData,
         signingMode,
       };
+
+      logger.info(
+        '[TREZOR-CONNECT] Calling TrezorConnect.cardanoSignTransaction()'
+      );
+
       // @ts-ignore ts-migrate(2345) FIXME: Argument of type '{ inputs: TrezorSignTransactionI... Remove this comment to see the full error message
       const signedTransaction = await TrezorConnect.cardanoSignTransaction({
-        device: {
-          path: devicePath,
-        },
+        device: buildTrezorDeviceParams(devicePath),
         ...dataToSign,
       });
+
       return Promise.resolve(signedTransaction);
     } catch (e) {
       throw e;
     }
   });
+
   resetTrezorActionChannel.onRequest(async () => {
+    logger.info('[TREZOR-CONNECT] Called TrezorConnect.cancel()');
     TrezorConnect.cancel('Method_Cancel');
   });
 };

source/main/trezor/connection.ts

@@ -0,0 +1,20 @@
+import TrezorConnect from 'trezor-connect';
+import { logger } from '../utils/logging';
+import { manifest } from './manifest';
+
+export const initTrezorConnect = async () => {
+  try {
+    await TrezorConnect.init({
+      popup: false, // render your own UI
+      webusb: false, // webusb is not supported in electron
+      debug: true,
+      manifest,
+    });
+    logger.info('[TREZOR-CONNECT] Called TrezorConnect.init()');
+  } catch (error) {
+    logger.info('[TREZOR-CONNECT] Failed to call TrezorConnect.init()');
+    throw error;
+  }
+};
+
+export const reinitTrezorConnect = initTrezorConnect;

source/main/trezor/manifest.ts

@@ -0,0 +1,6 @@
+import { Manifest } from 'trezor-connect';
+
+export const manifest: Manifest = {
+  email: '[email protected]',
+  appUrl: 'https://daedaluswallet.io/',
+};

source/main/utils/buildTrezorDeviceParams.ts

@@ -0,0 +1,19 @@
+import { CommonParams } from 'trezor-connect';
+import { logger } from './logging';
+
+export const buildTrezorDeviceParams = (
+  path: string | null
+): CommonParams['device'] => {
+  if (path !== null) {
+    logger.info(
+      `[HW-DEBUG] Connecting Trezor device with ${path} as device path`
+    );
+
+    return {
+      path,
+    };
+  }
+
+  logger.info('[HW-DEBUG] Connecting Trezor device with null as device path');
+  return undefined;
+};