@metamask/snaps-jest 8.1.3 → 8.3.0

package/CHANGELOG.md

@@ -6,6 +6,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [8.3.0]
+### Added
+- Add support for `snap_getPreferences` ([#2607](https://github.com/MetaMask/snaps/pull/2607))
+- Add `RadioButton` component ([#2592](https://github.com/MetaMask/snaps/pull/2592))
+- Add support for custom dialogs in `snaps-jest` ([#2526](https://github.com/MetaMask/snaps/pull/2526), [#2509](https://github.com/MetaMask/snaps/pull/2509))
+
+### Changed
+- Replace `superstruct` with ESM-compatible fork `@metamask/superstruct` ([#2445](https://github.com/MetaMask/snaps/pull/2445))
+
+## [8.2.0]
+### Added
+- Add support for `Checkbox` to `snaps-jest` ([#2515](https://github.com/MetaMask/snaps/pull/2515))
+  - Checkboxes can be interacted with using `clickElement`.
+- Add support for `FileInput` to `snaps-jest` ([#2494](https://github.com/MetaMask/snaps/pull/2494))
+  - Files can be uploaded to file inputs using `uploadFile`.
+
 ## [8.1.3]
 ### Changed
 - Bump MetaMask dependencies ([#2460](https://github.com/MetaMask/snaps/pull/2460), [#2477](https://github.com/MetaMask/snaps/pull/2477))
@@ -165,7 +181,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@8.1.3...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@8.3.0...HEAD
+[8.3.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@8.2.0...@metamask/snaps-jest@8.3.0
+[8.2.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@8.1.3...@metamask/snaps-jest@8.2.0
 [8.1.3]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@8.1.2...@metamask/snaps-jest@8.1.3
 [8.1.2]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@8.1.1...@metamask/snaps-jest@8.1.2
 [8.1.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@8.1.0...@metamask/snaps-jest@8.1.1

package/README.md

@@ -362,7 +362,7 @@ functions that can be used to interact with the user interface.
 ##### Example
 
 ```js
-import { installSnap } from '@metamask/snaps-jest';
+import { installSnap, assertIsAlertDialog } from '@metamask/snaps-jest';
 import { text } from '@metamask/snaps-sdk';
 import { assert } from '@metamask/utils';
 
@@ -379,7 +379,7 @@ describe('MySnap', () => {
 
     // This is useful if you're using TypeScript, since it will infer the type
     // of the user interface.
-    assert(ui.type === 'alert');
+    assertIsAlertDialog(ui);
     expect(ui).toRender(text('Hello, world!'));
 
     // "Click" the OK button.

package/dist/chunk-24CGIQLL.mjs

@@ -0,0 +1,30 @@
+import {
+  closeInterface,
+  resolveInterface,
+  setInterface
+} from "./chunk-ZJQSGRNK.mjs";
+
+// src/internals/simulation/methods/hooks/request-user-approval.ts
+import { put, take } from "redux-saga/effects";
+function* requestUserApprovalImplementation({
+  type,
+  requestData: { id }
+}) {
+  yield put(setInterface({ type, id }));
+  const { payload } = yield take(resolveInterface.type);
+  yield put(closeInterface());
+  return payload;
+}
+function getRequestUserApprovalImplementation(runSaga) {
+  return async (...args) => {
+    return await runSaga(
+      requestUserApprovalImplementation,
+      ...args
+    ).toPromise();
+  };
+}
+
+export {
+  getRequestUserApprovalImplementation
+};
+//# sourceMappingURL=chunk-24CGIQLL.mjs.map

package/dist/chunk-24CGIQLL.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/methods/hooks/request-user-approval.ts"],"sourcesContent":["import type { SagaIterator } from 'redux-saga';\nimport { put, take } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../store';\nimport { resolveInterface, setInterface, closeInterface } from '../../store';\n\ntype RequestUserApprovalParams = {\n  type: string;\n  requestData: {\n    id: string;\n  };\n};\n\n/**\n * Show a dialog to the user. This will wait for `resolveUserInterface` to be\n * dispatched before returning.\n *\n * @param opts - The options for the request.\n * @param opts.type - The type of dialog to show.\n * @param opts.requestData - The data to display in the dialog.\n * @param opts.requestData.id - The ID of the interface.\n * @yields Sets the dialog in the store, waits for the user to resolve the\n * dialog, and closes the dialog.\n * @returns The result of the dialog.\n */\nfunction* requestUserApprovalImplementation({\n  type,\n  requestData: { id },\n}: RequestUserApprovalParams): SagaIterator<unknown> {\n  yield put(setInterface({ type, id }));\n\n  // We use `take` to wait for `resolveUserInterface` to be dispatched, which\n  // indicates that the user has resolved the dialog.\n  const { payload } = yield take(resolveInterface.type);\n  yield put(closeInterface());\n\n  return payload;\n}\n\n/**\n * Get the implementation of the `requestUserApproval` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `requestUserApproval` hook.\n */\nexport function getRequestUserApprovalImplementation(runSaga: RunSagaFunction) {\n  return async (\n    ...args: Parameters<typeof requestUserApprovalImplementation>\n  ) => {\n    return await runSaga(\n      requestUserApprovalImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n"],"mappings":";;;;;;;AACA,SAAS,KAAK,YAAY;AAwB1B,UAAU,kCAAkC;AAAA,EAC1C;AAAA,EACA,aAAa,EAAE,GAAG;AACpB,GAAqD;AACnD,QAAM,IAAI,aAAa,EAAE,MAAM,GAAG,CAAC,CAAC;AAIpC,QAAM,EAAE,QAAQ,IAAI,MAAM,KAAK,iBAAiB,IAAI;AACpD,QAAM,IAAI,eAAe,CAAC;AAE1B,SAAO;AACT;AAQO,SAAS,qCAAqC,SAA0B;AAC7E,SAAO,UACF,SACA;AACH,WAAO,MAAM;AAAA,MACX;AAAA,MACA,GAAG;AAAA,IACL,EAAE,UAAU;AAAA,EACd;AACF;","names":[]}

package/dist/{chunk-T2PHS5FY.js → chunk-2RJYSYUB.js}

@@ -7,7 +7,7 @@
 
 
 
-var _superstruct = require('superstruct');
+var _superstruct = require('@metamask/superstruct');
 var SnapsEnvironmentOptionsStruct = _superstruct.type.call(void 0, {
   server: _superstruct.defaulted.call(void 0, 
     _superstruct.object.call(void 0, {
@@ -25,4 +25,4 @@ function getOptions(testEnvironmentOptions) {
 
 
 exports.getOptions = getOptions;
-//# sourceMappingURL=chunk-T2PHS5FY.js.map
+//# sourceMappingURL=chunk-2RJYSYUB.js.map

package/dist/chunk-2RJYSYUB.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/options.ts"],"names":[],"mappings":";AACA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,IAAM,gCAAgC,KAAK;AAAA,EACzC,QAAQ;AAAA,IACN,OAAO;AAAA,MACL,SAAS,UAAU,QAAQ,GAAG,IAAI;AAAA,MAClC,MAAM,UAAU,OAAO,GAAG,CAAC;AAAA,MAC3B,MAAM,UAAU,OAAO,GAAG,QAAQ,IAAI,CAAC;AAAA,IACzC,CAAC;AAAA,IACD,CAAC;AAAA,EACH;AACF,CAAC;AAuCM,SAAS,WAAW,wBAAiD;AAC1E,SAAO,OAAO,wBAAwB,6BAA6B;AACrE","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport {\n  boolean,\n  create,\n  defaulted,\n  number,\n  object,\n  string,\n  type,\n} from '@metamask/superstruct';\n\nconst SnapsEnvironmentOptionsStruct = type({\n  server: defaulted(\n    object({\n      enabled: defaulted(boolean(), true),\n      port: defaulted(number(), 0),\n      root: defaulted(string(), process.cwd()),\n    }),\n    {},\n  ),\n});\n\n/**\n * The options for the environment. These can be specified in the Jest\n * configuration under `testEnvironmentOptions`.\n *\n * @example\n * {\n *   \"testEnvironment\": \"@metamask/snaps-jest\",\n *   \"testEnvironmentOptions\": {\n *     \"executionEnvironmentUrl\": \"http://localhost:8080\",\n *     \"server\": {\n *       \"port\": 8080,\n *       /* ... *\\/\n *     }\n *   }\n * }\n * @property server - The options for the built-in HTTP server.\n * @property server.enabled - Whether to run the built-in HTTP server. Defaults\n * to `true`.\n * @property server.port - The port to use for the built-in HTTP server. If this\n * is not provided, a random available port will be used.\n * @property server.root - The root directory to serve from the built-in HTTP\n * server. Defaults to the current working directory. This is assumed to be the\n * directory containing the snap manifest and `dist` files. If this is a\n * relative path, it will be resolved relative to the current working directory.\n */\nexport type SnapsEnvironmentOptions = Infer<\n  typeof SnapsEnvironmentOptionsStruct\n>;\n\n/**\n * Get the environment options. This validates the options, and returns the\n * default options if none are provided.\n *\n * @param testEnvironmentOptions - The test environment options as defined in\n * the Jest configuration.\n * @returns The environment options.\n */\nexport function getOptions(testEnvironmentOptions: Record<string, unknown>) {\n  return create(testEnvironmentOptions, SnapsEnvironmentOptionsStruct);\n}\n"]}

package/dist/{chunk-KNJNL723.mjs → chunk-3J2IBWXV.mjs}

@@ -6,7 +6,7 @@ import {
 } from "./chunk-FP4H3ADT.mjs";
 import {
   DEFAULT_JSON_RPC_ENDPOINT
-} from "./chunk-6KXCBUNZ.mjs";
+} from "./chunk-LVNNGMJ2.mjs";
 
 // src/internals/simulation/middleware/engine.ts
 import { createFetchMiddleware } from "@metamask/eth-json-rpc-middleware";
@@ -36,4 +36,4 @@ function createJsonRpcEngine({
 export {
   createJsonRpcEngine
 };
-//# sourceMappingURL=chunk-KNJNL723.mjs.map
+//# sourceMappingURL=chunk-3J2IBWXV.mjs.map

package/dist/{chunk-EDFQDZNY.js → chunk-3NP6BDGK.js}

@@ -1,22 +1,28 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkXWGECIXIjs = require('./chunk-XWGECIXI.js');
+var _chunkRJNNNCZJjs = require('./chunk-RJNNNCZJ.js');
 
 
-var _chunkTVD4SWH7js = require('./chunk-TVD4SWH7.js');
+var _chunkDUVKGPX5js = require('./chunk-DUVKGPX5.js');
 
 
-var _chunkVXPCUDBIjs = require('./chunk-VXPCUDBI.js');
+var _chunkSW65QYFVjs = require('./chunk-SW65QYFV.js');
 
 
+var _chunk6V6MFT67js = require('./chunk-6V6MFT67.js');
 
-var _chunk44ARQBXSjs = require('./chunk-44ARQBXS.js');
 
 
-var _chunkMBQHVBLAjs = require('./chunk-MBQHVBLA.js');
+var _chunkWZ57PU2Kjs = require('./chunk-WZ57PU2K.js');
 
 
-var _chunkWMLSD6B5js = require('./chunk-WMLSD6B5.js');
+var _chunkQYHQ2WWXjs = require('./chunk-QYHQ2WWX.js');
+
+
+var _chunkK7MK6LQUjs = require('./chunk-K7MK6LQU.js');
+
+
+var _chunkD653LBAYjs = require('./chunk-D653LBAY.js');
 
 // src/internals/simulation/simulation.ts
 var _basecontroller = require('@metamask/base-controller');
@@ -28,29 +34,31 @@ var _keytree = require('@metamask/key-tree');
 
 
 var _node = require('@metamask/snaps-controllers/node');
+var _snapsrpcmethods = require('@metamask/snaps-rpc-methods');
 var _snapsutils = require('@metamask/snaps-utils');
 var _readablestream = require('readable-stream');
+var _effects = require('redux-saga/effects');
 async function handleInstallSnap(snapId, {
   executionService,
   executionServiceOptions,
   options: rawOptions = {}
 } = {}) {
-  const options = _chunkVXPCUDBIjs.getOptions.call(void 0, rawOptions);
+  const options = _chunk6V6MFT67js.getOptions.call(void 0, rawOptions);
   const location = _node.detectSnapLocation.call(void 0, snapId, {
     allowLocal: true
   });
   const snapFiles = await _node.fetchSnap.call(void 0, snapId, location);
-  const { store, runSaga } = _chunkWMLSD6B5js.createStore.call(void 0, options);
+  const { store, runSaga } = _chunkK7MK6LQUjs.createStore.call(void 0, options);
   const controllerMessenger = new (0, _basecontroller.ControllerMessenger)();
-  registerActions(controllerMessenger);
+  registerActions(controllerMessenger, runSaga);
   const hooks = getHooks(options, snapFiles, snapId, controllerMessenger);
-  const { subjectMetadataController, permissionController } = _chunk44ARQBXSjs.getControllers.call(void 0, {
+  const { subjectMetadataController, permissionController } = _chunkWZ57PU2Kjs.getControllers.call(void 0, {
     controllerMessenger,
     hooks,
     runSaga,
     options
   });
-  const engine = _chunkXWGECIXIjs.createJsonRpcEngine.call(void 0, {
+  const engine = _chunkRJNNNCZJjs.createJsonRpcEngine.call(void 0, {
     store,
     hooks,
     permissionMiddleware: permissionController.createPermissionMiddleware({
@@ -76,14 +84,14 @@ async function handleInstallSnap(snapId, {
       });
     }
   });
-  await _chunk44ARQBXSjs.registerSnap.call(void 0, snapId, snapFiles.manifest.result, {
+  await _chunkWZ57PU2Kjs.registerSnap.call(void 0, snapId, snapFiles.manifest.result, {
     permissionController,
     subjectMetadataController
   });
   await service.executeSnap({
     snapId,
     sourceCode: snapFiles.sourceCode.toString("utf8"),
-    endowments: await _chunkMBQHVBLAjs.getEndowments.call(void 0, permissionController, snapId)
+    endowments: await _chunkQYHQ2WWXjs.getEndowments.call(void 0, permissionController, snapId)
   });
   return {
     snapId,
@@ -96,7 +104,7 @@ async function handleInstallSnap(snapId, {
 function getHooks(options, snapFiles, snapId, controllerMessenger) {
   return {
     getMnemonic: async () => Promise.resolve(_keytree.mnemonicPhraseToBytes.call(void 0, options.secretRecoveryPhrase)),
-    getSnapFile: async (path, encoding) => await _chunkTVD4SWH7js.getSnapFile.call(void 0, snapFiles.auxiliaryFiles, path, encoding),
+    getSnapFile: async (path, encoding) => await _chunkSW65QYFVjs.getSnapFile.call(void 0, snapFiles.auxiliaryFiles, path, encoding),
     getIsLocked: () => false,
     createInterface: async (...args) => controllerMessenger.call(
       "SnapInterfaceController:createInterface",
@@ -112,10 +120,15 @@ function getHooks(options, snapFiles, snapId, controllerMessenger) {
       "SnapInterfaceController:getInterface",
       snapId,
       ...args
-    ).state
+    ).state,
+    resolveInterface: async (...args) => controllerMessenger.call(
+      "SnapInterfaceController:resolveInterface",
+      snapId,
+      ...args
+    )
   };
 }
-function registerActions(controllerMessenger) {
+function registerActions(controllerMessenger, runSaga) {
   controllerMessenger.registerActionHandler(
     "PhishingController:maybeUpdateState",
     async () => Promise.resolve()
@@ -124,6 +137,26 @@ function registerActions(controllerMessenger) {
     "PhishingController:testOrigin",
     () => ({ result: false, type: "all" })
   );
+  controllerMessenger.registerActionHandler(
+    "ApprovalController:hasRequest",
+    (opts) => {
+      function* getCurrentInterfaceSaga() {
+        const currentInterface2 = yield _effects.select.call(void 0, _chunkD653LBAYjs.getCurrentInterface);
+        return currentInterface2;
+      }
+      const currentInterface = runSaga(
+        getCurrentInterfaceSaga
+      ).result();
+      return currentInterface?.type === _snapsrpcmethods.DIALOG_APPROVAL_TYPES.default && currentInterface?.id === opts?.id;
+    }
+  );
+  controllerMessenger.registerActionHandler(
+    "ApprovalController:acceptRequest",
+    async (_id, value) => {
+      await runSaga(_chunkDUVKGPX5js.resolveWithSaga, value).toPromise();
+      return { value };
+    }
+  );
 }
 
 
@@ -131,4 +164,4 @@ function registerActions(controllerMessenger) {
 
 
 exports.handleInstallSnap = handleInstallSnap; exports.getHooks = getHooks; exports.registerActions = registerActions;
-//# sourceMappingURL=chunk-EDFQDZNY.js.map
+//# sourceMappingURL=chunk-3NP6BDGK.js.map

package/dist/chunk-3NP6BDGK.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/simulation.ts"],"names":["currentInterface"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,SAAS,2BAA2B;AACpC,SAAS,0BAA0B;AACnC,SAAS,6BAA6B;AAEtC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,6BAA6B;AAQtC,SAAS,gBAAgB;AAGzB,SAAS,gBAAgB;AAEzB,SAAS,cAAc;AA2GvB,eAAsB,kBAKpB,QACA;AAAA,EACE;AAAA,EACA;AAAA,EACA,SAAS,aAAa,CAAC;AACzB,IAA0C,CAAC,GACnB;AACxB,QAAM,UAAU,WAAW,UAAU;AAGrC,QAAM,WAAW,mBAAmB,QAAQ;AAAA,IAC1C,YAAY;AAAA,EACd,CAAC;AAED,QAAM,YAAY,MAAM,UAAU,QAAQ,QAAQ;AAGlD,QAAM,EAAE,OAAO,QAAQ,IAAI,YAAY,OAAO;AAE9C,QAAM,sBAAsB,IAAI,oBAA8B;AAE9D,kBAAgB,qBAAqB,OAAO;AAG5C,QAAM,QAAQ,SAAS,SAAS,WAAW,QAAQ,mBAAmB;AAEtE,QAAM,EAAE,2BAA2B,qBAAqB,IAAI,eAAe;AAAA,IACzE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,SAAS,oBAAoB;AAAA,IACjC;AAAA,IACA;AAAA,IACA,sBAAsB,qBAAqB,2BAA2B;AAAA,MACpE,QAAQ;AAAA,IACV,CAAC;AAAA,EACH,CAAC;AAGD,QAAM,mBAAmB,oBAAoB;AAC7C,QAAM,UAAU,IAAI,iBAAiB;AAAA,IACnC,GAAG;AAAA,IACH,WAAW,oBAAoB,cAAc;AAAA,MAC3C,MAAM;AAAA,MACN,gBAAgB,CAAC;AAAA,MACjB,eAAe,CAAC;AAAA,IAClB,CAAC;AAAA,IACD,mBAAmB,CAAC,SAAiB,cAAsB;AACzD,YAAM,MAAM,eAAe,WAAW,YAAY;AAClD,YAAM,SAAS,IAAI,aAAa,mBAAmB;AACnD,YAAM,iBAAiB,mBAAmB,EAAE,OAAO,CAAC;AAIpD,eAAS,QAAQ,gBAAgB,QAAQ,CAAC,UAAmB;AAC3D,YAAI,OAAO;AACT,mBAAS,4BAA4B,KAAK;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AAID,QAAM,aAAa,QAAQ,UAAU,SAAS,QAAQ;AAAA,IACpD;AAAA,IACA;AAAA,EACF,CAAC;AAGD,QAAM,QAAQ,YAAY;AAAA,IACxB;AAAA,IACA,YAAY,UAAU,WAAW,SAAS,MAAM;AAAA,IAChD,YAAY,MAAM,cAAc,sBAAsB,MAAM;AAAA,EAC9D,CAAC;AAED,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,kBAAkB;AAAA,IAClB;AAAA,IACA;AAAA,EACF;AACF;AAWO,SAAS,SACd,SACA,WACA,QACA,qBACiB;AACjB,SAAO;AAAA,IACL,aAAa,YACX,QAAQ,QAAQ,sBAAsB,QAAQ,oBAAoB,CAAC;AAAA,IACrE,aAAa,OAAO,MAAc,aAChC,MAAM,YAAY,UAAU,gBAAgB,MAAM,QAAQ;AAAA,IAC5D,aAAa,MAAM;AAAA,IACnB,iBAAiB,UAAU,SACzB,oBAAoB;AAAA,MAClB;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL;AAAA,IACF,iBAAiB,UAAU,SACzB,oBAAoB;AAAA,MAClB;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL;AAAA,IACF,mBAAmB,IAAI,SACrB,oBAAoB;AAAA,MAClB;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL,EAAE;AAAA,IACJ,kBAAkB,UAAU,SAC1B,oBAAoB;AAAA,MAClB;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL;AAAA,EACJ;AACF;AAQO,SAAS,gBACd,qBACA,SACA;AACA,sBAAoB;AAAA,IAClB;AAAA,IACA,YAAY,QAAQ,QAAQ;AAAA,EAC9B;AAEA,sBAAoB;AAAA,IAClB;AAAA,IACA,OAAO,EAAE,QAAQ,OAAO,MAAM,MAAM;AAAA,EACtC;AAEA,sBAAoB;AAAA,IAClB;AAAA,IACA,CAAC,SAAS;AAOR,gBAAU,0BAAwC;AAChD,cAAMA,oBAA8B,MAAM,OAAO,mBAAmB;AACpE,eAAOA;AAAA,MACT;AAEA,YAAM,mBAA0C;AAAA,QAC9C;AAAA,MACF,EAAE,OAAO;AACT,aACE,kBAAkB,SAAS,sBAAsB,WACjD,kBAAkB,OAAO,MAAM;AAAA,IAEnC;AAAA,EACF;AAEA,sBAAoB;AAAA,IAClB;AAAA,IACA,OAAO,KAAa,UAAmB;AACrC,YAAM,QAAQ,iBAAiB,KAAK,EAAE,UAAU;AAEhD,aAAO,EAAE,MAAM;AAAA,IACjB;AAAA,EACF;AACF","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 type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport {\n  fetchSnap,\n  detectSnapLocation,\n  NodeThreadExecutionService,\n  setupMultiplex,\n} from '@metamask/snaps-controllers/node';\nimport { DIALOG_APPROVAL_TYPES } from '@metamask/snaps-rpc-methods';\nimport type {\n  SnapId,\n  AuxiliaryFileEncoding,\n  Component,\n  InterfaceState,\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 * @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: '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"]}