[DDW-722] Code cleanup

Author: renanvalentin

hardware-wallet-tests/cardano-app-already-launched.ts

@@ -36,6 +36,7 @@ export const run = () => {
           deviceModel: expect.any(String),
           deviceName: expect.any(String),
           path: expect.any(String),
+          product: expect.any(String),
         });
 
         const cardanoAppChannelReply = await cardanoAppChannel.request(

hardware-wallet-tests/cardano-app-not-started.ts

@@ -36,6 +36,7 @@ export const run = () => {
           deviceModel: expect.any(String),
           deviceName: expect.any(String),
           path: expect.any(String),
+          product: expect.any(String),
         });
 
         try {
@@ -49,28 +50,28 @@ export const run = () => {
             patch: expect.any(Number),
             deviceId: expect.any(String),
           });
-
-          const extendedPublicKey = await publicKeyChannel.request(
-            {
-              path: "1852'/1815'/0'",
-              // Shelley 1852 ADA 1815 indicator for account '0'
-              isTrezor: false,
-              devicePath: params.path,
-            },
-            ipcRenderer,
-            ipcRenderer
-          );
-
-          expect(extendedPublicKey).toEqual({
-            chainCodeHex: expect.any(String),
-            publicKeyHex: expect.any(String),
-            deviceId: expect.any(String),
-          });
-
-          resolve();
         } catch (err) {
           return null;
         }
+
+        const extendedPublicKey = await publicKeyChannel.request(
+          {
+            path: "1852'/1815'/0'",
+            // Shelley 1852 ADA 1815 indicator for account '0'
+            isTrezor: false,
+            devicePath: params.path,
+          },
+          ipcRenderer,
+          ipcRenderer
+        );
+
+        expect(extendedPublicKey).toEqual({
+          chainCodeHex: expect.any(String),
+          publicKeyHex: expect.any(String),
+          deviceId: expect.any(String),
+        });
+
+        resolve();
       }
     );
 

hardware-wallet-tests/multiple-hardware-wallets.ts

