@metamask/eth-ledger-bridge-keyring 0.14.0 → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,81 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0]
+### Changed
+- **BREAKING:** Separate the bridge from the keyring ([#156](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/156))
+  - The Ledger bridge is now a separate class (`LedgerIframeBridge`), which must be constructed separately from the keyring and passed in as a constructor argument.
+  - The bridge initialization has been moved from the keyring constructor to the keyring `init` method. The bridge is expected to be passed to the keyring uninitialized, and the keyring `init` method is expected to be called after keyring construction (before the keyring is used).
+  - The keyring constructor no longer accepts keyring state. Instead, any pre-existing keyring state should be passed to the `deserialize` method after construction.
+- **BREAKING:** Export changed from default to named ([#174](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/174))
+  - The keyring is exported as `LedgerKeyring`
+- Add TypeScript types ([#174](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/174))
+
+## [0.15.0]
+### Changed
+- **BREAKING:** @ethereumjs/tx upgraded to major version 4, which includes a shift from storing numerical values as BNs to storing them as native BigInts. This is a breaking change for users of this keyring who access the values of the tx object, or that use those tx objects to interact with other libraries that depend on @ethereumsjs/tx versions under 4.0.0. ([#181](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/181))
+
+## [0.14.0]
+### Changed
+- **BREAKING:** The minimum version of Node.js required for this package has been bumped to v14. ([#169](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/169))
+
+### Fixed
+- Fix incorrect `v` for EIP-712 signatures and `personal_sign` ([#152](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/152))
+
+## [0.13.0]
+### Added
+- hdk.publicKey and hdk.chainCode should not be updated when unlocking using hdPath for an account.  ([#146](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/146))
+
+## [0.12.0]
+### Added
+- Add a new `destroy` method which will remove the `message` event listener from window.  ([#145](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/145))
+
+## [0.11.0]
+### Added
+- Add a new `isConnected` method which allows determining if the device is last known to be connected.  ([#131](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/131))
+
+### Changed
+- Messaging now runs off of message IDs instead of assuming the response received is from the last message sent, which will not always been true.  ([#132](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/132))
+
+## [0.10.0]
+### Added
+- Add a new `attemptMakeApp` method which allows clients to attempt a creation of the Ledger transport for the purposes of detecting/catching potential connection errors.  ([#126](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/126))
+
+## [0.9.0]
+### Changed
+- `updateTransportMethod` no longer defaults its parameter to false, and now names the param sent with the `'ledger-update-transport'` message `transportType`. This better is to support the use of an enum, instead of a boolean, for specifying transport preferences.  ([#114](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/114))
+
+## [0.8.0]
+### Added
+- Allow ledger-bridge iframe to connect Ledger wia WebHID, when it is supported by the current browser ([#107](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/107))
+
+### Changed
+- Reject with an Error object if unlocking is not successful  ([#104](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/104))
+- Ensure that logs of errors only have a single `Error:` string in the message ([#105](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/105))
+
+## [0.7.0]
+### Changed
+- Remove unused `events` and `ethereumjs-tx` dependencies ([#101](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/101), [#102](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/102))
+- Update eth-ledger-bridge-keyring to support EIP-1559 transactions ([#98](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/98), [#97](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/97), [#96](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/96))
+
+## [0.6.0]
+### Added
+- Support new versions of ethereumjs/tx ([#68](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/68))
+
+[Unreleased]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v0.15.0...v1.0.0
+[0.15.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v0.14.0...v0.15.0
+[0.14.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v0.13.0...v0.14.0
+[0.13.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v0.12.0...v0.13.0
+[0.12.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v0.11.0...v0.12.0
+[0.11.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v0.10.0...v0.11.0
+[0.10.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v0.9.0...v0.10.0
+[0.9.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v0.8.0...v0.9.0
+[0.8.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/MetaMask/eth-ledger-bridge-keyring/releases/tag/v0.6.0

package/README.md

@@ -1,5 +1,4 @@
-eth-ledger-bridge-keyring [![CircleCI](https://circleci.com/gh/MetaMask/eth-ledger-bridge-keyring.svg?style=svg)](https://circleci.com/gh/MetaMask/eth-ledger-bridge-keyring)
-==================
+# eth-ledger-bridge-keyring [![CircleCI](https://circleci.com/gh/MetaMask/eth-ledger-bridge-keyring.svg?style=svg)](https://circleci.com/gh/MetaMask/eth-ledger-bridge-keyring)
 
 An implementation of MetaMask's [Keyring interface](https://github.com/MetaMask/eth-simple-keyring#the-keyring-class-protocol), that uses a Ledger hardware wallet for all cryptographic operations.
 
@@ -16,17 +15,15 @@ device. However there are a number of differences:
 
 - Because extensions have limited access to browser features, there's no easy way to interact wth the Ledger Hardware wallet from the MetaMask extension. This library implements a workaround to those restrictions by injecting (on demand) an iframe to the background page of the extension, (which is hosted [here](https://metamask.github.io/eth-ledger-bridge-keyring/index.html).
 
-The iframe is allowed to interact with the Ledger device (since U2F requires SSL and the iframe is hosted under https) using the libraries from [LedgerJS](https://github.com/LedgerHQ/ledgerjs) *hw-app-eth* and *hw-transport-u2f* and establishes a two-way communication channel with the extension via postMessage.
+The iframe is allowed to interact with the Ledger device (since U2F requires SSL and the iframe is hosted under https) using the libraries from [LedgerJS](https://github.com/LedgerHQ/ledgerjs) _hw-app-eth_ and _hw-transport-u2f_ and establishes a two-way communication channel with the extension via postMessage.
 
 The iframe code it's hosted in the same repo under the branch [gh-pages](https://github.com/MetaMask/eth-ledger-bridge-keyring/tree/gh-pages) and it's being served via github pages. In the future we might move it under the metamask.io domain.
 
-Usage
------
+## Usage
 
 In addition to all the known methods from the [Keyring class protocol](https://github.com/MetaMask/eth-simple-keyring#the-keyring-class-protocol),
 there are a few others:
 
-
 - **isUnlocked** : Returns true if we have the public key in memory, which allows to generate the list of accounts at any time
 
 - **unlock** : Connects to the Ledger device and exports the extended public key, which is later used to read the available ethereum addresses inside the Ledger account.
@@ -41,16 +38,12 @@ there are a few others:
 
 - **forgetDevice** : removes all the device info from memory so the next interaction with the keyring will prompt the user to connect the Ledger device and export the account information
 
-Testing
--------
-Run the following command:
+## Testing and Linting
 
-```bash
-yarn test
-```
+Run `yarn test` to run the tests once. To run tests on file changes, run `yarn test:watch`.
 
+Run `yarn lint` to run the linter, or run `yarn lint:fix` to run the linter and fix any automatically fixable issues.
 
+## Attributions
 
-Attributions
--------
 This code was inspired by [eth-ledger-keyring](https://github.com/jamespic/eth-ledger-keyring) and [eth-hd-keyring](https://github.com/MetaMask/eth-hd-keyring)

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ledger-keyring';
+export * from './ledger-iframe-bridge';
+export * from './ledger-bridge';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ledger-keyring"), exports);
+__exportStar(require("./ledger-iframe-bridge"), exports);
+__exportStar(require("./ledger-bridge"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,yDAAuC;AACvC,kDAAgC","sourcesContent":["export * from './ledger-keyring';\nexport * from './ledger-iframe-bridge';\nexport * from './ledger-bridge';\n"]}

package/dist/ledger-bridge.d.ts

@@ -0,0 +1,34 @@
+import type LedgerHwAppEth from '@ledgerhq/hw-app-eth';
+export declare type GetPublicKeyParams = {
+    hdPath: string;
+};
+export declare type GetPublicKeyResponse = Awaited<ReturnType<LedgerHwAppEth['getAddress']>> & {
+    chainCode: string;
+};
+export declare type LedgerSignTransactionParams = {
+    hdPath: string;
+    tx: string;
+};
+export declare type LedgerSignTransactionResponse = Awaited<ReturnType<LedgerHwAppEth['signTransaction']>>;
+export declare type LedgerSignMessageParams = {
+    hdPath: string;
+    message: string;
+};
+export declare type LedgerSignMessageResponse = Awaited<ReturnType<LedgerHwAppEth['signPersonalMessage']>>;
+export declare type LedgerSignTypedDataParams = {
+    hdPath: string;
+    domainSeparatorHex: string;
+    hashStructMessageHex: string;
+};
+export declare type LedgerSignTypedDataResponse = Awaited<ReturnType<LedgerHwAppEth['signEIP712HashedMessage']>>;
+export interface LedgerBridge {
+    isDeviceConnected: boolean;
+    init(bridgeUrl: string): Promise<void>;
+    destroy(): Promise<void>;
+    attemptMakeApp(): Promise<boolean>;
+    updateTransportMethod(transportType: string): Promise<boolean>;
+    getPublicKey(params: GetPublicKeyParams): Promise<GetPublicKeyResponse>;
+    deviceSignTransaction(params: LedgerSignTransactionParams): Promise<LedgerSignTransactionResponse>;
+    deviceSignMessage(params: LedgerSignMessageParams): Promise<LedgerSignMessageResponse>;
+    deviceSignTypedData(params: LedgerSignTypedDataParams): Promise<LedgerSignTypedDataResponse>;
+}

package/dist/ledger-bridge.js

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

package/dist/ledger-bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ledger-bridge.js","sourceRoot":"","sources":["../src/ledger-bridge.ts"],"names":[],"mappings":"","sourcesContent":["import type LedgerHwAppEth from '@ledgerhq/hw-app-eth';\n\nexport type GetPublicKeyParams = { hdPath: string };\nexport type GetPublicKeyResponse = Awaited<\n  ReturnType<LedgerHwAppEth['getAddress']>\n> & {\n  chainCode: string;\n};\n\nexport type LedgerSignTransactionParams = { hdPath: string; tx: string };\nexport type LedgerSignTransactionResponse = Awaited<\n  ReturnType<LedgerHwAppEth['signTransaction']>\n>;\n\nexport type LedgerSignMessageParams = { hdPath: string; message: string };\nexport type LedgerSignMessageResponse = Awaited<\n  ReturnType<LedgerHwAppEth['signPersonalMessage']>\n>;\n\nexport type LedgerSignTypedDataParams = {\n  hdPath: string;\n  domainSeparatorHex: string;\n  hashStructMessageHex: string;\n};\nexport type LedgerSignTypedDataResponse = Awaited<\n  ReturnType<LedgerHwAppEth['signEIP712HashedMessage']>\n>;\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface LedgerBridge {\n  isDeviceConnected: boolean;\n\n  init(bridgeUrl: string): Promise<void>;\n\n  destroy(): Promise<void>;\n\n  attemptMakeApp(): Promise<boolean>;\n\n  updateTransportMethod(transportType: string): Promise<boolean>;\n\n  getPublicKey(params: GetPublicKeyParams): Promise<GetPublicKeyResponse>;\n\n  deviceSignTransaction(\n    params: LedgerSignTransactionParams,\n  ): Promise<LedgerSignTransactionResponse>;\n\n  deviceSignMessage(\n    params: LedgerSignMessageParams,\n  ): Promise<LedgerSignMessageResponse>;\n\n  deviceSignTypedData(\n    params: LedgerSignTypedDataParams,\n  ): Promise<LedgerSignTypedDataResponse>;\n}\n"]}

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

@@ -0,0 +1,85 @@
+import { GetPublicKeyParams, GetPublicKeyResponse, LedgerBridge, LedgerSignMessageParams, LedgerSignMessageResponse, LedgerSignTransactionParams, LedgerSignTransactionResponse, LedgerSignTypedDataParams, LedgerSignTypedDataResponse } from './ledger-bridge';
+export declare enum IFrameMessageAction {
+    LedgerConnectionChange = "ledger-connection-change",
+    LedgerUnlock = "ledger-unlock",
+    LedgerMakeApp = "ledger-make-app",
+    LedgerUpdateTransport = "ledger-update-transport",
+    LedgerSignTransaction = "ledger-sign-transaction",
+    LedgerSignPersonalMessage = "ledger-sign-personal-message",
+    LedgerSignTypedData = "ledger-sign-typed-data"
+}
+declare type IFrameMessageResponse<TAction extends IFrameMessageAction> = {
+    action: TAction;
+    messageId: number;
+} & ({
+    action: IFrameMessageAction.LedgerConnectionChange;
+    payload: {
+        connected: boolean;
+    };
+} | ({
+    action: IFrameMessageAction.LedgerMakeApp;
+} & ({
+    success: true;
+} | {
+    success: false;
+    error?: unknown;
+})) | {
+    action: IFrameMessageAction.LedgerUpdateTransport;
+    success: boolean;
+} | ({
+    action: IFrameMessageAction.LedgerUnlock;
+} & ({
+    success: true;
+    payload: GetPublicKeyResponse;
+} | {
+    success: false;
+    payload: {
+        error: Error;
+    };
+})) | ({
+    action: IFrameMessageAction.LedgerSignTransaction;
+} & ({
+    success: true;
+    payload: LedgerSignTransactionResponse;
+} | {
+    success: false;
+    payload: {
+        error: Error;
+    };
+})) | ({
+    action: IFrameMessageAction.LedgerSignPersonalMessage | IFrameMessageAction.LedgerSignTypedData;
+} & ({
+    success: true;
+    payload: LedgerSignMessageResponse | LedgerSignTypedDataResponse;
+} | {
+    success: false;
+    payload: {
+        error: Error;
+    };
+})));
+export declare class LedgerIframeBridge implements LedgerBridge {
+    #private;
+    iframe?: HTMLIFrameElement;
+    iframeLoaded: boolean;
+    eventListener?: (eventMessage: {
+        origin: string;
+        data: IFrameMessageResponse<IFrameMessageAction>;
+    }) => void;
+    isDeviceConnected: boolean;
+    currentMessageId: number;
+    messageCallbacks: Record<number, (response: IFrameMessageResponse<IFrameMessageAction>) => void>;
+    delayedPromise?: {
+        resolve: (value: boolean) => void;
+        reject: (error: unknown) => void;
+        transportType: string;
+    };
+    init(bridgeUrl: string): Promise<void>;
+    destroy(): Promise<void>;
+    attemptMakeApp(): Promise<boolean>;
+    updateTransportMethod(transportType: string): Promise<boolean>;
+    getPublicKey(params: GetPublicKeyParams): Promise<GetPublicKeyResponse>;
+    deviceSignTransaction(params: LedgerSignTransactionParams): Promise<LedgerSignTransactionResponse>;
+    deviceSignMessage(params: LedgerSignMessageParams): Promise<LedgerSignMessageResponse>;
+    deviceSignTypedData(params: LedgerSignTypedDataParams): Promise<LedgerSignTypedDataResponse>;
+}
+export {};

package/dist/ledger-iframe-bridge.js

@@ -0,0 +1,150 @@
+"use strict";
+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 _LedgerIframeBridge_instances, _LedgerIframeBridge_deviceActionMessage, _LedgerIframeBridge_setupIframe, _LedgerIframeBridge_getOrigin, _LedgerIframeBridge_eventListener, _LedgerIframeBridge_sendMessage;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LedgerIframeBridge = exports.IFrameMessageAction = void 0;
+const LEDGER_IFRAME_ID = 'LEDGER-IFRAME';
+var IFrameMessageAction;
+(function (IFrameMessageAction) {
+    IFrameMessageAction["LedgerConnectionChange"] = "ledger-connection-change";
+    IFrameMessageAction["LedgerUnlock"] = "ledger-unlock";
+    IFrameMessageAction["LedgerMakeApp"] = "ledger-make-app";
+    IFrameMessageAction["LedgerUpdateTransport"] = "ledger-update-transport";
+    IFrameMessageAction["LedgerSignTransaction"] = "ledger-sign-transaction";
+    IFrameMessageAction["LedgerSignPersonalMessage"] = "ledger-sign-personal-message";
+    IFrameMessageAction["LedgerSignTypedData"] = "ledger-sign-typed-data";
+})(IFrameMessageAction = exports.IFrameMessageAction || (exports.IFrameMessageAction = {}));
+class LedgerIframeBridge {
+    constructor() {
+        _LedgerIframeBridge_instances.add(this);
+        this.iframeLoaded = false;
+        this.isDeviceConnected = false;
+        this.currentMessageId = 0;
+        this.messageCallbacks = {};
+    }
+    async init(bridgeUrl) {
+        __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_setupIframe).call(this, bridgeUrl);
+        this.eventListener = __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_eventListener).bind(this, bridgeUrl);
+        window.addEventListener('message', this.eventListener);
+    }
+    async destroy() {
+        if (this.eventListener) {
+            window.removeEventListener('message', this.eventListener);
+        }
+    }
+    async attemptMakeApp() {
+        return new Promise((resolve, reject) => {
+            __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_sendMessage).call(this, {
+                action: IFrameMessageAction.LedgerMakeApp,
+            }, (response) => {
+                if (response.success) {
+                    resolve(true);
+                }
+                else {
+                    reject(response.error);
+                }
+            });
+        });
+    }
+    async updateTransportMethod(transportType) {
+        return new Promise((resolve, reject) => {
+            // If the iframe isn't loaded yet, let's store the desired transportType value and
+            // optimistically return a successful promise
+            if (!this.iframeLoaded) {
+                this.delayedPromise = {
+                    resolve,
+                    reject,
+                    transportType,
+                };
+                return;
+            }
+            __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_sendMessage).call(this, {
+                action: IFrameMessageAction.LedgerUpdateTransport,
+                params: { transportType },
+            }, ({ success }) => {
+                if (success) {
+                    return resolve(true);
+                }
+                return reject(new Error('Ledger transport could not be updated'));
+            });
+        });
+    }
+    async getPublicKey(params) {
+        return __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_deviceActionMessage).call(this, IFrameMessageAction.LedgerUnlock, params);
+    }
+    async deviceSignTransaction(params) {
+        return __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_deviceActionMessage).call(this, IFrameMessageAction.LedgerSignTransaction, params);
+    }
+    async deviceSignMessage(params) {
+        return __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_deviceActionMessage).call(this, IFrameMessageAction.LedgerSignPersonalMessage, params);
+    }
+    async deviceSignTypedData(params) {
+        return __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_deviceActionMessage).call(this, IFrameMessageAction.LedgerSignTypedData, params);
+    }
+}
+exports.LedgerIframeBridge = LedgerIframeBridge;
+_LedgerIframeBridge_instances = new WeakSet(), _LedgerIframeBridge_deviceActionMessage = async function _LedgerIframeBridge_deviceActionMessage(...[action, params]) {
+    return new Promise((resolve, reject) => {
+        __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_sendMessage).call(this, {
+            action,
+            params,
+        }, ({ success, payload }) => {
+            if (success) {
+                return resolve(payload);
+            }
+            return reject(payload.error);
+        });
+    });
+}, _LedgerIframeBridge_setupIframe = function _LedgerIframeBridge_setupIframe(bridgeUrl) {
+    this.iframe = document.createElement('iframe');
+    this.iframe.src = bridgeUrl;
+    this.iframe.allow = `hid 'src'`;
+    this.iframe.onload = async () => {
+        // If the ledger live preference was set before the iframe is loaded,
+        // set it after the iframe has loaded
+        this.iframeLoaded = true;
+        if (this.delayedPromise) {
+            try {
+                const result = await this.updateTransportMethod(this.delayedPromise.transportType);
+                this.delayedPromise.resolve(result);
+            }
+            catch (error) {
+                this.delayedPromise.reject(error);
+            }
+            finally {
+                delete this.delayedPromise;
+            }
+        }
+    };
+    document.head.appendChild(this.iframe);
+}, _LedgerIframeBridge_getOrigin = function _LedgerIframeBridge_getOrigin(bridgeUrl) {
+    const tmp = bridgeUrl.split('/');
+    tmp.splice(-1, 1);
+    return tmp.join('/');
+}, _LedgerIframeBridge_eventListener = function _LedgerIframeBridge_eventListener(bridgeUrl, eventMessage) {
+    if (eventMessage.origin !== __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_getOrigin).call(this, bridgeUrl)) {
+        return;
+    }
+    if (eventMessage.data) {
+        const messageCallback = this.messageCallbacks[eventMessage.data.messageId];
+        if (messageCallback) {
+            messageCallback(eventMessage.data);
+        }
+        else if (eventMessage.data.action === IFrameMessageAction.LedgerConnectionChange) {
+            this.isDeviceConnected = eventMessage.data.payload.connected;
+        }
+    }
+}, _LedgerIframeBridge_sendMessage = function _LedgerIframeBridge_sendMessage(message, callback) {
+    this.currentMessageId += 1;
+    const postMsg = Object.assign(Object.assign({}, message), { messageId: this.currentMessageId, target: LEDGER_IFRAME_ID });
+    this.messageCallbacks[this.currentMessageId] = callback;
+    if (!this.iframeLoaded || !this.iframe || !this.iframe.contentWindow) {
+        throw new Error('The iframe is not loaded yet');
+    }
+    this.iframe.contentWindow.postMessage(postMsg, '*');
+};
+//# sourceMappingURL=ledger-iframe-bridge.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ledger-iframe-bridge.js","sourceRoot":"","sources":["../src/ledger-iframe-bridge.ts"],"names":[],"mappings":";;;;;;;;;AAYA,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAEzC,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC7B,0EAAmD,CAAA;IACnD,qDAA8B,CAAA;IAC9B,wDAAiC,CAAA;IACjC,wEAAiD,CAAA;IACjD,wEAAiD,CAAA;IACjD,iFAA0D,CAAA;IAC1D,qEAA8C,CAAA;AAChD,CAAC,EARW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAQ9B;AAqDD,MAAa,kBAAkB;IAA/B;;QAGE,iBAAY,GAAG,KAAK,CAAC;QAOrB,sBAAiB,GAAG,KAAK,CAAC;QAE1B,qBAAgB,GAAG,CAAC,CAAC;QAErB,qBAAgB,GAGZ,EAAE,CAAC;IA2NT,CAAC;IAnNC,KAAK,CAAC,IAAI,CAAC,SAAiB;QAC1B,uBAAA,IAAI,sEAAa,MAAjB,IAAI,EAAc,SAAS,CAAC,CAAC;QAE7B,IAAI,CAAC,aAAa,GAAG,uBAAA,IAAI,wEAAe,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAE/D,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;SAC3D;IACH,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,uBAAA,IAAI,sEAAa,MAAjB,IAAI,EACF;gBACE,MAAM,EAAE,mBAAmB,CAAC,aAAa;aAC1C,EACD,CAAC,QAAQ,EAAE,EAAE;gBACX,IAAI,QAAQ,CAAC,OAAO,EAAE;oBACpB,OAAO,CAAC,IAAI,CAAC,CAAC;iBACf;qBAAM;oBACL,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;iBACxB;YACH,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAC,aAAqB;QAC/C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,kFAAkF;YAClF,6CAA6C;YAC7C,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;gBACtB,IAAI,CAAC,cAAc,GAAG;oBACpB,OAAO;oBACP,MAAM;oBACN,aAAa;iBACd,CAAC;gBACF,OAAO;aACR;YAED,uBAAA,IAAI,sEAAa,MAAjB,IAAI,EACF;gBACE,MAAM,EAAE,mBAAmB,CAAC,qBAAqB;gBACjD,MAAM,EAAE,EAAE,aAAa,EAAE;aAC1B,EACD,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;gBACd,IAAI,OAAO,EAAE;oBACX,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;iBACtB;gBACD,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC,CAAC;YACpE,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,MAA0B;QAE1B,OAAO,uBAAA,IAAI,8EAAqB,MAAzB,IAAI,EAAsB,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,qBAAqB,CACzB,MAAmC;QAEnC,OAAO,uBAAA,IAAI,8EAAqB,MAAzB,IAAI,EACT,mBAAmB,CAAC,qBAAqB,EACzC,MAAM,CACP,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,MAA+B;QAE/B,OAAO,uBAAA,IAAI,8EAAqB,MAAzB,IAAI,EACT,mBAAmB,CAAC,yBAAyB,EAC7C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,mBAAmB,CACvB,MAAiC;QAEjC,OAAO,uBAAA,IAAI,8EAAqB,MAAzB,IAAI,EACT,mBAAmB,CAAC,mBAAmB,EACvC,MAAM,CACP,CAAC;IACJ,CAAC;CAyHF;AA5OD,gDA4OC;yFAnGC,KAAK,kDACH,GAAG,CAAC,MAAM,EAAE,MAAM,CAIsD;IAExE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,uBAAA,IAAI,sEAAa,MAAjB,IAAI,EACF;YACE,MAAM;YACN,MAAM;SACP,EACD,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE;YACvB,IAAI,OAAO,EAAE;gBACX,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;aACzB;YACD,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,6EAEY,SAAiB;IAC5B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC/C,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;IAC5B,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,WAAW,CAAC;IAChC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,IAAI,EAAE;QAC9B,qEAAqE;QACrE,qCAAqC;QACrC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAC7C,IAAI,CAAC,cAAc,CAAC,aAAa,CAClC,CAAC;gBACF,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACrC;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aACnC;oBAAS;gBACR,OAAO,IAAI,CAAC,cAAc,CAAC;aAC5B;SACF;IACH,CAAC,CAAC;IACF,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACzC,CAAC,yEAEU,SAAiB;IAC1B,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClB,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC,iFAGC,SAAiB,EACjB,YAGC;IAED,IAAI,YAAY,CAAC,MAAM,KAAK,uBAAA,IAAI,oEAAW,MAAf,IAAI,EAAY,SAAS,CAAC,EAAE;QACtD,OAAO;KACR;IAED,IAAI,YAAY,CAAC,IAAI,EAAE;QACrB,MAAM,eAAe,GACnB,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,eAAe,EAAE;YACnB,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;SACpC;aAAM,IACL,YAAY,CAAC,IAAI,CAAC,MAAM,KAAK,mBAAmB,CAAC,sBAAsB,EACvE;YACA,IAAI,CAAC,iBAAiB,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;SAC9D;KACF;AACH,CAAC,6EAGC,OAA+B,EAC/B,QAA4D;IAE5D,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;IAE3B,MAAM,OAAO,mCACR,OAAO,KACV,SAAS,EAAE,IAAI,CAAC,gBAAgB,EAChC,MAAM,EAAE,gBAAgB,GACzB,CAAC;IAEF,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,QAEtC,CAAC;IAEV,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;QACpE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAED,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACtD,CAAC","sourcesContent":["import {\n  GetPublicKeyParams,\n  GetPublicKeyResponse,\n  LedgerBridge,\n  LedgerSignMessageParams,\n  LedgerSignMessageResponse,\n  LedgerSignTransactionParams,\n  LedgerSignTransactionResponse,\n  LedgerSignTypedDataParams,\n  LedgerSignTypedDataResponse,\n} from './ledger-bridge';\n\nconst LEDGER_IFRAME_ID = 'LEDGER-IFRAME';\n\nexport enum IFrameMessageAction {\n  LedgerConnectionChange = 'ledger-connection-change',\n  LedgerUnlock = 'ledger-unlock',\n  LedgerMakeApp = 'ledger-make-app',\n  LedgerUpdateTransport = 'ledger-update-transport',\n  LedgerSignTransaction = 'ledger-sign-transaction',\n  LedgerSignPersonalMessage = 'ledger-sign-personal-message',\n  LedgerSignTypedData = 'ledger-sign-typed-data',\n}\n\ntype IFrameMessageResponse<TAction extends IFrameMessageAction> = {\n  action: TAction;\n  messageId: number;\n} & (\n  | {\n      action: IFrameMessageAction.LedgerConnectionChange;\n      payload: { connected: boolean };\n    }\n  | ({\n      action: IFrameMessageAction.LedgerMakeApp;\n    } & ({ success: true } | { success: false; error?: unknown }))\n  | {\n      action: IFrameMessageAction.LedgerUpdateTransport;\n      success: boolean;\n    }\n  | ({\n      action: IFrameMessageAction.LedgerUnlock;\n    } & (\n      | { success: true; payload: GetPublicKeyResponse }\n      | { success: false; payload: { error: Error } }\n    ))\n  | ({\n      action: IFrameMessageAction.LedgerSignTransaction;\n    } & (\n      | { success: true; payload: LedgerSignTransactionResponse }\n      | { success: false; payload: { error: Error } }\n    ))\n  | ({\n      action:\n        | IFrameMessageAction.LedgerSignPersonalMessage\n        | IFrameMessageAction.LedgerSignTypedData;\n    } & (\n      | {\n          success: true;\n          payload: LedgerSignMessageResponse | LedgerSignTypedDataResponse;\n        }\n      | { success: false; payload: { error: Error } }\n    ))\n);\n\ntype IFrameMessage<TAction extends IFrameMessageAction> = {\n  action: TAction;\n  params?: Readonly<Record<string, unknown>>;\n};\n\ntype IFramePostMessage<TAction extends IFrameMessageAction> =\n  IFrameMessage<TAction> & {\n    messageId: number;\n    target: typeof LEDGER_IFRAME_ID;\n  };\n\nexport class LedgerIframeBridge implements LedgerBridge {\n  iframe?: HTMLIFrameElement;\n\n  iframeLoaded = false;\n\n  eventListener?: (eventMessage: {\n    origin: string;\n    data: IFrameMessageResponse<IFrameMessageAction>;\n  }) => void;\n\n  isDeviceConnected = false;\n\n  currentMessageId = 0;\n\n  messageCallbacks: Record<\n    number,\n    (response: IFrameMessageResponse<IFrameMessageAction>) => void\n  > = {};\n\n  delayedPromise?: {\n    resolve: (value: boolean) => void;\n    reject: (error: unknown) => void;\n    transportType: string;\n  };\n\n  async init(bridgeUrl: string) {\n    this.#setupIframe(bridgeUrl);\n\n    this.eventListener = this.#eventListener.bind(this, bridgeUrl);\n\n    window.addEventListener('message', this.eventListener);\n  }\n\n  async destroy() {\n    if (this.eventListener) {\n      window.removeEventListener('message', this.eventListener);\n    }\n  }\n\n  async attemptMakeApp(): Promise<boolean> {\n    return new Promise((resolve, reject) => {\n      this.#sendMessage(\n        {\n          action: IFrameMessageAction.LedgerMakeApp,\n        },\n        (response) => {\n          if (response.success) {\n            resolve(true);\n          } else {\n            reject(response.error);\n          }\n        },\n      );\n    });\n  }\n\n  async updateTransportMethod(transportType: string): Promise<boolean> {\n    return new Promise((resolve, reject) => {\n      // If the iframe isn't loaded yet, let's store the desired transportType value and\n      // optimistically return a successful promise\n      if (!this.iframeLoaded) {\n        this.delayedPromise = {\n          resolve,\n          reject,\n          transportType,\n        };\n        return;\n      }\n\n      this.#sendMessage(\n        {\n          action: IFrameMessageAction.LedgerUpdateTransport,\n          params: { transportType },\n        },\n        ({ success }) => {\n          if (success) {\n            return resolve(true);\n          }\n          return reject(new Error('Ledger transport could not be updated'));\n        },\n      );\n    });\n  }\n\n  async getPublicKey(\n    params: GetPublicKeyParams,\n  ): Promise<GetPublicKeyResponse> {\n    return this.#deviceActionMessage(IFrameMessageAction.LedgerUnlock, params);\n  }\n\n  async deviceSignTransaction(\n    params: LedgerSignTransactionParams,\n  ): Promise<LedgerSignTransactionResponse> {\n    return this.#deviceActionMessage(\n      IFrameMessageAction.LedgerSignTransaction,\n      params,\n    );\n  }\n\n  async deviceSignMessage(\n    params: LedgerSignMessageParams,\n  ): Promise<LedgerSignMessageResponse> {\n    return this.#deviceActionMessage(\n      IFrameMessageAction.LedgerSignPersonalMessage,\n      params,\n    );\n  }\n\n  async deviceSignTypedData(\n    params: LedgerSignTypedDataParams,\n  ): Promise<LedgerSignTypedDataResponse> {\n    return this.#deviceActionMessage(\n      IFrameMessageAction.LedgerSignTypedData,\n      params,\n    );\n  }\n\n  async #deviceActionMessage(\n    action: IFrameMessageAction.LedgerUnlock,\n    params: GetPublicKeyParams,\n  ): Promise<GetPublicKeyResponse>;\n\n  async #deviceActionMessage(\n    action: IFrameMessageAction.LedgerSignTransaction,\n    params: LedgerSignTransactionParams,\n  ): Promise<LedgerSignTransactionResponse>;\n\n  async #deviceActionMessage(\n    action: IFrameMessageAction.LedgerSignPersonalMessage,\n    params: LedgerSignMessageParams,\n  ): Promise<LedgerSignMessageResponse>;\n\n  async #deviceActionMessage(\n    action: IFrameMessageAction.LedgerSignTypedData,\n    params: LedgerSignTypedDataParams,\n  ): Promise<LedgerSignTypedDataResponse>;\n\n  async #deviceActionMessage(\n    ...[action, params]:\n      | [IFrameMessageAction.LedgerUnlock, GetPublicKeyParams]\n      | [IFrameMessageAction.LedgerSignTransaction, LedgerSignTransactionParams]\n      | [IFrameMessageAction.LedgerSignPersonalMessage, LedgerSignMessageParams]\n      | [IFrameMessageAction.LedgerSignTypedData, LedgerSignTypedDataParams]\n  ) {\n    return new Promise((resolve, reject) => {\n      this.#sendMessage(\n        {\n          action,\n          params,\n        },\n        ({ success, payload }) => {\n          if (success) {\n            return resolve(payload);\n          }\n          return reject(payload.error);\n        },\n      );\n    });\n  }\n\n  #setupIframe(bridgeUrl: string) {\n    this.iframe = document.createElement('iframe');\n    this.iframe.src = bridgeUrl;\n    this.iframe.allow = `hid 'src'`;\n    this.iframe.onload = async () => {\n      // If the ledger live preference was set before the iframe is loaded,\n      // set it after the iframe has loaded\n      this.iframeLoaded = true;\n      if (this.delayedPromise) {\n        try {\n          const result = await this.updateTransportMethod(\n            this.delayedPromise.transportType,\n          );\n          this.delayedPromise.resolve(result);\n        } catch (error) {\n          this.delayedPromise.reject(error);\n        } finally {\n          delete this.delayedPromise;\n        }\n      }\n    };\n    document.head.appendChild(this.iframe);\n  }\n\n  #getOrigin(bridgeUrl: string) {\n    const tmp = bridgeUrl.split('/');\n    tmp.splice(-1, 1);\n    return tmp.join('/');\n  }\n\n  #eventListener(\n    bridgeUrl: string,\n    eventMessage: {\n      origin: string;\n      data: IFrameMessageResponse<IFrameMessageAction>;\n    },\n  ) {\n    if (eventMessage.origin !== this.#getOrigin(bridgeUrl)) {\n      return;\n    }\n\n    if (eventMessage.data) {\n      const messageCallback =\n        this.messageCallbacks[eventMessage.data.messageId];\n      if (messageCallback) {\n        messageCallback(eventMessage.data);\n      } else if (\n        eventMessage.data.action === IFrameMessageAction.LedgerConnectionChange\n      ) {\n        this.isDeviceConnected = eventMessage.data.payload.connected;\n      }\n    }\n  }\n\n  #sendMessage<TAction extends IFrameMessageAction>(\n    message: IFrameMessage<TAction>,\n    callback: (response: IFrameMessageResponse<TAction>) => void,\n  ) {\n    this.currentMessageId += 1;\n\n    const postMsg: IFramePostMessage<TAction> = {\n      ...message,\n      messageId: this.currentMessageId,\n      target: LEDGER_IFRAME_ID,\n    };\n\n    this.messageCallbacks[this.currentMessageId] = callback as (\n      response: IFrameMessageResponse<IFrameMessageAction>,\n    ) => void;\n\n    if (!this.iframeLoaded || !this.iframe || !this.iframe.contentWindow) {\n      throw new Error('The iframe is not loaded yet');\n    }\n\n    this.iframe.contentWindow.postMessage(postMsg, '*');\n  }\n}\n"]}

package/dist/ledger-keyring.d.ts

@@ -0,0 +1,91 @@
+/// <reference types="node" />
+import { TypedTransaction } from '@ethereumjs/tx';
+import * as sigUtil from 'eth-sig-util';
+import type OldEthJsTransaction from 'ethereumjs-tx';
+import { EventEmitter } from 'events';
+import HDKey from 'hdkey';
+import { LedgerBridge } from './ledger-bridge';
+declare enum NetworkApiUrls {
+    Ropsten = "http://api-ropsten.etherscan.io",
+    Kovan = "http://api-kovan.etherscan.io",
+    Rinkeby = "https://api-rinkeby.etherscan.io",
+    Mainnet = "https://api.etherscan.io"
+}
+export declare type AccountDetails = {
+    index?: number;
+    bip44?: boolean;
+    hdPath?: string;
+};
+export declare type LedgerBridgeKeyringOptions = {
+    hdPath: string;
+    accounts: readonly string[];
+    accountDetails: Readonly<Record<string, AccountDetails>>;
+    accountIndexes: Readonly<Record<string, number>>;
+    bridgeUrl: string;
+    implementFullBIP44: boolean;
+};
+export declare class LedgerKeyring extends EventEmitter {
+    #private;
+    static type: string;
+    readonly type: string;
+    page: number;
+    perPage: number;
+    unlockedAccount: number;
+    accounts: readonly string[];
+    accountDetails: Record<string, AccountDetails>;
+    hdk: HDKey;
+    hdPath: string;
+    paths: Record<string, number>;
+    network: NetworkApiUrls;
+    implementFullBIP44: boolean;
+    bridgeUrl: string;
+    bridge: LedgerBridge;
+    constructor({ bridge }: {
+        bridge: LedgerBridge;
+    });
+    init(): Promise<void>;
+    destroy(): Promise<void>;
+    serialize(): Promise<{
+        hdPath: string;
+        accounts: readonly string[];
+        accountDetails: Record<string, AccountDetails>;
+        bridgeUrl: string;
+        implementFullBIP44: boolean;
+    }>;
+    deserialize(opts?: Partial<LedgerBridgeKeyringOptions>): Promise<void>;
+    isUnlocked(): boolean;
+    isConnected(): boolean;
+    setAccountToUnlock(index: number | string): void;
+    setHdPath(hdPath: string): void;
+    unlock(hdPath?: string, updateHdk?: boolean): Promise<string>;
+    addAccounts(amount?: number): Promise<string[]>;
+    getFirstPage(): Promise<{
+        address: string;
+        balance: number | null;
+        index: number;
+    }[]>;
+    getNextPage(): Promise<{
+        address: string;
+        balance: number | null;
+        index: number;
+    }[]>;
+    getPreviousPage(): Promise<{
+        address: string;
+        balance: number | null;
+        index: number;
+    }[]>;
+    getAccounts(): Promise<string[]>;
+    removeAccount(address: string): void;
+    attemptMakeApp(): Promise<boolean>;
+    updateTransportMethod(transportType: string): Promise<boolean>;
+    signTransaction(address: string, tx: TypedTransaction | OldEthJsTransaction): Promise<TypedTransaction | OldEthJsTransaction>;
+    signMessage(withAccount: string, data: string): Promise<string>;
+    signPersonalMessage(withAccount: string, message: string): Promise<string>;
+    unlockAccountByAddress(address: string): Promise<string | undefined>;
+    signTypedData(withAccount: string, data: sigUtil.EIP712TypedData, options?: {
+        version?: string;
+    }): Promise<string>;
+    exportAccount(): void;
+    forgetDevice(): void;
+}
+export {};