@exodus/hw-ledger 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.2.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@2.1.1...@exodus/hw-ledger@2.2.0) (2024-01-11)
+
+### Features
+
+- support signing matic transactions with ethereum app on ledger ([#5329](https://github.com/ExodusMovement/exodus-hydra/issues/5329)) ([55eda94](https://github.com/ExodusMovement/exodus-hydra/commit/55eda944b78e1714a2b7215731febf399167a85b))
+
+## [2.1.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@2.1.0...@exodus/hw-ledger@2.1.1) (2024-01-11)
+
+### Bug Fixes
+
+- missing dependencies ([#5322](https://github.com/ExodusMovement/exodus-hydra/issues/5322)) ([01efedc](https://github.com/ExodusMovement/exodus-hydra/commit/01efedc7508fb14925277fdcd388afb721ac3dd1))
+- skip ethereum parity v normalization ([#5330](https://github.com/ExodusMovement/exodus-hydra/issues/5330)) ([7408190](https://github.com/ExodusMovement/exodus-hydra/commit/740819013c486a67302298fa6e3e9c981f42014c))
+
 ## [2.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@2.0.0...@exodus/hw-ledger@2.1.0) (2023-12-25)
 
 ### Features

package/lib/module/assets/bitcoin.d.ts

@@ -9,8 +9,10 @@ export interface BitcoinMessage {
 }
 declare function createHandler(transport: Transport): Promise<HardwareWalletAssetHandler<BitcoinMessage>>;
 declare const metadata: {
-    applicationName: string;
-    supportedVersions: string;
+    applications: {
+        applicationName: string;
+        supportedVersions: string;
+    }[];
     handler: typeof createHandler;
 };
 export default metadata;

package/lib/module/assets/bitcoin.js

@@ -67,8 +67,12 @@ async function createHandler(transport) {
     };
 }
 const metadata = {
-    applicationName: 'Bitcoin',
-    supportedVersions: '^2.1.2',
+    applications: [
+        {
+            applicationName: 'Bitcoin',
+            supportedVersions: '^2.1.2',
+        },
+    ],
     handler: createHandler,
 };
 export default metadata;

package/lib/module/assets/ethereum.d.ts

@@ -2,8 +2,10 @@ import type Transport from '@ledgerhq/hw-transport';
 import type { HardwareWalletAssetHandler } from '@exodus/hw-common';
 declare function createHandler(transport: Transport): Promise<HardwareWalletAssetHandler>;
 declare const metadata: {
-    applicationName: string;
-    supportedVersions: string;
+    applications: {
+        applicationName: string;
+        supportedVersions: string;
+    }[];
     handler: typeof createHandler;
 };
 export default metadata;

package/lib/module/assets/ethereum.js

@@ -118,15 +118,19 @@ async function createHandler(transport) {
                 assert(false, 'rawMessage or EIP712Message must be specified');
             }
             const { r, s, v } = await signingPromise;
-            const vNorm = (v - 27).toString(16);
+            const vNorm = v.toString(16);
             const vHex = vNorm.length < 2 ? '0' + vNorm : vNorm;
             return Buffer.from(`${r}${s}${vHex}`, 'hex');
         },
     };
 }
 const metadata = {
-    applicationName: 'Ethereum',
-    supportedVersions: '^1.10.0',
+    applications: [
+        {
+            applicationName: 'Ethereum',
+            supportedVersions: '^1.10.0',
+        },
+    ],
     handler: createHandler,
 };
 export default metadata;

package/lib/module/assets/index.d.ts

@@ -2,8 +2,10 @@ import type Transport from '@ledgerhq/hw-transport';
 import type { HardwareWalletAssetHandler } from '@exodus/hw-common';
 type HandlerFactory = (transport: Transport) => Promise<HardwareWalletAssetHandler>;
 type AssetMetadata = {
-    applicationName: string;
-    supportedVersions: string;
+    applications: {
+        applicationName: string;
+        supportedVersions: string;
+    }[];
     handler: HandlerFactory;
 };
 export declare const assetApplications: Record<string, AssetMetadata>;

package/lib/module/assets/index.js

@@ -10,6 +10,6 @@ export const assetApplications = {
 };
 export const supportedBaseAssetNames = Object.keys(assetApplications);
 export const applicationNameToBaseAssetName = Object.entries(assetApplications).reduce((mapping, [assetName, metadata]) => {
-    mapping[metadata.applicationName] = assetName;
+    mapping[metadata.applications[0].applicationName] = assetName;
     return mapping;
 }, Object.create(null));

package/lib/module/assets/matic.d.ts

@@ -1,6 +1,8 @@
 declare const metadata: {
-    applicationName: string;
-    supportedVersions: string;
+    applications: {
+        applicationName: string;
+        supportedVersions: string;
+    }[];
     handler: (transport: import("@ledgerhq/hw-transport").default) => Promise<import("libraries/hw-common/lib").HardwareWalletAssetHandler<import("libraries/hw-common/lib").Message>>;
 };
 export default metadata;

package/lib/module/assets/matic.js

@@ -1,7 +1,12 @@
 import ethereum from './ethereum';
 const metadata = {
-    applicationName: 'Polygon',
-    supportedVersions: '^1.10.0',
+    applications: [
+        {
+            applicationName: 'Polygon',
+            supportedVersions: '^1.10.0',
+        },
+        ...ethereum.applications,
+    ],
     handler: ethereum.handler,
 };
 export default metadata;

package/lib/module/assets/solana.d.ts

@@ -2,8 +2,10 @@ import type Transport from '@ledgerhq/hw-transport';
 import type { HardwareWalletAssetHandler } from '@exodus/hw-common';
 declare function createHandler(transport: Transport): Promise<HardwareWalletAssetHandler>;
 declare const metadata: {
-    applicationName: string;
-    supportedVersions: string;
+    applications: {
+        applicationName: string;
+        supportedVersions: string;
+    }[];
     handler: typeof createHandler;
 };
 export default metadata;

package/lib/module/assets/solana.js

@@ -53,8 +53,12 @@ async function createHandler(transport) {
     };
 }
 const metadata = {
-    applicationName: 'Solana',
-    supportedVersions: '^1.4.0',
+    applications: [
+        {
+            applicationName: 'Solana',
+            supportedVersions: '^1.4.0',
+        },
+    ],
     handler: createHandler,
 };
 export default metadata;

package/lib/module/device.d.ts

@@ -8,6 +8,7 @@ export type Dependencies = {
 export declare class LedgerDevice implements HardwareWalletDevice {
     #private;
     constructor({ transportFactory, descriptor }: Dependencies);
+    ensureApplicationIsOpened: (baseAssetName: string) => Promise<void>;
     listSupportedAssetNames: () => Promise<string[]>;
     listInstalledAssetNames: () => Promise<string[]>;
     listUseableAssetNames: () => Promise<string[]>;

package/lib/module/device.js

@@ -2,7 +2,7 @@ import semver from 'semver';
 import { AssetUnsupportedError, DeviceLockedError, DeviceConnectionError, UserRefusedError, } from '@exodus/hw-common';
 import { applicationNameToBaseAssetName, assetApplications, supportedBaseAssetNames, } from './assets';
 import applicationFactory from './management/application';
-import { UnsupportedVersionError } from './errors';
+import { UnsupportedVersionError, ApplicationNotFoundError } from './errors';
 export class LedgerDevice {
     #transportFactory;
     #descriptor;
@@ -10,7 +10,7 @@ export class LedgerDevice {
         this.#transportFactory = transportFactory;
         this.#descriptor = descriptor;
     }
-    #runInSession = async (operation) => {
+    #runInSession = async (operation, expectErrorWhenClosing = false) => {
         const transport = await this.#transportFactory.open(this.#descriptor);
         try {
             return await operation(transport);
@@ -19,7 +19,14 @@ export class LedgerDevice {
             throw transformToCommonError(err);
         }
         finally {
-            await transport.close();
+            if (expectErrorWhenClosing) {
+                await transport.close().catch((err) => {
+                    console.warn(`caught error while closing ledger transport but was expected = `, err);
+                });
+            }
+            else {
+                await transport.close();
+            }
         }
     };
     #getAssetApplication = (assetName) => {
@@ -44,7 +51,7 @@ export class LedgerDevice {
         return this.#runInSession(async (transport) => {
             const handler = await applicationFactory(transport);
             return handler.openApplication(applicationName);
-        });
+        }, true);
     };
     #quitApplication = async () => {
         return this.#runInSession(async (transport) => {
