@exodus/hardware-wallets 1.2.1 → 1.3.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.
 
+## [1.3.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hardware-wallets@1.2.1...@exodus/hardware-wallets@1.3.0) (2024-09-19)
+
+### Features
+
+- add multisig support to hardware-wallets ([#9312](https://github.com/ExodusMovement/exodus-hydra/issues/9312)) ([62afbf1](https://github.com/ExodusMovement/exodus-hydra/commit/62afbf1fa0295e3267b807c38a756a9169fdd816))
+
 ## [1.2.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hardware-wallets@1.2.0...@exodus/hardware-wallets@1.2.1) (2024-09-13)
 
 ### Bug Fixes

package/lib/api/index.d.ts

@@ -18,9 +18,9 @@ declare const hardwareWalletsApiDefinition: {
             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>;
-            sync: ({ accountIndex }: import("../module/interfaces.js").SyncParams) => Promise<import("../module/interfaces.js").SyncedKeysId>;
+            sync: ({ accountIndex: index, isMultisig }?: import("../module/interfaces.js").SyncParams) => Promise<import("../module/interfaces.js").SyncedKeysId>;
             addPublicKeysToWalletAccount: ({ walletAccountName, syncedKeysId, }: import("../module/interfaces.js").StoreSyncedKeysParams) => Promise<void>;
-            create: ({ syncedKeysId }: import("../module/interfaces.js").CreateParams) => Promise<void>;
+            create: ({ syncedKeysId, isMultisig }: import("../module/interfaces.js").CreateParams) => Promise<import("@exodus/models").WalletAccount>;
         };
     };
     readonly dependencies: readonly ["hardwareWallets", "txLogMonitors", "restoreProgressTracker"];

package/lib/index.d.ts

@@ -1,3 +1,4 @@
+import hardwareWalletsApiDefinition from './api/index.js';
 declare const hardwareWallets: () => {
     readonly id: "hardwareWallets";
     readonly definitions: readonly [{
@@ -20,9 +21,9 @@ declare const hardwareWallets: () => {
                     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>;
-                    sync: ({ accountIndex }: import("./module/interfaces.js").SyncParams) => Promise<import("./module/interfaces.js").SyncedKeysId>;
+                    sync: ({ accountIndex: index, isMultisig }?: import("./module/interfaces.js").SyncParams) => Promise<import("./module/interfaces.js").SyncedKeysId>;
                     addPublicKeysToWalletAccount: ({ walletAccountName, syncedKeysId, }: import("./module/interfaces.js").StoreSyncedKeysParams) => Promise<void>;
-                    create: ({ syncedKeysId }: import("./module/interfaces.js").CreateParams) => Promise<void>;
+                    create: ({ syncedKeysId, isMultisig }: import("./module/interfaces.js").CreateParams) => Promise<import("@exodus/models").WalletAccount>;
                 };
             };
             readonly dependencies: readonly ["hardwareWallets", "txLogMonitors", "restoreProgressTracker"];
@@ -36,4 +37,5 @@ declare const hardwareWallets: () => {
         };
     }];
 };
+export type HardwareWalletsApi = ReturnType<typeof hardwareWalletsApiDefinition.factory>;
 export default hardwareWallets;

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

@@ -1,6 +1,6 @@
 import { WalletAccount } from '@exodus/models';
 import Emitter from '@exodus/wild-emitter';
-import type { HardwareSignerProvider, CanAccessAssetParams, CreateParams, StoreSyncedKeysParams, ScanParams, SyncParams, EnsureApplicationIsOpenedParams, SignTransactionParams, ScanResult, SyncedKeysId, RequireDeviceForParams } from './interfaces.js';
+import type { HardwareSignerProvider, CanAccessAssetParams, CreateParams, StoreSyncedKeysParams, ScanParams, SyncParams, EnsureApplicationIsOpenedParams, SignTransactionParams, ScanResult, SyncedKeysId, GetAddressParams, RequireDeviceForParams } from './interfaces.js';
 import type { HardwareWalletDiscovery, SignMessageParams } from '@exodus/hw-common';
 import type { Atom } from '@exodus/atoms';
 import type { IPublicKeyStore } from '@exodus/public-key-store';
