@metamask-previews/eth-ledger-bridge-keyring 4.1.1-672cc7b

package/dist/ledger-mobile-bridge.d.ts

@@ -0,0 +1,106 @@
+import type Transport from '@ledgerhq/hw-transport';
+import { GetPublicKeyParams, GetPublicKeyResponse, LedgerBridge, LedgerSignMessageParams, LedgerSignMessageResponse, LedgerSignTransactionParams, LedgerSignTransactionResponse, LedgerSignTypedDataParams, LedgerSignTypedDataResponse } from './ledger-bridge';
+import { TransportMiddleware } from './ledger-transport-middleware';
+import { GetAppNameAndVersionResponse, LedgerMobileBridgeOptions } from './type';
+export declare type MobileBridge = LedgerBridge<LedgerMobileBridgeOptions> & {
+    getAppNameAndVersion(): Promise<GetAppNameAndVersionResponse>;
+    openEthApp(): Promise<void>;
+    closeApps(): Promise<void>;
+};
+/**
+ * LedgerMobileBridge is a bridge between the LedgerKeyring and the LedgerTransportMiddleware.
+ */
+export declare class LedgerMobileBridge implements MobileBridge {
+    #private;
+    isDeviceConnected: boolean;
+    constructor(transportMiddleware: TransportMiddleware, opts?: LedgerMobileBridgeOptions);
+    /**
+     * Method to initializes the keyring.
+     * Mobile ledger doesnt not require init.
+     */
+    init(): Promise<void>;
+    /**
+     * Method to destroy the keyring.
+     * It will dispose the transportmiddleware and set isDeviceConnected to false.
+     */
+    destroy(): Promise<void>;
+    /**
+     * Method to sign a string Message.
+     * Sending the string message to the device and returning the signed message.
+     *
+     * @param params - An object contains hdPath and message.
+     * @param params.hdPath - The BIP 32 path of the account.
+     * @param params.message - The message to sign.
+     * @returns Retrieve v, r, s from the signed message.
+     */
+    deviceSignMessage({ hdPath, message, }: LedgerSignMessageParams): Promise<LedgerSignMessageResponse>;
+    /**
+     * Method to sign a EIP712 Message.
+     * Sending the typed data message to the device and returning the signed message.
+     *
+     * @param params - An object contains hdPath, domainSeparatorHex and hashStructMessageHex.
+     * @param params.hdPath - The BIP 32 path of the account.
+     * @param params.domainSeparatorHex - The domain separator.
+     * @param params.hashStructMessageHex - The hashed struct message.
+     * @returns Retrieve v, r, s from the signed message.
+     */
+    deviceSignTypedData({ hdPath, domainSeparatorHex, hashStructMessageHex, }: LedgerSignTypedDataParams): Promise<LedgerSignTypedDataResponse>;
+    /**
+     * Method to sign a transaction
+     * Sending the hexadecimal transaction message to the device and returning the signed transaction.
+     *
+     * @param params - An object contains tx, hdPath.
+     * @param params.tx - The raw ethereum transaction in hexadecimal to sign.
+     * @param params.hdPath - The BIP 32 path of the account.
+     * @returns Retrieve v, r, s from the signed transaction.
+     */
+    deviceSignTransaction({ tx, hdPath, }: LedgerSignTransactionParams): Promise<LedgerSignTransactionResponse>;
+    /**
+     * Method to retrieve the ethereum address for a given BIP 32 path.
+     *
+     * @param params - An object contains hdPath.
+     * @param params.hdPath - The BIP 32 path of the account.
+     * @returns An object contains publicKey, address and chainCode.
+     */
+    getPublicKey({ hdPath, }: GetPublicKeyParams): Promise<GetPublicKeyResponse>;
+    /**
+     * Method to retrieve the current configuration.
+     *
+     * @returns Retrieve current configuration.
+     */
+    getOptions(): Promise<LedgerMobileBridgeOptions>;
+    /**
+     * Method to set the current configuration.
+     *
+     * @param opts - An configuration object.
+     */
+    setOptions(opts: LedgerMobileBridgeOptions): Promise<void>;
+    /**
+     * Method to set the transport object to communicate with the device.
+     *
+     * @param transport - The communication interface with the Ledger hardware wallet. There are different kind of transports based on the technology (channels like U2F, HID, Bluetooth, Webusb).
+     * @returns Retrieve boolean.
+     */
+    updateTransportMethod(transport: Transport): Promise<boolean>;
+    /**
+     * Method to init eth app object on ledger device.
+     * This method is not supported on mobile.
+     */
+    attemptMakeApp(): Promise<boolean>;
+    /**
+     * Method to open ethereum application on ledger device.
+     *
+     */
+    openEthApp(): Promise<void>;
+    /**
+     * Method to close all running application on ledger device.
+     *
+     */
+    closeApps(): Promise<void>;
+    /**
+     * Method to retrieve the name and version of the running application in ledger device.
+     *
+     * @returns An object contains appName and version.
+     */
+    getAppNameAndVersion(): Promise<GetAppNameAndVersionResponse>;
+}

