[BREAKING] Move endowments from Controllers to RPC methods (#2155)

This PR is a **BREAKING** change because certain elements are moved from
one package to another and import across the libraries is affected.

### Summary of changes
All endowment related functionalities and specifications are moved from
the `endowments` folder within `snaps-controllers` to the `endowments`
folder located under `snaps-rpc-methods` package and exported from
there.
Export of certain functions from endowments required adjustments to the
index files, so these changes are made as well.
Fixed are related imports of the endowments in another packages affected
(e.g. snaps-simulator).
Code coverage thresholds are adjusted to the new calculations since
there are no functional or logical changes.

### Reasons for the changes
New features being implemented require endowment related specifications
and functionalities, in different packages.

The example of this is Dynamic Permissions feature which require
processing of the raw permission specification in order to request
permission grant to the Permission Controller. This process requires
specific utility functions as well as the caveat mappers or related
specifications which cannot be imported from `snaps-controllers` package
directly into the `snaps-rpc-methods` package.

The best solution for now is to move the endowment related code to the
`snaps-rpc-methods` package and export it from there.

Author: david0xd

packages/snaps-controllers/coverage.json

@@ -1,6 +1,6 @@
 {
-  "branches": 91.4,
-  "functions": 96.93,
-  "lines": 98.01,
-  "statements": 97.73
+  "branches": 91.12,
+  "functions": 96.81,
+  "lines": 97.86,
+  "statements": 97.51
 }

packages/snaps-controllers/src/cronjob/CronjobController.test.ts

@@ -1,10 +1,10 @@
+import { SnapEndowments } from '@metamask/snaps-rpc-methods';
 import type { TruncatedSnap } from '@metamask/snaps-utils';
 import { HandlerType } from '@metamask/snaps-utils';
 import { MOCK_ORIGIN, MOCK_SNAP_ID } from '@metamask/snaps-utils/test-utils';
 import type { SemVerVersion } from '@metamask/utils';
 import { Duration, inMilliseconds } from '@metamask/utils';
 
-import { SnapEndowments } from '../snaps';
 import {
   getRestrictedCronjobControllerMessenger,
   getRootCronjobControllerMessenger,

packages/snaps-controllers/src/cronjob/CronjobController.ts

@@ -1,6 +1,10 @@
 import type { RestrictedControllerMessenger } from '@metamask/base-controller';
 import { BaseController } from '@metamask/base-controller';
 import type { GetPermissions } from '@metamask/permission-controller';
+import {
+  getCronjobCaveatJobs,
+  SnapEndowments,
+} from '@metamask/snaps-rpc-methods';
 import type { SnapId } from '@metamask/snaps-sdk';
 import type {
   TruncatedSnap,
@@ -22,8 +26,7 @@ import type {
   SnapUninstalled,
   SnapUpdated,
 } from '..';
-import { getRunnableSnaps, SnapEndowments } from '..';
-import { getCronjobCaveatJobs } from '../snaps/endowments/cronjob';
+import { getRunnableSnaps } from '..';
 import { Timer } from '../snaps/Timer';
 
 export type CronjobControllerActions =

packages/snaps-controllers/src/snaps/SnapController.test.ts

@@ -10,7 +10,11 @@ import {
   type ValidPermission,
 } from '@metamask/permission-controller';
 import { providerErrors, rpcErrors } from '@metamask/rpc-errors';
-import { WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-rpc-methods';
+import {
+  WALLET_SNAP_PERMISSION_KEY,
+  handlerEndowments,
+  SnapEndowments,
+} from '@metamask/snaps-rpc-methods';
 import type { SnapId } from '@metamask/snaps-sdk';
 import { AuxiliaryFileEncoding, text } from '@metamask/snaps-sdk';
 import type { SnapPermissions, RpcOrigins } from '@metamask/snaps-utils';
@@ -87,7 +91,6 @@ import {
   sleep,
 } from '../test-utils';
 import { delay } from '../utils';
-import { handlerEndowments, SnapEndowments } from './endowments';
 import { SnapsRegistryStatus } from './registry';
 import type { SnapControllerState } from './SnapController';
 import {

packages/snaps-controllers/src/snaps/SnapController.ts

@@ -27,7 +27,15 @@ import type {
 import { SubjectType } from '@metamask/permission-controller';
 import { rpcErrors } from '@metamask/rpc-errors';
 import type { BlockReason } from '@metamask/snaps-registry';
-import { WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-rpc-methods';
+import {
+  WALLET_SNAP_PERMISSION_KEY,
+  getMaxRequestTimeCaveat,
+  handlerEndowments,
+  SnapEndowments,
+  getKeyringCaveatOrigins,
+  getRpcCaveatOrigins,
+  processSnapPermissions,
+} from '@metamask/snaps-rpc-methods';
 import type {
   RequestSnapsParams,
   RequestSnapsResult,
@@ -105,16 +113,8 @@ import type {
 } from '../services';
 import { fetchSnap, hasTimedOut, setDiff, withTimeout } from '../utils';
 import { ALLOWED_PERMISSIONS } from './constants';
-import {
-  getMaxRequestTimeCaveat,
-  handlerEndowments,
-  SnapEndowments,
-} from './endowments';
-import { getKeyringCaveatOrigins } from './endowments/keyring';
-import { getRpcCaveatOrigins } from './endowments/rpc';
 import type { SnapLocation } from './location';
 import { detectSnapLocation } from './location';
-import { processSnapPermissions } from './permissions';
 import type {
   GetMetadata,
   GetResult,

packages/snaps-controllers/src/snaps/constants.ts

@@ -1,4 +1,4 @@
-import { SnapEndowments } from './endowments';
+import { SnapEndowments } from '@metamask/snaps-rpc-methods';
 
 // These permissions are allowed without being on the allowlist.
 export const ALLOWED_PERMISSIONS = Object.freeze([

packages/snaps-controllers/src/snaps/index.ts

@@ -1,6 +1,4 @@
 export * from './location';
 export * from './SnapController';
-export * from './endowments';
 export * from './selectors';
 export * from './registry';
-export * from './permissions';

packages/snaps-controllers/src/test-utils/controller.ts

@@ -8,7 +8,10 @@ import type {
 } from '@metamask/permission-controller';
 import { SubjectType } from '@metamask/permission-controller';
 import { providerErrors } from '@metamask/rpc-errors';
-import { WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-rpc-methods';
+import {
+  SnapEndowments,
+  WALLET_SNAP_PERMISSION_KEY,
+} from '@metamask/snaps-rpc-methods';
 import { text, type SnapId } from '@metamask/snaps-sdk';
 import { SnapCaveatType } from '@metamask/snaps-utils';
 import {
@@ -39,7 +42,7 @@ import type {
   SnapsRegistryActions,
   SnapsRegistryEvents,
 } from '../snaps';
-import { SnapController, SnapEndowments } from '../snaps';
+import { SnapController } from '../snaps';
 import { MOCK_CRONJOB_PERMISSION } from './cronjob';
 import { getNodeEES, getNodeEESMessenger } from './execution-environment';
 import { MockSnapsRegistry } from './registry';

packages/snaps-controllers/src/test-utils/cronjob.ts

@@ -1,9 +1,8 @@
 import type { PermissionConstraint } from '@metamask/permission-controller';
+import { SnapEndowments } from '@metamask/snaps-rpc-methods';
 import { SnapCaveatType } from '@metamask/snaps-utils';
 import { MOCK_ORIGIN } from '@metamask/snaps-utils/test-utils';
 
-import { SnapEndowments } from '../snaps/endowments';
-
 export const MOCK_CRONJOB_PERMISSION: PermissionConstraint = {
   caveats: [
     {

packages/snaps-jest/src/internals/simulation/controllers.ts

@@ -9,10 +9,10 @@ import {
   SubjectType,
 } from '@metamask/permission-controller';
 import {
+  caveatSpecifications as snapsCaveatsSpecifications,
   endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,
   processSnapPermissions,
-} from '@metamask/snaps-controllers';
-import { caveatSpecifications as snapsCaveatsSpecifications } from '@metamask/snaps-rpc-methods';
+} from '@metamask/snaps-rpc-methods';
 import type { SnapManifest } from '@metamask/snaps-utils';
 import { getSafeJson } from '@metamask/utils';
 

packages/snaps-jest/src/internals/simulation/methods/specifications.ts

@@ -1,9 +1,9 @@
 import type { GenericPermissionController } from '@metamask/permission-controller';
 import {
+  endowmentPermissionBuilders,
   buildSnapEndowmentSpecifications,
   buildSnapRestrictedMethodSpecifications,
-  endowmentPermissionBuilders,
-} from '@metamask/snaps-controllers';
+} from '@metamask/snaps-rpc-methods';
 import { DEFAULT_ENDOWMENTS } from '@metamask/snaps-utils';
 
 import type { SimulationOptions } from '../options';

packages/snaps-rpc-methods/jest.config.js

@@ -10,10 +10,10 @@ module.exports = deepmerge(baseConfig, {
   ],
   coverageThreshold: {
     global: {
-      branches: 93.07,
-      functions: 100,
-      lines: 99.2,
-      statements: 97.77,
+      branches: 91.54,
+      functions: 97,
+      lines: 97.53,
+      statements: 97,
     },
   },
 });

packages/snaps-controllers/src/snaps/endowments/caveats/generic.test.ts renamed to packages/snaps-rpc-methods/src/endowments/caveats/generic.test.ts

@@ -116,3 +116,4 @@ export { getTransactionOriginCaveat } from './transaction-insight';
 export { getChainIdsCaveat, getLookupMatchersCaveat } from './name-lookup';
 export { getKeyringCaveatOrigins } from './keyring';
 export { getMaxRequestTimeCaveat } from './caveats';
+export { getCronjobCaveatJobs } from './cronjob';

packages/snaps-controllers/src/snaps/endowments/caveats/generic.ts renamed to packages/snaps-rpc-methods/src/endowments/caveats/generic.ts

@@ -1,8 +1,10 @@
-export type { PermittedRpcMethodHooks } from './permitted';
 export {
   handlers as permittedMethods,
   createSnapsMethodMiddleware,
 } from './permitted';
-export * from './restricted';
+export type { PermittedRpcMethodHooks } from './permitted';
 export { SnapCaveatType } from '@metamask/snaps-utils';
 export { selectHooks } from './utils';
+export * from './endowments';
+export * from './permissions';
+export * from './restricted';

packages/snaps-controllers/src/snaps/endowments/caveats/index.ts renamed to packages/snaps-rpc-methods/src/endowments/caveats/index.ts

@@ -2,18 +2,18 @@ import type {
   PermissionConstraint,
   PermissionSpecificationConstraint,
 } from '@metamask/permission-controller';
-import {
-  caveatMappers,
-  restrictedMethodPermissionBuilders,
-  selectHooks,
-} from '@metamask/snaps-rpc-methods';
 import type { SnapPermissions } from '@metamask/snaps-utils';
 import { hasProperty } from '@metamask/utils';
 
 import {
   endowmentCaveatMappers,
   endowmentPermissionBuilders,
 } from './endowments';
+import {
+  caveatMappers,
+  restrictedMethodPermissionBuilders,
+} from './restricted';
+import { selectHooks } from './utils';
 
 /**
  * Map initial permissions as defined in a Snap manifest to something that can

packages/snaps-controllers/src/snaps/endowments/caveats/requestTime.test.ts renamed to packages/snaps-rpc-methods/src/endowments/caveats/requestTime.test.ts

@@ -1,5 +1,5 @@
 import type { GenericPermissionController } from '@metamask/permission-controller';
-import { processSnapPermissions } from '@metamask/snaps-controllers';
+import { processSnapPermissions } from '@metamask/snaps-rpc-methods';
 import { SnapError } from '@metamask/snaps-sdk';
 import {
   DEFAULT_ENDOWMENTS,

packages/snaps-controllers/src/snaps/endowments/caveats/requestTime.ts renamed to packages/snaps-rpc-methods/src/endowments/caveats/requestTime.ts

@@ -12,15 +12,15 @@ import {
 import {
   IframeExecutionService,
   setupMultiplex,
-  endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,
-  processSnapPermissions,
-  buildSnapEndowmentSpecifications,
-  buildSnapRestrictedMethodSpecifications,
 } from '@metamask/snaps-controllers';
 import packageJson from '@metamask/snaps-execution-environments/package.json';
 import {
   createSnapsMethodMiddleware,
   caveatSpecifications as snapsCaveatsSpecifications,
+  endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,
+  processSnapPermissions,
+  buildSnapEndowmentSpecifications,
+  buildSnapRestrictedMethodSpecifications,
 } from '@metamask/snaps-rpc-methods';
 import type {
   SnapManifest,

packages/snaps-controllers/src/snaps/endowments/cronjob.test.ts renamed to packages/snaps-rpc-methods/src/endowments/cronjob.test.ts

@@ -1,5 +1,5 @@
 import type { GenericPermissionController } from '@metamask/permission-controller';
-import { endowmentPermissionBuilders } from '@metamask/snaps-controllers';
+import { endowmentPermissionBuilders } from '@metamask/snaps-rpc-methods';
 import { DEFAULT_ENDOWMENTS } from '@metamask/snaps-utils';
 
 export const ExcludedSnapEndowments = Object.freeze([]);