@metamask/snaps-controllers 14.2.2 → 15.0.1

package/dist/snaps/SnapController.mjs

@@ -1,10 +1,11 @@
+import { ORIGIN_METAMASK } from "@metamask/approval-controller";
 import { BaseController } from "@metamask/base-controller";
 import { SubjectType } from "@metamask/permission-controller";
 import { rpcErrors } from "@metamask/rpc-errors";
 import { WALLET_SNAP_PERMISSION_KEY, getMaxRequestTimeCaveat, handlerEndowments, SnapEndowments, getKeyringCaveatOrigins, getRpcCaveatOrigins, processSnapPermissions, getEncryptionEntropy, getChainIdsCaveat } from "@metamask/snaps-rpc-methods";
 import { AuxiliaryFileEncoding, getErrorMessage, OnAssetsLookupResponseStruct } from "@metamask/snaps-sdk";
-import { logWarning, getPlatformVersion, assertIsSnapManifest, assertIsValidSnapId, DEFAULT_ENDOWMENTS, DEFAULT_REQUESTED_SNAP_VERSION, encodeAuxiliaryFile, HandlerType, isOriginAllowed, logError, normalizeRelative, OnTransactionResponseStruct, OnSignatureResponseStruct, resolveVersionRange, SnapCaveatType, SnapStatus, SnapStatusEvents, unwrapError, OnHomePageResponseStruct, getValidatedLocalizationFiles, VirtualFile, NpmSnapFileNames, OnNameLookupResponseStruct, getLocalizedSnapManifest, MAX_FILE_SIZE, OnSettingsPageResponseStruct, isValidUrl, OnAssetHistoricalPriceResponseStruct, OnAssetsConversionResponseStruct, OnAssetsMarketDataResponseStruct } from "@metamask/snaps-utils";
-import { hexToNumber, assert, assertIsJsonRpcRequest, assertStruct, Duration, gtRange, gtVersion, hasProperty, inMilliseconds, isNonEmptyArray, isValidSemVerRange, satisfiesVersionRange, timeSince, createDeferredPromise } from "@metamask/utils";
+import { logWarning, getPlatformVersion, assertIsSnapManifest, assertIsValidSnapId, DEFAULT_ENDOWMENTS, encodeAuxiliaryFile, HandlerType, isOriginAllowed, logError, normalizeRelative, OnTransactionResponseStruct, OnSignatureResponseStruct, resolveVersionRange, SnapCaveatType, SnapStatus, SnapStatusEvents, unwrapError, OnHomePageResponseStruct, getValidatedLocalizationFiles, VirtualFile, NpmSnapFileNames, OnNameLookupResponseStruct, getLocalizedSnapManifest, MAX_FILE_SIZE, OnSettingsPageResponseStruct, isValidUrl, OnAssetHistoricalPriceResponseStruct, OnAssetsConversionResponseStruct, OnAssetsMarketDataResponseStruct } from "@metamask/snaps-utils";
+import { hexToNumber, assert, assertIsJsonRpcRequest, assertStruct, Duration, gtRange, gtVersion, hasProperty, inMilliseconds, isNonEmptyArray, satisfiesVersionRange, timeSince, createDeferredPromise } from "@metamask/utils";
 import { createMachine, interpret } from "@xstate/fsm";
 import { Mutex } from "async-mutex";
 import { nanoid } from "nanoid";
@@ -84,14 +85,28 @@ export class SnapController extends BaseController {
             messenger,
             metadata: {
                 snapStates: {
+                    includeInStateLogs: false,
                     persist: true,
                     anonymous: false,
+                    usedInUi: false,
                 },
                 unencryptedSnapStates: {
+                    includeInStateLogs: false,
                     persist: true,
                     anonymous: false,
+                    usedInUi: false,
                 },
                 snaps: {
+                    includeInStateLogs: (snaps) => {
+                        // Delete larger snap properties
+                        return Object.values(snaps).reduce((acc, snap) => {
+                            const snapCopy = { ...snap };
+                            delete snapCopy.sourceCode;
+                            delete snapCopy.auxiliaryFiles;
+                            acc[snap.id] = snapCopy;
+                            return acc;
+                        }, {});
+                    },
                     persist: (snaps) => {
                         return (Object.values(snaps)
                             // We should not persist snaps that are in the installing state,
@@ -110,6 +125,9 @@ export class SnapController extends BaseController {
                         }, {}));
                     },
                     anonymous: false,
+                    // TODO: Ensure larger snap properties are not sent to the UI
+                    // Currently these are stripped out manually in the extension
+                    usedInUi: true,
                 },
             },
             name: controllerName,
