@metamask/snaps-simulation 4.1.2 → 4.1.4

package/dist/methods/specifications.mjs

@@ -2,7 +2,7 @@ import { caip25EndowmentBuilder } from "@metamask/chain-agnostic-permission";
 import { endowmentPermissionBuilders, buildSnapEndowmentSpecifications, buildSnapRestrictedMethodSpecifications } from "@metamask/snaps-rpc-methods";
 import { DEFAULT_ENDOWMENTS } from "@metamask/snaps-utils";
 import { EXCLUDED_SNAP_ENDOWMENTS, EXCLUDED_SNAP_PERMISSIONS } from "./constants.mjs";
-import { getGetPreferencesMethodImplementation, getClearSnapStateMethodImplementation, getGetSnapStateMethodImplementation, getUpdateSnapStateMethodImplementation, getShowInAppNotificationImplementation, getShowNativeNotificationImplementation, getCreateInterfaceImplementation, getGetInterfaceImplementation, getRequestUserApprovalImplementation, getSetInterfaceDisplayedImplementation } from "./hooks/index.mjs";
+import { getGetPreferencesMethodImplementation } from "./hooks/index.mjs";
 /**
  * Get a function which resolves with the specified result.
  *
@@ -28,34 +28,25 @@ export function asyncResolve(result) {
  * @param options - The options.
  * @param options.controllerMessenger - The controller messenger.
  * @param options.hooks - The hooks.
- * @param options.runSaga - The function to run a saga outside the usual Redux
- * flow.
  * @param options.options - The simulation options.
  * @returns The permission specifications for the Snap.
  */