package/dist/ledger-mobile-bridge.js

@@ -0,0 +1,173 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _LedgerMobileBridge_instances, _LedgerMobileBridge_transportMiddleware, _LedgerMobileBridge_opts, _LedgerMobileBridge_getTransportMiddleWare, _LedgerMobileBridge_getEthApp;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LedgerMobileBridge = void 0;
+const ledger_1 = __importDefault(require("@ledgerhq/hw-app-eth/lib/services/ledger"));
+/**
+ * LedgerMobileBridge is a bridge between the LedgerKeyring and the LedgerTransportMiddleware.
+ */
+class LedgerMobileBridge {
+    constructor(transportMiddleware, opts = {}) {
+        _LedgerMobileBridge_instances.add(this);
+        _LedgerMobileBridge_transportMiddleware.set(this, void 0);
+        _LedgerMobileBridge_opts.set(this, void 0);
+        this.isDeviceConnected = false;
+        __classPrivateFieldSet(this, _LedgerMobileBridge_opts, opts, "f");
+        __classPrivateFieldSet(this, _LedgerMobileBridge_transportMiddleware, transportMiddleware, "f");
+    }
+    /**
+     * Method to initializes the keyring.
+     * Mobile ledger doesnt not require init.
+     */
+    async init() {
+        return Promise.resolve();
+    }
+    /**
+     * Method to destroy the keyring.
+     * It will dispose the transportmiddleware and set isDeviceConnected to false.
+     */
+    async destroy() {
+        try {
+            await __classPrivateFieldGet(this, _LedgerMobileBridge_instances, "m", _LedgerMobileBridge_getTransportMiddleWare).call(this).dispose();
+        }
+        catch (error) {
+            // eslint-disable-next-line no-console
+            console.error(error);
+        }
+        this.isDeviceConnected = false;
+    }
+    /**
+     * Method to sign a string Message.
+     * Sending the string message to the device and returning the signed message.
+     *
+     * @param params - An object contains hdPath and message.
+     * @param params.hdPath - The BIP 32 path of the account.
+     * @param params.message - The message to sign.
+     * @returns Retrieve v, r, s from the signed message.
+     */
+    async deviceSignMessage({ hdPath, message, }) {
+        return __classPrivateFieldGet(this, _LedgerMobileBridge_instances, "m", _LedgerMobileBridge_getEthApp).call(this).signPersonalMessage(hdPath, message);
+    }
+    /**
+     * Method to sign a EIP712 Message.
+     * Sending the typed data message to the device and returning the signed message.
+     *
+     * @param params - An object contains hdPath, domainSeparatorHex and hashStructMessageHex.
+     * @param params.hdPath - The BIP 32 path of the account.
+     * @param params.domainSeparatorHex - The domain separator.
+     * @param params.hashStructMessageHex - The hashed struct message.
+     * @returns Retrieve v, r, s from the signed message.
+     */
+    async deviceSignTypedData({ hdPath, domainSeparatorHex, hashStructMessageHex, }) {
+        return __classPrivateFieldGet(this, _LedgerMobileBridge_instances, "m", _LedgerMobileBridge_getEthApp).call(this).signEIP712HashedMessage(hdPath, domainSeparatorHex, hashStructMessageHex);
+    }
+    /**
+     * Method to sign a transaction
+     * Sending the hexadecimal transaction message to the device and returning the signed transaction.
+     *
+     * @param params - An object contains tx, hdPath.
+     * @param params.tx - The raw ethereum transaction in hexadecimal to sign.
+     * @param params.hdPath - The BIP 32 path of the account.
+     * @returns Retrieve v, r, s from the signed transaction.
+     */
+    async deviceSignTransaction({ tx, hdPath, }) {
+        const resolution = await ledger_1.default.resolveTransaction(tx, {}, {});
+        return __classPrivateFieldGet(this, _LedgerMobileBridge_instances, "m", _LedgerMobileBridge_getEthApp).call(this).signTransaction(hdPath, tx, resolution);
+    }
+    /**
+     * Method to retrieve the ethereum address for a given BIP 32 path.
+     *
+     * @param params - An object contains hdPath.
+     * @param params.hdPath - The BIP 32 path of the account.
+     * @returns An object contains publicKey, address and chainCode.
+     */
+    async getPublicKey({ hdPath, }) {
+        return await __classPrivateFieldGet(this, _LedgerMobileBridge_instances, "m", _LedgerMobileBridge_getEthApp).call(this).getAddress(hdPath, false, true);
+    }
+    /**
+     * Method to retrieve the current configuration.
+     *
+     * @returns Retrieve current configuration.
+     */
+    async getOptions() {
+        return __classPrivateFieldGet(this, _LedgerMobileBridge_opts, "f");
+    }
+    /**
+     * Method to set the current configuration.
+     *
+     * @param opts - An configuration object.
+     */
+    async setOptions(opts) {
+        __classPrivateFieldSet(this, _LedgerMobileBridge_opts, opts, "f");
+    }
+    /**
+     * Method to set the transport object to communicate with the device.
+     *
+     * @param transport - The communication interface with the Ledger hardware wallet. There are different kind of transports based on the technology (channels like U2F, HID, Bluetooth, Webusb).
+     * @returns Retrieve boolean.
+     */
+    async updateTransportMethod(transport) {
+        if (!transport.deviceModel) {
+            throw new Error('Property `deviceModel` is not defined in `transport`.');
+        }
+        if (!transport.deviceModel.id) {
+            throw new Error('Property `deviceModel.id` is not defined in `transport`.');
+        }
+        __classPrivateFieldGet(this, _LedgerMobileBridge_instances, "m", _LedgerMobileBridge_getTransportMiddleWare).call(this).setTransport(transport);
+        this.isDeviceConnected = true;
+        return Promise.resolve(true);
+    }
+    /**
+     * Method to init eth app object on ledger device.
+     * This method is not supported on mobile.
+     */
+    async attemptMakeApp() {
+        throw new Error('Method not supported.');
+    }
+    /**
+     * Method to open ethereum application on ledger device.
+     *
+     */
+    async openEthApp() {
+        await __classPrivateFieldGet(this, _LedgerMobileBridge_instances, "m", _LedgerMobileBridge_getEthApp).call(this).openEthApp();
+    }
+    /**
+     * Method to close all running application on ledger device.
+     *
+     */
+    async closeApps() {
+        await __classPrivateFieldGet(this, _LedgerMobileBridge_instances, "m", _LedgerMobileBridge_getEthApp).call(this).closeApps();
+    }
+    /**
+     * Method to retrieve the name and version of the running application in ledger device.
+     *
+     * @returns An object contains appName and version.
+     */
+    async getAppNameAndVersion() {
+        return __classPrivateFieldGet(this, _LedgerMobileBridge_instances, "m", _LedgerMobileBridge_getEthApp).call(this).getAppNameAndVersion();
+    }
+}
+exports.LedgerMobileBridge = LedgerMobileBridge;
+_LedgerMobileBridge_transportMiddleware = new WeakMap(), _LedgerMobileBridge_opts = new WeakMap(), _LedgerMobileBridge_instances = new WeakSet(), _LedgerMobileBridge_getTransportMiddleWare = function _LedgerMobileBridge_getTransportMiddleWare() {
+    if (__classPrivateFieldGet(this, _LedgerMobileBridge_transportMiddleware, "f")) {
+        return __classPrivateFieldGet(this, _LedgerMobileBridge_transportMiddleware, "f");
+    }
+    throw new Error('Instance `transportMiddleware` is not initialized.');
+}, _LedgerMobileBridge_getEthApp = function _LedgerMobileBridge_getEthApp() {
+    return __classPrivateFieldGet(this, _LedgerMobileBridge_instances, "m", _LedgerMobileBridge_getTransportMiddleWare).call(this).getEthApp();
+};
+//# sourceMappingURL=ledger-mobile-bridge.js.map

