@metamask/snaps-controllers 12.3.0 → 13.0.0

package/dist/insights/SnapInsightsController.cjs

@@ -1,10 +1,4 @@
 "use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _SnapInsightsController_instances, _SnapInsightsController_hasInsight, _SnapInsightsController_getSnapsWithPermission, _SnapInsightsController_handleTransaction, _SnapInsightsController_handleSignatureStateChange, _SnapInsightsController_handleSignature, _SnapInsightsController_handleTransactionStatusUpdate, _SnapInsightsController_handleInsightCleanup, _SnapInsightsController_handleSnapRequest, _SnapInsightsController_handleSnapResponse;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SnapInsightsController = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -26,162 +20,218 @@ class SnapInsightsController extends base_controller_1.BaseController {
             name: controllerName,
             state: { insights: {}, ...state },
         });
-        _SnapInsightsController_instances.add(this);
-        this.messagingSystem.subscribe('TransactionController:unapprovedTransactionAdded', __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleTransaction).bind(this));
-        this.messagingSystem.subscribe('TransactionController:transactionStatusUpdated', __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleTransactionStatusUpdate).bind(this));
-        this.messagingSystem.subscribe('SignatureController:stateChange', __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleSignatureStateChange).bind(this));
+        this.messagingSystem.subscribe('TransactionController:unapprovedTransactionAdded', this.#handleTransaction.bind(this));
+        this.messagingSystem.subscribe('TransactionController:transactionStatusUpdated', this.#handleTransactionStatusUpdate.bind(this));
+        this.messagingSystem.subscribe('SignatureController:stateChange', this.#handleSignatureStateChange.bind(this));
     }
-}
-exports.SnapInsightsController = SnapInsightsController;
-_SnapInsightsController_instances = new WeakSet(), _SnapInsightsController_hasInsight = function _SnapInsightsController_hasInsight(id) {
-    return (0, utils_1.hasProperty)(this.state.insights, id);
-}, _SnapInsightsController_getSnapsWithPermission = function _SnapInsightsController_getSnapsWithPermission(permissionName) {
-    const allSnaps = this.messagingSystem.call('SnapController:getAll');
-    const filteredSnaps = (0, snaps_1.getRunnableSnaps)(allSnaps);
-    return filteredSnaps.reduce((accumulator, snap) => {
-        const permissions = this.messagingSystem.call('PermissionController:getPermissions', snap.id);
-        if (permissions && (0, utils_1.hasProperty)(permissions, permissionName)) {
-            accumulator.push({
-                snapId: snap.id,
-                permission: permissions[permissionName],
+    /**
+     * Check if an insight already exists for a given ID.
+     *
+     * @param id - The ID.
+     * @returns True if the insight already exists, otherwise false.
+     */
+    #hasInsight(id) {
+        return (0, utils_1.hasProperty)(this.state.insights, id);
+    }
+    /**
+     * Get a list of runnable Snaps that have a given permission.
+     * Also includes the permission object itself.
+     *
+     * @param permissionName - The permission name.
+     * @returns A list of objects containing Snap IDs and the permission object.
+     */
+    #getSnapsWithPermission(permissionName) {
+        const allSnaps = this.messagingSystem.call('SnapController:getAll');
+        const filteredSnaps = (0, snaps_1.getRunnableSnaps)(allSnaps);
+        return filteredSnaps.reduce((accumulator, snap) => {
+            const permissions = this.messagingSystem.call('PermissionController:getPermissions', snap.id);
+            if (permissions && (0, utils_1.hasProperty)(permissions, permissionName)) {
+                accumulator.push({
+                    snapId: snap.id,
+                    permission: permissions[permissionName],
+                });
+            }
+            return accumulator;
+        }, []);
+    }
+    /**
+     * Handle a newly added unapproved transaction.
+     * This function fetches insights from all available Snaps
+     * and populates the insights state blob with the responses.
+     *
+     * @param transaction - The transaction object.
+     */
+    #handleTransaction(transaction) {
+        const { id, txParams, chainId, origin } = transaction;
+        // This assumes that the transactions are EVM-compatible for now.
+        const caipChainId = `eip155:${(0, utils_1.hexToBigInt)(chainId).toString(10)}`;
+        const snaps = this.#getSnapsWithPermission(snaps_rpc_methods_1.SnapEndowments.TransactionInsight);
+        snaps.forEach(({ snapId, permission }) => {
+            const hasTransactionOriginCaveat = (0, snaps_rpc_methods_1.getTransactionOriginCaveat)(permission);
+            const transactionOrigin = hasTransactionOriginCaveat && origin ? origin : null;
+            this.update((state) => {
+                state.insights[id] ??= {};
+                state.insights[id][snapId] = { snapId, loading: true };
             });
-        }
-        return accumulator;
-    }, []);
-}, _SnapInsightsController_handleTransaction = function _SnapInsightsController_handleTransaction(transaction) {
-    const { id, txParams, chainId, origin } = transaction;
-    // This assumes that the transactions are EVM-compatible for now.
-    const caipChainId = `eip155:${(0, utils_1.hexToBigInt)(chainId).toString(10)}`;
-    const snaps = __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_getSnapsWithPermission).call(this, snaps_rpc_methods_1.SnapEndowments.TransactionInsight);
-    snaps.forEach(({ snapId, permission }) => {
-        const hasTransactionOriginCaveat = (0, snaps_rpc_methods_1.getTransactionOriginCaveat)(permission);
-        const transactionOrigin = hasTransactionOriginCaveat && origin ? origin : null;
-        this.update((state) => {
-            var _a;
-            (_a = state.insights)[id] ?? (_a[id] = {});
-            state.insights[id][snapId] = { snapId, loading: true };
+            this.#handleSnapRequest({
+                snapId,
+                handler: snaps_utils_1.HandlerType.OnTransaction,
+                params: {
+                    transaction: txParams,
+                    chainId: caipChainId,
+                    transactionOrigin,
+                },
+            })
+                .then((response) => this.#handleSnapResponse({
+                id,
+                snapId,
+                response: response,
+            }))
+                .catch((error) => this.#handleSnapResponse({ id, snapId, error }));
         });
-        __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleSnapRequest).call(this, {
-            snapId,
-            handler: snaps_utils_1.HandlerType.OnTransaction,
-            params: {
-                transaction: txParams,
-                chainId: caipChainId,
-                transactionOrigin,
-            },
-        })
-            .then((response) => __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleSnapResponse).call(this, {
-            id,
-            snapId,
-            response: response,
-        }))
-            .catch((error) => __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleSnapResponse).call(this, { id, snapId, error }));
-    });
-}, _SnapInsightsController_handleSignatureStateChange = function _SnapInsightsController_handleSignatureStateChange(state) {
-    // If any IDs have disappeared since the last state update, the insight may be cleaned up.
-    for (const id of Object.keys(this.state.insights)) {
-        if (!(0, utils_1.hasProperty)(state.unapprovedTypedMessages, id) &&
-            !(0, utils_1.hasProperty)(state.unapprovedPersonalMsgs, id)) {
-            __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleInsightCleanup).call(this, id);
-        }
     }
