@metamask-previews/message-manager 11.0.3-preview-e5e6db48 → 11.0.3-preview-e96ca40c

package/CHANGELOG.md

@@ -7,14 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Changed
-
-- **BREAKING:** Base class of `DecryptMessageManager` and `EncryptionPublicKeyManager`(`AbstractMessageManager`) now expects new options to initialise ([#5103](https://github.com/MetaMask/core/pull/5103))
-- **BREAKING:** Removed internal event emitter (`hub` property) from `AbstractMessageManager` ([#5103](https://github.com/MetaMask/core/pull/5103))
-- **BREAKING:** `unapprovedMessage` and `updateBadge` removed from internal events. These events are now emitted from messaging system ([#5103](https://github.com/MetaMask/core/pull/5103))
-  - Controllers should now listen to `DerivedManagerName:X` event instead of using internal event emitter.
-- Bump `@metamask/base-controller` from `^7.0.0` to `^7.1.0` ([#5079](https://github.com/MetaMask/core/pull/5079))
-
 ## [11.0.3]
 
 ### Changed

package/dist/AbstractMessageManager.cjs

@@ -6,33 +6,10 @@ const base_controller_1 = require("@metamask/base-controller");
 // eslint-disable-next-line import/no-nodejs-modules
 const events_1 = require("events");
 const uuid_1 = require("uuid");
-const stateMetadata = {
-    unapprovedMessages: { persist: false, anonymous: false },
-    unapprovedMessagesCount: { persist: false, anonymous: false },
-};
-const getDefaultState = () => ({
-    unapprovedMessages: {},
-    unapprovedMessagesCount: 0,
-});
 /**
  * Controller in charge of managing - storing, adding, removing, updating - Messages.
  */
-class AbstractMessageManager extends base_controller_1.BaseController {
-    constructor({ additionalFinishStatuses, messenger, name, securityProviderRequest, state = {}, }) {
-        super({
-            messenger,
-            metadata: stateMetadata,
-            name,
-            state: {
-                ...getDefaultState(),
-                ...state,
-            },
-        });
-        this.internalEvents = new events_1.EventEmitter();
-        this.messages = [];
-        this.securityProviderRequest = securityProviderRequest;
-        this.additionalFinishStatuses = additionalFinishStatuses ?? [];
-    }
+class AbstractMessageManager extends base_controller_1.BaseControllerV1 {
     /**
      * Adds request props to the messsage params and returns a new messageParams object.
      * @param messageParams - The messageParams to add the request props to.
@@ -73,14 +50,11 @@ class AbstractMessageManager extends base_controller_1.BaseController {
      * @param emitUpdateBadge - Whether to emit the updateBadge event.
      */
     saveMessageList(emitUpdateBadge = true) {
-        this.update((state) => {
-            state.unapprovedMessages =
-                this.getUnapprovedMessages();
-            state.unapprovedMessagesCount = this.getUnapprovedMessagesCount();
-        });
+        const unapprovedMessages = this.getUnapprovedMessages();
+        const unapprovedMessagesCount = this.getUnapprovedMessagesCount();
+        this.update({ unapprovedMessages, unapprovedMessagesCount });
         if (emitUpdateBadge) {
-            // Empty payload is used to satisfy event constraint for BaseControllerV2
-            this.messagingSystem.publish(`${this.name}:updateBadge`, '');
+            this.hub.emit('updateBadge');
         }
     }
     /**
@@ -94,17 +68,14 @@ class AbstractMessageManager extends base_controller_1.BaseController {
         if (!message) {
             throw new Error(`${this.name}: Message not found for id: ${messageId}.`);
         }
-        const updatedMessage = {
-            ...message,
-            status,
-        };
-        this.updateMessage(updatedMessage);
-        this.internalEvents.emit(`${messageId}:${status}`, updatedMessage);
+        message.status = status;
+        this.updateMessage(message);
+        this.hub.emit(`${messageId}:${status}`, message);
         if (status === 'rejected' ||
             status === 'signed' ||
             status === 'errored' ||
             this.additionalFinishStatuses.includes(status)) {
-            this.internalEvents.emit(`${messageId}:finished`, updatedMessage);
+            this.hub.emit(`${messageId}:finished`, message);
         }
     }
     /**
@@ -138,11 +109,34 @@ class AbstractMessageManager extends base_controller_1.BaseController {
         }
         return message;
     }
-    clearUnapprovedMessages() {
-        this.update((state) => {
-            state.unapprovedMessages = {};
-            state.unapprovedMessagesCount = 0;
-        });
+    /**
+     * 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 ?? [];
+        this.getCurrentChainId = getCurrentChainId;
+        this.initialize();
     }
     /**
      * A getter for the number of 'unapproved' Messages in this.messages.
@@ -259,10 +253,8 @@ class AbstractMessageManager extends base_controller_1.BaseController {
         if (!message) {
             return;
         }
-        this.updateMessage({
-            ...message,
-            rawSig: result,
-        }, false);
+        message.rawSig = result;
+        this.updateMessage(message, false);
     }
     /**
      * Sets the messsage metadata
@@ -275,10 +267,8 @@ class AbstractMessageManager extends base_controller_1.BaseController {
         if (!message) {
             throw new Error(`${this.name}: Message not found for id: ${messageId}.`);
         }
-        this.updateMessage({
-            ...message,
-            metadata,
-        }, false);
+        message.metadata = metadata;
+        this.updateMessage(message, false);
     }
     /**
      * Sets a Message status to 'rejected' via a call to this.setMessageStatus.
@@ -298,14 +288,19 @@ class AbstractMessageManager extends base_controller_1.BaseController {
     async waitForFinishStatus(messageParamsWithId, messageName) {
         const { metamaskId: messageId, ...messageParams } = messageParamsWithId;
         return new Promise((resolve, reject) => {
-            this.internalEvents.once(`${messageId}:finished`, (data) => {
+            // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            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}`));
+                        return reject(
+                        // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+                        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                        new Error(`MetaMask ${messageName} Signature: ${data.error}`));
                     default:
                         return reject(new Error(`MetaMask ${messageName} Signature: Unknown problem: ${JSON.stringify(messageParams)}`));
                 }

package/dist/AbstractMessageManager.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractMessageManager.cjs","sourceRoot":"","sources":["../src/AbstractMessageManager.ts"],"names":[],"mappings":";;;AAAA,+DAA2D;AAQ3D,kEAAkE;AAClE,oDAAoD;AACpD,mCAAsC;AAEtC,+BAAoC;AAEpC,MAAM,aAAa,GAAG;IACpB,kBAAkB,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACxD,uBAAuB,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;CAC9D,CAAC;AAEF,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,CAAC;IAC7B,kBAAkB,EAAE,EAAE;IACtB,uBAAuB,EAAE,CAAC;CAC3B,CAAC,CAAC;AAsHH;;GAEG;AACH,MAAsB,sBAMpB,SAAQ,gCAUT;IASC,YAAY,EACV,wBAAwB,EACxB,SAAS,EACT,IAAI,EACJ,uBAAuB,EACvB,KAAK,GAAG,EAAkC,GACY;QACtD,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,aAAa;YACvB,IAAI;YACJ,KAAK,EAAE;gBACL,GAAG,eAAe,EAAE;gBACpB,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAjBL,mBAAc,GAAG,IAAI,qBAAY,EAAE,CAAC;QAkBlC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QACvD,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,IAAI,EAAE,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACO,yBAAyB,CAEjC,aAA4B,EAAE,GAAqB;QACnD,MAAM,oBAAoB,GAAG;YAC3B,GAAG,aAAa;SACjB,CAAC;QAEF,IAAI,GAAG,EAAE;YACP,oBAAoB,CAAC,SAAS,GAAG,GAAG,CAAC,EAAE,CAAC;YACxC,oBAAoB,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;SAC1C;QAED,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACO,uBAAuB,CAE/B,aAA4B,EAAE,IAAkB,EAAE,GAAqB;QACvE,MAAM,SAAS,GAAG,IAAA,SAAM,GAAE,CAAC;QAE3B,OAAO;YACL,EAAE,EAAE,SAAS;YACb,aAAa;YACb,qBAAqB,EAAE,GAAG,EAAE,qBAAqB;YACjD,MAAM,EAAE,YAAY;YACpB,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;YAChB,IAAI;SACL,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACO,eAAe,CAAC,eAAe,GAAG,IAAI;QAC9C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB;gBACtB,IAAI,CAAC,qBAAqB,EAGzB,CAAC;YACJ,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QACpE,CAAC,CAAC,CAAC;QACH,IAAI,eAAe,EAAE;YACnB,yEAAyE;YACzE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,IAAc,cAAc,EAAE,EAAE,CAAC,CAAC;SACxE;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,CACb,GAAG,IAAI,CAAC,IAAc,+BAA+B,SAAS,GAAG,CAClE,CAAC;SACH;QACD,MAAM,cAAc,GAAG;YACrB,GAAG,OAAO;YACV,MAAM;SACP,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,EAAE,cAAc,CAAC,CAAC;QACnE,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,cAAc,CAAC,IAAI,CACtB,GAAG,SAAmB,WAAW,EACjC,cAAc,CACf,CAAC;SACH;IACH,CAAC;IAED;;;;;;OAMG;IACO,aAAa,CAAC,OAAgB,EAAE,eAAe,GAAG,IAAI;QAC9D,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;IACK,KAAK,CAAC,aAAa,CAAC,OAAgB;QAC1C,IAAI,IAAI,CAAC,uBAAuB,EAAE;YAChC,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC,uBAAuB,CACjE,OAAO,EACP,OAAO,CAAC,IAAI,CACb,CAAC;YACF,OAAO;gBACL,GAAG,OAAO;gBACV,wBAAwB;aACzB,CAAC;SACH;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,uBAAuB;QACrB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB,GAAG,EAAE,CAAC;YAC9B,KAAK,CAAC,uBAAuB,GAAG,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;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,MAA+B,EAAE,OAAO,EAAE,EAAE;YACnD,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;YAC7B,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,OAAgB;QAC/B,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACnC,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;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,aAA6B;QAC1C,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,IAAI,CAAC,aAAa,CAChB;YACE,GAAG,OAAO;YACV,MAAM,EAAE,MAAM;SACf,EACD,KAAK,CACN,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,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,CACb,GAAG,IAAI,CAAC,IAAc,+BAA+B,SAAS,GAAG,CAClE,CAAC;SACH;QACD,IAAI,CAAC,aAAa,CAChB;YACE,GAAG,OAAO;YACV,QAAQ;SACT,EACD,KAAK,CACN,CAAC;IACJ,CAAC;IA6BD;;;;OAIG;IACH,aAAa,CAAC,SAAiB;QAC7B,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB,CACvB,mBAAkD,EAClD,WAAmB;QAEnB,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,aAAa,EAAE,GAAG,mBAAmB,CAAC;QACxE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,cAAc,CAAC,IAAI,CACtB,GAAG,SAAmB,WAAW,EACjC,CAAC,IAAqB,EAAE,EAAE;gBACxB,QAAQ,IAAI,CAAC,MAAM,EAAE;oBACnB,KAAK,QAAQ;wBACX,OAAO,OAAO,CAAC,IAAI,CAAC,MAAgB,CAAC,CAAC;oBACxC,KAAK,UAAU;wBACb,OAAO,MAAM,CACX,IAAI,KAAK,CACP,YAAY,WAAW,4CAA4C,CACpE,CACF,CAAC;oBACJ,KAAK,SAAS;wBACZ,OAAO,MAAM,CACX,IAAI,KAAK,CACP,YAAY,WAAW,eAAe,IAAI,CAAC,KAAe,EAAE,CAC7D,CACF,CAAC;oBACJ;wBACE,OAAO,MAAM,CACX,IAAI,KAAK,CACP,YAAY,WAAW,gCAAgC,IAAI,CAAC,SAAS,CACnE,aAAa,CACd,EAAE,CACJ,CACF,CAAC;iBACL;YACH,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AApaD,wDAoaC;AAED,kBAAe,sBAAsB,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ActionConstraint,\n  EventConstraint,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport type { ApprovalType } from '@metamask/controller-utils';\nimport type { Json } from '@metamask/utils';\n// This package purposefully relies on Node's EventEmitter module.\n// eslint-disable-next-line import/no-nodejs-modules\nimport { EventEmitter } from 'events';\nimport type { Draft } from 'immer';\nimport { v1 as random } from 'uuid';\n\nconst stateMetadata = {\n  unapprovedMessages: { persist: false, anonymous: false },\n  unapprovedMessagesCount: { persist: false, anonymous: false },\n};\n\nconst getDefaultState = () => ({\n  unapprovedMessages: {},\n  unapprovedMessagesCount: 0,\n});\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 type OriginalRequest = {\n  id?: number;\n  origin?: string;\n  securityAlertResponse?: Record<string, Json>;\n};\n\n/**\n * @type AbstractMessage\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 type 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 AbstractMessageParams\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 requestId? - Original request id\n * @property deferSetAsSigned? - Whether to defer setting the message as signed immediately after the keyring is told to sign it\n */\nexport type AbstractMessageParams = {\n  from: string;\n  origin?: string;\n  requestId?: number;\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 type AbstractMessageParamsMetamask = 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 type MessageManagerState<Message extends AbstractMessage> = {\n  unapprovedMessages: Record<string, Message>;\n  unapprovedMessagesCount: number;\n};\n\nexport type UpdateBadgeEvent = {\n  type: `${string}:updateBadge`;\n  payload: [unusedPayload: string];\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\n/**\n * AbstractMessageManager constructor options.\n *\n * @property additionalFinishStatuses - Optional list of statuses that are accepted to emit a finished event.\n * @property messenger - Controller messaging system.\n * @property name - The name of the manager.\n * @property securityProviderRequest - A function for verifying a message, whether it is malicious or not.\n * @property state - Initial state to set on this controller.\n */\nexport type AbstractMessageManagerOptions<\n  Message extends AbstractMessage,\n  Action extends ActionConstraint,\n  Event extends EventConstraint,\n> = {\n  additionalFinishStatuses?: string[];\n  messenger: RestrictedControllerMessenger<\n    string,\n    Action,\n    Event | UpdateBadgeEvent,\n    string,\n    string\n  >;\n  name: string;\n  securityProviderRequest?: SecurityProviderRequest;\n  state?: MessageManagerState<Message>;\n};\n\n/**\n * Controller in charge of managing - storing, adding, removing, updating - Messages.\n */\nexport abstract class AbstractMessageManager<\n  Message extends AbstractMessage,\n  Params extends AbstractMessageParams,\n  ParamsMetamask extends AbstractMessageParamsMetamask,\n  Action extends ActionConstraint,\n  Event extends EventConstraint,\n> extends BaseController<\n  string,\n  MessageManagerState<Message>,\n  RestrictedControllerMessenger<\n    string,\n    Action,\n    Event | UpdateBadgeEvent,\n    string,\n    string\n  >\n> {\n  protected messages: Message[];\n\n  private readonly securityProviderRequest: SecurityProviderRequest | undefined;\n\n  private readonly additionalFinishStatuses: string[];\n\n  internalEvents = new EventEmitter();\n\n  constructor({\n    additionalFinishStatuses,\n    messenger,\n    name,\n    securityProviderRequest,\n    state = {} as MessageManagerState<Message>,\n  }: AbstractMessageManagerOptions<Message, Action, Event>) {\n    super({\n      messenger,\n      metadata: stateMetadata,\n      name,\n      state: {\n        ...getDefaultState(),\n        ...state,\n      },\n    });\n    this.messages = [];\n    this.securityProviderRequest = securityProviderRequest;\n    this.additionalFinishStatuses = additionalFinishStatuses ?? [];\n  }\n\n  /**\n   * Adds request props to the messsage params and returns a new messageParams object.\n   * @param messageParams - The messageParams to add the request props to.\n   * @param req - The original request object.\n   * @returns The messageParams with the request props added.\n   */\n  protected addRequestToMessageParams<\n    MessageParams extends AbstractMessageParams,\n  >(messageParams: MessageParams, req?: OriginalRequest) {\n    const updatedMessageParams = {\n      ...messageParams,\n    };\n\n    if (req) {\n      updatedMessageParams.requestId = req.id;\n      updatedMessageParams.origin = req.origin;\n    }\n\n    return updatedMessageParams;\n  }\n\n  /**\n   * Creates a new Message with a random id and an 'unapproved' status.\n   * @param messageParams - The messageParams to add the request props to.\n   * @param type - The approval type of the message.\n   * @param req - The original request object.\n   * @returns The new unapproved message for a specified type.\n   */\n  protected createUnapprovedMessage<\n    MessageParams extends AbstractMessageParams,\n  >(messageParams: MessageParams, type: ApprovalType, req?: OriginalRequest) {\n    const messageId = random();\n\n    return {\n      id: messageId,\n      messageParams,\n      securityAlertResponse: req?.securityAlertResponse,\n      status: 'unapproved',\n      time: Date.now(),\n      type,\n    };\n  }\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    this.update((state) => {\n      state.unapprovedMessages =\n        this.getUnapprovedMessages() as unknown as Record<\n          string,\n          Draft<Message>\n        >;\n      state.unapprovedMessagesCount = this.getUnapprovedMessagesCount();\n    });\n    if (emitUpdateBadge) {\n      // Empty payload is used to satisfy event constraint for BaseControllerV2\n      this.messagingSystem.publish(`${this.name as string}: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(\n        `${this.name as string}: Message not found for id: ${messageId}.`,\n      );\n    }\n    const updatedMessage = {\n      ...message,\n      status,\n    };\n    this.updateMessage(updatedMessage);\n    this.internalEvents.emit(`${messageId}:${status}`, updatedMessage);\n    if (\n      status === 'rejected' ||\n      status === 'signed' ||\n      status === 'errored' ||\n      this.additionalFinishStatuses.includes(status)\n    ) {\n      this.internalEvents.emit(\n        `${messageId as string}:finished`,\n        updatedMessage,\n      );\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: Message, 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: Message): Promise<Message> {\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  clearUnapprovedMessages() {\n    this.update((state) => {\n      state.unapprovedMessages = {};\n      state.unapprovedMessagesCount = 0;\n    });\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: Record<string, Message>, message) => {\n        result[message.id] = message;\n        return result;\n      }, {});\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: Message) {\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: ParamsMetamask): Promise<Params> {\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    this.updateMessage(\n      {\n        ...message,\n        rawSig: result,\n      },\n      false,\n    );\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  setMetadata(messageId: string, metadata: Json) {\n    const message = this.getMessage(messageId);\n    if (!message) {\n      throw new Error(\n        `${this.name as string}: Message not found for id: ${messageId}.`,\n      );\n    }\n    this.updateMessage(\n      {\n        ...message,\n        metadata,\n      },\n      false,\n    );\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(\n    messageParams: ParamsMetamask,\n  ): Promise<Params>;\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: ParamsMetamask,\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.internalEvents.once(\n        `${messageId as string}:finished`,\n        (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(\n                  `MetaMask ${messageName} Signature: ${data.error as string}`,\n                ),\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}\n\nexport default AbstractMessageManager;\n"]}
+{"version":3,"file":"AbstractMessageManager.cjs","sourceRoot":"","sources":["../src/AbstractMessageManager.ts"],"names":[],"mappings":";;;AACA,+DAA6D;AAG7D,kEAAkE;AAClE,oDAAoD;AACpD,mCAAsC;AACtC,+BAAoC;AA2GpC;;GAEG;AACH,MAAsB,sBAUpB,SAAQ,kCAAoD;IAS5D;;;;;OAKG;IACO,yBAAyB,CAEjC,aAA4B,EAAE,GAAqB;QACnD,MAAM,oBAAoB,GAAG;YAC3B,GAAG,aAAa;SACjB,CAAC;QAEF,IAAI,GAAG,EAAE;YACP,oBAAoB,CAAC,SAAS,GAAG,GAAG,CAAC,EAAE,CAAC;YACxC,oBAAoB,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;SAC1C;QAED,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACO,uBAAuB,CAE/B,aAA4B,EAAE,IAAkB,EAAE,GAAqB;QACvE,MAAM,SAAS,GAAG,IAAA,SAAM,GAAE,CAAC;QAE3B,OAAO;YACL,EAAE,EAAE,SAAS;YACb,aAAa;YACb,qBAAqB,EAAE,GAAG,EAAE,qBAAqB;YACjD,MAAM,EAAE,YAAY;YACpB,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;YAChB,IAAI;SACL,CAAC;IACJ,CAAC;IAED;;;;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;IACK,KAAK,CAAC,aAAa,CAAC,OAAU;QACpC,IAAI,IAAI,CAAC,uBAAuB,EAAE;YAChC,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC,uBAAuB,CACjE,OAAO,EACP,OAAO,CAAC,IAAI,CACb,CAAC;YACF,OAAO;gBACL,GAAG,OAAO;gBACV,wBAAwB;aACzB,CAAC;SACH;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAYD;;;;;;;;OAQG;IACH,YACE,MAA4B,EAC5B,KAAuC,EACvC,uBAAiD,EACjD,wBAAmC,EACnC,iBAAqC;QAErC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QA1BvB;;WAEG;QACH,QAAG,GAAiB,IAAI,qBAAY,EAAE,CAAC;QAEvC;;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,IAAI,EAAE,CAAC;QAC/D,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;;;;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;IACH,KAAK,CAAC,UAAU,CAAC,OAAU;QACzB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACnC,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;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;IACH,KAAK,CAAC,mBAAmB,CACvB,mBAAkD,EAClD,WAAmB;QAEnB,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,aAAa,EAAE,GAAG,mBAAmB,CAAC;QACxE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,gFAAgF;YAChF,4EAA4E;YAC5E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,WAAW,EAAE,CAAC,IAAqB,EAAE,EAAE;gBAC/D,QAAQ,IAAI,CAAC,MAAM,EAAE;oBACnB,KAAK,QAAQ;wBACX,OAAO,OAAO,CAAC,IAAI,CAAC,MAAgB,CAAC,CAAC;oBACxC,KAAK,UAAU;wBACb,OAAO,MAAM,CACX,IAAI,KAAK,CACP,YAAY,WAAW,4CAA4C,CACpE,CACF,CAAC;oBACJ,KAAK,SAAS;wBACZ,OAAO,MAAM;wBACX,gFAAgF;wBAChF,4EAA4E;wBAC5E,IAAI,KAAK,CAAC,YAAY,WAAW,eAAe,IAAI,CAAC,KAAK,EAAE,CAAC,CAC9D,CAAC;oBACJ;wBACE,OAAO,MAAM,CACX,IAAI,KAAK,CACP,YAAY,WAAW,gCAAgC,IAAI,CAAC,SAAS,CACnE,aAAa,CACd,EAAE,CACJ,CACF,CAAC;iBACL;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA5YD,wDA4YC;AAED,kBAAe,sBAAsB,CAAC","sourcesContent":["import type { BaseConfig, BaseState } from '@metamask/base-controller';\nimport { BaseControllerV1 } from '@metamask/base-controller';\nimport type { ApprovalType } from '@metamask/controller-utils';\nimport type { Hex, Json } from '@metamask/utils';\n// This package purposefully relies on Node's EventEmitter module.\n// eslint-disable-next-line import/no-nodejs-modules\nimport { EventEmitter } from 'events';\nimport { v1 as random } from 'uuid';\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 */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface OriginalRequest {\n  id?: number;\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 */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\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 AbstractMessageParams\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 requestId? - Original request id\n * @property deferSetAsSigned? - Whether to defer setting the message as signed immediately after the keyring is told to sign it\n */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface AbstractMessageParams {\n  from: string;\n  origin?: string;\n  requestId?: number;\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 */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\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 */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions, @typescript-eslint/naming-convention\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\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\ntype getCurrentChainId = () => Hex;\n\n/**\n * Controller in charge of managing - storing, adding, removing, updating - Messages.\n */\nexport abstract class AbstractMessageManager<\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  M extends AbstractMessage,\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  P extends AbstractMessageParams,\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  PM extends AbstractMessageParamsMetamask,\n> extends BaseControllerV1<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   * Adds request props to the messsage params and returns a new messageParams object.\n   * @param messageParams - The messageParams to add the request props to.\n   * @param req - The original request object.\n   * @returns The messageParams with the request props added.\n   */\n  protected addRequestToMessageParams<\n    MessageParams extends AbstractMessageParams,\n  >(messageParams: MessageParams, req?: OriginalRequest) {\n    const updatedMessageParams = {\n      ...messageParams,\n    };\n\n    if (req) {\n      updatedMessageParams.requestId = req.id;\n      updatedMessageParams.origin = req.origin;\n    }\n\n    return updatedMessageParams;\n  }\n\n  /**\n   * Creates a new Message with a random id and an 'unapproved' status.\n   * @param messageParams - The messageParams to add the request props to.\n   * @param type - The approval type of the message.\n   * @param req - The original request object.\n   * @returns The new unapproved message for a specified type.\n   */\n  protected createUnapprovedMessage<\n    MessageParams extends AbstractMessageParams,\n  >(messageParams: MessageParams, type: ApprovalType, req?: OriginalRequest) {\n    const messageId = random();\n\n    return {\n      id: messageId,\n      messageParams,\n      securityAlertResponse: req?.securityAlertResponse,\n      status: 'unapproved',\n      time: Date.now(),\n      type,\n    };\n  }\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: EventEmitter = 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      // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\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              // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n              // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\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/AbstractMessageManager.d.cts

@@ -1,8 +1,8 @@
 /// <reference types="node" />
-import { BaseController } from "@metamask/base-controller";
-import type { ActionConstraint, EventConstraint, RestrictedControllerMessenger } from "@metamask/base-controller";
+import type { BaseConfig, BaseState } from "@metamask/base-controller";
+import { BaseControllerV1 } from "@metamask/base-controller";
 import type { ApprovalType } from "@metamask/controller-utils";
-import type { Json } from "@metamask/utils";
+import type { Hex, Json } from "@metamask/utils";
 import { EventEmitter } from "events";
 /**
  * @type OriginalRequest
@@ -10,13 +10,13 @@ import { EventEmitter } from "events";
  * Represents the original request object for adding a message.
  * @property origin? - Is it is specified, represents the origin
  */
-export type OriginalRequest = {
+export interface OriginalRequest {
     id?: number;
     origin?: string;
     securityAlertResponse?: Record<string, Json>;
-};
+}
 /**
- * @type AbstractMessage
+ * @type Message
  *
  * Represents and contains data about a signing type signature request.
  * @property id - An id to track and identify the message object
@@ -26,7 +26,7 @@ export type OriginalRequest = {
  * @property securityProviderResponse - Response from a security provider, whether it is malicious or not
  * @property metadata - Additional data for the message, for example external identifiers
  */
-export type AbstractMessage = {
+export interface AbstractMessage {
     id: string;
     time: number;
     status: string;
@@ -36,7 +36,7 @@ export type AbstractMessage = {
     securityAlertResponse?: Record<string, Json>;
     metadata?: Json;
     error?: string;
-};
+}
 /**
  * @type AbstractMessageParams
  *
@@ -46,12 +46,12 @@ export type AbstractMessage = {
  * @property requestId? - Original request id
  * @property deferSetAsSigned? - Whether to defer setting the message as signed immediately after the keyring is told to sign it
  */
-export type AbstractMessageParams = {
+export interface AbstractMessageParams {
     from: string;
     origin?: string;
     requestId?: number;
     deferSetAsSigned?: boolean;
-};
+}
 /**
  * @type MessageParamsMetamask
  *
@@ -61,9 +61,9 @@ export type AbstractMessageParams = {
  * @property from - Address from which the message is processed
  * @property origin? - Added for request origin identification
  */
-export type AbstractMessageParamsMetamask = AbstractMessageParams & {
+export interface AbstractMessageParamsMetamask extends AbstractMessageParams {
     metamaskId?: string;
-};
+}
 /**
  * @type MessageManagerState
  *
@@ -71,43 +71,25 @@ export type AbstractMessageParamsMetamask = AbstractMessageParams & {
  * @property unapprovedMessages - A collection of all Messages in the 'unapproved' state
  * @property unapprovedMessagesCount - The count of all Messages in this.unapprovedMessages
  */
-export type MessageManagerState<Message extends AbstractMessage> = {
-    unapprovedMessages: Record<string, Message>;
+export interface MessageManagerState<M extends AbstractMessage> extends BaseState {
+    unapprovedMessages: {
+        [key: string]: M;
+    };
     unapprovedMessagesCount: number;
-};
-export type UpdateBadgeEvent = {
-    type: `${string}:updateBadge`;
-    payload: [unusedPayload: string];
-};
+}
 /**
  * A function for verifying a message, whether it is malicious or not
  */
 export type SecurityProviderRequest = (requestData: AbstractMessage, messageType: string) => Promise<Json>;
-/**
- * AbstractMessageManager constructor options.
- *
- * @property additionalFinishStatuses - Optional list of statuses that are accepted to emit a finished event.
- * @property messenger - Controller messaging system.
- * @property name - The name of the manager.
- * @property securityProviderRequest - A function for verifying a message, whether it is malicious or not.
- * @property state - Initial state to set on this controller.
- */
-export type AbstractMessageManagerOptions<Message extends AbstractMessage, Action extends ActionConstraint, Event extends EventConstraint> = {
-    additionalFinishStatuses?: string[];
-    messenger: RestrictedControllerMessenger<string, Action, Event | UpdateBadgeEvent, string, string>;
-    name: string;
-    securityProviderRequest?: SecurityProviderRequest;
-    state?: MessageManagerState<Message>;
-};
+type getCurrentChainId = () => Hex;
 /**
  * Controller in charge of managing - storing, adding, removing, updating - Messages.
  */
-export declare abstract class AbstractMessageManager<Message extends AbstractMessage, Params extends AbstractMessageParams, ParamsMetamask extends AbstractMessageParamsMetamask, Action extends ActionConstraint, Event extends EventConstraint> extends BaseController<string, MessageManagerState<Message>, RestrictedControllerMessenger<string, Action, Event | UpdateBadgeEvent, string, string>> {
-    protected messages: Message[];
+export declare abstract class AbstractMessageManager<M extends AbstractMessage, P extends AbstractMessageParams, PM extends AbstractMessageParamsMetamask> extends BaseControllerV1<BaseConfig, MessageManagerState<M>> {
+    protected messages: M[];
+    protected getCurrentChainId: getCurrentChainId | undefined;
     private readonly securityProviderRequest;
     private readonly additionalFinishStatuses;
-    internalEvents: EventEmitter<[never]>;
-    constructor({ additionalFinishStatuses, messenger, name, securityProviderRequest, state, }: AbstractMessageManagerOptions<Message, Action, Event>);
     /**
      * Adds request props to the messsage params and returns a new messageParams object.
      * @param messageParams - The messageParams to add the request props to.
@@ -150,7 +132,7 @@ export declare abstract class AbstractMessageManager<Message extends AbstractMes
      * @param message - A Message that will replace an existing Message (with the id) in this.messages.
      * @param emitUpdateBadge - Whether to emit the updateBadge event.
      */
-    protected updateMessage(message: Message, emitUpdateBadge?: boolean): void;
+    protected updateMessage(message: M, emitUpdateBadge?: boolean): void;
     /**
      * Verifies a message is malicious or not by checking it against a security provider.
      *
@@ -158,7 +140,24 @@ export declare abstract class AbstractMessageManager<Message extends AbstractMes
      * @returns A promise that resolves to a secured message with additional security provider response data.
      */
     private securityCheck;
-    clearUnapprovedMessages(): void;
+    /**
+     * EventEmitter instance used to listen to specific message events
+     */
+    hub: EventEmitter;
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
+    /**
+     * 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?: Partial<BaseConfig>, state?: Partial<MessageManagerState<M>>, securityProviderRequest?: SecurityProviderRequest, additionalFinishStatuses?: string[], getCurrentChainId?: getCurrentChainId);
     /**
      * A getter for the number of 'unapproved' Messages in this.messages.
      *
@@ -170,14 +169,16 @@ export declare abstract class AbstractMessageManager<Message extends AbstractMes
      *
      * @returns An index of Message ids to Messages, for all 'unapproved' Messages in this.messages.
      */
-    getUnapprovedMessages(): Record<string, Message>;
+    getUnapprovedMessages(): {
+        [key: string]: M;
+    };
     /**
      * 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: Message): Promise<void>;
+    addMessage(message: M): Promise<void>;
     /**
      * Returns a specified Message.
      *
@@ -185,13 +186,13 @@ export declare abstract class AbstractMessageManager<Message extends AbstractMes
      * @returns The Message with the id that matches the passed messageId, or undefined
      * if no Message has that id.
      */
-    getMessage(messageId: string): Message | undefined;
+    getMessage(messageId: string): M | undefined;
     /**
      * Returns all the messages.
      *
      * @returns An array of messages.
      */
-    getAllMessages(): Message[];
+    getAllMessages(): M[];
     /**
      * 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.
@@ -200,7 +201,7 @@ export declare abstract class AbstractMessageManager<Message extends AbstractMes
      * plus data added by MetaMask.
      * @returns Promise resolving to the messageParams with the metamaskId property removed.
      */
-    approveMessage(messageParams: ParamsMetamask): Promise<Params>;
+    approveMessage(messageParams: PM): Promise<P>;
     /**
      * Sets a Message status to 'approved' via a call to this.setMessageStatus.
      *
@@ -252,7 +253,7 @@ export declare abstract class AbstractMessageManager<Message extends AbstractMes
      * @param messageParams - The messageParams to modify
      * @returns Promise resolving to the messageParams with the metamaskId property removed
      */
-    abstract prepMessageForSigning(messageParams: ParamsMetamask): Promise<Params>;
+    abstract prepMessageForSigning(messageParams: PM): Promise<P>;
     /**
      * 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
@@ -263,7 +264,7 @@ export declare abstract class AbstractMessageManager<Message extends AbstractMes
      * @param version? - The version of the JSON RPC protocol the request is using.
      * @returns The id of the newly created message.
      */
-    abstract addUnapprovedMessage(messageParams: ParamsMetamask, request: OriginalRequest, version?: string): Promise<string>;
+    abstract addUnapprovedMessage(messageParams: PM, request: OriginalRequest, version?: string): Promise<string>;
     /**
      * Sets a Message status to 'rejected' via a call to this.setMessageStatus.
      *

package/dist/AbstractMessageManager.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractMessageManager.d.cts","sourceRoot":"","sources":["../src/AbstractMessageManager.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,6BAA6B,EAC9B,kCAAkC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,mCAAmC;AAC/D,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAG5C,OAAO,EAAE,YAAY,EAAE,eAAe;AActC;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChD,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC7C,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,6BAA6B,GAAG,qBAAqB,GAAG;IAClE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,CAAC,OAAO,SAAS,eAAe,IAAI;IACjE,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5C,uBAAuB,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,GAAG,MAAM,cAAc,CAAC;IAC9B,OAAO,EAAE,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CACpC,WAAW,EAAE,eAAe,EAC5B,WAAW,EAAE,MAAM,KAChB,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;;;;;;GAQG;AACH,MAAM,MAAM,6BAA6B,CACvC,OAAO,SAAS,eAAe,EAC/B,MAAM,SAAS,gBAAgB,EAC/B,KAAK,SAAS,eAAe,IAC3B;IACF,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC,SAAS,EAAE,6BAA6B,CACtC,MAAM,EACN,MAAM,EACN,KAAK,GAAG,gBAAgB,EACxB,MAAM,EACN,MAAM,CACP,CAAC;IACF,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;IAClD,KAAK,CAAC,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,8BAAsB,sBAAsB,CAC1C,OAAO,SAAS,eAAe,EAC/B,MAAM,SAAS,qBAAqB,EACpC,cAAc,SAAS,6BAA6B,EACpD,MAAM,SAAS,gBAAgB,EAC/B,KAAK,SAAS,eAAe,CAC7B,SAAQ,cAAc,CACtB,MAAM,EACN,mBAAmB,CAAC,OAAO,CAAC,EAC5B,6BAA6B,CAC3B,MAAM,EACN,MAAM,EACN,KAAK,GAAG,gBAAgB,EACxB,MAAM,EACN,MAAM,CACP,CACF;IACC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAE9B,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAsC;IAE9E,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAW;IAEpD,cAAc,wBAAsB;gBAExB,EACV,wBAAwB,EACxB,SAAS,EACT,IAAI,EACJ,uBAAuB,EACvB,KAA0C,GAC3C,EAAE,6BAA6B,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC;IAexD;;;;;OAKG;IACH,SAAS,CAAC,yBAAyB,CACjC,aAAa,SAAS,qBAAqB,EAC3C,aAAa,EAAE,aAAa,EAAE,GAAG,CAAC,EAAE,eAAe;IAarD;;;;;;OAMG;IACH,SAAS,CAAC,uBAAuB,CAC/B,aAAa,SAAS,qBAAqB,EAC3C,aAAa,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,eAAe;;;;;;;;IAazE;;;;OAIG;IACH,SAAS,CAAC,eAAe,CAAC,eAAe,UAAO;IAehD;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IA0B5D;;;;;;OAMG;IACH,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,UAAO;IAShE;;;;;OAKG;YACW,aAAa;IAc3B,uBAAuB;IAOvB;;;;OAIG;IACH,0BAA0B;IAI1B;;;;OAIG;IACH,qBAAqB;IASrB;;;;;OAKG;IACG,UAAU,CAAC,OAAO,EAAE,OAAO;IAMjC;;;;;;OAMG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM;IAI5B;;;;OAIG;IACH,cAAc;IAId;;;;;;;OAOG;IACH,cAAc,CAAC,aAAa,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAO9D;;;;OAIG;IACH,wBAAwB,CAAC,SAAS,EAAE,MAAM;IAI1C;;;;;OAKG;IACH,0BAA0B,CAAC,SAAS,EAAE,MAAM;IAI5C;;;;;;;OAOG;IACH,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAIxD;;;;;;OAMG;IACH,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK3E;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAe3C;;;;;OAKG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI;IAgB7C;;;;;;OAMG;IACH,QAAQ,CAAC,qBAAqB,CAC5B,aAAa,EAAE,cAAc,GAC5B,OAAO,CAAC,MAAM,CAAC;IAElB;;;;;;;;;OASG;IACH,QAAQ,CAAC,oBAAoB,CAC3B,aAAa,EAAE,cAAc,EAC7B,OAAO,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC;IAElB;;;;OAIG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM;IAI/B;;;;;;OAMG;IACG,mBAAmB,CACvB,mBAAmB,EAAE,6BAA6B,EAClD,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC;CAkCnB;AAED,eAAe,sBAAsB,CAAC"}
+{"version":3,"file":"AbstractMessageManager.d.cts","sourceRoot":"","sources":["../src/AbstractMessageManager.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,kCAAkC;AACvE,OAAO,EAAE,gBAAgB,EAAE,kCAAkC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,mCAAmC;AAC/D,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,wBAAwB;AAGjD,OAAO,EAAE,YAAY,EAAE,eAAe;AAGtC;;;;;GAKG;AAIH,MAAM,WAAW,eAAe;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;GAUG;AAIH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChD,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC7C,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;GAQG;AAIH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;;GAQG;AAIH,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AAKH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,eAAe,CAC5D,SAAQ,SAAS;IACjB,kBAAkB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;KAAE,CAAC;IACzC,uBAAuB,EAAE,MAAM,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CACpC,WAAW,EAAE,eAAe,EAC5B,WAAW,EAAE,MAAM,KAChB,OAAO,CAAC,IAAI,CAAC,CAAC;AAInB,KAAK,iBAAiB,GAAG,MAAM,GAAG,CAAC;AAEnC;;GAEG;AACH,8BAAsB,sBAAsB,CAG1C,CAAC,SAAS,eAAe,EAGzB,CAAC,SAAS,qBAAqB,EAG/B,EAAE,SAAS,6BAA6B,CACxC,SAAQ,gBAAgB,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAC5D,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;IAExB,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE3D,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAsC;IAE9E,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAW;IAEpD;;;;;OAKG;IACH,SAAS,CAAC,yBAAyB,CACjC,aAAa,SAAS,qBAAqB,EAC3C,aAAa,EAAE,aAAa,EAAE,GAAG,CAAC,EAAE,eAAe;IAarD;;;;;;OAMG;IACH,SAAS,CAAC,uBAAuB,CAC/B,aAAa,SAAS,qBAAqB,EAC3C,aAAa,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,eAAe;;;;;;;;IAazE;;;;OAIG;IACH,SAAS,CAAC,eAAe,CAAC,eAAe,UAAO;IAShD;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAkB5D;;;;;;OAMG;IACH,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,EAAE,eAAe,UAAO;IAS1D;;;;;OAKG;YACW,aAAa;IAc3B;;OAEG;IACH,GAAG,EAAE,YAAY,CAAsB;IAEvC;;OAEG;IACM,IAAI,SAA4B;IAEzC;;;;;;;;OAQG;gBAED,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,EAC5B,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,EACvC,uBAAuB,CAAC,EAAE,uBAAuB,EACjD,wBAAwB,CAAC,EAAE,MAAM,EAAE,EACnC,iBAAiB,CAAC,EAAE,iBAAiB;IAcvC;;;;OAIG;IACH,0BAA0B;IAI1B;;;;OAIG;IACH,qBAAqB;;;IASrB;;;;;OAKG;IACG,UAAU,CAAC,OAAO,EAAE,CAAC;IAM3B;;;;;;OAMG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM;IAI5B;;;;OAIG;IACH,cAAc;IAId;;;;;;;OAOG;IACH,cAAc,CAAC,aAAa,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAO7C;;;;OAIG;IACH,wBAAwB,CAAC,SAAS,EAAE,MAAM;IAI1C;;;;;OAKG;IACH,0BAA0B,CAAC,SAAS,EAAE,MAAM;IAI5C;;;;;;;OAOG;IACH,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAIxD;;;;;;OAMG;IACH,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK3E;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAU3C;;;;;OAKG;IAEH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI;IAS7C;;;;;;OAMG;IACH,QAAQ,CAAC,qBAAqB,CAAC,aAAa,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAE7D;;;;;;;;;OASG;IACH,QAAQ,CAAC,oBAAoB,CAC3B,aAAa,EAAE,EAAE,EACjB,OAAO,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC;IAElB;;;;OAIG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM;IAI/B;;;;;;OAMG;IACG,mBAAmB,CACvB,mBAAmB,EAAE,6BAA6B,EAClD,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC;CAiCnB;AAED,eAAe,sBAAsB,CAAC"}