@metamask/snaps-controllers 3.4.0 → 3.5.0

package/dist/esm/snaps/SnapController.js

@@ -61,12 +61,12 @@ function _define_property(obj, key, value) {
     }
     return obj;
 }
-import { BaseControllerV2 as BaseController } from '@metamask/base-controller';
+import { BaseController } from '@metamask/base-controller';
 import { SubjectType } from '@metamask/permission-controller';
 import { rpcErrors } from '@metamask/rpc-errors';
 import { WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-rpc-methods';
 import { AuxiliaryFileEncoding, getErrorMessage } from '@metamask/snaps-sdk';
-import { validateComponentLinks, assertIsSnapManifest, assertIsValidSnapId, DEFAULT_ENDOWMENTS, DEFAULT_REQUESTED_SNAP_VERSION, encodeAuxiliaryFile, HandlerType, isOriginAllowed, logError, normalizeRelative, OnTransactionResponseStruct, resolveVersionRange, SnapCaveatType, SnapStatus, SnapStatusEvents, validateFetchedSnap, unwrapError, OnHomePageResponseStruct, getValidatedLocalizationFiles } from '@metamask/snaps-utils';
+import { validateComponentLinks, assertIsSnapManifest, assertIsValidSnapId, DEFAULT_ENDOWMENTS, DEFAULT_REQUESTED_SNAP_VERSION, encodeAuxiliaryFile, HandlerType, isOriginAllowed, logError, normalizeRelative, OnTransactionResponseStruct, resolveVersionRange, SnapCaveatType, SnapStatus, SnapStatusEvents, validateFetchedSnap, unwrapError, OnHomePageResponseStruct, getValidatedLocalizationFiles, encodeBase64 } from '@metamask/snaps-utils';
 import { assert, assertIsJsonRpcRequest, assertStruct, Duration, gtRange, gtVersion, hasProperty, inMilliseconds, isNonEmptyArray, isValidSemVerRange, satisfiesVersionRange, timeSince } from '@metamask/utils';
 import { createMachine, interpret } from '@xstate/fsm';
 import { nanoid } from 'nanoid';
@@ -425,7 +425,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
    * @param path - The path to the requested file.
    * @param encoding - An optional requested file encoding.
    * @returns The file requested in the chosen file encoding or null if the file is not found.
-   */ getSnapFile(snapId, path, encoding = AuxiliaryFileEncoding.Base64) {
+   */ async getSnapFile(snapId, path, encoding = AuxiliaryFileEncoding.Base64) {
         const snap = this.getExpect(snapId);
         const normalizedPath = normalizeRelative(path);
         const value = snap.auxiliaryFiles?.find((file)=>file.path === normalizedPath)?.value;
@@ -1153,10 +1153,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         });
         _class_private_method_get(this, _initializeStateMachine, initializeStateMachine).call(this);
         _class_private_method_get(this, _registerMessageHandlers, registerMessageHandlers).call(this);
-        Object.values(state?.snaps ?? {}).forEach((snap)=>_class_private_method_get(this, _setupRuntime, setupRuntime).call(this, snap.id, {
-                sourceCode: snap.sourceCode,
-                state: state?.snapStates?.[snap.id] ?? null
-            }));
+        Object.values(state?.snaps ?? {}).forEach((snap)=>_class_private_method_get(this, _setupRuntime, setupRuntime).call(this, snap.id));
     }
 }
 function initializeStateMachine() {
@@ -1231,7 +1228,7 @@ function registerMessageHandlers() {
     this.messagingSystem.registerActionHandler(`${controllerName}:getRegistryMetadata`, async (...args)=>this.getRegistryMetadata(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:disconnectOrigin`, (...args)=>this.removeSnapFromSubject(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:revokeDynamicPermissions`, (...args)=>this.revokeDynamicSnapPermissions(...args));
-    this.messagingSystem.registerActionHandler(`${controllerName}:getFile`, (...args)=>this.getSnapFile(...args));
+    this.messagingSystem.registerActionHandler(`${controllerName}:getFile`, async (...args)=>this.getSnapFile(...args));
 }
 function pollForLastRequestStatus() {
     _class_private_field_set(this, _timeoutForLastRequestStatus, setTimeout(()=>{
@@ -1282,8 +1279,7 @@ async function stopSnapsLastRequestPastMax() {
     const entries = [
         ..._class_private_field_get(this, _snapsRuntimeData).entries()
     ];
-    return Promise.all(entries.filter(([_snapId, runtime])=>runtime.activeReferences === 0 && runtime.pendingInboundRequests.length === 0 && // lastRequest should always be set here but TypeScript wants this check
-        runtime.lastRequest && _class_private_field_get(this, _maxIdleTime) && timeSince(runtime.lastRequest) > _class_private_field_get(this, _maxIdleTime)).map(async ([snapId])=>this.stopSnap(snapId, SnapStatusEvents.Stop)));
+    return Promise.all(entries.filter(([_snapId, runtime])=>runtime.activeReferences === 0 && runtime.pendingInboundRequests.length === 0 && runtime.lastRequest && _class_private_field_get(this, _maxIdleTime) && timeSince(runtime.lastRequest) > _class_private_field_get(this, _maxIdleTime)).map(async ([snapId])=>this.stopSnap(snapId, SnapStatusEvents.Stop)));
 }
 function transition(snapId, event) {
     const { interpreter } = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
@@ -1346,10 +1342,7 @@ async function resolveAllowlistVersion(snapId, versionRange) {
 }
 async function add(args) {
     const { id: snapId, location, versionRange } = args;
-    _class_private_method_get(this, _setupRuntime, setupRuntime).call(this, snapId, {
-        sourceCode: null,
-        state: null
-    });
+    _class_private_method_get(this, _setupRuntime, setupRuntime).call(this, snapId);
     const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
     if (!runtime.installPromise) {
         log(`Adding snap: ${snapId}`);
@@ -1387,11 +1380,14 @@ async function startSnap(snapData) {
         throw new Error(`Snap "${snapId}" is already started.`);
     }
     try {
+        const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
         const result = await _class_private_method_get(this, _executeWithTimeout, executeWithTimeout).call(this, this.messagingSystem.call('ExecutionService:executeSnap', {
             ...snapData,
             endowments: await _class_private_method_get(this, _getEndowments, getEndowments).call(this, snapId)
         }));
         _class_private_method_get(this, _transition, transition).call(this, snapId, SnapStatusEvents.Start);
+        // We treat the initialization of the snap as the first request, for idle timing purposes.
+        runtime.lastRequest = Date.now();
         return result;
     } catch (error) {
         await _class_private_method_get(this, _terminateSnap, terminateSnap).call(this, snapId);
@@ -1433,10 +1429,13 @@ function set(args) {
     const { version } = manifest.result;
     const sourceCode = sourceCodeFile.toString();
     assert(typeof sourceCode === 'string' && sourceCode.length > 0, `Invalid source code for snap "${snapId}".`);
-    const auxiliaryFiles = rawAuxiliaryFiles.map((file)=>({
+    const auxiliaryFiles = rawAuxiliaryFiles.map((file)=>{
+        assert(typeof file.data.base64 === 'string');
+        return {
             path: file.path,
-            value: file.toString('base64')
-        }));
+            value: file.data.base64
+        };
+    });
     const snapsState = this.state.snaps;
     const existingSnap = snapsState[snapId];
     const previousVersionHistory = existingSnap?.versionHistory ?? [];
@@ -1492,6 +1491,11 @@ async function fetchSnap(snapId, location) {
         const { iconPath } = manifest.result.source.location.npm;
         const svgIcon = iconPath ? await location.fetch(iconPath) : undefined;
         const auxiliaryFiles = await getSnapFiles(location, manifest.result.source.files);
+        await Promise.all(auxiliaryFiles.map(async (file)=>{
+            // This should still be safe
+            // eslint-disable-next-line require-atomic-updates
+            file.data.base64 = await encodeBase64(file);
+        }));
         const localizationFiles = await getSnapFiles(location, manifest.result.source.locales);
         const validatedLocalizationFiles = getValidatedLocalizationFiles(localizationFiles);
         const files = {
@@ -1703,7 +1707,7 @@ function getRuntimeExpect(snapId) {
     assert(runtime !== undefined, new Error(`Snap "${snapId}" runtime data not found`));
     return runtime;
 }
-function setupRuntime(snapId, data) {
+function setupRuntime(snapId) {
     if (_class_private_field_get(this, _snapsRuntimeData).has(snapId)) {
         return;
     }
@@ -1723,8 +1727,7 @@ function setupRuntime(snapId, data) {
         activeReferences: 0,
         pendingInboundRequests: [],
         pendingOutboundRequests: 0,
-        interpreter,
-        ...data
+        interpreter
     });
 }
 function calculatePermissionsChange(snapId, desiredPermissionsSet) {