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

package/dist/ledger-iframe-bridge.js

@@ -0,0 +1,174 @@
+"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 __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 _LedgerIframeBridge_instances, _LedgerIframeBridge_opts, _LedgerIframeBridge_deviceActionMessage, _LedgerIframeBridge_setupIframe, _LedgerIframeBridge_getOrigin, _LedgerIframeBridge_eventListener, _LedgerIframeBridge_sendMessage, _LedgerIframeBridge_validateConfiguration;
+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(opts = {
+        bridgeUrl: 'https://metamask.github.io/eth-ledger-bridge-keyring',
+    }) {
+        _LedgerIframeBridge_instances.add(this);
+        this.iframeLoaded = false;
+        _LedgerIframeBridge_opts.set(this, void 0);
+        this.isDeviceConnected = false;
+        this.currentMessageId = 0;
+        this.messageCallbacks = {};
+        __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_validateConfiguration).call(this, opts);
+        __classPrivateFieldSet(this, _LedgerIframeBridge_opts, {
+            bridgeUrl: opts?.bridgeUrl,
+        }, "f");
+    }
+    async init() {
+        await __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_setupIframe).call(this, __classPrivateFieldGet(this, _LedgerIframeBridge_opts, "f").bridgeUrl);
+        this.eventListener = __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_eventListener).bind(this, __classPrivateFieldGet(this, _LedgerIframeBridge_opts, "f").bridgeUrl);
+        window.addEventListener('message', this.eventListener);
+    }
+    async destroy() {
+        if (this.eventListener) {
+            window.removeEventListener('message', this.eventListener);
+        }
+    }
+    async getOptions() {
+        return __classPrivateFieldGet(this, _LedgerIframeBridge_opts, "f");
+    }
+    async setOptions(opts) {
+        __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_validateConfiguration).call(this, opts);
+        if (__classPrivateFieldGet(this, _LedgerIframeBridge_opts, "f")?.bridgeUrl !== opts.bridgeUrl) {
+            __classPrivateFieldGet(this, _LedgerIframeBridge_opts, "f").bridgeUrl = opts.bridgeUrl;
+            await this.destroy();
+            await this.init();
+        }
+    }
+    async attemptMakeApp() {
+        return new Promise((resolve, reject) => {
+            __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_sendMessage).call(this, {
+                action: IFrameMessageAction.LedgerMakeApp,
+            }, (response) => {
+                if ('success' in response && response.success) {
+                    resolve(true);
+                }
+                else if ('error' in response) {
+                    reject(response.error);
+                }
+                else {
+                    reject(new Error('Unknown error occurred'));
+                }
+            });
+        });
+    }
+    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) {
+                throw new Error('The iframe is not loaded yet');
+            }
+            __classPrivateFieldGet(this, _LedgerIframeBridge_instances, "m", _LedgerIframeBridge_sendMessage).call(this, {
+                action: IFrameMessageAction.LedgerUpdateTransport,
+                params: { transportType },
+            }, (response) => {
+                if ('success' in response && response.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_opts = new WeakMap(), _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,
+        }, (response) => {
+            if ('payload' in response && response.payload) {
+                if ('success' in response && response.success) {
+                    return resolve(response.payload);
+                }
+                if ('error' in response.payload) {
+                    return reject(response.payload.error);
+                }
+            }
+            return reject(new Error('Unknown error occurred'));
+        });
+    });
+}, _LedgerIframeBridge_setupIframe = async function _LedgerIframeBridge_setupIframe(bridgeUrl) {
+    return new Promise((resolve) => {
+        this.iframe = document.createElement('iframe');
+        this.iframe.src = bridgeUrl;
+        this.iframe.allow = `hid 'src'`;
+        this.iframe.onload = async () => {
+            this.iframeLoaded = true;
+            resolve();
+        };
+        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 = {
+        ...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, '*');
+}, _LedgerIframeBridge_validateConfiguration = function _LedgerIframeBridge_validateConfiguration(opts) {
+    if (typeof opts.bridgeUrl !== 'string' || opts.bridgeUrl.length === 0) {
+        throw new Error('bridgeURL is not a valid URL');
+    }
+};
+//# 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;AAqED,MAAa,kBAAkB;IAqB7B,YACE,OAAkC;QAChC,SAAS,EAAE,sDAAsD;KAClE;;QAnBH,iBAAY,GAAG,KAAK,CAAC;QAErB,2CAAiC;QAOjC,sBAAiB,GAAG,KAAK,CAAC;QAE1B,qBAAgB,GAAG,CAAC,CAAC;QAErB,qBAAgB,GACd,EAAE,CAAC;QAOH,uBAAA,IAAI,gFAAuB,MAA3B,IAAI,EAAwB,IAAI,CAAC,CAAC;QAClC,uBAAA,IAAI,4BAAS;YACX,SAAS,EAAE,IAAI,EAAE,SAAS;SAC3B,MAAA,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,uBAAA,IAAI,sEAAa,MAAjB,IAAI,EAAc,uBAAA,IAAI,gCAAM,CAAC,SAAS,CAAC,CAAC;QAE9C,IAAI,CAAC,aAAa,GAAG,uBAAA,IAAI,wEAAe,CAAC,IAAI,CAAC,IAAI,EAAE,uBAAA,IAAI,gCAAM,CAAC,SAAS,CAAC,CAAC;QAE1E,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,UAAU;QACd,OAAO,uBAAA,IAAI,gCAAM,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAA+B;QAC9C,uBAAA,IAAI,gFAAuB,MAA3B,IAAI,EAAwB,IAAI,CAAC,CAAC;QAClC,IAAI,uBAAA,IAAI,gCAAM,EAAE,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;YAC5C,uBAAA,IAAI,gCAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;YACtC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACrB,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;SACnB;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,SAAS,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,EAAE;oBAC7C,OAAO,CAAC,IAAI,CAAC,CAAC;iBACf;qBAAM,IAAI,OAAO,IAAI,QAAQ,EAAE;oBAC9B,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;iBACxB;qBAAM;oBACL,MAAM,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC;iBAC7C;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,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aACjD;YAED,uBAAA,IAAI,sEAAa,MAAjB,IAAI,EACF;gBACE,MAAM,EAAE,mBAAmB,CAAC,qBAAqB;gBACjD,MAAM,EAAE,EAAE,aAAa,EAAE;aAC1B,EACD,CAAC,QAAQ,EAAE,EAAE;gBACX,IAAI,SAAS,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,EAAE;oBAC7C,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;CAuHF;AA3PD,gDA2PC;mIAjGC,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,QAAQ,EAAE,EAAE;YACX,IAAI,SAAS,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,EAAE;gBAC7C,IAAI,SAAS,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,EAAE;oBAC7C,OAAO,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;iBAClC;gBACD,IAAI,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE;oBAC/B,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;iBACvC;aACF;YACD,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC;QACrD,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,oCAED,KAAK,0CAAc,SAAiB;IAClC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,IAAI,EAAE;YAC9B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;YACzB,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,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,QAAmD;IAEnD,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;IAE3B,MAAM,OAAO,GAA+B;QAC1C,GAAG,OAAO;QACV,SAAS,EAAE,IAAI,CAAC,gBAAgB;QAChC,MAAM,EAAE,gBAAgB;KACzB,CAAC;IAEF,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,QAAQ,CAAC;IAExD,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,iGAEsB,IAA+B;IACpD,IAAI,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QACrE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KACjD;AACH,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 IFrameMessageResponseStub<\n  SuccessResult extends Record<string, unknown>,\n  FailureResult = Error,\n> = {\n  messageId: number;\n} & (\n  | { success: true; payload: SuccessResult }\n  | { success: false; payload: { error: FailureResult } }\n);\n\ntype LedgerConnectionChangeActionResponse = {\n  messageId: number;\n  action: IFrameMessageAction.LedgerConnectionChange;\n  payload: { connected: boolean };\n};\n\ntype LedgerMakeAppActionResponse = {\n  messageId: number;\n  action: IFrameMessageAction.LedgerMakeApp;\n} & ({ success: true } | { success: false; error?: unknown });\n\ntype LedgerUpdateTransportActionResponse = {\n  messageId: number;\n  action: IFrameMessageAction.LedgerUpdateTransport;\n  success: boolean;\n};\n\ntype LedgerUnlockActionResponse = {\n  action: IFrameMessageAction.LedgerUnlock;\n} & IFrameMessageResponseStub<GetPublicKeyResponse>;\n\ntype LedgerSignTransactionActionResponse = {\n  action: IFrameMessageAction.LedgerSignTransaction;\n} & IFrameMessageResponseStub<LedgerSignTransactionResponse>;\n\ntype LedgerSignPersonalMessageActionResponse = {\n  action: IFrameMessageAction.LedgerSignPersonalMessage;\n} & IFrameMessageResponseStub<LedgerSignMessageResponse>;\n\ntype LedgerSignTypedDataActionResponse = {\n  action: IFrameMessageAction.LedgerSignTypedData;\n} & IFrameMessageResponseStub<LedgerSignTypedDataResponse>;\n\nexport type IFrameMessageResponse =\n  | LedgerConnectionChangeActionResponse\n  | LedgerMakeAppActionResponse\n  | LedgerUpdateTransportActionResponse\n  | LedgerUnlockActionResponse\n  | LedgerSignTransactionActionResponse\n  | LedgerSignPersonalMessageActionResponse\n  | LedgerSignTypedDataActionResponse;\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 type LedgerIframeBridgeOptions = {\n  bridgeUrl: string;\n};\n\nexport class LedgerIframeBridge\n  implements LedgerBridge<LedgerIframeBridgeOptions>\n{\n  iframe?: HTMLIFrameElement;\n\n  iframeLoaded = false;\n\n  #opts: LedgerIframeBridgeOptions;\n\n  eventListener?: (eventMessage: {\n    origin: string;\n    data: IFrameMessageResponse;\n  }) => void;\n\n  isDeviceConnected = false;\n\n  currentMessageId = 0;\n\n  messageCallbacks: Record<number, (response: IFrameMessageResponse) => void> =\n    {};\n\n  constructor(\n    opts: LedgerIframeBridgeOptions = {\n      bridgeUrl: 'https://metamask.github.io/eth-ledger-bridge-keyring',\n    },\n  ) {\n    this.#validateConfiguration(opts);\n    this.#opts = {\n      bridgeUrl: opts?.bridgeUrl,\n    };\n  }\n\n  async init() {\n    await this.#setupIframe(this.#opts.bridgeUrl);\n\n    this.eventListener = this.#eventListener.bind(this, this.#opts.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 getOptions(): Promise<LedgerIframeBridgeOptions> {\n    return this.#opts;\n  }\n\n  async setOptions(opts: LedgerIframeBridgeOptions): Promise<void> {\n    this.#validateConfiguration(opts);\n    if (this.#opts?.bridgeUrl !== opts.bridgeUrl) {\n      this.#opts.bridgeUrl = opts.bridgeUrl;\n      await this.destroy();\n      await this.init();\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 ('success' in response && response.success) {\n            resolve(true);\n          } else if ('error' in response) {\n            reject(response.error);\n          } else {\n            reject(new Error('Unknown error occurred'));\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        throw new Error('The iframe is not loaded yet');\n      }\n\n      this.#sendMessage(\n        {\n          action: IFrameMessageAction.LedgerUpdateTransport,\n          params: { transportType },\n        },\n        (response) => {\n          if ('success' in response && response.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        (response) => {\n          if ('payload' in response && response.payload) {\n            if ('success' in response && response.success) {\n              return resolve(response.payload);\n            }\n            if ('error' in response.payload) {\n              return reject(response.payload.error);\n            }\n          }\n          return reject(new Error('Unknown error occurred'));\n        },\n      );\n    });\n  }\n\n  async #setupIframe(bridgeUrl: string): Promise<void> {\n    return new Promise((resolve) => {\n      this.iframe = document.createElement('iframe');\n      this.iframe.src = bridgeUrl;\n      this.iframe.allow = `hid 'src'`;\n      this.iframe.onload = async () => {\n        this.iframeLoaded = true;\n        resolve();\n      };\n      document.head.appendChild(this.iframe);\n    });\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;\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) => 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;\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  #validateConfiguration(opts: LedgerIframeBridgeOptions): void {\n    if (typeof opts.bridgeUrl !== 'string' || opts.bridgeUrl.length === 0) {\n      throw new Error('bridgeURL is not a valid URL');\n    }\n  }\n}\n"]}

package/dist/ledger-keyring.d.ts

@@ -0,0 +1,94 @@
+/// <reference types="node" />
+import { TypedTransaction } from '@ethereumjs/tx';
+import type { MessageTypes, TypedMessage } from '@metamask/eth-sig-util';
+import type OldEthJsTransaction from 'ethereumjs-tx';
+import { EventEmitter } from 'events';
+import HDKey from 'hdkey';
+import { LedgerBridge, LedgerBridgeOptions } from './ledger-bridge';
+declare enum NetworkApiUrls {
+    Ropsten = "https://api-ropsten.etherscan.io",
+    Kovan = "https://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[];
+    deviceId: string;
+    accountDetails: Readonly<Record<string, AccountDetails>>;
+    accountIndexes: Readonly<Record<string, number>>;
+    implementFullBIP44: boolean;
+};
+export declare class LedgerKeyring extends EventEmitter {
+    #private;
+    static type: string;
+    deviceId: 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;
+    bridge: LedgerBridge<LedgerBridgeOptions>;
+    constructor({ bridge }: {
+        bridge: LedgerBridge<LedgerBridgeOptions>;
+    });
+    init(): Promise<void>;
+    destroy(): Promise<void>;
+    serialize(): Promise<{
+        hdPath: string;
+        accounts: readonly string[];
+        deviceId: string;
+        accountDetails: Record<string, AccountDetails>;
+        implementFullBIP44: boolean;
+    }>;
+    deserialize(opts?: Partial<LedgerBridgeKeyringOptions>): Promise<void>;
+    setDeviceId(deviceId: string): void;
+    getDeviceId(): string;
+    isUnlocked(): boolean;
+    isConnected(): boolean;
+    setAccountToUnlock(index: number): void;
+    setHdPath(hdPath: string): void;
+    unlock(hdPath?: string, updateHdk?: boolean): Promise<string>;
+    addAccounts(amount?: number): Promise<string[]>;
+    getName(): 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<T extends MessageTypes>(withAccount: string, data: TypedMessage<T>, options?: {
+        version?: string;
+    }): Promise<string>;
+    exportAccount(): void;
+    forgetDevice(): void;
+}
+export {};