@metamask/snaps-controllers 0.35.2-flask.1 → 0.36.1-flask.1

package/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.36.1-flask.1]
+### Changed
+- No changes this release.
+
+## [0.36.0-flask.1]
+### Changed
+- Allow omitting `jsonrpc` and `id` in `handleRequest` ([#1556](https://github.com/MetaMask/snaps/pull/1556))
+- Unblock `wallet_requestSnaps` and add dynamic permission support ([#1421](https://github.com/MetaMask/snaps/pull/1421))
+
 ## [0.35.2-flask.1]
 ### Fixed
 - Fix type issue introduced by [#1532](https://github.com/MetaMask/snaps/pull/1532) ([#1541](https://github.com/MetaMask/snaps/pull/1541))
@@ -542,7 +551,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - First semi-stable release.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/v0.35.2-flask.1...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/v0.36.1-flask.1...HEAD
+[0.36.1-flask.1]: https://github.com/MetaMask/snaps/compare/v0.36.0-flask.1...v0.36.1-flask.1
+[0.36.0-flask.1]: https://github.com/MetaMask/snaps/compare/v0.35.2-flask.1...v0.36.0-flask.1
 [0.35.2-flask.1]: https://github.com/MetaMask/snaps/compare/v0.35.1-flask.1...v0.35.2-flask.1
 [0.35.1-flask.1]: https://github.com/MetaMask/snaps/compare/v0.35.0-flask.1...v0.35.1-flask.1
 [0.35.0-flask.1]: https://github.com/MetaMask/snaps/compare/v0.34.1-flask.1...v0.35.0-flask.1

package/dist/cjs/snaps/SnapController.js

@@ -138,7 +138,7 @@ const defaultState = {
     return truncatedSnap;
 }
 const name = 'SnapController';
-var _closeAllConnections = /*#__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(), _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.
    *
@@ -170,7 +170,11 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
    * Removes a snap's permission (caveat) from all subjects.
    *
    * @param snapId - The id of the Snap.
-   */ _removeSnapFromSubjects = /*#__PURE__*/ new WeakSet(), _createApproval = /*#__PURE__*/ new WeakSet(), _updateApproval = /*#__PURE__*/ new WeakSet(), _add = /*#__PURE__*/ new WeakSet(), _startSnap = /*#__PURE__*/ new WeakSet(), _getEndowments = /*#__PURE__*/ new WeakSet(), /**
+   */ _removeSnapFromSubjects = /*#__PURE__*/ new WeakSet(), /**
+   * Safely revokes all permissions granted to a Snap.
+   *
+   * @param snapId - The snap ID.
+   */ _revokeAllSnapPermissions = /*#__PURE__*/ new WeakSet(), _createApproval = /*#__PURE__*/ new WeakSet(), _updateApproval = /*#__PURE__*/ new WeakSet(), _add = /*#__PURE__*/ new WeakSet(), _startSnap = /*#__PURE__*/ new WeakSet(), _getEndowments = /*#__PURE__*/ new WeakSet(), /**
    * Sets a snap in state. Called when a snap is installed or updated. Performs
    * various validation checks on the received arguments, and will throw if
    * validation fails.
@@ -458,7 +462,7 @@ class SnapController extends _basecontroller.BaseControllerV2 {
             _class_private_field_get(this, _closeAllConnections).call(this, snapId);
         });
         await this.messagingSystem.call('ExecutionService:terminateAllSnaps');
-        snapIds.forEach((snapId)=>this.revokeAllSnapPermissions(snapId));
+        snapIds.forEach((snapId)=>_class_private_method_get(this, _revokeAllSnapPermissions, revokeAllSnapPermissions).call(this, snapId));
         this.update((state)=>{
             state.snaps = {};
             state.snapStates = {};
@@ -490,7 +494,7 @@ class SnapController extends _basecontroller.BaseControllerV2 {
             // it. This ensures that the snap will not be restarted or otherwise
             // affect the host environment while we are deleting it.
             await this.disableSnap(snapId);
-            this.revokeAllSnapPermissions(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);
             this.update((state)=>{
@@ -529,13 +533,16 @@ class SnapController extends _basecontroller.BaseControllerV2 {
         }
     }
     /**
-   * Safely revokes all permissions granted to a Snap.
+   * Checks if a list of permissions are dynamic and allowed to be revoked, if they are they will all be revoked.
    *
    * @param snapId - The snap ID.
-   */ revokeAllSnapPermissions(snapId) {
-        if (this.messagingSystem.call('PermissionController:hasPermissions', snapId)) {
-            this.messagingSystem.call('PermissionController:revokeAllPermissions', snapId);
-        }
+   * @param permissionNames - The names of the permissions.
+   * @throws If non-dynamic permissions are passed.
+   */ revokeDynamicSnapPermissions(snapId, permissionNames) {
+        (0, _utils.assert)(permissionNames.every((permissionName)=>_class_private_field_get(this, _dynamicPermissions).includes(permissionName)), 'Non-dynamic permissions cannot be revoked');
+        this.messagingSystem.call('PermissionController:revokePermissions', {
+            [snapId]: permissionNames
+        });
     }
     /**
    * Handles incrementing the activeReferences counter.
@@ -668,7 +675,7 @@ class SnapController extends _basecontroller.BaseControllerV2 {
         }
         // Existing snaps that should be re-installed should not maintain their existing permissions
         if (existingSnap && location.shouldAlwaysReload) {
-            this.revokeAllSnapPermissions(snapId);
+            _class_private_method_get(this, _revokeAllSnapPermissions, revokeAllSnapPermissions).call(this, snapId);
         }
         try {
             const { sourceCode } = await _class_private_method_get(this, _add, add).call(this, {
@@ -884,7 +891,13 @@ class SnapController extends _basecontroller.BaseControllerV2 {
    * @param options.handler - The handler to trigger on the snap for the request.
    * @param options.request - The JSON-RPC request object.
    * @returns The result of the JSON-RPC request.
-   */ async handleRequest({ snapId, origin, handler: handlerType, request }) {
+   */ async handleRequest({ snapId, origin, handler: handlerType, request: rawRequest }) {
+        const request = {
+            jsonrpc: '2.0',
+            id: (0, _nanoid.nanoid)(),
+            ...rawRequest
+        };
+        (0, _utils.assertIsJsonRpcRequest)(request);
         const permissionName = _endowments.handlerEndowments[handlerType];
         const hasPermission = this.messagingSystem.call('PermissionController:hasPermission', snapId, permissionName);
         if (!hasPermission) {
@@ -912,7 +925,9 @@ class SnapController extends _basecontroller.BaseControllerV2 {
             request
         });
     }
-    constructor({ closeAllConnections, messenger, state, environmentEndowmentPermissions = [], excludedPermissions = {}, idleTimeCheckInterval = (0, _utils.inMilliseconds)(5, _utils.Duration.Second), maxIdleTime = (0, _utils.inMilliseconds)(30, _utils.Duration.Second), maxRequestTime = (0, _utils.inMilliseconds)(60, _utils.Duration.Second), fetchFunction = globalThis.fetch.bind(globalThis), featureFlags = {}, detectSnapLocation: detectSnapLocationFunction = _location.detectSnapLocation }){
+    constructor({ closeAllConnections, messenger, state, dynamicPermissions = [
+        'eth_accounts'
+    ], environmentEndowmentPermissions = [], excludedPermissions = {}, idleTimeCheckInterval = (0, _utils.inMilliseconds)(5, _utils.Duration.Second), maxIdleTime = (0, _utils.inMilliseconds)(30, _utils.Duration.Second), maxRequestTime = (0, _utils.inMilliseconds)(60, _utils.Duration.Second), fetchFunction = globalThis.fetch.bind(globalThis), featureFlags = {}, detectSnapLocation: detectSnapLocationFunction = _location.detectSnapLocation }){
         super({
             messenger,
             metadata: {
@@ -983,6 +998,7 @@ class SnapController extends _basecontroller.BaseControllerV2 {
    * @param snapId - The snap to terminate.
    */ _class_private_method_init(this, _terminateSnap);
         _class_private_method_init(this, _removeSnapFromSubjects);
+        _class_private_method_init(this, _revokeAllSnapPermissions);
         _class_private_method_init(this, _createApproval);
         _class_private_method_init(this, _updateApproval);
         /**
@@ -1058,6 +1074,10 @@ class SnapController extends _basecontroller.BaseControllerV2 {
             writable: true,
             value: void 0
         });
+        _class_private_field_init(this, _dynamicPermissions, {
+            writable: true,
+            value: void 0
+        });
         _class_private_field_init(this, _environmentEndowmentPermissions, {
             writable: true,
             value: void 0
@@ -1103,6 +1123,7 @@ class SnapController extends _basecontroller.BaseControllerV2 {
             value: void 0
         });
         _class_private_field_set(this, _closeAllConnections, closeAllConnections);
+        _class_private_field_set(this, _dynamicPermissions, dynamicPermissions);
         _class_private_field_set(this, _environmentEndowmentPermissions, environmentEndowmentPermissions);
         _class_private_field_set(this, _excludedPermissions, excludedPermissions);
         _class_private_field_set(this, _featureFlags, featureFlags);
@@ -1200,6 +1221,7 @@ function registerMessageHandlers() {
     this.messagingSystem.registerActionHandler(`${controllerName}:decrementActiveReferences`, (...args)=>this.decrementActiveReferences(...args));
     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));
 }
 function pollForLastRequestStatus() {
     _class_private_field_set(this, _timeoutForLastRequestStatus, setTimeout(()=>{
@@ -1270,6 +1292,11 @@ function removeSnapFromSubjects(snapId) {
         this.removeSnapFromSubject(subject, snapId);
     }
 }
+function revokeAllSnapPermissions(snapId) {
+    if (this.messagingSystem.call('PermissionController:hasPermissions', snapId)) {
+        this.messagingSystem.call('PermissionController:revokeAllPermissions', snapId);
+    }
+}
 function createApproval({ origin, snapId, type }) {
     const id = (0, _nanoid.nanoid)();
     const promise = this.messagingSystem.call('ApprovalController:addRequest', {
@@ -1520,24 +1547,12 @@ function getRpcRequestHandler(snapId) {
                 }
             }
         }
-        let _request = request;
-        if (!(0, _utils.hasProperty)(request, 'jsonrpc')) {
-            _request = {
-                ...request,
-                jsonrpc: '2.0'
-            };
-        } else if (request.jsonrpc !== '2.0') {
-            throw _ethrpcerrors.ethErrors.rpc.invalidRequest({
-                message: 'Invalid "jsonrpc" property. Must be "2.0" if provided.',
-                data: request.jsonrpc
-            });
-        }
         const timer = new _Timer.Timer(this.maxRequestTime);
         _class_private_method_get(this, _recordSnapRpcRequestStart, recordSnapRpcRequestStart).call(this, snapId, request.id, timer);
         const handleRpcRequestPromise = this.messagingSystem.call('ExecutionService:handleRpcRequest', snapId, {
             origin,
             handler: handlerType,
-            request: _request
+            request
         });
         // This will either get the result or reject due to the timeout.
         try {