package/dist/ledger-mobile-bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ledger-mobile-bridge.js","sourceRoot":"","sources":["../src/ledger-mobile-bridge.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,sFAAqE;AA4BrE;;GAEG;AACH,MAAa,kBAAkB;IAO7B,YACE,mBAAwC,EACxC,OAAkC,EAAE;;QARtC,0DAA2C;QAE3C,2CAAiC;QAEjC,sBAAiB,GAAG,KAAK,CAAC;QAMxB,uBAAA,IAAI,4BAAS,IAAI,MAAA,CAAC;QAClB,uBAAA,IAAI,2CAAwB,mBAAmB,MAAA,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACX,IAAI;YACF,MAAM,uBAAA,IAAI,iFAAwB,MAA5B,IAAI,CAA0B,CAAC,OAAO,EAAE,CAAC;SAChD;QAAC,OAAO,KAAK,EAAE;YACd,sCAAsC;YACtC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACtB;QACD,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;IACjC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CAAC,EACtB,MAAM,EACN,OAAO,GACiB;QACxB,OAAO,uBAAA,IAAI,oEAAW,MAAf,IAAI,CAAa,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,mBAAmB,CAAC,EACxB,MAAM,EACN,kBAAkB,EAClB,oBAAoB,GACM;QAC1B,OAAO,uBAAA,IAAI,oEAAW,MAAf,IAAI,CAAa,CAAC,uBAAuB,CAC9C,MAAM,EACN,kBAAkB,EAClB,oBAAoB,CACrB,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,qBAAqB,CAAC,EAC1B,EAAE,EACF,MAAM,GACsB;QAC5B,MAAM,UAAU,GAAG,MAAM,gBAAa,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACtE,OAAO,uBAAA,IAAI,oEAAW,MAAf,IAAI,CAAa,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,EACjB,MAAM,GACa;QACnB,OAAO,MAAM,uBAAA,IAAI,oEAAW,MAAf,IAAI,CAAa,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU;QACd,OAAO,uBAAA,IAAI,gCAAM,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,IAA+B;QAC9C,uBAAA,IAAI,4BAAS,IAAI,MAAA,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CAAC,SAAoB;QAC9C,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC1E;QACD,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,EAAE;YAC7B,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;SACH;QACD,uBAAA,IAAI,iFAAwB,MAA5B,IAAI,CAA0B,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,uBAAA,IAAI,oEAAW,MAAf,IAAI,CAAa,CAAC,UAAU,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,uBAAA,IAAI,oEAAW,MAAf,IAAI,CAAa,CAAC,SAAS,EAAE,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,oBAAoB;QACxB,OAAO,uBAAA,IAAI,oEAAW,MAAf,IAAI,CAAa,CAAC,oBAAoB,EAAE,CAAC;IAClD,CAAC;CAsBF;AApMD,gDAoMC;;IAdG,IAAI,uBAAA,IAAI,+CAAqB,EAAE;QAC7B,OAAO,uBAAA,IAAI,+CAAqB,CAAC;KAClC;IACD,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;AACxE,CAAC;IAQC,OAAO,uBAAA,IAAI,iFAAwB,MAA5B,IAAI,CAA0B,CAAC,SAAS,EAAE,CAAC;AACpD,CAAC","sourcesContent":["import ledgerService from '@ledgerhq/hw-app-eth/lib/services/ledger';\nimport type Transport from '@ledgerhq/hw-transport';\n\nimport {\n  GetPublicKeyParams,\n  GetPublicKeyResponse,\n  LedgerBridge,\n  LedgerSignMessageParams,\n  LedgerSignMessageResponse,\n  LedgerSignTransactionParams,\n  LedgerSignTransactionResponse,\n  LedgerSignTypedDataParams,\n  LedgerSignTypedDataResponse,\n} from './ledger-bridge';\nimport { MetaMaskLedgerHwAppEth } from './ledger-hw-app';\nimport { TransportMiddleware } from './ledger-transport-middleware';\nimport {\n  GetAppNameAndVersionResponse,\n  LedgerMobileBridgeOptions,\n} from './type';\n\n// MobileBridge Type will always use LedgerBridge with LedgerMobileBridgeOptions\nexport type MobileBridge = LedgerBridge<LedgerMobileBridgeOptions> & {\n  getAppNameAndVersion(): Promise<GetAppNameAndVersionResponse>;\n  openEthApp(): Promise<void>;\n  closeApps(): Promise<void>;\n};\n\n/**\n * LedgerMobileBridge is a bridge between the LedgerKeyring and the LedgerTransportMiddleware.\n */\nexport class LedgerMobileBridge implements MobileBridge {\n  #transportMiddleware?: TransportMiddleware;\n\n  #opts: LedgerMobileBridgeOptions;\n\n  isDeviceConnected = false;\n\n  constructor(\n    transportMiddleware: TransportMiddleware,\n    opts: LedgerMobileBridgeOptions = {},\n  ) {\n    this.#opts = opts;\n    this.#transportMiddleware = transportMiddleware;\n  }\n\n  /**\n   * Method to initializes the keyring.\n   * Mobile ledger doesnt not require init.\n   */\n  async init(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Method to destroy the keyring.\n   * It will dispose the transportmiddleware and set isDeviceConnected to false.\n   */\n  async destroy(): Promise<void> {\n    try {\n      await this.#getTransportMiddleWare().dispose();\n    } catch (error) {\n      // eslint-disable-next-line no-console\n      console.error(error);\n    }\n    this.isDeviceConnected = false;\n  }\n\n  /**\n   * Method to sign a string Message.\n   * Sending the string message to the device and returning the signed message.\n   *\n   * @param params - An object contains hdPath and message.\n   * @param params.hdPath - The BIP 32 path of the account.\n   * @param params.message - The message to sign.\n   * @returns Retrieve v, r, s from the signed message.\n   */\n  async deviceSignMessage({\n    hdPath,\n    message,\n  }: LedgerSignMessageParams): Promise<LedgerSignMessageResponse> {\n    return this.#getEthApp().signPersonalMessage(hdPath, message);\n  }\n\n  /**\n   * Method to sign a EIP712 Message.\n   * Sending the typed data message to the device and returning the signed message.\n   *\n   * @param params - An object contains hdPath, domainSeparatorHex and hashStructMessageHex.\n   * @param params.hdPath - The BIP 32 path of the account.\n   * @param params.domainSeparatorHex - The domain separator.\n   * @param params.hashStructMessageHex - The hashed struct message.\n   * @returns Retrieve v, r, s from the signed message.\n   */\n  async deviceSignTypedData({\n    hdPath,\n    domainSeparatorHex,\n    hashStructMessageHex,\n  }: LedgerSignTypedDataParams): Promise<LedgerSignTypedDataResponse> {\n    return this.#getEthApp().signEIP712HashedMessage(\n      hdPath,\n      domainSeparatorHex,\n      hashStructMessageHex,\n    );\n  }\n\n  /**\n   * Method to sign a transaction\n   * Sending the hexadecimal transaction message to the device and returning the signed transaction.\n   *\n   * @param params - An object contains tx, hdPath.\n   * @param params.tx - The raw ethereum transaction in hexadecimal to sign.\n   * @param params.hdPath - The BIP 32 path of the account.\n   * @returns Retrieve v, r, s from the signed transaction.\n   */\n  async deviceSignTransaction({\n    tx,\n    hdPath,\n  }: LedgerSignTransactionParams): Promise<LedgerSignTransactionResponse> {\n    const resolution = await ledgerService.resolveTransaction(tx, {}, {});\n    return this.#getEthApp().signTransaction(hdPath, tx, resolution);\n  }\n\n  /**\n   * Method to retrieve the ethereum address for a given BIP 32 path.\n   *\n   * @param params - An object contains hdPath.\n   * @param params.hdPath - The BIP 32 path of the account.\n   * @returns An object contains publicKey, address and chainCode.\n   */\n  async getPublicKey({\n    hdPath,\n  }: GetPublicKeyParams): Promise<GetPublicKeyResponse> {\n    return await this.#getEthApp().getAddress(hdPath, false, true);\n  }\n\n  /**\n   * Method to retrieve the current configuration.\n   *\n   * @returns Retrieve current configuration.\n   */\n  async getOptions(): Promise<LedgerMobileBridgeOptions> {\n    return this.#opts;\n  }\n\n  /**\n   * Method to set the current configuration.\n   *\n   * @param opts - An configuration object.\n   */\n  async setOptions(opts: LedgerMobileBridgeOptions): Promise<void> {\n    this.#opts = opts;\n  }\n\n  /**\n   * Method to set the transport object to communicate with the device.\n   *\n   * @param transport - The communication interface with the Ledger hardware wallet. There are different kind of transports based on the technology (channels like U2F, HID, Bluetooth, Webusb).\n   * @returns Retrieve boolean.\n   */\n  async updateTransportMethod(transport: Transport): Promise<boolean> {\n    if (!transport.deviceModel) {\n      throw new Error('Property `deviceModel` is not defined in `transport`.');\n    }\n    if (!transport.deviceModel.id) {\n      throw new Error(\n        'Property `deviceModel.id` is not defined in `transport`.',\n      );\n    }\n    this.#getTransportMiddleWare().setTransport(transport);\n    this.isDeviceConnected = true;\n    return Promise.resolve(true);\n  }\n\n  /**\n   * Method to init eth app object on ledger device.\n   * This method is not supported on mobile.\n   */\n  async attemptMakeApp(): Promise<boolean> {\n    throw new Error('Method not supported.');\n  }\n\n  /**\n   * Method to open ethereum application on ledger device.\n   *\n   */\n  async openEthApp(): Promise<void> {\n    await this.#getEthApp().openEthApp();\n  }\n\n  /**\n   * Method to close all running application on ledger device.\n   *\n   */\n  async closeApps(): Promise<void> {\n    await this.#getEthApp().closeApps();\n  }\n\n  /**\n   * Method to retrieve the name and version of the running application in ledger device.\n   *\n   * @returns An object contains appName and version.\n   */\n  async getAppNameAndVersion(): Promise<GetAppNameAndVersionResponse> {\n    return this.#getEthApp().getAppNameAndVersion();\n  }\n\n  /**\n   * Method to retrieve the transport middleWare object.\n   *\n   * @returns The TransportMiddleware object.\n   */\n  #getTransportMiddleWare(): TransportMiddleware {\n    if (this.#transportMiddleware) {\n      return this.#transportMiddleware;\n    }\n    throw new Error('Instance `transportMiddleware` is not initialized.');\n  }\n\n  /**\n   * Method to retrieve the ledger Eth App object.\n   *\n   * @returns The ledger Eth App object.\n   */\n  #getEthApp(): MetaMaskLedgerHwAppEth {\n    return this.#getTransportMiddleWare().getEthApp();\n  }\n}\n"]}

