@exodus/hw-ledger 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 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

package/lib/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/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/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

@@ -8,3 +8,8 @@ export const assetApplications = {
     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/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/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/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/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) => {

package/lib/module/discovery.d.ts

@@ -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/module/discovery.js

@@ -1,7 +1,7 @@
 import ExodusModule from '@exodus/module';
 import { APDU_PORT } from './constants';
 import { LedgerDevice } from './device';
-import { UnknownTransportError } from './errors';
+import { NoDeviceFoundError, UnknownTransportError } from './errors';
 const MODULE_ID = 'ledgerDiscovery';
 export class LedgerDiscovery extends ExodusModule {
     #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/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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/hw-ledger",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "The ledger module",
   "author": "Exodus Movement Inc.",
   "repository": {
@@ -29,8 +29,9 @@
     "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",
@@ -61,5 +62,5 @@
     "ts-jest": "^29.0.3",
     "typescript": "^4.7.3"
   },
-  "gitHead": "df9526a0bdc326e1a9918c3f76ba2197bf42a920"
+  "gitHead": "7406c4024c15818322f299ff30f2be0686ec3bd8"
 }