@metamask/snaps-controllers 12.1.0 → 12.3.0

package/dist/snaps/SnapController.cjs

@@ -10,7 +10,7 @@ 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 _SnapController_instances, _SnapController_closeAllConnections, _SnapController_dynamicPermissions, _SnapController_environmentEndowmentPermissions, _SnapController_excludedPermissions, _SnapController_featureFlags, _SnapController_fetchFunction, _SnapController_idleTimeCheckInterval, _SnapController_maxIdleTime, _SnapController_encryptor, _SnapController_getMnemonicSeed, _SnapController_getFeatureFlags, _SnapController_clientCryptography, _SnapController_detectSnapLocation, _SnapController_snapsRuntimeData, _SnapController_rollbackSnapshots, _SnapController_timeoutForLastRequestStatus, _SnapController_statusMachine, _SnapController_preinstalledSnaps, _SnapController_trackEvent, _SnapController_trackSnapExport, _SnapController_initializeStateMachine, _SnapController_registerMessageHandlers, _SnapController_handlePreinstalledSnaps, _SnapController_pollForLastRequestStatus, _SnapController_blockSnap, _SnapController_unblockSnap, _SnapController_assertIsInstallAllowed, _SnapController_assertCanInstallSnaps, _SnapController_assertCanUsePlatform, _SnapController_stopSnapsLastRequestPastMax, _SnapController_transition, _SnapController_terminateSnap, _SnapController_hasCachedEncryptionKey, _SnapController_getSnapEncryptionKey, _SnapController_decryptSnapState, _SnapController_encryptSnapState, _SnapController_getStateToPersist, _SnapController_persistSnapState, _SnapController_handleInitialConnections, _SnapController_addSnapToSubject, _SnapController_removeSnapFromSubjects, _SnapController_revokeAllSnapPermissions, _SnapController_createApproval, _SnapController_updateApproval, _SnapController_resolveAllowlistVersion, _SnapController_add, _SnapController_startSnap, _SnapController_getEndowments, _SnapController_set, _SnapController_validateSnapPermissions, _SnapController_validatePlatformVersion, _SnapController_getExecutionTimeout, _SnapController_getRpcRequestHandler, _SnapController_createInterface, _SnapController_assertInterfaceExists, _SnapController_transformSnapRpcResponse, _SnapController_transformOnAssetsLookupResult, _SnapController_transformOnAssetsConversionResult, _SnapController_transformSnapRpcRequest, _SnapController_assertSnapRpcResponse, _SnapController_recordSnapRpcRequestStart, _SnapController_recordSnapRpcRequestFinish, _SnapController_getRollbackSnapshot, _SnapController_createRollbackSnapshot, _SnapController_rollbackSnap, _SnapController_rollbackSnaps, _SnapController_getRuntime, _SnapController_getRuntimeExpect, _SnapController_setupRuntime, _SnapController_calculatePermissionsChange, _SnapController_isSubjectConnectedToSnap, _SnapController_calculateConnectionsChange, _SnapController_getPermissionsToGrant, _SnapController_updatePermissions, _SnapController_isValidUpdate, _SnapController_callLifecycleHook, _SnapController_handleLock;
+var _SnapController_instances, _SnapController_closeAllConnections, _SnapController_dynamicPermissions, _SnapController_environmentEndowmentPermissions, _SnapController_excludedPermissions, _SnapController_featureFlags, _SnapController_fetchFunction, _SnapController_idleTimeCheckInterval, _SnapController_maxIdleTime, _SnapController_encryptor, _SnapController_getMnemonicSeed, _SnapController_getFeatureFlags, _SnapController_clientCryptography, _SnapController_detectSnapLocation, _SnapController_snapsRuntimeData, _SnapController_rollbackSnapshots, _SnapController_timeoutForLastRequestStatus, _SnapController_statusMachine, _SnapController_preinstalledSnaps, _SnapController_trackEvent, _SnapController_trackSnapExport, _SnapController_initializeStateMachine, _SnapController_registerMessageHandlers, _SnapController_handlePreinstalledSnaps, _SnapController_pollForLastRequestStatus, _SnapController_blockSnap, _SnapController_unblockSnap, _SnapController_assertIsInstallAllowed, _SnapController_assertCanInstallSnaps, _SnapController_assertCanUsePlatform, _SnapController_stopSnapsLastRequestPastMax, _SnapController_transition, _SnapController_terminateSnap, _SnapController_hasCachedEncryptionKey, _SnapController_getSnapEncryptionKey, _SnapController_decryptSnapState, _SnapController_encryptSnapState, _SnapController_getStateToPersist, _SnapController_persistSnapState, _SnapController_handleInitialConnections, _SnapController_addSnapToSubject, _SnapController_removeSnapFromSubjects, _SnapController_revokeAllSnapPermissions, _SnapController_createApproval, _SnapController_updateApproval, _SnapController_resolveAllowlistVersion, _SnapController_add, _SnapController_startSnap, _SnapController_getEndowments, _SnapController_set, _SnapController_validateSnapPermissions, _SnapController_validatePlatformVersion, _SnapController_getExecutionTimeout, _SnapController_createInterface, _SnapController_assertInterfaceExists, _SnapController_transformSnapRpcResponse, _SnapController_transformOnAssetsLookupResult, _SnapController_transformOnAssetsConversionResult, _SnapController_transformSnapRpcRequest, _SnapController_assertSnapRpcResponse, _SnapController_recordSnapRpcRequestStart, _SnapController_recordSnapRpcRequestFinish, _SnapController_getRollbackSnapshot, _SnapController_createRollbackSnapshot, _SnapController_rollbackSnap, _SnapController_rollbackSnaps, _SnapController_getRuntime, _SnapController_getRuntimeExpect, _SnapController_setupRuntime, _SnapController_calculatePermissionsChange, _SnapController_isSubjectConnectedToSnap, _SnapController_calculateConnectionsChange, _SnapController_getPermissionsToGrant, _SnapController_updatePermissions, _SnapController_isValidUpdate, _SnapController_callLifecycleHook, _SnapController_handleLock;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SnapController = exports.SNAP_APPROVAL_RESULT = exports.SNAP_APPROVAL_UPDATE = exports.SNAP_APPROVAL_INSTALL = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -27,7 +27,6 @@ const semver_1 = require("semver");
 const constants_1 = require("./constants.cjs");
 const location_1 = require("./location/index.cjs");
 const registry_1 = require("./registry/index.cjs");