-export function getPermissionSpecifications({ controllerMessenger, hooks, runSaga, options, }) {
+export function getPermissionSpecifications({ controllerMessenger, hooks, options, }) {
+    const { getClientCryptography } = hooks;
     return {
         [caip25EndowmentBuilder.targetName]: caip25EndowmentBuilder.specificationBuilder({}),
         ...buildSnapEndowmentSpecifications(EXCLUDED_SNAP_ENDOWMENTS),
         ...buildSnapRestrictedMethodSpecifications(EXCLUDED_SNAP_PERMISSIONS, {
             // Shared hooks.
-            ...hooks,
+            getClientCryptography,
             // Snaps-specific hooks.
-            clearSnapState: getClearSnapStateMethodImplementation(runSaga),
             getPreferences: getGetPreferencesMethodImplementation(options),
-            getSnapState: getGetSnapStateMethodImplementation(runSaga),
             getUnlockPromise: asyncResolve(true),
+            getSnapKeyring: asyncResolve(null),
             // TODO: Allow the user to specify the result of this function.
             isOnPhishingList: resolve(false),
             maybeUpdatePhishingList: asyncResolve(),
-            requestUserApproval: getRequestUserApprovalImplementation(runSaga),
-            showInAppNotification: getShowInAppNotificationImplementation(runSaga),
-            showNativeNotification: getShowNativeNotificationImplementation(runSaga),
-            updateSnapState: getUpdateSnapStateMethodImplementation(runSaga),
-            createInterface: getCreateInterfaceImplementation(controllerMessenger),
-            getInterface: getGetInterfaceImplementation(controllerMessenger),
-            setInterfaceDisplayed: getSetInterfaceDisplayedImplementation(controllerMessenger),
-        }),
+        }, controllerMessenger),
     };
 }
 /**

package/dist/methods/specifications.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"specifications.mjs","sourceRoot":"","sources":["../../src/methods/specifications.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,4CAA4C;AAE7E,OAAO,EACL,2BAA2B,EAC3B,gCAAgC,EAChC,uCAAuC,EACxC,oCAAoC;AAErC,OAAO,EAAE,kBAAkB,EAAE,8BAA8B;AAE3D,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EAC1B,wBAAoB;AACrB,OAAO,EACL,qCAAqC,EACrC,qCAAqC,EACrC,mCAAmC,EACnC,sCAAsC,EACtC,sCAAsC,EACtC,uCAAuC,EACvC,gCAAgC,EAChC,6BAA6B,EAC7B,oCAAoC,EACpC,sCAAsC,EACvC,0BAAgB;AAqBjB;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,MAAe;IACrC,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAO,MAAa;IAC9C,OAAO,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,2BAA2B,CAAC,EAC1C,mBAAmB,EACnB,KAAK,EACL,OAAO,EACP,OAAO,GAC4B;IACnC,OAAO;QACL,CAAC,sBAAsB,CAAC,UAAU,CAAC,EACjC,sBAAsB,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACjD,GAAG,gCAAgC,CAAC,wBAAwB,CAAC;QAC7D,GAAG,uCAAuC,CAAC,yBAAyB,EAAE;YACpE,gBAAgB;YAChB,GAAG,KAAK;YAER,wBAAwB;YACxB,cAAc,EAAE,qCAAqC,CAAC,OAAO,CAAC;YAC9D,cAAc,EAAE,qCAAqC,CAAC,OAAO,CAAC;YAC9D,YAAY,EAAE,mCAAmC,CAAC,OAAO,CAAC;YAC1D,gBAAgB,EAAE,YAAY,CAAC,IAAI,CAAC;YAEpC,+DAA+D;YAC/D,gBAAgB,EAAE,OAAO,CAAC,KAAK,CAAC;YAEhC,uBAAuB,EAAE,YAAY,EAAE;YACvC,mBAAmB,EAAE,oCAAoC,CAAC,OAAO,CAAC;YAClE,qBAAqB,EAAE,sCAAsC,CAAC,OAAO,CAAC;YACtE,sBAAsB,EAAE,uCAAuC,CAAC,OAAO,CAAC;YACxE,eAAe,EAAE,sCAAsC,CAAC,OAAO,CAAC;YAChE,eAAe,EAAE,gCAAgC,CAAC,mBAAmB,CAAC;YACtE,YAAY,EAAE,6BAA6B,CAAC,mBAAmB,CAAC;YAChE,qBAAqB,EACnB,sCAAsC,CAAC,mBAAmB,CAAC;SAC9D,CAAC;KACH,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,oBAAiD,EACjD,MAAc;IAEd,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,MAAM,CAEzE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE;QAClC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC;QAClC,IAAI,oBAAoB,CAAC,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,MAAM,oBAAoB,CAAC,aAAa,CACzD,MAAM,EACN,cAAc,CACf,CAAC;YAEF,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO,WAAW,CAAC,MAAM,CAAC,UAAsB,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAExB,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,kBAAkB,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AACjE,CAAC","sourcesContent":["import { caip25EndowmentBuilder } from '@metamask/chain-agnostic-permission';\nimport type { GenericPermissionController } from '@metamask/permission-controller';\nimport {\n  endowmentPermissionBuilders,\n  buildSnapEndowmentSpecifications,\n  buildSnapRestrictedMethodSpecifications,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { DEFAULT_ENDOWMENTS } from '@metamask/snaps-utils';\n\nimport {\n  EXCLUDED_SNAP_ENDOWMENTS,\n  EXCLUDED_SNAP_PERMISSIONS,\n} from './constants';\nimport {\n  getGetPreferencesMethodImplementation,\n  getClearSnapStateMethodImplementation,\n  getGetSnapStateMethodImplementation,\n  getUpdateSnapStateMethodImplementation,\n  getShowInAppNotificationImplementation,\n  getShowNativeNotificationImplementation,\n  getCreateInterfaceImplementation,\n  getGetInterfaceImplementation,\n  getRequestUserApprovalImplementation,\n  getSetInterfaceDisplayedImplementation,\n} from './hooks';\nimport type { RootControllerMessenger } from '../controllers';\nimport type { SimulationOptions } from '../options';\nimport type { RunSagaFunction } from '../store';\n\nexport type PermissionSpecificationsHooks = {\n  /**\n   * A hook that returns the user's secret recovery phrase.\n   *\n   * @returns The user's secret recovery phrase.\n   */\n  getMnemonic: () => Promise<Uint8Array>;\n};\n\nexport type GetPermissionSpecificationsOptions = {\n  controllerMessenger: RootControllerMessenger;\n  hooks: PermissionSpecificationsHooks;\n  runSaga: RunSagaFunction;\n  options: SimulationOptions;\n};\n\n/**\n * Get a function which resolves with the specified result.\n *\n * @param result - The result to return.\n * @returns The function implementation.\n */\nexport function resolve(result: unknown) {\n  return () => result;\n}\n\n/**\n * Get a function which resolves with the specified result.\n *\n * @param result - The result to return. If not specified, the function will\n * resolve with `undefined`.\n * @returns The function implementation.\n */\nexport function asyncResolve<Type>(result?: Type) {\n  return async () => result;\n}\n\n/**\n * Get the permission specifications for the Snap.\n *\n * @param options - The options.\n * @param options.controllerMessenger - The controller messenger.\n * @param options.hooks - The hooks.\n * @param options.runSaga - The function to run a saga outside the usual Redux\n * flow.\n * @param options.options - The simulation options.\n * @returns The permission specifications for the Snap.\n */\nexport function getPermissionSpecifications({\n  controllerMessenger,\n  hooks,\n  runSaga,\n  options,\n}: GetPermissionSpecificationsOptions) {\n  return {\n    [caip25EndowmentBuilder.targetName]:\n      caip25EndowmentBuilder.specificationBuilder({}),\n    ...buildSnapEndowmentSpecifications(EXCLUDED_SNAP_ENDOWMENTS),\n    ...buildSnapRestrictedMethodSpecifications(EXCLUDED_SNAP_PERMISSIONS, {\n      // Shared hooks.\n      ...hooks,\n\n      // Snaps-specific hooks.\n      clearSnapState: getClearSnapStateMethodImplementation(runSaga),\n      getPreferences: getGetPreferencesMethodImplementation(options),\n      getSnapState: getGetSnapStateMethodImplementation(runSaga),\n      getUnlockPromise: asyncResolve(true),\n\n      // TODO: Allow the user to specify the result of this function.\n      isOnPhishingList: resolve(false),\n\n      maybeUpdatePhishingList: asyncResolve(),\n      requestUserApproval: getRequestUserApprovalImplementation(runSaga),\n      showInAppNotification: getShowInAppNotificationImplementation(runSaga),\n      showNativeNotification: getShowNativeNotificationImplementation(runSaga),\n      updateSnapState: getUpdateSnapStateMethodImplementation(runSaga),\n      createInterface: getCreateInterfaceImplementation(controllerMessenger),\n      getInterface: getGetInterfaceImplementation(controllerMessenger),\n      setInterfaceDisplayed:\n        getSetInterfaceDisplayedImplementation(controllerMessenger),\n    }),\n  };\n}\n\n/**\n * Get the endowments for the Snap.\n *\n * @param permissionController - The permission controller.\n * @param snapId - The ID of the Snap.\n * @returns The endowments for the Snap.\n */\nexport async function getEndowments(\n  permissionController: GenericPermissionController,\n  snapId: SnapId,\n) {\n  const allEndowments = await Object.keys(endowmentPermissionBuilders).reduce<\n    Promise<string[]>\n  >(async (promise, permissionName) => {\n    const accumulator = await promise;\n    if (permissionController.hasPermission(snapId, permissionName)) {\n      const endowments = await permissionController.getEndowments(\n        snapId,\n        permissionName,\n      );\n\n      if (endowments) {\n        return accumulator.concat(endowments as string[]);\n      }\n    }\n\n    return accumulator;\n  }, Promise.resolve([]));\n\n  return [...new Set([...DEFAULT_ENDOWMENTS, ...allEndowments])];\n}\n"]}
+{"version":3,"file":"specifications.mjs","sourceRoot":"","sources":["../../src/methods/specifications.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,4CAA4C;AAQ7E,OAAO,EACL,2BAA2B,EAC3B,gCAAgC,EAChC,uCAAuC,EACxC,oCAAoC;AAErC,OAAO,EAAE,kBAAkB,EAAE,8BAA8B;AAE3D,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EAC1B,wBAAoB;AACrB,OAAO,EAAE,qCAAqC,EAAE,0BAAgB;AAoBhE;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,MAAe;IACrC,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAO,MAAa;IAC9C,OAAO,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC;AAC5B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CAAC,EAC1C,mBAAmB,EACnB,KAAK,EACL,OAAO,GAC4B;IACnC,MAAM,EAAE,qBAAqB,EAAE,GAAG,KAAK,CAAC;IACxC,OAAO;QACL,CAAC,sBAAsB,CAAC,UAAU,CAAC,EACjC,sBAAsB,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACjD,GAAG,gCAAgC,CAAC,wBAAwB,CAAC;QAC7D,GAAG,uCAAuC,CACxC,yBAAyB,EACzB;YACE,gBAAgB;YAChB,qBAAqB;YAErB,wBAAwB;YACxB,cAAc,EAAE,qCAAqC,CAAC,OAAO,CAAC;YAC9D,gBAAgB,EAAE,YAAY,CAAC,IAAI,CAAC;YACpC,cAAc,EAAE,YAAY,CAAC,IAAI,CAAC;YAElC,+DAA+D;YAC/D,gBAAgB,EAAE,OAAO,CAAC,KAAK,CAAC;YAEhC,uBAAuB,EAAE,YAAY,EAAE;SACxC,EACD,mBAAgD,CACjD;KACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,oBAAiD,EACjD,MAAc;IAEd,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,MAAM,CAEzE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE;QAClC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC;QAClC,IAAI,oBAAoB,CAAC,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,MAAM,oBAAoB,CAAC,aAAa,CACzD,MAAM,EACN,cAAc,CACf,CAAC;YAEF,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO,WAAW,CAAC,MAAM,CAAC,UAAsB,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAExB,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,kBAAkB,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AACjE,CAAC","sourcesContent":["import { caip25EndowmentBuilder } from '@metamask/chain-agnostic-permission';\nimport type { CryptographicFunctions } from '@metamask/key-tree';\nimport type {\n  GenericPermissionController,\n  PermissionSpecificationConstraint,\n  PermissionSpecificationMap,\n} from '@metamask/permission-controller';\nimport type { RestrictedMethodMessenger } from '@metamask/snaps-rpc-methods';\nimport {\n  endowmentPermissionBuilders,\n  buildSnapEndowmentSpecifications,\n  buildSnapRestrictedMethodSpecifications,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { DEFAULT_ENDOWMENTS } from '@metamask/snaps-utils';\n\nimport {\n  EXCLUDED_SNAP_ENDOWMENTS,\n  EXCLUDED_SNAP_PERMISSIONS,\n} from './constants';\nimport { getGetPreferencesMethodImplementation } from './hooks';\nimport type { RootControllerMessenger } from '../controllers';\nimport type { SimulationOptions } from '../options';\n\nexport type PermissionSpecificationsHooks = {\n  /**\n   * Get the cryptographic functions to use for the client. This may return an\n   * empty object to fall back to the default cryptographic functions.\n   *\n   * @returns The cryptographic functions to use for the client.\n   */\n  getClientCryptography: () => CryptographicFunctions;\n};\n\nexport type GetPermissionSpecificationsOptions = {\n  controllerMessenger: RootControllerMessenger;\n  hooks: PermissionSpecificationsHooks;\n  options: SimulationOptions;\n};\n\n/**\n * Get a function which resolves with the specified result.\n *\n * @param result - The result to return.\n * @returns The function implementation.\n */\nexport function resolve(result: unknown) {\n  return () => result;\n}\n\n/**\n * Get a function which resolves with the specified result.\n *\n * @param result - The result to return. If not specified, the function will\n * resolve with `undefined`.\n * @returns The function implementation.\n */\nexport function asyncResolve<Type>(result?: Type) {\n  return async () => result;\n}\n\n/**\n * Get the permission specifications for the Snap.\n *\n * @param options - The options.\n * @param options.controllerMessenger - The controller messenger.\n * @param options.hooks - The hooks.\n * @param options.options - The simulation options.\n * @returns The permission specifications for the Snap.\n */\nexport function getPermissionSpecifications({\n  controllerMessenger,\n  hooks,\n  options,\n}: GetPermissionSpecificationsOptions): PermissionSpecificationMap<PermissionSpecificationConstraint> {\n  const { getClientCryptography } = hooks;\n  return {\n    [caip25EndowmentBuilder.targetName]:\n      caip25EndowmentBuilder.specificationBuilder({}),\n    ...buildSnapEndowmentSpecifications(EXCLUDED_SNAP_ENDOWMENTS),\n    ...buildSnapRestrictedMethodSpecifications(\n      EXCLUDED_SNAP_PERMISSIONS,\n      {\n        // Shared hooks.\n        getClientCryptography,\n\n        // Snaps-specific hooks.\n        getPreferences: getGetPreferencesMethodImplementation(options),\n        getUnlockPromise: asyncResolve(true),\n        getSnapKeyring: asyncResolve(null),\n\n        // TODO: Allow the user to specify the result of this function.\n        isOnPhishingList: resolve(false),\n\n        maybeUpdatePhishingList: asyncResolve(),\n      },\n      controllerMessenger as RestrictedMethodMessenger,\n    ),\n  };\n}\n\n/**\n * Get the endowments for the Snap.\n *\n * @param permissionController - The permission controller.\n * @param snapId - The ID of the Snap.\n * @returns The endowments for the Snap.\n */\nexport async function getEndowments(\n  permissionController: GenericPermissionController,\n  snapId: SnapId,\n) {\n  const allEndowments = await Object.keys(endowmentPermissionBuilders).reduce<\n    Promise<string[]>\n  >(async (promise, permissionName) => {\n    const accumulator = await promise;\n    if (permissionController.hasPermission(snapId, permissionName)) {\n      const endowments = await permissionController.getEndowments(\n        snapId,\n        permissionName,\n      );\n\n      if (endowments) {\n        return accumulator.concat(endowments as string[]);\n      }\n    }\n\n    return accumulator;\n  }, Promise.resolve([]));\n\n  return [...new Set([...DEFAULT_ENDOWMENTS, ...allEndowments])];\n}\n"]}

package/dist/middleware/engine.cjs

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createJsonRpcEngine = void 0;
 const json_rpc_engine_1 = require("@metamask/json-rpc-engine");
+const permission_controller_1 = require("@metamask/permission-controller");
 const snaps_rpc_methods_1 = require("@metamask/snaps-rpc-methods");
 const internal_methods_1 = require("./internal-methods/index.cjs");
 const mock_1 = require("./mock.cjs");
@@ -14,23 +15,26 @@ const provider_1 = require("./provider.cjs");
  * well as Snap-specific requests.
  *
  * @param options - The options to use when creating the engine.
+ * @param options.snapId - The Snap ID.
+ * @param options.messenger - The messenger.
  * @param options.store - The Redux store to use.
  * @param options.restrictedHooks - Any hooks used by the middleware handlers.
  * @param options.permittedHooks - Any hooks used by the middleware handlers.
- * @param options.permissionMiddleware - The permission middleware to use.
  * @param options.multichainHooks - Hooks used by the multichain middleware.
  * @param options.isMultichain - Whether the engine is used for multichain.
  * @returns A JSON-RPC engine.
  */
-function createJsonRpcEngine({ store, restrictedHooks, permittedHooks, permissionMiddleware, multichainHooks, isMultichain, }) {
+function createJsonRpcEngine({ snapId, messenger, store, restrictedHooks, permittedHooks, multichainHooks, isMultichain, }) {
     const engine = new json_rpc_engine_1.JsonRpcEngine();
+    engine.push((0, json_rpc_engine_1.createOriginMiddleware)(snapId));
     engine.push((0, multichain_1.createMultichainMiddleware)(isMultichain, multichainHooks));
     engine.push((0, mock_1.createMockMiddleware)(store));
     // The hooks here do not match the hooks used by the clients, so this
     // middleware should not be used outside of the simulation environment.
     engine.push((0, internal_methods_1.createInternalMethodsMiddleware)(restrictedHooks));
-    engine.push((0, snaps_rpc_methods_1.createSnapsMethodMiddleware)(true, permittedHooks));
-    engine.push(permissionMiddleware);
+    // @ts-expect-error Hooks type mismatch.
+    engine.push((0, snaps_rpc_methods_1.createSnapsMethodMiddleware)(true, permittedHooks, messenger));
+    engine.push((0, permission_controller_1.createPermissionMiddleware)({ messenger, origin: snapId }));
     engine.push((0, provider_1.createProviderMiddleware)(store));
     return engine;
 }

package/dist/middleware/engine.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"engine.cjs","sourceRoot":"","sources":["../../src/middleware/engine.ts"],"names":[],"mappings":";;;AACA,+DAA0D;AAE1D,mEAA0E;AAG1E,mEAAqE;AACrE,qCAA8C;AAC9C,uDAA0D;AAC1D,6CAAsD;AAkBtD;;;;;;;;;;;;;;GAcG;AACH,SAAgB,mBAAmB,CAAC,EAClC,KAAK,EACL,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,YAAY,GACe;IAC3B,MAAM,MAAM,GAAG,IAAI,+BAAa,EAAE,CAAC;IAEnC,MAAM,CAAC,IAAI,CAAC,IAAA,uCAA0B,EAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;IAEvE,MAAM,CAAC,IAAI,CAAC,IAAA,2BAAoB,EAAC,KAAK,CAAC,CAAC,CAAC;IAEzC,qEAAqE;IACrE,uEAAuE;IACvE,MAAM,CAAC,IAAI,CAAC,IAAA,kDAA+B,EAAC,eAAe,CAAC,CAAC,CAAC;IAC9D,MAAM,CAAC,IAAI,CAAC,IAAA,+CAA2B,EAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;IAE/D,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAClC,MAAM,CAAC,IAAI,CAAC,IAAA,mCAAwB,EAAC,KAAK,CAAC,CAAC,CAAC;IAE7C,OAAO,MAAM,CAAC;AAChB,CAAC;AAvBD,kDAuBC","sourcesContent":["import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { JsonRpcEngine } from '@metamask/json-rpc-engine';\nimport type { RestrictedMethodParameters } from '@metamask/permission-controller';\nimport { createSnapsMethodMiddleware } from '@metamask/snaps-rpc-methods';\nimport type { Json } from '@metamask/utils';\n\nimport { createInternalMethodsMiddleware } from './internal-methods';\nimport { createMockMiddleware } from './mock';\nimport { createMultichainMiddleware } from './multichain';\nimport { createProviderMiddleware } from './provider';\nimport type {\n  MultichainMiddlewareHooks,\n  PermittedMiddlewareHooks,\n  RestrictedMiddlewareHooks,\n} from '../simulation';\nimport type { Store } from '../store';\n\nexport type CreateJsonRpcEngineOptions = {\n  store: Store;\n  restrictedHooks: RestrictedMiddlewareHooks;\n  permittedHooks: PermittedMiddlewareHooks;\n  multichainHooks: MultichainMiddlewareHooks;\n  permissionMiddleware: JsonRpcMiddleware<RestrictedMethodParameters, Json>;\n  endpoint?: string;\n  isMultichain: boolean;\n};\n\n/**\n * Create a JSON-RPC engine for use in a simulated environment. This engine\n * should be used to handle all JSON-RPC requests. It is set up to handle\n * requests that would normally be handled internally by the MetaMask client, as\n * well as Snap-specific requests.\n *\n * @param options - The options to use when creating the engine.\n * @param options.store - The Redux store to use.\n * @param options.restrictedHooks - Any hooks used by the middleware handlers.\n * @param options.permittedHooks - Any hooks used by the middleware handlers.\n * @param options.permissionMiddleware - The permission middleware to use.\n * @param options.multichainHooks - Hooks used by the multichain middleware.\n * @param options.isMultichain - Whether the engine is used for multichain.\n * @returns A JSON-RPC engine.\n */\nexport function createJsonRpcEngine({\n  store,\n  restrictedHooks,\n  permittedHooks,\n  permissionMiddleware,\n  multichainHooks,\n  isMultichain,\n}: CreateJsonRpcEngineOptions) {\n  const engine = new JsonRpcEngine();\n\n  engine.push(createMultichainMiddleware(isMultichain, multichainHooks));\n\n  engine.push(createMockMiddleware(store));\n\n  // The hooks here do not match the hooks used by the clients, so this\n  // middleware should not be used outside of the simulation environment.\n  engine.push(createInternalMethodsMiddleware(restrictedHooks));\n  engine.push(createSnapsMethodMiddleware(true, permittedHooks));\n\n  engine.push(permissionMiddleware);\n  engine.push(createProviderMiddleware(store));\n\n  return engine;\n}\n"]}
+{"version":3,"file":"engine.cjs","sourceRoot":"","sources":["../../src/middleware/engine.ts"],"names":[],"mappings":";;;AAAA,+DAGmC;AACnC,2EAA6E;AAC7E,mEAA0E;AAG1E,mEAAqE;AACrE,qCAA8C;AAC9C,uDAA0D;AAC1D,6CAAsD;AAoBtD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,mBAAmB,CAAC,EAClC,MAAM,EACN,SAAS,EACT,KAAK,EACL,eAAe,EACf,cAAc,EACd,eAAe,EACf,YAAY,GACe;IAC3B,MAAM,MAAM,GAAG,IAAI,+BAAa,EAAE,CAAC;IAEnC,MAAM,CAAC,IAAI,CAAC,IAAA,wCAAsB,EAAC,MAAM,CAAC,CAAC,CAAC;IAE5C,MAAM,CAAC,IAAI,CAAC,IAAA,uCAA0B,EAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;IAEvE,MAAM,CAAC,IAAI,CAAC,IAAA,2BAAoB,EAAC,KAAK,CAAC,CAAC,CAAC;IAEzC,qEAAqE;IACrE,uEAAuE;IACvE,MAAM,CAAC,IAAI,CAAC,IAAA,kDAA+B,EAAC,eAAe,CAAC,CAAC,CAAC;IAE9D,wCAAwC;IACxC,MAAM,CAAC,IAAI,CAAC,IAAA,+CAA2B,EAAC,IAAI,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC;IAE1E,MAAM,CAAC,IAAI,CAAC,IAAA,kDAA0B,EAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACvE,MAAM,CAAC,IAAI,CAAC,IAAA,mCAAwB,EAAC,KAAK,CAAC,CAAC,CAAC;IAE7C,OAAO,MAAM,CAAC;AAChB,CAAC;AA5BD,kDA4BC","sourcesContent":["import {\n  JsonRpcEngine,\n  createOriginMiddleware,\n} from '@metamask/json-rpc-engine';\nimport { createPermissionMiddleware } from '@metamask/permission-controller';\nimport { createSnapsMethodMiddleware } from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\n\nimport { createInternalMethodsMiddleware } from './internal-methods';\nimport { createMockMiddleware } from './mock';\nimport { createMultichainMiddleware } from './multichain';\nimport { createProviderMiddleware } from './provider';\nimport type { RootControllerMessenger } from '../controllers';\nimport type {\n  MultichainMiddlewareHooks,\n  PermittedMiddlewareHooks,\n  RestrictedMiddlewareHooks,\n} from '../simulation';\nimport type { Store } from '../store';\n\nexport type CreateJsonRpcEngineOptions = {\n  snapId: SnapId;\n  messenger: RootControllerMessenger;\n  store: Store;\n  restrictedHooks: RestrictedMiddlewareHooks;\n  permittedHooks: PermittedMiddlewareHooks;\n  multichainHooks: MultichainMiddlewareHooks;\n  endpoint?: string;\n  isMultichain: boolean;\n};\n\n/**\n * Create a JSON-RPC engine for use in a simulated environment. This engine\n * should be used to handle all JSON-RPC requests. It is set up to handle\n * requests that would normally be handled internally by the MetaMask client, as\n * well as Snap-specific requests.\n *\n * @param options - The options to use when creating the engine.\n * @param options.snapId - The Snap ID.\n * @param options.messenger - The messenger.\n * @param options.store - The Redux store to use.\n * @param options.restrictedHooks - Any hooks used by the middleware handlers.\n * @param options.permittedHooks - Any hooks used by the middleware handlers.\n * @param options.multichainHooks - Hooks used by the multichain middleware.\n * @param options.isMultichain - Whether the engine is used for multichain.\n * @returns A JSON-RPC engine.\n */\nexport function createJsonRpcEngine({\n  snapId,\n  messenger,\n  store,\n  restrictedHooks,\n  permittedHooks,\n  multichainHooks,\n  isMultichain,\n}: CreateJsonRpcEngineOptions) {\n  const engine = new JsonRpcEngine();\n\n  engine.push(createOriginMiddleware(snapId));\n\n  engine.push(createMultichainMiddleware(isMultichain, multichainHooks));\n\n  engine.push(createMockMiddleware(store));\n\n  // The hooks here do not match the hooks used by the clients, so this\n  // middleware should not be used outside of the simulation environment.\n  engine.push(createInternalMethodsMiddleware(restrictedHooks));\n\n  // @ts-expect-error Hooks type mismatch.\n  engine.push(createSnapsMethodMiddleware(true, permittedHooks, messenger));\n\n  engine.push(createPermissionMiddleware({ messenger, origin: snapId }));\n  engine.push(createProviderMiddleware(store));\n\n  return engine;\n}\n"]}

package/dist/middleware/engine.d.cts

@@ -1,15 +1,15 @@
-import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
 import { JsonRpcEngine } from "@metamask/json-rpc-engine";
-import type { RestrictedMethodParameters } from "@metamask/permission-controller";
-import type { Json } from "@metamask/utils";
+import type { SnapId } from "@metamask/snaps-sdk";
+import type { RootControllerMessenger } from "../controllers.cjs";
 import type { MultichainMiddlewareHooks, PermittedMiddlewareHooks, RestrictedMiddlewareHooks } from "../simulation.cjs";
 import type { Store } from "../store/index.cjs";
 export type CreateJsonRpcEngineOptions = {
+    snapId: SnapId;
+    messenger: RootControllerMessenger;
     store: Store;
     restrictedHooks: RestrictedMiddlewareHooks;
     permittedHooks: PermittedMiddlewareHooks;
     multichainHooks: MultichainMiddlewareHooks;
-    permissionMiddleware: JsonRpcMiddleware<RestrictedMethodParameters, Json>;
     endpoint?: string;
     isMultichain: boolean;
 };
@@ -20,13 +20,14 @@ export type CreateJsonRpcEngineOptions = {
  * well as Snap-specific requests.
  *
  * @param options - The options to use when creating the engine.
+ * @param options.snapId - The Snap ID.
+ * @param options.messenger - The messenger.
  * @param options.store - The Redux store to use.
  * @param options.restrictedHooks - Any hooks used by the middleware handlers.
  * @param options.permittedHooks - Any hooks used by the middleware handlers.
- * @param options.permissionMiddleware - The permission middleware to use.
  * @param options.multichainHooks - Hooks used by the multichain middleware.
  * @param options.isMultichain - Whether the engine is used for multichain.
  * @returns A JSON-RPC engine.
  */
-export declare function createJsonRpcEngine({ store, restrictedHooks, permittedHooks, permissionMiddleware, multichainHooks, isMultichain, }: CreateJsonRpcEngineOptions): JsonRpcEngine;
+export declare function createJsonRpcEngine({ snapId, messenger, store, restrictedHooks, permittedHooks, multichainHooks, isMultichain, }: CreateJsonRpcEngineOptions): JsonRpcEngine;
 //# sourceMappingURL=engine.d.cts.map

package/dist/middleware/engine.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"engine.d.cts","sourceRoot":"","sources":["../../src/middleware/engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,kCAAkC;AACnE,OAAO,EAAE,aAAa,EAAE,kCAAkC;AAC1D,OAAO,KAAK,EAAE,0BAA0B,EAAE,wCAAwC;AAElF,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAM5C,OAAO,KAAK,EACV,yBAAyB,EACzB,wBAAwB,EACxB,yBAAyB,EAC1B,0BAAsB;AACvB,OAAO,KAAK,EAAE,KAAK,EAAE,2BAAiB;AAEtC,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,KAAK,CAAC;IACb,eAAe,EAAE,yBAAyB,CAAC;IAC3C,cAAc,EAAE,wBAAwB,CAAC;IACzC,eAAe,EAAE,yBAAyB,CAAC;IAC3C,oBAAoB,EAAE,iBAAiB,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAC;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,KAAK,EACL,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,YAAY,GACb,EAAE,0BAA0B,iBAgB5B"}
+{"version":3,"file":"engine.d.cts","sourceRoot":"","sources":["../../src/middleware/engine.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAEd,kCAAkC;AAGnC,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAMlD,OAAO,KAAK,EAAE,uBAAuB,EAAE,2BAAuB;AAC9D,OAAO,KAAK,EACV,yBAAyB,EACzB,wBAAwB,EACxB,yBAAyB,EAC1B,0BAAsB;AACvB,OAAO,KAAK,EAAE,KAAK,EAAE,2BAAiB;AAEtC,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,uBAAuB,CAAC;IACnC,KAAK,EAAE,KAAK,CAAC;IACb,eAAe,EAAE,yBAAyB,CAAC;IAC3C,cAAc,EAAE,wBAAwB,CAAC;IACzC,eAAe,EAAE,yBAAyB,CAAC;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,MAAM,EACN,SAAS,EACT,KAAK,EACL,eAAe,EACf,cAAc,EACd,eAAe,EACf,YAAY,GACb,EAAE,0BAA0B,iBAoB5B"}

package/dist/middleware/engine.d.mts

@@ -1,15 +1,15 @@
-import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
 import { JsonRpcEngine } from "@metamask/json-rpc-engine";
-import type { RestrictedMethodParameters } from "@metamask/permission-controller";
-import type { Json } from "@metamask/utils";
+import type { SnapId } from "@metamask/snaps-sdk";
+import type { RootControllerMessenger } from "../controllers.mjs";
 import type { MultichainMiddlewareHooks, PermittedMiddlewareHooks, RestrictedMiddlewareHooks } from "../simulation.mjs";
 import type { Store } from "../store/index.mjs";
 export type CreateJsonRpcEngineOptions = {
+    snapId: SnapId;
+    messenger: RootControllerMessenger;
     store: Store;
     restrictedHooks: RestrictedMiddlewareHooks;
     permittedHooks: PermittedMiddlewareHooks;
     multichainHooks: MultichainMiddlewareHooks;
-    permissionMiddleware: JsonRpcMiddleware<RestrictedMethodParameters, Json>;
     endpoint?: string;
     isMultichain: boolean;
 };
@@ -20,13 +20,14 @@ export type CreateJsonRpcEngineOptions = {
  * well as Snap-specific requests.
  *
  * @param options - The options to use when creating the engine.
+ * @param options.snapId - The Snap ID.
+ * @param options.messenger - The messenger.
  * @param options.store - The Redux store to use.
  * @param options.restrictedHooks - Any hooks used by the middleware handlers.
  * @param options.permittedHooks - Any hooks used by the middleware handlers.
- * @param options.permissionMiddleware - The permission middleware to use.
  * @param options.multichainHooks - Hooks used by the multichain middleware.
  * @param options.isMultichain - Whether the engine is used for multichain.
  * @returns A JSON-RPC engine.
  */
-export declare function createJsonRpcEngine({ store, restrictedHooks, permittedHooks, permissionMiddleware, multichainHooks, isMultichain, }: CreateJsonRpcEngineOptions): JsonRpcEngine;
+export declare function createJsonRpcEngine({ snapId, messenger, store, restrictedHooks, permittedHooks, multichainHooks, isMultichain, }: CreateJsonRpcEngineOptions): JsonRpcEngine;
 //# sourceMappingURL=engine.d.mts.map

package/dist/middleware/engine.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"engine.d.mts","sourceRoot":"","sources":["../../src/middleware/engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,kCAAkC;AACnE,OAAO,EAAE,aAAa,EAAE,kCAAkC;AAC1D,OAAO,KAAK,EAAE,0BAA0B,EAAE,wCAAwC;AAElF,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAM5C,OAAO,KAAK,EACV,yBAAyB,EACzB,wBAAwB,EACxB,yBAAyB,EAC1B,0BAAsB;AACvB,OAAO,KAAK,EAAE,KAAK,EAAE,2BAAiB;AAEtC,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,KAAK,CAAC;IACb,eAAe,EAAE,yBAAyB,CAAC;IAC3C,cAAc,EAAE,wBAAwB,CAAC;IACzC,eAAe,EAAE,yBAAyB,CAAC;IAC3C,oBAAoB,EAAE,iBAAiB,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAC;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,KAAK,EACL,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,YAAY,GACb,EAAE,0BAA0B,iBAgB5B"}
+{"version":3,"file":"engine.d.mts","sourceRoot":"","sources":["../../src/middleware/engine.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAEd,kCAAkC;AAGnC,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAMlD,OAAO,KAAK,EAAE,uBAAuB,EAAE,2BAAuB;AAC9D,OAAO,KAAK,EACV,yBAAyB,EACzB,wBAAwB,EACxB,yBAAyB,EAC1B,0BAAsB;AACvB,OAAO,KAAK,EAAE,KAAK,EAAE,2BAAiB;AAEtC,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,uBAAuB,CAAC;IACnC,KAAK,EAAE,KAAK,CAAC;IACb,eAAe,EAAE,yBAAyB,CAAC;IAC3C,cAAc,EAAE,wBAAwB,CAAC;IACzC,eAAe,EAAE,yBAAyB,CAAC;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,MAAM,EACN,SAAS,EACT,KAAK,EACL,eAAe,EACf,cAAc,EACd,eAAe,EACf,YAAY,GACb,EAAE,0BAA0B,iBAoB5B"}

package/dist/middleware/engine.mjs

@@ -1,4 +1,5 @@
-import { JsonRpcEngine } from "@metamask/json-rpc-engine";
+import { JsonRpcEngine, createOriginMiddleware } from "@metamask/json-rpc-engine";
+import { createPermissionMiddleware } from "@metamask/permission-controller";
 import { createSnapsMethodMiddleware } from "@metamask/snaps-rpc-methods";
 import { createInternalMethodsMiddleware } from "./internal-methods/index.mjs";
 import { createMockMiddleware } from "./mock.mjs";
@@ -11,23 +12,26 @@ import { createProviderMiddleware } from "./provider.mjs";
  * well as Snap-specific requests.
  *
  * @param options - The options to use when creating the engine.
+ * @param options.snapId - The Snap ID.
+ * @param options.messenger - The messenger.
  * @param options.store - The Redux store to use.
  * @param options.restrictedHooks - Any hooks used by the middleware handlers.
  * @param options.permittedHooks - Any hooks used by the middleware handlers.
- * @param options.permissionMiddleware - The permission middleware to use.
  * @param options.multichainHooks - Hooks used by the multichain middleware.
  * @param options.isMultichain - Whether the engine is used for multichain.
  * @returns A JSON-RPC engine.
  */
-export function createJsonRpcEngine({ store, restrictedHooks, permittedHooks, permissionMiddleware, multichainHooks, isMultichain, }) {
+export function createJsonRpcEngine({ snapId, messenger, store, restrictedHooks, permittedHooks, multichainHooks, isMultichain, }) {
     const engine = new JsonRpcEngine();
+    engine.push(createOriginMiddleware(snapId));
     engine.push(createMultichainMiddleware(isMultichain, multichainHooks));
     engine.push(createMockMiddleware(store));
     // The hooks here do not match the hooks used by the clients, so this
     // middleware should not be used outside of the simulation environment.
     engine.push(createInternalMethodsMiddleware(restrictedHooks));
-    engine.push(createSnapsMethodMiddleware(true, permittedHooks));
-    engine.push(permissionMiddleware);
+    // @ts-expect-error Hooks type mismatch.
+    engine.push(createSnapsMethodMiddleware(true, permittedHooks, messenger));
+    engine.push(createPermissionMiddleware({ messenger, origin: snapId }));
     engine.push(createProviderMiddleware(store));
     return engine;
 }

package/dist/middleware/engine.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"engine.mjs","sourceRoot":"","sources":["../../src/middleware/engine.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,kCAAkC;AAE1D,OAAO,EAAE,2BAA2B,EAAE,oCAAoC;AAG1E,OAAO,EAAE,+BAA+B,EAAE,qCAA2B;AACrE,OAAO,EAAE,oBAAoB,EAAE,mBAAe;AAC9C,OAAO,EAAE,0BAA0B,EAAE,+BAAqB;AAC1D,OAAO,EAAE,wBAAwB,EAAE,uBAAmB;AAkBtD;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,KAAK,EACL,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,YAAY,GACe;IAC3B,MAAM,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;IAEnC,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;IAEvE,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;IAEzC,qEAAqE;IACrE,uEAAuE;IACvE,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9D,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;IAE/D,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAClC,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;IAE7C,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { JsonRpcEngine } from '@metamask/json-rpc-engine';\nimport type { RestrictedMethodParameters } from '@metamask/permission-controller';\nimport { createSnapsMethodMiddleware } from '@metamask/snaps-rpc-methods';\nimport type { Json } from '@metamask/utils';\n\nimport { createInternalMethodsMiddleware } from './internal-methods';\nimport { createMockMiddleware } from './mock';\nimport { createMultichainMiddleware } from './multichain';\nimport { createProviderMiddleware } from './provider';\nimport type {\n  MultichainMiddlewareHooks,\n  PermittedMiddlewareHooks,\n  RestrictedMiddlewareHooks,\n} from '../simulation';\nimport type { Store } from '../store';\n\nexport type CreateJsonRpcEngineOptions = {\n  store: Store;\n  restrictedHooks: RestrictedMiddlewareHooks;\n  permittedHooks: PermittedMiddlewareHooks;\n  multichainHooks: MultichainMiddlewareHooks;\n  permissionMiddleware: JsonRpcMiddleware<RestrictedMethodParameters, Json>;\n  endpoint?: string;\n  isMultichain: boolean;\n};\n\n/**\n * Create a JSON-RPC engine for use in a simulated environment. This engine\n * should be used to handle all JSON-RPC requests. It is set up to handle\n * requests that would normally be handled internally by the MetaMask client, as\n * well as Snap-specific requests.\n *\n * @param options - The options to use when creating the engine.\n * @param options.store - The Redux store to use.\n * @param options.restrictedHooks - Any hooks used by the middleware handlers.\n * @param options.permittedHooks - Any hooks used by the middleware handlers.\n * @param options.permissionMiddleware - The permission middleware to use.\n * @param options.multichainHooks - Hooks used by the multichain middleware.\n * @param options.isMultichain - Whether the engine is used for multichain.\n * @returns A JSON-RPC engine.\n */\nexport function createJsonRpcEngine({\n  store,\n  restrictedHooks,\n  permittedHooks,\n  permissionMiddleware,\n  multichainHooks,\n  isMultichain,\n}: CreateJsonRpcEngineOptions) {\n  const engine = new JsonRpcEngine();\n\n  engine.push(createMultichainMiddleware(isMultichain, multichainHooks));\n\n  engine.push(createMockMiddleware(store));\n\n  // The hooks here do not match the hooks used by the clients, so this\n  // middleware should not be used outside of the simulation environment.\n  engine.push(createInternalMethodsMiddleware(restrictedHooks));\n  engine.push(createSnapsMethodMiddleware(true, permittedHooks));\n\n  engine.push(permissionMiddleware);\n  engine.push(createProviderMiddleware(store));\n\n  return engine;\n}\n"]}
+{"version":3,"file":"engine.mjs","sourceRoot":"","sources":["../../src/middleware/engine.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,sBAAsB,EACvB,kCAAkC;AACnC,OAAO,EAAE,0BAA0B,EAAE,wCAAwC;AAC7E,OAAO,EAAE,2BAA2B,EAAE,oCAAoC;AAG1E,OAAO,EAAE,+BAA+B,EAAE,qCAA2B;AACrE,OAAO,EAAE,oBAAoB,EAAE,mBAAe;AAC9C,OAAO,EAAE,0BAA0B,EAAE,+BAAqB;AAC1D,OAAO,EAAE,wBAAwB,EAAE,uBAAmB;AAoBtD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,MAAM,EACN,SAAS,EACT,KAAK,EACL,eAAe,EACf,cAAc,EACd,eAAe,EACf,YAAY,GACe;IAC3B,MAAM,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;IAEnC,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC;IAE5C,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;IAEvE,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;IAEzC,qEAAqE;IACrE,uEAAuE;IACvE,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,eAAe,CAAC,CAAC,CAAC;IAE9D,wCAAwC;IACxC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,IAAI,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC;IAE1E,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACvE,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;IAE7C,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import {\n  JsonRpcEngine,\n  createOriginMiddleware,\n} from '@metamask/json-rpc-engine';\nimport { createPermissionMiddleware } from '@metamask/permission-controller';\nimport { createSnapsMethodMiddleware } from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\n\nimport { createInternalMethodsMiddleware } from './internal-methods';\nimport { createMockMiddleware } from './mock';\nimport { createMultichainMiddleware } from './multichain';\nimport { createProviderMiddleware } from './provider';\nimport type { RootControllerMessenger } from '../controllers';\nimport type {\n  MultichainMiddlewareHooks,\n  PermittedMiddlewareHooks,\n  RestrictedMiddlewareHooks,\n} from '../simulation';\nimport type { Store } from '../store';\n\nexport type CreateJsonRpcEngineOptions = {\n  snapId: SnapId;\n  messenger: RootControllerMessenger;\n  store: Store;\n  restrictedHooks: RestrictedMiddlewareHooks;\n  permittedHooks: PermittedMiddlewareHooks;\n  multichainHooks: MultichainMiddlewareHooks;\n  endpoint?: string;\n  isMultichain: boolean;\n};\n\n/**\n * Create a JSON-RPC engine for use in a simulated environment. This engine\n * should be used to handle all JSON-RPC requests. It is set up to handle\n * requests that would normally be handled internally by the MetaMask client, as\n * well as Snap-specific requests.\n *\n * @param options - The options to use when creating the engine.\n * @param options.snapId - The Snap ID.\n * @param options.messenger - The messenger.\n * @param options.store - The Redux store to use.\n * @param options.restrictedHooks - Any hooks used by the middleware handlers.\n * @param options.permittedHooks - Any hooks used by the middleware handlers.\n * @param options.multichainHooks - Hooks used by the multichain middleware.\n * @param options.isMultichain - Whether the engine is used for multichain.\n * @returns A JSON-RPC engine.\n */\nexport function createJsonRpcEngine({\n  snapId,\n  messenger,\n  store,\n  restrictedHooks,\n  permittedHooks,\n  multichainHooks,\n  isMultichain,\n}: CreateJsonRpcEngineOptions) {\n  const engine = new JsonRpcEngine();\n\n  engine.push(createOriginMiddleware(snapId));\n\n  engine.push(createMultichainMiddleware(isMultichain, multichainHooks));\n\n  engine.push(createMockMiddleware(store));\n\n  // The hooks here do not match the hooks used by the clients, so this\n  // middleware should not be used outside of the simulation environment.\n  engine.push(createInternalMethodsMiddleware(restrictedHooks));\n\n  // @ts-expect-error Hooks type mismatch.\n  engine.push(createSnapsMethodMiddleware(true, permittedHooks, messenger));\n\n  engine.push(createPermissionMiddleware({ messenger, origin: snapId }));\n  engine.push(createProviderMiddleware(store));\n\n  return engine;\n}\n"]}

package/dist/simulation.cjs

@@ -2,11 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerActions = exports.getMultichainHooks = exports.getPermittedHooks = exports.getRestrictedHooks = exports.installSnap = void 0;
 const json_rpc_middleware_stream_1 = require("@metamask/json-rpc-middleware-stream");
+const key_tree_1 = require("@metamask/key-tree");
 const messenger_1 = require("@metamask/messenger");
 const permission_controller_1 = require("@metamask/permission-controller");
 const node_1 = require("@metamask/snaps-controllers/node");
 const snaps_rpc_methods_1 = require("@metamask/snaps-rpc-methods");
 const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
 const readable_stream_1 = require("readable-stream");
 const effects_1 = require("redux-saga/effects");
 const controllers_1 = require("./controllers.cjs");
@@ -15,7 +17,6 @@ const helpers_1 = require("./helpers.cjs");
 const interface_1 = require("./interface.cjs");
 const methods_1 = require("./methods/index.cjs");
 const hooks_1 = require("./methods/hooks/index.cjs");
-const get_mnemonic_seed_1 = require("./methods/hooks/get-mnemonic-seed.cjs");
 const middleware_1 = require("./middleware/index.cjs");
 const options_1 = require("./options.cjs");
 const store_1 = require("./store/index.cjs");
@@ -47,10 +48,10 @@ async function installSnap(snapId, { executionService, executionServiceOptions,
     const controllerMessenger = new messenger_1.Messenger({
         namespace: messenger_1.MOCK_ANY_NAMESPACE,
     });
-    registerActions(controllerMessenger, runSaga, options, snapId);
+    registerActions(controllerMessenger, runSaga, options, snapId, snapFiles.auxiliaryFiles);
     // Set up controllers and JSON-RPC stack.
     const restrictedHooks = getRestrictedHooks(options, store, runSaga);
-    const permittedHooks = getPermittedHooks(snapId, snapFiles, controllerMessenger, runSaga);
+    const permittedHooks = getPermittedHooks(runSaga);
     const multichainHooks = getMultichainHooks(snapId, options, controllerMessenger);
     const { subjectMetadataController, permissionController } = (0, controllers_1.getControllers)({
         controllerMessenger,
@@ -58,22 +59,21 @@ async function installSnap(snapId, { executionService, executionServiceOptions,
         runSaga,
         options,
     });
-    const permissionMiddleware = permissionController.createPermissionMiddleware({
-        origin: snapId,
-    });
     const engine = (0, middleware_1.createJsonRpcEngine)({
+        snapId,
+        messenger: controllerMessenger,
         store,
         restrictedHooks,
         permittedHooks,
-        permissionMiddleware,
         multichainHooks,
         isMultichain: false,
     });
     const multichainEngine = (0, middleware_1.createJsonRpcEngine)({
+        snapId,
+        messenger: controllerMessenger,
         store,
         restrictedHooks,
         permittedHooks,
-        permissionMiddleware,
         multichainHooks,
         isMultichain: true,
     });
@@ -149,7 +149,6 @@ exports.installSnap = installSnap;
 function getRestrictedHooks(options, store, runSaga) {
     return {
         getMnemonic: (0, hooks_1.getGetMnemonicImplementation)(options.secretRecoveryPhrase),
-        getMnemonicSeed: (0, get_mnemonic_seed_1.getGetMnemonicSeedImplementation)(options.secretRecoveryPhrase),
         getIsLocked: () => false,
         getClientCryptography: () => ({}),
         getSnap: (0, hooks_1.getGetSnapImplementation)(true),
@@ -161,30 +160,15 @@ exports.getRestrictedHooks = getRestrictedHooks;
 /**
  * Get the permitted hooks for the simulation.
  *
- * @param snapId - The ID of the Snap.
- * @param snapFiles - The fetched Snap files.
- * @param controllerMessenger - The controller messenger.
  * @param runSaga - The run saga function.
  * @returns The permitted hooks for the simulation.
  */
-function getPermittedHooks(snapId, snapFiles, controllerMessenger, runSaga) {
+function getPermittedHooks(runSaga) {
     return {
-        hasPermission: () => true,
         getUnlockPromise: (0, methods_1.asyncResolve)(),
-        getIsLocked: () => false,
         getIsActive: () => true,
         getVersion: () => '13.6.0-flask.0',
-        getSnapFile: async (path, encoding) => await (0, files_1.getSnapFile)(snapFiles.auxiliaryFiles, path, encoding),
-        createInterface: (...args) => controllerMessenger.call('SnapInterfaceController:createInterface', snapId, ...args),
-        updateInterface: (...args) => controllerMessenger.call('SnapInterfaceController:updateInterface', snapId, ...args),
-        getInterfaceState: (...args) => controllerMessenger.call('SnapInterfaceController:getInterfaceState', snapId, ...args),
-        getInterfaceContext: (...args) => controllerMessenger.call('SnapInterfaceController:getInterface', snapId, ...args).context,
-        resolveInterface: async (...args) => controllerMessenger.call('SnapInterfaceController:resolveInterface', snapId, ...args),
-        getEntropySources: (0, hooks_1.getGetEntropySourcesImplementation)(),
-        getSnapState: (0, hooks_1.getPermittedGetSnapStateMethodImplementation)(runSaga),
-        updateSnapState: (0, hooks_1.getPermittedUpdateSnapStateMethodImplementation)(runSaga),
-        clearSnapState: (0, hooks_1.getPermittedClearSnapStateMethodImplementation)(runSaga),
-        getSnap: (0, hooks_1.getGetSnapImplementation)(true),
+        getAllowedKeyringMethods: () => [],
         trackError: (0, hooks_1.getTrackErrorImplementation)(runSaga),
         trackEvent: (0, hooks_1.getTrackEventImplementation)(runSaga),
         startTrace: (0, hooks_1.getStartTraceImplementation)(runSaga),
@@ -238,6 +222,12 @@ function getMultichainHooks(snapId, options, controllerMessenger) {
     };
 }
 exports.getMultichainHooks = getMultichainHooks;
+/**
+ * Get the mock mnemonic for a given source ID.
+ *
+ * @param options - The simulation options.
+ * @returns The mnemonic.
+ */
 /**
  * Register mocked action handlers.
  *
@@ -245,8 +235,9 @@ exports.getMultichainHooks = getMultichainHooks;
  * @param runSaga - The run saga function.
  * @param options - The simulation options.
  * @param snapId - The ID of the Snap.
+ * @param auxiliaryFiles - Auxiliary files from the fetched Snap.
  */
-function registerActions(controllerMessenger, runSaga, options, snapId) {
+function registerActions(controllerMessenger, runSaga, options, snapId, auxiliaryFiles) {
     controllerMessenger.registerActionHandler('PhishingController:testOrigin', () => ({ result: false, type: 'all' }));
     controllerMessenger.registerActionHandler('AccountsController:getAccountByAddress', 
     // @ts-expect-error - This is a partial account with only the necessary
@@ -300,6 +291,70 @@ function registerActions(controllerMessenger, runSaga, options, snapId) {
         await runSaga(interface_1.resolveWithSaga, value).toPromise();
         return { value };
     });
+    controllerMessenger.registerActionHandler('ApprovalController:addRequest', 
+    // @ts-expect-error Types of property 'requestData' are incompatible.
+    (0, hooks_1.getRequestUserApprovalImplementation)(runSaga));
+    controllerMessenger.registerActionHandler('SnapController:getSnap', (0, hooks_1.getGetSnapImplementation)(true));
+    controllerMessenger.registerActionHandler('SnapController:getSnapState', (0, hooks_1.getGetSnapStateMethodImplementation)(runSaga));
+    controllerMessenger.registerActionHandler('SnapController:updateSnapState', (0, hooks_1.getUpdateSnapStateMethodImplementation)(runSaga));
+    controllerMessenger.registerActionHandler('SnapController:clearSnapState', (0, hooks_1.getClearSnapStateMethodImplementation)(runSaga));
+    controllerMessenger.registerActionHandler('SnapController:getSnapFile', async (_snapId, path, encoding) => (0, files_1.getSnapFile)(auxiliaryFiles, path, encoding));
+    const showNativeNotification = (0, hooks_1.getShowNativeNotificationImplementation)(runSaga);
+    const showInAppNotification = (0, hooks_1.getShowInAppNotificationImplementation)(runSaga);
+    controllerMessenger.registerActionHandler(
+    // @ts-expect-error - `RateLimitController` is not part of the simulation messenger types.
+    'RateLimitController:call', async (_origin, type, ...args) => {
+        switch (type) {
+            case 'showNativeNotification':
+                return await showNativeNotification(args[0], {
+                    type: 'native',
+                    message: args[1],
+                });
+            case 'showInAppNotification':
+                return await showInAppNotification(args[0], args[1]);
+            /* istanbul ignore next */
+            default:
+                return (0, utils_1.assertExhaustive)(type);
+        }
+    });
+    const getMnemonic = (0, hooks_1.getGetMnemonicImplementation)(options.secretRecoveryPhrase);
+    controllerMessenger.registerActionHandler(
+    // @ts-expect-error - `KeyringController` is not part of the simulation messenger types.
+    'KeyringController:getState', () => ({
+        isUnlocked: true,
+        keyrings: [
+            {
+                type: 'HD Key Tree',
+                metadata: {
+                    id: 'default',
+                    name: 'Default Secret Recovery Phrase',
+                },
+            },
+            {
+                type: 'HD Key Tree',
+                metadata: {
+                    id: 'alternative',
+                    name: 'Alternative Secret Recovery Phrase',
+                },
+            },
+        ],
+    }));
+    controllerMessenger.registerActionHandler(
+    // @ts-expect-error - `KeyringController` is not part of the simulation messenger types.
+    'KeyringController:withKeyring', async (selector, operation) => {
+        const source = (0, utils_1.hasProperty)(selector, 'id')
+            ? selector.id
+            : undefined;
+        const mnemonic = await getMnemonic(source);
+        const seed = await (0, key_tree_1.mnemonicToSeed)(mnemonic);
+        return await operation({
+            keyring: {
+                type: 'HD Key Tree',
+                mnemonic,
+                seed,
+            },
+        });
+    });
 }
 exports.registerActions = registerActions;
 //# sourceMappingURL=simulation.cjs.map