@@ -21,7 +21,7 @@ export declare class HardwareWallets implements HardwareSignerProvider {
     #private;
     readonly events: Emitter<string, any>;
     constructor({ assetsModule, ledgerDiscovery, logger, userInterface, publicKeyStore, wallet, walletAccountsAtom, walletAccounts, }: Dependencies);
-    signTransaction: ({ baseAssetName, unsignedTx, walletAccount }: SignTransactionParams) => Promise<any>;
+    signTransaction: ({ baseAssetName, unsignedTx, walletAccount, multisigData, }: SignTransactionParams) => Promise<any>;
     signMessage: ({ assetName, derivationPath, message }: SignMessageParams) => Promise<any>;
     isDeviceConnected: () => Promise<boolean>;
     scanForDevices: () => Promise<void>;
@@ -32,12 +32,13 @@ export declare class HardwareWallets implements HardwareSignerProvider {
     canAccessAsset: ({ assetName }: CanAccessAssetParams) => Promise<boolean>;
     listUseableAssetNames: () => Promise<string[]>;
     ensureApplicationIsOpened: ({ assetName }: EnsureApplicationIsOpenedParams) => Promise<void>;
+    getAddress: ({ assetName, accountIndex, addressIndex, multisigData, displayOnDevice, }: GetAddressParams) => Promise<string>;
     scan: ({ assetName, accountIndexes, addressLimit, addressOffset, }: ScanParams) => Promise<ScanResult>;
-    sync: ({ accountIndex }: SyncParams) => Promise<SyncedKeysId>;
+    sync: ({ accountIndex: index, isMultisig }?: SyncParams) => Promise<SyncedKeysId>;
     addPublicKeysToWalletAccount: ({ walletAccountName, syncedKeysId, }: StoreSyncedKeysParams) => Promise<void>;
-    create: ({ syncedKeysId }: CreateParams) => Promise<void>;
+    create: ({ syncedKeysId, isMultisig }: CreateParams) => Promise<WalletAccount>;
     requireDeviceFor: ({ walletAccount }: RequireDeviceForParams) => Promise<{
-        signTransaction: ({ baseAssetName, unsignedTx, walletAccount }: SignTransactionParams) => Promise<any>;
+        signTransaction: ({ baseAssetName, unsignedTx, walletAccount, multisigData, }: SignTransactionParams) => Promise<any>;
         signMessage: ({ assetName, derivationPath, message }: SignMessageParams) => Promise<any>;
     }>;
 }

package/lib/module/hardware-wallets.js

@@ -82,7 +82,7 @@ export class HardwareWallets {
         this.#requestUserAction({ scenario: 'completed' });
         throw new UserCancelledError();
     };
-    signTransaction = async ({ baseAssetName, unsignedTx, walletAccount }) => {
+    signTransaction = async ({ baseAssetName, unsignedTx, walletAccount, multisigData, }) => {
         const baseAsset = this.#assetsModule.getAsset(baseAssetName);
         const accountIndex = walletAccount.index;
         const sign = async ({ hardwareDevice }) => {
@@ -90,6 +90,7 @@ export class HardwareWallets {
                 unsignedTx,
                 hardwareDevice,
                 accountIndex,
+                multisigData,
             });
         };
         return this.#signGeneric({ baseAssetName, scenario: 'signTransaction', sign });
@@ -152,10 +153,11 @@ export class HardwareWallets {
             }
         }
     };
