@metamask/snaps-jest 6.0.1 → 7.0.0

package/CHANGELOG.md

@@ -6,6 +6,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.0.0]
+### Added
+- **BREAKING:** Support Interactive UI in `snaps-jest` ([#2286](https://github.com/MetaMask/snaps/pull/2286))
+  - Remove `content` from the Snap response, instead `getInterface()` must be used
+  - `clickElement` and `typeInField` can be used on the interface return value to simulate actions
+
+### Changed
+- Improve Jest expect types ([#2308](https://github.com/MetaMask/snaps/pull/2308))
+- Refactor to support changes to encryption ([#2316](https://github.com/MetaMask/snaps/pull/2316))
+
+## [6.0.2]
+### Changed
+- Bump MetaMask dependencies ([#2270](https://github.com/MetaMask/snaps/pull/2270))
+- Bump @metamask/json-rpc-engine from 7.3.2 to 7.3.3 ([#2247](https://github.com/MetaMask/snaps/pull/2247))
+
 ## [6.0.1]
 ### Fixed
 - Fix minor build configuration problems ([#2220](https://github.com/MetaMask/snaps/pull/2220))
@@ -107,7 +122,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@6.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@7.0.0...HEAD
+[7.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@6.0.2...@metamask/snaps-jest@7.0.0
+[6.0.2]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@6.0.1...@metamask/snaps-jest@6.0.2
 [6.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@6.0.0...@metamask/snaps-jest@6.0.1
 [6.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@5.0.0...@metamask/snaps-jest@6.0.0
 [5.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@4.0.1...@metamask/snaps-jest@5.0.0

package/README.md

@@ -194,7 +194,7 @@ All properties are optional, and have sensible defaults. The addresses are
 randomly generated by default. Most values can be specified as a hex string, or
 a decimal number.
 
-It returns an object with the user interface that was shown by the snap, in the
+It returns a `getInterface` function that gets the user interface that was shown by the snap, in the
 [onTransaction](https://docs.metamask.io/snaps/reference/exports/#ontransaction)
 function.
 
@@ -214,7 +214,9 @@ describe('MySnap', () => {
       nonce: '0x0',
     });
 
-    expect(response).toRender(panel([text('Hello, world!')]));
+    const screen = response.getInterface();
+
+    expect(screen).toRender(panel([text('Hello, world!')]));
   });
 });
 ```
@@ -233,7 +235,7 @@ All properties are optional, and have sensible defaults. The addresses are
 randomly generated by default. Most values can be specified as a hex string, or
 a decimal number.
 
-It returns an object with the user interface that was shown by the snap, in the
+It returns a `getInterface` function that gets the user interface that was shown by the snap, in the
 [onSignature](https://docs.metamask.io/snaps/reference/exports/#onsignature)
 function.
 
@@ -246,7 +248,9 @@ describe('MySnap', () => {
     const { onSignature } = await installSnap(/* optional snap ID */);
     const response = await onSignature();
 
-    expect(response).toRender(
+    const screen = response.getInterface();
+
+    expect(screen).toRender(
       panel([text('You are using the personal_sign method')]),
     );
   });
@@ -303,7 +307,7 @@ describe('MySnap', () => {
 ### `snap.onHomePage`
 
 The `onHomePage` function can be used to request the home page of the snap. It
-takes no arguments, and returns a promise that resolves to the response from the
+takes no arguments, and returns a promise that contains a `getInterface` function to get the response from the
 [onHomePage](https://docs.metamask.io/snaps/reference/entry-points/#onhomepage)
 function.
 
@@ -318,7 +322,9 @@ describe('MySnap', () => {
       params: [],
     });
 
-    expect(response).toRender(/* ... */);
+    const screen = response.getInterface();
+
+    expect(screen).toRender(/* ... */);
   });
 });
 ```
@@ -344,6 +350,8 @@ assert that a response from a snap matches an expected value:
 
 ### Interacting with user interfaces
 
+#### `snap_dialog`
+
 If your snap uses `snap_dialog` to show user interfaces, you can use the
 `request.getInterface` function to interact with them. This method is present on
 the return value of the `snap.request` function.
@@ -351,7 +359,7 @@ the return value of the `snap.request` function.
 It waits for the user interface to be shown, and returns an object with
 functions that can be used to interact with the user interface.
 
-#### Example
+##### Example
 
 ```js
 import { installSnap } from '@metamask/snaps-jest';
@@ -384,6 +392,91 @@ describe('MySnap', () => {
 });
 ```
 
+#### handlers
+
+If your snap uses handlers that shows user interfaces (`onTransaction`, `onSignature`, `onHomePage`), you can use the
+`response.getInterface` function to interact with them. This method is present on
+the return value of the `snap.request` function.
+
+It returns an object with functions that can be used to interact with the user interface.
+
+##### Example
+
+```js
+import { installSnap } from '@metamask/snaps-jest';
+
+describe('MySnap', () => {
+  it('should do something', async () => {
+    const { onHomePage } = await installSnap(/* optional snap ID */);
+    const response = await onHomePage({
+      method: 'foo',
+      params: [],
+    });
+
+    const screen = response.getInterface();
+
+    expect(screen).toRender(/* ... */);
+  });
+});
+```
+
+### User interactions in user interfaces
+
+The object returned by the `getInterface` function exposes other functions to trigger user interactions in the user interface.
+
+- `clickElement(elementName)`: Click on a button inside the user interface. If the button with the given name does not exist in the interface this method will throw.
+- `typeInField(elementName, valueToType)`: Enter a value in a field inside the user interface. If the input field with the given name des not exist in the interface this method will throw.
+
+#### Example
+
+```js
+import { installSnap } from '@metamask/snaps-jest';
+
+describe('MySnap', () => {
+  it('should do something', async () => {
+    const { onHomePage } = await installSnap(/* optional snap ID */);
+    const response = await onHomePage({
+      method: 'foo',
+      params: [],
+    });
+
+    const screen = response.getInterface();
+
+    expect(screen).toRender(/* ... */);
+
+    await screen.clickElement('myButton');
+
+    const screen = response.getInterface();
+
+    expect(screen).toRender(/* ... */);
+  });
+});
+```
+
+```js
+import { installSnap } from '@metamask/snaps-jest';
+
+describe('MySnap', () => {
+  it('should do something', async () => {
+    const { onHomePage } = await installSnap(/* optional snap ID */);
+    const response = await onHomePage({
+      method: 'foo',
+      params: [],
+    });
+
+    const screen = response.getInterface();
+
+    expect(screen).toRender(/* ... */);
+
+    await screen.typeInField('myField', 'the value to type');
+
+    const screen = response.getInterface();
+
+    expect(screen).toRender(/* ... */);
+  });
+});
+```
+
 ## Options
 
 You can pass options to the test environment by adding a

package/dist/{chunk-JUNUGLG4.js → chunk-2JAGD4N6.js}

@@ -3,7 +3,7 @@
 var _chunkT2PHS5FYjs = require('./chunk-T2PHS5FY.js');
 
 
-var _chunkSQJOQ7AFjs = require('./chunk-SQJOQ7AF.js');
+var _chunkMCYTJUDGjs = require('./chunk-MCYTJUDG.js');
 
 
 var _chunkN6MAO223js = require('./chunk-N6MAO223.js');
@@ -72,7 +72,7 @@ var SnapsEnvironment = class extends _jestenvironmentnode2.default {
    */
   async installSnap(snapId = this.snapId, options = {}) {
     await _chunkPHUTP7NBjs.__privateGet.call(void 0, this, _instance)?.executionService.terminateAllSnaps();
-    _chunkPHUTP7NBjs.__privateSet.call(void 0, this, _instance, await _chunkSQJOQ7AFjs.handleInstallSnap.call(void 0, snapId, options));
+    _chunkPHUTP7NBjs.__privateSet.call(void 0, this, _instance, await _chunkMCYTJUDGjs.handleInstallSnap.call(void 0, snapId, options));
     return _chunkPHUTP7NBjs.__privateGet.call(void 0, this, _instance);
   }
   /**
@@ -101,4 +101,4 @@ var environment_default = SnapsEnvironment;
 
 
 exports.SnapsEnvironment = SnapsEnvironment; exports.environment_default = environment_default;
-//# sourceMappingURL=chunk-JUNUGLG4.js.map
+//# sourceMappingURL=chunk-2JAGD4N6.js.map

package/dist/{chunk-7YD4IW43.mjs → chunk-3M4GRUMH.mjs}

@@ -15,7 +15,7 @@ import {
 // src/internals/simulation/store/store.ts
 import { configureStore } from "@reduxjs/toolkit";
 import createSagaMiddleware from "redux-saga";
-function createStore(password, { state, unencryptedState }) {
+function createStore({ state, unencryptedState }) {
   const sagaMiddleware = createSagaMiddleware();
   const store = configureStore({
     reducer: {
@@ -29,10 +29,7 @@ function createStore(password, { state, unencryptedState }) {
   if (state) {
     store.dispatch(
       setState({
-        state: JSON.stringify({
-          password,
-          value: state
-        }),
+        state: JSON.stringify(state),
         encrypted: true
       })
     );
@@ -54,4 +51,4 @@ function createStore(password, { state, unencryptedState }) {
 export {
   createStore
 };
-//# sourceMappingURL=chunk-7YD4IW43.mjs.map
+//# sourceMappingURL=chunk-3M4GRUMH.mjs.map

package/dist/chunk-3M4GRUMH.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/store/store.ts"],"sourcesContent":["import { configureStore } from '@reduxjs/toolkit';\nimport createSagaMiddleware from 'redux-saga';\n\nimport type { SimulationOptions } from '../options';\nimport { mocksSlice } from './mocks';\nimport { notificationsSlice } from './notifications';\nimport { setState, stateSlice } from './state';\nimport { uiSlice } from './ui';\n\n/**\n * Create a Redux store.\n *\n * @param options - The simulation options.\n * @param options.state - The initial state for the Snap.\n * @param options.unencryptedState - The initial unencrypted state for the Snap.\n * @returns A Redux store with the default state.\n */\nexport function createStore({ state, unencryptedState }: SimulationOptions) {\n  const sagaMiddleware = createSagaMiddleware();\n  const store = configureStore({\n    reducer: {\n      mocks: mocksSlice.reducer,\n      notifications: notificationsSlice.reducer,\n      state: stateSlice.reducer,\n      ui: uiSlice.reducer,\n    },\n    middleware: (getDefaultMiddleware) =>\n      getDefaultMiddleware({ thunk: false }).concat(sagaMiddleware),\n  });\n\n  // Set initial state for the Snap.\n  if (state) {\n    store.dispatch(\n      setState({\n        state: JSON.stringify(state),\n        encrypted: true,\n      }),\n    );\n  }\n\n  if (unencryptedState) {\n    store.dispatch(\n      setState({\n        state: JSON.stringify(unencryptedState),\n        encrypted: false,\n      }),\n    );\n  }\n\n  return {\n    store,\n    runSaga: sagaMiddleware.run.bind(sagaMiddleware),\n  };\n}\n\nexport type Store = ReturnType<typeof createStore>['store'];\nexport type ApplicationState = ReturnType<Store['getState']>;\nexport type RunSagaFunction = ReturnType<typeof createStore>['runSaga'];\n"],"mappings":";;;;;;;;;;;;;;;AAAA,SAAS,sBAAsB;AAC/B,OAAO,0BAA0B;AAgB1B,SAAS,YAAY,EAAE,OAAO,iBAAiB,GAAsB;AAC1E,QAAM,iBAAiB,qBAAqB;AAC5C,QAAM,QAAQ,eAAe;AAAA,IAC3B,SAAS;AAAA,MACP,OAAO,WAAW;AAAA,MAClB,eAAe,mBAAmB;AAAA,MAClC,OAAO,WAAW;AAAA,MAClB,IAAI,QAAQ;AAAA,IACd;AAAA,IACA,YAAY,CAAC,yBACX,qBAAqB,EAAE,OAAO,MAAM,CAAC,EAAE,OAAO,cAAc;AAAA,EAChE,CAAC;AAGD,MAAI,OAAO;AACT,UAAM;AAAA,MACJ,SAAS;AAAA,QACP,OAAO,KAAK,UAAU,KAAK;AAAA,QAC3B,WAAW;AAAA,MACb,CAAC;AAAA,IACH;AAAA,EACF;AAEA,MAAI,kBAAkB;AACpB,UAAM;AAAA,MACJ,SAAS;AAAA,QACP,OAAO,KAAK,UAAU,gBAAgB;AAAA,QACtC,WAAW;AAAA,MACb,CAAC;AAAA,IACH;AAAA,EACF;AAEA,SAAO;AAAA,IACL;AAAA,IACA,SAAS,eAAe,IAAI,KAAK,cAAc;AAAA,EACjD;AACF;","names":[]}

package/dist/{chunk-7BFTEFLS.mjs → chunk-5U5WB3SM.mjs}

@@ -5,9 +5,11 @@ import {
 } from "./chunk-MPZOXW6I.mjs";
 
 // src/internals/simulation/methods/hooks/state.ts
+import { parseJson } from "@metamask/snaps-utils";
 import { put, select } from "redux-saga/effects";
 function* getSnapStateImplementation(_snapId, encrypted = true) {
-  return yield select(getState(encrypted));
+  const state = yield select(getState(encrypted));
+  return parseJson(state);
 }
 function getGetSnapStateMethodImplementation(runSaga) {
   return (...args) => {
@@ -15,7 +17,7 @@ function getGetSnapStateMethodImplementation(runSaga) {
   };
 }
 function* updateSnapStateImplementation(_snapId, newState, encrypted = true) {
-  yield put(setState({ state: newState, encrypted }));
+  yield put(setState({ state: JSON.stringify(newState), encrypted }));
 }
 function getUpdateSnapStateMethodImplementation(runSaga) {
   return (...args) => {
@@ -36,4 +38,4 @@ export {
   getUpdateSnapStateMethodImplementation,
   getClearSnapStateMethodImplementation
 };
-//# sourceMappingURL=chunk-7BFTEFLS.mjs.map
+//# sourceMappingURL=chunk-5U5WB3SM.mjs.map

package/dist/chunk-5U5WB3SM.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/methods/hooks/state.ts"],"sourcesContent":["import { parseJson } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\nimport type { SagaIterator } from 'redux-saga';\nimport { put, select } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../store';\nimport { clearState, getState, setState } from '../../store';\n\n/**\n * Get the Snap state from the store.\n *\n * @param _snapId - The ID of the Snap to get the state for. This is ignored\n * because the simulator only supports one Snap.\n * @param encrypted - Whether to get the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @returns The state of the Snap.\n * @yields Selects the state from the store.\n */\nfunction* getSnapStateImplementation(\n  _snapId: string,\n  encrypted = true,\n): SagaIterator<string> {\n  const state = yield select(getState(encrypted));\n  // TODO: Use actual decryption implementation\n  return parseJson(state);\n}\n\n/**\n * Get the implementation of the `getSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `getSnapState` hook.\n */\nexport function getGetSnapStateMethodImplementation(runSaga: RunSagaFunction) {\n  return (...args: Parameters<typeof getSnapStateImplementation>) => {\n    return runSaga(getSnapStateImplementation, ...args).result();\n  };\n}\n\n/**\n * Update the Snap state in the store.\n *\n * @param _snapId - The ID of the Snap to update the state for. This is ignored\n * because the simulator only supports one Snap.\n * @param newState - The new state.\n * @param encrypted - Whether to update the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @yields Puts the new state in the store.\n */\nfunction* updateSnapStateImplementation(\n  _snapId: string,\n  newState: Record<string, Json>,\n  encrypted = true,\n): SagaIterator<void> {\n  // TODO: Use actual encryption implementation\n  yield put(setState({ state: JSON.stringify(newState), encrypted }));\n}\n\n/**\n * Get the implementation of the `updateSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `updateSnapState` hook.\n */\nexport function getUpdateSnapStateMethodImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return (...args: Parameters<typeof updateSnapStateImplementation>) => {\n    runSaga(updateSnapStateImplementation, ...args).result();\n  };\n}\n\n/**\n * Clear the Snap state in the store.\n *\n * @param _snapId - The ID of the Snap to clear the state for. This is ignored\n * because the simulator only supports one Snap.\n * @param encrypted - Whether to clear the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @yields Puts the new state in the store.\n */\nfunction* clearSnapStateImplementation(\n  _snapId: string,\n  encrypted = true,\n): SagaIterator<void> {\n  yield put(clearState({ encrypted }));\n}\n\n/**\n * Get the implementation of the `clearSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `clearSnapState` hook.\n */\nexport function getClearSnapStateMethodImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (...args: Parameters<typeof clearSnapStateImplementation>) => {\n    runSaga(clearSnapStateImplementation, ...args).result();\n  };\n}\n"],"mappings":";;;;;;;AAAA,SAAS,iBAAiB;AAG1B,SAAS,KAAK,cAAc;AAe5B,UAAU,2BACR,SACA,YAAY,MACU;AACtB,QAAM,QAAQ,MAAM,OAAO,SAAS,SAAS,CAAC;AAE9C,SAAO,UAAU,KAAK;AACxB;AAQO,SAAS,oCAAoC,SAA0B;AAC5E,SAAO,IAAI,SAAwD;AACjE,WAAO,QAAQ,4BAA4B,GAAG,IAAI,EAAE,OAAO;AAAA,EAC7D;AACF;AAYA,UAAU,8BACR,SACA,UACA,YAAY,MACQ;AAEpB,QAAM,IAAI,SAAS,EAAE,OAAO,KAAK,UAAU,QAAQ,GAAG,UAAU,CAAC,CAAC;AACpE;AAQO,SAAS,uCACd,SACA;AACA,SAAO,IAAI,SAA2D;AACpE,YAAQ,+BAA+B,GAAG,IAAI,EAAE,OAAO;AAAA,EACzD;AACF;AAWA,UAAU,6BACR,SACA,YAAY,MACQ;AACpB,QAAM,IAAI,WAAW,EAAE,UAAU,CAAC,CAAC;AACrC;AAQO,SAAS,sCACd,SACA;AACA,SAAO,UAAU,SAA0D;AACzE,YAAQ,8BAA8B,GAAG,IAAI,EAAE,OAAO;AAAA,EACxD;AACF;","names":[]}

package/dist/chunk-6POKT4OO.js

@@ -0,0 +1,127 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+var _chunkY4DKEF7Yjs = require('./chunk-Y4DKEF7Y.js');
+
+
+
+var _chunk2YE2P5BZjs = require('./chunk-2YE2P5BZ.js');
+
+// src/internals/request.ts
+var _snapsutils = require('@metamask/snaps-utils');
+var _utils = require('@metamask/utils');
+var _toolkit = require('@reduxjs/toolkit');
+function handleRequest({
+  snapId,
+  store,
+  executionService,
+  handler,
+  controllerMessenger,
+  runSaga,
+  request: { id = _toolkit.nanoid.call(void 0, ), origin = "https://metamask.io", ...options }
+}) {
+  const promise = executionService.handleRpcRequest(snapId, {
+    origin,
+    handler,
+    request: {
+      jsonrpc: "2.0",
+      id: 1,
+      ...options
+    }
+  }).then(async (result) => {
+    const notifications = _chunk2YE2P5BZjs.getNotifications.call(void 0, store.getState());
+    store.dispatch(_chunk2YE2P5BZjs.clearNotifications.call(void 0, ));
+    const getInterfaceFn = await getInterfaceApi(
+      result,
+      snapId,
+      controllerMessenger
+    );
+    return {
+      id: String(id),
+      response: {
+        result: _utils.getSafeJson.call(void 0, result)
+      },
+      notifications,
+      ...getInterfaceFn ? { getInterface: getInterfaceFn } : {}
+    };
+  }).catch((error) => {
+    const [unwrappedError] = _snapsutils.unwrapError.call(void 0, error);
+    return {
+      id: String(id),
+      response: {
+        error: unwrappedError.serialize()
+      },
+      notifications: []
+    };
+  });
+  promise.getInterface = async () => {
+    return await runSaga(
+      _chunkY4DKEF7Yjs.getInterface,
+      runSaga,
+      snapId,
+      controllerMessenger
+    ).toPromise();
+  };
+  return promise;
+}
+async function getInterfaceFromResult(result, snapId, controllerMessenger) {
+  if (_utils.isPlainObject.call(void 0, result) && _utils.hasProperty.call(void 0, result, "id")) {
+    return result.id;
+  }
+  if (_utils.isPlainObject.call(void 0, result) && _utils.hasProperty.call(void 0, result, "content")) {
+    const id = await controllerMessenger.call(
+      "SnapInterfaceController:createInterface",
+      snapId,
+      result.content
+    );
+    return id;
+  }
+  return void 0;
+}
+async function getInterfaceApi(result, snapId, controllerMessenger) {
+  const interfaceId = await getInterfaceFromResult(
+    result,
+    snapId,
+    controllerMessenger
+  );
+  if (interfaceId) {
+    return () => {
+      const { content } = controllerMessenger.call(
+        "SnapInterfaceController:getInterface",
+        snapId,
+        interfaceId
+      );
+      return {
+        content,
+        clickElement: async (name) => {
+          await _chunkY4DKEF7Yjs.clickElement.call(void 0, 
+            controllerMessenger,
+            interfaceId,
+            content,
+            snapId,
+            name
+          );
+        },
+        typeInField: async (name, value) => {
+          await _chunkY4DKEF7Yjs.typeInField.call(void 0, 
+            controllerMessenger,
+            interfaceId,
+            content,
+            snapId,
+            name,
+            value
+          );
+        }
+      };
+    };
+  }
+  return void 0;
+}
+
+
+
+
+
+exports.handleRequest = handleRequest; exports.getInterfaceFromResult = getInterfaceFromResult; exports.getInterfaceApi = getInterfaceApi;
+//# sourceMappingURL=chunk-6POKT4OO.js.map

package/dist/chunk-6POKT4OO.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/request.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,SAAS,mBAAmB;AAC5B,SAAS,aAAa,aAAa,qBAAqB;AACxD,SAAS,cAAc;AA+ChB,SAAS,cAAc;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,SAAS,EAAE,KAAK,OAAO,GAAG,SAAS,uBAAuB,GAAG,QAAQ;AACvE,GAAsC;AACpC,QAAM,UAAU,iBACb,iBAAiB,QAAQ;AAAA,IACxB;AAAA,IACA;AAAA,IACA,SAAS;AAAA,MACP,SAAS;AAAA,MACT,IAAI;AAAA,MACJ,GAAG;AAAA,IACL;AAAA,EACF,CAAC,EACA,KAAK,OAAO,WAAW;AACtB,UAAM,gBAAgB,iBAAiB,MAAM,SAAS,CAAC;AACvD,UAAM,SAAS,mBAAmB,CAAC;AAEnC,UAAM,iBAAiB,MAAM;AAAA,MAC3B;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,WAAO;AAAA,MACL,IAAI,OAAO,EAAE;AAAA,MACb,UAAU;AAAA,QACR,QAAQ,YAAY,MAAM;AAAA,MAC5B;AAAA,MACA;AAAA,MACA,GAAI,iBAAiB,EAAE,cAAc,eAAe,IAAI,CAAC;AAAA,IAC3D;AAAA,EACF,CAAC,EACA,MAAM,CAAC,UAAU;AAChB,UAAM,CAAC,cAAc,IAAI,YAAY,KAAK;AAE1C,WAAO;AAAA,MACL,IAAI,OAAO,EAAE;AAAA,MACb,UAAU;AAAA,QACR,OAAO,eAAe,UAAU;AAAA,MAClC;AAAA,MACA,eAAe,CAAC;AAAA,IAClB;AAAA,EACF,CAAC;AAEH,UAAQ,eAAe,YAAY;AACjC,WAAO,MAAM;AAAA,MACX;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,EAAE,UAAU;AAAA,EACd;AAEA,SAAO;AACT;AAUA,eAAsB,uBACpB,QACA,QACA,qBACA;AACA,MAAI,cAAc,MAAM,KAAK,YAAY,QAAQ,IAAI,GAAG;AACtD,WAAO,OAAO;AAAA,EAChB;AAEA,MAAI,cAAc,MAAM,KAAK,YAAY,QAAQ,SAAS,GAAG;AAC3D,UAAM,KAAK,MAAM,oBAAoB;AAAA,MACnC;AAAA,MACA;AAAA,MACA,OAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAUA,eAAsB,gBACpB,QACA,QACA,qBACmD;AACnD,QAAM,cAAc,MAAM;AAAA,IACxB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,MAAI,aAAa;AACf,WAAO,MAAM;AACX,YAAM,EAAE,QAAQ,IAAI,oBAAoB;AAAA,QACtC;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,aAAO;AAAA,QACL;AAAA,QACA,cAAc,OAAO,SAAS;AAC5B,gBAAM;AAAA,YACJ;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,QACA,aAAa,OAAO,MAAM,UAAU;AAClC,gBAAM;AAAA,YACJ;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT","sourcesContent":["import type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport type { SnapId, Component } from '@metamask/snaps-sdk';\nimport type { HandlerType } from '@metamask/snaps-utils';\nimport { unwrapError } from '@metamask/snaps-utils';\nimport { getSafeJson, hasProperty, isPlainObject } from '@metamask/utils';\nimport { nanoid } from '@reduxjs/toolkit';\n\nimport type {\n  RequestOptions,\n  SnapHandlerInterface,\n  SnapRequest,\n} from '../types';\nimport {\n  clearNotifications,\n  clickElement,\n  getInterface,\n  getNotifications,\n  typeInField,\n} from './simulation';\nimport type { RunSagaFunction, Store } from './simulation';\nimport type { RootControllerMessenger } from './simulation/controllers';\n\nexport type HandleRequestOptions = {\n  snapId: SnapId;\n  store: Store;\n  executionService: AbstractExecutionService<unknown>;\n  handler: HandlerType;\n  controllerMessenger: RootControllerMessenger;\n  runSaga: RunSagaFunction;\n  request: RequestOptions;\n};\n\n/**\n * Send a JSON-RPC request to the Snap, and wrap the response in a\n * {@link SnapResponse} object.\n *\n * @param options - The request options.\n * @param options.snapId - The ID of the Snap to send the request to.\n * @param options.store - The Redux store.\n * @param options.executionService - The execution service to use to send the\n * request.\n * @param options.handler - The handler to use to send the request.\n * @param options.controllerMessenger - The controller messenger used to call actions.\n * @param options.runSaga - A function to run a saga outside the usual Redux\n * flow.\n * @param options.request - The request to send.\n * @param options.request.id - The ID of the request. If not provided, a random\n * ID will be generated.\n * @param options.request.origin - The origin of the request. Defaults to\n * `https://metamask.io`.\n * @returns The response, wrapped in a {@link SnapResponse} object.\n */\nexport function handleRequest({\n  snapId,\n  store,\n  executionService,\n  handler,\n  controllerMessenger,\n  runSaga,\n  request: { id = nanoid(), origin = 'https://metamask.io', ...options },\n}: HandleRequestOptions): SnapRequest {\n  const promise = executionService\n    .handleRpcRequest(snapId, {\n      origin,\n      handler,\n      request: {\n        jsonrpc: '2.0',\n        id: 1,\n        ...options,\n      },\n    })\n    .then(async (result) => {\n      const notifications = getNotifications(store.getState());\n      store.dispatch(clearNotifications());\n\n      const getInterfaceFn = await getInterfaceApi(\n        result,\n        snapId,\n        controllerMessenger,\n      );\n\n      return {\n        id: String(id),\n        response: {\n          result: getSafeJson(result),\n        },\n        notifications,\n        ...(getInterfaceFn ? { getInterface: getInterfaceFn } : {}),\n      };\n    })\n    .catch((error) => {\n      const [unwrappedError] = unwrapError(error);\n\n      return {\n        id: String(id),\n        response: {\n          error: unwrappedError.serialize(),\n        },\n        notifications: [],\n      };\n    }) as unknown as SnapRequest;\n\n  promise.getInterface = async () => {\n    return await runSaga(\n      getInterface,\n      runSaga,\n      snapId,\n      controllerMessenger,\n    ).toPromise();\n  };\n\n  return promise;\n}\n\n/**\n * Get the interface ID from the result if it's available or create a new interface if the result contains static components.\n *\n * @param result - The handler result object.\n * @param snapId - The Snap ID.\n * @param controllerMessenger - The controller messenger.\n * @returns The interface ID or undefined if the result doesn't include content.\n */\nexport async function getInterfaceFromResult(\n  result: unknown,\n  snapId: SnapId,\n  controllerMessenger: RootControllerMessenger,\n) {\n  if (isPlainObject(result) && hasProperty(result, 'id')) {\n    return result.id as string;\n  }\n\n  if (isPlainObject(result) && hasProperty(result, 'content')) {\n    const id = await controllerMessenger.call(\n      'SnapInterfaceController:createInterface',\n      snapId,\n      result.content as Component,\n    );\n\n    return id;\n  }\n\n  return undefined;\n}\n\n/**\n * Get the response content from the SnapInterfaceController and include the interaction methods.\n *\n * @param result - The handler result object.\n * @param snapId - The Snap ID.\n * @param controllerMessenger - The controller messenger.\n * @returns The content components if any.\n */\nexport async function getInterfaceApi(\n  result: unknown,\n  snapId: SnapId,\n  controllerMessenger: RootControllerMessenger,\n): Promise<(() => SnapHandlerInterface) | undefined> {\n  const interfaceId = await getInterfaceFromResult(\n    result,\n    snapId,\n    controllerMessenger,\n  );\n\n  if (interfaceId) {\n    return () => {\n      const { content } = controllerMessenger.call(\n        'SnapInterfaceController:getInterface',\n        snapId,\n        interfaceId,\n      );\n\n      return {\n        content,\n        clickElement: async (name) => {\n          await clickElement(\n            controllerMessenger,\n            interfaceId,\n            content,\n            snapId,\n            name,\n          );\n        },\n        typeInField: async (name, value) => {\n          await typeInField(\n            controllerMessenger,\n            interfaceId,\n            content,\n            snapId,\n            name,\n            value,\n          );\n        },\n      };\n    };\n  }\n\n  return undefined;\n}\n"]}

package/dist/{chunk-7VILST6M.mjs → chunk-BVGI3E45.mjs}

@@ -1,7 +1,7 @@
 import {
   InterfaceStruct,
   SnapResponseStruct
-} from "./chunk-7J34R6YW.mjs";
+} from "./chunk-YEVKBYKO.mjs";
 
 // src/matchers.ts
 import { expect } from "@jest/globals";
@@ -131,4 +131,4 @@ export {
   toSendNotification,
   toRender
 };
-//# sourceMappingURL=chunk-7VILST6M.mjs.map
+//# sourceMappingURL=chunk-BVGI3E45.mjs.map

package/dist/chunk-CKRORVDW.js

@@ -0,0 +1 @@
+"use strict";//# sourceMappingURL=chunk-CKRORVDW.js.map

package/dist/{chunk-WFBQPYSV.js → chunk-DTDYOBCI.js}

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkLXSNRZV4js = require('./chunk-LXSNRZV4.js');
+var _chunkZWN4SO2Vjs = require('./chunk-ZWN4SO2V.js');
 
 
 var _chunkXAOCS6ZDjs = require('./chunk-XAOCS6ZD.js');
@@ -22,7 +22,9 @@ function getControllers(options) {
   const { controllerMessenger } = options;
   const subjectMetadataController = new (0, _permissioncontroller.SubjectMetadataController)({
     messenger: controllerMessenger.getRestricted({
-      name: "SubjectMetadataController"
+      name: "SubjectMetadataController",
+      allowedActions: [],
+      allowedEvents: []
     }),
     subjectCacheLimit: 100
   });
@@ -32,7 +34,8 @@ function getControllers(options) {
       allowedActions: [
         "PhishingController:maybeUpdateState",
         "PhishingController:testOrigin"
-      ]
+      ],
+      allowedEvents: []
     })
   });
   const permissionController = getPermissionController(options);
@@ -44,7 +47,7 @@ function getControllers(options) {
 }
 function getPermissionController(options) {
   const { controllerMessenger } = options;
-  const permissionSpecifications = _chunkLXSNRZV4js.getPermissionSpecifications.call(void 0, options);
+  const permissionSpecifications = _chunkZWN4SO2Vjs.getPermissionSpecifications.call(void 0, options);
   return new (0, _permissioncontroller.PermissionController)({
     messenger: controllerMessenger.getRestricted({
       name: "PermissionController",
@@ -56,7 +59,8 @@ function getPermissionController(options) {
         `SnapController:getPermitted`,
         `SnapController:install`,
         `SubjectMetadataController:getSubjectMetadata`
-      ]
+      ],
+      allowedEvents: []
     }),
     caveatSpecifications: {
       ..._snapsrpcmethods.caveatSpecifications,
@@ -88,4 +92,4 @@ async function registerSnap(snapId, manifest, {
 
 
 exports.getControllers = getControllers; exports.registerSnap = registerSnap;
-//# sourceMappingURL=chunk-WFBQPYSV.js.map
+//# sourceMappingURL=chunk-DTDYOBCI.js.map

package/dist/chunk-DTDYOBCI.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/controllers.ts"],"names":[],"mappings":";;;;;;;;AAOA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,+BAA+B;AAMxC;AAAA,EACE,wBAAwB;AAAA,EACxB,iCAAiC;AAAA,EACjC;AAAA,OACK;AAGP,SAAS,mBAAmB;AA0CrB,SAAS,eAAe,SAA6C;AAC1E,QAAM,EAAE,oBAAoB,IAAI;AAChC,QAAM,4BAA4B,IAAI,0BAA0B;AAAA,IAC9D,WAAW,oBAAoB,cAAc;AAAA,MAC3C,MAAM;AAAA,MACN,gBAAgB,CAAC;AAAA,MACjB,eAAe,CAAC;AAAA,IAClB,CAAC;AAAA,IACD,mBAAmB;AAAA,EACrB,CAAC;AAED,QAAM,sBAAsB,IAAI,wBAAwB;AAAA,IACtD,WAAW,oBAAoB,cAAc;AAAA,MAC3C,MAAM;AAAA,MACN,gBAAgB;AAAA,QACd;AAAA,QACA;AAAA,MACF;AAAA,MACA,eAAe,CAAC;AAAA,IAClB,CAAC;AAAA,EACH,CAAC;AAED,QAAM,uBAAuB,wBAAwB,OAAO;AAE5D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAUA,SAAS,wBAAwB,SAAgC;AAC/D,QAAM,EAAE,oBAAoB,IAAI;AAChC,QAAM,2BAA2B,4BAA4B,OAAO;AACpE,SAAO,IAAI,qBAAqB;AAAA,IAC9B,WAAW,oBAAoB,cAAc;AAAA,MAC3C,MAAM;AAAA,MACN,gBAAgB;AAAA,QACd;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MACA,eAAe,CAAC;AAAA,IAClB,CAAC;AAAA,IACD,sBAAsB;AAAA,MACpB,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,IACA;AAAA,IACA,qBAAqB;AAAA,EACvB,CAAC;AACH;AAWA,eAAsB,aACpB,QACA,UACA;AAAA,EACE;AAAA,EACA;AACF,GACA;AACA,4BAA0B,mBAAmB;AAAA,IAC3C,QAAQ;AAAA,IACR,aAAa,YAAY;AAAA,EAC3B,CAAC;AAED,QAAM,sBAAsB;AAAA,IAC1B,YAAY,SAAS,kBAAkB;AAAA,EACzC;AAEA,uBAAqB,iBAAiB;AAAA,IACpC;AAAA,IACA,SAAS,EAAE,QAAQ,OAAO;AAAA,IAC1B,6BAA6B;AAAA,EAC/B,CAAC;AACH","sourcesContent":["import type { ControllerMessenger } from '@metamask/base-controller';\nimport type {\n  CaveatSpecificationConstraint,\n  PermissionSpecificationConstraint,\n  PermissionControllerActions,\n  SubjectMetadataControllerActions,\n} from '@metamask/permission-controller';\nimport {\n  PermissionController,\n  SubjectMetadataController,\n  SubjectType,\n} from '@metamask/permission-controller';\nimport { SnapInterfaceController } from '@metamask/snaps-controllers';\nimport type {\n  ExecutionServiceActions,\n  SnapInterfaceControllerActions,\n  SnapInterfaceControllerAllowedActions,\n} from '@metamask/snaps-controllers';\nimport {\n  caveatSpecifications as snapsCaveatsSpecifications,\n  endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,\n  processSnapPermissions,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport type { SnapManifest } from '@metamask/snaps-utils';\nimport { getSafeJson } from '@metamask/utils';\n\nimport { getPermissionSpecifications } from './methods';\nimport { UNRESTRICTED_METHODS } from './methods/constants';\nimport type { SimulationOptions } from './options';\nimport type { MiddlewareHooks } from './simulation';\nimport type { RunSagaFunction } from './store';\n\nexport type RootControllerAllowedActions =\n  | SnapInterfaceControllerActions\n  | SnapInterfaceControllerAllowedActions\n  | PermissionControllerActions\n  | ExecutionServiceActions\n  | SubjectMetadataControllerActions;\n\nexport type RootControllerMessenger = ControllerMessenger<\n  RootControllerAllowedActions,\n  any\n>;\n\nexport type GetControllersOptions = {\n  controllerMessenger: ControllerMessenger<any, any>;\n  hooks: MiddlewareHooks;\n  runSaga: RunSagaFunction;\n  options: SimulationOptions;\n};\n\nexport type Controllers = {\n  permissionController: PermissionController<\n    PermissionSpecificationConstraint,\n    CaveatSpecificationConstraint\n  >;\n  subjectMetadataController: SubjectMetadataController;\n  interfaceController: SnapInterfaceController;\n};\n\n/**\n * Get the controllers for the Snap.\n *\n * @param options - The options.\n * @returns The controllers for the Snap.\n */\nexport function getControllers(options: GetControllersOptions): Controllers {\n  const { controllerMessenger } = options;\n  const subjectMetadataController = new SubjectMetadataController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'SubjectMetadataController',\n      allowedActions: [],\n      allowedEvents: [],\n    }),\n    subjectCacheLimit: 100,\n  });\n\n  const interfaceController = new SnapInterfaceController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'SnapInterfaceController',\n      allowedActions: [\n        'PhishingController:maybeUpdateState',\n        'PhishingController:testOrigin',\n      ],\n      allowedEvents: [],\n    }),\n  });\n\n  const permissionController = getPermissionController(options);\n\n  return {\n    permissionController,\n    subjectMetadataController,\n    interfaceController,\n  };\n}\n\n/**\n * Get the permission controller for the Snap.\n *\n * @param options - The options.\n * @param options.controllerMessenger - The controller messenger.\n * @param options.options - Miscellaneous options.\n * @returns The permission controller for the Snap.\n */\nfunction getPermissionController(options: GetControllersOptions) {\n  const { controllerMessenger } = options;\n  const permissionSpecifications = getPermissionSpecifications(options);\n  return new PermissionController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'PermissionController',\n      allowedActions: [\n        `ApprovalController:addRequest`,\n        `ApprovalController:hasRequest`,\n        `ApprovalController:acceptRequest`,\n        `ApprovalController:rejectRequest`,\n        `SnapController:getPermitted`,\n        `SnapController:install`,\n        `SubjectMetadataController:getSubjectMetadata`,\n      ],\n      allowedEvents: [],\n    }),\n    caveatSpecifications: {\n      ...snapsCaveatsSpecifications,\n      ...snapsEndowmentCaveatSpecifications,\n    },\n    permissionSpecifications,\n    unrestrictedMethods: UNRESTRICTED_METHODS,\n  });\n}\n\n/**\n * Register the Snap. This sets up the Snap's permissions and subject metadata.\n *\n * @param snapId - The ID of the Snap to install.\n * @param manifest - The parsed manifest.\n * @param controllers - The controllers for the Snap.\n * @param controllers.permissionController - The permission controller.\n * @param controllers.subjectMetadataController - The subject metadata controller.\n */\nexport async function registerSnap(\n  snapId: SnapId,\n  manifest: SnapManifest,\n  {\n    permissionController,\n    subjectMetadataController,\n  }: Omit<Controllers, 'interfaceController'>,\n) {\n  subjectMetadataController.addSubjectMetadata({\n    origin: snapId,\n    subjectType: SubjectType.Snap,\n  });\n\n  const approvedPermissions = processSnapPermissions(\n    getSafeJson(manifest.initialPermissions),\n  );\n\n  permissionController.grantPermissions({\n    approvedPermissions,\n    subject: { origin: snapId },\n    preserveExistingPermissions: false,\n  });\n}\n"]}

package/dist/{chunk-WIFOID2P.mjs → chunk-EDEJD326.mjs}

@@ -1,25 +1,26 @@
+import {
+  getEnvironment
+} from "./chunk-XK5HPZZC.mjs";
 import {
   handleRequest
-} from "./chunk-LYK6EGZU.mjs";
+} from "./chunk-PVMIH6OB.mjs";
 import {
   rootLogger
 } from "./chunk-J4ZPUCLX.mjs";
 import {
   JsonRpcMockOptionsStruct,
   SignatureOptionsStruct,
+  SnapResponseWithInterfaceStruct,
   TransactionOptionsStruct
-} from "./chunk-7J34R6YW.mjs";
+} from "./chunk-YEVKBYKO.mjs";
 import {
   addJsonRpcMock,
   removeJsonRpcMock
 } from "./chunk-H2464AXT.mjs";
-import {
-  getEnvironment
-} from "./chunk-XK5HPZZC.mjs";
 
 // src/helpers.ts
 import { HandlerType, logInfo } from "@metamask/snaps-utils";
-import { createModuleLogger } from "@metamask/utils";
+import { assertStruct, createModuleLogger } from "@metamask/utils";
 import { create } from "superstruct";
 var log = createModuleLogger(rootLogger, "helpers");
 function getOptions(snapId, options) {
@@ -28,6 +29,9 @@ function getOptions(snapId, options) {
   }
   return [snapId, options];
 }
+function assertIsResponseWithInterface(response) {
+  assertStruct(response, SnapResponseWithInterfaceStruct);
+}
 async function installSnap(snapId, options = {}) {
   const resolvedOptions = getOptions(snapId, options);
   const {
@@ -44,7 +48,7 @@ async function installSnap(snapId, options = {}) {
       chainId,
       ...transaction
     } = create(request, TransactionOptionsStruct);
-    return handleRequest({
+    const response = await handleRequest({
       snapId: installedSnapId,
       store,
       executionService,
@@ -60,6 +64,8 @@ async function installSnap(snapId, options = {}) {
         }
       }
     });
+    assertIsResponseWithInterface(response);
+    return response;
   };
   const onCronjob = (request) => {
     log("Running cronjob %o.", options);
@@ -94,7 +100,7 @@ async function installSnap(snapId, options = {}) {
         request,
         SignatureOptionsStruct
       );
-      return handleRequest({
+      const response = await handleRequest({
         snapId: installedSnapId,
         store,
         executionService,
@@ -109,12 +115,14 @@ async function installSnap(snapId, options = {}) {
           }
         }
       });
+      assertIsResponseWithInterface(response);
+      return response;
     },
     onCronjob,
     runCronjob: onCronjob,
     onHomePage: async () => {
       log("Rendering home page.");
-      return handleRequest({
+      const response = await handleRequest({
         snapId: installedSnapId,
         store,
         executionService,
@@ -125,6 +133,8 @@ async function installSnap(snapId, options = {}) {
           method: ""
         }
       });
+      assertIsResponseWithInterface(response);
+      return response;
     },
     mockJsonRpc(mock) {
       log("Mocking JSON-RPC request %o.", mock);
@@ -150,4 +160,4 @@ async function installSnap(snapId, options = {}) {
 export {
   installSnap
 };
-//# sourceMappingURL=chunk-WIFOID2P.mjs.map
+//# sourceMappingURL=chunk-EDEJD326.mjs.map

package/dist/chunk-EDEJD326.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/helpers.ts"],"sourcesContent":["import type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { HandlerType, logInfo } from '@metamask/snaps-utils';\nimport { assertStruct, createModuleLogger } from '@metamask/utils';\nimport { create } from 'superstruct';\n\nimport {\n  rootLogger,\n  handleRequest,\n  TransactionOptionsStruct,\n  getEnvironment,\n  JsonRpcMockOptionsStruct,\n  SignatureOptionsStruct,\n  SnapResponseWithInterfaceStruct,\n} from './internals';\nimport type { InstallSnapOptions } from './internals';\nimport {\n  addJsonRpcMock,\n  removeJsonRpcMock,\n} from './internals/simulation/store/mocks';\nimport type {\n  SnapResponseWithInterface,\n  CronjobOptions,\n  JsonRpcMockOptions,\n  Snap,\n  SnapResponse,\n  TransactionOptions,\n} from './types';\n\nconst log = createModuleLogger(rootLogger, 'helpers');\n\n/**\n * Get the options for {@link installSnap}.\n *\n * @param snapId - The ID of the Snap, or the options.\n * @param options - The options, if any.\n * @returns The options.\n */\nfunction getOptions<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId: SnapId | Partial<InstallSnapOptions<Service>> | undefined,\n  options: Partial<InstallSnapOptions<Service>>,\n): [SnapId | undefined, Partial<InstallSnapOptions<Service>>] {\n  if (typeof snapId === 'object') {\n    return [undefined, snapId];\n  }\n\n  return [snapId, options];\n}\n\n/**\n * Ensure that the actual response contains `getInterface`.\n *\n * @param response - The response of the handler.\n */\nfunction assertIsResponseWithInterface(\n  response: SnapResponse,\n): asserts response is SnapResponseWithInterface {\n  assertStruct(response, SnapResponseWithInterfaceStruct);\n}\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n *   it('should do something', async () => {\n *     const { request } = await installSnap('local:my-snap');\n *     const response = await request({\n *       method: 'foo',\n *       params: ['bar'],\n *     });\n *     expect(response).toRespondWith('bar');\n *   });\n * });\n * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap(): Promise<Snap>;\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n *   it('should do something', async () => {\n *     const { request } = await installSnap('local:my-snap');\n *     const response = await request({\n *       method: 'foo',\n *       params: ['bar'],\n *     });\n *     expect(response).toRespondWith('bar');\n *   });\n * });\n * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\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 snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(options: Partial<InstallSnapOptions<Service>>): Promise<Snap>;\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n *   it('should do something', async () => {\n *     const { request } = await installSnap('local:my-snap');\n *     const response = await request({\n *       method: 'foo',\n *       params: ['bar'],\n *     });\n *     expect(response).toRespondWith('bar');\n *   });\n * });\n * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults\n * to the URL of the built-in server, if it is running. This supports both\n * local snap IDs and NPM snap IDs.\n * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\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 snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId: SnapId,\n  options?: Partial<InstallSnapOptions<Service>>,\n): Promise<Snap>;\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n *   it('should do something', async () => {\n *     const { request } = await installSnap('local:my-snap');\n *     const response = await request({\n *       method: 'foo',\n *       params: ['bar'],\n *     });\n *     expect(response).toRespondWith('bar');\n *   });\n * });\n * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults\n * to the URL of the built-in server, if it is running. This supports both\n * local snap IDs and NPM snap IDs.\n * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\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 snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId?: SnapId | Partial<InstallSnapOptions<Service>>,\n  options: Partial<InstallSnapOptions<Service>> = {},\n): Promise<Snap> {\n  const resolvedOptions = getOptions(snapId, options);\n  const {\n    snapId: installedSnapId,\n    store,\n    executionService,\n    runSaga,\n    controllerMessenger,\n  } = await getEnvironment().installSnap(...resolvedOptions);\n\n  const onTransaction = async (\n    request: TransactionOptions,\n  ): Promise<SnapResponseWithInterface> => {\n    log('Sending transaction %o.', request);\n\n    const {\n      origin: transactionOrigin,\n      chainId,\n      ...transaction\n    } = create(request, TransactionOptionsStruct);\n\n    const response = await handleRequest({\n      snapId: installedSnapId,\n      store,\n      executionService,\n      runSaga,\n      controllerMessenger,\n      handler: HandlerType.OnTransaction,\n      request: {\n        method: '',\n        params: {\n          chainId,\n          transaction,\n          transactionOrigin,\n        },\n      },\n    });\n\n    assertIsResponseWithInterface(response);\n\n    return response;\n  };\n\n  const onCronjob = (request: CronjobOptions) => {\n    log('Running cronjob %o.', options);\n\n    return handleRequest({\n      snapId: installedSnapId,\n      store,\n      executionService,\n      controllerMessenger,\n      runSaga,\n      handler: HandlerType.OnCronjob,\n      request,\n    });\n  };\n\n  return {\n    request: (request) => {\n      log('Sending request %o.', request);\n\n      return handleRequest({\n        snapId: installedSnapId,\n        store,\n        executionService,\n        controllerMessenger,\n        runSaga,\n        handler: HandlerType.OnRpcRequest,\n        request,\n      });\n    },\n\n    onTransaction,\n    sendTransaction: onTransaction,\n\n    onSignature: async (\n      request: unknown,\n    ): Promise<SnapResponseWithInterface> => {\n      log('Requesting signature %o.', request);\n\n      const { origin: signatureOrigin, ...signature } = create(\n        request,\n        SignatureOptionsStruct,\n      );\n\n      const response = await handleRequest({\n        snapId: installedSnapId,\n        store,\n        executionService,\n        controllerMessenger,\n        runSaga,\n        handler: HandlerType.OnSignature,\n        request: {\n          method: '',\n          params: {\n            signature,\n            signatureOrigin,\n          },\n        },\n      });\n\n      assertIsResponseWithInterface(response);\n\n      return response;\n    },\n\n    onCronjob,\n    runCronjob: onCronjob,\n\n    onHomePage: async (): Promise<SnapResponseWithInterface> => {\n      log('Rendering home page.');\n\n      const response = await handleRequest({\n        snapId: installedSnapId,\n        store,\n        executionService,\n        controllerMessenger,\n        runSaga,\n        handler: HandlerType.OnHomePage,\n        request: {\n          method: '',\n        },\n      });\n\n      assertIsResponseWithInterface(response);\n\n      return response;\n    },\n\n    mockJsonRpc(mock: JsonRpcMockOptions) {\n      log('Mocking JSON-RPC request %o.', mock);\n\n      const { method, result } = create(mock, JsonRpcMockOptionsStruct);\n      store.dispatch(addJsonRpcMock({ method, result }));\n\n      return {\n        unmock() {\n          log('Unmocking JSON-RPC request %o.', mock);\n\n          store.dispatch(removeJsonRpcMock(method));\n        },\n      };\n    },\n\n    close: async () => {\n      log('Closing execution service.');\n      logInfo(\n        'Calling `snap.close()` is deprecated, and will be removed in a future release. Snaps are now automatically closed when the test ends.',\n      );\n\n      await executionService.terminateAllSnaps();\n    },\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAEA,SAAS,aAAa,eAAe;AACrC,SAAS,cAAc,0BAA0B;AACjD,SAAS,cAAc;AAyBvB,IAAM,MAAM,mBAAmB,YAAY,SAAS;AASpD,SAAS,WAKP,QACA,SAC4D;AAC5D,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,CAAC,QAAW,MAAM;AAAA,EAC3B;AAEA,SAAO,CAAC,QAAQ,OAAO;AACzB;AAOA,SAAS,8BACP,UAC+C;AAC/C,eAAa,UAAU,+BAA+B;AACxD;AAqIA,eAAsB,YAKpB,QACA,UAAgD,CAAC,GAClC;AACf,QAAM,kBAAkB,WAAW,QAAQ,OAAO;AAClD,QAAM;AAAA,IACJ,QAAQ;AAAA,IACR;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI,MAAM,eAAe,EAAE,YAAY,GAAG,eAAe;AAEzD,QAAM,gBAAgB,OACpB,YACuC;AACvC,QAAI,2BAA2B,OAAO;AAEtC,UAAM;AAAA,MACJ,QAAQ;AAAA,MACR;AAAA,MACA,GAAG;AAAA,IACL,IAAI,OAAO,SAAS,wBAAwB;AAE5C,UAAM,WAAW,MAAM,cAAc;AAAA,MACnC,QAAQ;AAAA,MACR;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,YAAY;AAAA,MACrB,SAAS;AAAA,QACP,QAAQ;AAAA,QACR,QAAQ;AAAA,UACN;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,kCAA8B,QAAQ;AAEtC,WAAO;AAAA,EACT;AAEA,QAAM,YAAY,CAAC,YAA4B;AAC7C,QAAI,uBAAuB,OAAO;AAElC,WAAO,cAAc;AAAA,MACnB,QAAQ;AAAA,MACR;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,YAAY;AAAA,MACrB;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,SAAS,CAAC,YAAY;AACpB,UAAI,uBAAuB,OAAO;AAElC,aAAO,cAAc;AAAA,QACnB,QAAQ;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS,YAAY;AAAA,QACrB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IAEA;AAAA,IACA,iBAAiB;AAAA,IAEjB,aAAa,OACX,YACuC;AACvC,UAAI,4BAA4B,OAAO;AAEvC,YAAM,EAAE,QAAQ,iBAAiB,GAAG,UAAU,IAAI;AAAA,QAChD;AAAA,QACA;AAAA,MACF;AAEA,YAAM,WAAW,MAAM,cAAc;AAAA,QACnC,QAAQ;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS,YAAY;AAAA,QACrB,SAAS;AAAA,UACP,QAAQ;AAAA,UACR,QAAQ;AAAA,YACN;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,MACF,CAAC;AAED,oCAA8B,QAAQ;AAEtC,aAAO;AAAA,IACT;AAAA,IAEA;AAAA,IACA,YAAY;AAAA,IAEZ,YAAY,YAAgD;AAC1D,UAAI,sBAAsB;AAE1B,YAAM,WAAW,MAAM,cAAc;AAAA,QACnC,QAAQ;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS,YAAY;AAAA,QACrB,SAAS;AAAA,UACP,QAAQ;AAAA,QACV;AAAA,MACF,CAAC;AAED,oCAA8B,QAAQ;AAEtC,aAAO;AAAA,IACT;AAAA,IAEA,YAAY,MAA0B;AACpC,UAAI,gCAAgC,IAAI;AAExC,YAAM,EAAE,QAAQ,OAAO,IAAI,OAAO,MAAM,wBAAwB;AAChE,YAAM,SAAS,eAAe,EAAE,QAAQ,OAAO,CAAC,CAAC;AAEjD,aAAO;AAAA,QACL,SAAS;AACP,cAAI,kCAAkC,IAAI;AAE1C,gBAAM,SAAS,kBAAkB,MAAM,CAAC;AAAA,QAC1C;AAAA,MACF;AAAA,IACF;AAAA,IAEA,OAAO,YAAY;AACjB,UAAI,4BAA4B;AAChC;AAAA,QACE;AAAA,MACF;AAEA,YAAM,iBAAiB,kBAAkB;AAAA,IAC3C;AAAA,EACF;AACF;","names":[]}