@metamask-previews/message-manager 7.3.0-preview.d32a7cc

package/dist/AbstractMessageManager.js

@@ -0,0 +1,294 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractMessageManager = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const events_1 = require("events");
+/**
+ * Controller in charge of managing - storing, adding, removing, updating - Messages.
+ */
+class AbstractMessageManager extends base_controller_1.BaseController {
+    /**
+     * Creates an AbstractMessageManager instance.
+     *
+     * @param config - Initial options used to configure this controller.
+     * @param state - Initial state to set on this controller.
+     * @param securityProviderRequest - A function for verifying a message, whether it is malicious or not.
+     * @param additionalFinishStatuses - Optional list of statuses that are accepted to emit a finished event.
+     * @param getCurrentChainId - Optional function to get the current chainId.
+     */
+    constructor(config, state, securityProviderRequest, additionalFinishStatuses, getCurrentChainId) {
+        super(config, state);
+        /**
+         * EventEmitter instance used to listen to specific message events
+         */
+        this.hub = new events_1.EventEmitter();
+        /**
+         * Name of this controller used during composition
+         */
+        this.name = 'AbstractMessageManager';
+        this.defaultState = {
+            unapprovedMessages: {},
+            unapprovedMessagesCount: 0,
+        };
+        this.messages = [];
+        this.securityProviderRequest = securityProviderRequest;
+        this.additionalFinishStatuses = additionalFinishStatuses !== null && additionalFinishStatuses !== void 0 ? additionalFinishStatuses : [];
+        this.getCurrentChainId = getCurrentChainId;
+        this.initialize();
+    }
+    /**
+     * Saves the unapproved messages, and their count to state.
+     *
+     * @param emitUpdateBadge - Whether to emit the updateBadge event.
+     */
+    saveMessageList(emitUpdateBadge = true) {
+        const unapprovedMessages = this.getUnapprovedMessages();
+        const unapprovedMessagesCount = this.getUnapprovedMessagesCount();
+        this.update({ unapprovedMessages, unapprovedMessagesCount });
+        if (emitUpdateBadge) {
+            this.hub.emit('updateBadge');
+        }
+    }
+    /**
+     * Updates the status of a Message in this.messages.
+     *
+     * @param messageId - The id of the Message to update.
+     * @param status - The new status of the Message.
+     */
+    setMessageStatus(messageId, status) {
+        const message = this.getMessage(messageId);
+        if (!message) {
+            throw new Error(`${this.name}: Message not found for id: ${messageId}.`);
+        }
+        message.status = status;
+        this.updateMessage(message);
+        this.hub.emit(`${messageId}:${status}`, message);
+        if (status === 'rejected' ||
+            status === 'signed' ||
+            status === 'errored' ||
+            this.additionalFinishStatuses.includes(status)) {
+            this.hub.emit(`${messageId}:finished`, message);
+        }
+    }
+    /**
+     * Sets a Message in this.messages to the passed Message if the ids are equal.
+     * Then saves the unapprovedMessage list to storage.
+     *
+     * @param message - A Message that will replace an existing Message (with the id) in this.messages.
+     * @param emitUpdateBadge - Whether to emit the updateBadge event.
+     */
+    updateMessage(message, emitUpdateBadge = true) {
+        const index = this.messages.findIndex((msg) => message.id === msg.id);
+        /* istanbul ignore next */
+        if (index !== -1) {
+            this.messages[index] = message;
+        }
+        this.saveMessageList(emitUpdateBadge);
+    }
+    /**
+     * Verifies a message is malicious or not by checking it against a security provider.
+     *
+     * @param message - The message to verify.
+     * @returns A promise that resolves to a secured message with additional security provider response data.
+     */
+    securityCheck(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.securityProviderRequest) {
+                const securityProviderResponse = yield this.securityProviderRequest(message, message.type);
+                return Object.assign(Object.assign({}, message), { securityProviderResponse });
+            }
+            return message;
+        });
+    }
+    /**
+     * A getter for the number of 'unapproved' Messages in this.messages.
+     *
+     * @returns The number of 'unapproved' Messages in this.messages.
+     */
+    getUnapprovedMessagesCount() {
+        return Object.keys(this.getUnapprovedMessages()).length;
+    }
+    /**
+     * A getter for the 'unapproved' Messages in state messages.
+     *
+     * @returns An index of Message ids to Messages, for all 'unapproved' Messages in this.messages.
+     */
+    getUnapprovedMessages() {
+        return this.messages
+            .filter((message) => message.status === 'unapproved')
+            .reduce((result, message) => {
+            result[message.id] = message;
+            return result;
+        }, {});
+    }
+    /**
+     * Adds a passed Message to this.messages, and calls this.saveMessageList() to save
+     * the unapproved Messages from that list to this.messages.
+     *
+     * @param message - The Message to add to this.messages.
+     */
+    addMessage(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const securedMessage = yield this.securityCheck(message);
+            this.messages.push(securedMessage);
+            this.saveMessageList();
+        });
+    }
+    /**
+     * Returns a specified Message.
+     *
+     * @param messageId - The id of the Message to get.
+     * @returns The Message with the id that matches the passed messageId, or undefined
+     * if no Message has that id.
+     */
+    getMessage(messageId) {
+        return this.messages.find((message) => message.id === messageId);
+    }
+    /**
+     * Returns all the messages.
+     *
+     * @returns An array of messages.
+     */
+    getAllMessages() {
+        return this.messages;
+    }
+    /**
+     * Approves a Message. Sets the message status via a call to this.setMessageStatusApproved,
+     * and returns a promise with any the message params modified for proper signing.
+     *
+     * @param messageParams - The messageParams to be used when signing method is called,
+     * plus data added by MetaMask.
+     * @returns Promise resolving to the messageParams with the metamaskId property removed.
+     */
+    approveMessage(messageParams) {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        this.setMessageStatusApproved(messageParams.metamaskId);
+        return this.prepMessageForSigning(messageParams);
+    }
+    /**
+     * Sets a Message status to 'approved' via a call to this.setMessageStatus.
+     *
+     * @param messageId - The id of the Message to approve.
+     */
+    setMessageStatusApproved(messageId) {
+        this.setMessageStatus(messageId, 'approved');
+    }
+    /**
+     * Sets message status to inProgress in order to allow users to use extension
+     * while waiting for a custodian signature.
+     *
+     * @param messageId - The id of the message to set to inProgress
+     */
+    setMessageStatusInProgress(messageId) {
+        this.setMessageStatus(messageId, 'inProgress');
+    }
+    /**
+     * Sets a Message status to 'signed' via a call to this.setMessageStatus and updates
+     * that Message in this.messages by adding the raw signature data of the signature
+     * request to the Message.
+     *
+     * @param messageId - The id of the Message to sign.
+     * @param rawSig - The raw data of the signature request.
+     */
+    setMessageStatusSigned(messageId, rawSig) {
+        this.setMessageStatusAndResult(messageId, rawSig, 'signed');
+    }
+    /**
+     * Sets the message via a call to this.setResult and updates status of the message.
+     *
+     * @param messageId - The id of the Message to sign.
+     * @param rawSig - The data to update rawSig in the message.
+     * @param status - The new message status.
+     */
+    setMessageStatusAndResult(messageId, rawSig, status) {
+        this.setResult(messageId, rawSig);
+        this.setMessageStatus(messageId, status);
+    }
+    /**
+     * Sets the message result.
+     *
+     * @param messageId - The id of the Message to sign.
+     * @param result - The data to update result in the message.
+     */
+    setResult(messageId, result) {
+        const message = this.getMessage(messageId);
+        /* istanbul ignore if */
+        if (!message) {
+            return;
+        }
+        message.rawSig = result;
+        this.updateMessage(message, false);
+    }
+    /**
+     * Sets the messsage metadata
+     *
+     * @param messageId - The id of the Message to update
+     * @param metadata - The data with which to replace the metadata property in the message
+     */
+    setMetadata(messageId, metadata) {
+        const message = this.getMessage(messageId);
+        if (!message) {
+            throw new Error(`${this.name}: Message not found for id: ${messageId}.`);
+        }
+        message.metadata = metadata;
+        this.updateMessage(message, false);
+    }
+    /**
+     * Sets a Message status to 'rejected' via a call to this.setMessageStatus.
+     *
+     * @param messageId - The id of the Message to reject.
+     */
+    rejectMessage(messageId) {
+        this.setMessageStatus(messageId, 'rejected');
+    }
+    /**
+     * Creates a promise which will resolve or reject when the message process is finished.
+     *
+     * @param messageParamsWithId - The params for the personal_sign call to be made after the message is approved.
+     * @param messageName - The name of the message
+     * @returns Promise resolving to the raw data of the signature request.
+     */
+    waitForFinishStatus(messageParamsWithId, messageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { metamaskId: messageId } = messageParamsWithId, messageParams = __rest(messageParamsWithId, ["metamaskId"]);
+            return new Promise((resolve, reject) => {
+                this.hub.once(`${messageId}:finished`, (data) => {
+                    switch (data.status) {
+                        case 'signed':
+                            return resolve(data.rawSig);
+                        case 'rejected':
+                            return reject(new Error(`MetaMask ${messageName} Signature: User denied message signature.`));
+                        case 'errored':
+                            return reject(new Error(`MetaMask ${messageName} Signature: ${data.error}`));
+                        default:
+                            return reject(new Error(`MetaMask ${messageName} Signature: Unknown problem: ${JSON.stringify(messageParams)}`));
+                    }
+                });
+            });
+        });
+    }
+}
+exports.AbstractMessageManager = AbstractMessageManager;
+exports.default = AbstractMessageManager;
+//# sourceMappingURL=AbstractMessageManager.js.map

