@metamask/snaps-controllers 9.16.0 → 9.18.0

package/dist/snaps/SnapController.cjs

@@ -13,7 +13,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _SnapController_instances, _SnapController_closeAllConnections, _SnapController_dynamicPermissions, _SnapController_environmentEndowmentPermissions, _SnapController_excludedPermissions, _SnapController_featureFlags, _SnapController_fetchFunction, _SnapController_idleTimeCheckInterval, _SnapController_maxIdleTime, _SnapController_encryptor, _SnapController_getMnemonic, _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_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_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;
+var _SnapController_instances, _SnapController_closeAllConnections, _SnapController_dynamicPermissions, _SnapController_environmentEndowmentPermissions, _SnapController_excludedPermissions, _SnapController_featureFlags, _SnapController_fetchFunction, _SnapController_idleTimeCheckInterval, _SnapController_maxIdleTime, _SnapController_encryptor, _SnapController_getMnemonic, _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;
 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");
@@ -24,6 +24,7 @@ const snaps_sdk_1 = require("@metamask/snaps-sdk");
 const snaps_utils_1 = require("@metamask/snaps-utils");
 const utils_1 = require("@metamask/utils");
 const fsm_1 = require("@xstate/fsm");
+const async_mutex_1 = require("async-mutex");
 const nanoid_1 = require("nanoid");
 const semver_1 = __importDefault(require("semver"));
 const fsm_2 = require("../fsm.cjs");
@@ -169,6 +170,7 @@ class SnapController extends base_controller_1.BaseController {
                 (0, snaps_utils_1.logError)(`Error when calling \`onUpdate\` lifecycle hook for snap "${id}": ${(0, snaps_sdk_1.getErrorMessage)(error)}`);
             });
         });
+        this.messagingSystem.subscribe('KeyringController:lock', __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_handleLock).bind(this));
         __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_initializeStateMachine).call(this);
         __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_registerMessageHandlers).call(this);
         if (__classPrivateFieldGet(this, _SnapController_preinstalledSnaps, "f")) {
@@ -398,17 +400,18 @@ class SnapController extends base_controller_1.BaseController {
      * @param encrypted - A flag to indicate whether to use encrypted storage or not.
      */
     async updateSnapState(snapId, newSnapState, encrypted) {
+        const runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId);
         if (encrypted) {
-            const encryptedState = await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_encryptSnapState).call(this, snapId, newSnapState);
-            this.update((state) => {
-                state.snapStates[snapId] = encryptedState;
-            });
+            runtime.state = newSnapState;
         }
         else {
-            this.update((state) => {
-                state.unencryptedSnapStates[snapId] = JSON.stringify(newSnapState);
-            });
+            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);
+        });
     }
     /**
      * Clears the state of the snap with the given id.
@@ -418,13 +421,17 @@ class SnapController extends base_controller_1.BaseController {
      * @param encrypted - A flag to indicate whether to use encrypted storage or not.
      */
     clearSnapState(snapId, encrypted) {
-        this.update((state) => {
-            if (encrypted) {
-                state.snapStates[snapId] = null;
-            }
-            else {
-                state.unencryptedSnapStates[snapId] = null;
-            }
+        const runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId);
+        if (encrypted) {
+            runtime.state = null;
+        }
+        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);
         });
     }
     /**
@@ -436,6 +443,11 @@ class SnapController extends base_controller_1.BaseController {
      * @returns The requested snap state or null if no state exists.
      */
     async getSnapState(snapId, encrypted) {
+        const runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId);
+        const cachedState = encrypted ? runtime.state : runtime.unencryptedState;
+        if (cachedState !== undefined) {
+            return cachedState;
+        }
         const state = encrypted
             ? this.state.snapStates[snapId]
             : this.state.unencryptedSnapStates[snapId];
@@ -443,10 +455,14 @@ class SnapController extends base_controller_1.BaseController {
             return null;
         }
         if (!encrypted) {
-            // For performance reasons, we do not validate that the state is JSON, since we control serialization.
-            return JSON.parse(state);
+            // For performance reasons, we do not validate that the state is JSON,
+            // since we control serialization.
+            const json = JSON.parse(state);
+            runtime.unencryptedState = json;
+            return json;
         }
         const decrypted = await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_decryptSnapState).call(this, snapId, state);
+        runtime.state = decrypted;
         return decrypted;
     }
     /**
@@ -1331,6 +1347,55 @@ async function _SnapController_encryptSnapState(snapId, state) {
     const encryptedState = await __classPrivateFieldGet(this, _SnapController_encryptor, "f").encryptWithKey(key, state);
     encryptedState.salt = salt;
     return JSON.stringify(encryptedState);
+}, _SnapController_getStateToPersist = 
+/**
+ * Get the new Snap state to persist based on the given state and encryption
+ * flag.
+ *
+ * - If the state is null, return null.
+ * - If the state should be encrypted, return the encrypted state.
+ * - Otherwise, if the state should not be encrypted, return the JSON-
+ * stringified state.
+ *
+ * @param snapId - The Snap ID.
+ * @param state - The state to persist.
+ * @param encrypted - A flag to indicate whether to use encrypted storage or
+ * not.
+ * @returns The state to persist.
+ */
+async function _SnapController_getStateToPersist(snapId, state, encrypted) {
+    if (state === null) {
+        return null;
+    }
+    if (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);
@@ -1658,7 +1723,7 @@ async function _SnapController_getEndowments(snapId) {
                 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, 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);
             return transformedResult;
         }
