@metamask/snaps-jest 4.0.1 → 6.0.0

package/CHANGELOG.md

@@ -6,6 +6,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.0.0]
+### Changed
+- **BREAKING:** Update ESM build to be fully compliant with the ESM standard ([#2210](https://github.com/MetaMask/snaps/pull/2210))
+- **BREAKING:** Move Node.js exports to separate export ([#2210](https://github.com/MetaMask/snaps/pull/2210))
+  - The default export is now browser-compatible.
+  - Node.js APIs can be imported from `<package>/node`.
+- Bump `@metamask/rpc-errors` to `^6.2.1` ([#2209](https://github.com/MetaMask/snaps/pull/2209))
+
+## [5.0.0]
+### Added
+- **BREAKING:** Implement testing framework using Node.js executor ([#1982](https://github.com/MetaMask/snaps/pull/1982), [#2118](https://github.com/MetaMask/snaps/pull/2118))
+  - The network mocking functionality was removed, but may be reintroduced in a future version.
+  - `mockJsonRpc` no longer returns a `Promise`.
+  - `runCronjob` was renamed to `onCronjob`, and `sendTransaction` was renamed to `onTransaction`.
+    - For backwards compatibility, the old methods are still available, but will be removed in a future version.
+- Add `onHomePage` support ([#2104](https://github.com/MetaMask/snaps/pull/2104))
+- Add `onSignature` support ([#2114](https://github.com/MetaMask/snaps/pull/2114))
+- Add `snap_getClientStatus` support ([#2159](https://github.com/MetaMask/snaps/pull/2159))
+
+### Changed
+- Bump several MetaMask dependencies ([#2101](https://github.com/MetaMask/snaps/pull/2101), [#2100](https://github.com/MetaMask/snaps/pull/2100), [#2129](https://github.com/MetaMask/snaps/pull/2129), [#2140](https://github.com/MetaMask/snaps/pull/2140), [#2141](https://github.com/MetaMask/snaps/pull/2141), [#2142](https://github.com/MetaMask/snaps/pull/2142))
+
 ## [4.0.1]
 ### Fixed
 - Fix coercing of address values in `sendTransaction` function ([#1970](https://github.com/MetaMask/snaps/pull/1970))
@@ -81,7 +103,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@4.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@6.0.0...HEAD
+[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
 [4.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@4.0.0...@metamask/snaps-jest@4.0.1
 [4.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@3.1.0...@metamask/snaps-jest@4.0.0
 [3.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@3.0.0...@metamask/snaps-jest@3.1.0

package/README.md

@@ -1,8 +1,7 @@
 # `@metamask/snaps-jest`
 
 A [Jest](https://jestjs.io/) preset for end-to-end testing MetaMask Snaps,
-including a Jest environment, and a set of Jest matchers. This package is
-currently experimental, and the API may change in the future.
+including a Jest environment, and a set of Jest matchers.
 
 - [Installation](#installation)
 - [Usage](#usage)
@@ -10,11 +9,12 @@ currently experimental, and the API may change in the future.
 - [API](#api)
   - [Install a snap](#install-a-snap)
   - [`snap.request`](#snaprequest)
-  - [`snap.sendTransaction`](#snapsendtransaction)
-  - [`snap.runCronjob`](#snapruncronjob)
+  - [`snap.onTransaction`](#snapontransaction)
+  - [`snap.onSignature`](#snaponsignature)
+  - [`snap.onCronjob`](#snaponcronjob)
+  - [`snap.onHomePage`](#snaponhomepage)
   - [Jest matchers](#jest-matchers)
   - [Interacting with user interfaces](#interacting-with-user-interfaces)
-  - [Network mocking](#network-mocking-snapmock)
 - [Options](#options)
 
 ## Installation
@@ -66,8 +66,8 @@ module.exports = {
 ### Install a snap
 
 `@metamask/snaps-jest` exposes a `installSnap` function that can be used to
-install a snap in the browser. It's recommended to use this function in each
-test, to ensure that each test starts with a clean slate.
+install a snap in the execution environment. It's recommended to use this
+function in each test, to ensure that each test starts with a clean slate.
 
 By default, if the built-in server is enabled, it will install the snap from
 the built-in server. Otherwise, you must specify a snap ID to install.
@@ -174,9 +174,9 @@ describe('MySnap', () => {
 });
 ```
 
-### `snap.sendTransaction`
+### `snap.onTransaction`
 
-The `sendTransaction` function can be used to send a transaction to the snap. It
+The `onTransaction` function can be used to send a transaction to the snap. It
 takes a single argument, which is an object with the following properties:
 
 - `origin`: The origin of the transaction.
@@ -204,8 +204,8 @@ import { panel, text } from '@metamask/snaps-sdk';
 
 describe('MySnap', () => {
   it('should do something', async () => {
-    const { sendTransaction } = await installSnap(/* optional snap ID */);
-    const response = await sendTransaction({
+    const { onTransaction } = await installSnap(/* optional snap ID */);
+    const response = await onTransaction({
       value: '0x0',
       data: '0x',
       gasLimit: '0x5208',
@@ -219,9 +219,43 @@ describe('MySnap', () => {
 });
 ```
 
-### `snap.runCronjob`
+### `snap.onSignature`
 
-The `runCronjob` function can be used to run a cronjob in the snap. It takes
+The `onSignature` function can be used to send a signature request to the snap. It
+takes a single argument, which is an object with the following properties:
+
+- `origin`: The origin of the signature request.
+- `from`: The address of the signer.
+- `data`: The data of the signature.
+- `signatureMethod`: The signature method being used in the request.
+
+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
+[onSignature](https://docs.metamask.io/snaps/reference/exports/#onsignature)
+function.
+
+```js
+import { installSnap } from '@metamask/snaps-jest';
+import { panel, text } from '@metamask/snaps-sdk';
+
+describe('MySnap', () => {
+  it('should do something', async () => {
+    const { onSignature } = await installSnap(/* optional snap ID */);
+    const response = await onSignature();
+
+    expect(response).toRender(
+      panel([text('You are using the personal_sign method')]),
+    );
+  });
+});
+```
+
+### `snap.onCronjob`
+
+The `onCronjob` function can be used to run a cronjob in the snap. It takes
 a single argument, which is similar to a JSON-RPC request object. It returns
 a promise that resolves to the response from the
 [onCronjob](https://docs.metamask.io/snaps/reference/exports/#oncronjob)
@@ -236,8 +270,8 @@ import { installSnap } from '@metamask/snaps-jest';
 
 describe('MySnap', () => {
   it('should do something', async () => {
-    const { runCronjob } = await installSnap(/* optional snap ID */);
-    const response = await runCronjob({
+    const { onCronjob } = await installSnap(/* optional snap ID */);
+    const response = await onCronjob({
       method: 'foo',
       params: [],
     });
@@ -254,8 +288,8 @@ import { installSnap } from '@metamask/snaps-jest';
 
 describe('MySnap', () => {
   it('should do something', async () => {
-    const { runCronjob } = await installSnap(/* optional snap ID */);
-    const response = await runCronjob({
+    const { onCronjob } = await installSnap(/* optional snap ID */);
+    const response = await onCronjob({
       method: 'foo',
       params: [],
     });
@@ -266,21 +300,25 @@ describe('MySnap', () => {
 });
 ```
 
-### `snap.close`
+### `snap.onHomePage`
 
-The `close` function can be used to close the page that the test is running in.
-This is mainly useful for cleaning up after a test, and is not required. It can
-potentially speed up your tests, since it prevents too many pages from being
-open at the same time.
+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
+[onHomePage](https://docs.metamask.io/snaps/reference/entry-points/#onhomepage)
+function.
 
 ```js
 import { installSnap } from '@metamask/snaps-jest';
 
 describe('MySnap', () => {
   it('should do something', async () => {
-    const { close } = await installSnap(/* optional snap ID */);
-    // ...
-    await close();
+    const { onHomePage } = await installSnap(/* optional snap ID */);
+    const response = await onHomePage({
+      method: 'foo',
+      params: [],
+    });
+
+    expect(response).toRender(/* ... */);
   });
 });
 ```
@@ -300,8 +338,9 @@ assert that a response from a snap matches an expected value:
 - `toRender(expectedInterface)`: Check if a snap rendered an interface. This is
   useful for testing the UI of a snap, either for a
   [`snap_dialog`](https://docs.metamask.io/snaps/reference/rpc-api/#snap_dialog),
-  or a UI rendered by
-  [the transaction insights API](https://docs.metamask.io/snaps/reference/exports/#ontransaction).
+  UI rendered by
+  [the transaction insights API](https://docs.metamask.io/snaps/reference/exports/#ontransaction) or
+  [the signature insights API](https://docs.metamask.io/snaps/reference/exports/#onsignature).
 
 ### Interacting with user interfaces
 
@@ -345,59 +384,6 @@ describe('MySnap', () => {
 });
 ```
 
-### Network mocking (`snap.mock`)
-
-`@metamask/snaps-jest` includes basic network mocking functionality. This can
-be used to mock the response of any network request made by the snap through
-the `endowment:network-access` functionality.
-
-The mock function takes a single argument, which is an object with the
-following properties:
-
-- `url` (`string | RegExp`): The URL of the request. This can be a string, or a
-  regular expression.
-- `partial` (`boolean`): If enabled, the request will be mocked if the URL
-  starts with the given URL. This option is ignored if a RegExp is provided to
-  the `url` option. Defaults to `false`.
-- `response` (`object`): An object with the response.
-  - `status` (`number`): The status code of the response. Defaults to `200`.
-  - `body` (`string`): The body of the response. Defaults to an empty string.
-  - `headers` (`object`): An object with the headers of the response. By
-    default, this will use headers that enable CORS.
-  - `contentType` (`string`): The content type of the response. Defaults to
-    `text/plain`.
-
-Except for the `url` option, all options are optional.
-
-#### Unmocking (`mock.unmock`)
-
-The mock function returns an object with an `unmock` function that can be
-used to remove the mock. Mocking happens on a per-snap-install basis. If the
-mock is not removed, it will remain active for the rest of the snap
-installation, so it does not affect other tests with a fresh snap installation.
-
-#### Example
-
-```js
-import { installSnap } from '@metamask/snaps-jest';
-
-describe('MySnap', () => {
-  it('should do something', async () => {
-    const { mock, request } = await installSnap(/* optional snap ID */);
-
-    const { unmock } = mock({
-      url: 'https://example.com',
-      status: 200,
-      body: 'Hello, world!',
-    });
-
-    // ...
-
-    unmock();
-  });
-});
-```
-
 ## Options
 
 You can pass options to the test environment by adding a
@@ -414,44 +400,6 @@ module.exports = {
 
 All options are optional, and have sensible defaults.
 
-### `keepAlive`
-
-- Type: `boolean`
-- Default: `false`
-
-Whether to keep the Jest environment running after the tests have finished. This
-is useful for debugging, but should not be used in CI environments: When this is
-enabled, the `jest` process will not exit on its own, and will need to be
-manually killed (e.g., with <kbd>Ctrl</kbd> + <kbd>C</kbd>).
-
-#### Example
-
-```js
-module.exports = {
-  preset: '@metamask/snaps-jest',
-  testEnvironmentOptions: {
-    keepAlive: true,
-  },
-};
-```
-
-### `browser`
-
-- Type: `object`
-
-Options for the browser that is used to run the tests.
-
-#### `browser.headless`
-
-- Type: `boolean`
-- Default: `true`
-
-Whether to run the browser in headless mode. By default, it will be enabled. If
-you want to see the browser window while the tests are running, you can disable
-this option. Note that this will require you to have a graphical environment
-available, so it is not recommended for CI environments, but can be useful for
-debugging in conjunction with the `keepAlive` option.
-
 ### `server`
 
 - Type: `object`
@@ -524,64 +472,3 @@ module.exports = {
   },
 };
 ```
-
-##### Example
-
-```js
-module.exports = {
-  preset: '@metamask/snaps-jest',
-  testEnvironmentOptions: {
-    browser: {
-      headless: false,
-    },
-  },
-};
-```
-
-### `executionEnvironmentUrl`
-
-- Type: `string`
-
-The URL of the execution environment to use for testing. This is the URL that
-will be loaded by the Snaps Simulator in the tests. By default, it will use the
-URL of the built-in HTTP server that is included with this package.
-
-> **Note**: This option is intended for advanced use cases. In most cases, you
-> should not need to change this option.
-
-See also: [`@metamask/snaps-execution-environments`](../snaps-execution-environments/README.md).
-
-#### Example
-
-```js
-module.exports = {
-  preset: '@metamask/snaps-jest',
-  testEnvironmentOptions: {
-    executionEnvironmentUrl: 'http://localhost:8080',
-  },
-};
-```
-
-### `simulatorUrl`
-
-- Type: `string`
-
-The URL of the simulator to use for testing. This is the URL that will be
-loaded in the browser when running tests. By default, it will use the URL of
-the built-in HTTP server that is included with this package.
-
-> **Note**: This option is intended for advanced use cases. In most cases, you
-> should not need to change this option.
-
-See also: [`@metamask/snaps-simulator`](../snaps-simulator/README.md).
-
-#### Example
-
-```js
-module.exports = {
-  preset: '@metamask/snaps-jest',
-  testEnvironmentOptions: {
-    simulatorUrl: 'http://localhost:8081',
-  },
-};
-```

package/dist/chunk-2KLZ7GOW.js

@@ -0,0 +1,15 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/internals/simulation/middleware/internal-methods/provider-state.ts
+async function getProviderStateHandler(_request, response, _next, end) {
+  response.result = {
+    isUnlocked: true,
+    chainId: "0x01",
+    networkVersion: "0x01",
+    accounts: []
+  };
+  return end();
+}
+
+
+
+exports.getProviderStateHandler = getProviderStateHandler;
+//# sourceMappingURL=chunk-2KLZ7GOW.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/middleware/internal-methods/provider-state.ts"],"names":[],"mappings":";AAqBA,eAAsB,wBACpB,UACA,UACA,OACA,KACA;AAGA,WAAS,SAAS;AAAA,IAChB,YAAY;AAAA,IACZ,SAAS;AAAA,IACT,gBAAgB;AAAA,IAChB,UAAU,CAAC;AAAA,EACb;AAEA,SAAO,IAAI;AACb","sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  JsonRpcEngineNextCallback,\n} from '@metamask/json-rpc-engine';\nimport type {\n  Json,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\n/**\n * A mock handler for metamask_getProviderState that always returns a specific\n * hardcoded result.\n *\n * @param _request - Incoming JSON-RPC request. Ignored for this specific\n * handler.\n * @param response - The outgoing JSON-RPC response, modified to return the\n * result.\n * @param _next - The `json-rpc-engine` middleware next handler.\n * @param end - The `json-rpc-engine` middleware end handler.\n */\nexport async function getProviderStateHandler(\n  _request: JsonRpcRequest,\n  response: PendingJsonRpcResponse<Json>,\n  _next: JsonRpcEngineNextCallback,\n  end: JsonRpcEngineEndCallback,\n) {\n  // For now this will return a mocked result, this should probably match\n  // whatever network the simulation is using.\n  response.result = {\n    isUnlocked: true,\n    chainId: '0x01',\n    networkVersion: '0x01',\n    accounts: [],\n  };\n\n  return end();\n}\n"]}

package/dist/chunk-2M7WQ26F.js

@@ -0,0 +1,28 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/options.ts
+
+
+
+
+
+
+
+
+var _superstruct = require('superstruct');
+var SnapsEnvironmentOptionsStruct = _superstruct.type.call(void 0, {
+  server: _superstruct.defaulted.call(void 0, 
+    _superstruct.object.call(void 0, {
+      enabled: _superstruct.defaulted.call(void 0, _superstruct.boolean.call(void 0, ), true),
+      port: _superstruct.defaulted.call(void 0, _superstruct.number.call(void 0, ), 0),
+      root: _superstruct.defaulted.call(void 0, _superstruct.string.call(void 0, ), process.cwd())
+    }),
+    {}
+  )
+});
+function getOptions(testEnvironmentOptions) {
+  return _superstruct.create.call(void 0, testEnvironmentOptions, SnapsEnvironmentOptionsStruct);
+}
+
+
+
+exports.getOptions = getOptions;
+//# sourceMappingURL=chunk-2M7WQ26F.js.map

package/dist/chunk-2M7WQ26F.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 'superstruct';\nimport {\n  boolean,\n  create,\n  defaulted,\n  number,\n  object,\n  string,\n  type,\n} from '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-34GS3AHA.js

@@ -0,0 +1,33 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/internals/simulation/store/mocks.ts
+var _toolkit = require('@reduxjs/toolkit');
+var INITIAL_STATE = {
+  jsonRpc: {}
+};
+var mocksSlice = _toolkit.createSlice.call(void 0, {
+  name: "mocks",
+  initialState: INITIAL_STATE,
+  reducers: {
+    addJsonRpcMock: (state, action) => {
+      state.jsonRpc[action.payload.method] = action.payload.result;
+    },
+    removeJsonRpcMock: (state, action) => {
+      delete state.jsonRpc[action.payload];
+    }
+  }
+});
+var { addJsonRpcMock, removeJsonRpcMock } = mocksSlice.actions;
+var getJsonRpcMocks = (state) => state.mocks.jsonRpc;
+var getJsonRpcMock = _toolkit.createSelector.call(void 0, 
+  getJsonRpcMocks,
+  (_, method) => method,
+  (jsonRpcMocks, method) => jsonRpcMocks[method]
+);
+
+
+
+
+
+
+
+exports.mocksSlice = mocksSlice; exports.addJsonRpcMock = addJsonRpcMock; exports.removeJsonRpcMock = removeJsonRpcMock; exports.getJsonRpcMocks = getJsonRpcMocks; exports.getJsonRpcMock = getJsonRpcMock;
+//# sourceMappingURL=chunk-34GS3AHA.js.map

package/dist/chunk-34GS3AHA.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/store/mocks.ts"],"names":[],"mappings":";AAEA,SAAS,gBAAgB,mBAAmB;AAgB5C,IAAM,gBAA4B;AAAA,EAChC,SAAS,CAAC;AACZ;AAEO,IAAM,aAAa,YAAY;AAAA,EACpC,MAAM;AAAA,EACN,cAAc;AAAA,EACd,UAAU;AAAA,IACR,gBAAgB,CAAC,OAAO,WAAuC;AAG7D,YAAM,QAAQ,OAAO,QAAQ,MAAM,IAAI,OAAO,QAAQ;AAAA,IACxD;AAAA,IACA,mBAAmB,CAAC,OAAO,WAAkC;AAC3D,aAAO,MAAM,QAAQ,OAAO,OAAO;AAAA,IACrC;AAAA,EACF;AACF,CAAC;AAEM,IAAM,EAAE,gBAAgB,kBAAkB,IAAI,WAAW;AAQzD,IAAM,kBAAkB,CAAC,UAA4B,MAAM,MAAM;AAKjE,IAAM,iBAAiB;AAAA,EAC5B;AAAA,EACA,CAAC,GAAY,WAAmB;AAAA,EAChC,CAAC,cAAc,WAAW,aAAa,MAAM;AAC/C","sourcesContent":["import type { Json } from '@metamask/utils';\nimport type { PayloadAction } from '@reduxjs/toolkit';\nimport { createSelector, createSlice } from '@reduxjs/toolkit';\n\nimport type { ApplicationState } from './store';\n\nexport type JsonRpcMock = {\n  method: string;\n  result: Json;\n};\n\nexport type MocksState = {\n  jsonRpc: Record<string, Json>;\n};\n\n/**\n * The initial notifications state.\n */\nconst INITIAL_STATE: MocksState = {\n  jsonRpc: {},\n};\n\nexport const mocksSlice = createSlice({\n  name: 'mocks',\n  initialState: INITIAL_STATE,\n  reducers: {\n    addJsonRpcMock: (state, action: PayloadAction<JsonRpcMock>) => {\n      // @ts-expect-error - TS2589: Type instantiation is excessively deep and\n      // possibly infinite.\n      state.jsonRpc[action.payload.method] = action.payload.result;\n    },\n    removeJsonRpcMock: (state, action: PayloadAction<string>) => {\n      delete state.jsonRpc[action.payload];\n    },\n  },\n});\n\nexport const { addJsonRpcMock, removeJsonRpcMock } = mocksSlice.actions;\n\n/**\n * Get the JSON-RPC mocks from the state.\n *\n * @param state - The application state.\n * @returns The JSON-RPC mocks.\n */\nexport const getJsonRpcMocks = (state: ApplicationState) => state.mocks.jsonRpc;\n\n/**\n * Get the JSON-RPC mock for a given method from the state.\n */\nexport const getJsonRpcMock = createSelector(\n  getJsonRpcMocks,\n  (_: unknown, method: string) => method,\n  (jsonRpcMocks, method) => jsonRpcMocks[method],\n);\n"]}

package/dist/chunk-3CC2NI7R.js

@@ -0,0 +1,80 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkK2KTKFLPjs = require('./chunk-K2KTKFLP.js');
+
+
+
+var _chunkON6M4WG5js = require('./chunk-ON6M4WG5.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((result) => {
+    const notifications = _chunkON6M4WG5js.getNotifications.call(void 0, store.getState());
+    store.dispatch(_chunkON6M4WG5js.clearNotifications.call(void 0, ));
+    const content = getContentFromResult(result, snapId, controllerMessenger);
+    return {
+      id: String(id),
+      response: {
+        result: _utils.getSafeJson.call(void 0, result)
+      },
+      notifications,
+      content
+    };
+  }).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(
+      _chunkK2KTKFLPjs.getInterface,
+      runSaga,
+      snapId,
+      controllerMessenger
+    ).toPromise();
+  };
+  return promise;
+}
+function getContentFromResult(result, snapId, controllerMessenger) {
+  if (_utils.isPlainObject.call(void 0, result) && _utils.hasProperty.call(void 0, result, "id")) {
+    return controllerMessenger.call(
+      "SnapInterfaceController:getInterface",
+      snapId,
+      result.id
+    ).content;
+  }
+  if (_utils.isPlainObject.call(void 0, result) && _utils.hasProperty.call(void 0, result, "content")) {
+    return result.content;
+  }
+  return void 0;
+}
+
+
+
+
+exports.handleRequest = handleRequest; exports.getContentFromResult = getContentFromResult;
+//# sourceMappingURL=chunk-3CC2NI7R.js.map

package/dist/chunk-3CC2NI7R.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;AAyChB,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,CAAC,WAAW;AAChB,UAAM,gBAAgB,iBAAiB,MAAM,SAAS,CAAC;AACvD,UAAM,SAAS,mBAAmB,CAAC;AAEnC,UAAM,UAAU,qBAAqB,QAAQ,QAAQ,mBAAmB;AAExE,WAAO;AAAA,MACL,IAAI,OAAO,EAAE;AAAA,MACb,UAAU;AAAA,QACR,QAAQ,YAAY,MAAM;AAAA,MAC5B;AAAA,MACA;AAAA,MACA;AAAA,IACF;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;AAUO,SAAS,qBACd,QACA,QACA,qBACuB;AACvB,MAAI,cAAc,MAAM,KAAK,YAAY,QAAQ,IAAI,GAAG;AACtD,WAAO,oBAAoB;AAAA,MACzB;AAAA,MACA;AAAA,MACA,OAAO;AAAA,IACT,EAAE;AAAA,EACJ;AAEA,MAAI,cAAc,MAAM,KAAK,YAAY,QAAQ,SAAS,GAAG;AAC3D,WAAO,OAAO;AAAA,EAChB;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 { RequestOptions, SnapRequest } from '../types';\nimport {\n  clearNotifications,\n  getInterface,\n  getNotifications,\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((result) => {\n      const notifications = getNotifications(store.getState());\n      store.dispatch(clearNotifications());\n\n      const content = getContentFromResult(result, snapId, controllerMessenger);\n\n      return {\n        id: String(id),\n        response: {\n          result: getSafeJson(result),\n        },\n        notifications,\n        content,\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 response content either from the SnapInterfaceController or the response object if there is one.\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 function getContentFromResult(\n  result: unknown,\n  snapId: SnapId,\n  controllerMessenger: RootControllerMessenger,\n): Component | undefined {\n  if (isPlainObject(result) && hasProperty(result, 'id')) {\n    return controllerMessenger.call(\n      'SnapInterfaceController:getInterface',\n      snapId,\n      result.id as string,\n    ).content;\n  }\n\n  if (isPlainObject(result) && hasProperty(result, 'content')) {\n    return result.content as Component;\n  }\n\n  return undefined;\n}\n"]}

package/dist/chunk-3IUQA6YL.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=chunk-3IUQA6YL.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/chunk-3KCEPGJA.js

@@ -0,0 +1,39 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+var _chunk4WCFXE73js = require('./chunk-4WCFXE73.js');
+
+// src/internals/simulation/methods/hooks/state.ts
+var _effects = require('redux-saga/effects');
+function* getSnapStateImplementation(_snapId, encrypted = true) {
+  return yield _effects.select.call(void 0, _chunk4WCFXE73js.getState.call(void 0, encrypted));
+}
+function getGetSnapStateMethodImplementation(runSaga) {
+  return (...args) => {
+    return runSaga(getSnapStateImplementation, ...args).result();
+  };
+}
+function* updateSnapStateImplementation(_snapId, newState, encrypted = true) {
+  yield _effects.put.call(void 0, _chunk4WCFXE73js.setState.call(void 0, { state: newState, encrypted }));
+}
+function getUpdateSnapStateMethodImplementation(runSaga) {
+  return (...args) => {
+    runSaga(updateSnapStateImplementation, ...args).result();
+  };
+}
+function* clearSnapStateImplementation(_snapId, encrypted = true) {
+  yield _effects.put.call(void 0, _chunk4WCFXE73js.clearState.call(void 0, { encrypted }));
+}
+function getClearSnapStateMethodImplementation(runSaga) {
+  return async (...args) => {
+    runSaga(clearSnapStateImplementation, ...args).result();
+  };
+}
+
+
+
+
+
+exports.getGetSnapStateMethodImplementation = getGetSnapStateMethodImplementation; exports.getUpdateSnapStateMethodImplementation = getUpdateSnapStateMethodImplementation; exports.getClearSnapStateMethodImplementation = getClearSnapStateMethodImplementation;
+//# sourceMappingURL=chunk-3KCEPGJA.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/methods/hooks/state.ts"],"names":[],"mappings":";;;;;;;AACA,SAAS,KAAK,cAAc;AAe5B,UAAU,2BACR,SACA,YAAY,MACU;AACtB,SAAO,MAAM,OAAO,SAAS,SAAS,CAAC;AACzC;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;AACpB,QAAM,IAAI,SAAS,EAAE,OAAO,UAAU,UAAU,CAAC,CAAC;AACpD;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","sourcesContent":["import 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  return yield select(getState(encrypted));\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: string,\n  encrypted = true,\n): SagaIterator<void> {\n  yield put(setState({ state: 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"]}

package/dist/chunk-3KQYPQZY.js

@@ -0,0 +1,20 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunk34GS3AHAjs = require('./chunk-34GS3AHA.js');
+
+// src/internals/simulation/middleware/mock.ts
+function createMockMiddleware(store) {
+  return function mockMiddleware(request, response, next, end) {
+    const result = _chunk34GS3AHAjs.getJsonRpcMock.call(void 0, store.getState(), request.method);
+    if (result) {
+      response.result = result;
+      return end();
+    }
+    return next();
+  };
+}
+
+
+
+exports.createMockMiddleware = createMockMiddleware;
+//# sourceMappingURL=chunk-3KQYPQZY.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/middleware/mock.ts"],"names":[],"mappings":";;;;;AAYO,SAAS,qBACd,OACwC;AACxC,SAAO,SAAS,eAAe,SAAS,UAAU,MAAM,KAAK;AAC3D,UAAM,SAAS,eAAe,MAAM,SAAS,GAAG,QAAQ,MAAM;AAC9D,QAAI,QAAQ;AACV,eAAS,SAAS;AAClB,aAAO,IAAI;AAAA,IACb;AAEA,WAAO,KAAK;AAAA,EACd;AACF","sourcesContent":["import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\n\nimport type { Store } from '../store';\nimport { getJsonRpcMock } from '../store/mocks';\n\n/**\n * Create a middleware for handling JSON-RPC methods that have been mocked.\n *\n * @param store - The Redux store to use.\n * @returns A middleware function.\n */\nexport function createMockMiddleware(\n  store: Store,\n): JsonRpcMiddleware<JsonRpcParams, Json> {\n  return function mockMiddleware(request, response, next, end) {\n    const result = getJsonRpcMock(store.getState(), request.method);\n    if (result) {\n      response.result = result;\n      return end();\n    }\n\n    return next();\n  };\n}\n"]}