-    #getAddress = async ({ assetName, accountIndex, addressIndex }) => {
+    getAddress = async ({ assetName, accountIndex, addressIndex, multisigData, displayOnDevice, }) => {
         const asset = this.#assetsModule.getAsset(assetName);
         const supportedPurposes = asset.baseAsset.api.getSupportedPurposes({
             compatibilityMode: 'ledger',
+            isMultisig: !!multisigData,
         });
         const { derivationPath } = asset.baseAsset.api.getKeyIdentifier({
             compatibilityMode: 'ledger',
@@ -168,6 +170,8 @@ export class HardwareWallets {
         return device.getAddress({
             assetName,
             derivationPath,
+            multisigData,
+            displayOnDevice,
         });
     };
     #getXPUB = async ({ device, baseAsset, purpose, accountIndex, }) => {
@@ -220,7 +224,7 @@ export class HardwareWallets {
         const startIndex = offsetBy;
         const addresses = [];
         for (let idx = startIndex; idx < startIndex + n; idx++) {
-            addresses.push(await this.#getAddress({ assetName, accountIndex, addressIndex: idx }));
+            addresses.push(await this.getAddress({ assetName, accountIndex, addressIndex: idx }));
         }
         const fetchedBalances = await Promise.all(addresses.map(async (address) => ({
             address,
@@ -253,9 +257,10 @@ export class HardwareWallets {
         }
         return accounts;
     };
-    sync = async ({ accountIndex }) => {
+    sync = async ({ accountIndex: index, isMultisig } = {}) => {
         const keysToSync = [];
         const device = await this.#ledgerDiscovery.getFirstDevice();
+        const accountIndex = index ?? this.#walletAccounts.getNextIndex({ source: WalletAccount.LEDGER_SRC });
         const useableAssetNames = new Set(await device.listUseableAssetNames());
         for (const assetName of useableAssetNames) {
             const asset = this.#assetsModule.getAsset(assetName);
@@ -263,6 +268,7 @@ export class HardwareWallets {
             const baseAsset = asset.baseAsset;
             const supportedPurposes = baseAsset.api.getSupportedPurposes({
                 compatibilityMode: 'ledger',
+                isMultisig,
             });
             for (const purpose of supportedPurposes) {
                 const { keyIdentifier, xpub, publicKey, } = (await this.#getXPUB({ device, baseAsset, purpose, accountIndex })) ||
@@ -287,7 +293,7 @@ export class HardwareWallets {
         }
         this.events.emit('syncAssets', { assetNames });
     };
-    create = async ({ syncedKeysId }) => {
+    create = async ({ syncedKeysId, isMultisig }) => {
         assert(this.#syncedKeysMap.has(syncedKeysId), `no synchronized keys found for id ${syncedKeysId}`);
         const { accountIndex } = this.#syncedKeysMap.get(syncedKeysId);
         const walletAccount = new WalletAccount({
@@ -296,11 +302,13 @@ export class HardwareWallets {
             source: WalletAccount.LEDGER_SRC,
             index: accountIndex,
             id: randomBytes(32).toString('hex'),
+            isMultisig: !!isMultisig,
         });
         const walletAccountName = walletAccount.toString();
         await this.#walletAccounts.create(walletAccount);
         await this.#walletAccounts.setActive(walletAccountName);
         await this.addPublicKeysToWalletAccount({ walletAccountName, syncedKeysId });
+        return walletAccount;
     };
     requireDeviceFor = async ({ walletAccount }) => {
         return {

package/lib/module/interfaces.d.ts

@@ -1,5 +1,5 @@
 import type { WalletAccount } from '@exodus/models';
-import type { HardwareWalletDevice, SignMessageParams } from '@exodus/hw-common';
+import type { HardwareWalletDevice, MultisigData, SignMessageParams } from '@exodus/hw-common';
 import type KeyIdentifier from '@exodus/key-identifier';
 export interface HardwareSignerProvider {
     isDeviceConnected: () => Promise<boolean>;
@@ -10,7 +10,7 @@ export interface HardwareSignerProvider {
     scan: ({ assetName, accountIndexes, addressOffset }: ScanParams) => Promise<ScanResult>;
     sync: ({ accountIndex }: SyncParams) => Promise<SyncedKeysId>;
     addPublicKeysToWalletAccount: ({ walletAccountName, syncedKeysId, }: StoreSyncedKeysParams) => Promise<void>;
-    create: ({ syncedKeysId }: CreateParams) => Promise<void>;
+    create: ({ syncedKeysId, isMultisig }: CreateParams) => Promise<WalletAccount>;
     signTransaction: ({ baseAssetName, unsignedTx, walletAccount, }: SignTransactionParams) => Promise<any>;
     signMessage: ({ assetName, derivationPath, message }: SignMessageParams) => Promise<any>;
 }
@@ -53,7 +53,8 @@ export type ScannedAccount = {
 };
 export type ScanResult = ScannedAccount[];
 export interface SyncParams {
-    accountIndex: number;
+    accountIndex?: number;
+    isMultisig?: boolean;
 }
 export type SyncedKeysId = string;
 export interface SyncedKeysData {
@@ -71,6 +72,7 @@ export interface StoreSyncedKeysParams {
 }
 export interface CreateParams {
     syncedKeysId: SyncedKeysId;
+    isMultisig?: boolean;
 }
 export type GenericSignCallback = ({ hardwareDevice, }: {
     hardwareDevice: HardwareWalletDevice;
@@ -84,6 +86,7 @@ export interface SignTransactionParams {
     baseAssetName: string;
     unsignedTx: UnsignedTransaction;
     walletAccount: WalletAccount;
+    multisigData?: MultisigData;
 }
 export interface UnsignedTransaction {
     txData: any;
@@ -93,6 +96,8 @@ export interface GetAddressParams {
     assetName: string;
     accountIndex: number;
     addressIndex: number;
+    multisigData?: MultisigData;
+    displayOnDevice?: boolean;
 }
 export interface GetXPUBParams {
     device: HardwareWalletDevice;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/hardware-wallets",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "An Exodus SDK feature that provides a high level abstraction for interacting with hardware wallet devices",
   "author": "Exodus Movement, Inc.",
   "repository": {
@@ -41,5 +41,5 @@
     "@exodus/public-key-store": "^1.2.2",
     "@types/randombytes": "^2.0.3"
   },
-  "gitHead": "4b5ea436184efe7a8c6017705893436905cd8c2f"
+  "gitHead": "758ea1b22f91994c5982c19071ff1f80f63e48be"
 }