@metamask/snaps-jest 8.3.0 → 8.3.2

package/dist/internals/simulation/options.mjs

@@ -1,9 +1,21 @@
-import {
-  getOptions
-} from "../../chunk-G333FBBL.mjs";
-import "../../chunk-LVNNGMJ2.mjs";
-import "../../chunk-JMDSN227.mjs";
-export {
-  getOptions
-};
+import { create, defaulted, nullable, object, optional, record, string } from "@metamask/superstruct";
+import { JsonStruct } from "@metamask/utils";
+import { DEFAULT_CURRENCY, DEFAULT_LOCALE, DEFAULT_SRP } from "./constants.mjs";
+const SimulationOptionsStruct = object({
+    currency: defaulted(optional(string()), DEFAULT_CURRENCY),
+    secretRecoveryPhrase: defaulted(optional(string()), DEFAULT_SRP),
+    locale: defaulted(optional(string()), DEFAULT_LOCALE),
+    state: defaulted(optional(nullable(record(string(), JsonStruct))), null),
+    unencryptedState: defaulted(optional(nullable(record(string(), JsonStruct))), null),
+});
+/**
+ * Get the options for the simulation.
+ *
+ * @param options - The user options. Any options not specified will be filled
+ * in with default values.
+ * @returns The simulation options.
+ */
+export function getOptions(options) {
+    return create(options, SimulationOptionsStruct);
+}
 //# sourceMappingURL=options.mjs.map

package/dist/internals/simulation/options.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"options.mjs","sourceRoot":"","sources":["../../../src/internals/simulation/options.ts"],"names":[],"mappings":"AACA,OAAO,EACL,MAAM,EACN,SAAS,EACT,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,MAAM,EACN,MAAM,EACP,8BAA8B;AAC/B,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAE7C,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,WAAW,EAAE,wBAAoB;AAE5E,MAAM,uBAAuB,GAAG,MAAM,CAAC;IACrC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,gBAAgB,CAAC;IACzD,oBAAoB,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,WAAW,CAAC;IAChE,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,cAAc,CAAC;IACrD,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IACxE,gBAAgB,EAAE,SAAS,CACzB,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,EAChD,IAAI,CACL;CACF,CAAC,CAAC;AAoBH;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,OAA8B;IACvD,OAAO,MAAM,CACX,OAAO,EACP,uBAAuB,CACW,CAAC;AACvC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport {\n  create,\n  defaulted,\n  nullable,\n  object,\n  optional,\n  record,\n  string,\n} from '@metamask/superstruct';\nimport { JsonStruct } from '@metamask/utils';\n\nimport { DEFAULT_CURRENCY, DEFAULT_LOCALE, DEFAULT_SRP } from './constants';\n\nconst SimulationOptionsStruct = object({\n  currency: defaulted(optional(string()), DEFAULT_CURRENCY),\n  secretRecoveryPhrase: defaulted(optional(string()), DEFAULT_SRP),\n  locale: defaulted(optional(string()), DEFAULT_LOCALE),\n  state: defaulted(optional(nullable(record(string(), JsonStruct))), null),\n  unencryptedState: defaulted(\n    optional(nullable(record(string(), JsonStruct))),\n    null,\n  ),\n});\n\n/**\n * Options for the simulation.\n *\n * @property secretRecoveryPhrase - The secret recovery phrase to use. This is\n * used to derive addresses and private keys. Defaults to a test recovery\n * phrase.\n * @property locale - The locale to use. Defaults to `en`.\n * @property state - The initial state of the Snap, if any. Defaults to `null`.\n */\nexport type SimulationUserOptions = Infer<typeof SimulationOptionsStruct>;\n\n/**\n * Options for the simulation, with defaults filled in.\n *\n * See {@link SimulationUserOptions} for documentation.\n */\nexport type SimulationOptions = Required<SimulationUserOptions>;\n\n/**\n * Get the options for the simulation.\n *\n * @param options - The user options. Any options not specified will be filled\n * in with default values.\n * @returns The simulation options.\n */\nexport function getOptions(options: SimulationUserOptions): SimulationOptions {\n  return create(\n    options,\n    SimulationOptionsStruct,\n  ) as Required<SimulationUserOptions>;\n}\n"]}