package/dist/ledger-transport-middleware.d.ts

@@ -0,0 +1,39 @@
+import type Transport from '@ledgerhq/hw-transport';
+import { MetaMaskLedgerHwAppEth } from './ledger-hw-app';
+export interface TransportMiddleware {
+    setTransport(transport: Transport): void;
+    getTransport(): Transport;
+    getEthApp(): MetaMaskLedgerHwAppEth;
+    dispose(): Promise<void>;
+}
+/**
+ * LedgerTransportMiddleware is a middleware to communicate with the Ledger device via transport or LedgerHwAppEth
+ */
+export declare class LedgerTransportMiddleware implements TransportMiddleware {
+    #private;
+    readonly mainAppName = "BOLOS";
+    readonly ethAppName = "Ethereum";
+    readonly transportEncoding = "ascii";
+    /**
+     * Method to close the transport connection.
+     */
+    dispose(): Promise<void>;
+    /**
+     * Method to set the transport object.
+     *
+     * @param transport - The transport object for communicating with a Ledger hardware wallet.
+     */
+    setTransport(transport: Transport): void;
+    /**
+     * Method to retrieve the transport object.
+     *
+     * @returns An generic interface for communicating with a Ledger hardware wallet.
+     */
+    getTransport(): Transport;
+    /**
+     * Method to get a new instance of the eth app object.
+     *
+     * @returns An generic interface for communicating with a Ledger hardware wallet to perform operation.
+     */
+    getEthApp(): MetaMaskLedgerHwAppEth;
+}