@@ -252,7 +270,7 @@ export class SnapController extends BaseController {
         this.messagingSystem.registerActionHandler(`${controllerName}:getSnapState`, async (...args) => this.getSnapState(...args));
         this.messagingSystem.registerActionHandler(`${controllerName}:handleRequest`, async (...args) => this.handleRequest(...args));
         this.messagingSystem.registerActionHandler(`${controllerName}:has`, (...args) => this.has(...args));
-        this.messagingSystem.registerActionHandler(`${controllerName}:updateBlockedSnaps`, async () => this.updateBlockedSnaps());
+        this.messagingSystem.registerActionHandler(`${controllerName}:updateRegistry`, async () => this.updateRegistry());
         this.messagingSystem.registerActionHandler(`${controllerName}:updateSnapState`, async (...args) => this.updateSnapState(...args));
         this.messagingSystem.registerActionHandler(`${controllerName}:enable`, (...args) => this.enableSnap(...args));
         this.messagingSystem.registerActionHandler(`${controllerName}:disable`, async (...args) => this.disableSnap(...args));
@@ -358,8 +376,10 @@ export class SnapController extends BaseController {
      * Checks all installed snaps against the block list and
      * blocks/unblocks snaps as appropriate. See {@link SnapController.blockSnap}
      * for more information.
+     *
+     * Also updates any preinstalled Snaps to the latest allowlisted version.
      */
-    async updateBlockedSnaps() {
+    async updateRegistry() {
         this.#assertCanUsePlatform();
         await this.messagingSystem.call('SnapsRegistry:update');
         const blockedSnaps = await this.messagingSystem.call('SnapsRegistry:get', Object.values(this.state.snaps).reduce((blockListArg, snap) => {
@@ -375,6 +395,30 @@ export class SnapController extends BaseController {
             }
             return this.#unblockSnap(snapId);
         }));
+        if (!this.#featureFlags.autoUpdatePreinstalledSnaps) {
+            return;
+        }
+        const preinstalledVersionRange = '*';
+        await Promise.allSettled(Object.values(this.state.snaps)
+            .filter((snap) => snap.preinstalled)
+            .map(async (snap) => {
+            const resolvedVersion = await this.#resolveAllowlistVersion(snap.id, preinstalledVersionRange);
+            if (resolvedVersion !== preinstalledVersionRange &&
+                gtVersion(resolvedVersion, snap.version)) {
+                const location = this.#detectSnapLocation(snap.id, {
+                    versionRange: resolvedVersion,
+                    fetch: this.#fetchFunction,
+                    allowLocal: false,
+                });
+                await this.#updateSnap({
+                    origin: ORIGIN_METAMASK,
+                    snapId: snap.id,
+                    location,
+                    versionRange: resolvedVersion,
+                    automaticUpdate: true,
+                });
+            }
+        }));
     }
     /**
      * Blocks an installed snap and prevents it from being started again. Emits
@@ -666,7 +710,7 @@ export class SnapController extends BaseController {
      */
     getExpect(snapId) {
         const snap = this.get(snapId);
-        assert(snap !== undefined, new Error(`Snap "${snapId}" not found.`));
+        assert(snap !== undefined, `Snap "${snapId}" not found.`);
         return snap;
     }
     /**
@@ -1216,7 +1260,7 @@ export class SnapController extends BaseController {
                 else if (!isUpdate) {
                     pendingInstalls.push(snapId);
                 }
-                result[snapId] = await this.processRequestedSnap(origin, snapId, location, version);
+                result[snapId] = await this.#processRequestedSnap(origin, snapId, location, version);
             }
             // Once we finish all installs / updates, emit events.
             pendingInstalls.forEach((snapId) => this.messagingSystem.publish(`SnapController:snapInstalled`, this.getTruncatedExpect(snapId), origin, false));
@@ -1245,23 +1289,19 @@ export class SnapController extends BaseController {
      * @param versionRange - The semver range of the snap to install.
      * @returns The resulting snap object, or an error if something went wrong.
      */
