@metamask/shield-controller 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -7,6 +7,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0]
+
+### Added
+
+- Added optional constructor params, `normalizeSignatureRequest` function which normalize the requests for TypedSignature similar to the security-alerts API. ([#6906](https://github.com/MetaMask/core/pull/6906))
+- Added util function, `parseSignatureRequestMethod` to correctly parse the Json-Rpc method value for the signature request. ([#6906](https://github.com/MetaMask/core/pull/6906))
+
+### Changed
+
+- Bump `@metamask/base-controller` from `^8.4.1` to `^8.4.2` ([#6917](https://github.com/MetaMask/core/pull/6917))
+- Bump `@metamask/transaction-controller` from `^60.7.0` to `^60.8.0` ([#6883](https://github.com/MetaMask/core/pull/6883))
+- Updated internal MessagingSystem subscriber for TransactionController and SignatureController `stateChange` events. ([#6906](https://github.com/MetaMask/core/pull/6906))
+  - Removed `personal_sign` check from the signature-coverage check. Now every signature requests will be sent to ruleset-engine.
+  - Updated `TransactionMeta.SimulationData` check conditional to shallow comparison instead of referential comparison, to avoid triggering unnecessary coverage-check requests.
+- Removed signature data validation from the internal `makeInitSignatureCoverageCheckBody` function. ([#6906](https://github.com/MetaMask/core/pull/6906))
+  - As signature data is not always `string` (e.g. `eth_signTypedData` uses Array of Object) and the data is already validated in the SignatureController before adding to the state.
+
+## [0.3.2]
+
+### Changed
+
+- Make start and stop idempotent ([#6817](https://github.com/MetaMask/core/pull/6817))
+
+### Fixed
+
+- Fixed incorrect endpoint for signature coverage result. ([#6821](https://github.com/MetaMask/core/pull/6821))
+
 ## [0.3.1]
 
 ### Changed
@@ -57,7 +84,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release of the shield-controller package ([#6137](https://github.com/MetaMask/core/pull/6137)
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.3.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.4.0...HEAD
+[0.4.0]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.3.2...@metamask/shield-controller@0.4.0
+[0.3.2]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.3.1...@metamask/shield-controller@0.3.2
 [0.3.1]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.3.0...@metamask/shield-controller@0.3.1
 [0.3.0]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.2.0...@metamask/shield-controller@0.3.0
 [0.2.0]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.1.2...@metamask/shield-controller@0.2.0

package/dist/ShieldController.cjs

@@ -10,12 +10,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _ShieldController_instances, _ShieldController_backend, _ShieldController_coverageHistoryLimit, _ShieldController_transactionHistoryLimit, _ShieldController_transactionControllerStateChangeHandler, _ShieldController_signatureControllerStateChangeHandler, _ShieldController_handleSignatureControllerStateChange, _ShieldController_handleTransactionControllerStateChange, _ShieldController_addCoverageResult, _ShieldController_logSignature, _ShieldController_logTransaction, _ShieldController_getCoverageStatus, _ShieldController_getLatestCoverageId;
+var _ShieldController_instances, _ShieldController_backend, _ShieldController_coverageHistoryLimit, _ShieldController_transactionHistoryLimit, _ShieldController_normalizeSignatureRequest, _ShieldController_transactionControllerStateChangeHandler, _ShieldController_signatureControllerStateChangeHandler, _ShieldController_started, _ShieldController_handleSignatureControllerStateChange, _ShieldController_handleTransactionControllerStateChange, _ShieldController_addCoverageResult, _ShieldController_logSignature, _ShieldController_logTransaction, _ShieldController_getCoverageStatus, _ShieldController_getLatestCoverageId;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShieldController = exports.getDefaultShieldControllerState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
 const signature_controller_1 = require("@metamask/signature-controller");
 const transaction_controller_1 = require("@metamask/transaction-controller");
+const lodash_1 = require("lodash");
 const constants_1 = require("./constants.cjs");
 const logger_1 = require("./logger.cjs");
 const log = (0, logger_1.createModuleLogger)(logger_1.projectLogger, 'ShieldController');
@@ -51,7 +52,7 @@ const metadata = {
 };
 class ShieldController extends base_controller_1.BaseController {
     constructor(options) {
-        const { messenger, state, backend, transactionHistoryLimit = 100, coverageHistoryLimit = 10, } = options;
+        const { messenger, state, backend, transactionHistoryLimit = 100, coverageHistoryLimit = 10, normalizeSignatureRequest, } = options;
         super({
             name: constants_1.controllerName,
             metadata,
@@ -65,19 +66,31 @@ class ShieldController extends base_controller_1.BaseController {
         _ShieldController_backend.set(this, void 0);
         _ShieldController_coverageHistoryLimit.set(this, void 0);
         _ShieldController_transactionHistoryLimit.set(this, void 0);
+        _ShieldController_normalizeSignatureRequest.set(this, void 0);
         _ShieldController_transactionControllerStateChangeHandler.set(this, void 0);
         _ShieldController_signatureControllerStateChangeHandler.set(this, void 0);
+        _ShieldController_started.set(this, void 0);
         __classPrivateFieldSet(this, _ShieldController_backend, backend, "f");
         __classPrivateFieldSet(this, _ShieldController_coverageHistoryLimit, coverageHistoryLimit, "f");
         __classPrivateFieldSet(this, _ShieldController_transactionHistoryLimit, transactionHistoryLimit, "f");
         __classPrivateFieldSet(this, _ShieldController_transactionControllerStateChangeHandler, __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_handleTransactionControllerStateChange).bind(this), "f");
         __classPrivateFieldSet(this, _ShieldController_signatureControllerStateChangeHandler, __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_handleSignatureControllerStateChange).bind(this), "f");
+        __classPrivateFieldSet(this, _ShieldController_started, false, "f");
+        __classPrivateFieldSet(this, _ShieldController_normalizeSignatureRequest, normalizeSignatureRequest, "f");
     }
     start() {
+        if (__classPrivateFieldGet(this, _ShieldController_started, "f")) {
+            return;
+        }
+        __classPrivateFieldSet(this, _ShieldController_started, true, "f");
         this.messagingSystem.subscribe('TransactionController:stateChange', __classPrivateFieldGet(this, _ShieldController_transactionControllerStateChangeHandler, "f"), (state) => state.transactions);
         this.messagingSystem.subscribe('SignatureController:stateChange', __classPrivateFieldGet(this, _ShieldController_signatureControllerStateChangeHandler, "f"), (state) => state.signatureRequests);
     }
     stop() {
+        if (!__classPrivateFieldGet(this, _ShieldController_started, "f")) {
+            return;
+        }
+        __classPrivateFieldSet(this, _ShieldController_started, false, "f");
         this.messagingSystem.unsubscribe('TransactionController:stateChange', __classPrivateFieldGet(this, _ShieldController_transactionControllerStateChangeHandler, "f"));
         this.messagingSystem.unsubscribe('SignatureController:stateChange', __classPrivateFieldGet(this, _ShieldController_signatureControllerStateChangeHandler, "f"));
     }
@@ -109,8 +122,13 @@ class ShieldController extends base_controller_1.BaseController {
     async checkSignatureCoverage(signatureRequest) {
         // Check coverage
         const coverageId = __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_getLatestCoverageId).call(this, signatureRequest.id);
+        // Normalize the signature request before sending it to the backend.
+        // This is to ensure that the signature data is normalized and consistent as the security alerts api calls.
+        const clonedSignatureRequest = (0, lodash_1.cloneDeep)(signatureRequest);
+        const normalizedSignatureRequest = __classPrivateFieldGet(this, _ShieldController_normalizeSignatureRequest, "f")?.call(this, clonedSignatureRequest) ??
+            clonedSignatureRequest;
         const coverageResult = await __classPrivateFieldGet(this, _ShieldController_backend, "f").checkSignatureCoverage({
-            signatureRequest,
+            signatureRequest: normalizedSignatureRequest,
             coverageId,
         });
         // Publish coverage result
@@ -121,16 +139,14 @@ class ShieldController extends base_controller_1.BaseController {
     }
 }
 exports.ShieldController = ShieldController;
-_ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimit = new WeakMap(), _ShieldController_transactionHistoryLimit = new WeakMap(), _ShieldController_transactionControllerStateChangeHandler = new WeakMap(), _ShieldController_signatureControllerStateChangeHandler = new WeakMap(), _ShieldController_instances = new WeakSet(), _ShieldController_handleSignatureControllerStateChange = function _ShieldController_handleSignatureControllerStateChange(signatureRequests, previousSignatureRequests) {
+_ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimit = new WeakMap(), _ShieldController_transactionHistoryLimit = new WeakMap(), _ShieldController_normalizeSignatureRequest = new WeakMap(), _ShieldController_transactionControllerStateChangeHandler = new WeakMap(), _ShieldController_signatureControllerStateChangeHandler = new WeakMap(), _ShieldController_started = new WeakMap(), _ShieldController_instances = new WeakSet(), _ShieldController_handleSignatureControllerStateChange = function _ShieldController_handleSignatureControllerStateChange(signatureRequests, previousSignatureRequests) {
     const signatureRequestsArray = Object.values(signatureRequests);
     const previousSignatureRequestsArray = Object.values(previousSignatureRequests ?? {});
     const previousSignatureRequestsById = new Map(previousSignatureRequestsArray.map((request) => [request.id, request]));
     for (const signatureRequest of signatureRequestsArray) {
         const previousSignatureRequest = previousSignatureRequestsById.get(signatureRequest.id);
-        // Check coverage if the signature request is new and has type
-        // `personal_sign`.
-        if (!previousSignatureRequest &&
-            signatureRequest.type === signature_controller_1.SignatureRequestType.PersonalSign) {
+        // Check coverage if the signature request is new.
+        if (!previousSignatureRequest) {
             this.checkSignatureCoverage(signatureRequest).catch(
             // istanbul ignore next
             (error) => log('Error checking coverage:', error));
@@ -147,12 +163,11 @@ _ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimi
     const previousTransactionsById = new Map(previousTransactions?.map((tx) => [tx.id, tx]) ?? []);
     for (const transaction of transactions) {
         const previousTransaction = previousTransactionsById.get(transaction.id);
+        // Check if the simulation data has changed.
+        const simulationDataNotChanged = (0, lodash_1.isEqual)(transaction.simulationData, previousTransaction?.simulationData);
         // Check coverage if the transaction is new or if the simulation data has
         // changed.
-        if (!previousTransaction ||
-            // Checking reference equality is sufficient because this object is
-            // replaced if the simulation data has changed.
-            previousTransaction.simulationData !== transaction.simulationData) {
+        if (!previousTransaction || !simulationDataNotChanged) {
             this.checkCoverage(transaction).catch(
             // istanbul ignore next
             (error) => log('Error checking coverage:', error));

package/dist/ShieldController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ShieldController.cjs","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAK3D,yEAKwC;AACxC,6EAI0C;AAE1C,+CAA6C;AAC7C,yCAA6D;AAG7D,MAAM,GAAG,GAAG,IAAA,2BAAkB,EAAC,sBAAa,EAAE,kBAAkB,CAAC,CAAC;AAuBlE;;;;GAIG;AACH,SAAgB,+BAA+B;IAC7C,OAAO;QACL,eAAe,EAAE,EAAE;QACnB,yBAAyB,EAAE,EAAE;KAC9B,CAAC;AACJ,CAAC;AALD,0EAKC;AAoDD;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE;QACf,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,IAAI;KACf;IACD,yBAAyB,EAAE;QACzB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAUF,MAAa,gBAAiB,SAAQ,gCAIrC;IAiBC,YAAY,OAAgC;QAC1C,MAAM,EACJ,SAAS,EACT,KAAK,EACL,OAAO,EACP,uBAAuB,GAAG,GAAG,EAC7B,oBAAoB,GAAG,EAAE,GAC1B,GAAG,OAAO,CAAC;QACZ,KAAK,CAAC;YACJ,IAAI,EAAE,0BAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAhCI,4CAAwB;QAExB,yDAA8B;QAE9B,4DAAiC;QAEjC,4EAGC;QAED,0EAGC;QAoBR,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,0CAAyB,oBAAoB,MAAA,CAAC;QAClD,uBAAA,IAAI,6CAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,6DACF,uBAAA,IAAI,6FAAwC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;QAC1D,uBAAA,IAAI,2DACF,uBAAA,IAAI,2FAAsC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;IAC1D,CAAC;IAED,KAAK;QACH,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,EAC7C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,EAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CACnC,CAAC;IACJ,CAAC;IAED,IAAI;QACF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,CAC9C,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,CAC5C,CAAC;IACJ,CAAC;IAgFD;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,iBAAiB;QACjB,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,EAAE,CAAC,CAAC;QACxD,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC,aAAa,CAAC;YACvD,MAAM;YACN,UAAU;SACX,CAAC,CAAC;QAEH,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,0BAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAEnD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,gBAAkC;QAElC,iBAAiB;QACjB,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAClE,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC,sBAAsB,CAAC;YAChE,gBAAgB;YAChB,UAAU;SACX,CAAC,CAAC;QAEH,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,0BAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,gBAAgB,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAE7D,OAAO,cAAc,CAAC;IACxB,CAAC;CA+FF;AA3SD,4CA2SC;wdAhOG,iBAAmD,EACnD,yBAAuE;IAEvE,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAChE,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAClD,yBAAyB,IAAI,EAAE,CAChC,CAAC;IACF,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAC3C,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CACvE,CAAC;IACF,KAAK,MAAM,gBAAgB,IAAI,sBAAsB,EAAE;QACrD,MAAM,wBAAwB,GAAG,6BAA6B,CAAC,GAAG,CAChE,gBAAgB,CAAC,EAAE,CACpB,CAAC;QAEF,8DAA8D;QAC9D,mBAAmB;QACnB,IACE,CAAC,wBAAwB;YACzB,gBAAgB,CAAC,IAAI,KAAK,2CAAoB,CAAC,YAAY,EAC3D;YACA,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,KAAK;YACjD,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,+DAA+D;QAC/D,IACE,gBAAgB,CAAC,MAAM,KAAK,6CAAsB,CAAC,MAAM;YACzD,gBAAgB,CAAC,MAAM,KAAK,wBAAwB,EAAE,MAAM,EAC5D;YACA,uBAAA,IAAI,mEAAc,MAAlB,IAAI,EAAe,gBAAgB,CAAC,CAAC,KAAK;YACxC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;KACF;AACH,CAAC,+HAGC,YAA+B,EAC/B,oBAAmD;IAEnD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CACtC,oBAAoB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CACrD,CAAC;IACF,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEzE,yEAAyE;QACzE,WAAW;QACX,IACE,CAAC,mBAAmB;YACpB,mEAAmE;YACnE,+CAA+C;YAC/C,mBAAmB,CAAC,cAAc,KAAK,WAAW,CAAC,cAAc,EACjE;YACA,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK;YACnC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,8CAA8C;QAC9C,IACE,WAAW,CAAC,MAAM,KAAK,0CAAiB,CAAC,SAAS;YAClD,WAAW,CAAC,MAAM,KAAK,mBAAmB,EAAE,MAAM,EAClD;YACA,uBAAA,IAAI,qEAAgB,MAApB,IAAI,EAAiB,WAAW,CAAC,CAAC,KAAK;YACrC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,CACpD,CAAC;SACH;KACF;AACH,CAAC,qFAwDkB,IAAY,EAAE,cAA8B;IAC7D,wCAAwC;IACxC,MAAM,gBAAgB,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,IAAI,CAAC,CAAC;IACzD,IAAI,gBAAgB,IAAI,cAAc,CAAC,UAAU,KAAK,gBAAgB,EAAE;QACtE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,+BAA+B;QAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtD,iCAAiC;QACjC,IAAI,CAAC,mBAAmB,EAAE;YACxB,QAAQ,GAAG,IAAI,CAAC;YAChB,mBAAmB,GAAG;gBACpB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC;SACnD;QAED,sCAAsC;QACtC,IAAI,mBAAmB,CAAC,OAAO,CAAC,MAAM,IAAI,uBAAA,IAAI,8CAAsB,EAAE;YACpE,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;SACnC;QAED,kBAAkB;QAClB,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpD,+BAA+B;QAC/B,MAAM,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;QAC5C,IAAI,WAA+B,CAAC;QACpC,IAAI,QAAQ,EAAE;YACZ,yCAAyC;YACzC,IAAI,yBAAyB,CAAC,MAAM,IAAI,uBAAA,IAAI,iDAAyB,EAAE;gBACrE,WAAW,GAAG,yBAAyB,CAAC,GAAG,EAAE,CAAC;gBAC9C,8CAA8C;gBAC9C,IAAI,WAAW,EAAE;oBACf,OAAO,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;iBAC3C;aACF;YACD,kBAAkB;YAClB,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACzC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,mCAED,KAAK,yCAAe,gBAAkC;IACpD,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC1C,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;KACxC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAEhE,MAAM,uBAAA,IAAI,iCAAS,CAAC,YAAY,CAAC;QAC/B,gBAAgB;QAChB,SAAS;QACT,MAAM;KACP,CAAC,CAAC;AACL,CAAC,qCAED,KAAK,2CAAiB,MAAuB;IAC3C,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC;IACpC,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,CAAC,CAAC;IAEtD,MAAM,uBAAA,IAAI,iCAAS,CAAC,cAAc,CAAC;QACjC,MAAM;QACN,eAAe;QACf,MAAM;KACP,CAAC,CAAC;AACL,CAAC,qFAEkB,MAAc;IAC/B,qCAAqC;IACrC,gCAAgC;IAChC,0CAA0C;IAC1C,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,CAAC;IACrD,IAAI,MAAM,GAAG,OAAO,CAAC;IACrB,IAAI,CAAC,UAAU,EAAE;QACf,GAAG,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;QACzC,MAAM,GAAG,WAAW,CAAC;KACtB;IACD,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC,yFAEoB,MAAc;IACjC,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;AACpE,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport {\n  SignatureRequestStatus,\n  SignatureRequestType,\n  type SignatureRequest,\n  type SignatureStateChange,\n} from '@metamask/signature-controller';\nimport {\n  TransactionStatus,\n  type TransactionControllerStateChangeEvent,\n  type TransactionMeta,\n} from '@metamask/transaction-controller';\n\nimport { controllerName } from './constants';\nimport { projectLogger, createModuleLogger } from './logger';\nimport type { CoverageResult, ShieldBackend } from './types';\n\nconst log = createModuleLogger(projectLogger, 'ShieldController');\n\nexport type CoverageResultRecordEntry = {\n  /**\n   * History of coverage results, latest first.\n   */\n  results: CoverageResult[];\n};\n\nexport type ShieldControllerState = {\n  /**\n   * Coverage results by transaction ID.\n   */\n  coverageResults: Record<\n    string, // txId\n    CoverageResultRecordEntry\n  >;\n  /**\n   * List of txIds ordered by time, latest first.\n   */\n  orderedTransactionHistory: string[];\n};\n\n/**\n * Get the default state for the ShieldController.\n *\n * @returns The default state for the ShieldController.\n */\nexport function getDefaultShieldControllerState(): ShieldControllerState {\n  return {\n    coverageResults: {},\n    orderedTransactionHistory: [],\n  };\n}\n\nexport type ShieldControllerCheckCoverageAction = {\n  type: `${typeof controllerName}:checkCoverage`;\n  handler: ShieldController['checkCoverage'];\n};\n\n/**\n * The internal actions available to the ShieldController.\n */\nexport type ShieldControllerActions = ShieldControllerCheckCoverageAction;\n\nexport type ShieldControllerCoverageResultReceivedEvent = {\n  type: `${typeof controllerName}:coverageResultReceived`;\n  payload: [coverageResult: CoverageResult];\n};\n\nexport type ShieldControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ShieldControllerState\n>;\n\n/**\n * The internal events available to the ShieldController.\n */\nexport type ShieldControllerEvents =\n  | ShieldControllerCoverageResultReceivedEvent\n  | ShieldControllerStateChangeEvent;\n\n/**\n * The external actions available to the ShieldController.\n */\ntype AllowedActions = never;\n\n/**\n * The external events available to the ShieldController.\n */\ntype AllowedEvents =\n  | SignatureStateChange\n  | TransactionControllerStateChangeEvent;\n\n/**\n * The messenger of the {@link ShieldController}.\n */\nexport type ShieldControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  ShieldControllerActions | AllowedActions,\n  ShieldControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Metadata for the ShieldController state, describing how to \"anonymize\"\n * the state and which parts should be persisted.\n */\nconst metadata = {\n  coverageResults: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: true,\n  },\n  orderedTransactionHistory: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: false,\n  },\n};\n\nexport type ShieldControllerOptions = {\n  messenger: ShieldControllerMessenger;\n  state?: Partial<ShieldControllerState>;\n  backend: ShieldBackend;\n  transactionHistoryLimit?: number;\n  coverageHistoryLimit?: number;\n};\n\nexport class ShieldController extends BaseController<\n  typeof controllerName,\n  ShieldControllerState,\n  ShieldControllerMessenger\n> {\n  readonly #backend: ShieldBackend;\n\n  readonly #coverageHistoryLimit: number;\n\n  readonly #transactionHistoryLimit: number;\n\n  readonly #transactionControllerStateChangeHandler: (\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) => void;\n\n  readonly #signatureControllerStateChangeHandler: (\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) => void;\n\n  constructor(options: ShieldControllerOptions) {\n    const {\n      messenger,\n      state,\n      backend,\n      transactionHistoryLimit = 100,\n      coverageHistoryLimit = 10,\n    } = options;\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultShieldControllerState(),\n        ...state,\n      },\n    });\n\n    this.#backend = backend;\n    this.#coverageHistoryLimit = coverageHistoryLimit;\n    this.#transactionHistoryLimit = transactionHistoryLimit;\n    this.#transactionControllerStateChangeHandler =\n      this.#handleTransactionControllerStateChange.bind(this);\n    this.#signatureControllerStateChangeHandler =\n      this.#handleSignatureControllerStateChange.bind(this);\n  }\n\n  start() {\n    this.messagingSystem.subscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n      (state) => state.transactions,\n    );\n\n    this.messagingSystem.subscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n      (state) => state.signatureRequests,\n    );\n  }\n\n  stop() {\n    this.messagingSystem.unsubscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n    );\n  }\n\n  #handleSignatureControllerStateChange(\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) {\n    const signatureRequestsArray = Object.values(signatureRequests);\n    const previousSignatureRequestsArray = Object.values(\n      previousSignatureRequests ?? {},\n    );\n    const previousSignatureRequestsById = new Map<string, SignatureRequest>(\n      previousSignatureRequestsArray.map((request) => [request.id, request]),\n    );\n    for (const signatureRequest of signatureRequestsArray) {\n      const previousSignatureRequest = previousSignatureRequestsById.get(\n        signatureRequest.id,\n      );\n\n      // Check coverage if the signature request is new and has type\n      // `personal_sign`.\n      if (\n        !previousSignatureRequest &&\n        signatureRequest.type === SignatureRequestType.PersonalSign\n      ) {\n        this.checkSignatureCoverage(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log signature once the signature request has been fulfilled.\n      if (\n        signatureRequest.status === SignatureRequestStatus.Signed &&\n        signatureRequest.status !== previousSignatureRequest?.status\n      ) {\n        this.#logSignature(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error logging signature:', error),\n        );\n      }\n    }\n  }\n\n  #handleTransactionControllerStateChange(\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) {\n    const previousTransactionsById = new Map<string, TransactionMeta>(\n      previousTransactions?.map((tx) => [tx.id, tx]) ?? [],\n    );\n    for (const transaction of transactions) {\n      const previousTransaction = previousTransactionsById.get(transaction.id);\n\n      // Check coverage if the transaction is new or if the simulation data has\n      // changed.\n      if (\n        !previousTransaction ||\n        // Checking reference equality is sufficient because this object is\n        // replaced if the simulation data has changed.\n        previousTransaction.simulationData !== transaction.simulationData\n      ) {\n        this.checkCoverage(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log transaction once it has been submitted.\n      if (\n        transaction.status === TransactionStatus.submitted &&\n        transaction.status !== previousTransaction?.status\n      ) {\n        this.#logTransaction(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error logging transaction:', error),\n        );\n      }\n    }\n  }\n\n  /**\n   * Checks the coverage of a transaction.\n   *\n   * @param txMeta - The transaction to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {\n    // Check coverage\n    const coverageId = this.#getLatestCoverageId(txMeta.id);\n    const coverageResult = await this.#backend.checkCoverage({\n      txMeta,\n      coverageId,\n    });\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(txMeta.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  /**\n   * Checks the coverage of a signature request.\n   *\n   * @param signatureRequest - The signature request to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkSignatureCoverage(\n    signatureRequest: SignatureRequest,\n  ): Promise<CoverageResult> {\n    // Check coverage\n    const coverageId = this.#getLatestCoverageId(signatureRequest.id);\n    const coverageResult = await this.#backend.checkSignatureCoverage({\n      signatureRequest,\n      coverageId,\n    });\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(signatureRequest.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  #addCoverageResult(txId: string, coverageResult: CoverageResult) {\n    // Assert the coverageId hasn't changed.\n    const latestCoverageId = this.#getLatestCoverageId(txId);\n    if (latestCoverageId && coverageResult.coverageId !== latestCoverageId) {\n      throw new Error('Coverage ID has changed');\n    }\n\n    this.update((draft) => {\n      // Fetch coverage result entry.\n      let newEntry = false;\n      let coverageResultEntry = draft.coverageResults[txId];\n\n      // Create new entry if necessary.\n      if (!coverageResultEntry) {\n        newEntry = true;\n        coverageResultEntry = {\n          results: [],\n        };\n        draft.coverageResults[txId] = coverageResultEntry;\n      }\n\n      // Trim coverage history if necessary.\n      if (coverageResultEntry.results.length >= this.#coverageHistoryLimit) {\n        coverageResultEntry.results.pop();\n      }\n\n      // Add new result.\n      coverageResultEntry.results.unshift(coverageResult);\n\n      // Add to history if new entry.\n      const { orderedTransactionHistory } = draft;\n      let removedTxId: string | undefined;\n      if (newEntry) {\n        // Trim transaction history if necessary.\n        if (orderedTransactionHistory.length >= this.#transactionHistoryLimit) {\n          removedTxId = orderedTransactionHistory.pop();\n          // Delete corresponding coverage result entry.\n          if (removedTxId) {\n            delete draft.coverageResults[removedTxId];\n          }\n        }\n        // Add to history.\n        orderedTransactionHistory.unshift(txId);\n      }\n    });\n  }\n\n  async #logSignature(signatureRequest: SignatureRequest) {\n    const signature = signatureRequest.rawSig;\n    if (!signature) {\n      throw new Error('Signature not found');\n    }\n\n    const { status } = this.#getCoverageStatus(signatureRequest.id);\n\n    await this.#backend.logSignature({\n      signatureRequest,\n      signature,\n      status,\n    });\n  }\n\n  async #logTransaction(txMeta: TransactionMeta) {\n    const transactionHash = txMeta.hash;\n    if (!transactionHash) {\n      throw new Error('Transaction hash not found');\n    }\n\n    const { status } = this.#getCoverageStatus(txMeta.id);\n\n    await this.#backend.logTransaction({\n      txMeta,\n      transactionHash,\n      status,\n    });\n  }\n\n  #getCoverageStatus(itemId: string) {\n    // The status is assigned as follows:\n    // - 'shown' if we have a result\n    // - 'not_shown' if we don't have a result\n    const coverageId = this.#getLatestCoverageId(itemId);\n    let status = 'shown';\n    if (!coverageId) {\n      log('Coverage ID not found for', itemId);\n      status = 'not_shown';\n    }\n    return { status };\n  }\n\n  #getLatestCoverageId(itemId: string): string | undefined {\n    return this.state.coverageResults[itemId]?.results[0]?.coverageId;\n  }\n}\n"]}
+{"version":3,"file":"ShieldController.cjs","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAK3D,yEAIwC;AACxC,6EAI0C;AAC1C,mCAA4C;AAE5C,+CAA6C;AAC7C,yCAA6D;AAO7D,MAAM,GAAG,GAAG,IAAA,2BAAkB,EAAC,sBAAa,EAAE,kBAAkB,CAAC,CAAC;AAuBlE;;;;GAIG;AACH,SAAgB,+BAA+B;IAC7C,OAAO;QACL,eAAe,EAAE,EAAE;QACnB,yBAAyB,EAAE,EAAE;KAC9B,CAAC;AACJ,CAAC;AALD,0EAKC;AAoDD;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE;QACf,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,IAAI;KACf;IACD,yBAAyB,EAAE;QACzB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAoBF,MAAa,gBAAiB,SAAQ,gCAIrC;IAqBC,YAAY,OAAgC;QAC1C,MAAM,EACJ,SAAS,EACT,KAAK,EACL,OAAO,EACP,uBAAuB,GAAG,GAAG,EAC7B,oBAAoB,GAAG,EAAE,EACzB,yBAAyB,GAC1B,GAAG,OAAO,CAAC;QACZ,KAAK,CAAC;YACJ,IAAI,EAAE,0BAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QArCI,4CAAwB;QAExB,yDAA8B;QAE9B,4DAAiC;QAEjC,8DAAyD;QAEzD,4EAGC;QAED,0EAGC;QAEV,4CAAkB;QAqBhB,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,0CAAyB,oBAAoB,MAAA,CAAC;QAClD,uBAAA,IAAI,6CAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,6DACF,uBAAA,IAAI,6FAAwC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;QAC1D,uBAAA,IAAI,2DACF,uBAAA,IAAI,2FAAsC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;QACxD,uBAAA,IAAI,6BAAY,KAAK,MAAA,CAAC;QACtB,uBAAA,IAAI,+CAA8B,yBAAyB,MAAA,CAAC;IAC9D,CAAC;IAED,KAAK;QACH,IAAI,uBAAA,IAAI,iCAAS,EAAE;YACjB,OAAO;SACR;QACD,uBAAA,IAAI,6BAAY,IAAI,MAAA,CAAC;QAErB,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,EAC7C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,EAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CACnC,CAAC;IACJ,CAAC;IAED,IAAI;QACF,IAAI,CAAC,uBAAA,IAAI,iCAAS,EAAE;YAClB,OAAO;SACR;QACD,uBAAA,IAAI,6BAAY,KAAK,MAAA,CAAC;QAEtB,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,CAC9C,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,CAC5C,CAAC;IACJ,CAAC;IA6ED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,iBAAiB;QACjB,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,EAAE,CAAC,CAAC;QACxD,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC,aAAa,CAAC;YACvD,MAAM;YACN,UAAU;SACX,CAAC,CAAC;QAEH,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,0BAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAEnD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,gBAAkC;QAElC,iBAAiB;QACjB,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAElE,oEAAoE;QACpE,2GAA2G;QAC3G,MAAM,sBAAsB,GAAG,IAAA,kBAAS,EAAC,gBAAgB,CAAC,CAAC;QAC3D,MAAM,0BAA0B,GAC9B,uBAAA,IAAI,mDAA2B,EAAE,KAAjC,IAAI,EAA8B,sBAAsB,CAAC;YACzD,sBAAsB,CAAC;QACzB,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC,sBAAsB,CAAC;YAChE,gBAAgB,EAAE,0BAA0B;YAC5C,UAAU;SACX,CAAC,CAAC;QAEH,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,0BAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,gBAAgB,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAE7D,OAAO,cAAc,CAAC;IACxB,CAAC;CA+FF;AAhUD,4CAgUC;gkBApOG,iBAAmD,EACnD,yBAAuE;IAEvE,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAChE,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAClD,yBAAyB,IAAI,EAAE,CAChC,CAAC;IACF,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAC3C,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CACvE,CAAC;IACF,KAAK,MAAM,gBAAgB,IAAI,sBAAsB,EAAE;QACrD,MAAM,wBAAwB,GAAG,6BAA6B,CAAC,GAAG,CAChE,gBAAgB,CAAC,EAAE,CACpB,CAAC;QAEF,kDAAkD;QAClD,IAAI,CAAC,wBAAwB,EAAE;YAC7B,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,KAAK;YACjD,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,+DAA+D;QAC/D,IACE,gBAAgB,CAAC,MAAM,KAAK,6CAAsB,CAAC,MAAM;YACzD,gBAAgB,CAAC,MAAM,KAAK,wBAAwB,EAAE,MAAM,EAC5D;YACA,uBAAA,IAAI,mEAAc,MAAlB,IAAI,EAAe,gBAAgB,CAAC,CAAC,KAAK;YACxC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;KACF;AACH,CAAC,+HAGC,YAA+B,EAC/B,oBAAmD;IAEnD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CACtC,oBAAoB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CACrD,CAAC;IACF,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEzE,4CAA4C;QAC5C,MAAM,wBAAwB,GAAG,IAAA,gBAAO,EACtC,WAAW,CAAC,cAAc,EAC1B,mBAAmB,EAAE,cAAc,CACpC,CAAC;QAEF,yEAAyE;QACzE,WAAW;QACX,IAAI,CAAC,mBAAmB,IAAI,CAAC,wBAAwB,EAAE;YACrD,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK;YACnC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,8CAA8C;QAC9C,IACE,WAAW,CAAC,MAAM,KAAK,0CAAiB,CAAC,SAAS;YAClD,WAAW,CAAC,MAAM,KAAK,mBAAmB,EAAE,MAAM,EAClD;YACA,uBAAA,IAAI,qEAAgB,MAApB,IAAI,EAAiB,WAAW,CAAC,CAAC,KAAK;YACrC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,CACpD,CAAC;SACH;KACF;AACH,CAAC,qFA+DkB,IAAY,EAAE,cAA8B;IAC7D,wCAAwC;IACxC,MAAM,gBAAgB,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,IAAI,CAAC,CAAC;IACzD,IAAI,gBAAgB,IAAI,cAAc,CAAC,UAAU,KAAK,gBAAgB,EAAE;QACtE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,+BAA+B;QAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtD,iCAAiC;QACjC,IAAI,CAAC,mBAAmB,EAAE;YACxB,QAAQ,GAAG,IAAI,CAAC;YAChB,mBAAmB,GAAG;gBACpB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC;SACnD;QAED,sCAAsC;QACtC,IAAI,mBAAmB,CAAC,OAAO,CAAC,MAAM,IAAI,uBAAA,IAAI,8CAAsB,EAAE;YACpE,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;SACnC;QAED,kBAAkB;QAClB,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpD,+BAA+B;QAC/B,MAAM,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;QAC5C,IAAI,WAA+B,CAAC;QACpC,IAAI,QAAQ,EAAE;YACZ,yCAAyC;YACzC,IAAI,yBAAyB,CAAC,MAAM,IAAI,uBAAA,IAAI,iDAAyB,EAAE;gBACrE,WAAW,GAAG,yBAAyB,CAAC,GAAG,EAAE,CAAC;gBAC9C,8CAA8C;gBAC9C,IAAI,WAAW,EAAE;oBACf,OAAO,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;iBAC3C;aACF;YACD,kBAAkB;YAClB,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACzC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,mCAED,KAAK,yCAAe,gBAAkC;IACpD,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC1C,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;KACxC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAEhE,MAAM,uBAAA,IAAI,iCAAS,CAAC,YAAY,CAAC;QAC/B,gBAAgB;QAChB,SAAS;QACT,MAAM;KACP,CAAC,CAAC;AACL,CAAC,qCAED,KAAK,2CAAiB,MAAuB;IAC3C,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC;IACpC,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,CAAC,CAAC;IAEtD,MAAM,uBAAA,IAAI,iCAAS,CAAC,cAAc,CAAC;QACjC,MAAM;QACN,eAAe;QACf,MAAM;KACP,CAAC,CAAC;AACL,CAAC,qFAEkB,MAAc;IAC/B,qCAAqC;IACrC,gCAAgC;IAChC,0CAA0C;IAC1C,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,CAAC;IACrD,IAAI,MAAM,GAAG,OAAO,CAAC;IACrB,IAAI,CAAC,UAAU,EAAE;QACf,GAAG,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;QACzC,MAAM,GAAG,WAAW,CAAC;KACtB;IACD,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC,yFAEoB,MAAc;IACjC,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;AACpE,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport {\n  SignatureRequestStatus,\n  type SignatureRequest,\n  type SignatureStateChange,\n} from '@metamask/signature-controller';\nimport {\n  TransactionStatus,\n  type TransactionControllerStateChangeEvent,\n  type TransactionMeta,\n} from '@metamask/transaction-controller';\nimport { cloneDeep, isEqual } from 'lodash';\n\nimport { controllerName } from './constants';\nimport { projectLogger, createModuleLogger } from './logger';\nimport type {\n  CoverageResult,\n  NormalizeSignatureRequestFn,\n  ShieldBackend,\n} from './types';\n\nconst log = createModuleLogger(projectLogger, 'ShieldController');\n\nexport type CoverageResultRecordEntry = {\n  /**\n   * History of coverage results, latest first.\n   */\n  results: CoverageResult[];\n};\n\nexport type ShieldControllerState = {\n  /**\n   * Coverage results by transaction ID.\n   */\n  coverageResults: Record<\n    string, // txId\n    CoverageResultRecordEntry\n  >;\n  /**\n   * List of txIds ordered by time, latest first.\n   */\n  orderedTransactionHistory: string[];\n};\n\n/**\n * Get the default state for the ShieldController.\n *\n * @returns The default state for the ShieldController.\n */\nexport function getDefaultShieldControllerState(): ShieldControllerState {\n  return {\n    coverageResults: {},\n    orderedTransactionHistory: [],\n  };\n}\n\nexport type ShieldControllerCheckCoverageAction = {\n  type: `${typeof controllerName}:checkCoverage`;\n  handler: ShieldController['checkCoverage'];\n};\n\n/**\n * The internal actions available to the ShieldController.\n */\nexport type ShieldControllerActions = ShieldControllerCheckCoverageAction;\n\nexport type ShieldControllerCoverageResultReceivedEvent = {\n  type: `${typeof controllerName}:coverageResultReceived`;\n  payload: [coverageResult: CoverageResult];\n};\n\nexport type ShieldControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ShieldControllerState\n>;\n\n/**\n * The internal events available to the ShieldController.\n */\nexport type ShieldControllerEvents =\n  | ShieldControllerCoverageResultReceivedEvent\n  | ShieldControllerStateChangeEvent;\n\n/**\n * The external actions available to the ShieldController.\n */\ntype AllowedActions = never;\n\n/**\n * The external events available to the ShieldController.\n */\ntype AllowedEvents =\n  | SignatureStateChange\n  | TransactionControllerStateChangeEvent;\n\n/**\n * The messenger of the {@link ShieldController}.\n */\nexport type ShieldControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  ShieldControllerActions | AllowedActions,\n  ShieldControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Metadata for the ShieldController state, describing how to \"anonymize\"\n * the state and which parts should be persisted.\n */\nconst metadata = {\n  coverageResults: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: true,\n  },\n  orderedTransactionHistory: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: false,\n  },\n};\n\nexport type ShieldControllerOptions = {\n  messenger: ShieldControllerMessenger;\n  state?: Partial<ShieldControllerState>;\n  backend: ShieldBackend;\n  transactionHistoryLimit?: number;\n  coverageHistoryLimit?: number;\n  /**\n   * Normalize the signature request before sending it to the backend.\n   * Please note that the reason this is not being done internally is to\n   * align the request body (data & params) with the security-alerts API.\n   * The same normalization function which is used to normalize security-alerts request should be used here.\n   *\n   * @param signatureRequest - The signature request to normalize.\n   * @returns The normalized signature request.\n   */\n  normalizeSignatureRequest?: NormalizeSignatureRequestFn;\n};\n\nexport class ShieldController extends BaseController<\n  typeof controllerName,\n  ShieldControllerState,\n  ShieldControllerMessenger\n> {\n  readonly #backend: ShieldBackend;\n\n  readonly #coverageHistoryLimit: number;\n\n  readonly #transactionHistoryLimit: number;\n\n  readonly #normalizeSignatureRequest?: NormalizeSignatureRequestFn;\n\n  readonly #transactionControllerStateChangeHandler: (\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) => void;\n\n  readonly #signatureControllerStateChangeHandler: (\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) => void;\n\n  #started: boolean;\n\n  constructor(options: ShieldControllerOptions) {\n    const {\n      messenger,\n      state,\n      backend,\n      transactionHistoryLimit = 100,\n      coverageHistoryLimit = 10,\n      normalizeSignatureRequest,\n    } = options;\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultShieldControllerState(),\n        ...state,\n      },\n    });\n\n    this.#backend = backend;\n    this.#coverageHistoryLimit = coverageHistoryLimit;\n    this.#transactionHistoryLimit = transactionHistoryLimit;\n    this.#transactionControllerStateChangeHandler =\n      this.#handleTransactionControllerStateChange.bind(this);\n    this.#signatureControllerStateChangeHandler =\n      this.#handleSignatureControllerStateChange.bind(this);\n    this.#started = false;\n    this.#normalizeSignatureRequest = normalizeSignatureRequest;\n  }\n\n  start() {\n    if (this.#started) {\n      return;\n    }\n    this.#started = true;\n\n    this.messagingSystem.subscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n      (state) => state.transactions,\n    );\n\n    this.messagingSystem.subscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n      (state) => state.signatureRequests,\n    );\n  }\n\n  stop() {\n    if (!this.#started) {\n      return;\n    }\n    this.#started = false;\n\n    this.messagingSystem.unsubscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n    );\n  }\n\n  #handleSignatureControllerStateChange(\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) {\n    const signatureRequestsArray = Object.values(signatureRequests);\n    const previousSignatureRequestsArray = Object.values(\n      previousSignatureRequests ?? {},\n    );\n    const previousSignatureRequestsById = new Map<string, SignatureRequest>(\n      previousSignatureRequestsArray.map((request) => [request.id, request]),\n    );\n    for (const signatureRequest of signatureRequestsArray) {\n      const previousSignatureRequest = previousSignatureRequestsById.get(\n        signatureRequest.id,\n      );\n\n      // Check coverage if the signature request is new.\n      if (!previousSignatureRequest) {\n        this.checkSignatureCoverage(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log signature once the signature request has been fulfilled.\n      if (\n        signatureRequest.status === SignatureRequestStatus.Signed &&\n        signatureRequest.status !== previousSignatureRequest?.status\n      ) {\n        this.#logSignature(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error logging signature:', error),\n        );\n      }\n    }\n  }\n\n  #handleTransactionControllerStateChange(\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) {\n    const previousTransactionsById = new Map<string, TransactionMeta>(\n      previousTransactions?.map((tx) => [tx.id, tx]) ?? [],\n    );\n    for (const transaction of transactions) {\n      const previousTransaction = previousTransactionsById.get(transaction.id);\n\n      // Check if the simulation data has changed.\n      const simulationDataNotChanged = isEqual(\n        transaction.simulationData,\n        previousTransaction?.simulationData,\n      );\n\n      // Check coverage if the transaction is new or if the simulation data has\n      // changed.\n      if (!previousTransaction || !simulationDataNotChanged) {\n        this.checkCoverage(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log transaction once it has been submitted.\n      if (\n        transaction.status === TransactionStatus.submitted &&\n        transaction.status !== previousTransaction?.status\n      ) {\n        this.#logTransaction(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error logging transaction:', error),\n        );\n      }\n    }\n  }\n\n  /**\n   * Checks the coverage of a transaction.\n   *\n   * @param txMeta - The transaction to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {\n    // Check coverage\n    const coverageId = this.#getLatestCoverageId(txMeta.id);\n    const coverageResult = await this.#backend.checkCoverage({\n      txMeta,\n      coverageId,\n    });\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(txMeta.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  /**\n   * Checks the coverage of a signature request.\n   *\n   * @param signatureRequest - The signature request to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkSignatureCoverage(\n    signatureRequest: SignatureRequest,\n  ): Promise<CoverageResult> {\n    // Check coverage\n    const coverageId = this.#getLatestCoverageId(signatureRequest.id);\n\n    // Normalize the signature request before sending it to the backend.\n    // This is to ensure that the signature data is normalized and consistent as the security alerts api calls.\n    const clonedSignatureRequest = cloneDeep(signatureRequest);\n    const normalizedSignatureRequest =\n      this.#normalizeSignatureRequest?.(clonedSignatureRequest) ??\n      clonedSignatureRequest;\n    const coverageResult = await this.#backend.checkSignatureCoverage({\n      signatureRequest: normalizedSignatureRequest,\n      coverageId,\n    });\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(signatureRequest.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  #addCoverageResult(txId: string, coverageResult: CoverageResult) {\n    // Assert the coverageId hasn't changed.\n    const latestCoverageId = this.#getLatestCoverageId(txId);\n    if (latestCoverageId && coverageResult.coverageId !== latestCoverageId) {\n      throw new Error('Coverage ID has changed');\n    }\n\n    this.update((draft) => {\n      // Fetch coverage result entry.\n      let newEntry = false;\n      let coverageResultEntry = draft.coverageResults[txId];\n\n      // Create new entry if necessary.\n      if (!coverageResultEntry) {\n        newEntry = true;\n        coverageResultEntry = {\n          results: [],\n        };\n        draft.coverageResults[txId] = coverageResultEntry;\n      }\n\n      // Trim coverage history if necessary.\n      if (coverageResultEntry.results.length >= this.#coverageHistoryLimit) {\n        coverageResultEntry.results.pop();\n      }\n\n      // Add new result.\n      coverageResultEntry.results.unshift(coverageResult);\n\n      // Add to history if new entry.\n      const { orderedTransactionHistory } = draft;\n      let removedTxId: string | undefined;\n      if (newEntry) {\n        // Trim transaction history if necessary.\n        if (orderedTransactionHistory.length >= this.#transactionHistoryLimit) {\n          removedTxId = orderedTransactionHistory.pop();\n          // Delete corresponding coverage result entry.\n          if (removedTxId) {\n            delete draft.coverageResults[removedTxId];\n          }\n        }\n        // Add to history.\n        orderedTransactionHistory.unshift(txId);\n      }\n    });\n  }\n\n  async #logSignature(signatureRequest: SignatureRequest) {\n    const signature = signatureRequest.rawSig;\n    if (!signature) {\n      throw new Error('Signature not found');\n    }\n\n    const { status } = this.#getCoverageStatus(signatureRequest.id);\n\n    await this.#backend.logSignature({\n      signatureRequest,\n      signature,\n      status,\n    });\n  }\n\n  async #logTransaction(txMeta: TransactionMeta) {\n    const transactionHash = txMeta.hash;\n    if (!transactionHash) {\n      throw new Error('Transaction hash not found');\n    }\n\n    const { status } = this.#getCoverageStatus(txMeta.id);\n\n    await this.#backend.logTransaction({\n      txMeta,\n      transactionHash,\n      status,\n    });\n  }\n\n  #getCoverageStatus(itemId: string) {\n    // The status is assigned as follows:\n    // - 'shown' if we have a result\n    // - 'not_shown' if we don't have a result\n    const coverageId = this.#getLatestCoverageId(itemId);\n    let status = 'shown';\n    if (!coverageId) {\n      log('Coverage ID not found for', itemId);\n      status = 'not_shown';\n    }\n    return { status };\n  }\n\n  #getLatestCoverageId(itemId: string): string | undefined {\n    return this.state.coverageResults[itemId]?.results[0]?.coverageId;\n  }\n}\n"]}

package/dist/ShieldController.d.cts

@@ -3,7 +3,7 @@ import type { ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/
 import { type SignatureRequest, type SignatureStateChange } from "@metamask/signature-controller";
 import { type TransactionControllerStateChangeEvent, type TransactionMeta } from "@metamask/transaction-controller";
 import { controllerName } from "./constants.cjs";
-import type { CoverageResult, ShieldBackend } from "./types.cjs";
+import type { CoverageResult, NormalizeSignatureRequestFn, ShieldBackend } from "./types.cjs";
 export type CoverageResultRecordEntry = {
     /**
      * History of coverage results, latest first.
@@ -62,6 +62,16 @@ export type ShieldControllerOptions = {
     backend: ShieldBackend;
     transactionHistoryLimit?: number;
     coverageHistoryLimit?: number;
+    /**
+     * Normalize the signature request before sending it to the backend.
+     * Please note that the reason this is not being done internally is to
+     * align the request body (data & params) with the security-alerts API.
+     * The same normalization function which is used to normalize security-alerts request should be used here.
+     *
+     * @param signatureRequest - The signature request to normalize.
+     * @returns The normalized signature request.
+     */
+    normalizeSignatureRequest?: NormalizeSignatureRequestFn;
 };
 export declare class ShieldController extends BaseController<typeof controllerName, ShieldControllerState, ShieldControllerMessenger> {
     #private;

package/dist/ShieldController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"ShieldController.d.cts","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,EAGL,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EAC1B,uCAAuC;AACxC,OAAO,EAEL,KAAK,qCAAqC,EAC1C,KAAK,eAAe,EACrB,yCAAyC;AAE1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAE7C,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAgB;AAI7D,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CACrB,MAAM,EAAE,OAAO;IACf,yBAAyB,CAC1B,CAAC;IACF;;OAEG;IACH,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAKvE;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,2CAA2C,GAC3C,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,KAAK,aAAa,GACd,oBAAoB,GACpB,qCAAqC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CACzD,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,EACtC,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAqBF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBAiBa,OAAO,EAAE,uBAAuB;IA2B5C,KAAK;IAcL,IAAI;IA0FJ;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAoBrE;;;;;OAKG;IACG,sBAAsB,CAC1B,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,cAAc,CAAC;CAiH3B"}
+{"version":3,"file":"ShieldController.d.cts","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,EAEL,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EAC1B,uCAAuC;AACxC,OAAO,EAEL,KAAK,qCAAqC,EAC1C,KAAK,eAAe,EACrB,yCAAyC;AAG1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAE7C,OAAO,KAAK,EACV,cAAc,EACd,2BAA2B,EAC3B,aAAa,EACd,oBAAgB;AAIjB,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CACrB,MAAM,EAAE,OAAO;IACf,yBAAyB,CAC1B,CAAC;IACF;;OAEG;IACH,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAKvE;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,2CAA2C,GAC3C,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,KAAK,aAAa,GACd,oBAAoB,GACpB,qCAAqC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CACzD,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,EACtC,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAqBF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;;;;OAQG;IACH,yBAAyB,CAAC,EAAE,2BAA2B,CAAC;CACzD,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBAqBa,OAAO,EAAE,uBAAuB;IA8B5C,KAAK;IAmBL,IAAI;IA4FJ;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAoBrE;;;;;OAKG;IACG,sBAAsB,CAC1B,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,cAAc,CAAC;CAwH3B"}

package/dist/ShieldController.d.mts

@@ -3,7 +3,7 @@ import type { ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/
 import { type SignatureRequest, type SignatureStateChange } from "@metamask/signature-controller";
 import { type TransactionControllerStateChangeEvent, type TransactionMeta } from "@metamask/transaction-controller";
 import { controllerName } from "./constants.mjs";
-import type { CoverageResult, ShieldBackend } from "./types.mjs";
+import type { CoverageResult, NormalizeSignatureRequestFn, ShieldBackend } from "./types.mjs";
 export type CoverageResultRecordEntry = {
     /**
      * History of coverage results, latest first.
@@ -62,6 +62,16 @@ export type ShieldControllerOptions = {
     backend: ShieldBackend;
     transactionHistoryLimit?: number;
     coverageHistoryLimit?: number;
+    /**
+     * Normalize the signature request before sending it to the backend.
+     * Please note that the reason this is not being done internally is to
+     * align the request body (data & params) with the security-alerts API.
+     * The same normalization function which is used to normalize security-alerts request should be used here.
+     *
+     * @param signatureRequest - The signature request to normalize.
+     * @returns The normalized signature request.
+     */
+    normalizeSignatureRequest?: NormalizeSignatureRequestFn;
 };
 export declare class ShieldController extends BaseController<typeof controllerName, ShieldControllerState, ShieldControllerMessenger> {
     #private;

package/dist/ShieldController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"ShieldController.d.mts","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,EAGL,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EAC1B,uCAAuC;AACxC,OAAO,EAEL,KAAK,qCAAqC,EAC1C,KAAK,eAAe,EACrB,yCAAyC;AAE1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAE7C,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAgB;AAI7D,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CACrB,MAAM,EAAE,OAAO;IACf,yBAAyB,CAC1B,CAAC;IACF;;OAEG;IACH,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAKvE;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,2CAA2C,GAC3C,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,KAAK,aAAa,GACd,oBAAoB,GACpB,qCAAqC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CACzD,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,EACtC,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAqBF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBAiBa,OAAO,EAAE,uBAAuB;IA2B5C,KAAK;IAcL,IAAI;IA0FJ;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAoBrE;;;;;OAKG;IACG,sBAAsB,CAC1B,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,cAAc,CAAC;CAiH3B"}
+{"version":3,"file":"ShieldController.d.mts","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,EAEL,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EAC1B,uCAAuC;AACxC,OAAO,EAEL,KAAK,qCAAqC,EAC1C,KAAK,eAAe,EACrB,yCAAyC;AAG1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAE7C,OAAO,KAAK,EACV,cAAc,EACd,2BAA2B,EAC3B,aAAa,EACd,oBAAgB;AAIjB,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CACrB,MAAM,EAAE,OAAO;IACf,yBAAyB,CAC1B,CAAC;IACF;;OAEG;IACH,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAKvE;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,2CAA2C,GAC3C,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,KAAK,aAAa,GACd,oBAAoB,GACpB,qCAAqC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CACzD,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,EACtC,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAqBF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;;;;OAQG;IACH,yBAAyB,CAAC,EAAE,2BAA2B,CAAC;CACzD,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBAqBa,OAAO,EAAE,uBAAuB;IA8B5C,KAAK;IAmBL,IAAI;IA4FJ;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAoBrE;;;;;OAKG;IACG,sBAAsB,CAC1B,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,cAAc,CAAC;CAwH3B"}

package/dist/ShieldController.mjs

@@ -9,10 +9,12 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _ShieldController_instances, _ShieldController_backend, _ShieldController_coverageHistoryLimit, _ShieldController_transactionHistoryLimit, _ShieldController_transactionControllerStateChangeHandler, _ShieldController_signatureControllerStateChangeHandler, _ShieldController_handleSignatureControllerStateChange, _ShieldController_handleTransactionControllerStateChange, _ShieldController_addCoverageResult, _ShieldController_logSignature, _ShieldController_logTransaction, _ShieldController_getCoverageStatus, _ShieldController_getLatestCoverageId;
+var _ShieldController_instances, _ShieldController_backend, _ShieldController_coverageHistoryLimit, _ShieldController_transactionHistoryLimit, _ShieldController_normalizeSignatureRequest, _ShieldController_transactionControllerStateChangeHandler, _ShieldController_signatureControllerStateChangeHandler, _ShieldController_started, _ShieldController_handleSignatureControllerStateChange, _ShieldController_handleTransactionControllerStateChange, _ShieldController_addCoverageResult, _ShieldController_logSignature, _ShieldController_logTransaction, _ShieldController_getCoverageStatus, _ShieldController_getLatestCoverageId;
 import { BaseController } from "@metamask/base-controller";
-import { SignatureRequestStatus, SignatureRequestType } from "@metamask/signature-controller";
+import { SignatureRequestStatus } from "@metamask/signature-controller";
 import { TransactionStatus } from "@metamask/transaction-controller";
+import $lodash from "lodash";
+const { cloneDeep, isEqual } = $lodash;
 import { controllerName } from "./constants.mjs";
 import { projectLogger, createModuleLogger } from "./logger.mjs";
 const log = createModuleLogger(projectLogger, 'ShieldController');
@@ -47,7 +49,7 @@ const metadata = {
 };
 export class ShieldController extends BaseController {
     constructor(options) {
-        const { messenger, state, backend, transactionHistoryLimit = 100, coverageHistoryLimit = 10, } = options;
+        const { messenger, state, backend, transactionHistoryLimit = 100, coverageHistoryLimit = 10, normalizeSignatureRequest, } = options;
         super({
             name: controllerName,
             metadata,
@@ -61,19 +63,31 @@ export class ShieldController extends BaseController {
         _ShieldController_backend.set(this, void 0);
         _ShieldController_coverageHistoryLimit.set(this, void 0);
         _ShieldController_transactionHistoryLimit.set(this, void 0);
+        _ShieldController_normalizeSignatureRequest.set(this, void 0);
         _ShieldController_transactionControllerStateChangeHandler.set(this, void 0);
         _ShieldController_signatureControllerStateChangeHandler.set(this, void 0);
+        _ShieldController_started.set(this, void 0);
         __classPrivateFieldSet(this, _ShieldController_backend, backend, "f");
         __classPrivateFieldSet(this, _ShieldController_coverageHistoryLimit, coverageHistoryLimit, "f");
         __classPrivateFieldSet(this, _ShieldController_transactionHistoryLimit, transactionHistoryLimit, "f");
         __classPrivateFieldSet(this, _ShieldController_transactionControllerStateChangeHandler, __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_handleTransactionControllerStateChange).bind(this), "f");
         __classPrivateFieldSet(this, _ShieldController_signatureControllerStateChangeHandler, __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_handleSignatureControllerStateChange).bind(this), "f");
+        __classPrivateFieldSet(this, _ShieldController_started, false, "f");
+        __classPrivateFieldSet(this, _ShieldController_normalizeSignatureRequest, normalizeSignatureRequest, "f");
     }
     start() {
+        if (__classPrivateFieldGet(this, _ShieldController_started, "f")) {
+            return;
+        }
+        __classPrivateFieldSet(this, _ShieldController_started, true, "f");
         this.messagingSystem.subscribe('TransactionController:stateChange', __classPrivateFieldGet(this, _ShieldController_transactionControllerStateChangeHandler, "f"), (state) => state.transactions);
         this.messagingSystem.subscribe('SignatureController:stateChange', __classPrivateFieldGet(this, _ShieldController_signatureControllerStateChangeHandler, "f"), (state) => state.signatureRequests);
     }
     stop() {
+        if (!__classPrivateFieldGet(this, _ShieldController_started, "f")) {
+            return;
+        }
+        __classPrivateFieldSet(this, _ShieldController_started, false, "f");
         this.messagingSystem.unsubscribe('TransactionController:stateChange', __classPrivateFieldGet(this, _ShieldController_transactionControllerStateChangeHandler, "f"));
         this.messagingSystem.unsubscribe('SignatureController:stateChange', __classPrivateFieldGet(this, _ShieldController_signatureControllerStateChangeHandler, "f"));
     }
@@ -105,8 +119,13 @@ export class ShieldController extends BaseController {
     async checkSignatureCoverage(signatureRequest) {
         // Check coverage
         const coverageId = __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_getLatestCoverageId).call(this, signatureRequest.id);
+        // Normalize the signature request before sending it to the backend.
+        // This is to ensure that the signature data is normalized and consistent as the security alerts api calls.
+        const clonedSignatureRequest = cloneDeep(signatureRequest);
+        const normalizedSignatureRequest = __classPrivateFieldGet(this, _ShieldController_normalizeSignatureRequest, "f")?.call(this, clonedSignatureRequest) ??
+            clonedSignatureRequest;
         const coverageResult = await __classPrivateFieldGet(this, _ShieldController_backend, "f").checkSignatureCoverage({
-            signatureRequest,
+            signatureRequest: normalizedSignatureRequest,
             coverageId,
         });
         // Publish coverage result
@@ -116,16 +135,14 @@ export class ShieldController extends BaseController {
         return coverageResult;
     }
 }
-_ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimit = new WeakMap(), _ShieldController_transactionHistoryLimit = new WeakMap(), _ShieldController_transactionControllerStateChangeHandler = new WeakMap(), _ShieldController_signatureControllerStateChangeHandler = new WeakMap(), _ShieldController_instances = new WeakSet(), _ShieldController_handleSignatureControllerStateChange = function _ShieldController_handleSignatureControllerStateChange(signatureRequests, previousSignatureRequests) {
+_ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimit = new WeakMap(), _ShieldController_transactionHistoryLimit = new WeakMap(), _ShieldController_normalizeSignatureRequest = new WeakMap(), _ShieldController_transactionControllerStateChangeHandler = new WeakMap(), _ShieldController_signatureControllerStateChangeHandler = new WeakMap(), _ShieldController_started = new WeakMap(), _ShieldController_instances = new WeakSet(), _ShieldController_handleSignatureControllerStateChange = function _ShieldController_handleSignatureControllerStateChange(signatureRequests, previousSignatureRequests) {
     const signatureRequestsArray = Object.values(signatureRequests);
     const previousSignatureRequestsArray = Object.values(previousSignatureRequests ?? {});
     const previousSignatureRequestsById = new Map(previousSignatureRequestsArray.map((request) => [request.id, request]));
     for (const signatureRequest of signatureRequestsArray) {
         const previousSignatureRequest = previousSignatureRequestsById.get(signatureRequest.id);
-        // Check coverage if the signature request is new and has type
-        // `personal_sign`.
-        if (!previousSignatureRequest &&
-            signatureRequest.type === SignatureRequestType.PersonalSign) {
+        // Check coverage if the signature request is new.
+        if (!previousSignatureRequest) {
             this.checkSignatureCoverage(signatureRequest).catch(
             // istanbul ignore next
             (error) => log('Error checking coverage:', error));
@@ -142,12 +159,11 @@ _ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimi
     const previousTransactionsById = new Map(previousTransactions?.map((tx) => [tx.id, tx]) ?? []);
     for (const transaction of transactions) {
         const previousTransaction = previousTransactionsById.get(transaction.id);
+        // Check if the simulation data has changed.
+        const simulationDataNotChanged = isEqual(transaction.simulationData, previousTransaction?.simulationData);
         // Check coverage if the transaction is new or if the simulation data has
         // changed.
-        if (!previousTransaction ||
-            // Checking reference equality is sufficient because this object is
-            // replaced if the simulation data has changed.
-            previousTransaction.simulationData !== transaction.simulationData) {
+        if (!previousTransaction || !simulationDataNotChanged) {
             this.checkCoverage(transaction).catch(
             // istanbul ignore next
             (error) => log('Error checking coverage:', error));

package/dist/ShieldController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ShieldController.mjs","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EAGrB,uCAAuC;AACxC,OAAO,EACL,iBAAiB,EAGlB,yCAAyC;AAE1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAC7C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,qBAAiB;AAG7D,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;AAuBlE;;;;GAIG;AACH,MAAM,UAAU,+BAA+B;IAC7C,OAAO;QACL,eAAe,EAAE,EAAE;QACnB,yBAAyB,EAAE,EAAE;KAC9B,CAAC;AACJ,CAAC;AAoDD;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE;QACf,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,IAAI;KACf;IACD,yBAAyB,EAAE;QACzB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAUF,MAAM,OAAO,gBAAiB,SAAQ,cAIrC;IAiBC,YAAY,OAAgC;QAC1C,MAAM,EACJ,SAAS,EACT,KAAK,EACL,OAAO,EACP,uBAAuB,GAAG,GAAG,EAC7B,oBAAoB,GAAG,EAAE,GAC1B,GAAG,OAAO,CAAC;QACZ,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAhCI,4CAAwB;QAExB,yDAA8B;QAE9B,4DAAiC;QAEjC,4EAGC;QAED,0EAGC;QAoBR,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,0CAAyB,oBAAoB,MAAA,CAAC;QAClD,uBAAA,IAAI,6CAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,6DACF,uBAAA,IAAI,6FAAwC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;QAC1D,uBAAA,IAAI,2DACF,uBAAA,IAAI,2FAAsC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;IAC1D,CAAC;IAED,KAAK;QACH,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,EAC7C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,EAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CACnC,CAAC;IACJ,CAAC;IAED,IAAI;QACF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,CAC9C,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,CAC5C,CAAC;IACJ,CAAC;IAgFD;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,iBAAiB;QACjB,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,EAAE,CAAC,CAAC;QACxD,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC,aAAa,CAAC;YACvD,MAAM;YACN,UAAU;SACX,CAAC,CAAC;QAEH,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,cAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAEnD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,gBAAkC;QAElC,iBAAiB;QACjB,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAClE,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC,sBAAsB,CAAC;YAChE,gBAAgB;YAChB,UAAU;SACX,CAAC,CAAC;QAEH,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,cAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,gBAAgB,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAE7D,OAAO,cAAc,CAAC;IACxB,CAAC;CA+FF;wdAhOG,iBAAmD,EACnD,yBAAuE;IAEvE,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAChE,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAClD,yBAAyB,IAAI,EAAE,CAChC,CAAC;IACF,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAC3C,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CACvE,CAAC;IACF,KAAK,MAAM,gBAAgB,IAAI,sBAAsB,EAAE;QACrD,MAAM,wBAAwB,GAAG,6BAA6B,CAAC,GAAG,CAChE,gBAAgB,CAAC,EAAE,CACpB,CAAC;QAEF,8DAA8D;QAC9D,mBAAmB;QACnB,IACE,CAAC,wBAAwB;YACzB,gBAAgB,CAAC,IAAI,KAAK,oBAAoB,CAAC,YAAY,EAC3D;YACA,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,KAAK;YACjD,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,+DAA+D;QAC/D,IACE,gBAAgB,CAAC,MAAM,KAAK,sBAAsB,CAAC,MAAM;YACzD,gBAAgB,CAAC,MAAM,KAAK,wBAAwB,EAAE,MAAM,EAC5D;YACA,uBAAA,IAAI,mEAAc,MAAlB,IAAI,EAAe,gBAAgB,CAAC,CAAC,KAAK;YACxC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;KACF;AACH,CAAC,+HAGC,YAA+B,EAC/B,oBAAmD;IAEnD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CACtC,oBAAoB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CACrD,CAAC;IACF,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEzE,yEAAyE;QACzE,WAAW;QACX,IACE,CAAC,mBAAmB;YACpB,mEAAmE;YACnE,+CAA+C;YAC/C,mBAAmB,CAAC,cAAc,KAAK,WAAW,CAAC,cAAc,EACjE;YACA,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK;YACnC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,8CAA8C;QAC9C,IACE,WAAW,CAAC,MAAM,KAAK,iBAAiB,CAAC,SAAS;YAClD,WAAW,CAAC,MAAM,KAAK,mBAAmB,EAAE,MAAM,EAClD;YACA,uBAAA,IAAI,qEAAgB,MAApB,IAAI,EAAiB,WAAW,CAAC,CAAC,KAAK;YACrC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,CACpD,CAAC;SACH;KACF;AACH,CAAC,qFAwDkB,IAAY,EAAE,cAA8B;IAC7D,wCAAwC;IACxC,MAAM,gBAAgB,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,IAAI,CAAC,CAAC;IACzD,IAAI,gBAAgB,IAAI,cAAc,CAAC,UAAU,KAAK,gBAAgB,EAAE;QACtE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,+BAA+B;QAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtD,iCAAiC;QACjC,IAAI,CAAC,mBAAmB,EAAE;YACxB,QAAQ,GAAG,IAAI,CAAC;YAChB,mBAAmB,GAAG;gBACpB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC;SACnD;QAED,sCAAsC;QACtC,IAAI,mBAAmB,CAAC,OAAO,CAAC,MAAM,IAAI,uBAAA,IAAI,8CAAsB,EAAE;YACpE,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;SACnC;QAED,kBAAkB;QAClB,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpD,+BAA+B;QAC/B,MAAM,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;QAC5C,IAAI,WAA+B,CAAC;QACpC,IAAI,QAAQ,EAAE;YACZ,yCAAyC;YACzC,IAAI,yBAAyB,CAAC,MAAM,IAAI,uBAAA,IAAI,iDAAyB,EAAE;gBACrE,WAAW,GAAG,yBAAyB,CAAC,GAAG,EAAE,CAAC;gBAC9C,8CAA8C;gBAC9C,IAAI,WAAW,EAAE;oBACf,OAAO,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;iBAC3C;aACF;YACD,kBAAkB;YAClB,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACzC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,mCAED,KAAK,yCAAe,gBAAkC;IACpD,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC1C,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;KACxC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAEhE,MAAM,uBAAA,IAAI,iCAAS,CAAC,YAAY,CAAC;QAC/B,gBAAgB;QAChB,SAAS;QACT,MAAM;KACP,CAAC,CAAC;AACL,CAAC,qCAED,KAAK,2CAAiB,MAAuB;IAC3C,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC;IACpC,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,CAAC,CAAC;IAEtD,MAAM,uBAAA,IAAI,iCAAS,CAAC,cAAc,CAAC;QACjC,MAAM;QACN,eAAe;QACf,MAAM;KACP,CAAC,CAAC;AACL,CAAC,qFAEkB,MAAc;IAC/B,qCAAqC;IACrC,gCAAgC;IAChC,0CAA0C;IAC1C,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,CAAC;IACrD,IAAI,MAAM,GAAG,OAAO,CAAC;IACrB,IAAI,CAAC,UAAU,EAAE;QACf,GAAG,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;QACzC,MAAM,GAAG,WAAW,CAAC;KACtB;IACD,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC,yFAEoB,MAAc;IACjC,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;AACpE,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport {\n  SignatureRequestStatus,\n  SignatureRequestType,\n  type SignatureRequest,\n  type SignatureStateChange,\n} from '@metamask/signature-controller';\nimport {\n  TransactionStatus,\n  type TransactionControllerStateChangeEvent,\n  type TransactionMeta,\n} from '@metamask/transaction-controller';\n\nimport { controllerName } from './constants';\nimport { projectLogger, createModuleLogger } from './logger';\nimport type { CoverageResult, ShieldBackend } from './types';\n\nconst log = createModuleLogger(projectLogger, 'ShieldController');\n\nexport type CoverageResultRecordEntry = {\n  /**\n   * History of coverage results, latest first.\n   */\n  results: CoverageResult[];\n};\n\nexport type ShieldControllerState = {\n  /**\n   * Coverage results by transaction ID.\n   */\n  coverageResults: Record<\n    string, // txId\n    CoverageResultRecordEntry\n  >;\n  /**\n   * List of txIds ordered by time, latest first.\n   */\n  orderedTransactionHistory: string[];\n};\n\n/**\n * Get the default state for the ShieldController.\n *\n * @returns The default state for the ShieldController.\n */\nexport function getDefaultShieldControllerState(): ShieldControllerState {\n  return {\n    coverageResults: {},\n    orderedTransactionHistory: [],\n  };\n}\n\nexport type ShieldControllerCheckCoverageAction = {\n  type: `${typeof controllerName}:checkCoverage`;\n  handler: ShieldController['checkCoverage'];\n};\n\n/**\n * The internal actions available to the ShieldController.\n */\nexport type ShieldControllerActions = ShieldControllerCheckCoverageAction;\n\nexport type ShieldControllerCoverageResultReceivedEvent = {\n  type: `${typeof controllerName}:coverageResultReceived`;\n  payload: [coverageResult: CoverageResult];\n};\n\nexport type ShieldControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ShieldControllerState\n>;\n\n/**\n * The internal events available to the ShieldController.\n */\nexport type ShieldControllerEvents =\n  | ShieldControllerCoverageResultReceivedEvent\n  | ShieldControllerStateChangeEvent;\n\n/**\n * The external actions available to the ShieldController.\n */\ntype AllowedActions = never;\n\n/**\n * The external events available to the ShieldController.\n */\ntype AllowedEvents =\n  | SignatureStateChange\n  | TransactionControllerStateChangeEvent;\n\n/**\n * The messenger of the {@link ShieldController}.\n */\nexport type ShieldControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  ShieldControllerActions | AllowedActions,\n  ShieldControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Metadata for the ShieldController state, describing how to \"anonymize\"\n * the state and which parts should be persisted.\n */\nconst metadata = {\n  coverageResults: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: true,\n  },\n  orderedTransactionHistory: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: false,\n  },\n};\n\nexport type ShieldControllerOptions = {\n  messenger: ShieldControllerMessenger;\n  state?: Partial<ShieldControllerState>;\n  backend: ShieldBackend;\n  transactionHistoryLimit?: number;\n  coverageHistoryLimit?: number;\n};\n\nexport class ShieldController extends BaseController<\n  typeof controllerName,\n  ShieldControllerState,\n  ShieldControllerMessenger\n> {\n  readonly #backend: ShieldBackend;\n\n  readonly #coverageHistoryLimit: number;\n\n  readonly #transactionHistoryLimit: number;\n\n  readonly #transactionControllerStateChangeHandler: (\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) => void;\n\n  readonly #signatureControllerStateChangeHandler: (\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) => void;\n\n  constructor(options: ShieldControllerOptions) {\n    const {\n      messenger,\n      state,\n      backend,\n      transactionHistoryLimit = 100,\n      coverageHistoryLimit = 10,\n    } = options;\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultShieldControllerState(),\n        ...state,\n      },\n    });\n\n    this.#backend = backend;\n    this.#coverageHistoryLimit = coverageHistoryLimit;\n    this.#transactionHistoryLimit = transactionHistoryLimit;\n    this.#transactionControllerStateChangeHandler =\n      this.#handleTransactionControllerStateChange.bind(this);\n    this.#signatureControllerStateChangeHandler =\n      this.#handleSignatureControllerStateChange.bind(this);\n  }\n\n  start() {\n    this.messagingSystem.subscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n      (state) => state.transactions,\n    );\n\n    this.messagingSystem.subscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n      (state) => state.signatureRequests,\n    );\n  }\n\n  stop() {\n    this.messagingSystem.unsubscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n    );\n  }\n\n  #handleSignatureControllerStateChange(\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) {\n    const signatureRequestsArray = Object.values(signatureRequests);\n    const previousSignatureRequestsArray = Object.values(\n      previousSignatureRequests ?? {},\n    );\n    const previousSignatureRequestsById = new Map<string, SignatureRequest>(\n      previousSignatureRequestsArray.map((request) => [request.id, request]),\n    );\n    for (const signatureRequest of signatureRequestsArray) {\n      const previousSignatureRequest = previousSignatureRequestsById.get(\n        signatureRequest.id,\n      );\n\n      // Check coverage if the signature request is new and has type\n      // `personal_sign`.\n      if (\n        !previousSignatureRequest &&\n        signatureRequest.type === SignatureRequestType.PersonalSign\n      ) {\n        this.checkSignatureCoverage(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log signature once the signature request has been fulfilled.\n      if (\n        signatureRequest.status === SignatureRequestStatus.Signed &&\n        signatureRequest.status !== previousSignatureRequest?.status\n      ) {\n        this.#logSignature(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error logging signature:', error),\n        );\n      }\n    }\n  }\n\n  #handleTransactionControllerStateChange(\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) {\n    const previousTransactionsById = new Map<string, TransactionMeta>(\n      previousTransactions?.map((tx) => [tx.id, tx]) ?? [],\n    );\n    for (const transaction of transactions) {\n      const previousTransaction = previousTransactionsById.get(transaction.id);\n\n      // Check coverage if the transaction is new or if the simulation data has\n      // changed.\n      if (\n        !previousTransaction ||\n        // Checking reference equality is sufficient because this object is\n        // replaced if the simulation data has changed.\n        previousTransaction.simulationData !== transaction.simulationData\n      ) {\n        this.checkCoverage(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log transaction once it has been submitted.\n      if (\n        transaction.status === TransactionStatus.submitted &&\n        transaction.status !== previousTransaction?.status\n      ) {\n        this.#logTransaction(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error logging transaction:', error),\n        );\n      }\n    }\n  }\n\n  /**\n   * Checks the coverage of a transaction.\n   *\n   * @param txMeta - The transaction to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {\n    // Check coverage\n    const coverageId = this.#getLatestCoverageId(txMeta.id);\n    const coverageResult = await this.#backend.checkCoverage({\n      txMeta,\n      coverageId,\n    });\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(txMeta.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  /**\n   * Checks the coverage of a signature request.\n   *\n   * @param signatureRequest - The signature request to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkSignatureCoverage(\n    signatureRequest: SignatureRequest,\n  ): Promise<CoverageResult> {\n    // Check coverage\n    const coverageId = this.#getLatestCoverageId(signatureRequest.id);\n    const coverageResult = await this.#backend.checkSignatureCoverage({\n      signatureRequest,\n      coverageId,\n    });\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(signatureRequest.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  #addCoverageResult(txId: string, coverageResult: CoverageResult) {\n    // Assert the coverageId hasn't changed.\n    const latestCoverageId = this.#getLatestCoverageId(txId);\n    if (latestCoverageId && coverageResult.coverageId !== latestCoverageId) {\n      throw new Error('Coverage ID has changed');\n    }\n\n    this.update((draft) => {\n      // Fetch coverage result entry.\n      let newEntry = false;\n      let coverageResultEntry = draft.coverageResults[txId];\n\n      // Create new entry if necessary.\n      if (!coverageResultEntry) {\n        newEntry = true;\n        coverageResultEntry = {\n          results: [],\n        };\n        draft.coverageResults[txId] = coverageResultEntry;\n      }\n\n      // Trim coverage history if necessary.\n      if (coverageResultEntry.results.length >= this.#coverageHistoryLimit) {\n        coverageResultEntry.results.pop();\n      }\n\n      // Add new result.\n      coverageResultEntry.results.unshift(coverageResult);\n\n      // Add to history if new entry.\n      const { orderedTransactionHistory } = draft;\n      let removedTxId: string | undefined;\n      if (newEntry) {\n        // Trim transaction history if necessary.\n        if (orderedTransactionHistory.length >= this.#transactionHistoryLimit) {\n          removedTxId = orderedTransactionHistory.pop();\n          // Delete corresponding coverage result entry.\n          if (removedTxId) {\n            delete draft.coverageResults[removedTxId];\n          }\n        }\n        // Add to history.\n        orderedTransactionHistory.unshift(txId);\n      }\n    });\n  }\n\n  async #logSignature(signatureRequest: SignatureRequest) {\n    const signature = signatureRequest.rawSig;\n    if (!signature) {\n      throw new Error('Signature not found');\n    }\n\n    const { status } = this.#getCoverageStatus(signatureRequest.id);\n\n    await this.#backend.logSignature({\n      signatureRequest,\n      signature,\n      status,\n    });\n  }\n\n  async #logTransaction(txMeta: TransactionMeta) {\n    const transactionHash = txMeta.hash;\n    if (!transactionHash) {\n      throw new Error('Transaction hash not found');\n    }\n\n    const { status } = this.#getCoverageStatus(txMeta.id);\n\n    await this.#backend.logTransaction({\n      txMeta,\n      transactionHash,\n      status,\n    });\n  }\n\n  #getCoverageStatus(itemId: string) {\n    // The status is assigned as follows:\n    // - 'shown' if we have a result\n    // - 'not_shown' if we don't have a result\n    const coverageId = this.#getLatestCoverageId(itemId);\n    let status = 'shown';\n    if (!coverageId) {\n      log('Coverage ID not found for', itemId);\n      status = 'not_shown';\n    }\n    return { status };\n  }\n\n  #getLatestCoverageId(itemId: string): string | undefined {\n    return this.state.coverageResults[itemId]?.results[0]?.coverageId;\n  }\n}\n"]}
+{"version":3,"file":"ShieldController.mjs","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,EACL,sBAAsB,EAGvB,uCAAuC;AACxC,OAAO,EACL,iBAAiB,EAGlB,yCAAyC;;;AAG1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAC7C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,qBAAiB;AAO7D,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;AAuBlE;;;;GAIG;AACH,MAAM,UAAU,+BAA+B;IAC7C,OAAO;QACL,eAAe,EAAE,EAAE;QACnB,yBAAyB,EAAE,EAAE;KAC9B,CAAC;AACJ,CAAC;AAoDD;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE;QACf,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,IAAI;KACf;IACD,yBAAyB,EAAE;QACzB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAoBF,MAAM,OAAO,gBAAiB,SAAQ,cAIrC;IAqBC,YAAY,OAAgC;QAC1C,MAAM,EACJ,SAAS,EACT,KAAK,EACL,OAAO,EACP,uBAAuB,GAAG,GAAG,EAC7B,oBAAoB,GAAG,EAAE,EACzB,yBAAyB,GAC1B,GAAG,OAAO,CAAC;QACZ,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QArCI,4CAAwB;QAExB,yDAA8B;QAE9B,4DAAiC;QAEjC,8DAAyD;QAEzD,4EAGC;QAED,0EAGC;QAEV,4CAAkB;QAqBhB,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,0CAAyB,oBAAoB,MAAA,CAAC;QAClD,uBAAA,IAAI,6CAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,6DACF,uBAAA,IAAI,6FAAwC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;QAC1D,uBAAA,IAAI,2DACF,uBAAA,IAAI,2FAAsC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;QACxD,uBAAA,IAAI,6BAAY,KAAK,MAAA,CAAC;QACtB,uBAAA,IAAI,+CAA8B,yBAAyB,MAAA,CAAC;IAC9D,CAAC;IAED,KAAK;QACH,IAAI,uBAAA,IAAI,iCAAS,EAAE;YACjB,OAAO;SACR;QACD,uBAAA,IAAI,6BAAY,IAAI,MAAA,CAAC;QAErB,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,EAC7C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,EAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CACnC,CAAC;IACJ,CAAC;IAED,IAAI;QACF,IAAI,CAAC,uBAAA,IAAI,iCAAS,EAAE;YAClB,OAAO;SACR;QACD,uBAAA,IAAI,6BAAY,KAAK,MAAA,CAAC;QAEtB,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,CAC9C,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,CAC5C,CAAC;IACJ,CAAC;IA6ED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,iBAAiB;QACjB,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,EAAE,CAAC,CAAC;QACxD,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC,aAAa,CAAC;YACvD,MAAM;YACN,UAAU;SACX,CAAC,CAAC;QAEH,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,cAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAEnD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,gBAAkC;QAElC,iBAAiB;QACjB,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAElE,oEAAoE;QACpE,2GAA2G;QAC3G,MAAM,sBAAsB,GAAG,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC3D,MAAM,0BAA0B,GAC9B,uBAAA,IAAI,mDAA2B,EAAE,KAAjC,IAAI,EAA8B,sBAAsB,CAAC;YACzD,sBAAsB,CAAC;QACzB,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC,sBAAsB,CAAC;YAChE,gBAAgB,EAAE,0BAA0B;YAC5C,UAAU;SACX,CAAC,CAAC;QAEH,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,cAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,gBAAgB,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAE7D,OAAO,cAAc,CAAC;IACxB,CAAC;CA+FF;gkBApOG,iBAAmD,EACnD,yBAAuE;IAEvE,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAChE,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAClD,yBAAyB,IAAI,EAAE,CAChC,CAAC;IACF,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAC3C,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CACvE,CAAC;IACF,KAAK,MAAM,gBAAgB,IAAI,sBAAsB,EAAE;QACrD,MAAM,wBAAwB,GAAG,6BAA6B,CAAC,GAAG,CAChE,gBAAgB,CAAC,EAAE,CACpB,CAAC;QAEF,kDAAkD;QAClD,IAAI,CAAC,wBAAwB,EAAE;YAC7B,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,KAAK;YACjD,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,+DAA+D;QAC/D,IACE,gBAAgB,CAAC,MAAM,KAAK,sBAAsB,CAAC,MAAM;YACzD,gBAAgB,CAAC,MAAM,KAAK,wBAAwB,EAAE,MAAM,EAC5D;YACA,uBAAA,IAAI,mEAAc,MAAlB,IAAI,EAAe,gBAAgB,CAAC,CAAC,KAAK;YACxC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;KACF;AACH,CAAC,+HAGC,YAA+B,EAC/B,oBAAmD;IAEnD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CACtC,oBAAoB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CACrD,CAAC;IACF,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEzE,4CAA4C;QAC5C,MAAM,wBAAwB,GAAG,OAAO,CACtC,WAAW,CAAC,cAAc,EAC1B,mBAAmB,EAAE,cAAc,CACpC,CAAC;QAEF,yEAAyE;QACzE,WAAW;QACX,IAAI,CAAC,mBAAmB,IAAI,CAAC,wBAAwB,EAAE;YACrD,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK;YACnC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,8CAA8C;QAC9C,IACE,WAAW,CAAC,MAAM,KAAK,iBAAiB,CAAC,SAAS;YAClD,WAAW,CAAC,MAAM,KAAK,mBAAmB,EAAE,MAAM,EAClD;YACA,uBAAA,IAAI,qEAAgB,MAApB,IAAI,EAAiB,WAAW,CAAC,CAAC,KAAK;YACrC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,CACpD,CAAC;SACH;KACF;AACH,CAAC,qFA+DkB,IAAY,EAAE,cAA8B;IAC7D,wCAAwC;IACxC,MAAM,gBAAgB,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,IAAI,CAAC,CAAC;IACzD,IAAI,gBAAgB,IAAI,cAAc,CAAC,UAAU,KAAK,gBAAgB,EAAE;QACtE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,+BAA+B;QAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtD,iCAAiC;QACjC,IAAI,CAAC,mBAAmB,EAAE;YACxB,QAAQ,GAAG,IAAI,CAAC;YAChB,mBAAmB,GAAG;gBACpB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC;SACnD;QAED,sCAAsC;QACtC,IAAI,mBAAmB,CAAC,OAAO,CAAC,MAAM,IAAI,uBAAA,IAAI,8CAAsB,EAAE;YACpE,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;SACnC;QAED,kBAAkB;QAClB,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpD,+BAA+B;QAC/B,MAAM,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;QAC5C,IAAI,WAA+B,CAAC;QACpC,IAAI,QAAQ,EAAE;YACZ,yCAAyC;YACzC,IAAI,yBAAyB,CAAC,MAAM,IAAI,uBAAA,IAAI,iDAAyB,EAAE;gBACrE,WAAW,GAAG,yBAAyB,CAAC,GAAG,EAAE,CAAC;gBAC9C,8CAA8C;gBAC9C,IAAI,WAAW,EAAE;oBACf,OAAO,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;iBAC3C;aACF;YACD,kBAAkB;YAClB,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACzC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,mCAED,KAAK,yCAAe,gBAAkC;IACpD,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC1C,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;KACxC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAEhE,MAAM,uBAAA,IAAI,iCAAS,CAAC,YAAY,CAAC;QAC/B,gBAAgB;QAChB,SAAS;QACT,MAAM;KACP,CAAC,CAAC;AACL,CAAC,qCAED,KAAK,2CAAiB,MAAuB;IAC3C,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC;IACpC,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,CAAC,CAAC;IAEtD,MAAM,uBAAA,IAAI,iCAAS,CAAC,cAAc,CAAC;QACjC,MAAM;QACN,eAAe;QACf,MAAM;KACP,CAAC,CAAC;AACL,CAAC,qFAEkB,MAAc;IAC/B,qCAAqC;IACrC,gCAAgC;IAChC,0CAA0C;IAC1C,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,CAAC;IACrD,IAAI,MAAM,GAAG,OAAO,CAAC;IACrB,IAAI,CAAC,UAAU,EAAE;QACf,GAAG,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;QACzC,MAAM,GAAG,WAAW,CAAC;KACtB;IACD,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC,yFAEoB,MAAc;IACjC,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;AACpE,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport {\n  SignatureRequestStatus,\n  type SignatureRequest,\n  type SignatureStateChange,\n} from '@metamask/signature-controller';\nimport {\n  TransactionStatus,\n  type TransactionControllerStateChangeEvent,\n  type TransactionMeta,\n} from '@metamask/transaction-controller';\nimport { cloneDeep, isEqual } from 'lodash';\n\nimport { controllerName } from './constants';\nimport { projectLogger, createModuleLogger } from './logger';\nimport type {\n  CoverageResult,\n  NormalizeSignatureRequestFn,\n  ShieldBackend,\n} from './types';\n\nconst log = createModuleLogger(projectLogger, 'ShieldController');\n\nexport type CoverageResultRecordEntry = {\n  /**\n   * History of coverage results, latest first.\n   */\n  results: CoverageResult[];\n};\n\nexport type ShieldControllerState = {\n  /**\n   * Coverage results by transaction ID.\n   */\n  coverageResults: Record<\n    string, // txId\n    CoverageResultRecordEntry\n  >;\n  /**\n   * List of txIds ordered by time, latest first.\n   */\n  orderedTransactionHistory: string[];\n};\n\n/**\n * Get the default state for the ShieldController.\n *\n * @returns The default state for the ShieldController.\n */\nexport function getDefaultShieldControllerState(): ShieldControllerState {\n  return {\n    coverageResults: {},\n    orderedTransactionHistory: [],\n  };\n}\n\nexport type ShieldControllerCheckCoverageAction = {\n  type: `${typeof controllerName}:checkCoverage`;\n  handler: ShieldController['checkCoverage'];\n};\n\n/**\n * The internal actions available to the ShieldController.\n */\nexport type ShieldControllerActions = ShieldControllerCheckCoverageAction;\n\nexport type ShieldControllerCoverageResultReceivedEvent = {\n  type: `${typeof controllerName}:coverageResultReceived`;\n  payload: [coverageResult: CoverageResult];\n};\n\nexport type ShieldControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ShieldControllerState\n>;\n\n/**\n * The internal events available to the ShieldController.\n */\nexport type ShieldControllerEvents =\n  | ShieldControllerCoverageResultReceivedEvent\n  | ShieldControllerStateChangeEvent;\n\n/**\n * The external actions available to the ShieldController.\n */\ntype AllowedActions = never;\n\n/**\n * The external events available to the ShieldController.\n */\ntype AllowedEvents =\n  | SignatureStateChange\n  | TransactionControllerStateChangeEvent;\n\n/**\n * The messenger of the {@link ShieldController}.\n */\nexport type ShieldControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  ShieldControllerActions | AllowedActions,\n  ShieldControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Metadata for the ShieldController state, describing how to \"anonymize\"\n * the state and which parts should be persisted.\n */\nconst metadata = {\n  coverageResults: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: true,\n  },\n  orderedTransactionHistory: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: false,\n  },\n};\n\nexport type ShieldControllerOptions = {\n  messenger: ShieldControllerMessenger;\n  state?: Partial<ShieldControllerState>;\n  backend: ShieldBackend;\n  transactionHistoryLimit?: number;\n  coverageHistoryLimit?: number;\n  /**\n   * Normalize the signature request before sending it to the backend.\n   * Please note that the reason this is not being done internally is to\n   * align the request body (data & params) with the security-alerts API.\n   * The same normalization function which is used to normalize security-alerts request should be used here.\n   *\n   * @param signatureRequest - The signature request to normalize.\n   * @returns The normalized signature request.\n   */\n  normalizeSignatureRequest?: NormalizeSignatureRequestFn;\n};\n\nexport class ShieldController extends BaseController<\n  typeof controllerName,\n  ShieldControllerState,\n  ShieldControllerMessenger\n> {\n  readonly #backend: ShieldBackend;\n\n  readonly #coverageHistoryLimit: number;\n\n  readonly #transactionHistoryLimit: number;\n\n  readonly #normalizeSignatureRequest?: NormalizeSignatureRequestFn;\n\n  readonly #transactionControllerStateChangeHandler: (\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) => void;\n\n  readonly #signatureControllerStateChangeHandler: (\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) => void;\n\n  #started: boolean;\n\n  constructor(options: ShieldControllerOptions) {\n    const {\n      messenger,\n      state,\n      backend,\n      transactionHistoryLimit = 100,\n      coverageHistoryLimit = 10,\n      normalizeSignatureRequest,\n    } = options;\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultShieldControllerState(),\n        ...state,\n      },\n    });\n\n    this.#backend = backend;\n    this.#coverageHistoryLimit = coverageHistoryLimit;\n    this.#transactionHistoryLimit = transactionHistoryLimit;\n    this.#transactionControllerStateChangeHandler =\n      this.#handleTransactionControllerStateChange.bind(this);\n    this.#signatureControllerStateChangeHandler =\n      this.#handleSignatureControllerStateChange.bind(this);\n    this.#started = false;\n    this.#normalizeSignatureRequest = normalizeSignatureRequest;\n  }\n\n  start() {\n    if (this.#started) {\n      return;\n    }\n    this.#started = true;\n\n    this.messagingSystem.subscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n      (state) => state.transactions,\n    );\n\n    this.messagingSystem.subscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n      (state) => state.signatureRequests,\n    );\n  }\n\n  stop() {\n    if (!this.#started) {\n      return;\n    }\n    this.#started = false;\n\n    this.messagingSystem.unsubscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n    );\n  }\n\n  #handleSignatureControllerStateChange(\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) {\n    const signatureRequestsArray = Object.values(signatureRequests);\n    const previousSignatureRequestsArray = Object.values(\n      previousSignatureRequests ?? {},\n    );\n    const previousSignatureRequestsById = new Map<string, SignatureRequest>(\n      previousSignatureRequestsArray.map((request) => [request.id, request]),\n    );\n    for (const signatureRequest of signatureRequestsArray) {\n      const previousSignatureRequest = previousSignatureRequestsById.get(\n        signatureRequest.id,\n      );\n\n      // Check coverage if the signature request is new.\n      if (!previousSignatureRequest) {\n        this.checkSignatureCoverage(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log signature once the signature request has been fulfilled.\n      if (\n        signatureRequest.status === SignatureRequestStatus.Signed &&\n        signatureRequest.status !== previousSignatureRequest?.status\n      ) {\n        this.#logSignature(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error logging signature:', error),\n        );\n      }\n    }\n  }\n\n  #handleTransactionControllerStateChange(\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) {\n    const previousTransactionsById = new Map<string, TransactionMeta>(\n      previousTransactions?.map((tx) => [tx.id, tx]) ?? [],\n    );\n    for (const transaction of transactions) {\n      const previousTransaction = previousTransactionsById.get(transaction.id);\n\n      // Check if the simulation data has changed.\n      const simulationDataNotChanged = isEqual(\n        transaction.simulationData,\n        previousTransaction?.simulationData,\n      );\n\n      // Check coverage if the transaction is new or if the simulation data has\n      // changed.\n      if (!previousTransaction || !simulationDataNotChanged) {\n        this.checkCoverage(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log transaction once it has been submitted.\n      if (\n        transaction.status === TransactionStatus.submitted &&\n        transaction.status !== previousTransaction?.status\n      ) {\n        this.#logTransaction(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error logging transaction:', error),\n        );\n      }\n    }\n  }\n\n  /**\n   * Checks the coverage of a transaction.\n   *\n   * @param txMeta - The transaction to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {\n    // Check coverage\n    const coverageId = this.#getLatestCoverageId(txMeta.id);\n    const coverageResult = await this.#backend.checkCoverage({\n      txMeta,\n      coverageId,\n    });\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(txMeta.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  /**\n   * Checks the coverage of a signature request.\n   *\n   * @param signatureRequest - The signature request to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkSignatureCoverage(\n    signatureRequest: SignatureRequest,\n  ): Promise<CoverageResult> {\n    // Check coverage\n    const coverageId = this.#getLatestCoverageId(signatureRequest.id);\n\n    // Normalize the signature request before sending it to the backend.\n    // This is to ensure that the signature data is normalized and consistent as the security alerts api calls.\n    const clonedSignatureRequest = cloneDeep(signatureRequest);\n    const normalizedSignatureRequest =\n      this.#normalizeSignatureRequest?.(clonedSignatureRequest) ??\n      clonedSignatureRequest;\n    const coverageResult = await this.#backend.checkSignatureCoverage({\n      signatureRequest: normalizedSignatureRequest,\n      coverageId,\n    });\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(signatureRequest.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  #addCoverageResult(txId: string, coverageResult: CoverageResult) {\n    // Assert the coverageId hasn't changed.\n    const latestCoverageId = this.#getLatestCoverageId(txId);\n    if (latestCoverageId && coverageResult.coverageId !== latestCoverageId) {\n      throw new Error('Coverage ID has changed');\n    }\n\n    this.update((draft) => {\n      // Fetch coverage result entry.\n      let newEntry = false;\n      let coverageResultEntry = draft.coverageResults[txId];\n\n      // Create new entry if necessary.\n      if (!coverageResultEntry) {\n        newEntry = true;\n        coverageResultEntry = {\n          results: [],\n        };\n        draft.coverageResults[txId] = coverageResultEntry;\n      }\n\n      // Trim coverage history if necessary.\n      if (coverageResultEntry.results.length >= this.#coverageHistoryLimit) {\n        coverageResultEntry.results.pop();\n      }\n\n      // Add new result.\n      coverageResultEntry.results.unshift(coverageResult);\n\n      // Add to history if new entry.\n      const { orderedTransactionHistory } = draft;\n      let removedTxId: string | undefined;\n      if (newEntry) {\n        // Trim transaction history if necessary.\n        if (orderedTransactionHistory.length >= this.#transactionHistoryLimit) {\n          removedTxId = orderedTransactionHistory.pop();\n          // Delete corresponding coverage result entry.\n          if (removedTxId) {\n            delete draft.coverageResults[removedTxId];\n          }\n        }\n        // Add to history.\n        orderedTransactionHistory.unshift(txId);\n      }\n    });\n  }\n\n  async #logSignature(signatureRequest: SignatureRequest) {\n    const signature = signatureRequest.rawSig;\n    if (!signature) {\n      throw new Error('Signature not found');\n    }\n\n    const { status } = this.#getCoverageStatus(signatureRequest.id);\n\n    await this.#backend.logSignature({\n      signatureRequest,\n      signature,\n      status,\n    });\n  }\n\n  async #logTransaction(txMeta: TransactionMeta) {\n    const transactionHash = txMeta.hash;\n    if (!transactionHash) {\n      throw new Error('Transaction hash not found');\n    }\n\n    const { status } = this.#getCoverageStatus(txMeta.id);\n\n    await this.#backend.logTransaction({\n      txMeta,\n      transactionHash,\n      status,\n    });\n  }\n\n  #getCoverageStatus(itemId: string) {\n    // The status is assigned as follows:\n    // - 'shown' if we have a result\n    // - 'not_shown' if we don't have a result\n    const coverageId = this.#getLatestCoverageId(itemId);\n    let status = 'shown';\n    if (!coverageId) {\n      log('Coverage ID not found for', itemId);\n      status = 'not_shown';\n    }\n    return { status };\n  }\n\n  #getLatestCoverageId(itemId: string): string | undefined {\n    return this.state.coverageResults[itemId]?.results[0]?.coverageId;\n  }\n}\n"]}