@metamask/snaps-controllers 11.1.0 → 11.2.1

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_initializeStateMachine, _SnapController_registerMessageHandlers, _SnapController_handlePreinstalledSnaps, _SnapController_pollForLastRequestStatus, _SnapController_blockSnap, _SnapController_unblockSnap, _SnapController_assertIsInstallAllowed, _SnapController_assertCanInstallSnaps, _SnapController_assertCanUsePlatform, _SnapController_stopSnapsLastRequestPastMax, _SnapController_transition, _SnapController_terminateSnap, _SnapController_getSnapEncryptionKey, _SnapController_hasCachedEncryptionKey, _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_transformSnapRpcRequestResult, _SnapController_transformOnAssetsLookupResult, _SnapController_transformOnAssetsConversionResult, _SnapController_assertSnapRpcRequestResult, _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_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_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_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");
@@ -130,6 +130,35 @@ class SnapController extends base_controller_1.BaseController {
         _SnapController_timeoutForLastRequestStatus.set(this, void 0);
         _SnapController_statusMachine.set(this, void 0);
         _SnapController_preinstalledSnaps.set(this, void 0);
+        /**
+         * Persist the state of a Snap.
+         *
+         * This function is debounced per Snap, meaning that multiple calls to this
+         * function for the same Snap will only result in one state update. It also
+         * uses a mutex to ensure that only one state update per Snap is processed at
+         * a time, avoiding possible race conditions.
+         *
+         * @param snapId - The Snap ID.
+         * @param newSnapState - The new state of the Snap.
+         * @param encrypted - A flag to indicate whether to use encrypted storage or
+         * not.
+         */
+        _SnapController_persistSnapState.set(this, (0, utils_2.debouncePersistState)((snapId, newSnapState, encrypted) => {
+            const runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId);
+            runtime.stateMutex
+                .runExclusive(async () => {
+                const newState = await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getStateToPersist).call(this, snapId, newSnapState, encrypted);
+                if (encrypted) {
+                    return this.update((state) => {
+                        state.snapStates[snapId] = newState;
+                    });
+                }
+                return this.update((state) => {
+                    state.unencryptedSnapStates[snapId] = newState;
+                });
+            })
+                .catch(snaps_utils_1.logError);
+        }, constants_1.STATE_DEBOUNCE_TIMEOUT));
         __classPrivateFieldSet(this, _SnapController_closeAllConnections, closeAllConnections, "f");
         __classPrivateFieldSet(this, _SnapController_dynamicPermissions, dynamicPermissions, "f");
         __classPrivateFieldSet(this, _SnapController_environmentEndowmentPermissions, environmentEndowmentPermissions, "f");
@@ -406,11 +435,7 @@ class SnapController extends base_controller_1.BaseController {
         else {
             runtime.unencryptedState = newSnapState;
         }
-        // This is intentionally run asynchronously to avoid blocking the main
-        // thread.
-        __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_persistSnapState).call(this, snapId, newSnapState, encrypted).catch((error) => {
-            (0, snaps_utils_1.logError)(error);
-        });
+        __classPrivateFieldGet(this, _SnapController_persistSnapState, "f").call(this, snapId, newSnapState, encrypted);
     }
     /**
      * Clears the state of the snap with the given id.
@@ -427,11 +452,7 @@ class SnapController extends base_controller_1.BaseController {
         else {
             runtime.unencryptedState = null;
         }
-        // This is intentionally run asynchronously to avoid blocking the main
-        // thread.
-        __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_persistSnapState).call(this, snapId, null, encrypted).catch((error) => {
-            (0, snaps_utils_1.logError)(error);
-        });
+        __classPrivateFieldGet(this, _SnapController_persistSnapState, "f").call(this, snapId, null, encrypted);
     }
     /**
      * Gets the own state of the snap with the given id.
@@ -1000,6 +1021,7 @@ class SnapController extends base_controller_1.BaseController {
      */
     async handleRequest({ snapId, origin, handler: handlerType, request: rawRequest, }) {
         __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_assertCanUsePlatform).call(this);
+        (0, utils_1.assert)(origin === 'metamask' || (0, snaps_utils_1.isValidUrl)(origin), "'origin' must be a valid URL or 'metamask'.");
         const request = {
             jsonrpc: '2.0',
             id: (0, nanoid_1.nanoid)(),
@@ -1038,7 +1060,7 @@ class SnapController extends base_controller_1.BaseController {
     }
 }
 exports.SnapController = SnapController;