-const RequestQueue_1 = require("./RequestQueue.cjs");
 const selectors_1 = require("./selectors.cjs");
 const Timer_1 = require("./Timer.cjs");
 const fsm_2 = require("../fsm.cjs");
@@ -526,6 +525,22 @@ class SnapController extends base_controller_1.BaseController {
         (0, utils_1.assert)(encoded.length < snaps_utils_1.MAX_FILE_SIZE, `Failed to encode static file to "${encoding}": Static files must be less than 64 MB when encoded.`);
         return encoded;
     }
+    /**
+     * Determine if a given Snap ID supports a given minimum version of the Snaps platform
+     * by inspecting the platformVersion in the Snap manifest.
+     *
+     * @param snapId - The Snap ID.
+     * @param version - The version.
+     * @returns True if the platform version is equal or greater to the passed version, false otherwise.
+     */
+    isMinimumPlatformVersion(snapId, version) {
+        const snap = this.getExpect(snapId);
+        const { platformVersion } = snap.manifest;
+        if (!platformVersion) {
+            return false;
+        }
+        return (0, semver_1.gte)(platformVersion, version);
+    }
     /**
      * Completely clear the controller's state: delete all associated data,
      * handlers, event listeners, and permissions; tear down all snap providers.
@@ -1065,12 +1080,49 @@ class SnapController extends base_controller_1.BaseController {
             constants_1.CLIENT_ONLY_HANDLERS.includes(handlerType)) {
             throw new Error(`"${handlerType}" can only be invoked by MetaMask.`);
         }
-        const handler = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRpcRequestHandler).call(this, snapId);
-        if (!handler) {
-            throw new Error(`Snap RPC message handler not found for snap "${snapId}".`);
+        if (!this.state.snaps[snapId].enabled) {
+            throw new Error(`Snap "${snapId}" is disabled.`);
+        }
+        if (this.state.snaps[snapId].status === snaps_utils_1.SnapStatus.Installing) {
+            throw new Error(`Snap "${snapId}" is currently being installed. Please try again later.`);
         }
         const timeout = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getExecutionTimeout).call(this, handlerPermissions);
-        return handler({ origin, handler: handlerType, request, timeout });
+        if (!this.isRunning(snapId)) {
+            const runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId);
+            if (!runtime.startPromise) {
+                runtime.startPromise = this.startSnap(snapId);
+            }
+            try {
+                await runtime.startPromise;
+            }
+            finally {
+                runtime.startPromise = null;
+            }
+        }
+        const transformedRequest = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformSnapRpcRequest).call(this, snapId, handlerType, request);
+        const timer = new Timer_1.Timer(timeout);
+        __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_recordSnapRpcRequestStart).call(this, snapId, transformedRequest.id, timer);
+        const handleRpcRequestPromise = this.messagingSystem.call('ExecutionService:handleRpcRequest', snapId, { origin, handler: handlerType, request: transformedRequest });
+        // This will either get the result or reject due to the timeout.
+        try {
+            const result = await (0, utils_2.withTimeout)(handleRpcRequestPromise, timer);
+            if (result === utils_2.hasTimedOut) {
+                throw new Error(`${snapId} failed to respond to the request in time.`);
+            }
+            await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_assertSnapRpcResponse).call(this, snapId, handlerType, result);
+            const transformedResult = await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformSnapRpcResponse).call(this, snapId, handlerType, transformedRequest, result);
+            __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_recordSnapRpcRequestFinish).call(this, snapId, transformedRequest.id, handlerType, origin, true);
+            return transformedResult;
+        }
+        catch (error) {
+            // We flag the RPC request as finished early since termination may affect pending requests
+            __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_recordSnapRpcRequestFinish).call(this, snapId, transformedRequest.id, handlerType, origin, false);
+            const [jsonRpcError, handled] = (0, snaps_utils_1.unwrapError)(error);
+            if (!handled) {
+                await this.stopSnap(snapId, snaps_utils_1.SnapStatusEvents.Crash);
+            }
+            throw jsonRpcError;
+        }
     }
 }
 exports.SnapController = SnapController;
@@ -1147,6 +1199,7 @@ _SnapController_closeAllConnections = new WeakMap(), _SnapController_dynamicPerm
     this.messagingSystem.registerActionHandler(`${exports.controllerName}:revokeDynamicPermissions`, (...args) => this.revokeDynamicSnapPermissions(...args));
     this.messagingSystem.registerActionHandler(`${exports.controllerName}:getFile`, async (...args) => this.getSnapFile(...args));
     this.messagingSystem.registerActionHandler(`${exports.controllerName}:stopAllSnaps`, async (...args) => this.stopAllSnaps(...args));
+    this.messagingSystem.registerActionHandler(`${exports.controllerName}:isMinimumPlatformVersion`, (...args) => this.isMinimumPlatformVersion(...args));
 }, _SnapController_handlePreinstalledSnaps = function _SnapController_handlePreinstalledSnaps(preinstalledSnaps) {
     for (const { snapId, manifest, files, removable, hidden, hideSnapBranding, } of preinstalledSnaps) {
         const existingSnap = this.get(snapId);
@@ -1697,71 +1750,6 @@ async function _SnapController_getEndowments(snapId) {
     }
 }, _SnapController_getExecutionTimeout = function _SnapController_getExecutionTimeout(permission) {
     return (0, snaps_rpc_methods_1.getMaxRequestTimeCaveat)(permission) ?? this.maxRequestTime;
-}, _SnapController_getRpcRequestHandler = function _SnapController_getRpcRequestHandler(snapId) {
-    const runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId);
-    const existingHandler = runtime.rpcHandler;
-    if (existingHandler) {
-        return existingHandler;
-    }
-    const requestQueue = new RequestQueue_1.RequestQueue(100);
-    // We need to set up this promise map to map snapIds to their respective startPromises,
-    // because otherwise we would lose context on the correct startPromise.
-    const startPromises = new Map();
-    const rpcHandler = async ({ origin, handler: handlerType, request, timeout, }) => {
-        if (!this.state.snaps[snapId].enabled) {
-            throw new Error(`Snap "${snapId}" is disabled.`);
-        }
-        if (this.state.snaps[snapId].status === snaps_utils_1.SnapStatus.Installing) {
-            throw new Error(`Snap "${snapId}" is currently being installed. Please try again later.`);
-        }
-        if (!this.isRunning(snapId)) {
-            let localStartPromise = startPromises.get(snapId);
-            if (!localStartPromise) {
-                localStartPromise = this.startSnap(snapId);
-                startPromises.set(snapId, localStartPromise);
-            }
-            else if (requestQueue.get(origin) >= requestQueue.maxQueueSize) {
-                throw new Error('Exceeds maximum number of requests waiting to be resolved, please try again.');
-            }
-            requestQueue.increment(origin);
-            try {
-                await localStartPromise;
-            }
-            finally {
-                requestQueue.decrement(origin);
-                // Only delete startPromise for a snap if its value hasn't changed
-                if (startPromises.get(snapId) === localStartPromise) {
-                    startPromises.delete(snapId);
-                }
-            }
-        }
-        const transformedRequest = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformSnapRpcRequest).call(this, snapId, handlerType, request);
-        const timer = new Timer_1.Timer(timeout);
-        __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_recordSnapRpcRequestStart).call(this, snapId, transformedRequest.id, timer);
-        const handleRpcRequestPromise = this.messagingSystem.call('ExecutionService:handleRpcRequest', snapId, { origin, handler: handlerType, request: transformedRequest });
-        // This will either get the result or reject due to the timeout.
-        try {
-            const result = await (0, utils_2.withTimeout)(handleRpcRequestPromise, timer);
-            if (result === utils_2.hasTimedOut) {
-                throw new Error(`${snapId} failed to respond to the request in time.`);
-            }
-            await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_assertSnapRpcResponse).call(this, snapId, handlerType, result);
-            const transformedResult = await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformSnapRpcResponse).call(this, snapId, handlerType, transformedRequest, result);
-            __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_recordSnapRpcRequestFinish).call(this, snapId, transformedRequest.id, handlerType, origin, true);
-            return transformedResult;
-        }
-        catch (error) {
-            // We flag the RPC request as finished early since termination may affect pending requests
-            __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_recordSnapRpcRequestFinish).call(this, snapId, transformedRequest.id, handlerType, origin, false);
-            const [jsonRpcError, handled] = (0, snaps_utils_1.unwrapError)(error);
-            if (!handled) {
-                await this.stopSnap(snapId, snaps_utils_1.SnapStatusEvents.Crash);
-            }
-            throw jsonRpcError;
-        }
-    };
-    runtime.rpcHandler = rpcHandler;
-    return rpcHandler;
 }, _SnapController_createInterface = 
 /**
  * Create a dynamic interface in the SnapInterfaceController.
@@ -2015,7 +2003,7 @@ async function _SnapController_rollbackSnaps(snapIds) {
     (0, fsm_2.forceStrict)(interpreter);
     __classPrivateFieldGet(this, _SnapController_snapsRuntimeData, "f").set(snapId, {
         lastRequest: null,
-        rpcHandler: null,
+        startPromise: null,
         installPromise: null,
         encryptionKey: null,
         encryptionSalt: null,