@metamask/snaps-simulation 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0]
+
+### Changed
+
+- Move helper functions to simulation package ([#2769](https://github.com/MetaMask/snaps/pull/2769))
+
 ## [1.0.1]
 
 ### Fixed
@@ -19,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release of `@metamask/snaps-simulation` package ([#2727](https://github.com/MetaMask/snaps/pull/2727))
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-simulation@1.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-simulation@1.1.0...HEAD
+[1.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-simulation@1.0.1...@metamask/snaps-simulation@1.1.0
 [1.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-simulation@1.0.0...@metamask/snaps-simulation@1.0.1
 [1.0.0]: https://github.com/MetaMask/snaps/releases/tag/@metamask/snaps-simulation@1.0.0

package/dist/helpers.cjs

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHelpers = void 0;
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const logger_1 = require("./logger.cjs");
+const request_1 = require("./request.cjs");
+const store_1 = require("./store/index.cjs");
+const structs_1 = require("./structs.cjs");
+const log = (0, utils_1.createModuleLogger)(logger_1.rootLogger, 'helpers');
+/**
+ * Get the helper functions for the Snap.
+ *
+ * @param snap - The installed Snap.
+ * @param snap.snapId - The ID of the Snap.
+ * @param snap.store - The Redux store.
+ * @param snap.executionService - The execution service.
+ * @param snap.runSaga - The `runSaga` function.
+ * @param snap.controllerMessenger - The controller messenger.
+ * @param snap.options - The simulation options.
+ * @returns The Snap helpers.
+ */
+function getHelpers({ snapId, store, executionService, runSaga, controllerMessenger, options, }) {
+    const onTransaction = async (request) => {
+        log('Sending transaction %o.', request);
+        const { origin: transactionOrigin, chainId, ...transaction } = (0, superstruct_1.create)(request, structs_1.TransactionOptionsStruct);
+        const response = await (0, request_1.handleRequest)({
+            snapId,
+            store,
+            executionService,
+            runSaga,
+            controllerMessenger,
+            handler: snaps_utils_1.HandlerType.OnTransaction,
+            request: {
+                method: '',
+                params: {
+                    chainId,
+                    transaction,
+                    transactionOrigin,
+                },
+            },
+        });
+        (0, structs_1.assertIsResponseWithInterface)(response);
+        return response;
+    };
+    const onCronjob = (request) => {
+        log('Running cronjob %o.', options);
+        return (0, request_1.handleRequest)({
+            snapId,
+            store,
+            executionService,
+            controllerMessenger,
+            runSaga,
+            handler: snaps_utils_1.HandlerType.OnCronjob,
+            request,
+        });
+    };
+    return {
+        request: (request) => {
+            log('Sending request %o.', request);
+            return (0, request_1.handleRequest)({
+                snapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: snaps_utils_1.HandlerType.OnRpcRequest,
+                request,
+            });
+        },
+        onTransaction,
+        sendTransaction: onTransaction,
+        onSignature: async (request) => {
+            log('Requesting signature %o.', request);
+            const { origin: signatureOrigin, ...signature } = (0, superstruct_1.create)(request, structs_1.SignatureOptionsStruct);
+            const response = await (0, request_1.handleRequest)({
+                snapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: snaps_utils_1.HandlerType.OnSignature,
+                request: {
+                    method: '',
+                    params: {
+                        signature,
+                        signatureOrigin,
+                    },
+                },
+            });
+            (0, structs_1.assertIsResponseWithInterface)(response);
+            return response;
+        },
+        onCronjob,
+        runCronjob: onCronjob,
+        onHomePage: async () => {
+            log('Rendering home page.');
+            const response = await (0, request_1.handleRequest)({
+                snapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: snaps_utils_1.HandlerType.OnHomePage,
+                request: {
+                    method: '',
+                },
+            });
+            (0, structs_1.assertIsResponseWithInterface)(response);
+            return response;
+        },
+        mockJsonRpc(mock) {
+            log('Mocking JSON-RPC request %o.', mock);
+            const { method, result } = (0, superstruct_1.create)(mock, structs_1.JsonRpcMockOptionsStruct);
+            store.dispatch((0, store_1.addJsonRpcMock)({ method, result }));
+            return {
+                unmock() {
+                    log('Unmocking JSON-RPC request %o.', mock);
+                    store.dispatch((0, store_1.removeJsonRpcMock)(method));
+                },
+            };
+        },
+        close: async () => {
+            log('Closing execution service.');
+            await executionService.terminateAllSnaps();
+        },
+    };
+}
+exports.getHelpers = getHelpers;
+//# sourceMappingURL=helpers.cjs.map

package/dist/helpers.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.cjs","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,uDAA+C;AAC/C,2CAAqD;AAErD,yCAAsC;AAEtC,2CAA0C;AAE1C,6CAA4D;AAC5D,2CAKmB;AAWnB,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAAC,mBAAU,EAAE,SAAS,CAAC,CAAC;AA8HtD;;;;;;;;;;;GAWG;AACH,SAAgB,UAAU,CAAC,EACzB,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,OAAO,EACP,mBAAmB,EACnB,OAAO,GACwC;IAC/C,MAAM,aAAa,GAAG,KAAK,EACzB,OAA2B,EACS,EAAE;QACtC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;QAExC,MAAM,EACJ,MAAM,EAAE,iBAAiB,EACzB,OAAO,EACP,GAAG,WAAW,EACf,GAAG,IAAA,oBAAM,EAAC,OAAO,EAAE,kCAAwB,CAAC,CAAC;QAE9C,MAAM,QAAQ,GAAG,MAAM,IAAA,uBAAa,EAAC;YACnC,MAAM;YACN,KAAK;YACL,gBAAgB;YAChB,OAAO;YACP,mBAAmB;YACnB,OAAO,EAAE,yBAAW,CAAC,aAAa;YAClC,OAAO,EAAE;gBACP,MAAM,EAAE,EAAE;gBACV,MAAM,EAAE;oBACN,OAAO;oBACP,WAAW;oBACX,iBAAiB;iBAClB;aACF;SACF,CAAC,CAAC;QAEH,IAAA,uCAA6B,EAAC,QAAQ,CAAC,CAAC;QAExC,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,OAAuB,EAAE,EAAE;QAC5C,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAA,uBAAa,EAAC;YACnB,MAAM;YACN,KAAK;YACL,gBAAgB;YAChB,mBAAmB;YACnB,OAAO;YACP,OAAO,EAAE,yBAAW,CAAC,SAAS;YAC9B,OAAO;SACR,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;YACnB,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAA,uBAAa,EAAC;gBACnB,MAAM;gBACN,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,yBAAW,CAAC,YAAY;gBACjC,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,aAAa;QACb,eAAe,EAAE,aAAa;QAE9B,WAAW,EAAE,KAAK,EAChB,OAAgB,EACoB,EAAE;YACtC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;YAEzC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,SAAS,EAAE,GAAG,IAAA,oBAAM,EACtD,OAAO,EACP,gCAAsB,CACvB,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,uBAAa,EAAC;gBACnC,MAAM;gBACN,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,yBAAW,CAAC,WAAW;gBAChC,OAAO,EAAE;oBACP,MAAM,EAAE,EAAE;oBACV,MAAM,EAAE;wBACN,SAAS;wBACT,eAAe;qBAChB;iBACF;aACF,CAAC,CAAC;YAEH,IAAA,uCAA6B,EAAC,QAAQ,CAAC,CAAC;YAExC,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,SAAS;QACT,UAAU,EAAE,SAAS;QAErB,UAAU,EAAE,KAAK,IAAwC,EAAE;YACzD,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAE5B,MAAM,QAAQ,GAAG,MAAM,IAAA,uBAAa,EAAC;gBACnC,MAAM;gBACN,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,yBAAW,CAAC,UAAU;gBAC/B,OAAO,EAAE;oBACP,MAAM,EAAE,EAAE;iBACX;aACF,CAAC,CAAC;YAEH,IAAA,uCAA6B,EAAC,QAAQ,CAAC,CAAC;YAExC,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,WAAW,CAAC,IAAwB;YAClC,GAAG,CAAC,8BAA8B,EAAE,IAAI,CAAC,CAAC;YAE1C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,oBAAM,EAAC,IAAI,EAAE,kCAAwB,CAAC,CAAC;YAClE,KAAK,CAAC,QAAQ,CAAC,IAAA,sBAAc,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YAEnD,OAAO;gBACL,MAAM;oBACJ,GAAG,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC;oBAE5C,KAAK,CAAC,QAAQ,CAAC,IAAA,yBAAiB,EAAC,MAAM,CAAC,CAAC,CAAC;gBAC5C,CAAC;aACF,CAAC;QACJ,CAAC;QAED,KAAK,EAAE,KAAK,IAAI,EAAE;YAChB,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAClC,MAAM,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAC7C,CAAC;KACF,CAAC;AACJ,CAAC;AAnJD,gCAmJC","sourcesContent":["import { HandlerType } from '@metamask/snaps-utils';\nimport { create } from '@metamask/superstruct';\nimport { createModuleLogger } from '@metamask/utils';\n\nimport { rootLogger } from './logger';\nimport type { SimulationOptions } from './options';\nimport { handleRequest } from './request';\nimport type { InstalledSnap } from './simulation';\nimport { addJsonRpcMock, removeJsonRpcMock } from './store';\nimport {\n  assertIsResponseWithInterface,\n  JsonRpcMockOptionsStruct,\n  SignatureOptionsStruct,\n  TransactionOptionsStruct,\n} from './structs';\nimport type {\n  CronjobOptions,\n  JsonRpcMockOptions,\n  RequestOptions,\n  SignatureOptions,\n  SnapRequest,\n  SnapResponseWithInterface,\n  TransactionOptions,\n} from './types';\n\nconst log = createModuleLogger(rootLogger, 'helpers');\n\n/**\n * This is the main entry point to interact with the snap. It is returned by\n * {@link installSnap}, and has methods to send requests to the snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * const snap = await installSnap();\n * const response = await snap.request({ method: 'hello' });\n *\n * expect(response).toRespondWith('Hello, world!');\n */\nexport type SnapHelpers = {\n  /**\n   * Send a JSON-RPC request to the snap.\n   *\n   * @param request - The request. This is similar to a JSON-RPC request, but\n   * has an extra `origin` field.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   */\n  request(request: RequestOptions): SnapRequest;\n\n  /**\n   * Send a transaction to the snap.\n   *\n   * @param transaction - The transaction. This is similar to an Ethereum\n   * transaction object, but has an extra `origin` field. Any missing fields\n   * will be filled in with default values.\n   * @returns The response.\n   */\n  onTransaction(\n    transaction?: Partial<TransactionOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Send a transaction to the snap.\n   *\n   * @param transaction - The transaction. This is similar to an Ethereum\n   * transaction object, but has an extra `origin` field. Any missing fields\n   * will be filled in with default values.\n   * @returns The response.\n   * @deprecated Use {@link onTransaction} instead.\n   */\n  sendTransaction(\n    transaction?: Partial<TransactionOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Send a signature request to the snap.\n   *\n   * @param signature - The signature request object. Contains the params from\n   * the various signature methods, but has an extra `origin` and `signatureMethod` field.\n   * Any missing fields will be filled in with default values.\n   * @returns The response.\n   */\n  onSignature(\n    signature?: Partial<SignatureOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Run a cronjob in the snap. This is similar to {@link request}, but the\n   * request will be sent to the `onCronjob` method of the snap.\n   *\n   * @param cronjob - The cronjob request. This is similar to a JSON-RPC\n   * request, and is normally specified in the snap manifest, under the\n   * `endowment:cronjob` permission.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   */\n  onCronjob(cronjob?: Partial<CronjobOptions>): SnapRequest;\n\n  /**\n   * Run a cronjob in the snap. This is similar to {@link request}, but the\n   * request will be sent to the `onCronjob` method of the snap.\n   *\n   * @param cronjob - The cronjob request. This is similar to a JSON-RPC\n   * request, and is normally specified in the snap manifest, under the\n   * `endowment:cronjob` permission.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   * @deprecated Use {@link onCronjob} instead.\n   */\n  runCronjob(cronjob: CronjobOptions): SnapRequest;\n\n  /**\n   * Get the response from the snap's `onHomePage` method.\n   *\n   * @returns The response.\n   */\n  onHomePage(): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Mock a JSON-RPC request. This will cause the snap to respond with the\n   * specified response when a request with the specified method is sent.\n   *\n   * @param mock - The mock options.\n   * @param mock.method - The JSON-RPC request method.\n   * @param mock.result - The JSON-RPC response, which will be returned when a\n   * request with the specified method is sent.\n   * @example\n   * import { installSnap } from '@metamask/snaps-jest';\n   *\n   * // In the test\n   * const snap = await installSnap();\n   * snap.mockJsonRpc({ method: 'eth_accounts', result: ['0x1234'] });\n   *\n   * // In the Snap\n   * const response =\n   *   await ethereum.request({ method: 'eth_accounts' }); // ['0x1234']\n   */\n  mockJsonRpc(mock: JsonRpcMockOptions): {\n    /**\n     * Remove the mock.\n     */\n    unmock(): void;\n  };\n\n  /**\n   * Close the page running the snap. This is mainly useful for cleaning up\n   * the test environment, and calling it is not strictly necessary.\n   *\n   * @returns A promise that resolves when the page is closed.\n   */\n  close(): Promise<void>;\n};\n\n/**\n * Get the helper functions for the Snap.\n *\n * @param snap - The installed Snap.\n * @param snap.snapId - The ID of the Snap.\n * @param snap.store - The Redux store.\n * @param snap.executionService - The execution service.\n * @param snap.runSaga - The `runSaga` function.\n * @param snap.controllerMessenger - The controller messenger.\n * @param snap.options - The simulation options.\n * @returns The Snap helpers.\n */\nexport function getHelpers({\n  snapId,\n  store,\n  executionService,\n  runSaga,\n  controllerMessenger,\n  options,\n}: InstalledSnap & { options: SimulationOptions }): SnapHelpers {\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,\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,\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,\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,\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,\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      await executionService.terminateAllSnaps();\n    },\n  };\n}\n"]}

package/dist/helpers.d.cts

@@ -0,0 +1,128 @@
+import type { SimulationOptions } from "./options.cjs";
+import type { InstalledSnap } from "./simulation.cjs";
+import type { CronjobOptions, JsonRpcMockOptions, RequestOptions, SignatureOptions, SnapRequest, SnapResponseWithInterface, TransactionOptions } from "./types.cjs";
+/**
+ * This is the main entry point to interact with the snap. It is returned by
+ * {@link installSnap}, and has methods to send requests to the snap.
+ *
+ * @example
+ * import { installSnap } from '@metamask/snaps-jest';
+ *
+ * const snap = await installSnap();
+ * const response = await snap.request({ method: 'hello' });
+ *
+ * expect(response).toRespondWith('Hello, world!');
+ */
+export type SnapHelpers = {
+    /**
+     * Send a JSON-RPC request to the snap.
+     *
+     * @param request - The request. This is similar to a JSON-RPC request, but
+     * has an extra `origin` field.
+     * @returns The response promise, with extra {@link SnapRequestObject} fields.
+     */
+    request(request: RequestOptions): SnapRequest;
+    /**
+     * Send a transaction to the snap.
+     *
+     * @param transaction - The transaction. This is similar to an Ethereum
+     * transaction object, but has an extra `origin` field. Any missing fields
+     * will be filled in with default values.
+     * @returns The response.
+     */
+    onTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponseWithInterface>;
+    /**
+     * Send a transaction to the snap.
+     *
+     * @param transaction - The transaction. This is similar to an Ethereum
+     * transaction object, but has an extra `origin` field. Any missing fields
+     * will be filled in with default values.
+     * @returns The response.
+     * @deprecated Use {@link onTransaction} instead.
+     */
+    sendTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponseWithInterface>;
+    /**
+     * Send a signature request to the snap.
+     *
+     * @param signature - The signature request object. Contains the params from
+     * the various signature methods, but has an extra `origin` and `signatureMethod` field.
+     * Any missing fields will be filled in with default values.
+     * @returns The response.
+     */
+    onSignature(signature?: Partial<SignatureOptions>): Promise<SnapResponseWithInterface>;
+    /**
+     * Run a cronjob in the snap. This is similar to {@link request}, but the
+     * request will be sent to the `onCronjob` method of the snap.
+     *
+     * @param cronjob - The cronjob request. This is similar to a JSON-RPC
+     * request, and is normally specified in the snap manifest, under the
+     * `endowment:cronjob` permission.
+     * @returns The response promise, with extra {@link SnapRequestObject} fields.
+     */
+    onCronjob(cronjob?: Partial<CronjobOptions>): SnapRequest;
+    /**
+     * Run a cronjob in the snap. This is similar to {@link request}, but the
+     * request will be sent to the `onCronjob` method of the snap.
+     *
+     * @param cronjob - The cronjob request. This is similar to a JSON-RPC
+     * request, and is normally specified in the snap manifest, under the
+     * `endowment:cronjob` permission.
+     * @returns The response promise, with extra {@link SnapRequestObject} fields.
+     * @deprecated Use {@link onCronjob} instead.
+     */
+    runCronjob(cronjob: CronjobOptions): SnapRequest;
+    /**
+     * Get the response from the snap's `onHomePage` method.
+     *
+     * @returns The response.
+     */
+    onHomePage(): Promise<SnapResponseWithInterface>;
+    /**
+     * Mock a JSON-RPC request. This will cause the snap to respond with the
+     * specified response when a request with the specified method is sent.
+     *
+     * @param mock - The mock options.
+     * @param mock.method - The JSON-RPC request method.
+     * @param mock.result - The JSON-RPC response, which will be returned when a
+     * request with the specified method is sent.
+     * @example
+     * import { installSnap } from '@metamask/snaps-jest';
+     *
+     * // In the test
+     * const snap = await installSnap();
+     * snap.mockJsonRpc({ method: 'eth_accounts', result: ['0x1234'] });
+     *
+     * // In the Snap
+     * const response =
+     *   await ethereum.request({ method: 'eth_accounts' }); // ['0x1234']
+     */
+    mockJsonRpc(mock: JsonRpcMockOptions): {
+        /**
+         * Remove the mock.
+         */
+        unmock(): void;
+    };
+    /**
+     * Close the page running the snap. This is mainly useful for cleaning up
+     * the test environment, and calling it is not strictly necessary.
+     *
+     * @returns A promise that resolves when the page is closed.
+     */
+    close(): Promise<void>;
+};
+/**
+ * Get the helper functions for the Snap.
+ *
+ * @param snap - The installed Snap.
+ * @param snap.snapId - The ID of the Snap.
+ * @param snap.store - The Redux store.
+ * @param snap.executionService - The execution service.
+ * @param snap.runSaga - The `runSaga` function.
+ * @param snap.controllerMessenger - The controller messenger.
+ * @param snap.options - The simulation options.
+ * @returns The Snap helpers.
+ */
+export declare function getHelpers({ snapId, store, executionService, runSaga, controllerMessenger, options, }: InstalledSnap & {
+    options: SimulationOptions;
+}): SnapHelpers;
+//# sourceMappingURL=helpers.d.cts.map

package/dist/helpers.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.cts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,sBAAkB;AAEnD,OAAO,KAAK,EAAE,aAAa,EAAE,yBAAqB;AAQlD,OAAO,KAAK,EACV,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,yBAAyB,EACzB,kBAAkB,EACnB,oBAAgB;AAIjB;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,WAAW,CAAC;IAE9C;;;;;;;OAOG;IACH,aAAa,CACX,WAAW,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACxC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;;OAQG;IACH,eAAe,CACb,WAAW,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACxC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,WAAW,CACT,SAAS,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GACpC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;IAE1D;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,WAAW,CAAC;IAEjD;;;;OAIG;IACH,UAAU,IAAI,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG;QACrC;;WAEG;QACH,MAAM,IAAI,IAAI,CAAC;KAChB,CAAC;IAEF;;;;;OAKG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,EACzB,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,OAAO,EACP,mBAAmB,EACnB,OAAO,GACR,EAAE,aAAa,GAAG;IAAE,OAAO,EAAE,iBAAiB,CAAA;CAAE,GAAG,WAAW,CA4I9D"}

package/dist/helpers.d.mts

@@ -0,0 +1,128 @@
+import type { SimulationOptions } from "./options.mjs";
+import type { InstalledSnap } from "./simulation.mjs";
+import type { CronjobOptions, JsonRpcMockOptions, RequestOptions, SignatureOptions, SnapRequest, SnapResponseWithInterface, TransactionOptions } from "./types.mjs";
+/**
+ * This is the main entry point to interact with the snap. It is returned by
+ * {@link installSnap}, and has methods to send requests to the snap.
+ *
+ * @example
+ * import { installSnap } from '@metamask/snaps-jest';
+ *
+ * const snap = await installSnap();
+ * const response = await snap.request({ method: 'hello' });
+ *
+ * expect(response).toRespondWith('Hello, world!');
+ */
+export type SnapHelpers = {
+    /**
+     * Send a JSON-RPC request to the snap.
+     *
+     * @param request - The request. This is similar to a JSON-RPC request, but
+     * has an extra `origin` field.
+     * @returns The response promise, with extra {@link SnapRequestObject} fields.
+     */
+    request(request: RequestOptions): SnapRequest;
+    /**
+     * Send a transaction to the snap.
+     *
+     * @param transaction - The transaction. This is similar to an Ethereum
+     * transaction object, but has an extra `origin` field. Any missing fields
+     * will be filled in with default values.
+     * @returns The response.
+     */
+    onTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponseWithInterface>;
+    /**
+     * Send a transaction to the snap.
+     *
+     * @param transaction - The transaction. This is similar to an Ethereum
+     * transaction object, but has an extra `origin` field. Any missing fields
+     * will be filled in with default values.
+     * @returns The response.
+     * @deprecated Use {@link onTransaction} instead.
+     */
+    sendTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponseWithInterface>;
+    /**
+     * Send a signature request to the snap.
+     *
+     * @param signature - The signature request object. Contains the params from
+     * the various signature methods, but has an extra `origin` and `signatureMethod` field.
+     * Any missing fields will be filled in with default values.
+     * @returns The response.
+     */
+    onSignature(signature?: Partial<SignatureOptions>): Promise<SnapResponseWithInterface>;
+    /**
+     * Run a cronjob in the snap. This is similar to {@link request}, but the
+     * request will be sent to the `onCronjob` method of the snap.
+     *
+     * @param cronjob - The cronjob request. This is similar to a JSON-RPC
+     * request, and is normally specified in the snap manifest, under the
+     * `endowment:cronjob` permission.
+     * @returns The response promise, with extra {@link SnapRequestObject} fields.
+     */
+    onCronjob(cronjob?: Partial<CronjobOptions>): SnapRequest;
+    /**
+     * Run a cronjob in the snap. This is similar to {@link request}, but the
+     * request will be sent to the `onCronjob` method of the snap.
+     *
+     * @param cronjob - The cronjob request. This is similar to a JSON-RPC
+     * request, and is normally specified in the snap manifest, under the
+     * `endowment:cronjob` permission.
+     * @returns The response promise, with extra {@link SnapRequestObject} fields.
+     * @deprecated Use {@link onCronjob} instead.
+     */
+    runCronjob(cronjob: CronjobOptions): SnapRequest;
+    /**
+     * Get the response from the snap's `onHomePage` method.
+     *
+     * @returns The response.
+     */
+    onHomePage(): Promise<SnapResponseWithInterface>;
+    /**
+     * Mock a JSON-RPC request. This will cause the snap to respond with the
+     * specified response when a request with the specified method is sent.
+     *
+     * @param mock - The mock options.
+     * @param mock.method - The JSON-RPC request method.
+     * @param mock.result - The JSON-RPC response, which will be returned when a
+     * request with the specified method is sent.
+     * @example
+     * import { installSnap } from '@metamask/snaps-jest';
+     *
+     * // In the test
+     * const snap = await installSnap();
+     * snap.mockJsonRpc({ method: 'eth_accounts', result: ['0x1234'] });
+     *
+     * // In the Snap
+     * const response =
+     *   await ethereum.request({ method: 'eth_accounts' }); // ['0x1234']
+     */
+    mockJsonRpc(mock: JsonRpcMockOptions): {
+        /**
+         * Remove the mock.
+         */
+        unmock(): void;
+    };
+    /**
+     * Close the page running the snap. This is mainly useful for cleaning up
+     * the test environment, and calling it is not strictly necessary.
+     *
+     * @returns A promise that resolves when the page is closed.
+     */
+    close(): Promise<void>;
+};
+/**
+ * Get the helper functions for the Snap.
+ *
+ * @param snap - The installed Snap.
+ * @param snap.snapId - The ID of the Snap.
+ * @param snap.store - The Redux store.
+ * @param snap.executionService - The execution service.
+ * @param snap.runSaga - The `runSaga` function.
+ * @param snap.controllerMessenger - The controller messenger.
+ * @param snap.options - The simulation options.
+ * @returns The Snap helpers.
+ */
+export declare function getHelpers({ snapId, store, executionService, runSaga, controllerMessenger, options, }: InstalledSnap & {
+    options: SimulationOptions;
+}): SnapHelpers;
+//# sourceMappingURL=helpers.d.mts.map

package/dist/helpers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.mts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,sBAAkB;AAEnD,OAAO,KAAK,EAAE,aAAa,EAAE,yBAAqB;AAQlD,OAAO,KAAK,EACV,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,yBAAyB,EACzB,kBAAkB,EACnB,oBAAgB;AAIjB;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,WAAW,CAAC;IAE9C;;;;;;;OAOG;IACH,aAAa,CACX,WAAW,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACxC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;;OAQG;IACH,eAAe,CACb,WAAW,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACxC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,WAAW,CACT,SAAS,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GACpC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;IAE1D;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,WAAW,CAAC;IAEjD;;;;OAIG;IACH,UAAU,IAAI,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG;QACrC;;WAEG;QACH,MAAM,IAAI,IAAI,CAAC;KAChB,CAAC;IAEF;;;;;OAKG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,EACzB,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,OAAO,EACP,mBAAmB,EACnB,OAAO,GACR,EAAE,aAAa,GAAG;IAAE,OAAO,EAAE,iBAAiB,CAAA;CAAE,GAAG,WAAW,CA4I9D"}

package/dist/helpers.mjs

@@ -0,0 +1,127 @@
+import { HandlerType } from "@metamask/snaps-utils";
+import { create } from "@metamask/superstruct";
+import { createModuleLogger } from "@metamask/utils";
+import { rootLogger } from "./logger.mjs";
+import { handleRequest } from "./request.mjs";
+import { addJsonRpcMock, removeJsonRpcMock } from "./store/index.mjs";
+import { assertIsResponseWithInterface, JsonRpcMockOptionsStruct, SignatureOptionsStruct, TransactionOptionsStruct } from "./structs.mjs";
+const log = createModuleLogger(rootLogger, 'helpers');
+/**
+ * Get the helper functions for the Snap.
+ *
+ * @param snap - The installed Snap.
+ * @param snap.snapId - The ID of the Snap.
+ * @param snap.store - The Redux store.
+ * @param snap.executionService - The execution service.
+ * @param snap.runSaga - The `runSaga` function.
+ * @param snap.controllerMessenger - The controller messenger.
+ * @param snap.options - The simulation options.
+ * @returns The Snap helpers.
+ */
+export function getHelpers({ snapId, store, executionService, runSaga, controllerMessenger, options, }) {
+    const onTransaction = async (request) => {
+        log('Sending transaction %o.', request);
+        const { origin: transactionOrigin, chainId, ...transaction } = create(request, TransactionOptionsStruct);
+        const response = await handleRequest({
+            snapId,
+            store,
+            executionService,
+            runSaga,
+            controllerMessenger,
+            handler: HandlerType.OnTransaction,
+            request: {
+                method: '',
+                params: {
+                    chainId,
+                    transaction,
+                    transactionOrigin,
+                },
+            },
+        });
+        assertIsResponseWithInterface(response);
+        return response;
+    };
+    const onCronjob = (request) => {
+        log('Running cronjob %o.', options);
+        return handleRequest({
+            snapId,
+            store,
+            executionService,
+            controllerMessenger,
+            runSaga,
+            handler: HandlerType.OnCronjob,
+            request,
+        });
+    };
+    return {
+        request: (request) => {
+            log('Sending request %o.', request);
+            return handleRequest({
+                snapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: HandlerType.OnRpcRequest,
+                request,
+            });
+        },
+        onTransaction,
+        sendTransaction: onTransaction,
+        onSignature: async (request) => {
+            log('Requesting signature %o.', request);
+            const { origin: signatureOrigin, ...signature } = create(request, SignatureOptionsStruct);
+            const response = await handleRequest({
+                snapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: HandlerType.OnSignature,
+                request: {
+                    method: '',
+                    params: {
+                        signature,
+                        signatureOrigin,
+                    },
+                },
+            });
+            assertIsResponseWithInterface(response);
+            return response;
+        },
+        onCronjob,
+        runCronjob: onCronjob,
+        onHomePage: async () => {
+            log('Rendering home page.');
+            const response = await handleRequest({
+                snapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: HandlerType.OnHomePage,
+                request: {
+                    method: '',
+                },
+            });
+            assertIsResponseWithInterface(response);
+            return response;
+        },
+        mockJsonRpc(mock) {
+            log('Mocking JSON-RPC request %o.', mock);
+            const { method, result } = create(mock, JsonRpcMockOptionsStruct);
+            store.dispatch(addJsonRpcMock({ method, result }));
+            return {
+                unmock() {
+                    log('Unmocking JSON-RPC request %o.', mock);
+                    store.dispatch(removeJsonRpcMock(method));
+                },
+            };
+        },
+        close: async () => {
+            log('Closing execution service.');
+            await executionService.terminateAllSnaps();
+        },
+    };
+}
+//# sourceMappingURL=helpers.mjs.map

package/dist/helpers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.mjs","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,8BAA8B;AACpD,OAAO,EAAE,MAAM,EAAE,8BAA8B;AAC/C,OAAO,EAAE,kBAAkB,EAAE,wBAAwB;AAErD,OAAO,EAAE,UAAU,EAAE,qBAAiB;AAEtC,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAE1C,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,0BAAgB;AAC5D,OAAO,EACL,6BAA6B,EAC7B,wBAAwB,EACxB,sBAAsB,EACtB,wBAAwB,EACzB,sBAAkB;AAWnB,MAAM,GAAG,GAAG,kBAAkB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AA8HtD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CAAC,EACzB,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,OAAO,EACP,mBAAmB,EACnB,OAAO,GACwC;IAC/C,MAAM,aAAa,GAAG,KAAK,EACzB,OAA2B,EACS,EAAE;QACtC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;QAExC,MAAM,EACJ,MAAM,EAAE,iBAAiB,EACzB,OAAO,EACP,GAAG,WAAW,EACf,GAAG,MAAM,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;QAE9C,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC;YACnC,MAAM;YACN,KAAK;YACL,gBAAgB;YAChB,OAAO;YACP,mBAAmB;YACnB,OAAO,EAAE,WAAW,CAAC,aAAa;YAClC,OAAO,EAAE;gBACP,MAAM,EAAE,EAAE;gBACV,MAAM,EAAE;oBACN,OAAO;oBACP,WAAW;oBACX,iBAAiB;iBAClB;aACF;SACF,CAAC,CAAC;QAEH,6BAA6B,CAAC,QAAQ,CAAC,CAAC;QAExC,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,OAAuB,EAAE,EAAE;QAC5C,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,aAAa,CAAC;YACnB,MAAM;YACN,KAAK;YACL,gBAAgB;YAChB,mBAAmB;YACnB,OAAO;YACP,OAAO,EAAE,WAAW,CAAC,SAAS;YAC9B,OAAO;SACR,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;YACnB,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;YAEpC,OAAO,aAAa,CAAC;gBACnB,MAAM;gBACN,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,WAAW,CAAC,YAAY;gBACjC,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,aAAa;QACb,eAAe,EAAE,aAAa;QAE9B,WAAW,EAAE,KAAK,EAChB,OAAgB,EACoB,EAAE;YACtC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;YAEzC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,SAAS,EAAE,GAAG,MAAM,CACtD,OAAO,EACP,sBAAsB,CACvB,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC;gBACnC,MAAM;gBACN,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,WAAW,CAAC,WAAW;gBAChC,OAAO,EAAE;oBACP,MAAM,EAAE,EAAE;oBACV,MAAM,EAAE;wBACN,SAAS;wBACT,eAAe;qBAChB;iBACF;aACF,CAAC,CAAC;YAEH,6BAA6B,CAAC,QAAQ,CAAC,CAAC;YAExC,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,SAAS;QACT,UAAU,EAAE,SAAS;QAErB,UAAU,EAAE,KAAK,IAAwC,EAAE;YACzD,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAE5B,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC;gBACnC,MAAM;gBACN,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,WAAW,CAAC,UAAU;gBAC/B,OAAO,EAAE;oBACP,MAAM,EAAE,EAAE;iBACX;aACF,CAAC,CAAC;YAEH,6BAA6B,CAAC,QAAQ,CAAC,CAAC;YAExC,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,WAAW,CAAC,IAAwB;YAClC,GAAG,CAAC,8BAA8B,EAAE,IAAI,CAAC,CAAC;YAE1C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;YAClE,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YAEnD,OAAO;gBACL,MAAM;oBACJ,GAAG,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC;oBAE5C,KAAK,CAAC,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC5C,CAAC;aACF,CAAC;QACJ,CAAC;QAED,KAAK,EAAE,KAAK,IAAI,EAAE;YAChB,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAClC,MAAM,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAC7C,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { HandlerType } from '@metamask/snaps-utils';\nimport { create } from '@metamask/superstruct';\nimport { createModuleLogger } from '@metamask/utils';\n\nimport { rootLogger } from './logger';\nimport type { SimulationOptions } from './options';\nimport { handleRequest } from './request';\nimport type { InstalledSnap } from './simulation';\nimport { addJsonRpcMock, removeJsonRpcMock } from './store';\nimport {\n  assertIsResponseWithInterface,\n  JsonRpcMockOptionsStruct,\n  SignatureOptionsStruct,\n  TransactionOptionsStruct,\n} from './structs';\nimport type {\n  CronjobOptions,\n  JsonRpcMockOptions,\n  RequestOptions,\n  SignatureOptions,\n  SnapRequest,\n  SnapResponseWithInterface,\n  TransactionOptions,\n} from './types';\n\nconst log = createModuleLogger(rootLogger, 'helpers');\n\n/**\n * This is the main entry point to interact with the snap. It is returned by\n * {@link installSnap}, and has methods to send requests to the snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * const snap = await installSnap();\n * const response = await snap.request({ method: 'hello' });\n *\n * expect(response).toRespondWith('Hello, world!');\n */\nexport type SnapHelpers = {\n  /**\n   * Send a JSON-RPC request to the snap.\n   *\n   * @param request - The request. This is similar to a JSON-RPC request, but\n   * has an extra `origin` field.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   */\n  request(request: RequestOptions): SnapRequest;\n\n  /**\n   * Send a transaction to the snap.\n   *\n   * @param transaction - The transaction. This is similar to an Ethereum\n   * transaction object, but has an extra `origin` field. Any missing fields\n   * will be filled in with default values.\n   * @returns The response.\n   */\n  onTransaction(\n    transaction?: Partial<TransactionOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Send a transaction to the snap.\n   *\n   * @param transaction - The transaction. This is similar to an Ethereum\n   * transaction object, but has an extra `origin` field. Any missing fields\n   * will be filled in with default values.\n   * @returns The response.\n   * @deprecated Use {@link onTransaction} instead.\n   */\n  sendTransaction(\n    transaction?: Partial<TransactionOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Send a signature request to the snap.\n   *\n   * @param signature - The signature request object. Contains the params from\n   * the various signature methods, but has an extra `origin` and `signatureMethod` field.\n   * Any missing fields will be filled in with default values.\n   * @returns The response.\n   */\n  onSignature(\n    signature?: Partial<SignatureOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Run a cronjob in the snap. This is similar to {@link request}, but the\n   * request will be sent to the `onCronjob` method of the snap.\n   *\n   * @param cronjob - The cronjob request. This is similar to a JSON-RPC\n   * request, and is normally specified in the snap manifest, under the\n   * `endowment:cronjob` permission.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   */\n  onCronjob(cronjob?: Partial<CronjobOptions>): SnapRequest;\n\n  /**\n   * Run a cronjob in the snap. This is similar to {@link request}, but the\n   * request will be sent to the `onCronjob` method of the snap.\n   *\n   * @param cronjob - The cronjob request. This is similar to a JSON-RPC\n   * request, and is normally specified in the snap manifest, under the\n   * `endowment:cronjob` permission.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   * @deprecated Use {@link onCronjob} instead.\n   */\n  runCronjob(cronjob: CronjobOptions): SnapRequest;\n\n  /**\n   * Get the response from the snap's `onHomePage` method.\n   *\n   * @returns The response.\n   */\n  onHomePage(): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Mock a JSON-RPC request. This will cause the snap to respond with the\n   * specified response when a request with the specified method is sent.\n   *\n   * @param mock - The mock options.\n   * @param mock.method - The JSON-RPC request method.\n   * @param mock.result - The JSON-RPC response, which will be returned when a\n   * request with the specified method is sent.\n   * @example\n   * import { installSnap } from '@metamask/snaps-jest';\n   *\n   * // In the test\n   * const snap = await installSnap();\n   * snap.mockJsonRpc({ method: 'eth_accounts', result: ['0x1234'] });\n   *\n   * // In the Snap\n   * const response =\n   *   await ethereum.request({ method: 'eth_accounts' }); // ['0x1234']\n   */\n  mockJsonRpc(mock: JsonRpcMockOptions): {\n    /**\n     * Remove the mock.\n     */\n    unmock(): void;\n  };\n\n  /**\n   * Close the page running the snap. This is mainly useful for cleaning up\n   * the test environment, and calling it is not strictly necessary.\n   *\n   * @returns A promise that resolves when the page is closed.\n   */\n  close(): Promise<void>;\n};\n\n/**\n * Get the helper functions for the Snap.\n *\n * @param snap - The installed Snap.\n * @param snap.snapId - The ID of the Snap.\n * @param snap.store - The Redux store.\n * @param snap.executionService - The execution service.\n * @param snap.runSaga - The `runSaga` function.\n * @param snap.controllerMessenger - The controller messenger.\n * @param snap.options - The simulation options.\n * @returns The Snap helpers.\n */\nexport function getHelpers({\n  snapId,\n  store,\n  executionService,\n  runSaga,\n  controllerMessenger,\n  options,\n}: InstalledSnap & { options: SimulationOptions }): SnapHelpers {\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,\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,\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,\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,\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,\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      await executionService.terminateAllSnaps();\n    },\n  };\n}\n"]}

package/dist/index.cjs

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./constants.cjs"), exports);
 __exportStar(require("./controllers.cjs"), exports);
+__exportStar(require("./helpers.cjs"), exports);
 __exportStar(require("./interface.cjs"), exports);
 __exportStar(require("./options.cjs"), exports);
 __exportStar(require("./request.cjs"), exports);

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAA4B;AAC5B,oDAA8B;AAC9B,kDAA4B;AAC5B,gDAA0B;AAC1B,gDAA0B;AAC1B,mDAA6B;AAC7B,oDAAwB;AACxB,gDAA0B;AAC1B,8CAAwB;AACxB,mDAA6B","sourcesContent":["export * from './constants';\nexport * from './controllers';\nexport * from './interface';\nexport * from './options';\nexport * from './request';\nexport * from './simulation';\nexport * from './store';\nexport * from './structs';\nexport * from './types';\nexport * from './validation';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAA4B;AAC5B,oDAA8B;AAC9B,gDAA0B;AAC1B,kDAA4B;AAC5B,gDAA0B;AAC1B,gDAA0B;AAC1B,mDAA6B;AAC7B,oDAAwB;AACxB,gDAA0B;AAC1B,8CAAwB;AACxB,mDAA6B","sourcesContent":["export * from './constants';\nexport * from './controllers';\nexport * from './helpers';\nexport * from './interface';\nexport * from './options';\nexport * from './request';\nexport * from './simulation';\nexport * from './store';\nexport * from './structs';\nexport * from './types';\nexport * from './validation';\n"]}

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 export * from "./constants.cjs";
 export * from "./controllers.cjs";
+export * from "./helpers.cjs";
 export * from "./interface.cjs";
 export * from "./options.cjs";
 export * from "./request.cjs";

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAA4B;AAC5B,kCAA8B;AAC9B,gCAA4B;AAC5B,8BAA0B;AAC1B,8BAA0B;AAC1B,iCAA6B;AAC7B,kCAAwB;AACxB,8BAA0B;AAC1B,4BAAwB;AACxB,iCAA6B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAA4B;AAC5B,kCAA8B;AAC9B,8BAA0B;AAC1B,gCAA4B;AAC5B,8BAA0B;AAC1B,8BAA0B;AAC1B,iCAA6B;AAC7B,kCAAwB;AACxB,8BAA0B;AAC1B,4BAAwB;AACxB,iCAA6B"}

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 export * from "./constants.mjs";
 export * from "./controllers.mjs";
+export * from "./helpers.mjs";
 export * from "./interface.mjs";
 export * from "./options.mjs";
 export * from "./request.mjs";

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAA4B;AAC5B,kCAA8B;AAC9B,gCAA4B;AAC5B,8BAA0B;AAC1B,8BAA0B;AAC1B,iCAA6B;AAC7B,kCAAwB;AACxB,8BAA0B;AAC1B,4BAAwB;AACxB,iCAA6B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAA4B;AAC5B,kCAA8B;AAC9B,8BAA0B;AAC1B,gCAA4B;AAC5B,8BAA0B;AAC1B,8BAA0B;AAC1B,iCAA6B;AAC7B,kCAAwB;AACxB,8BAA0B;AAC1B,4BAAwB;AACxB,iCAA6B"}

package/dist/index.mjs

@@ -1,5 +1,6 @@
 export * from "./constants.mjs";
 export * from "./controllers.mjs";
+export * from "./helpers.mjs";
 export * from "./interface.mjs";
 export * from "./options.mjs";
 export * from "./request.mjs";