@metamask/snaps-controllers 0.28.0 → 0.30.0

package/dist/snaps/SnapController.js

@@ -21,7 +21,7 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-var _SnapController_instances, _SnapController_closeAllConnections, _SnapController_environmentEndowmentPermissions, _SnapController_excludedPermissions, _SnapController_featureFlags, _SnapController_fetchFunction, _SnapController_idleTimeCheckInterval, _SnapController_registry, _SnapController_maxIdleTime, _SnapController_detectSnapLocation, _SnapController_rollbackSnapshots, _SnapController_timeoutForLastRequestStatus, _SnapController_statusMachine, _SnapController_initializeStateMachine, _SnapController_registerMessageHandlers, _SnapController_pollForLastRequestStatus, _SnapController_blockSnap, _SnapController_unblockSnap, _SnapController_assertIsInstallAllowed, _SnapController_stopSnapsLastRequestPastMax, _SnapController_transition, _SnapController_terminateSnap, _SnapController_add, _SnapController_startSnap, _SnapController_getEndowments, _SnapController_set, _SnapController_fetchSnap, _SnapController_processSnapPermissions, _SnapController_getRpcRequestHandler, _SnapController_executeWithTimeout, _SnapController_recordSnapRpcRequestStart, _SnapController_recordSnapRpcRequestFinish, _SnapController_getRollbackSnapshot, _SnapController_createRollbackSnapshot, _SnapController_rollbackSnap, _SnapController_rollbackSnaps, _SnapController_getRuntime, _SnapController_getRuntimeExpect, _SnapController_setupRuntime, _SnapController_calculatePermissionsChange, _SnapController_isValidUpdate;
+var _SnapController_instances, _SnapController_closeAllConnections, _SnapController_environmentEndowmentPermissions, _SnapController_excludedPermissions, _SnapController_featureFlags, _SnapController_fetchFunction, _SnapController_idleTimeCheckInterval, _SnapController_registry, _SnapController_maxIdleTime, _SnapController_detectSnapLocation, _SnapController_rollbackSnapshots, _SnapController_timeoutForLastRequestStatus, _SnapController_statusMachine, _SnapController_initializeStateMachine, _SnapController_registerMessageHandlers, _SnapController_pollForLastRequestStatus, _SnapController_blockSnap, _SnapController_unblockSnap, _SnapController_assertIsInstallAllowed, _SnapController_stopSnapsLastRequestPastMax, _SnapController_transition, _SnapController_terminateSnap, _SnapController_removeSnapFromSubjects, _SnapController_add, _SnapController_startSnap, _SnapController_getEndowments, _SnapController_set, _SnapController_fetchSnap, _SnapController_processSnapPermissions, _SnapController_getRpcRequestHandler, _SnapController_executeWithTimeout, _SnapController_recordSnapRpcRequestStart, _SnapController_recordSnapRpcRequestFinish, _SnapController_getRollbackSnapshot, _SnapController_createRollbackSnapshot, _SnapController_rollbackSnap, _SnapController_rollbackSnaps, _SnapController_getRuntime, _SnapController_getRuntimeExpect, _SnapController_setupRuntime, _SnapController_calculatePermissionsChange, _SnapController_isValidUpdate;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SnapController = exports.SNAP_APPROVAL_UPDATE = exports.SNAP_APPROVAL_INSTALL = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -33,6 +33,7 @@ const fsm_1 = require("@xstate/fsm");
 const eth_rpc_errors_1 = require("eth-rpc-errors");
 const nanoid_1 = require("nanoid");
 const fsm_2 = require("../fsm");
+const logging_1 = require("../logging");
 const utils_2 = require("../utils");
 const endowments_1 = require("./endowments");
 const rpc_1 = require("./endowments/rpc");
