@metamask/snaps-controllers 0.37.2-flask.1 → 0.38.1-flask.1

package/dist/esm/snaps/SnapController.js

@@ -64,7 +64,7 @@ function _define_property(obj, key, value) {
 import { BaseControllerV2 as BaseController } from '@metamask/base-controller';
 import { SubjectType } from '@metamask/permission-controller';
 import { WALLET_SNAP_PERMISSION_KEY } from '@metamask/rpc-methods';
-import { assertIsSnapManifest, DEFAULT_ENDOWMENTS, DEFAULT_REQUESTED_SNAP_VERSION, normalizeRelative, resolveVersionRange, SnapCaveatType, SnapStatus, SnapStatusEvents, assertIsValidSnapId, logError, logWarning, validateFetchedSnap } from '@metamask/snaps-utils';
+import { assertIsSnapManifest, assertIsValidSnapId, DEFAULT_ENDOWMENTS, DEFAULT_REQUESTED_SNAP_VERSION, getErrorMessage, HandlerType, logError, logWarning, normalizeRelative, resolveVersionRange, SnapCaveatType, SnapStatus, SnapStatusEvents, validateFetchedSnap } from '@metamask/snaps-utils';
 import { assert, assertIsJsonRpcRequest, Duration, gtRange, gtVersion, hasProperty, inMilliseconds, isNonEmptyArray, isValidSemVerRange, satisfiesVersionRange, timeSince } from '@metamask/utils';
 import { createMachine, interpret } from '@xstate/fsm';
 import { ethErrors } from 'eth-rpc-errors';
@@ -112,7 +112,7 @@ const defaultState = {
     return truncatedSnap;
 }
 const name = 'SnapController';
-var _closeAllConnections = /*#__PURE__*/ new WeakMap(), _dynamicPermissions = /*#__PURE__*/ new WeakMap(), _environmentEndowmentPermissions = /*#__PURE__*/ new WeakMap(), _excludedPermissions = /*#__PURE__*/ new WeakMap(), _featureFlags = /*#__PURE__*/ new WeakMap(), _fetchFunction = /*#__PURE__*/ new WeakMap(), _idleTimeCheckInterval = /*#__PURE__*/ new WeakMap(), _maxIdleTime = /*#__PURE__*/ new WeakMap(), _detectSnapLocation = /*#__PURE__*/ new WeakMap(), _rollbackSnapshots = /*#__PURE__*/ new WeakMap(), _timeoutForLastRequestStatus = /*#__PURE__*/ new WeakMap(), _statusMachine = /*#__PURE__*/ new WeakMap(), /**
+var _closeAllConnections = /*#__PURE__*/ new WeakMap(), _dynamicPermissions = /*#__PURE__*/ new WeakMap(), _environmentEndowmentPermissions = /*#__PURE__*/ new WeakMap(), _excludedPermissions = /*#__PURE__*/ new WeakMap(), _featureFlags = /*#__PURE__*/ new WeakMap(), _fetchFunction = /*#__PURE__*/ new WeakMap(), _idleTimeCheckInterval = /*#__PURE__*/ new WeakMap(), _maxIdleTime = /*#__PURE__*/ new WeakMap(), _detectSnapLocation = /*#__PURE__*/ new WeakMap(), _snapsRuntimeData = /*#__PURE__*/ new WeakMap(), _rollbackSnapshots = /*#__PURE__*/ new WeakMap(), _timeoutForLastRequestStatus = /*#__PURE__*/ new WeakMap(), _statusMachine = /*#__PURE__*/ new WeakMap(), /**
    * We track status of a Snap using a finite-state-machine.
    * It keeps track of whether the snap is started / stopped / etc.
    *
@@ -192,7 +192,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
    * @param snapId - The snap id.
    * @param newVersionRange - The new version range being requsted.
    * @returns `true` if validation checks pass and `false` if they do not.
-   */ _isValidUpdate = /*#__PURE__*/ new WeakSet();
+   */ _isValidUpdate = /*#__PURE__*/ new WeakSet(), _callLifecycleHook = /*#__PURE__*/ new WeakSet();
 /*
  * A snap is initialized in three phases:
  * - Add: Loads the snap from a remote source and parses it.
@@ -204,6 +204,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
    * blocks/unblocks snaps as appropriate. See {@link SnapController.blockSnap}
    * for more information.
    */ async updateBlockedSnaps() {
+        await this.messagingSystem.call('SnapsRegistry:update');
         const blockedSnaps = await this.messagingSystem.call('SnapsRegistry:get', Object.values(this.state.snaps).reduce((blockListArg, snap)=>{
             blockListArg[snap.id] = {
                 version: snap.version,
@@ -244,14 +245,13 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
    *
    * @param snapId - The id of the Snap to start.
    */ async startSnap(snapId) {
-        const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
-        if (this.state.snaps[snapId].enabled === false) {
+        const snap = this.state.snaps[snapId];
+        if (snap.enabled === false) {
             throw new Error(`Snap "${snapId}" is disabled.`);
         }
-        assert(runtime.sourceCode);
         await _class_private_method_get(this, _startSnap, startSnap).call(this, {
             snapId,
-            sourceCode: runtime.sourceCode
+            sourceCode: snap.sourceCode
         });
     }
     /**
@@ -380,8 +380,9 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
    * @param snapId - The id of the Snap whose state should be updated.
    * @param newSnapState - The new state of the snap.
    */ async updateSnapState(snapId, newSnapState) {
-        const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
-        runtime.state = newSnapState;
+        this.update((state)=>{
+            state.snapStates[snapId] = newSnapState;
+        });
     }
     /**
    * Clears the state of the snap with the given id.
@@ -389,8 +390,9 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
    *
    * @param snapId - The id of the Snap whose state should be cleared.
    */ clearSnapState(snapId) {
-        const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
-        runtime.state = null;
+        this.update((state)=>{
+            state.snapStates[snapId] = null;
+        });
     }
     /**
    * Adds error from a snap to the SnapController state.
@@ -429,7 +431,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
    * @returns A promise that resolves with the decrypted snap state or null if no state exists.
    * @throws If the snap state decryption fails.
    */ async getSnapState(snapId) {
-        const { state } = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
+        const state = this.state.snapStates[snapId];
         return state ?? null;
     }
     /**
@@ -475,7 +477,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
             await this.disableSnap(snapId);
             _class_private_method_get(this, _revokeAllSnapPermissions, revokeAllSnapPermissions).call(this, snapId);
             _class_private_method_get(this, _removeSnapFromSubjects, removeSnapFromSubjects).call(this, snapId);
-            this.snapsRuntimeData.delete(snapId);
+            _class_private_field_get(this, _snapsRuntimeData).delete(snapId);
             this.update((state)=>{
                 delete state.snaps[snapId];
                 delete state.snapStates[snapId];
@@ -597,9 +599,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
                     pendingUpdates.push(snapId);
                     let rollbackSnapshot = _class_private_method_get(this, _getRollbackSnapshot, getRollbackSnapshot).call(this, snapId);
                     if (rollbackSnapshot === undefined) {
-                        const prevSourceCode = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId).sourceCode;
                         rollbackSnapshot = _class_private_method_get(this, _createRollbackSnapshot, createRollbackSnapshot).call(this, snapId);
-                        rollbackSnapshot.sourceCode = prevSourceCode;
                         rollbackSnapshot.newVersion = version;
                     } else {
                         throw new Error('This snap is already being updated.');
@@ -915,12 +915,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
                     anonymous: false
                 },
                 snapStates: {
-                    persist: ()=>{
-                        return Object.keys(this.state.snaps).reduce((acc, cur)=>{
-                            acc[cur] = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, cur).state;
-                            return acc;
-                        }, {});
-                    },
+                    persist: true,
                     anonymous: false
                 },
                 snaps: {
@@ -928,7 +923,6 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
                         return Object.values(snaps).map((snap)=>{
                             return {
                                 ...snap,
-                                sourceCode: _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snap.id).sourceCode,
                                 // At the time state is rehydrated, no snap will be running.
                                 status: SnapStatus.Stopped
                             };
@@ -943,18 +937,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
             name,
             state: {
                 ...defaultState,
-                ...{
-                    ...state,
-                    snaps: Object.values(state?.snaps ?? {}).reduce((memo, snap)=>{
-                        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-                        // sourceCode is stripped out to prevent piping to MetaMask UI,
-                        // it is stored in the runtime while we're running a snap and then
-                        // persisted to state when needed.
-                        const { sourceCode, ...rest } = snap;
-                        memo[snap.id] = rest;
-                        return memo;
-                    }, {})
-                }
+                ...state
             }
         });
         _class_private_method_init(this, _initializeStateMachine);
@@ -1049,6 +1032,16 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         _class_private_method_init(this, _setupRuntime);
         _class_private_method_init(this, _calculatePermissionsChange);
         _class_private_method_init(this, _isValidUpdate);
+        /**
+   * Call a lifecycle hook on a snap, if the snap has the
+   * `endowment:lifecycle-hooks` permission. If the snap does not have the
+   * permission, nothing happens.
+   *
+   * @param snapId - The snap ID.
+   * @param handler - The lifecycle hook to call. This should be one of the
+   * supported lifecycle hooks.
+   * @private
+   */ _class_private_method_init(this, _callLifecycleHook);
         _class_private_field_init(this, _closeAllConnections, {
             writable: true,
             value: void 0
@@ -1087,8 +1080,10 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
             writable: true,
             value: void 0
         });
-        // This property cannot be hash private yet because of tests.
-        _define_property(this, "snapsRuntimeData", void 0);
+        _class_private_field_init(this, _snapsRuntimeData, {
+            writable: true,
+            value: void 0
+        });
         _class_private_field_init(this, _rollbackSnapshots, {
             writable: true,
             value: void 0
@@ -1115,12 +1110,22 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         this._onOutboundRequest = this._onOutboundRequest.bind(this);
         this._onOutboundResponse = this._onOutboundResponse.bind(this);
         _class_private_field_set(this, _rollbackSnapshots, new Map());
-        this.snapsRuntimeData = new Map();
+        _class_private_field_set(this, _snapsRuntimeData, new Map());
         _class_private_method_get(this, _pollForLastRequestStatus, pollForLastRequestStatus).call(this);
         /* eslint-disable @typescript-eslint/unbound-method */ this.messagingSystem.subscribe('ExecutionService:unhandledError', this._onUnhandledSnapError);
         this.messagingSystem.subscribe('ExecutionService:outboundRequest', this._onOutboundRequest);
         this.messagingSystem.subscribe('ExecutionService:outboundResponse', this._onOutboundResponse);
-        /* eslint-enable @typescript-eslint/unbound-method */ _class_private_method_get(this, _initializeStateMachine, initializeStateMachine).call(this);
+        /* eslint-enable @typescript-eslint/unbound-method */ this.messagingSystem.subscribe('SnapController:snapInstalled', ({ id })=>{
+            _class_private_method_get(this, _callLifecycleHook, callLifecycleHook).call(this, id, HandlerType.OnInstall).catch((error)=>{
+                logError(`Error when calling \`onInstall\` lifecycle hook for snap "${id}": ${getErrorMessage(error)}`);
+            });
+        });
+        this.messagingSystem.subscribe('SnapController:snapUpdated', ({ id })=>{
+            _class_private_method_get(this, _callLifecycleHook, callLifecycleHook).call(this, id, HandlerType.OnUpdate).catch((error)=>{
+                logError(`Error when calling \`onUpdate\` lifecycle hook for snap "${id}": ${getErrorMessage(error)}`);
+            });
+        });
+        _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,
@@ -1249,7 +1254,7 @@ async function assertIsInstallAllowed(snapId, snapInfo) {
 }
 async function stopSnapsLastRequestPastMax() {
     const entries = [
-        ...this.snapsRuntimeData.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)));
@@ -1424,6 +1429,7 @@ function set(args) {
         initialPermissions: manifest.result.initialPermissions,
         manifest: manifest.result,
         status: _class_private_field_get(this, _statusMachine).config.initial,
+        sourceCode,
         version,
         versionHistory
     };
@@ -1441,8 +1447,6 @@ function set(args) {
             rollbackSnapshot.statePatches = inversePatches;
         }
     }
-    const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
-    runtime.sourceCode = sourceCode;
     this.messagingSystem.publish(`SnapController:snapAdded`, snap, svgIcon?.toString());
     return {
         ...snap,
@@ -1472,15 +1476,12 @@ async function fetchSnap(snapId, location) {
             location
         };
     } catch (error) {
-        // TODO(ritave): Export `getErrorMessage()` from @metamask/utils and use it here
-        //               https://github.com/MetaMask/utils/blob/62d022ef83c91fa4d150e51913be4441508a0ab1/src/assert.ts
-        const message = error instanceof Error ? error.message : error.toString();
-        throw new Error(`Failed to fetch Snap "${snapId}": ${message}.`);
+        throw new Error(`Failed to fetch snap "${snapId}": ${getErrorMessage(error)}.`);
     }
 }
 function validateSnapPermissions(processedPermissions) {
     const permissionKeys = Object.keys(processedPermissions);
-    const handlerPermissions = Object.values(handlerEndowments);
+    const handlerPermissions = Array.from(new Set(Object.values(handlerEndowments)));
     assert(permissionKeys.some((key)=>handlerPermissions.includes(key)), `A snap must request at least one of the following permissions: ${handlerPermissions.join(', ')}.`);
     const excludedPermissionErrors = permissionKeys.reduce((errors, permission)=>{
         if (hasProperty(_class_private_field_get(this, _excludedPermissions), permission)) {
@@ -1581,7 +1582,6 @@ function createRollbackSnapshot(snapId) {
     assert(_class_private_field_get(this, _rollbackSnapshots).get(snapId) === undefined, new Error(`Snap "${snapId}" rollback snapshot already exists.`));
     _class_private_field_get(this, _rollbackSnapshots).set(snapId, {
         statePatches: [],
-        sourceCode: '',
         permissions: {
             revoked: null,
             granted: [],
@@ -1603,7 +1603,7 @@ async function rollbackSnap(snapId) {
     if (this.get(snapId)?.status !== SnapStatus.Stopped) {
         _class_private_method_get(this, _transition, transition).call(this, snapId, SnapStatusEvents.Stop);
     }
-    const { statePatches, sourceCode, permissions } = rollbackSnapshot;
+    const { statePatches, permissions } = rollbackSnapshot;
     if (statePatches?.length) {
         this.applyPatches(statePatches);
     }
@@ -1614,10 +1614,6 @@ async function rollbackSnap(snapId) {
             state.snaps[snapId].status = SnapStatus.Stopped;
         });
     }
-    if (sourceCode) {
-        const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
-        runtime.sourceCode = sourceCode;
-    }
     if (permissions.revoked && Object.keys(permissions.revoked).length) {
         this.messagingSystem.call('PermissionController:grantPermissions', {
             approvedPermissions: permissions.revoked,
@@ -1642,7 +1638,7 @@ async function rollbackSnaps(snapIds) {
     }
 }
 function getRuntime(snapId) {
-    return this.snapsRuntimeData.get(snapId);
+    return _class_private_field_get(this, _snapsRuntimeData).get(snapId);
 }
 function getRuntimeExpect(snapId) {
     const runtime = _class_private_method_get(this, _getRuntime, getRuntime).call(this, snapId);
@@ -1650,7 +1646,7 @@ function getRuntimeExpect(snapId) {
     return runtime;
 }
 function setupRuntime(snapId, data) {
-    if (this.snapsRuntimeData.has(snapId)) {
+    if (_class_private_field_get(this, _snapsRuntimeData).has(snapId)) {
         return;
     }
     const snap = this.get(snapId);
@@ -1662,7 +1658,7 @@ function setupRuntime(snapId, data) {
         value: snap?.status ?? _class_private_field_get(this, _statusMachine).config.initial
     });
     forceStrict(interpreter);
-    this.snapsRuntimeData.set(snapId, {
+    _class_private_field_get(this, _snapsRuntimeData).set(snapId, {
         lastRequest: null,
         rpcHandler: null,
         installPromise: null,
@@ -1698,5 +1694,21 @@ function isValidUpdate(snapId, newVersionRange) {
     }
     return true;
 }
+async function callLifecycleHook(snapId, handler) {
+    const permissionName = handlerEndowments[handler];
+    const hasPermission = this.messagingSystem.call('PermissionController:hasPermission', snapId, permissionName);
+    if (!hasPermission) {
+        return;
+    }
+    await this.handleRequest({
+        snapId,
+        handler,
+        origin: '',
+        request: {
+            jsonrpc: '2.0',
+            method: handler
+        }
+    });
+}
 
 //# sourceMappingURL=SnapController.js.map