package/dist/AbstractMessageManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractMessageManager.js","sourceRoot":"","sources":["../src/AbstractMessageManager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AACA,+DAA2D;AAE3D,mCAAsC;AAsFtC;;GAEG;AACH,MAAsB,sBAIpB,SAAQ,gCAAkD;IA6F1D;;;;;;;;OAQG;IACH,YACE,MAA4B,EAC5B,KAAuC,EACvC,uBAAiD,EACjD,wBAAmC,EACnC,iBAAqC;QAErC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QA1BvB;;WAEG;QACH,QAAG,GAAG,IAAI,qBAAY,EAAE,CAAC;QAEzB;;WAEG;QACM,SAAI,GAAG,wBAAwB,CAAC;QAmBvC,IAAI,CAAC,YAAY,GAAG;YAClB,kBAAkB,EAAE,EAAE;YACtB,uBAAuB,EAAE,CAAC;SAC3B,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QACvD,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,aAAxB,wBAAwB,cAAxB,wBAAwB,GAAI,EAAE,CAAC;QAC/D,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IA9GD;;;;OAIG;IACO,eAAe,CAAC,eAAe,GAAG,IAAI;QAC9C,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACxD,MAAM,uBAAuB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClE,IAAI,CAAC,MAAM,CAAC,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,CAAC,CAAC;QAC7D,IAAI,eAAe,EAAE;YACnB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SAC9B;IACH,CAAC;IAED;;;;;OAKG;IACO,gBAAgB,CAAC,SAAiB,EAAE,MAAc;QAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,+BAA+B,SAAS,GAAG,CAAC,CAAC;SAC1E;QACD,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;QACxB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QACjD,IACE,MAAM,KAAK,UAAU;YACrB,MAAM,KAAK,QAAQ;YACnB,MAAM,KAAK,SAAS;YACpB,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAC9C;YACA,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;SACjD;IACH,CAAC;IAED;;;;;;OAMG;IACO,aAAa,CAAC,OAAU,EAAE,eAAe,GAAG,IAAI;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC;QACtE,0BAA0B;QAC1B,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YAChB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC;SAChC;QACD,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACW,aAAa,CAAC,OAAU;;YACpC,IAAI,IAAI,CAAC,uBAAuB,EAAE;gBAChC,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC,uBAAuB,CACjE,OAAO,EACP,OAAO,CAAC,IAAI,CACb,CAAC;gBACF,uCACK,OAAO,KACV,wBAAwB,IACxB;aACH;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAwCD;;;;OAIG;IACH,0BAA0B;QACxB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,MAAM,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,qBAAqB;QACnB,OAAO,IAAI,CAAC,QAAQ;aACjB,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,YAAY,CAAC;aACpD,MAAM,CAAC,CAAC,MAA4B,EAAE,OAAU,EAAE,EAAE;YACnD,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;YAC7B,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,EAAE,CAAyB,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACG,UAAU,CAAC,OAAU;;YACzB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACzD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACnC,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC;KAAA;IAED;;;;;;OAMG;IACH,UAAU,CAAC,SAAiB;QAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,aAAiB;QAC9B,6DAA6D;QAC7D,aAAa;QACb,IAAI,CAAC,wBAAwB,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,wBAAwB,CAAC,SAAiB;QACxC,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CAAC,SAAiB;QAC1C,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CAAC,SAAiB,EAAE,MAAc;QACtD,IAAI,CAAC,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,yBAAyB,CAAC,SAAiB,EAAE,MAAc,EAAE,MAAc;QACzE,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAClC,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,SAAiB,EAAE,MAAc;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAC3C,wBAAwB;QACxB,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO;SACR;QACD,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;QACxB,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IAEH,WAAW,CAAC,SAAiB,EAAE,QAAc;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,+BAA+B,SAAS,GAAG,CAAC,CAAC;SAC1E;QACD,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC5B,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IA2BD;;;;OAIG;IACH,aAAa,CAAC,SAAiB;QAC7B,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;OAMG;IACG,mBAAmB,CACvB,mBAAkD,EAClD,WAAmB;;YAEnB,MAAM,EAAE,UAAU,EAAE,SAAS,KAAuB,mBAAmB,EAArC,aAAa,UAAK,mBAAmB,EAAjE,cAA2C,CAAsB,CAAC;YACxE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,WAAW,EAAE,CAAC,IAAqB,EAAE,EAAE;oBAC/D,QAAQ,IAAI,CAAC,MAAM,EAAE;wBACnB,KAAK,QAAQ;4BACX,OAAO,OAAO,CAAC,IAAI,CAAC,MAAgB,CAAC,CAAC;wBACxC,KAAK,UAAU;4BACb,OAAO,MAAM,CACX,IAAI,KAAK,CACP,YAAY,WAAW,4CAA4C,CACpE,CACF,CAAC;wBACJ,KAAK,SAAS;4BACZ,OAAO,MAAM,CACX,IAAI,KAAK,CAAC,YAAY,WAAW,eAAe,IAAI,CAAC,KAAK,EAAE,CAAC,CAC9D,CAAC;wBACJ;4BACE,OAAO,MAAM,CACX,IAAI,KAAK,CACP,YAAY,WAAW,gCAAgC,IAAI,CAAC,SAAS,CACnE,aAAa,CACd,EAAE,CACJ,CACF,CAAC;qBACL;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAvVD,wDAuVC;AAED,kBAAe,sBAAsB,CAAC","sourcesContent":["import type { BaseConfig, BaseState } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Hex, Json } from '@metamask/utils';\nimport { EventEmitter } from 'events';\n\n/**\n * @type OriginalRequest\n *\n * Represents the original request object for adding a message.\n * @property origin? - Is it is specified, represents the origin\n */\nexport interface OriginalRequest {\n  origin?: string;\n  securityAlertResponse?: Record<string, Json>;\n}\n\n/**\n * @type Message\n *\n * Represents and contains data about a signing type signature request.\n * @property id - An id to track and identify the message object\n * @property type - The json-prc signing method for which a signature request has been made.\n * A 'Message' which always has a signing type\n * @property rawSig - Raw data of the signature request\n * @property securityProviderResponse - Response from a security provider, whether it is malicious or not\n * @property metadata - Additional data for the message, for example external identifiers\n */\nexport interface AbstractMessage {\n  id: string;\n  time: number;\n  status: string;\n  type: string;\n  rawSig?: string;\n  securityProviderResponse?: Record<string, Json>;\n  securityAlertResponse?: Record<string, Json>;\n  metadata?: Json;\n  error?: string;\n}\n\n/**\n * @type MessageParams\n *\n * Represents the parameters to pass to the signing method once the signature request is approved.\n * @property from - Address from which the message is processed\n * @property origin? - Added for request origin identification\n * @property deferSetAsSigned? - Whether to defer setting the message as signed immediately after the keyring is told to sign it\n */\nexport interface AbstractMessageParams {\n  from: string;\n  origin?: string;\n  deferSetAsSigned?: boolean;\n}\n\n/**\n * @type MessageParamsMetamask\n *\n * Represents the parameters to pass to the signing method once the signature request is approved\n * plus data added by MetaMask.\n * @property metamaskId - Added for tracking and identification within MetaMask\n * @property from - Address from which the message is processed\n * @property origin? - Added for request origin identification\n */\nexport interface AbstractMessageParamsMetamask extends AbstractMessageParams {\n  metamaskId?: string;\n}\n\n/**\n * @type MessageManagerState\n *\n * Message Manager state\n * @property unapprovedMessages - A collection of all Messages in the 'unapproved' state\n * @property unapprovedMessagesCount - The count of all Messages in this.unapprovedMessages\n */\nexport interface MessageManagerState<M extends AbstractMessage>\n  extends BaseState {\n  unapprovedMessages: { [key: string]: M };\n  unapprovedMessagesCount: number;\n}\n\n/**\n * A function for verifying a message, whether it is malicious or not\n */\nexport type SecurityProviderRequest = (\n  requestData: AbstractMessage,\n  messageType: string,\n) => Promise<Json>;\n\ntype getCurrentChainId = () => Hex;\n\n/**\n * Controller in charge of managing - storing, adding, removing, updating - Messages.\n */\nexport abstract class AbstractMessageManager<\n  M extends AbstractMessage,\n  P extends AbstractMessageParams,\n  PM extends AbstractMessageParamsMetamask,\n> extends BaseController<BaseConfig, MessageManagerState<M>> {\n  protected messages: M[];\n\n  protected getCurrentChainId: getCurrentChainId | undefined;\n\n  private readonly securityProviderRequest: SecurityProviderRequest | undefined;\n\n  private readonly additionalFinishStatuses: string[];\n\n  /**\n   * Saves the unapproved messages, and their count to state.\n   *\n   * @param emitUpdateBadge - Whether to emit the updateBadge event.\n   */\n  protected saveMessageList(emitUpdateBadge = true) {\n    const unapprovedMessages = this.getUnapprovedMessages();\n    const unapprovedMessagesCount = this.getUnapprovedMessagesCount();\n    this.update({ unapprovedMessages, unapprovedMessagesCount });\n    if (emitUpdateBadge) {\n      this.hub.emit('updateBadge');\n    }\n  }\n\n  /**\n   * Updates the status of a Message in this.messages.\n   *\n   * @param messageId - The id of the Message to update.\n   * @param status - The new status of the Message.\n   */\n  protected setMessageStatus(messageId: string, status: string) {\n    const message = this.getMessage(messageId);\n    if (!message) {\n      throw new Error(`${this.name}: Message not found for id: ${messageId}.`);\n    }\n    message.status = status;\n    this.updateMessage(message);\n    this.hub.emit(`${messageId}:${status}`, message);\n    if (\n      status === 'rejected' ||\n      status === 'signed' ||\n      status === 'errored' ||\n      this.additionalFinishStatuses.includes(status)\n    ) {\n      this.hub.emit(`${messageId}:finished`, message);\n    }\n  }\n\n  /**\n   * Sets a Message in this.messages to the passed Message if the ids are equal.\n   * Then saves the unapprovedMessage list to storage.\n   *\n   * @param message - A Message that will replace an existing Message (with the id) in this.messages.\n   * @param emitUpdateBadge - Whether to emit the updateBadge event.\n   */\n  protected updateMessage(message: M, emitUpdateBadge = true) {\n    const index = this.messages.findIndex((msg) => message.id === msg.id);\n    /* istanbul ignore next */\n    if (index !== -1) {\n      this.messages[index] = message;\n    }\n    this.saveMessageList(emitUpdateBadge);\n  }\n\n  /**\n   * Verifies a message is malicious or not by checking it against a security provider.\n   *\n   * @param message - The message to verify.\n   * @returns A promise that resolves to a secured message with additional security provider response data.\n   */\n  private async securityCheck(message: M): Promise<M> {\n    if (this.securityProviderRequest) {\n      const securityProviderResponse = await this.securityProviderRequest(\n        message,\n        message.type,\n      );\n      return {\n        ...message,\n        securityProviderResponse,\n      };\n    }\n    return message;\n  }\n\n  /**\n   * EventEmitter instance used to listen to specific message events\n   */\n  hub = new EventEmitter();\n\n  /**\n   * Name of this controller used during composition\n   */\n  override name = 'AbstractMessageManager';\n\n  /**\n   * Creates an AbstractMessageManager instance.\n   *\n   * @param config - Initial options used to configure this controller.\n   * @param state - Initial state to set on this controller.\n   * @param securityProviderRequest - A function for verifying a message, whether it is malicious or not.\n   * @param additionalFinishStatuses - Optional list of statuses that are accepted to emit a finished event.\n   * @param getCurrentChainId - Optional function to get the current chainId.\n   */\n  constructor(\n    config?: Partial<BaseConfig>,\n    state?: Partial<MessageManagerState<M>>,\n    securityProviderRequest?: SecurityProviderRequest,\n    additionalFinishStatuses?: string[],\n    getCurrentChainId?: getCurrentChainId,\n  ) {\n    super(config, state);\n    this.defaultState = {\n      unapprovedMessages: {},\n      unapprovedMessagesCount: 0,\n    };\n    this.messages = [];\n    this.securityProviderRequest = securityProviderRequest;\n    this.additionalFinishStatuses = additionalFinishStatuses ?? [];\n    this.getCurrentChainId = getCurrentChainId;\n    this.initialize();\n  }\n\n  /**\n   * A getter for the number of 'unapproved' Messages in this.messages.\n   *\n   * @returns The number of 'unapproved' Messages in this.messages.\n   */\n  getUnapprovedMessagesCount() {\n    return Object.keys(this.getUnapprovedMessages()).length;\n  }\n\n  /**\n   * A getter for the 'unapproved' Messages in state messages.\n   *\n   * @returns An index of Message ids to Messages, for all 'unapproved' Messages in this.messages.\n   */\n  getUnapprovedMessages() {\n    return this.messages\n      .filter((message) => message.status === 'unapproved')\n      .reduce((result: { [key: string]: M }, message: M) => {\n        result[message.id] = message;\n        return result;\n      }, {}) as { [key: string]: M };\n  }\n\n  /**\n   * Adds a passed Message to this.messages, and calls this.saveMessageList() to save\n   * the unapproved Messages from that list to this.messages.\n   *\n   * @param message - The Message to add to this.messages.\n   */\n  async addMessage(message: M) {\n    const securedMessage = await this.securityCheck(message);\n    this.messages.push(securedMessage);\n    this.saveMessageList();\n  }\n\n  /**\n   * Returns a specified Message.\n   *\n   * @param messageId - The id of the Message to get.\n   * @returns The Message with the id that matches the passed messageId, or undefined\n   * if no Message has that id.\n   */\n  getMessage(messageId: string) {\n    return this.messages.find((message) => message.id === messageId);\n  }\n\n  /**\n   * Returns all the messages.\n   *\n   * @returns An array of messages.\n   */\n  getAllMessages() {\n    return this.messages;\n  }\n\n  /**\n   * Approves a Message. Sets the message status via a call to this.setMessageStatusApproved,\n   * and returns a promise with any the message params modified for proper signing.\n   *\n   * @param messageParams - The messageParams to be used when signing method is called,\n   * plus data added by MetaMask.\n   * @returns Promise resolving to the messageParams with the metamaskId property removed.\n   */\n  approveMessage(messageParams: PM): Promise<P> {\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    this.setMessageStatusApproved(messageParams.metamaskId);\n    return this.prepMessageForSigning(messageParams);\n  }\n\n  /**\n   * Sets a Message status to 'approved' via a call to this.setMessageStatus.\n   *\n   * @param messageId - The id of the Message to approve.\n   */\n  setMessageStatusApproved(messageId: string) {\n    this.setMessageStatus(messageId, 'approved');\n  }\n\n  /**\n   * Sets message status to inProgress in order to allow users to use extension\n   * while waiting for a custodian signature.\n   *\n   * @param messageId - The id of the message to set to inProgress\n   */\n  setMessageStatusInProgress(messageId: string) {\n    this.setMessageStatus(messageId, 'inProgress');\n  }\n\n  /**\n   * Sets a Message status to 'signed' via a call to this.setMessageStatus and updates\n   * that Message in this.messages by adding the raw signature data of the signature\n   * request to the Message.\n   *\n   * @param messageId - The id of the Message to sign.\n   * @param rawSig - The raw data of the signature request.\n   */\n  setMessageStatusSigned(messageId: string, rawSig: string) {\n    this.setMessageStatusAndResult(messageId, rawSig, 'signed');\n  }\n\n  /**\n   * Sets the message via a call to this.setResult and updates status of the message.\n   *\n   * @param messageId - The id of the Message to sign.\n   * @param rawSig - The data to update rawSig in the message.\n   * @param status - The new message status.\n   */\n  setMessageStatusAndResult(messageId: string, rawSig: string, status: string) {\n    this.setResult(messageId, rawSig);\n    this.setMessageStatus(messageId, status);\n  }\n\n  /**\n   * Sets the message result.\n   *\n   * @param messageId - The id of the Message to sign.\n   * @param result - The data to update result in the message.\n   */\n  setResult(messageId: string, result: string) {\n    const message = this.getMessage(messageId);\n    /* istanbul ignore if */\n    if (!message) {\n      return;\n    }\n    message.rawSig = result;\n    this.updateMessage(message, false);\n  }\n\n  /**\n   * Sets the messsage metadata\n   *\n   * @param messageId - The id of the Message to update\n   * @param metadata - The data with which to replace the metadata property in the message\n   */\n\n  setMetadata(messageId: string, metadata: Json) {\n    const message = this.getMessage(messageId);\n    if (!message) {\n      throw new Error(`${this.name}: Message not found for id: ${messageId}.`);\n    }\n    message.metadata = metadata;\n    this.updateMessage(message, false);\n  }\n\n  /**\n   * Removes the metamaskId property from passed messageParams and returns a promise which\n   * resolves the updated messageParams\n   *\n   * @param messageParams - The messageParams to modify\n   * @returns Promise resolving to the messageParams with the metamaskId property removed\n   */\n  abstract prepMessageForSigning(messageParams: PM): Promise<P>;\n\n  /**\n   * Creates a new Message with an 'unapproved' status using the passed messageParams.\n   * this.addMessage is called to add the new Message to this.messages, and to save the\n   * unapproved Messages.\n   *\n   * @param messageParams - Message parameters for the message to add\n   * @param req - The original request object possibly containing the origin.\n   * @param version? - The version of the JSON RPC protocol the request is using.\n   * @returns The id of the newly created message.\n   */\n  abstract addUnapprovedMessage(\n    messageParams: PM,\n    request: OriginalRequest,\n    version?: string,\n  ): Promise<string>;\n\n  /**\n   * Sets a Message status to 'rejected' via a call to this.setMessageStatus.\n   *\n   * @param messageId - The id of the Message to reject.\n   */\n  rejectMessage(messageId: string) {\n    this.setMessageStatus(messageId, 'rejected');\n  }\n\n  /**\n   * Creates a promise which will resolve or reject when the message process is finished.\n   *\n   * @param messageParamsWithId - The params for the personal_sign call to be made after the message is approved.\n   * @param messageName - The name of the message\n   * @returns Promise resolving to the raw data of the signature request.\n   */\n  async waitForFinishStatus(\n    messageParamsWithId: AbstractMessageParamsMetamask,\n    messageName: string,\n  ): Promise<string> {\n    const { metamaskId: messageId, ...messageParams } = messageParamsWithId;\n    return new Promise((resolve, reject) => {\n      this.hub.once(`${messageId}:finished`, (data: AbstractMessage) => {\n        switch (data.status) {\n          case 'signed':\n            return resolve(data.rawSig as string);\n          case 'rejected':\n            return reject(\n              new Error(\n                `MetaMask ${messageName} Signature: User denied message signature.`,\n              ),\n            );\n          case 'errored':\n            return reject(\n              new Error(`MetaMask ${messageName} Signature: ${data.error}`),\n            );\n          default:\n            return reject(\n              new Error(\n                `MetaMask ${messageName} Signature: Unknown problem: ${JSON.stringify(\n                  messageParams,\n                )}`,\n              ),\n            );\n        }\n      });\n    });\n  }\n}\n\nexport default AbstractMessageManager;\n"]}

