@exodus/hw-ledger 1.1.0 → 1.3.0

package/CHANGELOG.md

@@ -3,6 +3,20 @@
 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/hw-ledger@1.2.0...@exodus/hw-ledger@1.3.0) (2023-11-28)
+
+### Features
+
+- add ability to retrieve supported, installed and useable assets ([#4901](https://github.com/ExodusMovement/exodus-hydra/issues/4901)) ([d821590](https://github.com/ExodusMovement/exodus-hydra/commit/d82159062aa497c1ae5bbe4362cce8a2aff0cc9c))
+- add generic `Message` type in `SignMessageParams` ([#4895](https://github.com/ExodusMovement/exodus-hydra/issues/4895)) ([fb688ea](https://github.com/ExodusMovement/exodus-hydra/commit/fb688ea071c18a1a041bbd53869f7afdce2c0b1d))
+- add ledger `getFirstDevice` helper ([#4897](https://github.com/ExodusMovement/exodus-hydra/issues/4897)) ([6a2b362](https://github.com/ExodusMovement/exodus-hydra/commit/6a2b362e69b46e0d19be80394ff6f5533f6139ba))
+
+## [1.2.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@1.1.0...@exodus/hw-ledger@1.2.0) (2023-11-27)
+
+### Features
+
+- make hw-ledger a feature ([#4882](https://github.com/ExodusMovement/exodus-hydra/issues/4882)) ([33d93fb](https://github.com/ExodusMovement/exodus-hydra/commit/33d93fb0f4bb507e3788c0450a3e413e79815433))
+
 ## [1.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@1.0.0...@exodus/hw-ledger@1.1.0) (2023-08-21)
 
 ### Features

package/lib/index.d.ts

@@ -1,2 +1,12 @@
-export * from './discovery';
-export { default } from './discovery';
+declare const hardwareWalletLedger: () => {
+    id: string;
+    definitions: {
+        definition: {
+            id: string;
+            type: string;
+            factory: (deps: import("./module").Dependencies) => import("./module").LedgerDiscovery;
+            dependencies: string[];
+        };
+    }[];
+};
+export default hardwareWalletLedger;

package/lib/index.js

@@ -1,2 +1,12 @@
-export * from './discovery';
-export { default } from './discovery';
+import ledgerDiscoveryDefinition from './module';
+const hardwareWalletLedger = () => {
+    return {
+        id: 'hardwareWalletLedger',
+        definitions: [
+            {
+                definition: ledgerDiscoveryDefinition,
+            },
+        ],
+    };
+};
+export default hardwareWalletLedger;

package/lib/{assets → module/assets}/bitcoin.d.ts

@@ -1,6 +1,13 @@
 import type Transport from '@ledgerhq/hw-transport';
-import type { HardwareWalletDevice } from '@exodus/hw-common';
-declare function createHandler(transport: Transport): Promise<HardwareWalletDevice>;
+import type { Bytes, HardwareWalletAssetHandler } from '@exodus/hw-common';
+export interface BitcoinMessage {
+    rawMessage?: Bytes;
+    bip322Message?: {
+        address: string;
+        message: Bytes;
+    };
+}
+declare function createHandler(transport: Transport): Promise<HardwareWalletAssetHandler<BitcoinMessage>>;
 declare const metadata: {
     applicationName: string;
     supportedVersions: string;

package/lib/{assets → module/assets}/ethereum.d.ts

@@ -1,6 +1,6 @@
 import type Transport from '@ledgerhq/hw-transport';
-import type { HardwareWalletDevice } from '@exodus/hw-common';
-declare function createHandler(transport: Transport): Promise<HardwareWalletDevice>;
+import type { HardwareWalletAssetHandler } from '@exodus/hw-common';
+declare function createHandler(transport: Transport): Promise<HardwareWalletAssetHandler>;
 declare const metadata: {
     applicationName: string;
     supportedVersions: string;

package/lib/{assets → module/assets}/ethereum.js

@@ -97,9 +97,7 @@ async function createHandler(transport) {
                         const { domainSeparator, hashStructMessage } = hashEIP712Message(message.EIP712Message);
                         return app.signEIP712HashedMessage(params.derivationPath, domainSeparator.toString('hex'), hashStructMessage.toString('hex'));
                     }
-                    else {
-                        throw err;
-                    }
+                    throw err;
                 });
             }
             else {

package/lib/{assets → module/assets}/index.d.ts

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

package/lib/module/assets/index.js

@@ -0,0 +1,15 @@
+import bitcoin from './bitcoin';
+import ethereum from './ethereum';
+import polygon from './polygon';
+import solana from './solana';
+export const assetApplications = {
+    bitcoin,
+    ethereum,
+    polygon,
+    solana,
+};
+export const supportedBaseAssetNames = Object.keys(assetApplications);
+export const applicationNameToBaseAssetName = Object.entries(assetApplications).reduce((mapping, [assetName, metadata]) => {
+    mapping[metadata.applicationName] = assetName;
+    return mapping;
+}, Object.create(null));

package/lib/{assets → module/assets}/polygon.d.ts

@@ -1,6 +1,6 @@
 declare const metadata: {
     applicationName: string;
     supportedVersions: string;
-    handler: (transport: import("@ledgerhq/hw-transport").default) => Promise<import("~/../../libraries/hw-common/lib").HardwareWalletDevice>;
+    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/{assets → module/assets}/solana.d.ts

@@ -1,6 +1,6 @@
 import type Transport from '@ledgerhq/hw-transport';
-import type { HardwareWalletDevice } from '@exodus/hw-common';
-declare function createHandler(transport: Transport): Promise<HardwareWalletDevice>;
+import type { HardwareWalletAssetHandler } from '@exodus/hw-common';
+declare function createHandler(transport: Transport): Promise<HardwareWalletAssetHandler>;
 declare const metadata: {
     applicationName: string;
     supportedVersions: string;

package/lib/{device.d.ts → module/device.d.ts}

@@ -8,6 +8,9 @@ export type Dependencies = {
 export declare class LedgerDevice implements HardwareWalletDevice {
     #private;
     constructor({ transportFactory, descriptor }: Dependencies);
+    listSupportedAssetNames: () => Promise<string[]>;
+    listInstalledAssetNames: () => Promise<string[]>;
+    listUseableAssetNames: () => Promise<string[]>;
     getAddress: (params: GetAddressParams) => Promise<string>;
     getXPub: (params: GetXPubParams) => Promise<string>;
     getPublicKey: (params: GetPublicKeyParams) => Promise<Readonly<Uint8Array>>;

package/lib/{device.js → module/device.js}

@@ -1,6 +1,6 @@
 import semver from 'semver';
 import { AssetUnsupportedError, DeviceLockedError, DeviceConnectionError, UserRefusedError, } from '@exodus/hw-common';
-import { assetApplications } from './assets';
+import { applicationNameToBaseAssetName, assetApplications, supportedBaseAssetNames, } from './assets';
 import applicationFactory from './management/application';
 import { UnsupportedVersionError } from './errors';
 export class LedgerDevice {
@@ -69,6 +69,27 @@ export class LedgerDevice {
             throw new UnsupportedVersionError(desiredApplicationInfo.version, supportedVersions);
         }
     };
+    listSupportedAssetNames = async () => {
+        return supportedBaseAssetNames;
+    };
+    listInstalledAssetNames = async () => {
+        const { name: applicationName } = await this.#getInformation();
+        if (applicationName !== 'BOLOS')
+            await this.#quitApplication();
+        const installedApplications = await this.#listApplications();
+        const installedAssets = [];
+        installedApplications.forEach(({ name: applicationName }) => {
+            const assetName = applicationNameToBaseAssetName[applicationName];
+            if (assetName)
+                installedAssets.push(assetName);
+        });
+        return installedAssets;
+    };
+    listUseableAssetNames = async () => {
+        const { name: applicationName } = await this.#getInformation();
+        const assetName = applicationNameToBaseAssetName[applicationName];
+        return assetName ? [assetName] : [];
+    };
     getAddress = async (params) => {
         await this.#ensureApplicationIsOpened(params.assetName);
         return this.#runInSession(async (transport) => {
@@ -110,10 +131,10 @@ function transformToCommonError(_err) {
     if (err.name === 'LockedDeviceError') {
         return new DeviceLockedError();
     }
-    else if (err.name === 'UserRefusedOnDevice') {
+    if (err.name === 'UserRefusedOnDevice') {
         return new UserRefusedError();
     }
-    else if ([
+    if ([
         'HwTransportError',
         'TransportError',
         'TransportRaceCondition',
@@ -123,7 +144,5 @@ function transformToCommonError(_err) {
     ].includes(err.name)) {
         return new DeviceConnectionError(err);
     }
-    else {
-        return err;
-    }
+    return err;
 }

package/lib/{discovery.d.ts → module/discovery.d.ts}

@@ -1,5 +1,5 @@
 import ExodusModule from '@exodus/module';
-import { Logger } from '~/shared/types';
+import { Logger } from '../shared/types';
 import type { HardwareWalletDescriptor, HardwareWalletDiscovery } from '@exodus/hw-common';
 import type { TransportFactory } from './types';
 export type Dependencies = {
@@ -14,6 +14,7 @@ export declare class LedgerDiscovery extends ExodusModule implements HardwareWal
     #private;
     constructor({ logger, transportsFactories }: Dependencies);
     list: () => Promise<HardwareWalletDescriptor[]>;
+    getFirstDevice: () => Promise<import("@exodus/hw-common").HardwareWalletDevice>;
 }
 declare const _default: {
     id: string;

package/lib/{discovery.js → module/discovery.js}

@@ -1,8 +1,8 @@
 import ExodusModule from '@exodus/module';
 import { APDU_PORT } from './constants';
 import { LedgerDevice } from './device';
-import { UnknownTransportError } from './errors';
-const MODULE_ID = 'hardwareWalletLedger';
+import { NoDeviceFoundError, UnknownTransportError } from './errors';
+const MODULE_ID = 'ledgerDiscovery';
 export class LedgerDiscovery extends ExodusModule {
     #transportsFactories;
     constructor({ logger, transportsFactories }) {
@@ -48,6 +48,13 @@ export class LedgerDiscovery extends ExodusModule {
         }
         return descriptors;
     };
+    getFirstDevice = async () => {
+        const devices = await this.list();
+        if (devices[0]) {
+            return devices[0].get();
+        }
+        throw new NoDeviceFoundError();
+    };
 }
 const createLedgerDiscovery = (deps) => new LedgerDiscovery({ ...deps });
 export default {

package/lib/{errors.d.ts → module/errors.d.ts}

@@ -3,6 +3,10 @@ export declare class UnknownTransportError extends HardwareWalletError {
     name: string;
     constructor(transportName?: string);
 }
+export declare class NoDeviceFoundError extends HardwareWalletError {
+    name: string;
+    constructor();
+}
 export declare class UnsupportedVersionError extends HardwareWalletError {
     name: string;
     constructor(actualVersion: string, supportedVersions: string);

package/lib/{errors.js → module/errors.js}

@@ -5,6 +5,12 @@ export class UnknownTransportError extends HardwareWalletError {
         super(`unknown transport type ${transportName || ''}`);
     }
 }
+export class NoDeviceFoundError extends HardwareWalletError {
+    name = 'NoDeviceFoundError';
+    constructor() {
+        super(`unable to find a connected device`);
+    }
+}
 export class UnsupportedVersionError extends HardwareWalletError {
     name = 'UnsupportedVersionError';
     constructor(actualVersion, supportedVersions) {

package/lib/module/index.d.ts

@@ -0,0 +1,2 @@
+export * from './discovery';
+export { default } from './discovery';

package/lib/module/index.js

@@ -0,0 +1,2 @@
+export * from './discovery';
+export { default } from './discovery';

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@exodus/hw-ledger",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "The ledger module",
   "author": "Exodus Movement Inc.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
   },
-  "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/modules/hw-ledger",
+  "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/features/hw-ledger",
   "license": "UNLICENSED",
   "bugs": {
     "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Ahw-ledger"
   },
+  "main": "lib/index.js",
   "files": [
     "lib",
     "./README.md",
@@ -23,14 +24,14 @@
     "clean": "tsc --build --clean",
     "test": "jest --testMatch='**/*.unit.test.js' --coverageDirectory coverage/unit",
     "zemu:install": "docker pull zondax/builder-zemu:speculos-745fe46f81cfc18114b94a37beaefb58a09c0fcd",
-    "test:integration:manual": "yarn zemu:install && jest --maxWorkers 2 --testMatch='**/*.integration.test.js' --coverageDirectory coverage/integration",
-    "coverage:merge": "istanbul-combine -p summary -r json-summary -r lcov coverage/integration/coverage-final.json coverage/unit/coverage-final.json",
+    "test:integration": "yarn zemu:install && jest --runInBand",
     "lint": "eslint . --ignore-path ../../.gitignore",
     "lint:fix": "yarn lint --fix"
   },
   "dependencies": {
+    "@exodus/ethersproject-abi": "^5.4.2-exodus.2",
     "@exodus/ethersproject-transactions": "^5.4.2-exodus.0",
-    "@exodus/hw-common": "^1.0.0",
+    "@exodus/hw-common": "^1.2.0",
     "@exodus/secp256k1": "^4.0.2-exodus.0",
     "@ledgerhq/hw-app-eth": "^6.33.6",
     "@ledgerhq/hw-app-solana": "^7.0.10",
@@ -44,7 +45,7 @@
   },
   "devDependencies": {
     "@exodus/bip32": "^2.0.0",
-    "@exodus/module": "^1.2.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",
@@ -61,5 +62,5 @@
     "ts-jest": "^29.0.3",
     "typescript": "^4.7.3"
   },
-  "gitHead": "a30eeb219ca0b987b2f3f7242ca9e4c10f8b8414"
+  "gitHead": "7406c4024c15818322f299ff30f2be0686ec3bd8"
 }

package/lib/assets/index.js

@@ -1,10 +0,0 @@
-import bitcoin from './bitcoin';
-import ethereum from './ethereum';
-import polygon from './polygon';
-import solana from './solana';
-export const assetApplications = {
-    bitcoin,
-    ethereum,
-    polygon,
-    solana,
-};