-    // TODO: Either fix this lint violation or explain why it's necessary to
-    //  ignore.
-    // eslint-disable-next-line no-restricted-syntax
-    async processRequestedSnap(origin, snapId, location, versionRange) {
+    async #processRequestedSnap(origin, snapId, location, versionRange) {
         const existingSnap = this.getTruncated(snapId);
         // For devX we always re-install local snaps.
         if (existingSnap && !location.shouldAlwaysReload) {
             if (satisfiesVersionRange(existingSnap.version, versionRange)) {
                 return existingSnap;
             }
-            return await this.updateSnap(origin, snapId, location, versionRange, 
-            // Since we are requesting an update from within processRequestedSnap,
-            // we disable the emitting of the snapUpdated event and rely on the caller
-            // to publish this event after the update is complete.
-            // This is necessary as installSnaps may be installing multiple snaps
-            // and we don't want to emit events prematurely.
-            false);
+            return await this.#updateSnap({
+                origin,
+                snapId,
+                location,
+                versionRange,
+            });
         }
         this.#assertCanInstallSnaps();
         let pendingApproval = this.#createApproval({
@@ -1285,7 +1325,7 @@ export class SnapController extends BaseController {
                 location,
                 versionRange,
             });
-            await this.authorize(snapId, pendingApproval);
+            await this.#authorize(snapId, pendingApproval);
             pendingApproval = this.#createApproval({
                 origin,
                 snapId,
@@ -1354,28 +1394,30 @@ export class SnapController extends BaseController {
      * If the original version of the snap was blocked and the update succeeded,
      * the snap will be unblocked and enabled before it is restarted.
      *
-     * @param origin - The origin requesting the snap update.
-     * @param snapId - The id of the Snap to be updated.
-     * @param location - The location implementation of the snap.
-     * @param newVersionRange - A semver version range in which the maximum version will be chosen.
-     * @param emitEvent - An optional boolean flag to indicate whether this update should emit an event.
+     * @param options - An options bag.
+     * @param options.origin - The origin requesting the snap update.
+     * @param options.snapId - The id of the Snap to be updated.
+     * @param options.location - The location implementation of the snap.
+     * @param options.versionRange - A semver version range in which the maximum version will be chosen.
+     * @param options.automaticUpdate - An optional boolean flag to indicate whether this update should be done
+     * automatically.
      * @returns The snap metadata if updated, `null` otherwise.
      */
-    async updateSnap(origin, snapId, location, newVersionRange = DEFAULT_REQUESTED_SNAP_VERSION, emitEvent = true) {
+    async #updateSnap({ origin, snapId, location, versionRange, automaticUpdate = false, }) {
         this.#assertCanInstallSnaps();
         this.#assertCanUsePlatform();
         const snap = this.getExpect(snapId);
-        if (snap.preinstalled) {
+        const { preinstalled, removable, hidden, hideSnapBranding } = snap;
+        if (preinstalled && !automaticUpdate) {
             throw new Error('Preinstalled Snaps cannot be manually updated.');
         }
-        if (!isValidSemVerRange(newVersionRange)) {
-            throw new Error(`Received invalid snap version range: "${newVersionRange}".`);
-        }
-        let pendingApproval = this.#createApproval({
-            origin,
-            snapId,
-            type: SNAP_APPROVAL_UPDATE,
-        });
+        let pendingApproval = automaticUpdate
+            ? null
+            : this.#createApproval({
+                origin,
+                snapId,
+                type: SNAP_APPROVAL_UPDATE,
+            });
         try {
             this.messagingSystem.publish('SnapController:snapInstallStarted', snapId, origin, true);
             const oldManifest = snap.manifest;
@@ -1384,10 +1426,10 @@ export class SnapController extends BaseController {
             const manifest = manifestFile.result;
             const newVersion = manifest.version;
             if (!gtVersion(newVersion, snap.version)) {
-                throw rpcErrors.invalidParams(`Snap "${snapId}@${snap.version}" is already installed. Couldn't update to a version inside requested "${newVersionRange}" range.`);
+                throw rpcErrors.invalidParams(`Snap "${snapId}@${snap.version}" is already installed. Couldn't update to a version inside requested "${versionRange}" range.`);
             }
-            if (!satisfiesVersionRange(newVersion, newVersionRange)) {
-                throw new Error(`Version mismatch. Manifest for "${snapId}" specifies version "${newVersion}" which doesn't satisfy requested version range "${newVersionRange}".`);
+            if (!satisfiesVersionRange(newVersion, versionRange)) {
+                throw new Error(`Version mismatch. Manifest for "${snapId}" specifies version "${newVersion}" which doesn't satisfy requested version range "${versionRange}".`);
             }
             await this.#assertIsInstallAllowed(snapId, {
                 version: newVersion,
@@ -1399,23 +1441,33 @@ export class SnapController extends BaseController {
             this.#validateSnapPermissions(processedPermissions);
             const { newPermissions, unusedPermissions, approvedPermissions } = this.#calculatePermissionsChange(snapId, processedPermissions);
             const { newConnections, unusedConnections, approvedConnections } = this.#calculateConnectionsChange(snapId, oldManifest.initialConnections ?? {}, manifest.initialConnections ?? {});
-            this.#updateApproval(pendingApproval.id, {
-                permissions: newPermissions,
-                newVersion: manifest.version,
-                newPermissions,
-                approvedPermissions,
-                unusedPermissions,
-                newConnections,
-                unusedConnections,
-                approvedConnections,
-                loading: false,
-            });
-            const { permissions: approvedNewPermissions, ...requestData } = (await pendingApproval.promise);
-            pendingApproval = this.#createApproval({
-                origin,
-                snapId,
-                type: SNAP_APPROVAL_RESULT,
-            });
+            let approvedNewPermissions;
+            let requestData;
+            if (pendingApproval) {
+                this.#updateApproval(pendingApproval.id, {
+                    permissions: newPermissions,
+                    newVersion: manifest.version,
+                    newPermissions,
+                    approvedPermissions,
+                    unusedPermissions,
+                    newConnections,
+                    unusedConnections,
+                    approvedConnections,
+                    loading: false,
+                });
+                const { permissions, ...rest } = (await pendingApproval.promise);
+                approvedNewPermissions = permissions;
+                requestData = rest;
+                pendingApproval = this.#createApproval({
+                    origin,
+                    snapId,
+                    type: SNAP_APPROVAL_RESULT,
+                });
+            }
+            else {
+                assert(automaticUpdate);
+                approvedNewPermissions = newPermissions;
+            }
             if (this.isRunning(snapId)) {
                 await this.stopSnap(snapId, SnapStatusEvents.Stop);
             }