@@ -47,7 +48,6 @@ exports.SNAP_APPROVAL_UPDATE = 'wallet_updateSnap';
 const TRUNCATED_SNAP_PROPERTIES = new Set([
     'initialPermissions',
     'id',
-    'permissionName',
     'version',
     'enabled',
     'blocked',
@@ -192,7 +192,7 @@ class SnapController extends base_controller_1.BaseControllerV2 {
             .then(() => this.addSnapError(error))
             .catch((stopSnapError) => {
             // TODO: Decide how to handle errors.
-            console.error(stopSnapError);
+            (0, snaps_utils_1.logError)(stopSnapError);
         });
     }
     _onOutboundRequest(snapId) {
@@ -464,9 +464,7 @@ class SnapController extends base_controller_1.BaseControllerV2 {
             // affect the host environment while we are deleting it.
             await this.disableSnap(snapId);
             this.revokeAllSnapPermissions(snapId);
-            const permissionName = (0, snaps_utils_1.getSnapPermissionName)(snapId);
-            // Revoke all subjects access to the snap
-            this.messagingSystem.call('PermissionController:revokePermissionForAllSubjects', permissionName);
+            __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_removeSnapFromSubjects).call(this, snapId);
             this.snapsRuntimeData.delete(snapId);
             this.update((state) => {
                 delete state.snaps[snapId];
@@ -519,15 +517,14 @@ class SnapController extends base_controller_1.BaseControllerV2 {
      * @returns The serialized permitted snaps for the origin.
      */
     getPermittedSnaps(origin) {
-        var _a;
-        return Object.values((_a = this.messagingSystem.call('PermissionController:getPermissions', origin)) !== null && _a !== void 0 ? _a : {}).reduce((permittedSnaps, perm) => {
-            if (perm.parentCapability.startsWith(snaps_utils_1.SNAP_PREFIX)) {
-                const snapId = perm.parentCapability.replace(snaps_utils_1.SNAP_PREFIX_REGEX, '');
-                const snap = this.get(snapId);
-                const truncatedSnap = this.getTruncated(snapId);
-                if (truncatedSnap && (snap === null || snap === void 0 ? void 0 : snap.status) !== snaps_utils_1.SnapStatus.Installing) {
-                    permittedSnaps[snapId] = truncatedSnap;
-                }
+        var _a, _b, _c, _d, _e;
+        const permissions = (_a = this.messagingSystem.call('PermissionController:getPermissions', origin)) !== null && _a !== void 0 ? _a : {};
+        const snaps = (_e = (_d = (_c = (_b = permissions[rpc_methods_1.WALLET_SNAP_PERMISSION_KEY]) === null || _b === void 0 ? void 0 : _b.caveats) === null || _c === void 0 ? void 0 : _c.find((caveat) => caveat.type === snaps_utils_1.SnapCaveatType.SnapIds)) === null || _d === void 0 ? void 0 : _d.value) !== null && _e !== void 0 ? _e : {};
+        return Object.keys(snaps).reduce((permittedSnaps, snapId) => {
+            const snap = this.get(snapId);
+            const truncatedSnap = this.getTruncated(snapId);
+            if (truncatedSnap && (snap === null || snap === void 0 ? void 0 : snap.status) !== snaps_utils_1.SnapStatus.Installing) {
+                permittedSnaps[snapId] = truncatedSnap;
             }
             return permittedSnaps;
         }, {});
@@ -555,8 +552,8 @@ class SnapController extends base_controller_1.BaseControllerV2 {
                 if (error) {
                     throw eth_rpc_errors_1.ethErrors.rpc.invalidParams(`The "version" field must be a valid SemVer version range if specified. Received: "${rawVersion}".`);
                 }
-                const permissionName = (0, snaps_utils_1.getSnapPermissionName)(snapId);
-                if (!this.messagingSystem.call('PermissionController:hasPermission', origin, permissionName)) {
+                const permissions = this.messagingSystem.call('PermissionController:getPermissions', origin);
+                if (!(0, snaps_utils_1.isSnapPermitted)(permissions, snapId)) {
                     throw eth_rpc_errors_1.ethErrors.provider.unauthorized(`Not authorized to install snap "${snapId}". Request the permission for the snap before attempting to install it.`);
                 }
                 const isUpdate = pendingUpdates.includes(snapId);
@@ -637,7 +634,7 @@ class SnapController extends base_controller_1.BaseControllerV2 {
             return truncated;
         }
         catch (error) {
-            console.error(`Error when adding snap.`, error);
+            (0, snaps_utils_1.logError)(`Error when adding snap.`, error);
             throw error;
         }
     }
@@ -668,7 +665,7 @@ class SnapController extends base_controller_1.BaseControllerV2 {
         const newSnap = await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_fetchSnap).call(this, snapId, location);
         const newVersion = newSnap.manifest.result.version;
         if (!(0, utils_1.gtVersion)(newVersion, snap.version)) {
-            console.warn(`Tried updating snap "${snapId}" within "${newVersionRange}" version range, but newer version "${snap.version}" is already installed`);
+            (0, snaps_utils_1.logWarning)(`Tried updating snap "${snapId}" within "${newVersionRange}" version range, but newer version "${snap.version}" is already installed`);
             return null;
         }
         await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_assertIsInstallAllowed).call(this, snapId, {
@@ -724,9 +721,10 @@ class SnapController extends base_controller_1.BaseControllerV2 {
             rollbackSnapshot.permissions.granted = Object.keys(approvedNewPermissions);
             rollbackSnapshot.permissions.requestData = requestData;
         }
+        const normalizedSourcePath = (0, snaps_utils_1.normalizeRelative)(newSnap.manifest.result.source.location.npm.filePath);
         const sourceCode = (_a = newSnap.files
-            .find((file) => file.path === newSnap.manifest.result.source.location.npm.filePath)) === null || _a === void 0 ? void 0 : _a.toString();
-        (0, utils_1.assert)(sourceCode !== undefined);
+            .find((file) => file.path === normalizedSourcePath)) === null || _a === void 0 ? void 0 : _a.toString();
+        (0, utils_1.assert)(typeof sourceCode === 'string' && sourceCode.length > 0, `Invalid source code for snap "${snapId}".`);
         try {
             await __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_startSnap).call(this, { snapId, sourceCode });
         }
@@ -737,6 +735,16 @@ class SnapController extends base_controller_1.BaseControllerV2 {
         this.messagingSystem.publish('SnapController:snapUpdated', truncatedSnap, snap.version);
         return truncatedSnap;
     }
+    /**
+     * Get metadata for the given snap ID.
+     *
+     * @param snapId - The ID of the snap to get metadata for.
+     * @returns The metadata for the given snap ID, or `null` if the snap is not
+     * verified.
+     */
+    async getRegistryMetadata(snapId) {
+        return await __classPrivateFieldGet(this, _SnapController_registry, "f").getMetadata(snapId);
+    }
     /**
      * Initiates a request for the given snap's initial permissions.
      * Must be called in order. See processRequestedSnap.
@@ -748,7 +756,7 @@ class SnapController extends base_controller_1.BaseControllerV2 {
      * @returns The snap's approvedPermissions.
      */
     async authorize(origin, snapId) {
-        console.info(`Authorizing snap: ${snapId}`);
+        (0, logging_1.log)(`Authorizing snap: ${snapId}`);
         const snapsState = this.state.snaps;
         const snap = snapsState[snapId];
         const { initialPermissions } = snap;
@@ -901,11 +909,12 @@ _SnapController_closeAllConnections = new WeakMap(), _SnapController_environment
     this.messagingSystem.registerActionHandler(`${exports.controllerName}:getAll`, (...args) => this.getAllSnaps(...args));
     this.messagingSystem.registerActionHandler(`${exports.controllerName}:incrementActiveReferences`, (...args) => this.incrementActiveReferences(...args));
     this.messagingSystem.registerActionHandler(`${exports.controllerName}:decrementActiveReferences`, (...args) => this.decrementActiveReferences(...args));
+    this.messagingSystem.registerActionHandler(`${exports.controllerName}:getRegistryMetadata`, async (...args) => this.getRegistryMetadata(...args));
 }, _SnapController_pollForLastRequestStatus = function _SnapController_pollForLastRequestStatus() {
     __classPrivateFieldSet(this, _SnapController_timeoutForLastRequestStatus, setTimeout(() => {
         __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_stopSnapsLastRequestPastMax).call(this).catch((error) => {
             // TODO: Decide how to handle errors.
-            console.error(error);
+            (0, snaps_utils_1.logError)(error);
         });
         __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_pollForLastRequestStatus).call(this);
     }, __classPrivateFieldGet(this, _SnapController_idleTimeCheckInterval, "f")), "f");
@@ -929,7 +938,7 @@ async function _SnapController_blockSnap(snapId, blockedSnapInfo) {
         await this.disableSnap(snapId);
     }
     catch (error) {
-        console.error(`Encountered error when stopping blocked snap "${snapId}".`, error);
+        (0, snaps_utils_1.logError)(`Encountered error when stopping blocked snap "${snapId}".`, error);
     }
     this.messagingSystem.publish(`${exports.controllerName}:snapBlocked`, snapId, blockedSnapInfo);
 }, _SnapController_unblockSnap = function _SnapController_unblockSnap(snapId) {
@@ -979,6 +988,26 @@ async function _SnapController_blockSnap(snapId, blockedSnapInfo) {
 async function _SnapController_terminateSnap(snapId) {
     await this.messagingSystem.call('ExecutionService:terminateSnap', snapId);
     this.messagingSystem.publish('SnapController:snapTerminated', this.getTruncatedExpect(snapId));
+}, _SnapController_removeSnapFromSubjects = function _SnapController_removeSnapFromSubjects(snapId) {
+    var _a, _b, _c, _d;
+    const subjects = this.messagingSystem.call('PermissionController:getSubjectNames');
+    for (const subject of subjects) {
+        const subjectPermissions = this.messagingSystem.call('PermissionController:getPermissions', subject);
+        const snapIdsCaveat = ((_c = (_b = (_a = subjectPermissions === null || subjectPermissions === void 0 ? void 0 : subjectPermissions[rpc_methods_1.WALLET_SNAP_PERMISSION_KEY]) === null || _a === void 0 ? void 0 : _a.caveats) === null || _b === void 0 ? void 0 : _b.find((caveat) => caveat.type === snaps_utils_1.SnapCaveatType.SnapIds)) !== null && _c !== void 0 ? _c : {});
+        const caveatHasSnap = Boolean((_d = snapIdsCaveat.value) === null || _d === void 0 ? void 0 : _d[snapId]);
+        if (caveatHasSnap) {
+            const newCaveatValue = Object.assign({}, snapIdsCaveat.value);
+            delete newCaveatValue[snapId];
+            if (Object.keys(newCaveatValue).length > 0) {
+                this.messagingSystem.call('PermissionController:updateCaveat', subject, rpc_methods_1.WALLET_SNAP_PERMISSION_KEY, snaps_utils_1.SnapCaveatType.SnapIds, newCaveatValue);
+            }
+            else {
+                this.messagingSystem.call('PermissionController:revokePermissions', {
+                    [subject]: [rpc_methods_1.WALLET_SNAP_PERMISSION_KEY],
+                });
+            }
+        }
+    }
 }, _SnapController_add = 
 /**
  * Returns a promise representing the complete installation of the requested snap.
@@ -995,7 +1024,7 @@ async function _SnapController_add(args) {
     __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_setupRuntime).call(this, snapId, { sourceCode: null, state: null });
     const runtime = __classPrivateFieldGet(this, _SnapController_instances, "m", _SnapController_getRuntimeExpect).call(this, snapId);
     if (!runtime.installPromise) {
-        console.info(`Adding snap: ${snapId}`);
+        (0, logging_1.log)(`Adding snap: ${snapId}`);
         // If fetching and setting the snap succeeds, this property will be set
         // to null in the authorize() method.
         runtime.installPromise = (async () => {
@@ -1065,7 +1094,7 @@ async function _SnapController_getEndowments(snapId) {
         // This is a bug in TypeScript: https://github.com/microsoft/TypeScript/issues/48313
         // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
         snaps_utils_1.DEFAULT_ENDOWMENTS.length + allEndowments.length) {
-        console.error('Duplicate endowments found. Default endowments should not be requested.', allEndowments);
+        (0, snaps_utils_1.logError)('Duplicate endowments found. Default endowments should not be requested.', allEndowments);
     }
     return dedupedEndowments;
 }, _SnapController_set = function _SnapController_set(args) {
@@ -1076,14 +1105,15 @@ async function _SnapController_getEndowments(snapId) {
     if (!(0, utils_1.satisfiesVersionRange)(version, versionRange)) {
         throw new Error(`Version mismatch. Manifest for "${snapId}" specifies version "${version}" which doesn't satisfy requested version range "${versionRange}"`);
     }
+    const normalizedSourcePath = (0, snaps_utils_1.normalizeRelative)(manifest.result.source.location.npm.filePath);
+    const { iconPath } = manifest.result.source.location.npm;
+    const normalizedIconPath = iconPath && (0, snaps_utils_1.normalizeRelative)(iconPath);
     const sourceCode = (_a = files
-        .find((file) => file.path === manifest.result.source.location.npm.filePath)) === null || _a === void 0 ? void 0 : _a.toString();
-    const svgIcon = files.find((file) => manifest.result.source.location.npm.iconPath !== undefined &&
-        file.path === manifest.result.source.location.npm.iconPath);
-    (0, utils_1.assert)(sourceCode !== undefined);
-    if (typeof sourceCode !== 'string' || sourceCode.length === 0) {
-        throw new Error(`Invalid source code for snap "${snapId}".`);
-    }
+        .find((file) => file.path === normalizedSourcePath)) === null || _a === void 0 ? void 0 : _a.toString();
+    const svgIcon = normalizedIconPath
+        ? files.find((file) => file.path === normalizedIconPath)
+        : undefined;
+    (0, utils_1.assert)(typeof sourceCode === 'string' && sourceCode.length > 0, `Invalid source code for snap "${snapId}".`);
     const snapsState = this.state.snaps;
     const existingSnap = snapsState[snapId];
     const previousVersionHistory = (_b = existingSnap === null || existingSnap === void 0 ? void 0 : existingSnap.versionHistory) !== null && _b !== void 0 ? _b : [];
@@ -1098,9 +1128,7 @@ async function _SnapController_getEndowments(snapId) {
     const snap = Object.assign(Object.assign({}, existingSnap), { 
         // Note that the snap will be unblocked and enabled, regardless of its
         // previous state.
-        blocked: false, enabled: true, 
-        // So we can easily correlate the snap with its permission
-        permissionName: (0, snaps_utils_1.getSnapPermissionName)(snapId), id: snapId, initialPermissions: manifest.result.initialPermissions, manifest: manifest.result, status: __classPrivateFieldGet(this, _SnapController_statusMachine, "f").config.initial, version,
+        blocked: false, enabled: true, id: snapId, initialPermissions: manifest.result.initialPermissions, manifest: manifest.result, status: __classPrivateFieldGet(this, _SnapController_statusMachine, "f").config.initial, version,
         versionHistory });
     // If the snap was blocked, it isn't any longer
     delete snap.blockInformation;
@@ -1134,12 +1162,13 @@ async function _SnapController_fetchSnap(snapId, location) {
     try {
         const manifest = await location.manifest();
         const sourceCode = await location.fetch(manifest.result.source.location.npm.filePath);
-        (0, snaps_utils_1.validateSnapShasum)(manifest.result, sourceCode.toString());
         const { iconPath } = manifest.result.source.location.npm;
+        const svgIcon = iconPath ? await location.fetch(iconPath) : undefined;
         const files = [sourceCode];
-        if (iconPath) {
-            files.push(await location.fetch(iconPath));
+        if (svgIcon) {
+            files.push(svgIcon);
         }
+        (0, snaps_utils_1.validateSnapShasum)({ manifest, sourceCode, svgIcon });
         return { manifest, files, location };
     }
     catch (error) {
@@ -1244,7 +1273,7 @@ async function _SnapController_executeWithTimeout(snapId, promise, timer) {
     const isLongRunning = this.messagingSystem.call('PermissionController:hasPermission', snapId, endowments_1.SnapEndowments.LongRunning);
     // Long running snaps have timeouts disabled
     if (isLongRunning) {
-        console.warn(`${endowments_1.SnapEndowments.LongRunning} will soon be deprecated. For more information please see https://github.com/MetaMask/snaps-monorepo/issues/945.`);
+        (0, snaps_utils_1.logWarning)(`${endowments_1.SnapEndowments.LongRunning} will soon be deprecated. For more information please see https://github.com/MetaMask/snaps-monorepo/issues/945.`);
         return promise;
     }
     const result = await (0, utils_2.withTimeout)(promise, timer !== null && timer !== void 0 ? timer : this.maxRequestTime);