-_SnapController_closeAllConnections = new WeakMap(), _SnapController_dynamicPermissions = new WeakMap(), _SnapController_environmentEndowmentPermissions = new WeakMap(), _SnapController_excludedPermissions = new WeakMap(), _SnapController_featureFlags = new WeakMap(), _SnapController_fetchFunction = new WeakMap(), _SnapController_idleTimeCheckInterval = new WeakMap(), _SnapController_maxIdleTime = new WeakMap(), _SnapController_encryptor = new WeakMap(), _SnapController_getMnemonicSeed = new WeakMap(), _SnapController_getFeatureFlags = new WeakMap(), _SnapController_clientCryptography = new WeakMap(), _SnapController_detectSnapLocation = new WeakMap(), _SnapController_snapsRuntimeData = new WeakMap(), _SnapController_rollbackSnapshots = new WeakMap(), _SnapController_timeoutForLastRequestStatus = new WeakMap(), _SnapController_statusMachine = new WeakMap(), _SnapController_preinstalledSnaps = new WeakMap(), _SnapController_instances = new WeakSet(), _SnapController_initializeStateMachine = function _SnapController_initializeStateMachine() {
+_SnapController_closeAllConnections = new WeakMap(), _SnapController_dynamicPermissions = new WeakMap(), _SnapController_environmentEndowmentPermissions = new WeakMap(), _SnapController_excludedPermissions = new WeakMap(), _SnapController_featureFlags = new WeakMap(), _SnapController_fetchFunction = new WeakMap(), _SnapController_idleTimeCheckInterval = new WeakMap(), _SnapController_maxIdleTime = new WeakMap(), _SnapController_encryptor = new WeakMap(), _SnapController_getMnemonicSeed = new WeakMap(), _SnapController_getFeatureFlags = new WeakMap(), _SnapController_clientCryptography = new WeakMap(), _SnapController_detectSnapLocation = new WeakMap(), _SnapController_snapsRuntimeData = new WeakMap(), _SnapController_rollbackSnapshots = new WeakMap(), _SnapController_timeoutForLastRequestStatus = new WeakMap(), _SnapController_statusMachine = new WeakMap(), _SnapController_preinstalledSnaps = new WeakMap(), _SnapController_persistSnapState = new WeakMap(), _SnapController_instances = new WeakSet(), _SnapController_initializeStateMachine = function _SnapController_initializeStateMachine() {
     const disableGuard = ({ snapId }) => {
         return this.getExpect(snapId).enabled;
     };
@@ -1271,6 +1293,8 @@ async function _SnapController_terminateSnap(snapId) {
     // Hack to give up execution for a bit to let timed out requests return.
     await new Promise((resolve) => setTimeout(resolve, 1));
     this.messagingSystem.publish('SnapController:snapTerminated', this.getTruncatedExpect(snapId));
+}, _SnapController_hasCachedEncryptionKey = function _SnapController_hasCachedEncryptionKey(snapId, runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId)) {
+    return runtime.encryptionKey !== null && runtime.encryptionSalt !== null;
 }, _SnapController_getSnapEncryptionKey = 
 /**
  * Generate an encryption key to be used for state encryption for a given Snap.
@@ -1284,7 +1308,7 @@ async function _SnapController_terminateSnap(snapId) {
  */
 async function _SnapController_getSnapEncryptionKey({ snapId, salt: passedSalt, useCache, keyMetadata, }) {
     const runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId);
-    if (runtime.encryptionKey && runtime.encryptionSalt && useCache) {
+    if (__classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_hasCachedEncryptionKey).call(this, snapId, runtime) && useCache) {
         return {
             key: await __classPrivateFieldGet(this, _SnapController_encryptor, "f").importKey(runtime.encryptionKey),
             salt: runtime.encryptionSalt,
@@ -1305,9 +1329,6 @@ async function _SnapController_getSnapEncryptionKey({ snapId, salt: passedSalt,
         runtime.encryptionSalt = salt;
     }
     return { key: encryptionKey, salt };
-}, _SnapController_hasCachedEncryptionKey = function _SnapController_hasCachedEncryptionKey(snapId) {
-    const runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId);
-    return runtime.encryptionKey !== null && runtime.encryptionSalt !== null;
 }, _SnapController_decryptSnapState = 
 /**
  * Decrypt the encrypted state for a given Snap.
@@ -1386,31 +1407,6 @@ async function _SnapController_getStateToPersist(snapId, state, encrypted) {
         return await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_encryptSnapState).call(this, snapId, state);
     }
     return JSON.stringify(state);
-}, _SnapController_persistSnapState = 
-/**
- * Persist the state of a Snap.
- *
- * This is run with a mutex to ensure that only one state update per Snap is
- * processed at a time, avoiding possible race conditions.
- *
- * @param snapId - The Snap ID.
- * @param newSnapState - The new state of the Snap.
- * @param encrypted - A flag to indicate whether to use encrypted storage or
- * not.
- */
-async function _SnapController_persistSnapState(snapId, newSnapState, encrypted) {
-    const runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId);
-    await runtime.stateMutex.runExclusive(async () => {
-        const newState = await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getStateToPersist).call(this, snapId, newSnapState, encrypted);
-        if (encrypted) {
-            return this.update((state) => {
-                state.snapStates[snapId] = newState;
-            });
-        }
-        return this.update((state) => {
-            state.unencryptedSnapStates[snapId] = newState;
-        });
-    });
 }, _SnapController_handleInitialConnections = function _SnapController_handleInitialConnections(snapId, previousInitialConnections, initialConnections) {
     if (previousInitialConnections) {
         const revokedInitialConnections = (0, utils_2.setDiff)(previousInitialConnections, initialConnections);
@@ -1726,23 +1722,24 @@ async function _SnapController_getEndowments(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, request.id, timer);
-        const handleRpcRequestPromise = this.messagingSystem.call('ExecutionService:handleRpcRequest', snapId, { origin, handler: handlerType, request });
+        __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_assertSnapRpcRequestResult).call(this, snapId, handlerType, result);
-            const transformedResult = await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformSnapRpcRequestResult).call(this, snapId, handlerType, request, result);
-            __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_recordSnapRpcRequestFinish).call(this, snapId, request.id);
+            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);
             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, request.id);