@@ -15,15 +15,13 @@ export const run = () => {
 
   const hardwareWalletConnectionChannel = createHardwareWalletConnectionChannel();
 
-  const promptMessages = createTestInstructions([
+  createTestInstructions([
     'Start test runner',
     'Plug Ledger Nano S to your computer',
     'Plug Ledger Nano X to your computer',
   ]);
 
-  promptMessages();
-
-  const expectedSequence = createSequentialResult([
+  const getNextExpectedSequence = createSequentialResult([
     {
       disconnected: false,
       deviceModel: 'nanoS',
@@ -37,7 +35,7 @@ export const run = () => {
   return new Promise((resolve) => {
     hardwareWalletConnectionChannel.onReceive(
       async (message: { path: string; deviceModel: string }) => {
-        const [expectedValue, isOver] = expectedSequence();
+        const [expectedValue, isOver] = getNextExpectedSequence();
         expect(message).toEqual(expectedValue);
 
         if (isOver) {

hardware-wallet-tests/remove-multiple-hardware-wallets.ts

@@ -8,7 +8,7 @@ import {
   createTestInstructions,
 } from './utils';
 
-const expectedSequence = createSequentialResult([
+const getNextExpectedSequence = createSequentialResult([
   {
     disconnected: false,
     deviceModel: 'nanoS',
@@ -34,27 +34,23 @@ export const run = () => {
 
   const hardwareWalletConnectionChannel = createHardwareWalletConnectionChannel();
 
-  const promptMessages = createTestInstructions([
+  createTestInstructions([
     'Connect Nano S',
     'Connect Nano X',
     'Disconnect Nano S',
     'Disconnect Nano X',
   ]);
 
-  promptMessages();
-
   return new Promise((resolve) => {
     hardwareWalletConnectionChannel.onReceive(
       async (params: { path: string; deviceModel: string }) => {
-        const [expectedValue, isOver] = expectedSequence();
+        const [expectedValue, isOver] = getNextExpectedSequence();
 
         expect(params).toEqual(expectedValue);
 
         if (isOver) {
           return resolve(null);
         }
-
-        promptMessages();
       }
     );
 

hardware-wallet-tests/remove-single-hardware-wallet.ts

@@ -11,7 +11,7 @@ import {
 export const run = () => {
   expect.assertions(3);
 
-  const promptMessages = createTestInstructions([
+  createTestInstructions([
     'Plug Ledger Nano S to your computer',
     'Disconnect Nano S',
   ]);
@@ -20,7 +20,7 @@ export const run = () => {
 
   const hardwareWalletConnectionChannel = createHardwareWalletConnectionChannel();
 
-  const expectedSequence = createSequentialResult([
+  const getNextExpectedSequence = createSequentialResult([
     {
       disconnected: false,
     },
@@ -29,16 +29,13 @@ export const run = () => {
     },
   ]);
 
-  promptMessages();
-
   return new Promise((resolve) => {
     hardwareWalletConnectionChannel.onReceive(
       async (params: { path: string }) => {
-        const [expectedValue, isOver] = expectedSequence();
+        const [expectedValue, isOver] = getNextExpectedSequence();
         expect(params).toEqual(expectedValue);
 
         if (isOver) return resolve(null);
-        promptMessages();
       }
     );
 

hardware-wallet-tests/utils.ts

@@ -115,6 +115,7 @@ export const createSequentialResult = (sequence: Array<Partial<Result>>) => {
     deviceModel: expect.any(String),
     deviceName: expect.any(String),
     path: expect.any(String),
+    product: expect.any(String),
   };
 
   const result = sequence.map((s) => ({ ...common, ...s }));
@@ -127,6 +128,4 @@ export const log = (message: string) =>
 
 export const createTestInstructions = (messages: string[]) => {
   messages.forEach((m, i) => log(`${i + 1} - ${m}`));
-
-  return () => log(messages.shift());
 };

source/common/ipc/api.ts

@@ -1,4 +1,3 @@
-import { BridgeInfo, Device as TrezorDevice, UdevInfo } from 'trezor-connect';
 import type {
   BugReportRequestHttpOptions,
   BugReportRequestPayload,
@@ -62,6 +61,9 @@ import type {
   TrezorSignTransactionRequest,
   TrezorSignTransactionResponse,
   HardwareWalletConnectionRequest,
+  LedgerDevicePayload,
+  TrezorDevicePayload,
+  TrezorDeviceErrorPayload,
 } from '../types/hardware-wallets.types';
 
 /**
@@ -465,37 +467,6 @@ export type GetBlockSyncProgressMainResponse = {
  * Channels for connecting / interacting with Hardware Wallet devices
  */
 
-export type LedgerDevicePayload = {
-  disconnected: boolean;
-  deviceType: 'ledger';
-  deviceId: string | null;
-  deviceModel: string;
-  deviceName: string;
-  path: string;
-  product: string;
-};
-
-export type TrezorDevicePayload = {
-  disconnected: boolean;
-  deviceId: string;
-  deviceType: 'trezor';
-  deviceModel: TrezorDevice;
-  // e.g. "1" or "T"
-  deviceName: string;
-  path: string;
-  eventType: string;
-};
-
-export type TrezorDeviceErrorPayload = {
-  error?: {
-    payload: {
-      error: string;
-      bridge?: BridgeInfo;
-      udev?: UdevInfo;
-    };
-  };
-};
-
 export const GET_HARDWARE_WALLET_TRANSPORT_CHANNEL =
   'GET_HARDWARE_WALLET_TRANSPORT_CHANNEL';
 export type getHardwareWalletTransportRendererRequest = HardwareWalletTransportDeviceRequest;

source/common/types/hardware-wallets.types.ts

@@ -1,3 +1,5 @@
+import { BridgeInfo, Device as TrezorDevice, UdevInfo } from 'trezor-connect';
+
 export type BIP32Path = Array<number>;
 export type LedgerModel = 'nanoS' | 'nanoX';
 export type TrezorModel = '1' | 'T';
@@ -31,13 +33,10 @@ export const DeviceModels: {
   TREZOR_ONE: '1',
   TREZOR_T: 'T',
 };
-export const DeviceTypes: {
-  LEDGER: DeviceType;
-  TREZOR: DeviceType;
-} = {
-  LEDGER: 'ledger',
-  TREZOR: 'trezor',
-};
+export enum DeviceTypes {
+  LEDGER = 'ledger',
+  TREZOR = 'trezor',
+}
 export const DeviceEvents: {
   CONNECT: DeviceEvent;
   CONNECT_UNACQUIRED: DeviceEvent;
@@ -296,6 +295,42 @@ export type TrezorSignTransactionResponse = {
   success: boolean;
   payload: TrezorSerializedTxPayload | TrezorRawTxPayload;
 };
+
+export type LedgerDevicePayload = {
+  disconnected: boolean;
+  deviceType: 'ledger';
+  deviceId: string | null;
+  deviceModel: string;
+  deviceName: string;
+  path: string;
+  product: string;
+};
+
+export type TrezorDevicePayload = {
+  disconnected: boolean;
+  deviceId: string;
+  deviceType: 'trezor';
+  deviceModel: TrezorDevice;
+  // e.g. "1" or "T"
+  deviceName: string;
+  path: string;
+  eventType: string;
+};
+
+export type TrezorDeviceErrorPayload = {
+  deviceType: 'trezor';
+  error?: {
+    payload: {
+      error: string;
+      bridge?: BridgeInfo;
+      udev?: UdevInfo;
+      code?: string;
+    };
+  };
+};
+
+// FIXME: This should be LedgerDevicePayload | TrezorDevicePayload | TrezorDeviceErrorPayload
+// Changing so will result in a huge refactoring on HardwareWalletsStore._changeHardwareWalletConnectionStatus
 export type HardwareWalletConnectionRequest = {
   disconnected: boolean;
   deviceType: DeviceType;

source/main/ipc/getHardwareWalletChannel.ts

@@ -188,6 +188,7 @@ export const handleHardwareWalletRequests = async (
         // Send Transport error to Renderer
         getHardwareWalletConnectionChannel.send(
           {
+            deviceType: 'trezor',
             error: {
               payload: event.payload,
             },
@@ -381,7 +382,6 @@ export const handleHardwareWalletRequests = async (
             deviceName: productName,
             // e.g. Ledger Nano S
             path: lastConnectedPath || devicePath,
-            firmwareVersion: null,
           };
 
           logger.info(

source/main/utils/logging.ts

@@ -34,7 +34,7 @@ const logToLevel = (level: string) => (
   });
 
 export const logger: Logger = {
-  debug: logToLevel('info'),
+  debug: logToLevel('debug'),
   info: logToLevel('info'),
   error: logToLevel('error'),
   warn: logToLevel('warn'),