@exodus/hw-ledger 2.3.1 → 2.4.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.4.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@2.3.1...@exodus/hw-ledger@2.4.0) (2024-03-06)
+
+### Features
+
+- add bluetooth support ([#5998](https://github.com/ExodusMovement/exodus-hydra/issues/5998)) ([6160b9e](https://github.com/ExodusMovement/exodus-hydra/commit/6160b9eec796afe0109699b6e1c3291fbaeeede1))
+
 ## [2.3.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@2.3.0...@exodus/hw-ledger@2.3.1) (2024-02-13)
 
 ### Bug Fixes

package/lib/index.d.ts

@@ -1,4 +1,5 @@
-declare const hardwareWalletLedger: () => {
+import type { HwLedgerConfig } from './module/types';
+declare const hardwareWalletLedger: ({ bluetoothScannerTimeout, }?: Partial<HwLedgerConfig>) => {
     id: string;
     definitions: {
         definition: {
@@ -7,6 +8,9 @@ declare const hardwareWalletLedger: () => {
             factory: (deps: import("./module").Dependencies) => import("./module").LedgerDiscovery;
             dependencies: string[];
         };
+        config: {
+            bluetoothScannerTimeout: number;
+        };
     }[];
 };
 export default hardwareWalletLedger;

package/lib/index.js

@@ -1,10 +1,11 @@
 import ledgerDiscoveryDefinition from './module';
-const hardwareWalletLedger = () => {
+const hardwareWalletLedger = ({ bluetoothScannerTimeout = 10000, } = {}) => {
     return {
         id: 'hardwareWalletLedger',
         definitions: [
             {
                 definition: ledgerDiscoveryDefinition,
+                config: { bluetoothScannerTimeout },
             },
         ],
     };

package/lib/module/discovery.d.ts

@@ -1,8 +1,9 @@
 import ExodusModule from '@exodus/module';
 import { Logger } from '../shared/types';
 import type { HardwareWalletDescriptor, HardwareWalletDiscovery } from '@exodus/hw-common';
-import type { TransportFactory } from './types';
+import type { TransportFactory, HwLedgerConfig } from './types';
 export type Dependencies = {
+    config: HwLedgerConfig;
     logger: Logger;
     transportsFactories: {
         usb: TransportFactory;
@@ -12,7 +13,9 @@ export type Dependencies = {
 };
 export declare class LedgerDiscovery extends ExodusModule implements HardwareWalletDiscovery {
     #private;
-    constructor({ logger, transportsFactories }: Dependencies);
+    constructor({ config, logger, transportsFactories }: Dependencies);
+    scan: () => Promise<void>;
+    stopScan: (clearDevices?: boolean) => void;
     list: () => Promise<HardwareWalletDescriptor[]>;
     getFirstDevice: () => Promise<import("@exodus/hw-common").HardwareWalletDevice<import("@exodus/hw-common").Message>>;
 }

package/lib/module/discovery.js

@@ -5,7 +5,10 @@ import { NoDeviceFoundError, UnknownTransportError } from './errors';
 const MODULE_ID = 'ledgerDiscovery';
 export class LedgerDiscovery extends ExodusModule {
     #transportsFactories;
-    constructor({ logger, transportsFactories }) {
+    #scannerTimeout;
+    #scannerBluetooth;
+    #discoveredBluetoothDevices = Object.create(null);
+    constructor({ config, logger, transportsFactories }) {
         super({ name: MODULE_ID, logger });
         if (!(typeof transportsFactories === 'object' &&
             Object.keys(transportsFactories).length > 0 &&
@@ -14,14 +17,55 @@ export class LedgerDiscovery extends ExodusModule {
                 typeof transportFactory.list === 'function' &&
                 typeof transportFactory.open === 'function')))
             throw new UnknownTransportError();
+        if (!Number.isInteger(config.bluetoothScannerTimeout)) {
+            throw new TypeError(`Invalid bluetoothScannerTimeout passed through config`);
+        }
         this.#transportsFactories = transportsFactories;
+        this.#scannerTimeout = config.bluetoothScannerTimeout;
     }
+    scan = async () => {
+        return new Promise((resolve, reject) => {
+            if (this.#transportsFactories.bluetooth) {
+                this.stopScan(true);
+                this.#scannerBluetooth = this.#transportsFactories.bluetooth.listen({
+                    next: (evnt) => {
+                        if (evnt.type === 'add') {
+                            const descriptor = evnt.descriptor;
+                            this.#discoveredBluetoothDevices[descriptor.id] = descriptor;
+                        }
+                    },
+                    error: (error) => {
+                        this._logger.error(`an error occured while scanning for bluetooth devices "${error.message}"`);
+                        this.stopScan();
+                        reject(error);
+                    },
+                    complete: () => { },
+                });
+                setTimeout(() => {
+                    this.stopScan();
+                    resolve();
+                }, this.#scannerTimeout);
+            }
+            else {
+                this._logger.error(`Attempted to perform scan without having bluetooth transport factory`);
+            }
+        });
+    };
+    stopScan = (clearDevices = false) => {
+        if (clearDevices) {
+            this.#discoveredBluetoothDevices = Object.create(null);
+        }
+        if (this.#scannerBluetooth) {
+            this.#scannerBluetooth.unsubscribe();
+            this.#scannerBluetooth = undefined;
+        }
+    };
     list = async () => {
         const descriptors = [];
         for (const [transportName, transportFactory] of Object.entries(this.#transportsFactories)) {
-            const deviceList = await transportFactory.list();
             switch (transportName) {
                 case 'usb':
+                    const deviceList = await transportFactory.list();
                     const usbDeviceList = deviceList.map((hidDevice) => ({
                         manufacturer: 'ledger',
                         transport: 'usb',
@@ -30,7 +74,12 @@ export class LedgerDiscovery extends ExodusModule {
                     descriptors.push(...usbDeviceList);
                     break;
                 case 'bluetooth':
-                    this._logger.error('bluetooth is not supported yet!');
+                    const bluetoothDeviceList = Object.values(this.#discoveredBluetoothDevices).map((bluetoothDevice) => ({
+                        manufacturer: 'ledger',
+                        transport: 'bluetooth',
+                        get: async () => new LedgerDevice({ transportFactory, descriptor: bluetoothDevice }),
+                    }));
+                    descriptors.push(...bluetoothDeviceList);
                     break;
                 case 'tcp':
                     descriptors.push({
@@ -61,5 +110,5 @@ export default {
     id: MODULE_ID,
     type: 'module',
     factory: createLedgerDiscovery,
-    dependencies: ['logger', 'transportsFactories'],
+    dependencies: ['config', 'logger', 'transportsFactories'],
 };

package/lib/module/types.d.ts

@@ -1,2 +1,5 @@
 import type Transport from '@ledgerhq/hw-transport';
 export type TransportFactory = typeof Transport;
+export type HwLedgerConfig = {
+    bluetoothScannerTimeout: number;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/hw-ledger",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "The ledger module",
   "author": "Exodus Movement Inc.",
   "repository": {
@@ -22,10 +22,10 @@
     "build": "tsc --build tsconfig.build.json",
     "build:watch": "tsc --build tsconfig.build.json && (concurrently 'tsc --build -w tsconfig.build.json')",
     "clean": "tsc --build --clean",
-    "test": "jest --testMatch='**/*.unit.test.js' --coverageDirectory coverage/unit",
+    "test": "run -T jest --testMatch='**/*.unit.test.js' --coverageDirectory coverage/unit",
     "zemu:install": "docker pull zondax/builder-zemu:speculos-745fe46f81cfc18114b94a37beaefb58a09c0fcd",
     "test:integration": "yarn zemu:install && jest --runInBand",
-    "lint": "eslint . --ignore-path ../../.gitignore",
+    "lint": "run -T eslint . --ignore-path ../../.gitignore",
     "lint:fix": "yarn lint --fix",
     "prepublishOnly": "yarn run -T build --scope @exodus/hw-ledger"
   },
@@ -60,13 +60,11 @@
     "@types/secp256k1": "^4.0.3",
     "@zondax/zemu": "^0.43.1",
     "concurrently": "^7.6.0",
-    "eslint": "^8.44.0",
     "istanbul-combine": "^0.3.0",
-    "jest": "^29.1.2",
     "jest-when": "^3.5.2",
     "tiny-secp256k1": "^2.2.3",
     "ts-jest": "^29.0.3",
     "typescript": "^4.7.3"
   },
-  "gitHead": "fac836c7ae4dbf64c3df293db1fb34b632400a02"
+  "gitHead": "f4899f51920c3103416a11db9fd9d5a8ed4af07c"
 }