package/dist/DecryptMessageManager.d.ts

@@ -0,0 +1,75 @@
+import type { AbstractMessage, AbstractMessageParams, AbstractMessageParamsMetamask, OriginalRequest } from './AbstractMessageManager';
+import { AbstractMessageManager } from './AbstractMessageManager';
+/**
+ * @type DecryptMessage
+ *
+ * Represents and contains data about a 'eth_decrypt' type signature request.
+ * These are created when a signature for an eth_decrypt call is requested.
+ * @property id - An id to track and identify the message object
+ * @property messageParams - The parameters to pass to the eth_decrypt method once the request is approved
+ * @property type - The json-prc signing method for which a signature request has been made.
+ * A 'DecryptMessage' which always has a 'eth_decrypt' type
+ */
+export interface DecryptMessage extends AbstractMessage {
+    messageParams: DecryptMessageParams;
+}
+/**
+ * @type DecryptMessageParams
+ *
+ * Represents the parameters to pass to the eth_decrypt method once the request is approved.
+ * @property data - A hex string conversion of the raw buffer data of the signature request
+ */
+export interface DecryptMessageParams extends AbstractMessageParams {
+    data: string;
+}
+/**
+ * @type DecryptMessageParamsMetamask
+ *
+ * Represents the parameters to pass to the eth_decrypt method once the request is approved
+ * plus data added by MetaMask.
+ * @property metamaskId - Added for tracking and identification within MetaMask
+ * @property data - A hex string conversion of the raw buffer data of the signature request
+ * @property from - Address to sign this message from
+ * @property origin? - Added for request origin identification
+ */
+export interface DecryptMessageParamsMetamask extends AbstractMessageParamsMetamask {
+    data: string;
+}
+/**
+ * Controller in charge of managing - storing, adding, removing, updating - DecryptMessages.
+ */
+export declare class DecryptMessageManager extends AbstractMessageManager<DecryptMessage, DecryptMessageParams, DecryptMessageParamsMetamask> {
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
+    /**
+     * Creates a new Message with an 'unapproved' status using the passed messageParams.
+     * this.addMessage is called to add the new Message to this.messages, and to save the unapproved Messages.
+     *
+     * @param messageParams - The params for the personal_sign call to be made after the message is approved.
+     * @param req - The original request object possibly containing the origin.
+     * @returns Promise resolving to the raw data of the signature request.
+     */
+    addUnapprovedMessageAsync(messageParams: DecryptMessageParams, req?: OriginalRequest): Promise<string>;
+    /**
+     * Creates a new Message with an 'unapproved' status using the passed messageParams.
+     * this.addMessage is called to add the new Message to this.messages, and to save the
+     * unapproved Messages.
+     *
+     * @param messageParams - The params for the personal_sign call to be made after the message
+     * is approved.
+     * @param req - The original request object possibly containing the origin.
+     * @returns The id of the newly created message.
+     */
+    addUnapprovedMessage(messageParams: DecryptMessageParams, req?: OriginalRequest): Promise<string>;
+    /**
+     * Removes the metamaskId property from passed messageParams and returns a promise which
+     * resolves the updated messageParams.
+     *
+     * @param messageParams - The messageParams to modify.
+     * @returns Promise resolving to the messageParams with the metamaskId property removed.
+     */
+    prepMessageForSigning(messageParams: DecryptMessageParamsMetamask): Promise<DecryptMessageParams>;
+}
+//# sourceMappingURL=DecryptMessageManager.d.ts.map