@@ -1424,6 +1476,10 @@ export class SnapController extends BaseController {
                 origin,
                 id: snapId,
                 files: newSnap,
+                removable,
+                preinstalled,
+                hidden,
+                hideSnapBranding,
                 isUpdate: true,
             });
             this.#updatePermissions({
@@ -1432,14 +1488,17 @@ export class SnapController extends BaseController {
                 newPermissions: approvedNewPermissions,
                 requestData,
             });
-            if (manifest.initialConnections) {
-                this.#handleInitialConnections(snapId, oldManifest.initialConnections ?? null, manifest.initialConnections);
-            }
+            const previousInitialConnections = oldManifest.initialConnections ?? null;
+            const newInitialConnections = manifest.initialConnections ?? {};
+            this.#handleInitialConnections(snapId, previousInitialConnections, newInitialConnections);
             const rollbackSnapshot = this.#getRollbackSnapshot(snapId);
             if (rollbackSnapshot !== undefined) {
                 rollbackSnapshot.permissions.revoked = unusedPermissions;
                 rollbackSnapshot.permissions.granted = approvedNewPermissions;
                 rollbackSnapshot.permissions.requestData = requestData;
+                rollbackSnapshot.previousInitialConnections =
+                    previousInitialConnections;
+                rollbackSnapshot.newInitialConnections = newInitialConnections;
             }
             const sourceCode = sourceCodeFile.toString();
             assert(typeof sourceCode === 'string' && sourceCode.length > 0, `Invalid source code for snap "${snapId}".`);
@@ -1450,23 +1509,24 @@ export class SnapController extends BaseController {
                 throw new Error(`Snap ${snapId} crashed with updated source code.`);
             }
             const truncatedSnap = this.getTruncatedExpect(snapId);
-            if (emitEvent) {
-                this.messagingSystem.publish('SnapController:snapUpdated', truncatedSnap, snap.version, origin, false);
+            if (pendingApproval) {
+                this.#updateApproval(pendingApproval.id, {
+                    loading: false,
+                    type: SNAP_APPROVAL_UPDATE,
+                });
             }