package/dist/ledger-transport-middleware.js

@@ -0,0 +1,64 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _LedgerTransportMiddleware_transport;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LedgerTransportMiddleware = void 0;
+const ledger_hw_app_1 = require("./ledger-hw-app");
+/**
+ * LedgerTransportMiddleware is a middleware to communicate with the Ledger device via transport or LedgerHwAppEth
+ */
+class LedgerTransportMiddleware {
+    constructor() {
+        this.mainAppName = 'BOLOS';
+        this.ethAppName = 'Ethereum';
+        this.transportEncoding = 'ascii';
+        _LedgerTransportMiddleware_transport.set(this, void 0);
+    }
+    /**
+     * Method to close the transport connection.
+     */
+    async dispose() {
+        const transport = this.getTransport();
+        await transport.close();
+    }
+    /**
+     * Method to set the transport object.
+     *
+     * @param transport - The transport object for communicating with a Ledger hardware wallet.
+     */
+    setTransport(transport) {
+        __classPrivateFieldSet(this, _LedgerTransportMiddleware_transport, transport, "f");
+    }
+    /**
+     * Method to retrieve the transport object.
+     *
+     * @returns An generic interface for communicating with a Ledger hardware wallet.
+     */
+    getTransport() {
+        if (!__classPrivateFieldGet(this, _LedgerTransportMiddleware_transport, "f")) {
+            throw new Error('Instance `transport` is not initialized.');
+        }
+        return __classPrivateFieldGet(this, _LedgerTransportMiddleware_transport, "f");
+    }
+    /**
+     * Method to get a new instance of the eth app object.
+     *
+     * @returns An generic interface for communicating with a Ledger hardware wallet to perform operation.
+     */
+    getEthApp() {
+        return new ledger_hw_app_1.MetaMaskLedgerHwAppEth(this.getTransport());
+    }
+}
+exports.LedgerTransportMiddleware = LedgerTransportMiddleware;
+_LedgerTransportMiddleware_transport = new WeakMap();
+//# sourceMappingURL=ledger-transport-middleware.js.map