-    if (state.unapprovedPersonalMsgCount > 0 ||
-        state.unapprovedTypedMessagesCount > 0) {
-        const snaps = __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_getSnapsWithPermission).call(this, snaps_rpc_methods_1.SnapEndowments.SignatureInsight);
-        // This isn't very efficient, but SignatureController doesn't expose a better event for us to use yet.
-        for (const personalSignature of Object.values(state.unapprovedPersonalMsgs)) {
-            __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleSignature).call(this, snaps, personalSignature);
+    /**
+     * Handle the stateChange event emitted by the SignatureController.
+     * This function will remove existing insights from the state when applicable, as well as
+     * trigger insight fetching for newly added signatures.
+     *
+     * @param state - The SignatureController state blob.
+     */
+    #handleSignatureStateChange(state) {
+        // If any IDs have disappeared since the last state update, the insight may be cleaned up.
+        for (const id of Object.keys(this.state.insights)) {
+            if (!(0, utils_1.hasProperty)(state.unapprovedTypedMessages, id) &&
+                !(0, utils_1.hasProperty)(state.unapprovedPersonalMsgs, id)) {
+                this.#handleInsightCleanup(id);
+            }
         }
-        for (const typedMessage of Object.values(state.unapprovedTypedMessages)) {
-            __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleSignature).call(this, snaps, typedMessage);
+        if (state.unapprovedPersonalMsgCount > 0 ||
+            state.unapprovedTypedMessagesCount > 0) {
+            const snaps = this.#getSnapsWithPermission(snaps_rpc_methods_1.SnapEndowments.SignatureInsight);
+            // This isn't very efficient, but SignatureController doesn't expose a better event for us to use yet.
+            for (const personalSignature of Object.values(state.unapprovedPersonalMsgs)) {
+                this.#handleSignature(snaps, personalSignature);
+            }
+            for (const typedMessage of Object.values(state.unapprovedTypedMessages)) {
+                this.#handleSignature(snaps, typedMessage);
+            }
         }
     }
-}, _SnapInsightsController_handleSignature = function _SnapInsightsController_handleSignature(snaps, signature) {
-    const { id, msgParams } = signature;
-    if (__classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_hasInsight).call(this, id)) {
-        return;
+    /**
+     * Handle a newly added unapproved signature.
+     * This function fetches insights from all available Snaps
+     * and populates the insights state blob with the responses.
+     *
+     * @param snaps - A list of Snaps to invoke.
+     * @param signature - The signature object.
+     */
+    #handleSignature(snaps, signature) {
+        const { id, msgParams } = signature;
+        if (this.#hasInsight(id)) {
+            return;
+        }
+        const { from, data, signatureMethod, origin } = msgParams;
+        /**
+         * Both eth_signTypedData_v3 and eth_signTypedData_v4 methods
+         * need to be parsed because their data is stringified. All other
+         * signature methods do not, so they are ignored.
+         */
+        const shouldParse = signatureMethod === 'eth_signTypedData_v3' ||
+            signatureMethod === 'eth_signTypedData_v4';
+        const payload = {
+            from,
+            data: shouldParse ? JSON.parse(data) : data,
+            signatureMethod,
+        };
+        snaps.forEach(({ snapId, permission }) => {
+            const hasSignatureOriginCaveat = (0, snaps_rpc_methods_1.getSignatureOriginCaveat)(permission);
+            const signatureOrigin = origin && hasSignatureOriginCaveat ? origin : null;
+            this.update((state) => {
+                state.insights[id] ??= {};
+                state.insights[id][snapId] = { snapId, loading: true };
+            });
+            this.#handleSnapRequest({
+                snapId,
+                handler: snaps_utils_1.HandlerType.OnSignature,
+                params: { signature: payload, signatureOrigin },
+            })
+                .then((response) => this.#handleSnapResponse({
+                id,
+                snapId,
+                response: response,
+            }))
+                .catch((error) => this.#handleSnapResponse({ id, snapId, error }));
+        });
     }
-    const { from, data, signatureMethod, origin } = msgParams;
     /**
-     * Both eth_signTypedData_v3 and eth_signTypedData_v4 methods
-     * need to be parsed because their data is stringified. All other
-     * signature methods do not, so they are ignored.
+     * Handle the transactionStatusUpdated event emitted by the TransactionController.
+     * This function will remove insights for the transaction in question
+     * once the transaction status has changed from unapproved.
+     *
+     * @param args - An options bag.
+     * @param args.transactionMeta - The transaction.
      */
-    const shouldParse = signatureMethod === 'eth_signTypedData_v3' ||
-        signatureMethod === 'eth_signTypedData_v4';
-    const payload = {
-        from,
-        data: shouldParse ? JSON.parse(data) : data,
-        signatureMethod,
-    };
-    snaps.forEach(({ snapId, permission }) => {
-        const hasSignatureOriginCaveat = (0, snaps_rpc_methods_1.getSignatureOriginCaveat)(permission);
-        const signatureOrigin = origin && hasSignatureOriginCaveat ? origin : null;
+    #handleTransactionStatusUpdate({ transactionMeta, }) {
+        if (transactionMeta.status !== 'unapproved') {
+            this.#handleInsightCleanup(transactionMeta.id);
+        }
+    }
+    #handleInsightCleanup(id) {
+        if (!this.#hasInsight(id)) {
+            return;
+        }
+        // Delete interfaces from interface controller.
+        Object.values(this.state.insights[id])
+            .filter((insight) => insight.interfaceId)
+            .forEach((insight) => {
+            this.messagingSystem.call('SnapInterfaceController:deleteInterface', insight.interfaceId);
+        });
         this.update((state) => {
-            var _a;
-            (_a = state.insights)[id] ?? (_a[id] = {});
-            state.insights[id][snapId] = { snapId, loading: true };
+            delete state.insights[id];
         });
-        __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleSnapRequest).call(this, {
-            snapId,
-            handler: snaps_utils_1.HandlerType.OnSignature,
-            params: { signature: payload, signatureOrigin },
-        })
-            .then((response) => __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleSnapResponse).call(this, {
-            id,
-            snapId,
-            response: response,
-        }))
-            .catch((error) => __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleSnapResponse).call(this, { id, snapId, error }));
-    });
-}, _SnapInsightsController_handleTransactionStatusUpdate = function _SnapInsightsController_handleTransactionStatusUpdate({ transactionMeta, }) {
-    if (transactionMeta.status !== 'unapproved') {
-        __classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_handleInsightCleanup).call(this, transactionMeta.id);
     }
-}, _SnapInsightsController_handleInsightCleanup = function _SnapInsightsController_handleInsightCleanup(id) {
-    if (!__classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_hasInsight).call(this, id)) {
-        return;
+    /**
+     * Handle sending a request to a given Snap with a given payload.
+     *
+     * @param args - An options bag.
+     * @param args.snapId - The Snap ID.
+     * @param args.handler - The handler to invoke.
+     * @param args.params - The JSON-RPC params to send.
+     * @returns The response from the Snap.
+     */
+    async #handleSnapRequest({ snapId, handler, params, }) {
+        return this.messagingSystem.call('SnapController:handleRequest', {
+            snapId,
+            origin: 'metamask',
+            handler,
+            request: {
+                method: '',
+                params,
+            },
+        });
     }