-            this.#updateApproval(pendingApproval.id, {
-                loading: false,
-                type: SNAP_APPROVAL_UPDATE,
-            });
             return truncatedSnap;
         }
         catch (error) {
             logError(`Error when updating ${snapId},`, error);
             const errorString = error instanceof Error ? error.message : error.toString();
-            this.#updateApproval(pendingApproval.id, {
-                loading: false,
-                error: errorString,
-                type: SNAP_APPROVAL_UPDATE,
-            });
+            if (pendingApproval) {
+                this.#updateApproval(pendingApproval.id, {
+                    loading: false,
+                    error: errorString,
+                    type: SNAP_APPROVAL_UPDATE,
+                });
+            }
             this.messagingSystem.publish('SnapController:snapInstallFailed', snapId, origin, true, errorString);
             throw error;
         }
@@ -1712,14 +1772,11 @@ export class SnapController extends BaseController {
      * Initiates a request for the given snap's initial permissions.
      * Must be called in order. See processRequestedSnap.
      *
-     * This function is not hash private yet because of tests.
-     *
      * @param snapId - The id of the Snap.
      * @param pendingApproval - Pending approval to update.
      * @returns The snap's approvedPermissions.
      */
-    // eslint-disable-next-line no-restricted-syntax
-    async authorize(snapId, pendingApproval) {
+    async #authorize(snapId, pendingApproval) {
         log(`Authorizing snap: ${snapId}`);
         const snapsState = this.state.snaps;
         const snap = snapsState[snapId];
@@ -2141,14 +2198,14 @@ export class SnapController extends BaseController {
      * @returns A `RollbackSnapshot`.
      */
     #createRollbackSnapshot(snapId) {
-        assert(this.#rollbackSnapshots.get(snapId) === undefined, new Error(`Snap "${snapId}" rollback snapshot already exists.`));
+        assert(this.#rollbackSnapshots.get(snapId) === undefined, `Snap "${snapId}" rollback snapshot already exists.`);
         this.#rollbackSnapshots.set(snapId, {
             statePatches: [],
             permissions: {},
             newVersion: '',
         });
         const newRollbackSnapshot = this.#rollbackSnapshots.get(snapId);
-        assert(newRollbackSnapshot !== undefined, new Error(`Snapshot creation failed for ${snapId}.`));
+        assert(newRollbackSnapshot !== undefined, `Snapshot creation failed for ${snapId}.`);
         return newRollbackSnapshot;
     }
     /**
@@ -2172,7 +2229,7 @@ export class SnapController extends BaseController {
         if (this.get(snapId)?.status !== SnapStatus.Stopped) {
             this.#transition(snapId, SnapStatusEvents.Stop);
         }
-        const { statePatches, permissions } = rollbackSnapshot;
+        const { statePatches, permissions, previousInitialConnections, newInitialConnections, } = rollbackSnapshot;
         if (statePatches?.length) {
             this.applyPatches(statePatches);
         }
@@ -2189,6 +2246,8 @@ export class SnapController extends BaseController {
             newPermissions: permissions.revoked,
             requestData: permissions.requestData,
         });
+        // Calling this in reverse order to undo the changes
+        this.#handleInitialConnections(snapId, newInitialConnections ?? null, previousInitialConnections ?? {});
         const truncatedSnap = this.getTruncatedExpect(snapId);
         this.messagingSystem.publish('SnapController:snapRolledback', truncatedSnap, rollbackSnapshot.newVersion);
         this.#rollbackSnapshots.delete(snapId);
@@ -2209,7 +2268,7 @@ export class SnapController extends BaseController {
     }
     #getRuntimeExpect(snapId) {
         const runtime = this.#getRuntime(snapId);
-        assert(runtime !== undefined, new Error(`Snap "${snapId}" runtime data not found`));
+        assert(runtime !== undefined, `Snap "${snapId}" runtime data not found`);
         return runtime;
     }
     #setupRuntime(snapId) {
@@ -2280,8 +2339,7 @@ export class SnapController extends BaseController {
      * @returns The permissions to grant to the Snap.
      */
     #getPermissionsToGrant(snapId, newPermissions) {
-        if (this.#featureFlags.useCaip25Permission &&
-            Object.keys(newPermissions).includes(SnapEndowments.EthereumProvider)) {
+        if (Object.keys(newPermissions).includes(SnapEndowments.EthereumProvider)) {
             // This will return the globally selected network if the Snap doesn't have
             // one set.
             const networkClientId = this.messagingSystem.call('SelectedNetworkController:getNetworkClientIdForDomain', snapId);