package/dist/ledger-transport-middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ledger-transport-middleware.js","sourceRoot":"","sources":["../src/ledger-transport-middleware.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,mDAAyD;AAUzD;;GAEG;AACH,MAAa,yBAAyB;IAAtC;QACW,gBAAW,GAAG,OAAO,CAAC;QAEtB,eAAU,GAAG,UAAU,CAAC;QAExB,sBAAiB,GAAG,OAAO,CAAC;QAErC,uDAAuB;IAuCzB,CAAC;IArCC;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACtC,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,SAAoB;QAC/B,uBAAA,IAAI,wCAAc,SAAS,MAAA,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,YAAY;QACV,IAAI,CAAC,uBAAA,IAAI,4CAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;SAC7D;QACD,OAAO,uBAAA,IAAI,4CAAW,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,SAAS;QACP,OAAO,IAAI,sCAAsB,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACzD,CAAC;CACF;AA9CD,8DA8CC","sourcesContent":["import type Transport from '@ledgerhq/hw-transport';\n\nimport { MetaMaskLedgerHwAppEth } from './ledger-hw-app';\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface TransportMiddleware {\n  setTransport(transport: Transport): void;\n  getTransport(): Transport;\n  getEthApp(): MetaMaskLedgerHwAppEth;\n  dispose(): Promise<void>;\n}\n\n/**\n * LedgerTransportMiddleware is a middleware to communicate with the Ledger device via transport or LedgerHwAppEth\n */\nexport class LedgerTransportMiddleware implements TransportMiddleware {\n  readonly mainAppName = 'BOLOS';\n\n  readonly ethAppName = 'Ethereum';\n\n  readonly transportEncoding = 'ascii';\n\n  #transport?: Transport;\n\n  /**\n   * Method to close the transport connection.\n   */\n  async dispose(): Promise<void> {\n    const transport = this.getTransport();\n    await transport.close();\n  }\n\n  /**\n   * Method to set the transport object.\n   *\n   * @param transport - The transport object for communicating with a Ledger hardware wallet.\n   */\n  setTransport(transport: Transport): void {\n    this.#transport = transport;\n  }\n\n  /**\n   * Method to retrieve the transport object.\n   *\n   * @returns An generic interface for communicating with a Ledger hardware wallet.\n   */\n  getTransport(): Transport {\n    if (!this.#transport) {\n      throw new Error('Instance `transport` is not initialized.');\n    }\n    return this.#transport;\n  }\n\n  /**\n   * Method to get a new instance of the eth app object.\n   *\n   * @returns An generic interface for communicating with a Ledger hardware wallet to perform operation.\n   */\n  getEthApp(): MetaMaskLedgerHwAppEth {\n    return new MetaMaskLedgerHwAppEth(this.getTransport());\n  }\n}\n"]}

package/dist/type.d.ts

@@ -0,0 +1,5 @@
+export declare type GetAppNameAndVersionResponse = {
+    appName: string;
+    version: string;
+};
+export declare type LedgerMobileBridgeOptions = Record<string, never>;

package/dist/type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=type.js.map

package/dist/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../src/type.ts"],"names":[],"mappings":"","sourcesContent":["export type GetAppNameAndVersionResponse = {\n  appName: string;\n  version: string;\n};\n\nexport type LedgerMobileBridgeOptions = Record<string, never>;\n"]}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@metamask-previews/eth-ledger-bridge-keyring",
+  "version": "4.1.1-672cc7b",
+  "description": "A MetaMask compatible keyring, for ledger hardware wallets",
+  "keywords": [
+    "ethereum",
+    "keyring",
+    "ledger",
+    "metamask"
+  ],
+  "homepage": "https://github.com/MetaMask/eth-ledger-bridge-keyring#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/eth-ledger-bridge-keyring/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/eth-ledger-bridge-keyring.git"
+  },
+  "license": "ISC",
+  "author": "Bruno Barbieri",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json",
+    "build:clean": "rimraf dist && yarn build",
+    "build:docs": "typedoc",
+    "build:force": "tsc --build tsconfig.build.json --force",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/eth-ledger-bridge-keyring",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/eth-ledger-bridge-keyring",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "jest && jest-it-up",
+    "test:clean": "jest --clearCache",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@ethereumjs/rlp": "^4.0.0",
+    "@ethereumjs/tx": "^4.2.0",
+    "@ethereumjs/util": "^8.0.0",
+    "@ledgerhq/hw-app-eth": "6.26.1",
+    "@metamask/eth-sig-util": "^7.0.1",
+    "deepmerge": "^4.2.2",
+    "hdkey": "^2.1.0"
+  },
+  "devDependencies": {
+    "@ethereumjs/common": "^3.2.0",
+    "@lavamoat/allow-scripts": "^2.5.1",
+    "@ledgerhq/hw-transport": "^6.24.1",
+    "@ledgerhq/types-cryptoassets": "^7.6.0",
+    "@ledgerhq/types-devices": "^6.22.4",
+    "@metamask/auto-changelog": "^3.1.0",
+    "@metamask/utils": "^8.2.0",
+    "@types/ethereumjs-tx": "^1.0.1",
+    "@types/hdkey": "^2.0.1",
+    "@types/jest": "^28.1.6",
+    "@types/node": "^16.18.59",
+    "@types/web": "^0.0.69",
+    "depcheck": "^1.4.3",
+    "ethereumjs-tx": "^1.3.4",
+    "jest": "^28.1.3",
+    "jest-it-up": "^2.2.0",
+    "rimraf": "^4.1.2",
+    "ts-jest": "^28.0.7",
+    "ts-node": "^10.7.0",
+    "typedoc": "^0.23.15",
+    "typescript": "~4.8.4"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "lavamoat": {
+    "allowScripts": {
+      "@lavamoat/preinstall-always-fail": false,
+      "@ledgerhq/hw-app-eth>@ledgerhq/domain-service>eip55>keccak": false,
+      "ethereumjs-tx>ethereumjs-util>keccak": false,
+      "ethereumjs-tx>ethereumjs-util>secp256k1": false,
+      "hdkey>secp256k1": false,
+      "ethereumjs-tx>ethereumjs-util>ethereum-cryptography>keccak": false
+    }
+  }
+}