@exodus/hardware-wallets 1.4.0 → 1.5.1

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.5.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hardware-wallets@1.5.0...@exodus/hardware-wallets@1.5.1) (2024-10-17)
+
+### Bug Fixes
+
+- support cancelling transaction through ui ([#10058](https://github.com/ExodusMovement/exodus-hydra/issues/10058)) ([beb7d2d](https://github.com/ExodusMovement/exodus-hydra/commit/beb7d2d1aafba17678a34febcf2458163d9182d2))
+
+## [1.5.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hardware-wallets@1.4.0...@exodus/hardware-wallets@1.5.0) (2024-10-17)
+
+### Features
+
+- add `getSelectedDevice` ([#9822](https://github.com/ExodusMovement/exodus-hydra/issues/9822)) ([2c18c22](https://github.com/ExodusMovement/exodus-hydra/commit/2c18c22d419ba9136cd8b264e946b151df438c59))
+- support adding model to wallet account ([#9936](https://github.com/ExodusMovement/exodus-hydra/issues/9936)) ([8c858f6](https://github.com/ExodusMovement/exodus-hydra/commit/8c858f6e08e41bee3261f444c3d25e8bdd385014))
+
+### Bug Fixes
+
+- unify user refused error handling ([#10052](https://github.com/ExodusMovement/exodus-hydra/issues/10052)) ([db85d10](https://github.com/ExodusMovement/exodus-hydra/commit/db85d108333630d09bad545c5ec1169b937e08fe))
+
 ## [1.4.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hardware-wallets@1.3.0...@exodus/hardware-wallets@1.4.0) (2024-10-07)
 
 ### Features

package/lib/api/index.d.ts

@@ -10,7 +10,7 @@ declare const hardwareWalletsApiDefinition: {
         hardwareWallets: {
             isDeviceConnected: () => Promise<boolean>;
             getAvailableDevices: () => Promise<{
-                model: ("blue" | "nanoS" | "nanoSP" | "nanoX" | "stax" | "europa") | ("1" | "t" | "Safe 3" | "Safe 5") | "unknown";
+                model: import("libraries/hw-common/lib/types.js").HardwareWalletDeviceModels;
                 name: string;
             }[]>;
             listUseableAssetNames: () => Promise<string[]>;

package/lib/index.d.ts

@@ -13,7 +13,7 @@ declare const hardwareWallets: () => {
                 hardwareWallets: {
                     isDeviceConnected: () => Promise<boolean>;
                     getAvailableDevices: () => Promise<{
-                        model: ("blue" | "nanoS" | "nanoSP" | "nanoX" | "stax" | "europa") | ("1" | "t" | "Safe 3" | "Safe 5") | "unknown";
+                        model: import("libraries/hw-common/lib/types.js").HardwareWalletDeviceModels;
                         name: string;
                     }[]>;
                     listUseableAssetNames: () => Promise<string[]>;

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

@@ -26,7 +26,7 @@ export declare class HardwareWallets implements HardwareSignerProvider {
     isDeviceConnected: () => Promise<boolean>;
     scanForDevices: () => Promise<void>;
     getAvailableDevices: () => Promise<{
-        model: ("blue" | "nanoS" | "nanoSP" | "nanoX" | "stax" | "europa") | ("1" | "t" | "Safe 3" | "Safe 5") | "unknown";
+        model: import("@exodus/hw-common").HardwareWalletDeviceModels;
         name: string;
     }[]>;
     canAccessAsset: ({ assetName }: CanAccessAssetParams) => Promise<boolean>;

package/lib/module/hardware-wallets.js

@@ -3,7 +3,7 @@ import { WalletAccount } from '@exodus/models';
 import Emitter from '@exodus/wild-emitter';
 import randomBytes from 'randombytes';
 import delay from 'delay';
-import { UserCancelledError } from './errors.js';
+import { NoDeviceFoundError, UserRefusedError } from '@exodus/hw-common';
 export class HardwareWallets {
     #assetsModule;
     #ledgerDiscovery;
@@ -25,26 +25,35 @@ export class HardwareWallets {
         this.#walletAccountsAtom = walletAccountsAtom;
         this.#walletAccounts = walletAccounts;
     }
+    #getSelectedDevice = async () => {
+        const descriptors = await this.#ledgerDiscovery.list();
+        if (descriptors[0]) {
+            return { device: await descriptors[0].get() };
+        }
+        throw new NoDeviceFoundError();
+    };
     #requestUserAction = async (params) => {
         const rpc = this.#userInterface.getRPC();
         return rpc.callMethod('handle-hardware-wallet', params);
     };
     #signGeneric = async ({ baseAssetName, scenario, sign }) => {
-        let needUserApproval = true;
         let attempts = 0;
         const MAX_ATTEMPTS = 50;
         while (attempts < MAX_ATTEMPTS) {
             try {
-                if (needUserApproval) {
-                    this.#requestUserAction({
-                        scenario,
-                        baseAssetName,
-                    });
-                    needUserApproval = false;
+                const approvePromise = this.#requestUserAction({
+                    scenario,
+                    baseAssetName,
+                });
+                const { device } = await this.#getSelectedDevice();
+                const runSign = async () => {
+                    await device.ensureApplicationIsOpened(baseAssetName);
+                    return sign({ device });
+                };
+                const result = await Promise.race([approvePromise, runSign()]);
+                if (typeof result === 'object' && result.tryAgain === false) {
+                    throw new UserRefusedError(false);
                 }
-                const hardwareDevice = await this.#ledgerDiscovery.getFirstDevice();
-                await hardwareDevice.ensureApplicationIsOpened(baseAssetName);
-                const result = await sign({ hardwareDevice });
                 this.#requestUserAction({ scenario: 'completed' });
                 return result;
             }
@@ -52,11 +61,10 @@ export class HardwareWallets {
                 if (error.message.includes('timeout')) {
                     break;
                 }
-                if (error.name === 'DisconnectedDeviceDuringOperation') {
-                    this.#requestUserAction({
-                        scenario,
-                        baseAssetName,
-                    });
+                else if (error.name === 'UserRefusedError') {
+                    throw error;
+                }
+                if (['DisconnectedDevice', 'DisconnectedDeviceDuringOperation'].includes(error.name)) {
                     continue;
                 }
                 try {
@@ -80,15 +88,15 @@ export class HardwareWallets {
             }
         }
         this.#requestUserAction({ scenario: 'completed' });
-        throw new UserCancelledError();
+        throw new UserRefusedError(false);
     };
     signTransaction = async ({ baseAssetName, unsignedTx, walletAccount, multisigData, }) => {
         const baseAsset = this.#assetsModule.getAsset(baseAssetName);
         const accountIndex = walletAccount.index;
-        const sign = async ({ hardwareDevice }) => {
+        const sign = async ({ device }) => {
             return baseAsset.api.signHardware({
                 unsignedTx,
-                hardwareDevice,
+                hardwareDevice: device,
                 accountIndex,
                 multisigData,
             });
@@ -97,8 +105,8 @@ export class HardwareWallets {
     };
     signMessage = async ({ assetName, derivationPath, message }) => {
         const baseAssetName = this.#assetsModule.getAsset(assetName).baseAsset.name;
-        const sign = async ({ hardwareDevice }) => {
-            return hardwareDevice.signMessage({
+        const sign = async ({ device }) => {
+            return device.signMessage({
                 assetName: baseAssetName,
                 derivationPath,
                 message,
@@ -128,12 +136,12 @@ export class HardwareWallets {
     };
     canAccessAsset = async ({ assetName }) => {
         const asset = this.#assetsModule.getAsset(assetName);
-        const device = await this.#ledgerDiscovery.getFirstDevice();
+        const { device } = await this.#getSelectedDevice();
         const useableAssetNames = new Set(await device.listUseableAssetNames());
         return useableAssetNames.has(asset.baseAsset.name);
     };
     listUseableAssetNames = async () => {
-        const device = await this.#ledgerDiscovery.getFirstDevice();
+        const { device } = await this.#getSelectedDevice();
         return device.listUseableAssetNames();
     };
     ensureApplicationIsOpened = async ({ assetName }) => {
@@ -141,8 +149,8 @@ export class HardwareWallets {
         let i = 0;
         while (i < 3) {
             try {
-                const hardwareDevice = await this.#ledgerDiscovery.getFirstDevice();
-                await hardwareDevice.ensureApplicationIsOpened(asset.baseAsset.name);
+                const { device } = await this.#getSelectedDevice();
+                await device.ensureApplicationIsOpened(asset.baseAsset.name);
             }
             catch (error) {
                 this.#logger.log(error);
@@ -166,7 +174,7 @@ export class HardwareWallets {
             chainIndex: 0,
             addressIndex,
         });
-        const device = await this.#ledgerDiscovery.getFirstDevice();
+        const { device } = await this.#getSelectedDevice();
         return device.getAddress({
             assetName,
             derivationPath,
@@ -259,7 +267,7 @@ export class HardwareWallets {
     };
     sync = async ({ accountIndex: index, isMultisig } = {}) => {
         const keysToSync = [];
-        const device = await this.#ledgerDiscovery.getFirstDevice();
+        const { device } = await this.#getSelectedDevice();
         const accountIndex = index ?? this.#walletAccounts.getNextIndex({ source: WalletAccount.LEDGER_SRC });
         const useableAssetNames = new Set(await device.listUseableAssetNames());
         for (const assetName of useableAssetNames) {
@@ -279,6 +287,7 @@ export class HardwareWallets {
         const id = randomBytes(16).toString('hex');
         this.#syncedKeysMap.set(id, {
             accountIndex,
+            model: device.descriptor.model,
             assetNames: useableAssetNames,
             keysToSync,
         });
@@ -295,11 +304,12 @@ export class HardwareWallets {
     };
     create = async ({ syncedKeysId, isMultisig }) => {
         assert(this.#syncedKeysMap.has(syncedKeysId), `no synchronized keys found for id ${syncedKeysId}`);
-        const { accountIndex } = this.#syncedKeysMap.get(syncedKeysId);
+        const { accountIndex, model } = this.#syncedKeysMap.get(syncedKeysId);
         const walletAccount = new WalletAccount({
             label: `Ledger${accountIndex === 0 ? '' : ' ' + accountIndex}`,
             icon: 'ledger',
             source: WalletAccount.LEDGER_SRC,
+            model,
             index: accountIndex,
             id: randomBytes(32).toString('hex'),
             isMultisig: !!isMultisig,

package/lib/module/interfaces.d.ts

@@ -1,5 +1,5 @@
 import type { WalletAccount } from '@exodus/models';
-import type { HardwareWalletDevice, MultisigData, SignMessageParams } from '@exodus/hw-common';
+import type { HardwareWalletDeviceModels, HardwareWalletDevice, MultisigData, SignMessageParams } from '@exodus/hw-common';
 import type KeyIdentifier from '@exodus/key-identifier';
 export interface HardwareSignerProvider {
     isDeviceConnected: () => Promise<boolean>;
@@ -59,6 +59,7 @@ export interface SyncParams {
 export type SyncedKeysId = string;
 export interface SyncedKeysData {
     accountIndex: number;
+    model: HardwareWalletDeviceModels;
     assetNames: Set<string>;
     keysToSync: KeyToSyncData[];
 }
@@ -74,8 +75,8 @@ export interface CreateParams {
     syncedKeysId: SyncedKeysId;
     isMultisig?: boolean;
 }
-export type GenericSignCallback = ({ hardwareDevice, }: {
-    hardwareDevice: HardwareWalletDevice;
+export type GenericSignCallback = ({ device }: {
+    device: HardwareWalletDevice;
 }) => Promise<any>;
 export interface GenericSignParams {
     baseAssetName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/hardware-wallets",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "An Exodus SDK feature that provides a high level abstraction for interacting with hardware wallet devices",
   "author": "Exodus Movement, Inc.",
   "repository": {
@@ -24,10 +24,11 @@
     "clean": "run -T tsc --build --clean",
     "lint": "run -T eslint .",
     "lint:fix": "yarn lint --fix",
-    "test": "run -T jest",
+    "test": "run -T exodus-test --jest --esbuild",
     "prepublishOnly": "yarn run -T build --scope @exodus/hardware-wallets"
   },
   "dependencies": {
+    "@exodus/hw-common": "^3.0.0",
     "@exodus/models": "^12.0.1",
     "@exodus/wild-emitter": "^1.1.0",
     "delay": "^5.0.0",
@@ -37,11 +38,11 @@
   "devDependencies": {
     "@exodus/atoms": "^9.0.0",
     "@exodus/dependency-types": "^2.1.0",
-    "@exodus/hw-common": "^2.5.0",
     "@exodus/key-identifier": "^1.3.0",
     "@exodus/logger": "^1.2.2",
     "@exodus/public-key-provider": "^3.0.0",
-    "@types/randombytes": "^2.0.3"
+    "@types/randombytes": "^2.0.3",
+    "p-defer": "^4.0.1"
   },
-  "gitHead": "c60b8443608e3f1d4673fff692f4aa03b816badd"
+  "gitHead": "c74a9968861467c805398c25b4017985e976ba31"
 }

package/lib/module/errors.d.ts

@@ -1,4 +0,0 @@
-export declare class UserCancelledError extends Error {
-    name: string;
-    constructor();
-}

package/lib/module/errors.js

@@ -1,6 +0,0 @@
-export class UserCancelledError extends Error {
-    name = 'UserCancelledError';
-    constructor() {
-        super('User cancelled action');
-    }
-}