-    // Delete interfaces from interface controller.
-    Object.values(this.state.insights[id])
-        .filter((insight) => insight.interfaceId)
-        .forEach((insight) => {
-        this.messagingSystem.call('SnapInterfaceController:deleteInterface', insight.interfaceId);
-    });
-    this.update((state) => {
-        delete state.insights[id];
-    });
-}, _SnapInsightsController_handleSnapRequest = 
-/**
- * Handle sending a request to a given Snap with a given payload.
- *
- * @param args - An options bag.
- * @param args.snapId - The Snap ID.
- * @param args.handler - The handler to invoke.
- * @param args.params - The JSON-RPC params to send.
- * @returns The response from the Snap.
- */
-async function _SnapInsightsController_handleSnapRequest({ snapId, handler, params, }) {
-    return this.messagingSystem.call('SnapController:handleRequest', {
-        snapId,
-        origin: 'metamask',
-        handler,
-        request: {
-            method: '',
-            params,
-        },
-    });
-}, _SnapInsightsController_handleSnapResponse = function _SnapInsightsController_handleSnapResponse({ id, snapId, response, error, }) {
-    // If the insight has been cleaned up already, we can skip setting the state.
-    // This may happen if a user accepts/rejects a transaction/signature faster than the Snap responds.
-    if (!__classPrivateFieldGet(this, _SnapInsightsController_instances, "m", _SnapInsightsController_hasInsight).call(this, id)) {
-        return;
+    /**
+     * Handle response from a given Snap by persisting the response or error in state.
+     *
+     * @param args - An options bag.
+     * @param args.id - The transaction or signature ID.
+     * @param args.snapId - The Snap ID.
+     * @param args.response - An optional response object returned by the Snap.
+     * @param args.error - An optional error returned by the Snap.
+     */
+    #handleSnapResponse({ id, snapId, response, error, }) {
+        // If the insight has been cleaned up already, we can skip setting the state.
+        // This may happen if a user accepts/rejects a transaction/signature faster than the Snap responds.
+        if (!this.#hasInsight(id)) {
+            return;
+        }
+        this.update((state) => {
+            state.insights[id][snapId].loading = false;
+            state.insights[id][snapId].interfaceId = response?.id;
+            state.insights[id][snapId].severity = response?.severity;
+            state.insights[id][snapId].error = error?.message;
+        });
     }
-    this.update((state) => {
-        state.insights[id][snapId].loading = false;
-        state.insights[id][snapId].interfaceId = response?.id;
-        state.insights[id][snapId].severity = response?.severity;
-        state.insights[id][snapId].error = error?.message;
-    });
-};
+}
+exports.SnapInsightsController = SnapInsightsController;
 //# sourceMappingURL=SnapInsightsController.cjs.map

