@exodus/hardware-wallets 1.0.0 → 1.1.1

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [1.1.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hardware-wallets@1.1.0...@exodus/hardware-wallets@1.1.1) (2024-08-12)
+
+### Bug Fixes
+
+- resolve circular dependency temporarily ([#8316](https://github.com/ExodusMovement/exodus-hydra/issues/8316)) ([c4e7570](https://github.com/ExodusMovement/exodus-hydra/commit/c4e75706c5f1e4e4be63d6c46dcaa5f30f71d124))
+
+## [1.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hardware-wallets@1.0.0...@exodus/hardware-wallets@1.1.0) (2024-08-08)
+
+### Features
+
+- add scan device support ([#8249](https://github.com/ExodusMovement/exodus-hydra/issues/8249)) ([e6393bf](https://github.com/ExodusMovement/exodus-hydra/commit/e6393bf91235a9b0d719097d855e1808efc48a33))

package/lib/api/index.d.ts

@@ -2,12 +2,15 @@ import type { HardwareWallets } from '../module/hardware-wallets.js';
 declare const hardwareWalletsApiDefinition: {
     readonly id: "hardwareWalletsApi";
     readonly type: "api";
-    readonly factory: ({ hardwareWallets }: {
+    readonly factory: ({ hardwareWallets, restoreProgressTracker, txLogMonitors, }: {
         hardwareWallets: HardwareWallets;
+        txLogMonitors: any;
+        restoreProgressTracker: any;
     }) => {
         hardwareWallets: {
             isDeviceConnected: () => Promise<boolean>;
             listUseableAssetNames: () => Promise<string[]>;
+            scanForDevices: () => Promise<void>;
             canAccessAsset: ({ assetName }: import("../module/interfaces.js").CanAccessAssetParams) => Promise<boolean>;
             ensureApplicationIsOpened: ({ assetName }: import("../module/interfaces.js").EnsureApplicationIsOpenedParams) => Promise<void>;
             scan: ({ assetName, accountIndexes, addressLimit, addressOffset, }: import("../module/interfaces.js").ScanParams) => Promise<import("../module/interfaces.js").ScanResult>;
@@ -16,6 +19,6 @@ declare const hardwareWalletsApiDefinition: {
             create: ({ syncedKeysId }: import("../module/interfaces.js").CreateParams) => Promise<void>;
         };
     };
-    readonly dependencies: readonly ["hardwareWallets"];
+    readonly dependencies: readonly ["hardwareWallets", "txLogMonitors", "restoreProgressTracker"];
 };
 export default hardwareWalletsApiDefinition;

package/lib/api/index.js

@@ -1,8 +1,26 @@
-const createHardwareWalletsApi = ({ hardwareWallets }) => {
+const createHardwareWalletsApi = ({ hardwareWallets, restoreProgressTracker, txLogMonitors, }) => {
+    hardwareWallets.events.subscribe(({ type, payload }) => {
+        if (type !== 'syncAssets')
+            return;
+        const { assetNames } = payload;
+        for (const assetName of assetNames) {
+            if (assetName === 'ethereum' || assetName === 'matic') {
+                restoreProgressTracker.restoreAsset('ethereum');
+                restoreProgressTracker.restoreAsset('matic');
+                txLogMonitors.update({ assetName: 'ethereum', refresh: true });
+                txLogMonitors.update({ assetName: 'matic', refresh: true });
+            }
+            else {
+                restoreProgressTracker.restoreAsset(assetName);
+                txLogMonitors.update({ assetName, refresh: true });
+            }
+        }
+    });
     return {
         hardwareWallets: {
             isDeviceConnected: hardwareWallets.isDeviceConnected,
             listUseableAssetNames: hardwareWallets.listUseableAssetNames,
+            scanForDevices: hardwareWallets.scanForDevices,
             canAccessAsset: hardwareWallets.canAccessAsset,
             ensureApplicationIsOpened: hardwareWallets.ensureApplicationIsOpened,
             scan: hardwareWallets.scan,
@@ -16,6 +34,6 @@ const hardwareWalletsApiDefinition = {
     id: 'hardwareWalletsApi',
     type: 'api',
     factory: createHardwareWalletsApi,
-    dependencies: ['hardwareWallets'],
+    dependencies: ['hardwareWallets', 'txLogMonitors', 'restoreProgressTracker'],
 };
 export default hardwareWalletsApiDefinition;

package/lib/index.d.ts

@@ -4,12 +4,15 @@ declare const hardwareWallets: () => {
         readonly definition: {
             readonly id: "hardwareWalletsApi";
             readonly type: "api";
-            readonly factory: ({ hardwareWallets }: {
+            readonly factory: ({ hardwareWallets, restoreProgressTracker, txLogMonitors, }: {
                 hardwareWallets: import("./module/hardware-wallets.js").HardwareWallets;
+                txLogMonitors: any;
+                restoreProgressTracker: any;
             }) => {
                 hardwareWallets: {
                     isDeviceConnected: () => Promise<boolean>;
                     listUseableAssetNames: () => Promise<string[]>;
+                    scanForDevices: () => Promise<void>;
                     canAccessAsset: ({ assetName }: import("./module/interfaces.js").CanAccessAssetParams) => Promise<boolean>;
                     ensureApplicationIsOpened: ({ assetName }: import("./module/interfaces.js").EnsureApplicationIsOpenedParams) => Promise<void>;
                     scan: ({ assetName, accountIndexes, addressLimit, addressOffset, }: import("./module/interfaces.js").ScanParams) => Promise<import("./module/interfaces.js").ScanResult>;
@@ -18,14 +21,14 @@ declare const hardwareWallets: () => {
                     create: ({ syncedKeysId }: import("./module/interfaces.js").CreateParams) => Promise<void>;
                 };
             };
-            readonly dependencies: readonly ["hardwareWallets"];
+            readonly dependencies: readonly ["hardwareWallets", "txLogMonitors", "restoreProgressTracker"];
         };
     }, {
         readonly definition: {
             readonly id: "hardwareWallets";
             readonly type: "module";
             readonly factory: (opts: import("./module/hardware-wallets.js").Dependencies) => import("./module/hardware-wallets.js").HardwareWallets;
-            readonly dependencies: readonly ["assetsModule", "logger", "ledgerDiscovery", "userInterface", "publicKeyStore", "wallet", "walletAccountsAtom", "walletAccounts", "txLogMonitors", "restoreProgressTracker"];
+            readonly dependencies: readonly ["assetsModule", "logger", "ledgerDiscovery", "userInterface", "publicKeyStore", "wallet", "walletAccountsAtom", "walletAccounts"];
         };
     }];
 };

package/lib/module/hardware-wallets.d.ts

@@ -1,4 +1,5 @@
 import { WalletAccount } from '@exodus/models';
+import Emitter from '@exodus/wild-emitter';
 import type { HardwareSignerProvider, CanAccessAssetParams, CreateParams, StoreSyncedKeysParams, ScanParams, SyncParams, EnsureApplicationIsOpenedParams, SignTransactionParams, ScanResult, SyncedKeysId } from './interfaces.js';
 import type { HardwareWalletDiscovery, SignMessageParams } from '@exodus/hw-common';
 import type { Atom } from '@exodus/atoms';
@@ -18,10 +19,12 @@ export type Dependencies = {
 };
 export declare class HardwareWallets implements HardwareSignerProvider {
     #private;
-    constructor({ assetsModule, ledgerDiscovery, logger, userInterface, publicKeyStore, wallet, walletAccountsAtom, walletAccounts, txLogMonitors, restoreProgressTracker, }: Dependencies);
+    readonly events: Emitter<string, any>;
+    constructor({ assetsModule, ledgerDiscovery, logger, userInterface, publicKeyStore, wallet, walletAccountsAtom, walletAccounts, }: Dependencies);
     signTransaction: ({ baseAssetName, unsignedTx, walletAccount }: SignTransactionParams) => Promise<any>;
     signMessage: ({ assetName, derivationPath, message }: SignMessageParams) => Promise<any>;
     isDeviceConnected: () => Promise<boolean>;
+    scanForDevices: () => Promise<void>;
     canAccessAsset: ({ assetName }: CanAccessAssetParams) => Promise<boolean>;
     listUseableAssetNames: () => Promise<string[]>;
     ensureApplicationIsOpened: ({ assetName }: EnsureApplicationIsOpenedParams) => Promise<void>;
@@ -34,6 +37,6 @@ declare const hardwareWalletsModuleDefinition: {
     readonly id: "hardwareWallets";
     readonly type: "module";
     readonly factory: (opts: Dependencies) => HardwareWallets;
-    readonly dependencies: readonly ["assetsModule", "logger", "ledgerDiscovery", "userInterface", "publicKeyStore", "wallet", "walletAccountsAtom", "walletAccounts", "txLogMonitors", "restoreProgressTracker"];
+    readonly dependencies: readonly ["assetsModule", "logger", "ledgerDiscovery", "userInterface", "publicKeyStore", "wallet", "walletAccountsAtom", "walletAccounts"];
 };
 export default hardwareWalletsModuleDefinition;

package/lib/module/hardware-wallets.js

@@ -1,5 +1,6 @@
 import assert from 'minimalistic-assert';
 import { WalletAccount } from '@exodus/models';
+import Emitter from '@exodus/wild-emitter';
 import randomBytes from 'randombytes';
 import delay from 'delay';
 import { UserCancelledError } from './errors.js';
@@ -12,10 +13,9 @@ export class HardwareWallets {
     #wallet;
     #walletAccountsAtom;
     #walletAccounts;
-    #txLogMonitors;
-    #restoreProgressTracker;
     #syncedKeysMap = new Map();
-    constructor({ assetsModule, ledgerDiscovery, logger, userInterface, publicKeyStore, wallet, walletAccountsAtom, walletAccounts, txLogMonitors, restoreProgressTracker, }) {
+    events = new Emitter();
+    constructor({ assetsModule, ledgerDiscovery, logger, userInterface, publicKeyStore, wallet, walletAccountsAtom, walletAccounts, }) {
         this.#assetsModule = assetsModule;
         this.#ledgerDiscovery = ledgerDiscovery;
         this.#logger = logger;
@@ -24,8 +24,6 @@ export class HardwareWallets {
         this.#wallet = wallet;
         this.#walletAccountsAtom = walletAccountsAtom;
         this.#walletAccounts = walletAccounts;
-        this.#txLogMonitors = txLogMonitors;
-        this.#restoreProgressTracker = restoreProgressTracker;
     }
     #requestUserAction = async (params) => {
         const rpc = this.#userInterface.getRPC();
@@ -116,6 +114,10 @@ export class HardwareWallets {
             return false;
         }
     };
+    scanForDevices = async () => {
+        this.#ledgerDiscovery.stopScan(true);
+        return this.#ledgerDiscovery.scan();
+    };
     canAccessAsset = async ({ assetName }) => {
         const asset = this.#assetsModule.getAsset(assetName);
         const device = await this.#ledgerDiscovery.getFirstDevice();
@@ -276,18 +278,7 @@ export class HardwareWallets {
             const { xpub, publicKey } = keys;
             await this.#publicKeyStore.add({ walletAccountName, keyIdentifier, xpub, publicKey });
         }
-        for (const assetName of assetNames) {
-            if (assetName === 'ethereum' || assetName === 'matic') {
-                this.#restoreProgressTracker.restoreAsset('ethereum');
-                this.#restoreProgressTracker.restoreAsset('matic');
-                this.#txLogMonitors.update({ assetName: 'ethereum', refresh: true });
-                this.#txLogMonitors.update({ assetName: 'matic', refresh: true });
-            }
-            else {
-                this.#restoreProgressTracker.restoreAsset(assetName);
-                this.#txLogMonitors.update({ assetName, refresh: true });
-            }
-        }
+        this.events.emit('syncAssets', { assetNames });
     };
     create = async ({ syncedKeysId }) => {
         assert(this.#syncedKeysMap.has(syncedKeysId), `no synchronized keys found for id ${syncedKeysId}`);
@@ -319,8 +310,6 @@ const hardwareWalletsModuleDefinition = {
         'wallet',
         'walletAccountsAtom',
         'walletAccounts',
-        'txLogMonitors',
-        'restoreProgressTracker',
     ],
 };
 export default hardwareWalletsModuleDefinition;

package/lib/module/interfaces.d.ts

@@ -3,6 +3,7 @@ import type { HardwareWalletDevice, SignMessageParams } from '@exodus/hw-common'
 import type KeyIdentifier from '@exodus/key-identifier';
 export interface HardwareSignerProvider {
     isDeviceConnected: () => Promise<boolean>;
+    scanForDevices: () => Promise<void>;
     canAccessAsset: ({ assetName }: CanAccessAssetParams) => Promise<boolean>;
     listUseableAssetNames: () => Promise<string[]>;
     ensureApplicationIsOpened: ({ assetName }: EnsureApplicationIsOpenedParams) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/hardware-wallets",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "An Exodus SDK feature that provides a high level abstraction for interacting with hardware wallet devices",
   "author": "Exodus Movement, Inc.",
   "repository": {
@@ -29,15 +29,16 @@
   },
   "dependencies": {
     "@exodus/models": "^11.7.0",
+    "@exodus/wild-emitter": "^1.1.0",
     "delay": "^5.0.0",
     "minimalistic-assert": "^1.0.1",
     "randombytes": "^2.1.0"
   },
   "devDependencies": {
     "@exodus/atoms": "^8.0.0",
-    "@exodus/hw-common": "^2.2.1",
+    "@exodus/hw-common": "^2.3.0",
     "@exodus/logger": "^1.2.2",
     "@exodus/public-key-store": "^1.2.2"
   },
-  "gitHead": "73cd1e81c69bd252bf1bdef0862223b9660a7fdf"
+  "gitHead": "7b677da738335fdc10685fdfab0084f60d21a828"
 }