@@ -52,18 +59,37 @@ export class LedgerDevice {
             return handler.quitApplication();
         });
     };
-    #ensureApplicationIsOpened = async (assetName) => {
-        const { applicationName, supportedVersions } = this.#getAssetApplication(assetName);
+    ensureApplicationIsOpened = async (baseAssetName) => {
+        const { applications } = this.#getAssetApplication(baseAssetName);
+        const supportedApplicationNames = applications.map(({ applicationName }) => applicationName);
         const currentApplicationInfo = await this.#getInformation();
         let desiredApplicationInfo = null;
-        if (applicationName === currentApplicationInfo.name) {
+        if (supportedApplicationNames.includes(currentApplicationInfo.name)) {
             desiredApplicationInfo = currentApplicationInfo;
         }
         else {
             await this.#quitApplication();
-            await this.#openApplication(applicationName);
+            let applicationName = null;
+            for (const applicationNameToOpen of supportedApplicationNames) {
+                try {
+                    await this.#openApplication(applicationNameToOpen);
+                    applicationName = applicationNameToOpen;
+                    break;
+                }
+                catch (err) {
+                    const APPLICATION_NOT_INSTALLED = 26631;
+                    if (err.statusCode === APPLICATION_NOT_INSTALLED) {
+                        continue;
+                    }
+                }
+            }
+            if (!applicationName) {
+                throw new ApplicationNotFoundError(supportedApplicationNames);
+            }
             desiredApplicationInfo = await this.#getInformation();
         }
+        const currentApplicationName = desiredApplicationInfo.name;
+        const { supportedVersions } = applications.find(({ applicationName }) => applicationName === currentApplicationName);
         const isSupportedVersion = semver.satisfies(desiredApplicationInfo.version, supportedVersions);
         if (!isSupportedVersion) {
             throw new UnsupportedVersionError(desiredApplicationInfo.version, supportedVersions);
@@ -91,35 +117,35 @@ export class LedgerDevice {
         return assetName ? [assetName] : [];
     };
     getAddress = async (params) => {
-        await this.#ensureApplicationIsOpened(params.assetName);
+        await this.ensureApplicationIsOpened(params.assetName);
         return this.#runInSession(async (transport) => {
             const handler = await this.#getAssetApplication(params.assetName).handler(transport);
             return handler.getAddress(params);
         });
     };
     getXPub = async (params) => {
-        await this.#ensureApplicationIsOpened(params.assetName);
+        await this.ensureApplicationIsOpened(params.assetName);
         return this.#runInSession(async (transport) => {
             const handler = await this.#getAssetApplication(params.assetName).handler(transport);
             return handler.getXPub(params);
         });
     };
     getPublicKey = async (params) => {
-        await this.#ensureApplicationIsOpened(params.assetName);
+        await this.ensureApplicationIsOpened(params.assetName);
         return this.#runInSession(async (transport) => {
             const handler = await this.#getAssetApplication(params.assetName).handler(transport);
             return handler.getPublicKey(params);
         });
     };
     signTransaction = async (params) => {
-        await this.#ensureApplicationIsOpened(params.assetName);
+        await this.ensureApplicationIsOpened(params.assetName);
         return this.#runInSession(async (transport) => {
             const handler = await this.#getAssetApplication(params.assetName).handler(transport);
             return handler.signTransaction(params);
         });
     };
     signMessage = async (params) => {
-        await this.#ensureApplicationIsOpened(params.assetName);
+        await this.ensureApplicationIsOpened(params.assetName);
         return this.#runInSession(async (transport) => {
             const handler = await this.#getAssetApplication(params.assetName).handler(transport);
             return handler.signMessage(params);

package/lib/module/errors.d.ts

@@ -7,8 +7,15 @@ export declare class NoDeviceFoundError extends HardwareWalletError {
     name: string;
     constructor();
 }
+export declare class ApplicationNotFoundError extends HardwareWalletError {
+    name: string;
+    supportedApplications: string[];
+    constructor(supportedApplications: string[]);
+}
 export declare class UnsupportedVersionError extends HardwareWalletError {
     name: string;
+    supportedVersions: string;
+    actualVersion: string;
     constructor(actualVersion: string, supportedVersions: string);
 }
 export declare class RequiresBlindSigningError extends HardwareWalletError {

package/lib/module/errors.js

@@ -11,10 +11,22 @@ export class NoDeviceFoundError extends HardwareWalletError {
         super(`unable to find a connected device`);
     }
 }
+export class ApplicationNotFoundError extends HardwareWalletError {
+    name = 'ApplicationNotFoundError';
+    supportedApplications;
+    constructor(supportedApplications) {
+        super(`required application not installed, please install a supported application (${supportedApplications.join(', ')}).`);
+        this.supportedApplications = supportedApplications;
+    }
+}
 export class UnsupportedVersionError extends HardwareWalletError {
     name = 'UnsupportedVersionError';
+    supportedVersions;
+    actualVersion;
     constructor(actualVersion, supportedVersions) {
         super(`version does not meet version requirements: ${actualVersion} does not match ${supportedVersions}`);
+        this.supportedVersions = supportedVersions;
+        this.actualVersion = actualVersion;
     }
 }
 export class RequiresBlindSigningError extends HardwareWalletError {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/hw-ledger",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "The ledger module",
   "author": "Exodus Movement Inc.",
   "repository": {
@@ -36,6 +36,7 @@
     "@exodus/hw-common": "^2.0.0",
     "@exodus/ledger-bitcoin": "^0.2.3-exodus.0",
     "@exodus/ledgerhq-hw-app-eth": "^6.33.7-exodus.3",
+    "@exodus/module": "^1.2.2",
     "@exodus/secp256k1": "^4.0.2-exodus.0",
     "@ledgerhq/hw-app-solana": "^7.0.10",
     "@ledgerhq/hw-transport": "^6.28.5",
@@ -48,7 +49,6 @@
   "devDependencies": {
     "@exodus/bip32": "^2.0.0",
     "@exodus/ledgerhq-devices": "^8.1.0-exodus.0",
-    "@exodus/module": "^1.2.2",
     "@ledgerhq/hw-transport-node-hid": "^6.27.17",
     "@ledgerhq/hw-transport-node-speculos": "^6.27.16",
     "@types/bs58": "^4.0.1",
@@ -67,5 +67,5 @@
     "ts-jest": "^29.0.3",
     "typescript": "^4.7.3"
   },
-  "gitHead": "85a22445ece0c52a1efd5d4323824e52fbfce116"
+  "gitHead": "d19b9139b125653c52a2d4e657d87d9ed40e5d4b"
 }