package/dist/internals/simulation/simulation.cjs

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerActions = exports.getHooks = exports.handleInstallSnap = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const json_rpc_middleware_stream_1 = require("@metamask/json-rpc-middleware-stream");
+const key_tree_1 = require("@metamask/key-tree");
+const phishing_controller_1 = require("@metamask/phishing-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 readable_stream_1 = require("readable-stream");
+const effects_1 = require("redux-saga/effects");
+const controllers_1 = require("./controllers.cjs");
+const files_1 = require("./files.cjs");
+const interface_1 = require("./interface.cjs");
+const methods_1 = require("./methods/index.cjs");
+const middleware_1 = require("./middleware/index.cjs");
+const options_1 = require("./options.cjs");
+const store_1 = require("./store/index.cjs");
+/**
+ * Install a Snap in a simulated environment. This will fetch the Snap files,
+ * create a Redux store, set up the controllers and JSON-RPC stack, register the
+ * Snap, and run the Snap code in the execution service.
+ *
+ * @param snapId - The ID of the Snap to install.
+ * @param options - The options to use when installing the Snap.
+ * @param options.executionService - The execution service to use.
+ * @param options.executionServiceOptions - The options to use when creating the
+ * execution service, if any. This should only include options specific to the
+ * provided execution service.
+ * @param options.options - The simulation options.
+ * @returns The installed Snap object.
+ * @template Service - The type of the execution service.
+ */
+async function handleInstallSnap(snapId, { executionService, executionServiceOptions, options: rawOptions = {}, } = {}) {
+    const options = (0, options_1.getOptions)(rawOptions);
+    // Fetch Snap files.
+    const location = (0, node_1.detectSnapLocation)(snapId, {
+        allowLocal: true,
+    });
+    const snapFiles = await (0, node_1.fetchSnap)(snapId, location);
+    // Create Redux store.
+    const { store, runSaga } = (0, store_1.createStore)(options);
+    const controllerMessenger = new base_controller_1.ControllerMessenger();
+    registerActions(controllerMessenger, runSaga);
+    // Set up controllers and JSON-RPC stack.
+    const hooks = getHooks(options, snapFiles, snapId, controllerMessenger);
+    const { subjectMetadataController, permissionController } = (0, controllers_1.getControllers)({
+        controllerMessenger,
+        hooks,
+        runSaga,
+        options,
+    });
+    const engine = (0, middleware_1.createJsonRpcEngine)({
+        store,
+        hooks,
+        permissionMiddleware: permissionController.createPermissionMiddleware({
+            origin: snapId,
+        }),
+    });
+    // Create execution service.
+    const ExecutionService = executionService ?? node_1.NodeThreadExecutionService;
+    const service = new ExecutionService({
+        ...executionServiceOptions,
+        messenger: controllerMessenger.getRestricted({
+            name: 'ExecutionService',
+            allowedActions: [],
+            allowedEvents: [],
+        }),
+        setupSnapProvider: (_snapId, rpcStream) => {
+            const mux = (0, node_1.setupMultiplex)(rpcStream, 'snapStream');
+            const stream = mux.createStream('metamask-provider');
+            const providerStream = (0, json_rpc_middleware_stream_1.createEngineStream)({ engine });
+            // Error function is difficult to test, so we ignore it.
+            /* istanbul ignore next 2 */
+            (0, readable_stream_1.pipeline)(stream, providerStream, stream, (error) => {
+                if (error) {
+                    (0, snaps_utils_1.logError)(`Provider stream failure.`, error);
+                }
+            });
+        },
+    });
+    // Register the Snap. This sets up the Snap's permissions and subject
+    // metadata.
+    await (0, controllers_1.registerSnap)(snapId, snapFiles.manifest.result, {
+        permissionController,
+        subjectMetadataController,
+    });
+    // Run the Snap code in the execution service.
+    await service.executeSnap({
+        snapId,
+        sourceCode: snapFiles.sourceCode.toString('utf8'),
+        endowments: await (0, methods_1.getEndowments)(permissionController, snapId),
+    });
+    return {
+        snapId,
+        store,
+        executionService: service,
+        controllerMessenger,
+        runSaga,
+    };
+}
+exports.handleInstallSnap = handleInstallSnap;
+/**
+ * Get the hooks for the simulation.
+ *
+ * @param options - The simulation options.
+ * @param snapFiles - The Snap files.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The hooks for the simulation.
+ */
+function getHooks(options, snapFiles, snapId, controllerMessenger) {
+    return {
+        getMnemonic: async () => Promise.resolve((0, key_tree_1.mnemonicPhraseToBytes)(options.secretRecoveryPhrase)),
+        getSnapFile: async (path, encoding) => await (0, files_1.getSnapFile)(snapFiles.auxiliaryFiles, path, encoding),
+        getIsLocked: () => false,
+        createInterface: async (...args) => controllerMessenger.call('SnapInterfaceController:createInterface', snapId, ...args),
+        updateInterface: async (...args) => controllerMessenger.call('SnapInterfaceController:updateInterface', snapId, ...args),
+        getInterfaceState: (...args) => controllerMessenger.call('SnapInterfaceController:getInterface', snapId, ...args).state,
+        resolveInterface: async (...args) => controllerMessenger.call('SnapInterfaceController:resolveInterface', snapId, ...args),
+    };
+}
+exports.getHooks = getHooks;
+/**
+ * Register mocked action handlers.
+ *
+ * @param controllerMessenger - The controller messenger.
+ * @param runSaga - The run saga function.
+ */
+function registerActions(controllerMessenger, runSaga) {
+    controllerMessenger.registerActionHandler('PhishingController:maybeUpdateState', async () => Promise.resolve());
+    controllerMessenger.registerActionHandler('PhishingController:testOrigin', () => ({ result: false, type: phishing_controller_1.PhishingDetectorResultType.All }));
+    controllerMessenger.registerActionHandler('ApprovalController:hasRequest', (opts) => {
+        /**
+         * Get the current interface from the store.
+         *
+         * @yields Selects the current interface from the store.
+         * @returns The current interface.
+         */
+        function* getCurrentInterfaceSaga() {
+            const currentInterface = yield (0, effects_1.select)(store_1.getCurrentInterface);
+            return currentInterface;
+        }
+        const currentInterface = runSaga(getCurrentInterfaceSaga).result();
+        return (currentInterface?.type === snaps_rpc_methods_1.DIALOG_APPROVAL_TYPES.default &&
+            currentInterface?.id === opts?.id);
+    });
+    controllerMessenger.registerActionHandler('ApprovalController:acceptRequest', async (_id, value) => {
+        await runSaga(interface_1.resolveWithSaga, value).toPromise();
+        return { value };
+    });
+}
+exports.registerActions = registerActions;
+//# sourceMappingURL=simulation.cjs.map

package/dist/internals/simulation/simulation.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulation.cjs","sourceRoot":"","sources":["../../../src/internals/simulation/simulation.ts"],"names":[],"mappings":";;;AAIA,+DAAgE;AAChE,qFAA0E;AAC1E,iDAA2D;AAC3D,uEAA2E;AAE3E,2DAK0C;AAC1C,mEAAoE;AAQpE,uDAAiD;AAGjD,qDAA2C;AAE3C,gDAA4C;AAG5C,mDAA6D;AAC7D,uCAAsC;AACtC,+CAA8C;AAC9C,iDAA0C;AAC1C,uDAAmD;AAEnD,2CAAuC;AAEvC,6CAA2D;AAkF3D;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,iBAAiB,CAKrC,MAAc,EACd,EACE,gBAAgB,EAChB,uBAAuB,EACvB,OAAO,EAAE,UAAU,GAAG,EAAE,MACgB,EAAE;IAE5C,MAAM,OAAO,GAAG,IAAA,oBAAU,EAAC,UAAU,CAAC,CAAC;IAEvC,oBAAoB;IACpB,MAAM,QAAQ,GAAG,IAAA,yBAAkB,EAAC,MAAM,EAAE;QAC1C,UAAU,EAAE,IAAI;KACjB,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,IAAA,gBAAS,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAEpD,sBAAsB;IACtB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC;IAEhD,MAAM,mBAAmB,GAAG,IAAI,qCAAmB,EAAY,CAAC;IAEhE,eAAe,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAE9C,yCAAyC;IACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAExE,MAAM,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,GAAG,IAAA,4BAAc,EAAC;QACzE,mBAAmB;QACnB,KAAK;QACL,OAAO;QACP,OAAO;KACR,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAA,gCAAmB,EAAC;QACjC,KAAK;QACL,KAAK;QACL,oBAAoB,EAAE,oBAAoB,CAAC,0BAA0B,CAAC;YACpE,MAAM,EAAE,MAAM;SACf,CAAC;KACH,CAAC,CAAC;IAEH,4BAA4B;IAC5B,MAAM,gBAAgB,GAAG,gBAAgB,IAAI,iCAA0B,CAAC;IACxE,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;QACnC,GAAG,uBAAuB;QAC1B,SAAS,EAAE,mBAAmB,CAAC,aAAa,CAAC;YAC3C,IAAI,EAAE,kBAAkB;YACxB,cAAc,EAAE,EAAE;YAClB,aAAa,EAAE,EAAE;SAClB,CAAC;QACF,iBAAiB,EAAE,CAAC,OAAe,EAAE,SAAiB,EAAE,EAAE;YACxD,MAAM,GAAG,GAAG,IAAA,qBAAc,EAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;YACrD,MAAM,cAAc,GAAG,IAAA,+CAAkB,EAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YAEtD,wDAAwD;YACxD,4BAA4B;YAC5B,IAAA,0BAAQ,EAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,KAAc,EAAE,EAAE;gBAC1D,IAAI,KAAK,EAAE,CAAC;oBACV,IAAA,sBAAQ,EAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;IAEH,qEAAqE;IACrE,YAAY;IACZ,MAAM,IAAA,0BAAY,EAAC,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;QACpD,oBAAoB;QACpB,yBAAyB;KAC1B,CAAC,CAAC;IAEH,8CAA8C;IAC9C,MAAM,OAAO,CAAC,WAAW,CAAC;QACxB,MAAM;QACN,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC;QACjD,UAAU,EAAE,MAAM,IAAA,uBAAa,EAAC,oBAAoB,EAAE,MAAM,CAAC;KAC9D,CAAC,CAAC;IAEH,OAAO;QACL,MAAM;QACN,KAAK;QACL,gBAAgB,EAAE,OAAO;QACzB,mBAAmB;QACnB,OAAO;KACR,CAAC;AACJ,CAAC;AA3FD,8CA2FC;AAED;;;;;;;;GAQG;AACH,SAAgB,QAAQ,CACtB,OAA0B,EAC1B,SAA2B,EAC3B,MAAc,EACd,mBAA4C;IAE5C,OAAO;QACL,WAAW,EAAE,KAAK,IAAI,EAAE,CACtB,OAAO,CAAC,OAAO,CAAC,IAAA,gCAAqB,EAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QACtE,WAAW,EAAE,KAAK,EAAE,IAAY,EAAE,QAA+B,EAAE,EAAE,CACnE,MAAM,IAAA,mBAAW,EAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,QAAQ,CAAC;QAC7D,WAAW,EAAE,GAAG,EAAE,CAAC,KAAK;QACxB,eAAe,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CACjC,mBAAmB,CAAC,IAAI,CACtB,yCAAyC,EACzC,MAAM,EACN,GAAG,IAAI,CACR;QACH,eAAe,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CACjC,mBAAmB,CAAC,IAAI,CACtB,yCAAyC,EACzC,MAAM,EACN,GAAG,IAAI,CACR;QACH,iBAAiB,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAC7B,mBAAmB,CAAC,IAAI,CACtB,sCAAsC,EACtC,MAAM,EACN,GAAG,IAAI,CACR,CAAC,KAAK;QACT,gBAAgB,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAClC,mBAAmB,CAAC,IAAI,CACtB,0CAA0C,EAC1C,MAAM,EACN,GAAG,IAAI,CACR;KACJ,CAAC;AACJ,CAAC;AArCD,4BAqCC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAC7B,mBAA4C,EAC5C,OAAwB;IAExB,mBAAmB,CAAC,qBAAqB,CACvC,qCAAqC,EACrC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAC9B,CAAC;IAEF,mBAAmB,CAAC,qBAAqB,CACvC,+BAA+B,EAC/B,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gDAA0B,CAAC,GAAG,EAAE,CAAC,CAChE,CAAC;IAEF,mBAAmB,CAAC,qBAAqB,CACvC,+BAA+B,EAC/B,CAAC,IAAI,EAAE,EAAE;QACP;;;;;WAKG;QACH,QAAQ,CAAC,CAAC,uBAAuB;YAC/B,MAAM,gBAAgB,GAAc,MAAM,IAAA,gBAAM,EAAC,2BAAmB,CAAC,CAAC;YACtE,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,gBAAgB,GAA0B,OAAO,CACrD,uBAAuB,CACxB,CAAC,MAAM,EAAE,CAAC;QACX,OAAO,CACL,gBAAgB,EAAE,IAAI,KAAK,yCAAqB,CAAC,OAAO;YACxD,gBAAgB,EAAE,EAAE,KAAK,IAAI,EAAE,EAAE,CAClC,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,mBAAmB,CAAC,qBAAqB,CACvC,kCAAkC,EAClC,KAAK,EAAE,GAAW,EAAE,KAAc,EAAE,EAAE;QACpC,MAAM,OAAO,CAAC,2BAAe,EAAE,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;QAElD,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC,CACF,CAAC;AACJ,CAAC;AA9CD,0CA8CC","sourcesContent":["import type {\n  ActionConstraint,\n  EventConstraint,\n} from '@metamask/base-controller';\nimport { ControllerMessenger } from '@metamask/base-controller';\nimport { createEngineStream } from '@metamask/json-rpc-middleware-stream';\nimport { mnemonicPhraseToBytes } from '@metamask/key-tree';\nimport { PhishingDetectorResultType } from '@metamask/phishing-controller';\nimport type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport {\n  detectSnapLocation,\n  fetchSnap,\n  NodeThreadExecutionService,\n  setupMultiplex,\n} from '@metamask/snaps-controllers/node';\nimport { DIALOG_APPROVAL_TYPES } from '@metamask/snaps-rpc-methods';\nimport type {\n  AuxiliaryFileEncoding,\n  Component,\n  InterfaceState,\n  SnapId,\n} from '@metamask/snaps-sdk';\nimport type { FetchedSnapFiles } from '@metamask/snaps-utils';\nimport { logError } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\nimport type { Duplex } from 'readable-stream';\nimport { pipeline } from 'readable-stream';\nimport type { SagaIterator } from 'redux-saga';\nimport { select } from 'redux-saga/effects';\n\nimport type { RootControllerMessenger } from './controllers';\nimport { getControllers, registerSnap } from './controllers';\nimport { getSnapFile } from './files';\nimport { resolveWithSaga } from './interface';\nimport { getEndowments } from './methods';\nimport { createJsonRpcEngine } from './middleware';\nimport type { SimulationOptions, SimulationUserOptions } from './options';\nimport { getOptions } from './options';\nimport type { Interface, RunSagaFunction, Store } from './store';\nimport { createStore, getCurrentInterface } from './store';\n\n/**\n * Options for the execution service, without the options that are shared\n * between all execution services.\n *\n * @template Service - The type of the execution service, i.e., the class that\n * creates the execution service.\n */\nexport type ExecutionServiceOptions<\n  Service extends new (...args: any[]) => any,\n> = Omit<\n  ConstructorParameters<Service>[0],\n  keyof ConstructorParameters<typeof AbstractExecutionService<unknown>>[0]\n>;\n\n/**\n * The options for running a Snap in a simulated environment.\n *\n * @property executionService - The execution service to use.\n * @property executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @property options - The simulation options.\n * @template Service - The type of the execution service.\n */\nexport type InstallSnapOptions<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService<unknown>\n  >,\n> = ExecutionServiceOptions<Service> extends Record<string, never>\n  ? {\n      executionService: Service;\n      executionServiceOptions?: ExecutionServiceOptions<Service>;\n      options?: SimulationUserOptions;\n    }\n  : {\n      executionService: Service;\n      executionServiceOptions: ExecutionServiceOptions<Service>;\n      options?: SimulationUserOptions;\n    };\n\nexport type InstalledSnap = {\n  snapId: SnapId;\n  store: Store;\n  executionService: InstanceType<typeof AbstractExecutionService>;\n  controllerMessenger: ControllerMessenger<ActionConstraint, EventConstraint>;\n  runSaga: RunSagaFunction;\n};\n\nexport type MiddlewareHooks = {\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  /**\n   * A hook that returns the Snap's auxiliary file for the given path.\n   *\n   * @param path - The path of the auxiliary file to get.\n   * @param encoding - The encoding to use when returning the file.\n   * @returns The Snap's auxiliary file for the given path.\n   */\n  getSnapFile: (\n    path: string,\n    encoding: AuxiliaryFileEncoding,\n  ) => Promise<string | null>;\n\n  /**\n   * A hook that returns whether the client is locked or not.\n   *\n   * @returns A boolean flag signaling whether the client is locked.\n   */\n  getIsLocked: () => boolean;\n  createInterface: (content: Component) => Promise<string>;\n  updateInterface: (id: string, content: Component) => Promise<void>;\n  getInterfaceState: (id: string) => InterfaceState;\n  resolveInterface: (id: string, value: Json) => Promise<void>;\n};\n\n/**\n * Install a Snap in a simulated environment. This will fetch the Snap files,\n * create a Redux store, set up the controllers and JSON-RPC stack, register the\n * Snap, and run the Snap code in the execution service.\n *\n * @param snapId - The ID of the Snap to install.\n * @param options - The options to use when installing the Snap.\n * @param options.executionService - The execution service to use.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\n * @returns The installed Snap object.\n * @template Service - The type of the execution service.\n */\nexport async function handleInstallSnap<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId: SnapId,\n  {\n    executionService,\n    executionServiceOptions,\n    options: rawOptions = {},\n  }: Partial<InstallSnapOptions<Service>> = {},\n): Promise<InstalledSnap> {\n  const options = getOptions(rawOptions);\n\n  // Fetch Snap files.\n  const location = detectSnapLocation(snapId, {\n    allowLocal: true,\n  });\n\n  const snapFiles = await fetchSnap(snapId, location);\n\n  // Create Redux store.\n  const { store, runSaga } = createStore(options);\n\n  const controllerMessenger = new ControllerMessenger<any, any>();\n\n  registerActions(controllerMessenger, runSaga);\n\n  // Set up controllers and JSON-RPC stack.\n  const hooks = getHooks(options, snapFiles, snapId, controllerMessenger);\n\n  const { subjectMetadataController, permissionController } = getControllers({\n    controllerMessenger,\n    hooks,\n    runSaga,\n    options,\n  });\n\n  const engine = createJsonRpcEngine({\n    store,\n    hooks,\n    permissionMiddleware: permissionController.createPermissionMiddleware({\n      origin: snapId,\n    }),\n  });\n\n  // Create execution service.\n  const ExecutionService = executionService ?? NodeThreadExecutionService;\n  const service = new ExecutionService({\n    ...executionServiceOptions,\n    messenger: controllerMessenger.getRestricted({\n      name: 'ExecutionService',\n      allowedActions: [],\n      allowedEvents: [],\n    }),\n    setupSnapProvider: (_snapId: string, rpcStream: Duplex) => {\n      const mux = setupMultiplex(rpcStream, 'snapStream');\n      const stream = mux.createStream('metamask-provider');\n      const providerStream = createEngineStream({ engine });\n\n      // Error function is difficult to test, so we ignore it.\n      /* istanbul ignore next 2 */\n      pipeline(stream, providerStream, stream, (error: unknown) => {\n        if (error) {\n          logError(`Provider stream failure.`, error);\n        }\n      });\n    },\n  });\n\n  // Register the Snap. This sets up the Snap's permissions and subject\n  // metadata.\n  await registerSnap(snapId, snapFiles.manifest.result, {\n    permissionController,\n    subjectMetadataController,\n  });\n\n  // Run the Snap code in the execution service.\n  await service.executeSnap({\n    snapId,\n    sourceCode: snapFiles.sourceCode.toString('utf8'),\n    endowments: await getEndowments(permissionController, snapId),\n  });\n\n  return {\n    snapId,\n    store,\n    executionService: service,\n    controllerMessenger,\n    runSaga,\n  };\n}\n\n/**\n * Get the hooks for the simulation.\n *\n * @param options - The simulation options.\n * @param snapFiles - The Snap files.\n * @param snapId - The Snap ID.\n * @param controllerMessenger - The controller messenger.\n * @returns The hooks for the simulation.\n */\nexport function getHooks(\n  options: SimulationOptions,\n  snapFiles: FetchedSnapFiles,\n  snapId: SnapId,\n  controllerMessenger: RootControllerMessenger,\n): MiddlewareHooks {\n  return {\n    getMnemonic: async () =>\n      Promise.resolve(mnemonicPhraseToBytes(options.secretRecoveryPhrase)),\n    getSnapFile: async (path: string, encoding: AuxiliaryFileEncoding) =>\n      await getSnapFile(snapFiles.auxiliaryFiles, path, encoding),\n    getIsLocked: () => false,\n    createInterface: async (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:createInterface',\n        snapId,\n        ...args,\n      ),\n    updateInterface: async (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:updateInterface',\n        snapId,\n        ...args,\n      ),\n    getInterfaceState: (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:getInterface',\n        snapId,\n        ...args,\n      ).state,\n    resolveInterface: async (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:resolveInterface',\n        snapId,\n        ...args,\n      ),\n  };\n}\n\n/**\n * Register mocked action handlers.\n *\n * @param controllerMessenger - The controller messenger.\n * @param runSaga - The run saga function.\n */\nexport function registerActions(\n  controllerMessenger: RootControllerMessenger,\n  runSaga: RunSagaFunction,\n) {\n  controllerMessenger.registerActionHandler(\n    'PhishingController:maybeUpdateState',\n    async () => Promise.resolve(),\n  );\n\n  controllerMessenger.registerActionHandler(\n    'PhishingController:testOrigin',\n    () => ({ result: false, type: PhishingDetectorResultType.All }),\n  );\n\n  controllerMessenger.registerActionHandler(\n    'ApprovalController:hasRequest',\n    (opts) => {\n      /**\n       * Get the current interface from the store.\n       *\n       * @yields Selects the current interface from the store.\n       * @returns The current interface.\n       */\n      function* getCurrentInterfaceSaga(): SagaIterator {\n        const currentInterface: Interface = yield select(getCurrentInterface);\n        return currentInterface;\n      }\n\n      const currentInterface: Interface | undefined = runSaga(\n        getCurrentInterfaceSaga,\n      ).result();\n      return (\n        currentInterface?.type === DIALOG_APPROVAL_TYPES.default &&\n        currentInterface?.id === opts?.id\n      );\n    },\n  );\n\n  controllerMessenger.registerActionHandler(\n    'ApprovalController:acceptRequest',\n    async (_id: string, value: unknown) => {\n      await runSaga(resolveWithSaga, value).toPromise();\n\n      return { value };\n    },\n  );\n}\n"]}

package/dist/{types/internals/simulation/simulation.d.ts → internals/simulation/simulation.d.cts}

@@ -1,12 +1,12 @@
-import type { ActionConstraint, EventConstraint } from '@metamask/base-controller';
-import { ControllerMessenger } from '@metamask/base-controller';
-import type { AbstractExecutionService } from '@metamask/snaps-controllers';
-import type { SnapId, AuxiliaryFileEncoding, Component, InterfaceState } from '@metamask/snaps-sdk';
-import type { FetchedSnapFiles } from '@metamask/snaps-utils';
-import type { Json } from '@metamask/utils';
-import type { RootControllerMessenger } from './controllers';
-import type { SimulationOptions, SimulationUserOptions } from './options';
-import type { RunSagaFunction, Store } from './store';
+import type { ActionConstraint, EventConstraint } from "@metamask/base-controller";
+import { ControllerMessenger } from "@metamask/base-controller";
+import type { AbstractExecutionService } from "@metamask/snaps-controllers";
+import type { AuxiliaryFileEncoding, Component, InterfaceState, SnapId } from "@metamask/snaps-sdk";
+import type { FetchedSnapFiles } from "@metamask/snaps-utils";
+import type { Json } from "@metamask/utils";
+import type { RootControllerMessenger } from "./controllers.cjs";
+import type { SimulationOptions, SimulationUserOptions } from "./options.cjs";
+import type { RunSagaFunction, Store } from "./store/index.cjs";
 /**
  * Options for the execution service, without the options that are shared
  * between all execution services.
@@ -79,6 +79,7 @@ export type MiddlewareHooks = {
  * execution service, if any. This should only include options specific to the
  * provided execution service.
  * @param options.options - The simulation options.
+ * @returns The installed Snap object.
  * @template Service - The type of the execution service.
  */
 export declare function handleInstallSnap<Service extends new (...args: any[]) => InstanceType<typeof AbstractExecutionService>>(snapId: SnapId, { executionService, executionServiceOptions, options: rawOptions, }?: Partial<InstallSnapOptions<Service>>): Promise<InstalledSnap>;
@@ -99,3 +100,4 @@ export declare function getHooks(options: SimulationOptions, snapFiles: FetchedS
  * @param runSaga - The run saga function.
  */
 export declare function registerActions(controllerMessenger: RootControllerMessenger, runSaga: RunSagaFunction): void;
+//# sourceMappingURL=simulation.d.cts.map

package/dist/internals/simulation/simulation.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulation.d.cts","sourceRoot":"","sources":["../../../src/internals/simulation/simulation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EAChB,kCAAkC;AACnC,OAAO,EAAE,mBAAmB,EAAE,kCAAkC;AAIhE,OAAO,KAAK,EAAE,wBAAwB,EAAE,oCAAoC;AAQ5E,OAAO,KAAK,EACV,qBAAqB,EACrB,SAAS,EACT,cAAc,EACd,MAAM,EACP,4BAA4B;AAC7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,8BAA8B;AAE9D,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAM5C,OAAO,KAAK,EAAE,uBAAuB,EAAE,0BAAsB;AAM7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,sBAAkB;AAE1E,OAAO,KAAK,EAAa,eAAe,EAAE,KAAK,EAAE,0BAAgB;AAGjE;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,CACjC,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,IACzC,IAAI,CACN,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EACjC,MAAM,qBAAqB,CAAC,OAAO,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CACzE,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,CAC5B,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAAC,OAAO,CAAC,CACzC,IACC,uBAAuB,CAAC,OAAO,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAC9D;IACE,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uBAAuB,CAAC,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC3D,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC,GACD;IACE,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uBAAuB,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC1D,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC,CAAC;AAEN,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;IACb,gBAAgB,EAAE,YAAY,CAAC,OAAO,wBAAwB,CAAC,CAAC;IAChE,mBAAmB,EAAE,mBAAmB,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;IAC5E,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,WAAW,EAAE,CACX,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,qBAAqB,KAC5B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE5B;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC;IAC3B,eAAe,EAAE,CAAC,OAAO,EAAE,SAAS,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACzD,eAAe,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnE,iBAAiB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,cAAc,CAAC;IAClD,gBAAgB,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAChC,EAED,MAAM,EAAE,MAAM,EACd,EACE,gBAAgB,EAChB,uBAAuB,EACvB,OAAO,EAAE,UAAe,GACzB,GAAE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAM,GAC3C,OAAO,CAAC,aAAa,CAAC,CAgFxB;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,OAAO,EAAE,iBAAiB,EAC1B,SAAS,EAAE,gBAAgB,EAC3B,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,uBAAuB,GAC3C,eAAe,CAgCjB;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,mBAAmB,EAAE,uBAAuB,EAC5C,OAAO,EAAE,eAAe,QA4CzB"}

package/dist/internals/simulation/simulation.d.mts

@@ -0,0 +1,103 @@
+import type { ActionConstraint, EventConstraint } from "@metamask/base-controller";
+import { ControllerMessenger } from "@metamask/base-controller";
+import type { AbstractExecutionService } from "@metamask/snaps-controllers";
+import type { AuxiliaryFileEncoding, Component, InterfaceState, SnapId } from "@metamask/snaps-sdk";
+import type { FetchedSnapFiles } from "@metamask/snaps-utils";
+import type { Json } from "@metamask/utils";
+import type { RootControllerMessenger } from "./controllers.mjs";
+import type { SimulationOptions, SimulationUserOptions } from "./options.mjs";
+import type { RunSagaFunction, Store } from "./store/index.mjs";
+/**
+ * Options for the execution service, without the options that are shared
+ * between all execution services.
+ *
+ * @template Service - The type of the execution service, i.e., the class that
+ * creates the execution service.
+ */
+export type ExecutionServiceOptions<Service extends new (...args: any[]) => any> = Omit<ConstructorParameters<Service>[0], keyof ConstructorParameters<typeof AbstractExecutionService<unknown>>[0]>;
+/**
+ * The options for running a Snap in a simulated environment.
+ *
+ * @property executionService - The execution service to use.
+ * @property executionServiceOptions - The options to use when creating the
+ * execution service, if any. This should only include options specific to the
+ * provided execution service.
+ * @property options - The simulation options.
+ * @template Service - The type of the execution service.
+ */
+export type InstallSnapOptions<Service extends new (...args: any[]) => InstanceType<typeof AbstractExecutionService<unknown>>> = ExecutionServiceOptions<Service> extends Record<string, never> ? {
+    executionService: Service;
+    executionServiceOptions?: ExecutionServiceOptions<Service>;
+    options?: SimulationUserOptions;
+} : {
+    executionService: Service;
+    executionServiceOptions: ExecutionServiceOptions<Service>;
+    options?: SimulationUserOptions;
+};
+export type InstalledSnap = {
+    snapId: SnapId;
+    store: Store;
+    executionService: InstanceType<typeof AbstractExecutionService>;
+    controllerMessenger: ControllerMessenger<ActionConstraint, EventConstraint>;
+    runSaga: RunSagaFunction;
+};
+export type MiddlewareHooks = {
+    /**
+     * A hook that returns the user's secret recovery phrase.
+     *
+     * @returns The user's secret recovery phrase.
+     */
+    getMnemonic: () => Promise<Uint8Array>;
+    /**
+     * A hook that returns the Snap's auxiliary file for the given path.
+     *
+     * @param path - The path of the auxiliary file to get.
+     * @param encoding - The encoding to use when returning the file.
+     * @returns The Snap's auxiliary file for the given path.
+     */
+    getSnapFile: (path: string, encoding: AuxiliaryFileEncoding) => Promise<string | null>;
+    /**
+     * A hook that returns whether the client is locked or not.
+     *
+     * @returns A boolean flag signaling whether the client is locked.
+     */
+    getIsLocked: () => boolean;
+    createInterface: (content: Component) => Promise<string>;
+    updateInterface: (id: string, content: Component) => Promise<void>;
+    getInterfaceState: (id: string) => InterfaceState;
+    resolveInterface: (id: string, value: Json) => Promise<void>;
+};
+/**
+ * Install a Snap in a simulated environment. This will fetch the Snap files,
+ * create a Redux store, set up the controllers and JSON-RPC stack, register the
+ * Snap, and run the Snap code in the execution service.
+ *
+ * @param snapId - The ID of the Snap to install.
+ * @param options - The options to use when installing the Snap.
+ * @param options.executionService - The execution service to use.
+ * @param options.executionServiceOptions - The options to use when creating the
+ * execution service, if any. This should only include options specific to the
+ * provided execution service.
+ * @param options.options - The simulation options.
+ * @returns The installed Snap object.
+ * @template Service - The type of the execution service.
+ */
+export declare function handleInstallSnap<Service extends new (...args: any[]) => InstanceType<typeof AbstractExecutionService>>(snapId: SnapId, { executionService, executionServiceOptions, options: rawOptions, }?: Partial<InstallSnapOptions<Service>>): Promise<InstalledSnap>;
+/**
+ * Get the hooks for the simulation.
+ *
+ * @param options - The simulation options.
+ * @param snapFiles - The Snap files.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The hooks for the simulation.
+ */
+export declare function getHooks(options: SimulationOptions, snapFiles: FetchedSnapFiles, snapId: SnapId, controllerMessenger: RootControllerMessenger): MiddlewareHooks;
+/**
+ * Register mocked action handlers.
+ *
+ * @param controllerMessenger - The controller messenger.
+ * @param runSaga - The run saga function.
+ */
+export declare function registerActions(controllerMessenger: RootControllerMessenger, runSaga: RunSagaFunction): void;
+//# sourceMappingURL=simulation.d.mts.map

package/dist/internals/simulation/simulation.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulation.d.mts","sourceRoot":"","sources":["../../../src/internals/simulation/simulation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EAChB,kCAAkC;AACnC,OAAO,EAAE,mBAAmB,EAAE,kCAAkC;AAIhE,OAAO,KAAK,EAAE,wBAAwB,EAAE,oCAAoC;AAQ5E,OAAO,KAAK,EACV,qBAAqB,EACrB,SAAS,EACT,cAAc,EACd,MAAM,EACP,4BAA4B;AAC7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,8BAA8B;AAE9D,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAM5C,OAAO,KAAK,EAAE,uBAAuB,EAAE,0BAAsB;AAM7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,sBAAkB;AAE1E,OAAO,KAAK,EAAa,eAAe,EAAE,KAAK,EAAE,0BAAgB;AAGjE;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,CACjC,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,IACzC,IAAI,CACN,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EACjC,MAAM,qBAAqB,CAAC,OAAO,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CACzE,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,CAC5B,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAAC,OAAO,CAAC,CACzC,IACC,uBAAuB,CAAC,OAAO,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAC9D;IACE,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uBAAuB,CAAC,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC3D,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC,GACD;IACE,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uBAAuB,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC1D,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC,CAAC;AAEN,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;IACb,gBAAgB,EAAE,YAAY,CAAC,OAAO,wBAAwB,CAAC,CAAC;IAChE,mBAAmB,EAAE,mBAAmB,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;IAC5E,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,WAAW,EAAE,CACX,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,qBAAqB,KAC5B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE5B;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC;IAC3B,eAAe,EAAE,CAAC,OAAO,EAAE,SAAS,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACzD,eAAe,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnE,iBAAiB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,cAAc,CAAC;IAClD,gBAAgB,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAChC,EAED,MAAM,EAAE,MAAM,EACd,EACE,gBAAgB,EAChB,uBAAuB,EACvB,OAAO,EAAE,UAAe,GACzB,GAAE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAM,GAC3C,OAAO,CAAC,aAAa,CAAC,CAgFxB;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,OAAO,EAAE,iBAAiB,EAC1B,SAAS,EAAE,gBAAgB,EAC3B,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,uBAAuB,GAC3C,eAAe,CAgCjB;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,mBAAmB,EAAE,uBAAuB,EAC5C,OAAO,EAAE,eAAe,QA4CzB"}

package/dist/internals/simulation/simulation.mjs

@@ -1,39 +1,150 @@
-import {
-  getHooks,
-  handleInstallSnap,
-  registerActions
-} from "../../chunk-Q3I6P2ZF.mjs";
-import "../../chunk-ZG33OGC3.mjs";
-import "../../chunk-3J2IBWXV.mjs";
-import "../../chunk-6HHV6YFQ.mjs";
-import "../../chunk-Q2OQXAUM.mjs";
-import "../../chunk-VOYBI6T4.mjs";
-import "../../chunk-IXKO6X55.mjs";
-import "../../chunk-FP4H3ADT.mjs";
-import "../../chunk-6JPBXAHM.mjs";
-import "../../chunk-IWJ4HKDR.mjs";
-import "../../chunk-G333FBBL.mjs";
-import "../../chunk-LVNNGMJ2.mjs";
-import "../../chunk-LSKT2AUS.mjs";
-import "../../chunk-NTOY6Y4Q.mjs";
-import "../../chunk-OHRFO2BL.mjs";
-import "../../chunk-UDOXICJK.mjs";
-import "../../chunk-QRVFWATH.mjs";
-import "../../chunk-FQWOVTBB.mjs";
-import "../../chunk-ALRZENWP.mjs";
-import "../../chunk-24CGIQLL.mjs";
-import "../../chunk-5U5WB3SM.mjs";
-import "../../chunk-RQKT6BQ2.mjs";
-import "../../chunk-ORR7AE5X.mjs";
-import "../../chunk-ZJQSGRNK.mjs";
-import "../../chunk-H2464AXT.mjs";
-import "../../chunk-LB4R3BUA.mjs";
-import "../../chunk-MPZOXW6I.mjs";
-import "../../chunk-57SGDM5B.mjs";
-import "../../chunk-JMDSN227.mjs";
-export {
-  getHooks,
-  handleInstallSnap,
-  registerActions
-};
+import { ControllerMessenger } from "@metamask/base-controller";
+import { createEngineStream } from "@metamask/json-rpc-middleware-stream";
+import { mnemonicPhraseToBytes } from "@metamask/key-tree";
+import { PhishingDetectorResultType } from "@metamask/phishing-controller";
+import { detectSnapLocation, fetchSnap, NodeThreadExecutionService, setupMultiplex } from "@metamask/snaps-controllers/node";
+import { DIALOG_APPROVAL_TYPES } from "@metamask/snaps-rpc-methods";
+import { logError } from "@metamask/snaps-utils";
+import { pipeline } from "readable-stream";
+import $reduxsagaeffects from "redux-saga/effects";
+const { select } = $reduxsagaeffects;
+import { getControllers, registerSnap } from "./controllers.mjs";
+import { getSnapFile } from "./files.mjs";
+import { resolveWithSaga } from "./interface.mjs";
+import { getEndowments } from "./methods/index.mjs";
+import { createJsonRpcEngine } from "./middleware/index.mjs";
+import { getOptions } from "./options.mjs";
+import { createStore, getCurrentInterface } from "./store/index.mjs";
+/**
+ * Install a Snap in a simulated environment. This will fetch the Snap files,
+ * create a Redux store, set up the controllers and JSON-RPC stack, register the
+ * Snap, and run the Snap code in the execution service.
+ *
+ * @param snapId - The ID of the Snap to install.
+ * @param options - The options to use when installing the Snap.
+ * @param options.executionService - The execution service to use.
+ * @param options.executionServiceOptions - The options to use when creating the
+ * execution service, if any. This should only include options specific to the
+ * provided execution service.
+ * @param options.options - The simulation options.
+ * @returns The installed Snap object.
+ * @template Service - The type of the execution service.
+ */
+export async function handleInstallSnap(snapId, { executionService, executionServiceOptions, options: rawOptions = {}, } = {}) {
+    const options = getOptions(rawOptions);
+    // Fetch Snap files.
+    const location = detectSnapLocation(snapId, {
+        allowLocal: true,
+    });
+    const snapFiles = await fetchSnap(snapId, location);
+    // Create Redux store.
+    const { store, runSaga } = createStore(options);
+    const controllerMessenger = new ControllerMessenger();
+    registerActions(controllerMessenger, runSaga);
+    // Set up controllers and JSON-RPC stack.
+    const hooks = getHooks(options, snapFiles, snapId, controllerMessenger);
+    const { subjectMetadataController, permissionController } = getControllers({
+        controllerMessenger,
+        hooks,
+        runSaga,
+        options,
+    });
+    const engine = createJsonRpcEngine({
+        store,
+        hooks,
+        permissionMiddleware: permissionController.createPermissionMiddleware({
+            origin: snapId,
+        }),
+    });
+    // Create execution service.
+    const ExecutionService = executionService ?? NodeThreadExecutionService;
+    const service = new ExecutionService({
+        ...executionServiceOptions,
+        messenger: controllerMessenger.getRestricted({
+            name: 'ExecutionService',
+            allowedActions: [],
+            allowedEvents: [],
+        }),
+        setupSnapProvider: (_snapId, rpcStream) => {
+            const mux = setupMultiplex(rpcStream, 'snapStream');
+            const stream = mux.createStream('metamask-provider');
+            const providerStream = createEngineStream({ engine });
+            // Error function is difficult to test, so we ignore it.
+            /* istanbul ignore next 2 */
+            pipeline(stream, providerStream, stream, (error) => {
+                if (error) {
+                    logError(`Provider stream failure.`, error);
+                }
+            });
+        },
+    });
+    // Register the Snap. This sets up the Snap's permissions and subject
+    // metadata.
+    await registerSnap(snapId, snapFiles.manifest.result, {
+        permissionController,
+        subjectMetadataController,
+    });
+    // Run the Snap code in the execution service.
+    await service.executeSnap({
+        snapId,
+        sourceCode: snapFiles.sourceCode.toString('utf8'),
+        endowments: await getEndowments(permissionController, snapId),
+    });
+    return {
+        snapId,
+        store,
+        executionService: service,
+        controllerMessenger,
+        runSaga,
+    };
+}
+/**
+ * Get the hooks for the simulation.
+ *
+ * @param options - The simulation options.
+ * @param snapFiles - The Snap files.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The hooks for the simulation.
+ */
+export function getHooks(options, snapFiles, snapId, controllerMessenger) {
+    return {
+        getMnemonic: async () => Promise.resolve(mnemonicPhraseToBytes(options.secretRecoveryPhrase)),
+        getSnapFile: async (path, encoding) => await getSnapFile(snapFiles.auxiliaryFiles, path, encoding),
+        getIsLocked: () => false,
+        createInterface: async (...args) => controllerMessenger.call('SnapInterfaceController:createInterface', snapId, ...args),
+        updateInterface: async (...args) => controllerMessenger.call('SnapInterfaceController:updateInterface', snapId, ...args),
+        getInterfaceState: (...args) => controllerMessenger.call('SnapInterfaceController:getInterface', snapId, ...args).state,
+        resolveInterface: async (...args) => controllerMessenger.call('SnapInterfaceController:resolveInterface', snapId, ...args),
+    };
+}
+/**
+ * Register mocked action handlers.
+ *
+ * @param controllerMessenger - The controller messenger.
+ * @param runSaga - The run saga function.
+ */
+export function registerActions(controllerMessenger, runSaga) {
+    controllerMessenger.registerActionHandler('PhishingController:maybeUpdateState', async () => Promise.resolve());
+    controllerMessenger.registerActionHandler('PhishingController:testOrigin', () => ({ result: false, type: PhishingDetectorResultType.All }));
+    controllerMessenger.registerActionHandler('ApprovalController:hasRequest', (opts) => {
+        /**
+         * Get the current interface from the store.
+         *
+         * @yields Selects the current interface from the store.
+         * @returns The current interface.
+         */
+        function* getCurrentInterfaceSaga() {
+            const currentInterface = yield select(getCurrentInterface);
+            return currentInterface;
+        }
+        const currentInterface = runSaga(getCurrentInterfaceSaga).result();
+        return (currentInterface?.type === DIALOG_APPROVAL_TYPES.default &&
+            currentInterface?.id === opts?.id);
+    });
+    controllerMessenger.registerActionHandler('ApprovalController:acceptRequest', async (_id, value) => {
+        await runSaga(resolveWithSaga, value).toPromise();
+        return { value };
+    });
+}
 //# sourceMappingURL=simulation.mjs.map

package/dist/internals/simulation/simulation.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"simulation.mjs","sourceRoot":"","sources":["../../../src/internals/simulation/simulation.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,kCAAkC;AAChE,OAAO,EAAE,kBAAkB,EAAE,6CAA6C;AAC1E,OAAO,EAAE,qBAAqB,EAAE,2BAA2B;AAC3D,OAAO,EAAE,0BAA0B,EAAE,sCAAsC;AAE3E,OAAO,EACL,kBAAkB,EAClB,SAAS,EACT,0BAA0B,EAC1B,cAAc,EACf,yCAAyC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,oCAAoC;AAQpE,OAAO,EAAE,QAAQ,EAAE,8BAA8B;AAGjD,OAAO,EAAE,QAAQ,EAAE,wBAAwB;;;AAK3C,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,0BAAsB;AAC7D,OAAO,EAAE,WAAW,EAAE,oBAAgB;AACtC,OAAO,EAAE,eAAe,EAAE,wBAAoB;AAC9C,OAAO,EAAE,aAAa,EAAE,4BAAkB;AAC1C,OAAO,EAAE,mBAAmB,EAAE,+BAAqB;AAEnD,OAAO,EAAE,UAAU,EAAE,sBAAkB;AAEvC,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,0BAAgB;AAkF3D;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAKrC,MAAc,EACd,EACE,gBAAgB,EAChB,uBAAuB,EACvB,OAAO,EAAE,UAAU,GAAG,EAAE,MACgB,EAAE;IAE5C,MAAM,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;IAEvC,oBAAoB;IACpB,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,EAAE;QAC1C,UAAU,EAAE,IAAI;KACjB,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAEpD,sBAAsB;IACtB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAEhD,MAAM,mBAAmB,GAAG,IAAI,mBAAmB,EAAY,CAAC;IAEhE,eAAe,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAE9C,yCAAyC;IACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAExE,MAAM,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,GAAG,cAAc,CAAC;QACzE,mBAAmB;QACnB,KAAK;QACL,OAAO;QACP,OAAO;KACR,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,mBAAmB,CAAC;QACjC,KAAK;QACL,KAAK;QACL,oBAAoB,EAAE,oBAAoB,CAAC,0BAA0B,CAAC;YACpE,MAAM,EAAE,MAAM;SACf,CAAC;KACH,CAAC,CAAC;IAEH,4BAA4B;IAC5B,MAAM,gBAAgB,GAAG,gBAAgB,IAAI,0BAA0B,CAAC;IACxE,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;QACnC,GAAG,uBAAuB;QAC1B,SAAS,EAAE,mBAAmB,CAAC,aAAa,CAAC;YAC3C,IAAI,EAAE,kBAAkB;YACxB,cAAc,EAAE,EAAE;YAClB,aAAa,EAAE,EAAE;SAClB,CAAC;QACF,iBAAiB,EAAE,CAAC,OAAe,EAAE,SAAiB,EAAE,EAAE;YACxD,MAAM,GAAG,GAAG,cAAc,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;YACrD,MAAM,cAAc,GAAG,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YAEtD,wDAAwD;YACxD,4BAA4B;YAC5B,QAAQ,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,KAAc,EAAE,EAAE;gBAC1D,IAAI,KAAK,EAAE,CAAC;oBACV,QAAQ,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;IAEH,qEAAqE;IACrE,YAAY;IACZ,MAAM,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;QACpD,oBAAoB;QACpB,yBAAyB;KAC1B,CAAC,CAAC;IAEH,8CAA8C;IAC9C,MAAM,OAAO,CAAC,WAAW,CAAC;QACxB,MAAM;QACN,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC;QACjD,UAAU,EAAE,MAAM,aAAa,CAAC,oBAAoB,EAAE,MAAM,CAAC;KAC9D,CAAC,CAAC;IAEH,OAAO;QACL,MAAM;QACN,KAAK;QACL,gBAAgB,EAAE,OAAO;QACzB,mBAAmB;QACnB,OAAO;KACR,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ,CACtB,OAA0B,EAC1B,SAA2B,EAC3B,MAAc,EACd,mBAA4C;IAE5C,OAAO;QACL,WAAW,EAAE,KAAK,IAAI,EAAE,CACtB,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QACtE,WAAW,EAAE,KAAK,EAAE,IAAY,EAAE,QAA+B,EAAE,EAAE,CACnE,MAAM,WAAW,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,QAAQ,CAAC;QAC7D,WAAW,EAAE,GAAG,EAAE,CAAC,KAAK;QACxB,eAAe,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CACjC,mBAAmB,CAAC,IAAI,CACtB,yCAAyC,EACzC,MAAM,EACN,GAAG,IAAI,CACR;QACH,eAAe,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CACjC,mBAAmB,CAAC,IAAI,CACtB,yCAAyC,EACzC,MAAM,EACN,GAAG,IAAI,CACR;QACH,iBAAiB,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAC7B,mBAAmB,CAAC,IAAI,CACtB,sCAAsC,EACtC,MAAM,EACN,GAAG,IAAI,CACR,CAAC,KAAK;QACT,gBAAgB,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAClC,mBAAmB,CAAC,IAAI,CACtB,0CAA0C,EAC1C,MAAM,EACN,GAAG,IAAI,CACR;KACJ,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAC7B,mBAA4C,EAC5C,OAAwB;IAExB,mBAAmB,CAAC,qBAAqB,CACvC,qCAAqC,EACrC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAC9B,CAAC;IAEF,mBAAmB,CAAC,qBAAqB,CACvC,+BAA+B,EAC/B,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,CAChE,CAAC;IAEF,mBAAmB,CAAC,qBAAqB,CACvC,+BAA+B,EAC/B,CAAC,IAAI,EAAE,EAAE;QACP;;;;;WAKG;QACH,QAAQ,CAAC,CAAC,uBAAuB;YAC/B,MAAM,gBAAgB,GAAc,MAAM,MAAM,CAAC,mBAAmB,CAAC,CAAC;YACtE,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,gBAAgB,GAA0B,OAAO,CACrD,uBAAuB,CACxB,CAAC,MAAM,EAAE,CAAC;QACX,OAAO,CACL,gBAAgB,EAAE,IAAI,KAAK,qBAAqB,CAAC,OAAO;YACxD,gBAAgB,EAAE,EAAE,KAAK,IAAI,EAAE,EAAE,CAClC,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,mBAAmB,CAAC,qBAAqB,CACvC,kCAAkC,EAClC,KAAK,EAAE,GAAW,EAAE,KAAc,EAAE,EAAE;QACpC,MAAM,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;QAElD,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["import type {\n  ActionConstraint,\n  EventConstraint,\n} from '@metamask/base-controller';\nimport { ControllerMessenger } from '@metamask/base-controller';\nimport { createEngineStream } from '@metamask/json-rpc-middleware-stream';\nimport { mnemonicPhraseToBytes } from '@metamask/key-tree';\nimport { PhishingDetectorResultType } from '@metamask/phishing-controller';\nimport type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport {\n  detectSnapLocation,\n  fetchSnap,\n  NodeThreadExecutionService,\n  setupMultiplex,\n} from '@metamask/snaps-controllers/node';\nimport { DIALOG_APPROVAL_TYPES } from '@metamask/snaps-rpc-methods';\nimport type {\n  AuxiliaryFileEncoding,\n  Component,\n  InterfaceState,\n  SnapId,\n} from '@metamask/snaps-sdk';\nimport type { FetchedSnapFiles } from '@metamask/snaps-utils';\nimport { logError } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\nimport type { Duplex } from 'readable-stream';\nimport { pipeline } from 'readable-stream';\nimport type { SagaIterator } from 'redux-saga';\nimport { select } from 'redux-saga/effects';\n\nimport type { RootControllerMessenger } from './controllers';\nimport { getControllers, registerSnap } from './controllers';\nimport { getSnapFile } from './files';\nimport { resolveWithSaga } from './interface';\nimport { getEndowments } from './methods';\nimport { createJsonRpcEngine } from './middleware';\nimport type { SimulationOptions, SimulationUserOptions } from './options';\nimport { getOptions } from './options';\nimport type { Interface, RunSagaFunction, Store } from './store';\nimport { createStore, getCurrentInterface } from './store';\n\n/**\n * Options for the execution service, without the options that are shared\n * between all execution services.\n *\n * @template Service - The type of the execution service, i.e., the class that\n * creates the execution service.\n */\nexport type ExecutionServiceOptions<\n  Service extends new (...args: any[]) => any,\n> = Omit<\n  ConstructorParameters<Service>[0],\n  keyof ConstructorParameters<typeof AbstractExecutionService<unknown>>[0]\n>;\n\n/**\n * The options for running a Snap in a simulated environment.\n *\n * @property executionService - The execution service to use.\n * @property executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @property options - The simulation options.\n * @template Service - The type of the execution service.\n */\nexport type InstallSnapOptions<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService<unknown>\n  >,\n> = ExecutionServiceOptions<Service> extends Record<string, never>\n  ? {\n      executionService: Service;\n      executionServiceOptions?: ExecutionServiceOptions<Service>;\n      options?: SimulationUserOptions;\n    }\n  : {\n      executionService: Service;\n      executionServiceOptions: ExecutionServiceOptions<Service>;\n      options?: SimulationUserOptions;\n    };\n\nexport type InstalledSnap = {\n  snapId: SnapId;\n  store: Store;\n  executionService: InstanceType<typeof AbstractExecutionService>;\n  controllerMessenger: ControllerMessenger<ActionConstraint, EventConstraint>;\n  runSaga: RunSagaFunction;\n};\n\nexport type MiddlewareHooks = {\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  /**\n   * A hook that returns the Snap's auxiliary file for the given path.\n   *\n   * @param path - The path of the auxiliary file to get.\n   * @param encoding - The encoding to use when returning the file.\n   * @returns The Snap's auxiliary file for the given path.\n   */\n  getSnapFile: (\n    path: string,\n    encoding: AuxiliaryFileEncoding,\n  ) => Promise<string | null>;\n\n  /**\n   * A hook that returns whether the client is locked or not.\n   *\n   * @returns A boolean flag signaling whether the client is locked.\n   */\n  getIsLocked: () => boolean;\n  createInterface: (content: Component) => Promise<string>;\n  updateInterface: (id: string, content: Component) => Promise<void>;\n  getInterfaceState: (id: string) => InterfaceState;\n  resolveInterface: (id: string, value: Json) => Promise<void>;\n};\n\n/**\n * Install a Snap in a simulated environment. This will fetch the Snap files,\n * create a Redux store, set up the controllers and JSON-RPC stack, register the\n * Snap, and run the Snap code in the execution service.\n *\n * @param snapId - The ID of the Snap to install.\n * @param options - The options to use when installing the Snap.\n * @param options.executionService - The execution service to use.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\n * @returns The installed Snap object.\n * @template Service - The type of the execution service.\n */\nexport async function handleInstallSnap<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId: SnapId,\n  {\n    executionService,\n    executionServiceOptions,\n    options: rawOptions = {},\n  }: Partial<InstallSnapOptions<Service>> = {},\n): Promise<InstalledSnap> {\n  const options = getOptions(rawOptions);\n\n  // Fetch Snap files.\n  const location = detectSnapLocation(snapId, {\n    allowLocal: true,\n  });\n\n  const snapFiles = await fetchSnap(snapId, location);\n\n  // Create Redux store.\n  const { store, runSaga } = createStore(options);\n\n  const controllerMessenger = new ControllerMessenger<any, any>();\n\n  registerActions(controllerMessenger, runSaga);\n\n  // Set up controllers and JSON-RPC stack.\n  const hooks = getHooks(options, snapFiles, snapId, controllerMessenger);\n\n  const { subjectMetadataController, permissionController } = getControllers({\n    controllerMessenger,\n    hooks,\n    runSaga,\n    options,\n  });\n\n  const engine = createJsonRpcEngine({\n    store,\n    hooks,\n    permissionMiddleware: permissionController.createPermissionMiddleware({\n      origin: snapId,\n    }),\n  });\n\n  // Create execution service.\n  const ExecutionService = executionService ?? NodeThreadExecutionService;\n  const service = new ExecutionService({\n    ...executionServiceOptions,\n    messenger: controllerMessenger.getRestricted({\n      name: 'ExecutionService',\n      allowedActions: [],\n      allowedEvents: [],\n    }),\n    setupSnapProvider: (_snapId: string, rpcStream: Duplex) => {\n      const mux = setupMultiplex(rpcStream, 'snapStream');\n      const stream = mux.createStream('metamask-provider');\n      const providerStream = createEngineStream({ engine });\n\n      // Error function is difficult to test, so we ignore it.\n      /* istanbul ignore next 2 */\n      pipeline(stream, providerStream, stream, (error: unknown) => {\n        if (error) {\n          logError(`Provider stream failure.`, error);\n        }\n      });\n    },\n  });\n\n  // Register the Snap. This sets up the Snap's permissions and subject\n  // metadata.\n  await registerSnap(snapId, snapFiles.manifest.result, {\n    permissionController,\n    subjectMetadataController,\n  });\n\n  // Run the Snap code in the execution service.\n  await service.executeSnap({\n    snapId,\n    sourceCode: snapFiles.sourceCode.toString('utf8'),\n    endowments: await getEndowments(permissionController, snapId),\n  });\n\n  return {\n    snapId,\n    store,\n    executionService: service,\n    controllerMessenger,\n    runSaga,\n  };\n}\n\n/**\n * Get the hooks for the simulation.\n *\n * @param options - The simulation options.\n * @param snapFiles - The Snap files.\n * @param snapId - The Snap ID.\n * @param controllerMessenger - The controller messenger.\n * @returns The hooks for the simulation.\n */\nexport function getHooks(\n  options: SimulationOptions,\n  snapFiles: FetchedSnapFiles,\n  snapId: SnapId,\n  controllerMessenger: RootControllerMessenger,\n): MiddlewareHooks {\n  return {\n    getMnemonic: async () =>\n      Promise.resolve(mnemonicPhraseToBytes(options.secretRecoveryPhrase)),\n    getSnapFile: async (path: string, encoding: AuxiliaryFileEncoding) =>\n      await getSnapFile(snapFiles.auxiliaryFiles, path, encoding),\n    getIsLocked: () => false,\n    createInterface: async (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:createInterface',\n        snapId,\n        ...args,\n      ),\n    updateInterface: async (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:updateInterface',\n        snapId,\n        ...args,\n      ),\n    getInterfaceState: (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:getInterface',\n        snapId,\n        ...args,\n      ).state,\n    resolveInterface: async (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:resolveInterface',\n        snapId,\n        ...args,\n      ),\n  };\n}\n\n/**\n * Register mocked action handlers.\n *\n * @param controllerMessenger - The controller messenger.\n * @param runSaga - The run saga function.\n */\nexport function registerActions(\n  controllerMessenger: RootControllerMessenger,\n  runSaga: RunSagaFunction,\n) {\n  controllerMessenger.registerActionHandler(\n    'PhishingController:maybeUpdateState',\n    async () => Promise.resolve(),\n  );\n\n  controllerMessenger.registerActionHandler(\n    'PhishingController:testOrigin',\n    () => ({ result: false, type: PhishingDetectorResultType.All }),\n  );\n\n  controllerMessenger.registerActionHandler(\n    'ApprovalController:hasRequest',\n    (opts) => {\n      /**\n       * Get the current interface from the store.\n       *\n       * @yields Selects the current interface from the store.\n       * @returns The current interface.\n       */\n      function* getCurrentInterfaceSaga(): SagaIterator {\n        const currentInterface: Interface = yield select(getCurrentInterface);\n        return currentInterface;\n      }\n\n      const currentInterface: Interface | undefined = runSaga(\n        getCurrentInterfaceSaga,\n      ).result();\n      return (\n        currentInterface?.type === DIALOG_APPROVAL_TYPES.default &&\n        currentInterface?.id === opts?.id\n      );\n    },\n  );\n\n  controllerMessenger.registerActionHandler(\n    'ApprovalController:acceptRequest',\n    async (_id: string, value: unknown) => {\n      await runSaga(resolveWithSaga, value).toPromise();\n\n      return { value };\n    },\n  );\n}\n"]}

package/dist/internals/simulation/store/index.cjs

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./notifications.cjs"), exports);
+__exportStar(require("./state.cjs"), exports);
+__exportStar(require("./store.cjs"), exports);
+__exportStar(require("./ui.cjs"), exports);
+//# sourceMappingURL=index.cjs.map