@@ -1694,10 +1759,11 @@ async function _SnapController_createInterface(snapId, content, contentType) {
  *
  * @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.
  * @returns The transformed result if applicable, otherwise the original result.
  */
-async function _SnapController_transformSnapRpcRequestResult(snapId, handlerType, result) {
+async function _SnapController_transformSnapRpcRequestResult(snapId, handlerType, request, result) {
     switch (handlerType) {
         case snaps_utils_1.HandlerType.OnTransaction:
         case snaps_utils_1.HandlerType.OnSignature:
@@ -1713,9 +1779,47 @@ async function _SnapController_transformSnapRpcRequestResult(snapId, handlerType
             }
             return result;
         }
+        case snaps_utils_1.HandlerType.OnAssetsLookup:
+            // We can cast since the request and result have already been validated.
+            return __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformOnAssetsLookupResult).call(this, snapId, request, result);
+        case snaps_utils_1.HandlerType.OnAssetsConversion:
+            // We can cast since the request and result have already been validated.
+            return __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_transformOnAssetsConversionResult).call(this, request, result);
         default:
             return result;
     }
+}, _SnapController_transformOnAssetsLookupResult = function _SnapController_transformOnAssetsLookupResult(snapId, { params: requestedParams }, { assets }) {
+    const permissions = this.messagingSystem.call('PermissionController:getPermissions', snapId);
+    // We know the permissions are guaranteed to be set here.
+    (0, utils_1.assert)(permissions);
+    const permission = permissions[snaps_rpc_methods_1.SnapEndowments.Assets];
+    const scopes = (0, snaps_rpc_methods_1.getChainIdsCaveat)(permission);
+    (0, utils_1.assert)(scopes);
+    const { assets: requestedAssets } = requestedParams;
+    const filteredAssets = Object.keys(assets).reduce((accumulator, assetType) => {
+        const castAssetType = assetType;
+        const isValid = scopes.some((scope) => castAssetType.startsWith(scope)) &&
+            requestedAssets.includes(castAssetType);
+        // Filter out unrequested assets and assets for scopes the Snap hasn't registered for.
+        if (isValid) {
+            accumulator[castAssetType] = assets[castAssetType];
+        }
+        return accumulator;
+    }, {});
+    return { assets: filteredAssets };
+}, _SnapController_transformOnAssetsConversionResult = function _SnapController_transformOnAssetsConversionResult({ params: requestedParams }, { conversionRates }) {
+    const { conversions: requestedConversions } = requestedParams;
+    const filteredConversionRates = requestedConversions.reduce((accumulator, conversion) => {
+        var _a;
+        const rate = conversionRates[conversion.from]?.[conversion.to];
+        // Only include rates that were actually requested.
+        if (rate) {
+            accumulator[_a = conversion.from] ?? (accumulator[_a] = {});
+            accumulator[conversion.from][conversion.to] = rate;
+        }
+        return accumulator;
+    }, {});
+    return { conversionRates: filteredConversionRates };
 }, _SnapController_assertSnapRpcRequestResult = 
 /**
  * Assert that the returned result of a Snap RPC call is the expected shape.
@@ -1757,6 +1861,12 @@ async function _SnapController_assertSnapRpcRequestResult(snapId, handlerType, r
         case snaps_utils_1.HandlerType.OnNameLookup:
             (0, utils_1.assertStruct)(result, snaps_utils_1.OnNameLookupResponseStruct);
             break;
+        case snaps_utils_1.HandlerType.OnAssetsLookup:
+            (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);
+            break;
         default:
             break;
     }
@@ -1864,6 +1974,7 @@ async function _SnapController_rollbackSnaps(snapIds) {
         pendingOutboundRequests: 0,
         interpreter,
         stopping: false,
+        stateMutex: new async_mutex_1.Mutex(),
     });
 }, _SnapController_calculatePermissionsChange = function _SnapController_calculatePermissionsChange(snapId, desiredPermissionsSet) {
     const oldPermissions = this.messagingSystem.call('PermissionController:getPermissions', snapId) ?? {};
@@ -1945,5 +2056,11 @@ async function _SnapController_callLifecycleHook(origin, snapId, handler) {
             method: handler,
         },
     });
+}, _SnapController_handleLock = function _SnapController_handleLock() {
+    for (const runtime of __classPrivateFieldGet(this, _SnapController_snapsRuntimeData, "f").values()) {
+        runtime.encryptionKey = null;
+        runtime.encryptionSalt = null;
+        runtime.state = undefined;
+    }
 };
 //# sourceMappingURL=SnapController.cjs.map