package/dist/DecryptMessageManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DecryptMessageManager.d.ts","sourceRoot":"","sources":["../src/DecryptMessageManager.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,eAAe,EACf,qBAAqB,EACrB,6BAA6B,EAC7B,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAGlE;;;;;;;;;GASG;AACH,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,aAAa,EAAE,oBAAoB,CAAC;CACrC;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IACjE,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,4BACf,SAAQ,6BAA6B;IACrC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,sBAAsB,CAC/D,cAAc,EACd,oBAAoB,EACpB,4BAA4B,CAC7B;IACC;;OAEG;IACM,IAAI,SAA2B;IAExC;;;;;;;OAOG;IACG,yBAAyB,CAC7B,aAAa,EAAE,oBAAoB,EACnC,GAAG,CAAC,EAAE,eAAe,GACpB,OAAO,CAAC,MAAM,CAAC;IAkClB;;;;;;;;;OASG;IACG,oBAAoB,CACxB,aAAa,EAAE,oBAAoB,EACnC,GAAG,CAAC,EAAE,eAAe;IAsBvB;;;;;;OAMG;IACH,qBAAqB,CACnB,aAAa,EAAE,4BAA4B,GAC1C,OAAO,CAAC,oBAAoB,CAAC;CAIjC"}

package/dist/DecryptMessageManager.js