package/dist/insights/SnapInsightsController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"SnapInsightsController.cjs","sourceRoot":"","sources":["../../src/insights/SnapInsightsController.ts"],"names":[],"mappings":";;;;;;;;;AAKA,+DAA2D;AAM3D,mEAIqC;AAErC,uDAAoD;AACpD,2CAA2D;AAI3D,8CAA4C;AAU5C,MAAM,cAAc,GAAG,wBAAwB,CAAC;AA0DhD;;GAEG;AACH,MAAa,sBAAuB,SAAQ,gCAI3C;IACC,YAAY,EAAE,SAAS,EAAE,KAAK,EAA8B;QAC1D,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE;gBACR,QAAQ,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;aAC/C;YACD,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE;SAClC,CAAC,CAAC;;QAEH,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,kDAAkD,EAClD,uBAAA,IAAI,oFAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CACnC,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,gDAAgD,EAChD,uBAAA,IAAI,gGAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/C,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,uBAAA,IAAI,6FAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5C,CAAC;IACJ,CAAC;CA2RF;AAxTD,wDAwTC;oIAnRa,EAAU;IACpB,OAAO,IAAA,mBAAW,EAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC9C,CAAC,2GASuB,cAAsB;IAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,IAAA,wBAAgB,EAAC,QAAQ,CAAC,CAAC;IAEjD,OAAO,aAAa,CAAC,MAAM,CAAuB,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE;QACtE,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC3C,qCAAqC,EACrC,IAAI,CAAC,EAAE,CACR,CAAC;QACF,IAAI,WAAW,IAAI,IAAA,mBAAW,EAAC,WAAW,EAAE,cAAc,CAAC,EAAE,CAAC;YAC5D,WAAW,CAAC,IAAI,CAAC;gBACf,MAAM,EAAE,IAAI,CAAC,EAAE;gBACf,UAAU,EAAE,WAAW,CAAC,cAAc,CAAC;aACxC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC,iGASkB,WAA4B;IAC7C,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;IAEtD,iEAAiE;IACjE,MAAM,WAAW,GAAG,UAAU,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;IAElE,MAAM,KAAK,GAAG,uBAAA,IAAI,yFAAwB,MAA5B,IAAI,EAChB,kCAAc,CAAC,kBAAkB,CAClC,CAAC;IAEF,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE;QACvC,MAAM,0BAA0B,GAAG,IAAA,8CAA0B,EAAC,UAAU,CAAC,CAAC;QAC1E,MAAM,iBAAiB,GACrB,0BAA0B,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QAEvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;;YACpB,MAAA,KAAK,CAAC,QAAQ,EAAC,EAAE,SAAF,EAAE,IAAM,EAAE,EAAC;YAC1B,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,uBAAA,IAAI,oFAAmB,MAAvB,IAAI,EAAoB;YACtB,MAAM;YACN,OAAO,EAAE,yBAAW,CAAC,aAAa;YAClC,MAAM,EAAE;gBACN,WAAW,EAAE,QAAQ;gBACrB,OAAO,EAAE,WAAW;gBACpB,iBAAiB;aAClB;SACF,CAAC;aACC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACjB,uBAAA,IAAI,qFAAoB,MAAxB,IAAI,EAAqB;YACvB,EAAE;YACF,MAAM;YACN,QAAQ,EAAE,QAAgC;SAC3C,CAAC,CACH;aACA,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAA,IAAI,qFAAoB,MAAxB,IAAI,EAAqB,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,mHAS2B,KAA+B;IACzD,0FAA0F;IAC1F,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClD,IACE,CAAC,IAAA,mBAAW,EAAC,KAAK,CAAC,uBAAuB,EAAE,EAAE,CAAC;YAC/C,CAAC,IAAA,mBAAW,EAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,CAAC,EAC9C,CAAC;YACD,uBAAA,IAAI,uFAAsB,MAA1B,IAAI,EAAuB,EAAE,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED,IACE,KAAK,CAAC,0BAA0B,GAAG,CAAC;QACpC,KAAK,CAAC,4BAA4B,GAAG,CAAC,EACtC,CAAC;QACD,MAAM,KAAK,GAAG,uBAAA,IAAI,yFAAwB,MAA5B,IAAI,EAChB,kCAAc,CAAC,gBAAgB,CAChC,CAAC;QAEF,sGAAsG;QACtG,KAAK,MAAM,iBAAiB,IAAI,MAAM,CAAC,MAAM,CAC3C,KAAK,CAAC,sBAAsB,CAC7B,EAAE,CAAC;YACF,uBAAA,IAAI,kFAAiB,MAArB,IAAI,EAAkB,KAAK,EAAE,iBAAiB,CAAC,CAAC;QAClD,CAAC;QAED,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,EAAE,CAAC;YACxE,uBAAA,IAAI,kFAAiB,MAArB,IAAI,EAAkB,KAAK,EAAE,YAAY,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;AACH,CAAC,6FAUgB,KAA2B,EAAE,SAAyB;IACrE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAEpC,IAAI,uBAAA,IAAI,6EAAY,MAAhB,IAAI,EAAa,EAAE,CAAC,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAE1D;;;;OAIG;IACH,MAAM,WAAW,GACf,eAAe,KAAK,sBAAsB;QAC1C,eAAe,KAAK,sBAAsB,CAAC;IAE7C,MAAM,OAAO,GAAG;QACd,IAAI;QACJ,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAc,CAAC,CAAC,CAAC,CAAC,IAAI;QACrD,eAAe;KAChB,CAAC;IAEF,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE;QACvC,MAAM,wBAAwB,GAAG,IAAA,4CAAwB,EAAC,UAAU,CAAC,CAAC;QACtE,MAAM,eAAe,GACnB,MAAM,IAAI,wBAAwB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QAErD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;;YACpB,MAAA,KAAK,CAAC,QAAQ,EAAC,EAAE,SAAF,EAAE,IAAM,EAAE,EAAC;YAC1B,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,uBAAA,IAAI,oFAAmB,MAAvB,IAAI,EAAoB;YACtB,MAAM;YACN,OAAO,EAAE,yBAAW,CAAC,WAAW;YAChC,MAAM,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE;SAChD,CAAC;aACC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACjB,uBAAA,IAAI,qFAAoB,MAAxB,IAAI,EAAqB;YACvB,EAAE;YACF,MAAM;YACN,QAAQ,EAAE,QAAgC;SAC3C,CAAC,CACH;aACA,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAA,IAAI,qFAAoB,MAAxB,IAAI,EAAqB,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,yHAU8B,EAC7B,eAAe,GAGhB;IACC,IAAI,eAAe,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;QAC5C,uBAAA,IAAI,uFAAsB,MAA1B,IAAI,EAAuB,eAAe,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;AACH,CAAC,uGAEqB,EAAU;IAC9B,IAAI,CAAC,uBAAA,IAAI,6EAAY,MAAhB,IAAI,EAAa,EAAE,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,+CAA+C;IAC/C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SACnC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;SACxC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QACnB,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,yCAAyC,EACzC,OAAO,CAAC,WAAqB,CAC9B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEL,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,oDAAoB,EACvB,MAAM,EACN,OAAO,EACP,MAAM,GAKP;IACC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,8BAA8B,EAAE;QAC/D,MAAM;QACN,MAAM,EAAE,UAAU;QAClB,OAAO;QACP,OAAO,EAAE;YACP,MAAM,EAAE,EAAE;YACV,MAAM;SACP;KACF,CAAC,CAAC;AACL,CAAC,mGAWmB,EAClB,EAAE,EACF,MAAM,EACN,QAAQ,EACR,KAAK,GAMN;IACC,6EAA6E;IAC7E,mGAAmG;IACnG,IAAI,CAAC,uBAAA,IAAI,6EAAY,MAAhB,IAAI,EAAa,EAAE,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,GAAG,KAAK,CAAC;QAC3C,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,GAAG,QAAQ,EAAE,EAAY,CAAC;QAChE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,GAAG,QAAQ,EAAE,QAAkB,CAAC;QACnE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,GAAG,KAAK,EAAE,OAAO,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type {\n  RestrictedMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  Caveat,\n  GetPermissions,\n  ValidPermission,\n} from '@metamask/permission-controller';\nimport {\n  getSignatureOriginCaveat,\n  getTransactionOriginCaveat,\n  SnapEndowments,\n} from '@metamask/snaps-rpc-methods';\nimport type { Json, SnapId } from '@metamask/snaps-sdk';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport { hasProperty, hexToBigInt } from '@metamask/utils';\n\nimport type { DeleteInterface } from '../interface';\nimport type { GetAllSnaps, HandleSnapRequest } from '../snaps';\nimport { getRunnableSnaps } from '../snaps';\nimport type {\n  TransactionControllerUnapprovedTransactionAddedEvent,\n  TransactionMeta,\n  SignatureStateChange,\n  SignatureControllerState,\n  StateSignature,\n  TransactionControllerTransactionStatusUpdatedEvent,\n} from '../types';\n\nconst controllerName = 'SnapInsightsController';\n\nexport type SnapInsightsControllerAllowedActions =\n  | HandleSnapRequest\n  | GetAllSnaps\n  | GetPermissions\n  | DeleteInterface;\n\nexport type SnapInsightsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  SnapInsightsControllerState\n>;\n\nexport type SnapInsightsControllerActions =\n  SnapInsightsControllerGetStateAction;\n\nexport type SnapInsightControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  SnapInsightsControllerState\n>;\n\nexport type SnapInsightControllerEvents = SnapInsightControllerStateChangeEvent;\n\nexport type SnapInsightsControllerAllowedEvents =\n  | TransactionControllerUnapprovedTransactionAddedEvent\n  | TransactionControllerTransactionStatusUpdatedEvent\n  | SignatureStateChange;\n\nexport type SnapInsightsControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  SnapInsightsControllerActions | SnapInsightsControllerAllowedActions,\n  SnapInsightControllerEvents | SnapInsightsControllerAllowedEvents,\n  SnapInsightsControllerAllowedActions['type'],\n  SnapInsightsControllerAllowedEvents['type']\n>;\n\nexport type SnapInsight = {\n  snapId: SnapId;\n  interfaceId?: string | null;\n  error?: string;\n  loading: boolean;\n  severity?: string;\n};\n\nexport type SnapInsightsControllerState = {\n  insights: Record<string, Record<SnapId, SnapInsight>>;\n};\n\nexport type SnapInsightsControllerArgs = {\n  messenger: SnapInsightsControllerMessenger;\n  state?: SnapInsightsControllerState;\n};\n\ntype SnapWithPermission = {\n  snapId: SnapId;\n  permission: ValidPermission<string, Caveat<string, Json>>;\n};\n\n/**\n * Controller for monitoring for new transactions and signatures to provide insight for.\n */\nexport class SnapInsightsController extends BaseController<\n  typeof controllerName,\n  SnapInsightsControllerState,\n  SnapInsightsControllerMessenger\n> {\n  constructor({ messenger, state }: SnapInsightsControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        insights: { persist: false, anonymous: false },\n      },\n      name: controllerName,\n      state: { insights: {}, ...state },\n    });\n\n    this.messagingSystem.subscribe(\n      'TransactionController:unapprovedTransactionAdded',\n      this.#handleTransaction.bind(this),\n    );\n\n    this.messagingSystem.subscribe(\n      'TransactionController:transactionStatusUpdated',\n      this.#handleTransactionStatusUpdate.bind(this),\n    );\n\n    this.messagingSystem.subscribe(\n      'SignatureController:stateChange',\n      this.#handleSignatureStateChange.bind(this),\n    );\n  }\n\n  /**\n   * Check if an insight already exists for a given ID.\n   *\n   * @param id - The ID.\n   * @returns True if the insight already exists, otherwise false.\n   */\n  #hasInsight(id: string) {\n    return hasProperty(this.state.insights, id);\n  }\n\n  /**\n   * Get a list of runnable Snaps that have a given permission.\n   * Also includes the permission object itself.\n   *\n   * @param permissionName - The permission name.\n   * @returns A list of objects containing Snap IDs and the permission object.\n   */\n  #getSnapsWithPermission(permissionName: string) {\n    const allSnaps = this.messagingSystem.call('SnapController:getAll');\n    const filteredSnaps = getRunnableSnaps(allSnaps);\n\n    return filteredSnaps.reduce<SnapWithPermission[]>((accumulator, snap) => {\n      const permissions = this.messagingSystem.call(\n        'PermissionController:getPermissions',\n        snap.id,\n      );\n      if (permissions && hasProperty(permissions, permissionName)) {\n        accumulator.push({\n          snapId: snap.id,\n          permission: permissions[permissionName],\n        });\n      }\n\n      return accumulator;\n    }, []);\n  }\n\n  /**\n   * Handle a newly added unapproved transaction.\n   * This function fetches insights from all available Snaps\n   * and populates the insights state blob with the responses.\n   *\n   * @param transaction - The transaction object.\n   */\n  #handleTransaction(transaction: TransactionMeta) {\n    const { id, txParams, chainId, origin } = transaction;\n\n    // This assumes that the transactions are EVM-compatible for now.\n    const caipChainId = `eip155:${hexToBigInt(chainId).toString(10)}`;\n\n    const snaps = this.#getSnapsWithPermission(\n      SnapEndowments.TransactionInsight,\n    );\n\n    snaps.forEach(({ snapId, permission }) => {\n      const hasTransactionOriginCaveat = getTransactionOriginCaveat(permission);\n      const transactionOrigin =\n        hasTransactionOriginCaveat && origin ? origin : null;\n\n      this.update((state) => {\n        state.insights[id] ??= {};\n        state.insights[id][snapId] = { snapId, loading: true };\n      });\n\n      this.#handleSnapRequest({\n        snapId,\n        handler: HandlerType.OnTransaction,\n        params: {\n          transaction: txParams,\n          chainId: caipChainId,\n          transactionOrigin,\n        },\n      })\n        .then((response) =>\n          this.#handleSnapResponse({\n            id,\n            snapId,\n            response: response as Record<string, Json>,\n          }),\n        )\n        .catch((error) => this.#handleSnapResponse({ id, snapId, error }));\n    });\n  }\n\n  /**\n   * Handle the stateChange event emitted by the SignatureController.\n   * This function will remove existing insights from the state when applicable, as well as\n   * trigger insight fetching for newly added signatures.\n   *\n   * @param state - The SignatureController state blob.\n   */\n  #handleSignatureStateChange(state: SignatureControllerState) {\n    // If any IDs have disappeared since the last state update, the insight may be cleaned up.\n    for (const id of Object.keys(this.state.insights)) {\n      if (\n        !hasProperty(state.unapprovedTypedMessages, id) &&\n        !hasProperty(state.unapprovedPersonalMsgs, id)\n      ) {\n        this.#handleInsightCleanup(id);\n      }\n    }\n\n    if (\n      state.unapprovedPersonalMsgCount > 0 ||\n      state.unapprovedTypedMessagesCount > 0\n    ) {\n      const snaps = this.#getSnapsWithPermission(\n        SnapEndowments.SignatureInsight,\n      );\n\n      // This isn't very efficient, but SignatureController doesn't expose a better event for us to use yet.\n      for (const personalSignature of Object.values(\n        state.unapprovedPersonalMsgs,\n      )) {\n        this.#handleSignature(snaps, personalSignature);\n      }\n\n      for (const typedMessage of Object.values(state.unapprovedTypedMessages)) {\n        this.#handleSignature(snaps, typedMessage);\n      }\n    }\n  }\n\n  /**\n   * Handle a newly added unapproved signature.\n   * This function fetches insights from all available Snaps\n   * and populates the insights state blob with the responses.\n   *\n   * @param snaps - A list of Snaps to invoke.\n   * @param signature - The signature object.\n   */\n  #handleSignature(snaps: SnapWithPermission[], signature: StateSignature) {\n    const { id, msgParams } = signature;\n\n    if (this.#hasInsight(id)) {\n      return;\n    }\n\n    const { from, data, signatureMethod, origin } = msgParams;\n\n    /**\n     * Both eth_signTypedData_v3 and eth_signTypedData_v4 methods\n     * need to be parsed because their data is stringified. All other\n     * signature methods do not, so they are ignored.\n     */\n    const shouldParse =\n      signatureMethod === 'eth_signTypedData_v3' ||\n      signatureMethod === 'eth_signTypedData_v4';\n\n    const payload = {\n      from,\n      data: shouldParse ? JSON.parse(data as string) : data,\n      signatureMethod,\n    };\n\n    snaps.forEach(({ snapId, permission }) => {\n      const hasSignatureOriginCaveat = getSignatureOriginCaveat(permission);\n      const signatureOrigin =\n        origin && hasSignatureOriginCaveat ? origin : null;\n\n      this.update((state) => {\n        state.insights[id] ??= {};\n        state.insights[id][snapId] = { snapId, loading: true };\n      });\n\n      this.#handleSnapRequest({\n        snapId,\n        handler: HandlerType.OnSignature,\n        params: { signature: payload, signatureOrigin },\n      })\n        .then((response) =>\n          this.#handleSnapResponse({\n            id,\n            snapId,\n            response: response as Record<string, Json>,\n          }),\n        )\n        .catch((error) => this.#handleSnapResponse({ id, snapId, error }));\n    });\n  }\n\n  /**\n   * Handle the transactionStatusUpdated event emitted by the TransactionController.\n   * This function will remove insights for the transaction in question\n   * once the transaction status has changed from unapproved.\n   *\n   * @param args - An options bag.\n   * @param args.transactionMeta - The transaction.\n   */\n  #handleTransactionStatusUpdate({\n    transactionMeta,\n  }: {\n    transactionMeta: TransactionMeta;\n  }) {\n    if (transactionMeta.status !== 'unapproved') {\n      this.#handleInsightCleanup(transactionMeta.id);\n    }\n  }\n\n  #handleInsightCleanup(id: string) {\n    if (!this.#hasInsight(id)) {\n      return;\n    }\n\n    // Delete interfaces from interface controller.\n    Object.values(this.state.insights[id])\n      .filter((insight) => insight.interfaceId)\n      .forEach((insight) => {\n        this.messagingSystem.call(\n          'SnapInterfaceController:deleteInterface',\n          insight.interfaceId as string,\n        );\n      });\n\n    this.update((state) => {\n      delete state.insights[id];\n    });\n  }\n\n  /**\n   * Handle sending a request to a given Snap with a given payload.\n   *\n   * @param args - An options bag.\n   * @param args.snapId - The Snap ID.\n   * @param args.handler - The handler to invoke.\n   * @param args.params - The JSON-RPC params to send.\n   * @returns The response from the Snap.\n   */\n  async #handleSnapRequest({\n    snapId,\n    handler,\n    params,\n  }: {\n    snapId: SnapId;\n    handler: HandlerType.OnTransaction | HandlerType.OnSignature;\n    params: Record<string, Json>;\n  }) {\n    return this.messagingSystem.call('SnapController:handleRequest', {\n      snapId,\n      origin: 'metamask',\n      handler,\n      request: {\n        method: '',\n        params,\n      },\n    });\n  }\n\n  /**\n   * Handle response from a given Snap by persisting the response or error in state.\n   *\n   * @param args - An options bag.\n   * @param args.id - The transaction or signature ID.\n   * @param args.snapId - The Snap ID.\n   * @param args.response - An optional response object returned by the Snap.\n   * @param args.error - An optional error returned by the Snap.\n   */\n  #handleSnapResponse({\n    id,\n    snapId,\n    response,\n    error,\n  }: {\n    id: string;\n    snapId: SnapId;\n    response?: Record<string, Json>;\n    error?: Error;\n  }) {\n    // If the insight has been cleaned up already, we can skip setting the state.\n    // This may happen if a user accepts/rejects a transaction/signature faster than the Snap responds.\n    if (!this.#hasInsight(id)) {\n      return;\n    }\n\n    this.update((state) => {\n      state.insights[id][snapId].loading = false;\n      state.insights[id][snapId].interfaceId = response?.id as string;\n      state.insights[id][snapId].severity = response?.severity as string;\n      state.insights[id][snapId].error = error?.message;\n    });\n  }\n}\n"]}
+{"version":3,"file":"SnapInsightsController.cjs","sourceRoot":"","sources":["../../src/insights/SnapInsightsController.ts"],"names":[],"mappings":";;;AAKA,+DAA2D;AAM3D,mEAIqC;AAErC,uDAAoD;AACpD,2CAA2D;AAI3D,8CAA4C;AAU5C,MAAM,cAAc,GAAG,wBAAwB,CAAC;AA0DhD;;GAEG;AACH,MAAa,sBAAuB,SAAQ,gCAI3C;IACC,YAAY,EAAE,SAAS,EAAE,KAAK,EAA8B;QAC1D,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE;gBACR,QAAQ,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;aAC/C;YACD,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE;SAClC,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,kDAAkD,EAClD,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CACnC,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,gDAAgD,EAChD,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/C,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5C,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,EAAU;QACpB,OAAO,IAAA,mBAAW,EAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACH,uBAAuB,CAAC,cAAsB;QAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QACpE,MAAM,aAAa,GAAG,IAAA,wBAAgB,EAAC,QAAQ,CAAC,CAAC;QAEjD,OAAO,aAAa,CAAC,MAAM,CAAuB,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE;YACtE,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC3C,qCAAqC,EACrC,IAAI,CAAC,EAAE,CACR,CAAC;YACF,IAAI,WAAW,IAAI,IAAA,mBAAW,EAAC,WAAW,EAAE,cAAc,CAAC,EAAE,CAAC;gBAC5D,WAAW,CAAC,IAAI,CAAC;oBACf,MAAM,EAAE,IAAI,CAAC,EAAE;oBACf,UAAU,EAAE,WAAW,CAAC,cAAc,CAAC;iBACxC,CAAC,CAAC;YACL,CAAC;YAED,OAAO,WAAW,CAAC;QACrB,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAAC,WAA4B;QAC7C,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;QAEtD,iEAAiE;QACjE,MAAM,WAAW,GAAG,UAAU,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAElE,MAAM,KAAK,GAAG,IAAI,CAAC,uBAAuB,CACxC,kCAAc,CAAC,kBAAkB,CAClC,CAAC;QAEF,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE;YACvC,MAAM,0BAA0B,GAAG,IAAA,8CAA0B,EAAC,UAAU,CAAC,CAAC;YAC1E,MAAM,iBAAiB,GACrB,0BAA0B,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;YAEvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;gBAC1B,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YACzD,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,kBAAkB,CAAC;gBACtB,MAAM;gBACN,OAAO,EAAE,yBAAW,CAAC,aAAa;gBAClC,MAAM,EAAE;oBACN,WAAW,EAAE,QAAQ;oBACrB,OAAO,EAAE,WAAW;oBACpB,iBAAiB;iBAClB;aACF,CAAC;iBACC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACjB,IAAI,CAAC,mBAAmB,CAAC;gBACvB,EAAE;gBACF,MAAM;gBACN,QAAQ,EAAE,QAAgC;aAC3C,CAAC,CACH;iBACA,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,2BAA2B,CAAC,KAA+B;QACzD,0FAA0F;QAC1F,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YAClD,IACE,CAAC,IAAA,mBAAW,EAAC,KAAK,CAAC,uBAAuB,EAAE,EAAE,CAAC;gBAC/C,CAAC,IAAA,mBAAW,EAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,CAAC,EAC9C,CAAC;gBACD,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;QAED,IACE,KAAK,CAAC,0BAA0B,GAAG,CAAC;YACpC,KAAK,CAAC,4BAA4B,GAAG,CAAC,EACtC,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,uBAAuB,CACxC,kCAAc,CAAC,gBAAgB,CAChC,CAAC;YAEF,sGAAsG;YACtG,KAAK,MAAM,iBAAiB,IAAI,MAAM,CAAC,MAAM,CAC3C,KAAK,CAAC,sBAAsB,CAC7B,EAAE,CAAC;gBACF,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;YAClD,CAAC;YAED,KAAK,MAAM,YAAY,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,EAAE,CAAC;gBACxE,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAC,KAA2B,EAAE,SAAyB;QACrE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;QAEpC,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;YACzB,OAAO;QACT,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;QAE1D;;;;WAIG;QACH,MAAM,WAAW,GACf,eAAe,KAAK,sBAAsB;YAC1C,eAAe,KAAK,sBAAsB,CAAC;QAE7C,MAAM,OAAO,GAAG;YACd,IAAI;YACJ,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAc,CAAC,CAAC,CAAC,CAAC,IAAI;YACrD,eAAe;SAChB,CAAC;QAEF,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE;YACvC,MAAM,wBAAwB,GAAG,IAAA,4CAAwB,EAAC,UAAU,CAAC,CAAC;YACtE,MAAM,eAAe,GACnB,MAAM,IAAI,wBAAwB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;YAErD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;gBAC1B,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YACzD,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,kBAAkB,CAAC;gBACtB,MAAM;gBACN,OAAO,EAAE,yBAAW,CAAC,WAAW;gBAChC,MAAM,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE;aAChD,CAAC;iBACC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACjB,IAAI,CAAC,mBAAmB,CAAC;gBACvB,EAAE;gBACF,MAAM;gBACN,QAAQ,EAAE,QAAgC;aAC3C,CAAC,CACH;iBACA,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,8BAA8B,CAAC,EAC7B,eAAe,GAGhB;QACC,IAAI,eAAe,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;YAC5C,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED,qBAAqB,CAAC,EAAU;QAC9B,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,+CAA+C;QAC/C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;aACnC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;aACxC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACnB,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,yCAAyC,EACzC,OAAO,CAAC,WAAqB,CAC9B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,kBAAkB,CAAC,EACvB,MAAM,EACN,OAAO,EACP,MAAM,GAKP;QACC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,8BAA8B,EAAE;YAC/D,MAAM;YACN,MAAM,EAAE,UAAU;YAClB,OAAO;YACP,OAAO,EAAE;gBACP,MAAM,EAAE,EAAE;gBACV,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAClB,EAAE,EACF,MAAM,EACN,QAAQ,EACR,KAAK,GAMN;QACC,6EAA6E;QAC7E,mGAAmG;QACnG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,GAAG,KAAK,CAAC;YAC3C,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,GAAG,QAAQ,EAAE,EAAY,CAAC;YAChE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,GAAG,QAAQ,EAAE,QAAkB,CAAC;YACnE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,GAAG,KAAK,EAAE,OAAO,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxTD,wDAwTC","sourcesContent":["import type {\n  RestrictedMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  Caveat,\n  GetPermissions,\n  ValidPermission,\n} from '@metamask/permission-controller';\nimport {\n  getSignatureOriginCaveat,\n  getTransactionOriginCaveat,\n  SnapEndowments,\n} from '@metamask/snaps-rpc-methods';\nimport type { Json, SnapId } from '@metamask/snaps-sdk';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport { hasProperty, hexToBigInt } from '@metamask/utils';\n\nimport type { DeleteInterface } from '../interface';\nimport type { GetAllSnaps, HandleSnapRequest } from '../snaps';\nimport { getRunnableSnaps } from '../snaps';\nimport type {\n  TransactionControllerUnapprovedTransactionAddedEvent,\n  TransactionMeta,\n  SignatureStateChange,\n  SignatureControllerState,\n  StateSignature,\n  TransactionControllerTransactionStatusUpdatedEvent,\n} from '../types';\n\nconst controllerName = 'SnapInsightsController';\n\nexport type SnapInsightsControllerAllowedActions =\n  | HandleSnapRequest\n  | GetAllSnaps\n  | GetPermissions\n  | DeleteInterface;\n\nexport type SnapInsightsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  SnapInsightsControllerState\n>;\n\nexport type SnapInsightsControllerActions =\n  SnapInsightsControllerGetStateAction;\n\nexport type SnapInsightControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  SnapInsightsControllerState\n>;\n\nexport type SnapInsightControllerEvents = SnapInsightControllerStateChangeEvent;\n\nexport type SnapInsightsControllerAllowedEvents =\n  | TransactionControllerUnapprovedTransactionAddedEvent\n  | TransactionControllerTransactionStatusUpdatedEvent\n  | SignatureStateChange;\n\nexport type SnapInsightsControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  SnapInsightsControllerActions | SnapInsightsControllerAllowedActions,\n  SnapInsightControllerEvents | SnapInsightsControllerAllowedEvents,\n  SnapInsightsControllerAllowedActions['type'],\n  SnapInsightsControllerAllowedEvents['type']\n>;\n\nexport type SnapInsight = {\n  snapId: SnapId;\n  interfaceId?: string | null;\n  error?: string;\n  loading: boolean;\n  severity?: string;\n};\n\nexport type SnapInsightsControllerState = {\n  insights: Record<string, Record<SnapId, SnapInsight>>;\n};\n\nexport type SnapInsightsControllerArgs = {\n  messenger: SnapInsightsControllerMessenger;\n  state?: SnapInsightsControllerState;\n};\n\ntype SnapWithPermission = {\n  snapId: SnapId;\n  permission: ValidPermission<string, Caveat<string, Json>>;\n};\n\n/**\n * Controller for monitoring for new transactions and signatures to provide insight for.\n */\nexport class SnapInsightsController extends BaseController<\n  typeof controllerName,\n  SnapInsightsControllerState,\n  SnapInsightsControllerMessenger\n> {\n  constructor({ messenger, state }: SnapInsightsControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        insights: { persist: false, anonymous: false },\n      },\n      name: controllerName,\n      state: { insights: {}, ...state },\n    });\n\n    this.messagingSystem.subscribe(\n      'TransactionController:unapprovedTransactionAdded',\n      this.#handleTransaction.bind(this),\n    );\n\n    this.messagingSystem.subscribe(\n      'TransactionController:transactionStatusUpdated',\n      this.#handleTransactionStatusUpdate.bind(this),\n    );\n\n    this.messagingSystem.subscribe(\n      'SignatureController:stateChange',\n      this.#handleSignatureStateChange.bind(this),\n    );\n  }\n\n  /**\n   * Check if an insight already exists for a given ID.\n   *\n   * @param id - The ID.\n   * @returns True if the insight already exists, otherwise false.\n   */\n  #hasInsight(id: string) {\n    return hasProperty(this.state.insights, id);\n  }\n\n  /**\n   * Get a list of runnable Snaps that have a given permission.\n   * Also includes the permission object itself.\n   *\n   * @param permissionName - The permission name.\n   * @returns A list of objects containing Snap IDs and the permission object.\n   */\n  #getSnapsWithPermission(permissionName: string) {\n    const allSnaps = this.messagingSystem.call('SnapController:getAll');\n    const filteredSnaps = getRunnableSnaps(allSnaps);\n\n    return filteredSnaps.reduce<SnapWithPermission[]>((accumulator, snap) => {\n      const permissions = this.messagingSystem.call(\n        'PermissionController:getPermissions',\n        snap.id,\n      );\n      if (permissions && hasProperty(permissions, permissionName)) {\n        accumulator.push({\n          snapId: snap.id,\n          permission: permissions[permissionName],\n        });\n      }\n\n      return accumulator;\n    }, []);\n  }\n\n  /**\n   * Handle a newly added unapproved transaction.\n   * This function fetches insights from all available Snaps\n   * and populates the insights state blob with the responses.\n   *\n   * @param transaction - The transaction object.\n   */\n  #handleTransaction(transaction: TransactionMeta) {\n    const { id, txParams, chainId, origin } = transaction;\n\n    // This assumes that the transactions are EVM-compatible for now.\n    const caipChainId = `eip155:${hexToBigInt(chainId).toString(10)}`;\n\n    const snaps = this.#getSnapsWithPermission(\n      SnapEndowments.TransactionInsight,\n    );\n\n    snaps.forEach(({ snapId, permission }) => {\n      const hasTransactionOriginCaveat = getTransactionOriginCaveat(permission);\n      const transactionOrigin =\n        hasTransactionOriginCaveat && origin ? origin : null;\n\n      this.update((state) => {\n        state.insights[id] ??= {};\n        state.insights[id][snapId] = { snapId, loading: true };\n      });\n\n      this.#handleSnapRequest({\n        snapId,\n        handler: HandlerType.OnTransaction,\n        params: {\n          transaction: txParams,\n          chainId: caipChainId,\n          transactionOrigin,\n        },\n      })\n        .then((response) =>\n          this.#handleSnapResponse({\n            id,\n            snapId,\n            response: response as Record<string, Json>,\n          }),\n        )\n        .catch((error) => this.#handleSnapResponse({ id, snapId, error }));\n    });\n  }\n\n  /**\n   * Handle the stateChange event emitted by the SignatureController.\n   * This function will remove existing insights from the state when applicable, as well as\n   * trigger insight fetching for newly added signatures.\n   *\n   * @param state - The SignatureController state blob.\n   */\n  #handleSignatureStateChange(state: SignatureControllerState) {\n    // If any IDs have disappeared since the last state update, the insight may be cleaned up.\n    for (const id of Object.keys(this.state.insights)) {\n      if (\n        !hasProperty(state.unapprovedTypedMessages, id) &&\n        !hasProperty(state.unapprovedPersonalMsgs, id)\n      ) {\n        this.#handleInsightCleanup(id);\n      }\n    }\n\n    if (\n      state.unapprovedPersonalMsgCount > 0 ||\n      state.unapprovedTypedMessagesCount > 0\n    ) {\n      const snaps = this.#getSnapsWithPermission(\n        SnapEndowments.SignatureInsight,\n      );\n\n      // This isn't very efficient, but SignatureController doesn't expose a better event for us to use yet.\n      for (const personalSignature of Object.values(\n        state.unapprovedPersonalMsgs,\n      )) {\n        this.#handleSignature(snaps, personalSignature);\n      }\n\n      for (const typedMessage of Object.values(state.unapprovedTypedMessages)) {\n        this.#handleSignature(snaps, typedMessage);\n      }\n    }\n  }\n\n  /**\n   * Handle a newly added unapproved signature.\n   * This function fetches insights from all available Snaps\n   * and populates the insights state blob with the responses.\n   *\n   * @param snaps - A list of Snaps to invoke.\n   * @param signature - The signature object.\n   */\n  #handleSignature(snaps: SnapWithPermission[], signature: StateSignature) {\n    const { id, msgParams } = signature;\n\n    if (this.#hasInsight(id)) {\n      return;\n    }\n\n    const { from, data, signatureMethod, origin } = msgParams;\n\n    /**\n     * Both eth_signTypedData_v3 and eth_signTypedData_v4 methods\n     * need to be parsed because their data is stringified. All other\n     * signature methods do not, so they are ignored.\n     */\n    const shouldParse =\n      signatureMethod === 'eth_signTypedData_v3' ||\n      signatureMethod === 'eth_signTypedData_v4';\n\n    const payload = {\n      from,\n      data: shouldParse ? JSON.parse(data as string) : data,\n      signatureMethod,\n    };\n\n    snaps.forEach(({ snapId, permission }) => {\n      const hasSignatureOriginCaveat = getSignatureOriginCaveat(permission);\n      const signatureOrigin =\n        origin && hasSignatureOriginCaveat ? origin : null;\n\n      this.update((state) => {\n        state.insights[id] ??= {};\n        state.insights[id][snapId] = { snapId, loading: true };\n      });\n\n      this.#handleSnapRequest({\n        snapId,\n        handler: HandlerType.OnSignature,\n        params: { signature: payload, signatureOrigin },\n      })\n        .then((response) =>\n          this.#handleSnapResponse({\n            id,\n            snapId,\n            response: response as Record<string, Json>,\n          }),\n        )\n        .catch((error) => this.#handleSnapResponse({ id, snapId, error }));\n    });\n  }\n\n  /**\n   * Handle the transactionStatusUpdated event emitted by the TransactionController.\n   * This function will remove insights for the transaction in question\n   * once the transaction status has changed from unapproved.\n   *\n   * @param args - An options bag.\n   * @param args.transactionMeta - The transaction.\n   */\n  #handleTransactionStatusUpdate({\n    transactionMeta,\n  }: {\n    transactionMeta: TransactionMeta;\n  }) {\n    if (transactionMeta.status !== 'unapproved') {\n      this.#handleInsightCleanup(transactionMeta.id);\n    }\n  }\n\n  #handleInsightCleanup(id: string) {\n    if (!this.#hasInsight(id)) {\n      return;\n    }\n\n    // Delete interfaces from interface controller.\n    Object.values(this.state.insights[id])\n      .filter((insight) => insight.interfaceId)\n      .forEach((insight) => {\n        this.messagingSystem.call(\n          'SnapInterfaceController:deleteInterface',\n          insight.interfaceId as string,\n        );\n      });\n\n    this.update((state) => {\n      delete state.insights[id];\n    });\n  }\n\n  /**\n   * Handle sending a request to a given Snap with a given payload.\n   *\n   * @param args - An options bag.\n   * @param args.snapId - The Snap ID.\n   * @param args.handler - The handler to invoke.\n   * @param args.params - The JSON-RPC params to send.\n   * @returns The response from the Snap.\n   */\n  async #handleSnapRequest({\n    snapId,\n    handler,\n    params,\n  }: {\n    snapId: SnapId;\n    handler: HandlerType.OnTransaction | HandlerType.OnSignature;\n    params: Record<string, Json>;\n  }) {\n    return this.messagingSystem.call('SnapController:handleRequest', {\n      snapId,\n      origin: 'metamask',\n      handler,\n      request: {\n        method: '',\n        params,\n      },\n    });\n  }\n\n  /**\n   * Handle response from a given Snap by persisting the response or error in state.\n   *\n   * @param args - An options bag.\n   * @param args.id - The transaction or signature ID.\n   * @param args.snapId - The Snap ID.\n   * @param args.response - An optional response object returned by the Snap.\n   * @param args.error - An optional error returned by the Snap.\n   */\n  #handleSnapResponse({\n    id,\n    snapId,\n    response,\n    error,\n  }: {\n    id: string;\n    snapId: SnapId;\n    response?: Record<string, Json>;\n    error?: Error;\n  }) {\n    // If the insight has been cleaned up already, we can skip setting the state.\n    // This may happen if a user accepts/rejects a transaction/signature faster than the Snap responds.\n    if (!this.#hasInsight(id)) {\n      return;\n    }\n\n    this.update((state) => {\n      state.insights[id][snapId].loading = false;\n      state.insights[id][snapId].interfaceId = response?.id as string;\n      state.insights[id][snapId].severity = response?.severity as string;\n      state.insights[id][snapId].error = error?.message;\n    });\n  }\n}\n"]}