@metamask/snaps-jest 4.0.1 → 5.0.0

package/dist/cjs/helpers.js

@@ -8,58 +8,133 @@ Object.defineProperty(exports, "installSnap", {
         return installSnap;
     }
 });
+const _snapsutils = require("@metamask/snaps-utils");
 const _utils = require("@metamask/utils");
-const _pptrtestinglibrary = require("pptr-testing-library");
+const _superstruct = require("superstruct");
 const _internals = require("./internals");
-// eslint-disable-next-line @typescript-eslint/unbound-method
-const { getByTestId } = _pptrtestinglibrary.queries;
+const _mocks = require("./internals/simulation/store/mocks");
 const log = (0, _utils.createModuleLogger)(_internals.rootLogger, 'helpers');
-async function installSnap(snapId = (0, _internals.getEnvironment)().snapId) {
-    const environment = (0, _internals.getEnvironment)();
-    log('Installing snap %s.', snapId);
-    const page = await environment.createPage();
-    const document = await (0, _pptrtestinglibrary.getDocument)(page);
-    log('Setting snap ID to %s.', snapId);
-    await page.evaluate((payload)=>{
-        window.__SIMULATOR_API__.dispatch({
-            type: 'configuration/setSnapId',
-            payload
+/**
+ * Get the options for {@link installSnap}.
+ *
+ * @param snapId - The ID of the Snap, or the options.
+ * @param options - The options, if any.
+ * @returns The options.
+ */ function getOptions(snapId, options) {
+    if (typeof snapId === 'object') {
+        return [
+            undefined,
+            snapId
+        ];
+    }
+    return [
+        snapId,
+        options
+    ];
+}
+async function installSnap(snapId, options = {}) {
+    const resolvedOptions = getOptions(snapId, options);
+    const { snapId: installedSnapId, store, executionService, runSaga, controllerMessenger } = await (0, _internals.getEnvironment)().installSnap(...resolvedOptions);
+    const onTransaction = async (request)=>{
+        log('Sending transaction %o.', request);
+        const { origin: transactionOrigin, chainId, ...transaction } = (0, _superstruct.create)(request, _internals.TransactionOptionsStruct);
+        return (0, _internals.handleRequest)({
+            snapId: installedSnapId,
+            store,
+            executionService,
+            runSaga,
+            controllerMessenger,
+            handler: _snapsutils.HandlerType.OnTransaction,
+            request: {
+                method: '',
+                params: {
+                    chainId,
+                    transaction,
+                    transactionOrigin
+                }
+            }
+        });
+    };
+    const onCronjob = (request)=>{
+        log('Running cronjob %o.', options);
+        return (0, _internals.handleRequest)({
+            snapId: installedSnapId,
+            store,
+            executionService,
+            controllerMessenger,
+            runSaga,
+            handler: _snapsutils.HandlerType.OnCronjob,
+            request
         });
-    }, snapId);
-    log('Waiting for snap to install.');
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    await (0, _internals.waitFor)(async ()=>await getByTestId(document, 'status-ok'), {
-        timeout: 10000,
-        message: `Timed out waiting for snap to install. Make sure the snap ID ("${snapId}") is correct, and the server is running.`
-    });
+    };
     return {
-        request: (options)=>{
-            log('Sending request %o.', options);
-            // Note: This function is intentionally not async, so that we can access
-            // the `getInterface` method on the response.
-            return (0, _internals.request)(page, options);
-        },
-        sendTransaction: async (options = {})=>{
-            log('Sending transaction %o.', options);
-            return await (0, _internals.sendTransaction)(page, options);
+        request: (request)=>{
+            log('Sending request %o.', request);
+            return (0, _internals.handleRequest)({
+                snapId: installedSnapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: _snapsutils.HandlerType.OnRpcRequest,
+                request
+            });
         },
-        runCronjob: (options)=>{
-            log('Running cronjob %o.', options);
-            // Note: This function is intentionally not async, so that we can access
-            // the `getInterface` method on the response.
-            return (0, _internals.runCronjob)(page, options);
+        onTransaction,
+        sendTransaction: onTransaction,
+        onSignature: async (request)=>{
+            log('Requesting signature %o.', request);
+            const { origin: signatureOrigin, ...signature } = (0, _superstruct.create)(request, _internals.SignatureOptionsStruct);
+            return (0, _internals.handleRequest)({
+                snapId: installedSnapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: _snapsutils.HandlerType.OnSignature,
+                request: {
+                    method: '',
+                    params: {
+                        signature,
+                        signatureOrigin
+                    }
+                }
+            });
         },
-        close: async ()=>{
-            log('Closing page.');
-            await page.close();
+        onCronjob,
+        runCronjob: onCronjob,
+        onHomePage: async ()=>{
+            log('Rendering home page.');
+            return (0, _internals.handleRequest)({
+                snapId: installedSnapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: _snapsutils.HandlerType.OnHomePage,
+                request: {
+                    method: ''
+                }
+            });
         },
-        mock: async (options)=>{
-            log('Mocking %o.', options);
-            return await (0, _internals.mock)(page, options);
+        mockJsonRpc (mock) {
+            log('Mocking JSON-RPC request %o.', mock);
+            const { method, result } = (0, _superstruct.create)(mock, _internals.JsonRpcMockOptionsStruct);
+            store.dispatch((0, _mocks.addJsonRpcMock)({
+                method,
+                result
+            }));
+            return {
+                unmock () {
+                    log('Unmocking JSON-RPC request %o.', mock);
+                    store.dispatch((0, _mocks.removeJsonRpcMock)(method));
+                }
+            };
         },
-        mockJsonRpc: async (options)=>{
-            log('Mocking JSON-RPC %o.', options);
-            return await (0, _internals.mockJsonRpc)(page, options);
+        close: async ()=>{
+            log('Closing execution service.');
+            (0, _snapsutils.logInfo)('Calling `snap.close()` is deprecated, and will be removed in a future release. Snaps are now automatically closed when the test ends.');
+            await executionService.terminateAllSnaps();
         }
     };
 }

package/dist/cjs/helpers.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/helpers.ts"],"sourcesContent":["import { createModuleLogger } from '@metamask/utils';\nimport { getDocument, queries } from 'pptr-testing-library';\n\nimport {\n  getEnvironment,\n  mock,\n  waitFor,\n  request,\n  sendTransaction,\n  runCronjob,\n  mockJsonRpc,\n  rootLogger,\n} from './internals';\nimport type { Snap, SnapResponse } from './types';\n\n// eslint-disable-next-line @typescript-eslint/unbound-method\nconst { getByTestId } = queries;\n\nconst log = createModuleLogger(rootLogger, 'helpers');\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 * ```ts\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 * ```\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 * @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  snapId: string = getEnvironment().snapId,\n): Promise<Snap> {\n  const environment = getEnvironment();\n\n  log('Installing snap %s.', snapId);\n\n  const page = await environment.createPage();\n  const document = await getDocument(page);\n\n  log('Setting snap ID to %s.', snapId);\n  await page.evaluate((payload) => {\n    window.__SIMULATOR_API__.dispatch({\n      type: 'configuration/setSnapId',\n      payload,\n    });\n  }, snapId);\n\n  log('Waiting for snap to install.');\n  // eslint-disable-next-line @typescript-eslint/no-misused-promises\n  await waitFor(async () => await getByTestId(document, 'status-ok'), {\n    timeout: 10000,\n    message: `Timed out waiting for snap to install. Make sure the snap ID (\"${snapId}\") is correct, and the server is running.`,\n  });\n\n  return {\n    request: (options) => {\n      log('Sending request %o.', options);\n\n      // Note: This function is intentionally not async, so that we can access\n      // the `getInterface` method on the response.\n      return request(page, options);\n    },\n\n    sendTransaction: async (options = {}): Promise<SnapResponse> => {\n      log('Sending transaction %o.', options);\n\n      return await sendTransaction(page, options);\n    },\n\n    runCronjob: (options) => {\n      log('Running cronjob %o.', options);\n\n      // Note: This function is intentionally not async, so that we can access\n      // the `getInterface` method on the response.\n      return runCronjob(page, options);\n    },\n\n    close: async () => {\n      log('Closing page.');\n\n      await page.close();\n    },\n\n    mock: async (options) => {\n      log('Mocking %o.', options);\n\n      return await mock(page, options);\n    },\n\n    mockJsonRpc: async (options) => {\n      log('Mocking JSON-RPC %o.', options);\n\n      return await mockJsonRpc(page, options);\n    },\n  };\n}\n"],"names":["installSnap","getByTestId","queries","log","createModuleLogger","rootLogger","snapId","getEnvironment","environment","page","createPage","document","getDocument","evaluate","payload","window","__SIMULATOR_API__","dispatch","type","waitFor","timeout","message","request","options","sendTransaction","runCronjob","close","mock","mockJsonRpc"],"mappings":";;;;+BA8CsBA;;;eAAAA;;;uBA9Ca;oCACE;2BAW9B;AAGP,6DAA6D;AAC7D,MAAM,EAAEC,WAAW,EAAE,GAAGC,2BAAO;AAE/B,MAAMC,MAAMC,IAAAA,yBAAkB,EAACC,qBAAU,EAAE;AA4BpC,eAAeL,YACpBM,SAAiBC,IAAAA,yBAAc,IAAGD,MAAM;IAExC,MAAME,cAAcD,IAAAA,yBAAc;IAElCJ,IAAI,uBAAuBG;IAE3B,MAAMG,OAAO,MAAMD,YAAYE,UAAU;IACzC,MAAMC,WAAW,MAAMC,IAAAA,+BAAW,EAACH;IAEnCN,IAAI,0BAA0BG;IAC9B,MAAMG,KAAKI,QAAQ,CAAC,CAACC;QACnBC,OAAOC,iBAAiB,CAACC,QAAQ,CAAC;YAChCC,MAAM;YACNJ;QACF;IACF,GAAGR;IAEHH,IAAI;IACJ,kEAAkE;IAClE,MAAMgB,IAAAA,kBAAO,EAAC,UAAY,MAAMlB,YAAYU,UAAU,cAAc;QAClES,SAAS;QACTC,SAAS,CAAC,+DAA+D,EAAEf,OAAO,yCAAyC,CAAC;IAC9H;IAEA,OAAO;QACLgB,SAAS,CAACC;YACRpB,IAAI,uBAAuBoB;YAE3B,wEAAwE;YACxE,6CAA6C;YAC7C,OAAOD,IAAAA,kBAAO,EAACb,MAAMc;QACvB;QAEAC,iBAAiB,OAAOD,UAAU,CAAC,CAAC;YAClCpB,IAAI,2BAA2BoB;YAE/B,OAAO,MAAMC,IAAAA,0BAAe,EAACf,MAAMc;QACrC;QAEAE,YAAY,CAACF;YACXpB,IAAI,uBAAuBoB;YAE3B,wEAAwE;YACxE,6CAA6C;YAC7C,OAAOE,IAAAA,qBAAU,EAAChB,MAAMc;QAC1B;QAEAG,OAAO;YACLvB,IAAI;YAEJ,MAAMM,KAAKiB,KAAK;QAClB;QAEAC,MAAM,OAAOJ;YACXpB,IAAI,eAAeoB;YAEnB,OAAO,MAAMI,IAAAA,eAAI,EAAClB,MAAMc;QAC1B;QAEAK,aAAa,OAAOL;YAClBpB,IAAI,wBAAwBoB;YAE5B,OAAO,MAAMK,IAAAA,sBAAW,EAACnB,MAAMc;QACjC;IACF;AACF"}
+{"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 { createModuleLogger } from '@metamask/utils';\nimport { create } from 'superstruct';\n\nimport {\n  rootLogger,\n  handleRequest,\n  TransactionOptionsStruct,\n  getEnvironment,\n  JsonRpcMockOptionsStruct,\n  SignatureOptionsStruct,\n} from './internals';\nimport type { InstallSnapOptions } from './internals';\nimport {\n  addJsonRpcMock,\n  removeJsonRpcMock,\n} from './internals/simulation/store/mocks';\nimport type {\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 * 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<SnapResponse> => {\n    log('Sending transaction %o.', request);\n\n    const {\n      origin: transactionOrigin,\n      chainId,\n      ...transaction\n    } = create(request, TransactionOptionsStruct);\n\n    return 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\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 (request: unknown): Promise<SnapResponse> => {\n      log('Requesting signature %o.', request);\n\n      const { origin: signatureOrigin, ...signature } = create(\n        request,\n        SignatureOptionsStruct,\n      );\n\n      return 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\n    onCronjob,\n    runCronjob: onCronjob,\n\n    onHomePage: async (): Promise<SnapResponse> => {\n      log('Rendering home page.');\n\n      return handleRequest({\n        snapId: installedSnapId,\n        store,\n        executionService,\n        controllerMessenger,\n        runSaga,\n        handler: HandlerType.OnHomePage,\n        request: {\n          method: '',\n        },\n      });\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"],"names":["installSnap","log","createModuleLogger","rootLogger","getOptions","snapId","options","undefined","resolvedOptions","installedSnapId","store","executionService","runSaga","controllerMessenger","getEnvironment","onTransaction","request","origin","transactionOrigin","chainId","transaction","create","TransactionOptionsStruct","handleRequest","handler","HandlerType","OnTransaction","method","params","onCronjob","OnCronjob","OnRpcRequest","sendTransaction","onSignature","signatureOrigin","signature","SignatureOptionsStruct","OnSignature","runCronjob","onHomePage","OnHomePage","mockJsonRpc","mock","result","JsonRpcMockOptionsStruct","dispatch","addJsonRpcMock","unmock","removeJsonRpcMock","close","logInfo","terminateAllSnaps"],"mappings":";;;;+BAsLsBA;;;eAAAA;;;4BApLe;uBACF;6BACZ;2BAShB;uBAKA;AASP,MAAMC,MAAMC,IAAAA,yBAAkB,EAACC,qBAAU,EAAE;AAE3C;;;;;;CAMC,GACD,SAASC,WAKPC,MAAiE,EACjEC,OAA6C;IAE7C,IAAI,OAAOD,WAAW,UAAU;QAC9B,OAAO;YAACE;YAAWF;SAAO;IAC5B;IAEA,OAAO;QAACA;QAAQC;KAAQ;AAC1B;AAqIO,eAAeN,YAKpBK,MAAsD,EACtDC,UAAgD,CAAC,CAAC;IAElD,MAAME,kBAAkBJ,WAAWC,QAAQC;IAC3C,MAAM,EACJD,QAAQI,eAAe,EACvBC,KAAK,EACLC,gBAAgB,EAChBC,OAAO,EACPC,mBAAmB,EACpB,GAAG,MAAMC,IAAAA,yBAAc,IAAGd,WAAW,IAAIQ;IAE1C,MAAMO,gBAAgB,OACpBC;QAEAf,IAAI,2BAA2Be;QAE/B,MAAM,EACJC,QAAQC,iBAAiB,EACzBC,OAAO,EACP,GAAGC,aACJ,GAAGC,IAAAA,mBAAM,EAACL,SAASM,mCAAwB;QAE5C,OAAOC,IAAAA,wBAAa,EAAC;YACnBlB,QAAQI;YACRC;YACAC;YACAC;YACAC;YACAW,SAASC,uBAAW,CAACC,aAAa;YAClCV,SAAS;gBACPW,QAAQ;gBACRC,QAAQ;oBACNT;oBACAC;oBACAF;gBACF;YACF;QACF;IACF;IAEA,MAAMW,YAAY,CAACb;QACjBf,IAAI,uBAAuBK;QAE3B,OAAOiB,IAAAA,wBAAa,EAAC;YACnBlB,QAAQI;YACRC;YACAC;YACAE;YACAD;YACAY,SAASC,uBAAW,CAACK,SAAS;YAC9Bd;QACF;IACF;IAEA,OAAO;QACLA,SAAS,CAACA;YACRf,IAAI,uBAAuBe;YAE3B,OAAOO,IAAAA,wBAAa,EAAC;gBACnBlB,QAAQI;gBACRC;gBACAC;gBACAE;gBACAD;gBACAY,SAASC,uBAAW,CAACM,YAAY;gBACjCf;YACF;QACF;QAEAD;QACAiB,iBAAiBjB;QAEjBkB,aAAa,OAAOjB;YAClBf,IAAI,4BAA4Be;YAEhC,MAAM,EAAEC,QAAQiB,eAAe,EAAE,GAAGC,WAAW,GAAGd,IAAAA,mBAAM,EACtDL,SACAoB,iCAAsB;YAGxB,OAAOb,IAAAA,wBAAa,EAAC;gBACnBlB,QAAQI;gBACRC;gBACAC;gBACAE;gBACAD;gBACAY,SAASC,uBAAW,CAACY,WAAW;gBAChCrB,SAAS;oBACPW,QAAQ;oBACRC,QAAQ;wBACNO;wBACAD;oBACF;gBACF;YACF;QACF;QAEAL;QACAS,YAAYT;QAEZU,YAAY;YACVtC,IAAI;YAEJ,OAAOsB,IAAAA,wBAAa,EAAC;gBACnBlB,QAAQI;gBACRC;gBACAC;gBACAE;gBACAD;gBACAY,SAASC,uBAAW,CAACe,UAAU;gBAC/BxB,SAAS;oBACPW,QAAQ;gBACV;YACF;QACF;QAEAc,aAAYC,IAAwB;YAClCzC,IAAI,gCAAgCyC;YAEpC,MAAM,EAAEf,MAAM,EAAEgB,MAAM,EAAE,GAAGtB,IAAAA,mBAAM,EAACqB,MAAME,mCAAwB;YAChElC,MAAMmC,QAAQ,CAACC,IAAAA,qBAAc,EAAC;gBAAEnB;gBAAQgB;YAAO;YAE/C,OAAO;gBACLI;oBACE9C,IAAI,kCAAkCyC;oBAEtChC,MAAMmC,QAAQ,CAACG,IAAAA,wBAAiB,EAACrB;gBACnC;YACF;QACF;QAEAsB,OAAO;YACLhD,IAAI;YACJiD,IAAAA,mBAAO,EACL;YAGF,MAAMvC,iBAAiBwC,iBAAiB;QAC1C;IACF;AACF"}

package/dist/cjs/internals/environment.js

@@ -12,7 +12,7 @@ const _utils = require("@metamask/utils");
 function getEnvironment() {
     // `snapsEnvironment` is a global variable that is set by the Jest
     // environment.
-    (0, _utils.assert)(snapsEnvironment, 'Snaps environment not found. Make sure you have configured the environment correctly.');
+    (0, _utils.assert)(typeof snapsEnvironment !== 'undefined', 'Snaps environment not found. Make sure you have configured the environment correctly.');
     return snapsEnvironment;
 }
 

package/dist/cjs/internals/environment.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/internals/environment.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\n\n/**\n * Get the Snaps environment. This asserts that the environment has been\n * configured.\n *\n * @returns The Snaps environment.\n */\nexport function getEnvironment() {\n  // `snapsEnvironment` is a global variable that is set by the Jest\n  // environment.\n  assert(\n    snapsEnvironment,\n    'Snaps environment not found. Make sure you have configured the environment correctly.',\n  );\n\n  return snapsEnvironment;\n}\n"],"names":["getEnvironment","assert","snapsEnvironment"],"mappings":";;;;+BAQgBA;;;eAAAA;;;uBARO;AAQhB,SAASA;IACd,kEAAkE;IAClE,eAAe;IACfC,IAAAA,aAAM,EACJC,kBACA;IAGF,OAAOA;AACT"}
+{"version":3,"sources":["../../../src/internals/environment.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\n\n/**\n * Get the Snaps environment. This asserts that the environment has been\n * configured.\n *\n * @returns The Snaps environment.\n */\nexport function getEnvironment() {\n  // `snapsEnvironment` is a global variable that is set by the Jest\n  // environment.\n  assert(\n    typeof snapsEnvironment !== 'undefined',\n    'Snaps environment not found. Make sure you have configured the environment correctly.',\n  );\n\n  return snapsEnvironment;\n}\n"],"names":["getEnvironment","assert","snapsEnvironment"],"mappings":";;;;+BAQgBA;;;eAAAA;;;uBARO;AAQhB,SAASA;IACd,kEAAkE;IAClE,eAAe;IACfC,IAAAA,aAAM,EACJ,OAAOC,qBAAqB,aAC5B;IAGF,OAAOA;AACT"}

package/dist/cjs/internals/index.js

@@ -3,14 +3,11 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 _export_star(require("./environment"), exports);
-_export_star(require("./interface"), exports);
 _export_star(require("./logger"), exports);
-_export_star(require("./network"), exports);
 _export_star(require("./request"), exports);
 _export_star(require("./server"), exports);
+_export_star(require("./simulation"), exports);
 _export_star(require("./structs"), exports);
-_export_star(require("./types"), exports);
-_export_star(require("./wait-for"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/dist/cjs/internals/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/internals/index.ts"],"sourcesContent":["export * from './environment';\nexport * from './interface';\nexport * from './logger';\nexport * from './network';\nexport * from './request';\nexport * from './server';\nexport * from './structs';\n// eslint-disable-next-line import/export\nexport * from './types';\nexport * from './wait-for';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBAEA;qBACA"}
+{"version":3,"sources":["../../../src/internals/index.ts"],"sourcesContent":["export * from './environment';\nexport * from './logger';\nexport * from './request';\nexport * from './server';\nexport * from './simulation';\nexport * from './structs';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA"}

package/dist/cjs/internals/request.js

@@ -9,113 +9,61 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    request: function() {
-        return request;
+    handleRequest: function() {
+        return handleRequest;
     },
-    sendTransaction: function() {
-        return sendTransaction;
-    },
-    runCronjob: function() {
-        return runCronjob;
+    getContentFromResult: function() {
+        return getContentFromResult;
     }
 });
 const _snapsutils = require("@metamask/snaps-utils");
 const _utils = require("@metamask/utils");
-const _pptrtestinglibrary = require("pptr-testing-library");
-const _superstruct = require("superstruct");
-const _interface = require("./interface");
-const _logger = require("./logger");
-const _structs = require("./structs");
-const _waitfor = require("./wait-for");
-const log = (0, _utils.createModuleLogger)(_logger.rootLogger, 'request');
-/**
- * Send a request to the snap.
- *
- * @param page - The page to send the request from.
- * @param args - The request arguments.
- * @returns The request ID.
- */ async function sendRequest(page, args) {
-    const document = await (0, _pptrtestinglibrary.getDocument)(page);
-    const button = await _pptrtestinglibrary.queries.getByTestId(document, `navigation-${args.handler}`);
-    // Navigate to the request handler page.
-    await button.click();
-    return await page.evaluate((payload)=>{
-        window.__SIMULATOR_API__.dispatch({
-            type: 'simulation/sendRequest',
-            payload
-        });
-        return window.__SIMULATOR_API__.getRequestId();
-    }, args);
-}
-function request(page, { origin = 'metamask.io', ...options }, handler = _snapsutils.HandlerType.OnRpcRequest) {
-    const doRequest = async ()=>{
-        const args = {
-            origin,
-            handler,
-            request: {
-                jsonrpc: '2.0',
-                id: 1,
-                ...options
-            }
-        };
-        log('Sending request %o', args);
-        const promise = (0, _waitfor.waitForResponse)(page, handler);
-        const id = await sendRequest(page, args);
-        const response = await promise;
-        log('Received response %o', response);
-        const notifications = await (0, _interface.getNotifications)(page, id);
-        return {
-            id,
-            response,
-            notifications
-        };
-    };
-    // This is a bit hacky, but it allows us to add the `getInterface` method
-    // to the response promise.
-    const response = doRequest();
-    response.getInterface = async (getInterfaceOptions)=>{
-        return await (0, _interface.getInterface)(page, getInterfaceOptions);
-    };
-    return response;
-}
-async function sendTransaction(page, options) {
-    const { origin: transactionOrigin, chainId, ...transaction } = (0, _superstruct.create)(options, _structs.TransactionOptionsStruct);
-    const args = {
-        origin: '',
-        handler: _snapsutils.HandlerType.OnTransaction,
+const _toolkit = require("@reduxjs/toolkit");
+const _simulation = require("./simulation");
+function handleRequest({ snapId, store, executionService, handler, controllerMessenger, runSaga, request: { id = (0, _toolkit.nanoid)(), origin = 'https://metamask.io', ...options } }) {
+    const promise = executionService.handleRpcRequest(snapId, {
+        origin,
+        handler,
         request: {
             jsonrpc: '2.0',
-            method: '',
-            params: {
-                chainId,
-                transaction,
-                transactionOrigin
-            }
+            id: 1,
+            ...options
         }
-    };
-    log('Sending transaction %o', args);
-    const promise = (0, _waitfor.waitForResponse)(page, _snapsutils.HandlerType.OnTransaction);
-    const id = await sendRequest(page, args);
-    const response = await promise;
-    log('Received response %o', response);
-    if ((0, _utils.hasProperty)(response, 'error')) {
+    }).then((result)=>{
+        const notifications = (0, _simulation.getNotifications)(store.getState());
+        store.dispatch((0, _simulation.clearNotifications)());
+        const content = getContentFromResult(result, snapId, controllerMessenger);
+        return {
+            id: String(id),
+            response: {
+                result: (0, _utils.getSafeJson)(result)
+            },
+            notifications,
+            content
+        };
+    }).catch((error)=>{
+        const [unwrappedError] = (0, _snapsutils.unwrapError)(error);
         return {
-            id,
-            response,
+            id: String(id),
+            response: {
+                error: unwrappedError.serialize()
+            },
             notifications: []
         };
-    }
-    (0, _utils.assert)((0, _utils.isPlainObject)(response.result));
-    (0, _utils.assert)((0, _utils.hasProperty)(response.result, 'content'));
-    return {
-        id,
-        response,
-        notifications: [],
-        content: response.result.content
+    });
+    promise.getInterface = async ()=>{
+        return await runSaga(_simulation.getInterface, runSaga, snapId, controllerMessenger).toPromise();
     };
+    return promise;
 }
-function runCronjob(page, options) {
-    return request(page, options, _snapsutils.HandlerType.OnCronjob);
+function getContentFromResult(result, snapId, controllerMessenger) {
+    if ((0, _utils.isPlainObject)(result) && (0, _utils.hasProperty)(result, 'id')) {
+        return controllerMessenger.call('SnapInterfaceController:getInterface', snapId, result.id).content;
+    }
+    if ((0, _utils.isPlainObject)(result) && (0, _utils.hasProperty)(result, 'content')) {
+        return result.content;
+    }
+    return undefined;
 }
 
 //# sourceMappingURL=request.js.map

package/dist/cjs/internals/request.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/internals/request.ts"],"sourcesContent":["import type { Component } from '@metamask/snaps-sdk';\nimport type { SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport {\n  assert,\n  createModuleLogger,\n  hasProperty,\n  isPlainObject,\n} from '@metamask/utils';\nimport { getDocument, queries } from 'pptr-testing-library';\nimport type { Page } from 'puppeteer';\nimport { create } from 'superstruct';\n\nimport type {\n  CronjobOptions,\n  RequestOptions,\n  SnapRequest,\n  SnapResponse,\n  TransactionOptions,\n} from '../types';\nimport { getInterface, getNotifications } from './interface';\nimport { rootLogger } from './logger';\nimport { TransactionOptionsStruct } from './structs';\nimport { waitForResponse } from './wait-for';\n\nconst log = createModuleLogger(rootLogger, 'request');\n\n/**\n * Send a request to the snap.\n *\n * @param page - The page to send the request from.\n * @param args - The request arguments.\n * @returns The request ID.\n */\nasync function sendRequest(page: Page, args: SnapRpcHookArgs) {\n  const document = await getDocument(page);\n  const button = await queries.getByTestId(\n    document,\n    `navigation-${args.handler}`,\n  );\n\n  // Navigate to the request handler page.\n  await button.click();\n\n  return await page.evaluate((payload) => {\n    window.__SIMULATOR_API__.dispatch({\n      type: 'simulation/sendRequest',\n      payload,\n    });\n\n    return window.__SIMULATOR_API__.getRequestId();\n  }, args);\n}\n\n/**\n * Send a request to the snap.\n *\n * @param page - The page to send the request from.\n * @param options - The request options.\n * @param options.origin - The origin of the request. Defaults to `metamask.io`.\n * @param handler - The handler to use. Defaults to `onRpcRequest`.\n * @returns The response.\n */\nexport function request(\n  page: Page,\n  { origin = 'metamask.io', ...options }: RequestOptions,\n  handler:\n    | HandlerType.OnRpcRequest\n    | HandlerType.OnCronjob = HandlerType.OnRpcRequest,\n) {\n  const doRequest = async (): Promise<SnapResponse> => {\n    const args: SnapRpcHookArgs = {\n      origin,\n      handler,\n      request: {\n        jsonrpc: '2.0',\n        id: 1,\n        ...options,\n      },\n    };\n\n    log('Sending request %o', args);\n\n    const promise = waitForResponse(page, handler);\n    const id = await sendRequest(page, args);\n    const response = await promise;\n\n    log('Received response %o', response);\n\n    const notifications = await getNotifications(page, id);\n\n    return { id, response, notifications };\n  };\n\n  // This is a bit hacky, but it allows us to add the `getInterface` method\n  // to the response promise.\n  const response = doRequest() as SnapRequest;\n\n  response.getInterface = async (getInterfaceOptions) => {\n    return await getInterface(page, getInterfaceOptions);\n  };\n\n  return response;\n}\n\n/**\n * Send a transaction to the snap.\n *\n * @param page - The page to send the transaction from.\n * @param options - The transaction options.\n * @returns The response.\n */\nexport async function sendTransaction(\n  page: Page,\n  options: Partial<TransactionOptions>,\n) {\n  const {\n    origin: transactionOrigin,\n    chainId,\n    ...transaction\n  } = create(options, TransactionOptionsStruct);\n\n  const args: SnapRpcHookArgs = {\n    origin: '',\n    handler: HandlerType.OnTransaction,\n    request: {\n      jsonrpc: '2.0',\n      method: '',\n      params: {\n        chainId,\n        transaction,\n        transactionOrigin,\n      },\n    },\n  };\n\n  log('Sending transaction %o', args);\n\n  const promise = waitForResponse(page, HandlerType.OnTransaction);\n  const id = await sendRequest(page, args);\n  const response = await promise;\n\n  log('Received response %o', response);\n\n  if (hasProperty(response, 'error')) {\n    return { id, response, notifications: [] };\n  }\n\n  assert(isPlainObject(response.result));\n  assert(hasProperty(response.result, 'content'));\n\n  return {\n    id,\n    response,\n    notifications: [],\n    content: response.result.content as Component,\n  };\n}\n\n/**\n * Run a cronjob.\n *\n * @param page - The page to run the cronjob from.\n * @param options - The request options.\n * @returns The response.\n */\nexport function runCronjob(page: Page, options: CronjobOptions) {\n  return request(page, options, HandlerType.OnCronjob);\n}\n"],"names":["request","sendTransaction","runCronjob","log","createModuleLogger","rootLogger","sendRequest","page","args","document","getDocument","button","queries","getByTestId","handler","click","evaluate","payload","window","__SIMULATOR_API__","dispatch","type","getRequestId","origin","options","HandlerType","OnRpcRequest","doRequest","jsonrpc","id","promise","waitForResponse","response","notifications","getNotifications","getInterface","getInterfaceOptions","transactionOrigin","chainId","transaction","create","TransactionOptionsStruct","OnTransaction","method","params","hasProperty","assert","isPlainObject","result","content","OnCronjob"],"mappings":";;;;;;;;;;;IA+DgBA,OAAO;eAAPA;;IAiDMC,eAAe;eAAfA;;IAsDNC,UAAU;eAAVA;;;4BApKY;uBAMrB;oCAC8B;6BAEd;2BASwB;wBACpB;yBACc;yBACT;AAEhC,MAAMC,MAAMC,IAAAA,yBAAkB,EAACC,kBAAU,EAAE;AAE3C;;;;;;CAMC,GACD,eAAeC,YAAYC,IAAU,EAAEC,IAAqB;IAC1D,MAAMC,WAAW,MAAMC,IAAAA,+BAAW,EAACH;IACnC,MAAMI,SAAS,MAAMC,2BAAO,CAACC,WAAW,CACtCJ,UACA,CAAC,WAAW,EAAED,KAAKM,OAAO,CAAC,CAAC;IAG9B,wCAAwC;IACxC,MAAMH,OAAOI,KAAK;IAElB,OAAO,MAAMR,KAAKS,QAAQ,CAAC,CAACC;QAC1BC,OAAOC,iBAAiB,CAACC,QAAQ,CAAC;YAChCC,MAAM;YACNJ;QACF;QAEA,OAAOC,OAAOC,iBAAiB,CAACG,YAAY;IAC9C,GAAGd;AACL;AAWO,SAASR,QACdO,IAAU,EACV,EAAEgB,SAAS,aAAa,EAAE,GAAGC,SAAyB,EACtDV,UAE4BW,uBAAW,CAACC,YAAY;IAEpD,MAAMC,YAAY;QAChB,MAAMnB,OAAwB;YAC5Be;YACAT;YACAd,SAAS;gBACP4B,SAAS;gBACTC,IAAI;gBACJ,GAAGL,OAAO;YACZ;QACF;QAEArB,IAAI,sBAAsBK;QAE1B,MAAMsB,UAAUC,IAAAA,wBAAe,EAACxB,MAAMO;QACtC,MAAMe,KAAK,MAAMvB,YAAYC,MAAMC;QACnC,MAAMwB,WAAW,MAAMF;QAEvB3B,IAAI,wBAAwB6B;QAE5B,MAAMC,gBAAgB,MAAMC,IAAAA,2BAAgB,EAAC3B,MAAMsB;QAEnD,OAAO;YAAEA;YAAIG;YAAUC;QAAc;IACvC;IAEA,yEAAyE;IACzE,2BAA2B;IAC3B,MAAMD,WAAWL;IAEjBK,SAASG,YAAY,GAAG,OAAOC;QAC7B,OAAO,MAAMD,IAAAA,uBAAY,EAAC5B,MAAM6B;IAClC;IAEA,OAAOJ;AACT;AASO,eAAe/B,gBACpBM,IAAU,EACViB,OAAoC;IAEpC,MAAM,EACJD,QAAQc,iBAAiB,EACzBC,OAAO,EACP,GAAGC,aACJ,GAAGC,IAAAA,mBAAM,EAAChB,SAASiB,iCAAwB;IAE5C,MAAMjC,OAAwB;QAC5Be,QAAQ;QACRT,SAASW,uBAAW,CAACiB,aAAa;QAClC1C,SAAS;YACP4B,SAAS;YACTe,QAAQ;YACRC,QAAQ;gBACNN;gBACAC;gBACAF;YACF;QACF;IACF;IAEAlC,IAAI,0BAA0BK;IAE9B,MAAMsB,UAAUC,IAAAA,wBAAe,EAACxB,MAAMkB,uBAAW,CAACiB,aAAa;IAC/D,MAAMb,KAAK,MAAMvB,YAAYC,MAAMC;IACnC,MAAMwB,WAAW,MAAMF;IAEvB3B,IAAI,wBAAwB6B;IAE5B,IAAIa,IAAAA,kBAAW,EAACb,UAAU,UAAU;QAClC,OAAO;YAAEH;YAAIG;YAAUC,eAAe,EAAE;QAAC;IAC3C;IAEAa,IAAAA,aAAM,EAACC,IAAAA,oBAAa,EAACf,SAASgB,MAAM;IACpCF,IAAAA,aAAM,EAACD,IAAAA,kBAAW,EAACb,SAASgB,MAAM,EAAE;IAEpC,OAAO;QACLnB;QACAG;QACAC,eAAe,EAAE;QACjBgB,SAASjB,SAASgB,MAAM,CAACC,OAAO;IAClC;AACF;AASO,SAAS/C,WAAWK,IAAU,EAAEiB,OAAuB;IAC5D,OAAOxB,QAAQO,MAAMiB,SAASC,uBAAW,CAACyB,SAAS;AACrD"}
+{"version":3,"sources":["../../../src/internals/request.ts"],"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"],"names":["handleRequest","getContentFromResult","snapId","store","executionService","handler","controllerMessenger","runSaga","request","id","nanoid","origin","options","promise","handleRpcRequest","jsonrpc","then","result","notifications","getNotifications","getState","dispatch","clearNotifications","content","String","response","getSafeJson","catch","error","unwrappedError","unwrapError","serialize","getInterface","toPromise","isPlainObject","hasProperty","call","undefined"],"mappings":";;;;;;;;;;;IA8CgBA,aAAa;eAAbA;;IAkEAC,oBAAoB;eAApBA;;;4BA7GY;uBAC4B;yBACjC;4BAOhB;AAkCA,SAASD,cAAc,EAC5BE,MAAM,EACNC,KAAK,EACLC,gBAAgB,EAChBC,OAAO,EACPC,mBAAmB,EACnBC,OAAO,EACPC,SAAS,EAAEC,KAAKC,IAAAA,eAAM,GAAE,EAAEC,SAAS,qBAAqB,EAAE,GAAGC,SAAS,EACjD;IACrB,MAAMC,UAAUT,iBACbU,gBAAgB,CAACZ,QAAQ;QACxBS;QACAN;QACAG,SAAS;YACPO,SAAS;YACTN,IAAI;YACJ,GAAGG,OAAO;QACZ;IACF,GACCI,IAAI,CAAC,CAACC;QACL,MAAMC,gBAAgBC,IAAAA,4BAAgB,EAAChB,MAAMiB,QAAQ;QACrDjB,MAAMkB,QAAQ,CAACC,IAAAA,8BAAkB;QAEjC,MAAMC,UAAUtB,qBAAqBgB,QAAQf,QAAQI;QAErD,OAAO;YACLG,IAAIe,OAAOf;YACXgB,UAAU;gBACRR,QAAQS,IAAAA,kBAAW,EAACT;YACtB;YACAC;YACAK;QACF;IACF,GACCI,KAAK,CAAC,CAACC;QACN,MAAM,CAACC,eAAe,GAAGC,IAAAA,uBAAW,EAACF;QAErC,OAAO;YACLnB,IAAIe,OAAOf;YACXgB,UAAU;gBACRG,OAAOC,eAAeE,SAAS;YACjC;YACAb,eAAe,EAAE;QACnB;IACF;IAEFL,QAAQmB,YAAY,GAAG;QACrB,OAAO,MAAMzB,QACXyB,wBAAY,EACZzB,SACAL,QACAI,qBACA2B,SAAS;IACb;IAEA,OAAOpB;AACT;AAUO,SAASZ,qBACdgB,MAAe,EACff,MAAc,EACdI,mBAA4C;IAE5C,IAAI4B,IAAAA,oBAAa,EAACjB,WAAWkB,IAAAA,kBAAW,EAAClB,QAAQ,OAAO;QACtD,OAAOX,oBAAoB8B,IAAI,CAC7B,wCACAlC,QACAe,OAAOR,EAAE,EACTc,OAAO;IACX;IAEA,IAAIW,IAAAA,oBAAa,EAACjB,WAAWkB,IAAAA,kBAAW,EAAClB,QAAQ,YAAY;QAC3D,OAAOA,OAAOM,OAAO;IACvB;IAEA,OAAOc;AACT"}

package/dist/cjs/internals/server.js

@@ -20,8 +20,6 @@ function _interop_require_default(obj) {
         default: obj
     };
 }
-const SNAPS_EXECUTION_ENVIRONMENTS_PATH = (0, _path.resolve)((0, _path.dirname)(require.resolve('@metamask/snaps-execution-environments/package.json')), 'dist', 'browserify', 'iframe');
-const SNAPS_SIMULATOR_PATH = (0, _path.resolve)((0, _path.dirname)(require.resolve('@metamask/snaps-simulator/package.json')), 'dist', 'webpack', 'test');
 /**
  * Check that:
  *
@@ -57,8 +55,6 @@ async function startServer(options) {
         response.header('Access-Control-Allow-Headers', 'Content-Type');
         next();
     });
-    app.use('/environment', _express.default.static(SNAPS_EXECUTION_ENVIRONMENTS_PATH));
-    app.use('/simulator', _express.default.static(SNAPS_SIMULATOR_PATH));
     app.use(_express.default.static((0, _path.resolve)(process.cwd(), options.root)));
     const server = (0, _http.createServer)(app);
     return await new Promise((resolve, reject)=>{

package/dist/cjs/internals/server.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/internals/server.ts"],"sourcesContent":["import type { SnapManifest } from '@metamask/snaps-utils';\nimport {\n  assertIsSnapManifest,\n  isDirectory,\n  isFile,\n} from '@metamask/snaps-utils';\nimport { createModuleLogger } from '@metamask/utils';\nimport express from 'express';\nimport { promises as fs } from 'fs';\nimport type { Server } from 'http';\nimport { createServer } from 'http';\nimport { resolve as pathResolve, dirname } from 'path';\n\nimport type { SnapsEnvironmentOptions } from '../options';\nimport { rootLogger } from './logger';\n\nconst SNAPS_EXECUTION_ENVIRONMENTS_PATH = pathResolve(\n  dirname(\n    require.resolve('@metamask/snaps-execution-environments/package.json'),\n  ),\n  'dist',\n  'browserify',\n  'iframe',\n);\n\nconst SNAPS_SIMULATOR_PATH = pathResolve(\n  dirname(require.resolve('@metamask/snaps-simulator/package.json')),\n  'dist',\n  'webpack',\n  'test',\n);\n\nexport type ServerOptions = Required<\n  // We need a double `Required` for the type to be inferred correctly.\n  Required<SnapsEnvironmentOptions>['server']\n>;\n\n/**\n * Check that:\n *\n * - The root directory exists.\n * - The root directory contains a `snap.manifest.json` file.\n * - The file path in the manifest exists.\n *\n * @param root - The root directory.\n * @throws If any of the checks fail.\n */\nasync function assertRoot(root: string) {\n  if (!root) {\n    throw new Error('You must specify a root directory.');\n  }\n\n  if (!(await isDirectory(root, false))) {\n    throw new Error(`Root directory \"${root}\" is not a directory.`);\n  }\n\n  const manifestPath = pathResolve(root, 'snap.manifest.json');\n  const manifest: SnapManifest = await fs\n    .readFile(manifestPath, 'utf8')\n    .then(JSON.parse);\n\n  assertIsSnapManifest(manifest);\n  const filePath = pathResolve(root, manifest.source.location.npm.filePath);\n\n  if (!(await isFile(filePath))) {\n    throw new Error(\n      `File \"${filePath}\" does not exist, or is not a file. Did you forget to build your snap?`,\n    );\n  }\n}\n\n/**\n * Start an HTTP server on `localhost` with a random port. This is used to serve\n * the static files for the environment.\n *\n * @param options - The options to use.\n * @param options.port - The port to use for the server.\n * @param options.root - The root directory to serve from the server.\n * @returns The HTTP server.\n */\nexport async function startServer(options: ServerOptions) {\n  await assertRoot(options.root);\n\n  const log = createModuleLogger(rootLogger, 'server');\n  const app = express();\n\n  app.use((_request, response, next) => {\n    response.header('Access-Control-Allow-Origin', '*');\n    response.header('Access-Control-Allow-Credentials', 'true');\n    response.header('Access-Control-Allow-Methods', 'GET, OPTIONS');\n    response.header('Access-Control-Allow-Headers', 'Content-Type');\n\n    next();\n  });\n\n  app.use('/environment', express.static(SNAPS_EXECUTION_ENVIRONMENTS_PATH));\n  app.use('/simulator', express.static(SNAPS_SIMULATOR_PATH));\n  app.use(express.static(pathResolve(process.cwd(), options.root)));\n\n  const server = createServer(app);\n  return await new Promise<Server>((resolve, reject) => {\n    server.listen(options.port, () => {\n      resolve(server);\n    });\n\n    server.on('error', (error) => {\n      log(error);\n      reject(error);\n    });\n  });\n}\n"],"names":["startServer","SNAPS_EXECUTION_ENVIRONMENTS_PATH","pathResolve","dirname","require","resolve","SNAPS_SIMULATOR_PATH","assertRoot","root","Error","isDirectory","manifestPath","manifest","fs","readFile","then","JSON","parse","assertIsSnapManifest","filePath","source","location","npm","isFile","options","log","createModuleLogger","rootLogger","app","express","use","_request","response","next","header","static","process","cwd","server","createServer","Promise","reject","listen","port","on","error"],"mappings":";;;;+BAgFsBA;;;eAAAA;;;4BA3Ef;uBAC4B;gEACf;oBACW;sBAEF;sBACmB;wBAGrB;;;;;;AAE3B,MAAMC,oCAAoCC,IAAAA,aAAW,EACnDC,IAAAA,aAAO,EACLC,QAAQC,OAAO,CAAC,yDAElB,QACA,cACA;AAGF,MAAMC,uBAAuBJ,IAAAA,aAAW,EACtCC,IAAAA,aAAO,EAACC,QAAQC,OAAO,CAAC,4CACxB,QACA,WACA;AAQF;;;;;;;;;CASC,GACD,eAAeE,WAAWC,IAAY;IACpC,IAAI,CAACA,MAAM;QACT,MAAM,IAAIC,MAAM;IAClB;IAEA,IAAI,CAAE,MAAMC,IAAAA,uBAAW,EAACF,MAAM,QAAS;QACrC,MAAM,IAAIC,MAAM,CAAC,gBAAgB,EAAED,KAAK,qBAAqB,CAAC;IAChE;IAEA,MAAMG,eAAeT,IAAAA,aAAW,EAACM,MAAM;IACvC,MAAMI,WAAyB,MAAMC,YAAE,CACpCC,QAAQ,CAACH,cAAc,QACvBI,IAAI,CAACC,KAAKC,KAAK;IAElBC,IAAAA,gCAAoB,EAACN;IACrB,MAAMO,WAAWjB,IAAAA,aAAW,EAACM,MAAMI,SAASQ,MAAM,CAACC,QAAQ,CAACC,GAAG,CAACH,QAAQ;IAExE,IAAI,CAAE,MAAMI,IAAAA,kBAAM,EAACJ,WAAY;QAC7B,MAAM,IAAIV,MACR,CAAC,MAAM,EAAEU,SAAS,sEAAsE,CAAC;IAE7F;AACF;AAWO,eAAenB,YAAYwB,OAAsB;IACtD,MAAMjB,WAAWiB,QAAQhB,IAAI;IAE7B,MAAMiB,MAAMC,IAAAA,yBAAkB,EAACC,kBAAU,EAAE;IAC3C,MAAMC,MAAMC,IAAAA,gBAAO;IAEnBD,IAAIE,GAAG,CAAC,CAACC,UAAUC,UAAUC;QAC3BD,SAASE,MAAM,CAAC,+BAA+B;QAC/CF,SAASE,MAAM,CAAC,oCAAoC;QACpDF,SAASE,MAAM,CAAC,gCAAgC;QAChDF,SAASE,MAAM,CAAC,gCAAgC;QAEhDD;IACF;IAEAL,IAAIE,GAAG,CAAC,gBAAgBD,gBAAO,CAACM,MAAM,CAAClC;IACvC2B,IAAIE,GAAG,CAAC,cAAcD,gBAAO,CAACM,MAAM,CAAC7B;IACrCsB,IAAIE,GAAG,CAACD,gBAAO,CAACM,MAAM,CAACjC,IAAAA,aAAW,EAACkC,QAAQC,GAAG,IAAIb,QAAQhB,IAAI;IAE9D,MAAM8B,SAASC,IAAAA,kBAAY,EAACX;IAC5B,OAAO,MAAM,IAAIY,QAAgB,CAACnC,SAASoC;QACzCH,OAAOI,MAAM,CAAClB,QAAQmB,IAAI,EAAE;YAC1BtC,QAAQiC;QACV;QAEAA,OAAOM,EAAE,CAAC,SAAS,CAACC;YAClBpB,IAAIoB;YACJJ,OAAOI;QACT;IACF;AACF"}
+{"version":3,"sources":["../../../src/internals/server.ts"],"sourcesContent":["import type { SnapManifest } from '@metamask/snaps-utils';\nimport {\n  assertIsSnapManifest,\n  isDirectory,\n  isFile,\n} from '@metamask/snaps-utils';\nimport { createModuleLogger } from '@metamask/utils';\nimport express from 'express';\nimport { promises as fs } from 'fs';\nimport type { Server } from 'http';\nimport { createServer } from 'http';\nimport { resolve as pathResolve } from 'path';\n\nimport type { SnapsEnvironmentOptions } from '../options';\nimport { rootLogger } from './logger';\n\nexport type ServerOptions = Required<\n  // We need a double `Required` for the type to be inferred correctly.\n  Required<SnapsEnvironmentOptions>['server']\n>;\n\n/**\n * Check that:\n *\n * - The root directory exists.\n * - The root directory contains a `snap.manifest.json` file.\n * - The file path in the manifest exists.\n *\n * @param root - The root directory.\n * @throws If any of the checks fail.\n */\nasync function assertRoot(root: string) {\n  if (!root) {\n    throw new Error('You must specify a root directory.');\n  }\n\n  if (!(await isDirectory(root, false))) {\n    throw new Error(`Root directory \"${root}\" is not a directory.`);\n  }\n\n  const manifestPath = pathResolve(root, 'snap.manifest.json');\n  const manifest: SnapManifest = await fs\n    .readFile(manifestPath, 'utf8')\n    .then(JSON.parse);\n\n  assertIsSnapManifest(manifest);\n  const filePath = pathResolve(root, manifest.source.location.npm.filePath);\n\n  if (!(await isFile(filePath))) {\n    throw new Error(\n      `File \"${filePath}\" does not exist, or is not a file. Did you forget to build your snap?`,\n    );\n  }\n}\n\n/**\n * Start an HTTP server on `localhost` with a random port. This is used to serve\n * the static files for the environment.\n *\n * @param options - The options to use.\n * @param options.port - The port to use for the server.\n * @param options.root - The root directory to serve from the server.\n * @returns The HTTP server.\n */\nexport async function startServer(options: ServerOptions) {\n  await assertRoot(options.root);\n\n  const log = createModuleLogger(rootLogger, 'server');\n  const app = express();\n\n  app.use((_request, response, next) => {\n    response.header('Access-Control-Allow-Origin', '*');\n    response.header('Access-Control-Allow-Credentials', 'true');\n    response.header('Access-Control-Allow-Methods', 'GET, OPTIONS');\n    response.header('Access-Control-Allow-Headers', 'Content-Type');\n\n    next();\n  });\n\n  app.use(express.static(pathResolve(process.cwd(), options.root)));\n\n  const server = createServer(app);\n  return await new Promise<Server>((resolve, reject) => {\n    server.listen(options.port, () => {\n      resolve(server);\n    });\n\n    server.on('error', (error) => {\n      log(error);\n      reject(error);\n    });\n  });\n}\n"],"names":["startServer","assertRoot","root","Error","isDirectory","manifestPath","pathResolve","manifest","fs","readFile","then","JSON","parse","assertIsSnapManifest","filePath","source","location","npm","isFile","options","log","createModuleLogger","rootLogger","app","express","use","_request","response","next","header","static","process","cwd","server","createServer","Promise","resolve","reject","listen","port","on","error"],"mappings":";;;;+BAgEsBA;;;eAAAA;;;4BA3Df;uBAC4B;gEACf;oBACW;sBAEF;sBACU;wBAGZ;;;;;;AAO3B;;;;;;;;;CASC,GACD,eAAeC,WAAWC,IAAY;IACpC,IAAI,CAACA,MAAM;QACT,MAAM,IAAIC,MAAM;IAClB;IAEA,IAAI,CAAE,MAAMC,IAAAA,uBAAW,EAACF,MAAM,QAAS;QACrC,MAAM,IAAIC,MAAM,CAAC,gBAAgB,EAAED,KAAK,qBAAqB,CAAC;IAChE;IAEA,MAAMG,eAAeC,IAAAA,aAAW,EAACJ,MAAM;IACvC,MAAMK,WAAyB,MAAMC,YAAE,CACpCC,QAAQ,CAACJ,cAAc,QACvBK,IAAI,CAACC,KAAKC,KAAK;IAElBC,IAAAA,gCAAoB,EAACN;IACrB,MAAMO,WAAWR,IAAAA,aAAW,EAACJ,MAAMK,SAASQ,MAAM,CAACC,QAAQ,CAACC,GAAG,CAACH,QAAQ;IAExE,IAAI,CAAE,MAAMI,IAAAA,kBAAM,EAACJ,WAAY;QAC7B,MAAM,IAAIX,MACR,CAAC,MAAM,EAAEW,SAAS,sEAAsE,CAAC;IAE7F;AACF;AAWO,eAAed,YAAYmB,OAAsB;IACtD,MAAMlB,WAAWkB,QAAQjB,IAAI;IAE7B,MAAMkB,MAAMC,IAAAA,yBAAkB,EAACC,kBAAU,EAAE;IAC3C,MAAMC,MAAMC,IAAAA,gBAAO;IAEnBD,IAAIE,GAAG,CAAC,CAACC,UAAUC,UAAUC;QAC3BD,SAASE,MAAM,CAAC,+BAA+B;QAC/CF,SAASE,MAAM,CAAC,oCAAoC;QACpDF,SAASE,MAAM,CAAC,gCAAgC;QAChDF,SAASE,MAAM,CAAC,gCAAgC;QAEhDD;IACF;IAEAL,IAAIE,GAAG,CAACD,gBAAO,CAACM,MAAM,CAACxB,IAAAA,aAAW,EAACyB,QAAQC,GAAG,IAAIb,QAAQjB,IAAI;IAE9D,MAAM+B,SAASC,IAAAA,kBAAY,EAACX;IAC5B,OAAO,MAAM,IAAIY,QAAgB,CAACC,SAASC;QACzCJ,OAAOK,MAAM,CAACnB,QAAQoB,IAAI,EAAE;YAC1BH,QAAQH;QACV;QAEAA,OAAOO,EAAE,CAAC,SAAS,CAACC;YAClBrB,IAAIqB;YACJJ,OAAOI;QACT;IACF;AACF"}

package/dist/cjs/internals/simulation/constants.js

@@ -0,0 +1,29 @@
+/**
+ * A secret recovery phrase that is used for testing purposes. Do not use this
+ * to store any real funds!
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    DEFAULT_SRP: function() {
+        return DEFAULT_SRP;
+    },
+    DEFAULT_LOCALE: function() {
+        return DEFAULT_LOCALE;
+    },
+    DEFAULT_JSON_RPC_ENDPOINT: function() {
+        return DEFAULT_JSON_RPC_ENDPOINT;
+    }
+});
+const DEFAULT_SRP = 'test test test test test test test test test test test ball';
+const DEFAULT_LOCALE = 'en';
+const DEFAULT_JSON_RPC_ENDPOINT = 'https://cloudflare-eth.com/';
+
+//# sourceMappingURL=constants.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/internals/simulation/constants.ts"],"sourcesContent":["/**\n * A secret recovery phrase that is used for testing purposes. Do not use this\n * to store any real funds!\n */\nexport const DEFAULT_SRP =\n  'test test test test test test test test test test test ball';\n\n/**\n * The default locale.\n */\nexport const DEFAULT_LOCALE = 'en';\n\n/**\n * The default JSON-RPC endpoint for Ethereum requests.\n */\nexport const DEFAULT_JSON_RPC_ENDPOINT = 'https://cloudflare-eth.com/';\n"],"names":["DEFAULT_SRP","DEFAULT_LOCALE","DEFAULT_JSON_RPC_ENDPOINT"],"mappings":"AAAA;;;CAGC;;;;;;;;;;;IACYA,WAAW;eAAXA;;IAMAC,cAAc;eAAdA;;IAKAC,yBAAyB;eAAzBA;;;AAXN,MAAMF,cACX;AAKK,MAAMC,iBAAiB;AAKvB,MAAMC,4BAA4B"}