@@ -0,0 +1,97 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DecryptMessageManager = void 0;
+const uuid_1 = require("uuid");
+const AbstractMessageManager_1 = require("./AbstractMessageManager");
+const utils_1 = require("./utils");
+/**
+ * Controller in charge of managing - storing, adding, removing, updating - DecryptMessages.
+ */
+class DecryptMessageManager extends AbstractMessageManager_1.AbstractMessageManager {
+    constructor() {
+        super(...arguments);
+        /**
+         * Name of this controller used during composition
+         */
+        this.name = 'DecryptMessageManager';
+    }
+    /**
+     * Creates a new Message with an 'unapproved' status using the passed messageParams.
+     * this.addMessage is called to add the new Message to this.messages, and to save the unapproved Messages.
+     *
+     * @param messageParams - The params for the personal_sign call to be made after the message is approved.
+     * @param req - The original request object possibly containing the origin.
+     * @returns Promise resolving to the raw data of the signature request.
+     */
+    addUnapprovedMessageAsync(messageParams, req) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, utils_1.validateDecryptedMessageData)(messageParams);
+            const messageId = yield this.addUnapprovedMessage(messageParams, req);
+            return new Promise((resolve, reject) => {
+                this.hub.once(`${messageId}:finished`, (data) => {
+                    switch (data.status) {
+                        case 'decrypted':
+                            return resolve(data.rawSig);
+                        case 'rejected':
+                            return reject(new Error('MetaMask DecryptMessage: User denied message decryption.'));
+                        case 'errored':
+                            return reject(new Error('MetaMask DecryptMessage: This message cannot be decrypted.'));
+                        default:
+                            return reject(new Error(`MetaMask DecryptMessage: Unknown problem: ${JSON.stringify(messageParams)}`));
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Creates a new Message with an 'unapproved' status using the passed messageParams.
+     * this.addMessage is called to add the new Message to this.messages, and to save the
+     * unapproved Messages.
+     *
+     * @param messageParams - The params for the personal_sign call to be made after the message
+     * is approved.
+     * @param req - The original request object possibly containing the origin.
+     * @returns The id of the newly created message.
+     */
+    addUnapprovedMessage(messageParams, req) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (req) {
+                messageParams.origin = req.origin;
+            }
+            messageParams.data = (0, utils_1.normalizeMessageData)(messageParams.data);
+            const messageId = (0, uuid_1.v1)();
+            const messageData = {
+                id: messageId,
+                messageParams,
+                status: 'unapproved',
+                time: Date.now(),
+                type: 'eth_decrypt',
+            };
+            yield this.addMessage(messageData);
+            this.hub.emit(`unapprovedMessage`, Object.assign(Object.assign({}, messageParams), { metamaskId: messageId }));
+            return messageId;
+        });
+    }
+    /**
+     * Removes the metamaskId property from passed messageParams and returns a promise which
+     * resolves the updated messageParams.
+     *
+     * @param messageParams - The messageParams to modify.
+     * @returns Promise resolving to the messageParams with the metamaskId property removed.
+     */
+    prepMessageForSigning(messageParams) {
+        delete messageParams.metamaskId;
+        return Promise.resolve(messageParams);
+    }
+}
+exports.DecryptMessageManager = DecryptMessageManager;
+//# sourceMappingURL=DecryptMessageManager.js.map

package/dist/DecryptMessageManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DecryptMessageManager.js","sourceRoot":"","sources":["../src/DecryptMessageManager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+BAAoC;AAQpC,qEAAkE;AAClE,mCAA6E;AAyC7E;;GAEG;AACH,MAAa,qBAAsB,SAAQ,+CAI1C;IAJD;;QAKE;;WAEG;QACM,SAAI,GAAG,uBAAuB,CAAC;IA8F1C,CAAC;IA5FC;;;;;;;OAOG;IACG,yBAAyB,CAC7B,aAAmC,EACnC,GAAqB;;YAErB,IAAA,oCAA4B,EAAC,aAAa,CAAC,CAAC;YAC5C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;YAEtE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,WAAW,EAAE,CAAC,IAAoB,EAAE,EAAE;oBAC9D,QAAQ,IAAI,CAAC,MAAM,EAAE;wBACnB,KAAK,WAAW;4BACd,OAAO,OAAO,CAAC,IAAI,CAAC,MAAgB,CAAC,CAAC;wBACxC,KAAK,UAAU;4BACb,OAAO,MAAM,CACX,IAAI,KAAK,CACP,0DAA0D,CAC3D,CACF,CAAC;wBACJ,KAAK,SAAS;4BACZ,OAAO,MAAM,CACX,IAAI,KAAK,CACP,4DAA4D,CAC7D,CACF,CAAC;wBACJ;4BACE,OAAO,MAAM,CACX,IAAI,KAAK,CACP,6CAA6C,IAAI,CAAC,SAAS,CACzD,aAAa,CACd,EAAE,CACJ,CACF,CAAC;qBACL;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;;;;;OASG;IACG,oBAAoB,CACxB,aAAmC,EACnC,GAAqB;;YAErB,IAAI,GAAG,EAAE;gBACP,aAAa,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;aACnC;YACD,aAAa,CAAC,IAAI,GAAG,IAAA,4BAAoB,EAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9D,MAAM,SAAS,GAAG,IAAA,SAAM,GAAE,CAAC;YAC3B,MAAM,WAAW,GAAmB;gBAClC,EAAE,EAAE,SAAS;gBACb,aAAa;gBACb,MAAM,EAAE,YAAY;gBACpB,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;gBAChB,IAAI,EAAE,aAAa;aACpB,CAAC;YACF,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YACnC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,kCAC5B,aAAa,GACb,EAAE,UAAU,EAAE,SAAS,EAAE,EAC5B,CAAC;YACH,OAAO,SAAS,CAAC;QACnB,CAAC;KAAA;IAED;;;;;;OAMG;IACH,qBAAqB,CACnB,aAA2C;QAE3C,OAAO,aAAa,CAAC,UAAU,CAAC;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACxC,CAAC;CACF;AAtGD,sDAsGC","sourcesContent":["import { v1 as random } from 'uuid';\n\nimport type {\n  AbstractMessage,\n  AbstractMessageParams,\n  AbstractMessageParamsMetamask,\n  OriginalRequest,\n} from './AbstractMessageManager';\nimport { AbstractMessageManager } from './AbstractMessageManager';\nimport { normalizeMessageData, validateDecryptedMessageData } from './utils';\n\n/**\n * @type DecryptMessage\n *\n * Represents and contains data about a 'eth_decrypt' type signature request.\n * These are created when a signature for an eth_decrypt call is requested.\n * @property id - An id to track and identify the message object\n * @property messageParams - The parameters to pass to the eth_decrypt method once the request is approved\n * @property type - The json-prc signing method for which a signature request has been made.\n * A 'DecryptMessage' which always has a 'eth_decrypt' type\n */\nexport interface DecryptMessage extends AbstractMessage {\n  messageParams: DecryptMessageParams;\n}\n\n/**\n * @type DecryptMessageParams\n *\n * Represents the parameters to pass to the eth_decrypt method once the request is approved.\n * @property data - A hex string conversion of the raw buffer data of the signature request\n */\nexport interface DecryptMessageParams extends AbstractMessageParams {\n  data: string;\n}\n\n/**\n * @type DecryptMessageParamsMetamask\n *\n * Represents the parameters to pass to the eth_decrypt method once the request is approved\n * plus data added by MetaMask.\n * @property metamaskId - Added for tracking and identification within MetaMask\n * @property data - A hex string conversion of the raw buffer data of the signature request\n * @property from - Address to sign this message from\n * @property origin? - Added for request origin identification\n */\nexport interface DecryptMessageParamsMetamask\n  extends AbstractMessageParamsMetamask {\n  data: string;\n}\n\n/**\n * Controller in charge of managing - storing, adding, removing, updating - DecryptMessages.\n */\nexport class DecryptMessageManager extends AbstractMessageManager<\n  DecryptMessage,\n  DecryptMessageParams,\n  DecryptMessageParamsMetamask\n> {\n  /**\n   * Name of this controller used during composition\n   */\n  override name = 'DecryptMessageManager';\n\n  /**\n   * Creates a new Message with an 'unapproved' status using the passed messageParams.\n   * this.addMessage is called to add the new Message to this.messages, and to save the unapproved Messages.\n   *\n   * @param messageParams - The params for the personal_sign call to be made after the message is approved.\n   * @param req - The original request object possibly containing the origin.\n   * @returns Promise resolving to the raw data of the signature request.\n   */\n  async addUnapprovedMessageAsync(\n    messageParams: DecryptMessageParams,\n    req?: OriginalRequest,\n  ): Promise<string> {\n    validateDecryptedMessageData(messageParams);\n    const messageId = await this.addUnapprovedMessage(messageParams, req);\n\n    return new Promise((resolve, reject) => {\n      this.hub.once(`${messageId}:finished`, (data: DecryptMessage) => {\n        switch (data.status) {\n          case 'decrypted':\n            return resolve(data.rawSig as string);\n          case 'rejected':\n            return reject(\n              new Error(\n                'MetaMask DecryptMessage: User denied message decryption.',\n              ),\n            );\n          case 'errored':\n            return reject(\n              new Error(\n                'MetaMask DecryptMessage: This message cannot be decrypted.',\n              ),\n            );\n          default:\n            return reject(\n              new Error(\n                `MetaMask DecryptMessage: Unknown problem: ${JSON.stringify(\n                  messageParams,\n                )}`,\n              ),\n            );\n        }\n      });\n    });\n  }\n\n  /**\n   * Creates a new Message with an 'unapproved' status using the passed messageParams.\n   * this.addMessage is called to add the new Message to this.messages, and to save the\n   * unapproved Messages.\n   *\n   * @param messageParams - The params for the personal_sign call to be made after the message\n   * is approved.\n   * @param req - The original request object possibly containing the origin.\n   * @returns The id of the newly created message.\n   */\n  async addUnapprovedMessage(\n    messageParams: DecryptMessageParams,\n    req?: OriginalRequest,\n  ) {\n    if (req) {\n      messageParams.origin = req.origin;\n    }\n    messageParams.data = normalizeMessageData(messageParams.data);\n    const messageId = random();\n    const messageData: DecryptMessage = {\n      id: messageId,\n      messageParams,\n      status: 'unapproved',\n      time: Date.now(),\n      type: 'eth_decrypt',\n    };\n    await this.addMessage(messageData);\n    this.hub.emit(`unapprovedMessage`, {\n      ...messageParams,\n      ...{ metamaskId: messageId },\n    });\n    return messageId;\n  }\n\n  /**\n   * Removes the metamaskId property from passed messageParams and returns a promise which\n   * resolves the updated messageParams.\n   *\n   * @param messageParams - The messageParams to modify.\n   * @returns Promise resolving to the messageParams with the metamaskId property removed.\n   */\n  prepMessageForSigning(\n    messageParams: DecryptMessageParamsMetamask,\n  ): Promise<DecryptMessageParams> {\n    delete messageParams.metamaskId;\n    return Promise.resolve(messageParams);\n  }\n}\n"]}

package/dist/EncryptionPublicKeyManager.d.ts

@@ -0,0 +1,76 @@
+import type { AbstractMessage, AbstractMessageParams, AbstractMessageParamsMetamask, OriginalRequest } from './AbstractMessageManager';
+import { AbstractMessageManager } from './AbstractMessageManager';
+/**
+ * @type EncryptionPublicKey
+ *
+ * Represents and contains data about a 'eth_getEncryptionPublicKey' type request.
+ * These are created when an encryption public key is requested.
+ * @property id - An id to track and identify the message object
+ * @property messageParams - The parameters to pass to the eth_getEncryptionPublicKey method once the request is approved
+ * @property type - The json-prc method for which an encryption public key request has been made.
+ * A 'Message' which always has a 'eth_getEncryptionPublicKey' type
+ * @property rawSig - Encryption public key
+ */
+export interface EncryptionPublicKey extends AbstractMessage {
+    messageParams: EncryptionPublicKeyParams;
+}
+/**
+ * @type EncryptionPublicKeyParams
+ *
+ * Represents the parameters to pass to the method once the request is approved.
+ * @property from - Address from which to extract the encryption public key
+ * @property origin? - Added for request origin identification
+ */
+export declare type EncryptionPublicKeyParams = AbstractMessageParams;
+/**
+ * @type MessageParamsMetamask
+ *
+ * Represents the parameters to pass to the eth_getEncryptionPublicKey method once the request is approved
+ * plus data added by MetaMask.
+ * @property metamaskId - Added for tracking and identification within MetaMask
+ * @property data - Encryption public key
+ * @property from - Address from which to extract the encryption public key
+ * @property origin? - Added for request origin identification
+ */
+export interface EncryptionPublicKeyParamsMetamask extends AbstractMessageParamsMetamask {
+    data: string;
+}
+/**
+ * Controller in charge of managing - storing, adding, removing, updating - Messages.
+ */
+export declare class EncryptionPublicKeyManager extends AbstractMessageManager<EncryptionPublicKey, EncryptionPublicKeyParams, EncryptionPublicKeyParamsMetamask> {
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
+    /**
+     * Creates a new Message with an 'unapproved' status using the passed messageParams.
+     * this.addMessage is called to add the new Message to this.messages, and to save the unapproved Messages.
+     *
+     * @param messageParams - The params for the eth_getEncryptionPublicKey call to be made after the message is approved.
+     * @param req - The original request object possibly containing the origin.
+     * @returns Promise resolving to the raw data of the request.
+     */
+    addUnapprovedMessageAsync(messageParams: EncryptionPublicKeyParams, req?: OriginalRequest): Promise<string>;
+    /**
+     * Creates a new Message with an 'unapproved' status using the passed messageParams.
+     * this.addMessage is called to add the new Message to this.messages, and to save the
+     * unapproved Messages.
+     *
+     * @param messageParams - The params for the eth_getEncryptionPublicKey call to be made after the message
+     * is approved.
+     * @param req - The original request object possibly containing the origin.
+     * @returns The id of the newly created message.
+     */
+    addUnapprovedMessage(messageParams: EncryptionPublicKeyParams, req?: OriginalRequest): Promise<string>;
+    /**
+     * Removes the metamaskId property from passed messageParams and returns a promise which
+     * resolves the updated messageParams.
+     *
+     * @param messageParams - The messageParams to modify.
+     * @returns Promise resolving to the messageParams with the metamaskId property removed.
+     */
+    prepMessageForSigning(messageParams: EncryptionPublicKeyParamsMetamask): Promise<EncryptionPublicKeyParams>;
+}
+export default EncryptionPublicKeyManager;
+//# sourceMappingURL=EncryptionPublicKeyManager.d.ts.map

package/dist/EncryptionPublicKeyManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EncryptionPublicKeyManager.d.ts","sourceRoot":"","sources":["../src/EncryptionPublicKeyManager.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,eAAe,EACf,qBAAqB,EACrB,6BAA6B,EAC7B,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAGlE;;;;;;;;;;GAUG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,aAAa,EAAE,yBAAyB,CAAC;CAC1C;AAED;;;;;;GAMG;AACH,oBAAY,yBAAyB,GAAG,qBAAqB,CAAC;AAE9D;;;;;;;;;GASG;AACH,MAAM,WAAW,iCACf,SAAQ,6BAA6B;IACrC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,sBAAsB,CACpE,mBAAmB,EACnB,yBAAyB,EACzB,iCAAiC,CAClC;IACC;;OAEG;IACM,IAAI,SAAgC;IAE7C;;;;;;;OAOG;IACG,yBAAyB,CAC7B,aAAa,EAAE,yBAAyB,EACxC,GAAG,CAAC,EAAE,eAAe,GACpB,OAAO,CAAC,MAAM,CAAC;IA4BlB;;;;;;;;;OASG;IACG,oBAAoB,CACxB,aAAa,EAAE,yBAAyB,EACxC,GAAG,CAAC,EAAE,eAAe,GACpB,OAAO,CAAC,MAAM,CAAC;IAoBlB;;;;;;OAMG;IACH,qBAAqB,CACnB,aAAa,EAAE,iCAAiC,GAC/C,OAAO,CAAC,yBAAyB,CAAC;CAItC;AAED,eAAe,0BAA0B,CAAC"}