+            __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_recordSnapRpcRequestFinish).call(this, snapId, transformedRequest.id);
             const [jsonRpcError, handled] = (0, snaps_utils_1.unwrapError)(error);
             if (!handled) {
                 await this.stopSnap(snapId, snaps_utils_1.SnapStatusEvents.Crash);
@@ -1766,17 +1763,17 @@ async function _SnapController_createInterface(snapId, content, contentType) {
 }, _SnapController_assertInterfaceExists = function _SnapController_assertInterfaceExists(snapId, id) {
     // This will throw if the interface isn't accessible, but we assert nevertheless.
     (0, utils_1.assert)(this.messagingSystem.call('SnapInterfaceController:getInterface', snapId, id));
-}, _SnapController_transformSnapRpcRequestResult = 
+}, _SnapController_transformSnapRpcResponse = 
 /**
- * Transform a RPC request result if necessary.
+ * Transform a RPC response if necessary.
  *
  * @param snapId - The snap ID of the snap that produced the result.
  * @param handlerType - The handler type that produced the result.
  * @param request - The request that returned the result.
- * @param result - The result.
+ * @param result - The response.
  * @returns The transformed result if applicable, otherwise the original result.
  */
-async function _SnapController_transformSnapRpcRequestResult(snapId, handlerType, request, result) {
+async function _SnapController_transformSnapRpcResponse(snapId, handlerType, request, result) {
     switch (handlerType) {
         case snaps_utils_1.HandlerType.OnTransaction:
         case snaps_utils_1.HandlerType.OnSignature:
@@ -1833,7 +1830,22 @@ async function _SnapController_transformSnapRpcRequestResult(snapId, handlerType
         return accumulator;
     }, {});
     return { conversionRates: filteredConversionRates };
-}, _SnapController_assertSnapRpcRequestResult = 
+}, _SnapController_transformSnapRpcRequest = function _SnapController_transformSnapRpcRequest(snapId, handlerType, request) {
+    switch (handlerType) {
+        // For onUserInput we inject context, so the client doesn't have to worry about keeping it in sync.
+        case snaps_utils_1.HandlerType.OnUserInput: {
+            (0, utils_1.assert)(request.params && (0, utils_1.hasProperty)(request.params, 'id'));
+            const interfaceId = request.params.id;
+            const { context } = this.messagingSystem.call('SnapInterfaceController:getInterface', snapId, interfaceId);
+            return {
+                ...request,
+                params: { ...request.params, context },
+            };
+        }
+        default:
+            return request;
+    }
+}, _SnapController_assertSnapRpcResponse = 
 /**
  * Assert that the returned result of a Snap RPC call is the expected shape.
  *
@@ -1841,7 +1853,7 @@ async function _SnapController_transformSnapRpcRequestResult(snapId, handlerType
  * @param handlerType - The handler type of the RPC Request.
  * @param result - The result of the RPC request.
  */
-async function _SnapController_assertSnapRpcRequestResult(snapId, handlerType, result) {
+async function _SnapController_assertSnapRpcResponse(snapId, handlerType, result) {
     switch (handlerType) {
         case snaps_utils_1.HandlerType.OnTransaction: {
             (0, utils_1.assertStruct)(result, snaps_utils_1.OnTransactionResponseStruct);
@@ -1878,7 +1890,10 @@ async function _SnapController_assertSnapRpcRequestResult(snapId, handlerType, r
             (0, utils_1.assertStruct)(result, snaps_sdk_1.OnAssetsLookupResponseStruct);
             break;
         case snaps_utils_1.HandlerType.OnAssetsConversion:
-            (0, utils_1.assertStruct)(result, snaps_sdk_1.OnAssetsConversionResponseStruct);
+            (0, utils_1.assertStruct)(result, snaps_utils_1.OnAssetsConversionResponseStruct);
+            break;
+        case snaps_utils_1.HandlerType.OnAssetHistoricalPrice:
+            (0, utils_1.assertStruct)(result, snaps_utils_1.OnAssetHistoricalPriceResponseStruct);
             break;
         default:
             break;