@metamask/snaps-jest 4.0.1 → 5.0.0

package/dist/esm/internals/request.js

@@ -1,120 +1,77 @@
-import { HandlerType } from '@metamask/snaps-utils';
-import { assert, createModuleLogger, hasProperty, isPlainObject } from '@metamask/utils';
-import { getDocument, queries } from 'pptr-testing-library';
-import { create } from 'superstruct';
-import { getInterface, getNotifications } from './interface';
-import { rootLogger } from './logger';
-import { TransactionOptionsStruct } from './structs';
-import { waitForResponse } from './wait-for';
-const log = createModuleLogger(rootLogger, 'request');
+import { unwrapError } from '@metamask/snaps-utils';
+import { getSafeJson, hasProperty, isPlainObject } from '@metamask/utils';
+import { nanoid } from '@reduxjs/toolkit';
+import { clearNotifications, getInterface, getNotifications } from './simulation';
 /**
- * Send a request to the snap.
+ * Send a JSON-RPC request to the Snap, and wrap the response in a
+ * {@link SnapResponse} object.
  *
- * @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 getDocument(page);
-    const button = await 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);
-}
-/**
- * Send a request to the snap.
- *
- * @param page - The page to send the request from.
  * @param options - The request options.
- * @param options.origin - The origin of the request. Defaults to `metamask.io`.
- * @param handler - The handler to use. Defaults to `onRpcRequest`.
- * @returns The response.
- */ export function request(page, { origin = 'metamask.io', ...options }, handler = HandlerType.OnRpcRequest) {
-    const doRequest = async ()=>{
-        const args = {
-            origin,
-            handler,
-            request: {
-                jsonrpc: '2.0',
-                id: 1,
-                ...options
-            }
-        };
-        log('Sending request %o', args);
-        const promise = waitForResponse(page, handler);
-        const id = await sendRequest(page, args);
-        const response = await promise;
-        log('Received response %o', response);
-        const notifications = await 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 getInterface(page, getInterfaceOptions);
-    };
-    return response;
-}
-/**
- * Send a transaction to the snap.
- *
- * @param page - The page to send the transaction from.
- * @param options - The transaction options.
- * @returns The response.
- */ export async function sendTransaction(page, options) {
-    const { origin: transactionOrigin, chainId, ...transaction } = create(options, TransactionOptionsStruct);
-    const args = {
-        origin: '',
-        handler: HandlerType.OnTransaction,
+ * @param options.snapId - The ID of the Snap to send the request to.
+ * @param options.store - The Redux store.
+ * @param options.executionService - The execution service to use to send the
+ * request.
+ * @param options.handler - The handler to use to send the request.
+ * @param options.controllerMessenger - The controller messenger used to call actions.
+ * @param options.runSaga - A function to run a saga outside the usual Redux
+ * flow.
+ * @param options.request - The request to send.
+ * @param options.request.id - The ID of the request. If not provided, a random
+ * ID will be generated.
+ * @param options.request.origin - The origin of the request. Defaults to
+ * `https://metamask.io`.
+ * @returns The response, wrapped in a {@link SnapResponse} object.
+ */ export function handleRequest({ snapId, store, executionService, handler, controllerMessenger, runSaga, request: { id = 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 = waitForResponse(page, HandlerType.OnTransaction);
-    const id = await sendRequest(page, args);
-    const response = await promise;
-    log('Received response %o', response);
-    if (hasProperty(response, 'error')) {
+    }).then((result)=>{
+        const notifications = getNotifications(store.getState());
+        store.dispatch(clearNotifications());
+        const content = getContentFromResult(result, snapId, controllerMessenger);
+        return {
+            id: String(id),
+            response: {
+                result: getSafeJson(result)
+            },
+            notifications,
+            content
+        };
+    }).catch((error)=>{
+        const [unwrappedError] = unwrapError(error);
         return {
-            id,
-            response,
+            id: String(id),
+            response: {
+                error: unwrappedError.serialize()
+            },
             notifications: []
         };
-    }
-    assert(isPlainObject(response.result));
-    assert(hasProperty(response.result, 'content'));
-    return {
-        id,
-        response,
-        notifications: [],
-        content: response.result.content
+    });
+    promise.getInterface = async ()=>{
+        return await runSaga(getInterface, runSaga, snapId, controllerMessenger).toPromise();
     };
+    return promise;
 }
 /**
- * Run a cronjob.
+ * Get the response content either from the SnapInterfaceController or the response object if there is one.
  *
- * @param page - The page to run the cronjob from.
- * @param options - The request options.
- * @returns The response.
- */ export function runCronjob(page, options) {
-    return request(page, options, HandlerType.OnCronjob);
+ * @param result - The handler result object.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The content components if any.
+ */ export function getContentFromResult(result, snapId, controllerMessenger) {
+    if (isPlainObject(result) && hasProperty(result, 'id')) {
+        return controllerMessenger.call('SnapInterfaceController:getInterface', snapId, result.id).content;
+    }
+    if (isPlainObject(result) && hasProperty(result, 'content')) {
+        return result.content;
+    }
+    return undefined;
 }
 
 //# sourceMappingURL=request.js.map

package/dist/esm/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":["HandlerType","assert","createModuleLogger","hasProperty","isPlainObject","getDocument","queries","create","getInterface","getNotifications","rootLogger","TransactionOptionsStruct","waitForResponse","log","sendRequest","page","args","document","button","getByTestId","handler","click","evaluate","payload","window","__SIMULATOR_API__","dispatch","type","getRequestId","request","origin","options","OnRpcRequest","doRequest","jsonrpc","id","promise","response","notifications","getInterfaceOptions","sendTransaction","transactionOrigin","chainId","transaction","OnTransaction","method","params","result","content","runCronjob","OnCronjob"],"mappings":"AAEA,SAASA,WAAW,QAAQ,wBAAwB;AACpD,SACEC,MAAM,EACNC,kBAAkB,EAClBC,WAAW,EACXC,aAAa,QACR,kBAAkB;AACzB,SAASC,WAAW,EAAEC,OAAO,QAAQ,uBAAuB;AAE5D,SAASC,MAAM,QAAQ,cAAc;AASrC,SAASC,YAAY,EAAEC,gBAAgB,QAAQ,cAAc;AAC7D,SAASC,UAAU,QAAQ,WAAW;AACtC,SAASC,wBAAwB,QAAQ,YAAY;AACrD,SAASC,eAAe,QAAQ,aAAa;AAE7C,MAAMC,MAAMX,mBAAmBQ,YAAY;AAE3C;;;;;;CAMC,GACD,eAAeI,YAAYC,IAAU,EAAEC,IAAqB;IAC1D,MAAMC,WAAW,MAAMZ,YAAYU;IACnC,MAAMG,SAAS,MAAMZ,QAAQa,WAAW,CACtCF,UACA,CAAC,WAAW,EAAED,KAAKI,OAAO,CAAC,CAAC;IAG9B,wCAAwC;IACxC,MAAMF,OAAOG,KAAK;IAElB,OAAO,MAAMN,KAAKO,QAAQ,CAAC,CAACC;QAC1BC,OAAOC,iBAAiB,CAACC,QAAQ,CAAC;YAChCC,MAAM;YACNJ;QACF;QAEA,OAAOC,OAAOC,iBAAiB,CAACG,YAAY;IAC9C,GAAGZ;AACL;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASa,QACdd,IAAU,EACV,EAAEe,SAAS,aAAa,EAAE,GAAGC,SAAyB,EACtDX,UAE4BpB,YAAYgC,YAAY;IAEpD,MAAMC,YAAY;QAChB,MAAMjB,OAAwB;YAC5Bc;YACAV;YACAS,SAAS;gBACPK,SAAS;gBACTC,IAAI;gBACJ,GAAGJ,OAAO;YACZ;QACF;QAEAlB,IAAI,sBAAsBG;QAE1B,MAAMoB,UAAUxB,gBAAgBG,MAAMK;QACtC,MAAMe,KAAK,MAAMrB,YAAYC,MAAMC;QACnC,MAAMqB,WAAW,MAAMD;QAEvBvB,IAAI,wBAAwBwB;QAE5B,MAAMC,gBAAgB,MAAM7B,iBAAiBM,MAAMoB;QAEnD,OAAO;YAAEA;YAAIE;YAAUC;QAAc;IACvC;IAEA,yEAAyE;IACzE,2BAA2B;IAC3B,MAAMD,WAAWJ;IAEjBI,SAAS7B,YAAY,GAAG,OAAO+B;QAC7B,OAAO,MAAM/B,aAAaO,MAAMwB;IAClC;IAEA,OAAOF;AACT;AAEA;;;;;;CAMC,GACD,OAAO,eAAeG,gBACpBzB,IAAU,EACVgB,OAAoC;IAEpC,MAAM,EACJD,QAAQW,iBAAiB,EACzBC,OAAO,EACP,GAAGC,aACJ,GAAGpC,OAAOwB,SAASpB;IAEpB,MAAMK,OAAwB;QAC5Bc,QAAQ;QACRV,SAASpB,YAAY4C,aAAa;QAClCf,SAAS;YACPK,SAAS;YACTW,QAAQ;YACRC,QAAQ;gBACNJ;gBACAC;gBACAF;YACF;QACF;IACF;IAEA5B,IAAI,0BAA0BG;IAE9B,MAAMoB,UAAUxB,gBAAgBG,MAAMf,YAAY4C,aAAa;IAC/D,MAAMT,KAAK,MAAMrB,YAAYC,MAAMC;IACnC,MAAMqB,WAAW,MAAMD;IAEvBvB,IAAI,wBAAwBwB;IAE5B,IAAIlC,YAAYkC,UAAU,UAAU;QAClC,OAAO;YAAEF;YAAIE;YAAUC,eAAe,EAAE;QAAC;IAC3C;IAEArC,OAAOG,cAAciC,SAASU,MAAM;IACpC9C,OAAOE,YAAYkC,SAASU,MAAM,EAAE;IAEpC,OAAO;QACLZ;QACAE;QACAC,eAAe,EAAE;QACjBU,SAASX,SAASU,MAAM,CAACC,OAAO;IAClC;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,WAAWlC,IAAU,EAAEgB,OAAuB;IAC5D,OAAOF,QAAQd,MAAMgB,SAAS/B,YAAYkD,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":["unwrapError","getSafeJson","hasProperty","isPlainObject","nanoid","clearNotifications","getInterface","getNotifications","handleRequest","snapId","store","executionService","handler","controllerMessenger","runSaga","request","id","origin","options","promise","handleRpcRequest","jsonrpc","then","result","notifications","getState","dispatch","content","getContentFromResult","String","response","catch","error","unwrappedError","serialize","toPromise","call","undefined"],"mappings":"AAGA,SAASA,WAAW,QAAQ,wBAAwB;AACpD,SAASC,WAAW,EAAEC,WAAW,EAAEC,aAAa,QAAQ,kBAAkB;AAC1E,SAASC,MAAM,QAAQ,mBAAmB;AAG1C,SACEC,kBAAkB,EAClBC,YAAY,EACZC,gBAAgB,QACX,eAAe;AActB;;;;;;;;;;;;;;;;;;;CAmBC,GACD,OAAO,SAASC,cAAc,EAC5BC,MAAM,EACNC,KAAK,EACLC,gBAAgB,EAChBC,OAAO,EACPC,mBAAmB,EACnBC,OAAO,EACPC,SAAS,EAAEC,KAAKZ,QAAQ,EAAEa,SAAS,qBAAqB,EAAE,GAAGC,SAAS,EACjD;IACrB,MAAMC,UAAUR,iBACbS,gBAAgB,CAACX,QAAQ;QACxBQ;QACAL;QACAG,SAAS;YACPM,SAAS;YACTL,IAAI;YACJ,GAAGE,OAAO;QACZ;IACF,GACCI,IAAI,CAAC,CAACC;QACL,MAAMC,gBAAgBjB,iBAAiBG,MAAMe,QAAQ;QACrDf,MAAMgB,QAAQ,CAACrB;QAEf,MAAMsB,UAAUC,qBAAqBL,QAAQd,QAAQI;QAErD,OAAO;YACLG,IAAIa,OAAOb;YACXc,UAAU;gBACRP,QAAQtB,YAAYsB;YACtB;YACAC;YACAG;QACF;IACF,GACCI,KAAK,CAAC,CAACC;QACN,MAAM,CAACC,eAAe,GAAGjC,YAAYgC;QAErC,OAAO;YACLhB,IAAIa,OAAOb;YACXc,UAAU;gBACRE,OAAOC,eAAeC,SAAS;YACjC;YACAV,eAAe,EAAE;QACnB;IACF;IAEFL,QAAQb,YAAY,GAAG;QACrB,OAAO,MAAMQ,QACXR,cACAQ,SACAL,QACAI,qBACAsB,SAAS;IACb;IAEA,OAAOhB;AACT;AAEA;;;;;;;CAOC,GACD,OAAO,SAASS,qBACdL,MAAe,EACfd,MAAc,EACdI,mBAA4C;IAE5C,IAAIV,cAAcoB,WAAWrB,YAAYqB,QAAQ,OAAO;QACtD,OAAOV,oBAAoBuB,IAAI,CAC7B,wCACA3B,QACAc,OAAOP,EAAE,EACTW,OAAO;IACX;IAEA,IAAIxB,cAAcoB,WAAWrB,YAAYqB,QAAQ,YAAY;QAC3D,OAAOA,OAAOI,OAAO;IACvB;IAEA,OAAOU;AACT"}

package/dist/esm/internals/server.js

@@ -3,10 +3,8 @@ import { createModuleLogger } from '@metamask/utils';
 import express from 'express';
 import { promises as fs } from 'fs';
 import { createServer } from 'http';
-import { resolve as pathResolve, dirname } from 'path';
+import { resolve as pathResolve } from 'path';
 import { rootLogger } from './logger';
-const SNAPS_EXECUTION_ENVIRONMENTS_PATH = pathResolve(dirname(require.resolve('@metamask/snaps-execution-environments/package.json')), 'dist', 'browserify', 'iframe');
-const SNAPS_SIMULATOR_PATH = pathResolve(dirname(require.resolve('@metamask/snaps-simulator/package.json')), 'dist', 'webpack', 'test');
 /**
  * Check that:
  *
@@ -50,8 +48,6 @@ const SNAPS_SIMULATOR_PATH = pathResolve(dirname(require.resolve('@metamask/snap
         response.header('Access-Control-Allow-Headers', 'Content-Type');
         next();
     });
-    app.use('/environment', express.static(SNAPS_EXECUTION_ENVIRONMENTS_PATH));
-    app.use('/simulator', express.static(SNAPS_SIMULATOR_PATH));
     app.use(express.static(pathResolve(process.cwd(), options.root)));
     const server = createServer(app);
     return await new Promise((resolve, reject)=>{

package/dist/esm/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":["assertIsSnapManifest","isDirectory","isFile","createModuleLogger","express","promises","fs","createServer","resolve","pathResolve","dirname","rootLogger","SNAPS_EXECUTION_ENVIRONMENTS_PATH","require","SNAPS_SIMULATOR_PATH","assertRoot","root","Error","manifestPath","manifest","readFile","then","JSON","parse","filePath","source","location","npm","startServer","options","log","app","use","_request","response","next","header","static","process","cwd","server","Promise","reject","listen","port","on","error"],"mappings":"AACA,SACEA,oBAAoB,EACpBC,WAAW,EACXC,MAAM,QACD,wBAAwB;AAC/B,SAASC,kBAAkB,QAAQ,kBAAkB;AACrD,OAAOC,aAAa,UAAU;AAC9B,SAASC,YAAYC,EAAE,QAAQ,KAAK;AAEpC,SAASC,YAAY,QAAQ,OAAO;AACpC,SAASC,WAAWC,WAAW,EAAEC,OAAO,QAAQ,OAAO;AAGvD,SAASC,UAAU,QAAQ,WAAW;AAEtC,MAAMC,oCAAoCH,YACxCC,QACEG,QAAQL,OAAO,CAAC,yDAElB,QACA,cACA;AAGF,MAAMM,uBAAuBL,YAC3BC,QAAQG,QAAQL,OAAO,CAAC,4CACxB,QACA,WACA;AAQF;;;;;;;;;CASC,GACD,eAAeO,WAAWC,IAAY;IACpC,IAAI,CAACA,MAAM;QACT,MAAM,IAAIC,MAAM;IAClB;IAEA,IAAI,CAAE,MAAMhB,YAAYe,MAAM,QAAS;QACrC,MAAM,IAAIC,MAAM,CAAC,gBAAgB,EAAED,KAAK,qBAAqB,CAAC;IAChE;IAEA,MAAME,eAAeT,YAAYO,MAAM;IACvC,MAAMG,WAAyB,MAAMb,GAClCc,QAAQ,CAACF,cAAc,QACvBG,IAAI,CAACC,KAAKC,KAAK;IAElBvB,qBAAqBmB;IACrB,MAAMK,WAAWf,YAAYO,MAAMG,SAASM,MAAM,CAACC,QAAQ,CAACC,GAAG,CAACH,QAAQ;IAExE,IAAI,CAAE,MAAMtB,OAAOsB,WAAY;QAC7B,MAAM,IAAIP,MACR,CAAC,MAAM,EAAEO,SAAS,sEAAsE,CAAC;IAE7F;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAeI,YAAYC,OAAsB;IACtD,MAAMd,WAAWc,QAAQb,IAAI;IAE7B,MAAMc,MAAM3B,mBAAmBQ,YAAY;IAC3C,MAAMoB,MAAM3B;IAEZ2B,IAAIC,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;IAEAJ,IAAIC,GAAG,CAAC,gBAAgB5B,QAAQiC,MAAM,CAACzB;IACvCmB,IAAIC,GAAG,CAAC,cAAc5B,QAAQiC,MAAM,CAACvB;IACrCiB,IAAIC,GAAG,CAAC5B,QAAQiC,MAAM,CAAC5B,YAAY6B,QAAQC,GAAG,IAAIV,QAAQb,IAAI;IAE9D,MAAMwB,SAASjC,aAAawB;IAC5B,OAAO,MAAM,IAAIU,QAAgB,CAACjC,SAASkC;QACzCF,OAAOG,MAAM,CAACd,QAAQe,IAAI,EAAE;YAC1BpC,QAAQgC;QACV;QAEAA,OAAOK,EAAE,CAAC,SAAS,CAACC;YAClBhB,IAAIgB;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":["assertIsSnapManifest","isDirectory","isFile","createModuleLogger","express","promises","fs","createServer","resolve","pathResolve","rootLogger","assertRoot","root","Error","manifestPath","manifest","readFile","then","JSON","parse","filePath","source","location","npm","startServer","options","log","app","use","_request","response","next","header","static","process","cwd","server","Promise","reject","listen","port","on","error"],"mappings":"AACA,SACEA,oBAAoB,EACpBC,WAAW,EACXC,MAAM,QACD,wBAAwB;AAC/B,SAASC,kBAAkB,QAAQ,kBAAkB;AACrD,OAAOC,aAAa,UAAU;AAC9B,SAASC,YAAYC,EAAE,QAAQ,KAAK;AAEpC,SAASC,YAAY,QAAQ,OAAO;AACpC,SAASC,WAAWC,WAAW,QAAQ,OAAO;AAG9C,SAASC,UAAU,QAAQ,WAAW;AAOtC;;;;;;;;;CASC,GACD,eAAeC,WAAWC,IAAY;IACpC,IAAI,CAACA,MAAM;QACT,MAAM,IAAIC,MAAM;IAClB;IAEA,IAAI,CAAE,MAAMZ,YAAYW,MAAM,QAAS;QACrC,MAAM,IAAIC,MAAM,CAAC,gBAAgB,EAAED,KAAK,qBAAqB,CAAC;IAChE;IAEA,MAAME,eAAeL,YAAYG,MAAM;IACvC,MAAMG,WAAyB,MAAMT,GAClCU,QAAQ,CAACF,cAAc,QACvBG,IAAI,CAACC,KAAKC,KAAK;IAElBnB,qBAAqBe;IACrB,MAAMK,WAAWX,YAAYG,MAAMG,SAASM,MAAM,CAACC,QAAQ,CAACC,GAAG,CAACH,QAAQ;IAExE,IAAI,CAAE,MAAMlB,OAAOkB,WAAY;QAC7B,MAAM,IAAIP,MACR,CAAC,MAAM,EAAEO,SAAS,sEAAsE,CAAC;IAE7F;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAeI,YAAYC,OAAsB;IACtD,MAAMd,WAAWc,QAAQb,IAAI;IAE7B,MAAMc,MAAMvB,mBAAmBO,YAAY;IAC3C,MAAMiB,MAAMvB;IAEZuB,IAAIC,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;IAEAJ,IAAIC,GAAG,CAACxB,QAAQ6B,MAAM,CAACxB,YAAYyB,QAAQC,GAAG,IAAIV,QAAQb,IAAI;IAE9D,MAAMwB,SAAS7B,aAAaoB;IAC5B,OAAO,MAAM,IAAIU,QAAgB,CAAC7B,SAAS8B;QACzCF,OAAOG,MAAM,CAACd,QAAQe,IAAI,EAAE;YAC1BhC,QAAQ4B;QACV;QAEAA,OAAOK,EAAE,CAAC,SAAS,CAACC;YAClBhB,IAAIgB;YACJJ,OAAOI;QACT;IACF;AACF"}

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

@@ -0,0 +1,12 @@
+/**
+ * A secret recovery phrase that is used for testing purposes. Do not use this
+ * to store any real funds!
+ */ export const DEFAULT_SRP = 'test test test test test test test test test test test ball';
+/**
+ * The default locale.
+ */ export const DEFAULT_LOCALE = 'en';
+/**
+ * The default JSON-RPC endpoint for Ethereum requests.
+ */ export const DEFAULT_JSON_RPC_ENDPOINT = 'https://cloudflare-eth.com/';
+
+//# sourceMappingURL=constants.js.map

package/dist/esm/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,GACD,OAAO,MAAMA,cACX,8DAA8D;AAEhE;;CAEC,GACD,OAAO,MAAMC,iBAAiB,KAAK;AAEnC;;CAEC,GACD,OAAO,MAAMC,4BAA4B,8BAA8B"}

package/dist/esm/internals/simulation/controllers.js

@@ -0,0 +1,90 @@
+import { PermissionController, SubjectMetadataController, SubjectType } from '@metamask/permission-controller';
+import { SnapInterfaceController } from '@metamask/snaps-controllers';
+import { caveatSpecifications as snapsCaveatsSpecifications, endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications, processSnapPermissions } from '@metamask/snaps-rpc-methods';
+import { getSafeJson } from '@metamask/utils';
+import { getPermissionSpecifications } from './methods';
+import { UNRESTRICTED_METHODS } from './methods/constants';
+/**
+ * Get the controllers for the Snap.
+ *
+ * @param options - The options.
+ * @returns The controllers for the Snap.
+ */ export function getControllers(options) {
+    const { controllerMessenger } = options;
+    const subjectMetadataController = new SubjectMetadataController({
+        messenger: controllerMessenger.getRestricted({
+            name: 'SubjectMetadataController'
+        }),
+        subjectCacheLimit: 100
+    });
+    const interfaceController = new SnapInterfaceController({
+        messenger: controllerMessenger.getRestricted({
+            name: 'SnapInterfaceController',
+            allowedActions: [
+                'PhishingController:maybeUpdateState',
+                'PhishingController:testOrigin'
+            ]
+        })
+    });
+    const permissionController = getPermissionController(options);
+    return {
+        permissionController,
+        subjectMetadataController,
+        interfaceController
+    };
+}
+/**
+ * Get the permission controller for the Snap.
+ *
+ * @param options - The options.
+ * @param options.controllerMessenger - The controller messenger.
+ * @param options.options - Miscellaneous options.
+ * @returns The permission controller for the Snap.
+ */ function getPermissionController(options) {
+    const { controllerMessenger } = options;
+    const permissionSpecifications = getPermissionSpecifications(options);
+    return new PermissionController({
+        messenger: controllerMessenger.getRestricted({
+            name: 'PermissionController',
+            allowedActions: [
+                `ApprovalController:addRequest`,
+                `ApprovalController:hasRequest`,
+                `ApprovalController:acceptRequest`,
+                `ApprovalController:rejectRequest`,
+                `SnapController:getPermitted`,
+                `SnapController:install`,
+                `SubjectMetadataController:getSubjectMetadata`
+            ]
+        }),
+        caveatSpecifications: {
+            ...snapsCaveatsSpecifications,
+            ...snapsEndowmentCaveatSpecifications
+        },
+        permissionSpecifications,
+        unrestrictedMethods: UNRESTRICTED_METHODS
+    });
+}
+/**
+ * Register the Snap. This sets up the Snap's permissions and subject metadata.
+ *
+ * @param snapId - The ID of the Snap to install.
+ * @param manifest - The parsed manifest.
+ * @param controllers - The controllers for the Snap.
+ * @param controllers.permissionController - The permission controller.
+ * @param controllers.subjectMetadataController - The subject metadata controller.
+ */ export async function registerSnap(snapId, manifest, { permissionController, subjectMetadataController }) {
+    subjectMetadataController.addSubjectMetadata({
+        origin: snapId,
+        subjectType: SubjectType.Snap
+    });
+    const approvedPermissions = processSnapPermissions(getSafeJson(manifest.initialPermissions));
+    permissionController.grantPermissions({
+        approvedPermissions,
+        subject: {
+            origin: snapId
+        },
+        preserveExistingPermissions: false
+    });
+}
+
+//# sourceMappingURL=controllers.js.map

package/dist/esm/internals/simulation/controllers.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/internals/simulation/controllers.ts"],"sourcesContent":["import type { ControllerMessenger } from '@metamask/base-controller';\nimport type {\n  CaveatSpecificationConstraint,\n  PermissionSpecificationConstraint,\n  PermissionControllerActions,\n  SubjectMetadataControllerActions,\n} from '@metamask/permission-controller';\nimport {\n  PermissionController,\n  SubjectMetadataController,\n  SubjectType,\n} from '@metamask/permission-controller';\nimport { SnapInterfaceController } from '@metamask/snaps-controllers';\nimport type {\n  ExecutionServiceActions,\n  SnapInterfaceControllerActions,\n  SnapInterfaceControllerAllowedActions,\n} from '@metamask/snaps-controllers';\nimport {\n  caveatSpecifications as snapsCaveatsSpecifications,\n  endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,\n  processSnapPermissions,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport type { SnapManifest } from '@metamask/snaps-utils';\nimport { getSafeJson } from '@metamask/utils';\n\nimport { getPermissionSpecifications } from './methods';\nimport { UNRESTRICTED_METHODS } from './methods/constants';\nimport type { SimulationOptions } from './options';\nimport type { MiddlewareHooks } from './simulation';\nimport type { RunSagaFunction } from './store';\n\nexport type RootControllerAllowedActions =\n  | SnapInterfaceControllerActions\n  | SnapInterfaceControllerAllowedActions\n  | PermissionControllerActions\n  | ExecutionServiceActions\n  | SubjectMetadataControllerActions;\n\nexport type RootControllerMessenger = ControllerMessenger<\n  RootControllerAllowedActions,\n  any\n>;\n\nexport type GetControllersOptions = {\n  controllerMessenger: ControllerMessenger<any, any>;\n  hooks: MiddlewareHooks;\n  runSaga: RunSagaFunction;\n  options: SimulationOptions;\n};\n\nexport type Controllers = {\n  permissionController: PermissionController<\n    PermissionSpecificationConstraint,\n    CaveatSpecificationConstraint\n  >;\n  subjectMetadataController: SubjectMetadataController;\n  interfaceController: SnapInterfaceController;\n};\n\n/**\n * Get the controllers for the Snap.\n *\n * @param options - The options.\n * @returns The controllers for the Snap.\n */\nexport function getControllers(options: GetControllersOptions): Controllers {\n  const { controllerMessenger } = options;\n  const subjectMetadataController = new SubjectMetadataController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'SubjectMetadataController',\n    }),\n    subjectCacheLimit: 100,\n  });\n\n  const interfaceController = new SnapInterfaceController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'SnapInterfaceController',\n      allowedActions: [\n        'PhishingController:maybeUpdateState',\n        'PhishingController:testOrigin',\n      ],\n    }),\n  });\n\n  const permissionController = getPermissionController(options);\n\n  return {\n    permissionController,\n    subjectMetadataController,\n    interfaceController,\n  };\n}\n\n/**\n * Get the permission controller for the Snap.\n *\n * @param options - The options.\n * @param options.controllerMessenger - The controller messenger.\n * @param options.options - Miscellaneous options.\n * @returns The permission controller for the Snap.\n */\nfunction getPermissionController(options: GetControllersOptions) {\n  const { controllerMessenger } = options;\n  const permissionSpecifications = getPermissionSpecifications(options);\n  return new PermissionController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'PermissionController',\n      allowedActions: [\n        `ApprovalController:addRequest`,\n        `ApprovalController:hasRequest`,\n        `ApprovalController:acceptRequest`,\n        `ApprovalController:rejectRequest`,\n        `SnapController:getPermitted`,\n        `SnapController:install`,\n        `SubjectMetadataController:getSubjectMetadata`,\n      ],\n    }),\n    caveatSpecifications: {\n      ...snapsCaveatsSpecifications,\n      ...snapsEndowmentCaveatSpecifications,\n    },\n    permissionSpecifications,\n    unrestrictedMethods: UNRESTRICTED_METHODS,\n  });\n}\n\n/**\n * Register the Snap. This sets up the Snap's permissions and subject metadata.\n *\n * @param snapId - The ID of the Snap to install.\n * @param manifest - The parsed manifest.\n * @param controllers - The controllers for the Snap.\n * @param controllers.permissionController - The permission controller.\n * @param controllers.subjectMetadataController - The subject metadata controller.\n */\nexport async function registerSnap(\n  snapId: SnapId,\n  manifest: SnapManifest,\n  {\n    permissionController,\n    subjectMetadataController,\n  }: Omit<Controllers, 'interfaceController'>,\n) {\n  subjectMetadataController.addSubjectMetadata({\n    origin: snapId,\n    subjectType: SubjectType.Snap,\n  });\n\n  const approvedPermissions = processSnapPermissions(\n    getSafeJson(manifest.initialPermissions),\n  );\n\n  permissionController.grantPermissions({\n    approvedPermissions,\n    subject: { origin: snapId },\n    preserveExistingPermissions: false,\n  });\n}\n"],"names":["PermissionController","SubjectMetadataController","SubjectType","SnapInterfaceController","caveatSpecifications","snapsCaveatsSpecifications","endowmentCaveatSpecifications","snapsEndowmentCaveatSpecifications","processSnapPermissions","getSafeJson","getPermissionSpecifications","UNRESTRICTED_METHODS","getControllers","options","controllerMessenger","subjectMetadataController","messenger","getRestricted","name","subjectCacheLimit","interfaceController","allowedActions","permissionController","getPermissionController","permissionSpecifications","unrestrictedMethods","registerSnap","snapId","manifest","addSubjectMetadata","origin","subjectType","Snap","approvedPermissions","initialPermissions","grantPermissions","subject","preserveExistingPermissions"],"mappings":"AAOA,SACEA,oBAAoB,EACpBC,yBAAyB,EACzBC,WAAW,QACN,kCAAkC;AACzC,SAASC,uBAAuB,QAAQ,8BAA8B;AAMtE,SACEC,wBAAwBC,0BAA0B,EAClDC,iCAAiCC,kCAAkC,EACnEC,sBAAsB,QACjB,8BAA8B;AAGrC,SAASC,WAAW,QAAQ,kBAAkB;AAE9C,SAASC,2BAA2B,QAAQ,YAAY;AACxD,SAASC,oBAAoB,QAAQ,sBAAsB;AAiC3D;;;;;CAKC,GACD,OAAO,SAASC,eAAeC,OAA8B;IAC3D,MAAM,EAAEC,mBAAmB,EAAE,GAAGD;IAChC,MAAME,4BAA4B,IAAId,0BAA0B;QAC9De,WAAWF,oBAAoBG,aAAa,CAAC;YAC3CC,MAAM;QACR;QACAC,mBAAmB;IACrB;IAEA,MAAMC,sBAAsB,IAAIjB,wBAAwB;QACtDa,WAAWF,oBAAoBG,aAAa,CAAC;YAC3CC,MAAM;YACNG,gBAAgB;gBACd;gBACA;aACD;QACH;IACF;IAEA,MAAMC,uBAAuBC,wBAAwBV;IAErD,OAAO;QACLS;QACAP;QACAK;IACF;AACF;AAEA;;;;;;;CAOC,GACD,SAASG,wBAAwBV,OAA8B;IAC7D,MAAM,EAAEC,mBAAmB,EAAE,GAAGD;IAChC,MAAMW,2BAA2Bd,4BAA4BG;IAC7D,OAAO,IAAIb,qBAAqB;QAC9BgB,WAAWF,oBAAoBG,aAAa,CAAC;YAC3CC,MAAM;YACNG,gBAAgB;gBACd,CAAC,6BAA6B,CAAC;gBAC/B,CAAC,6BAA6B,CAAC;gBAC/B,CAAC,gCAAgC,CAAC;gBAClC,CAAC,gCAAgC,CAAC;gBAClC,CAAC,2BAA2B,CAAC;gBAC7B,CAAC,sBAAsB,CAAC;gBACxB,CAAC,4CAA4C,CAAC;aAC/C;QACH;QACAjB,sBAAsB;YACpB,GAAGC,0BAA0B;YAC7B,GAAGE,kCAAkC;QACvC;QACAiB;QACAC,qBAAqBd;IACvB;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAee,aACpBC,MAAc,EACdC,QAAsB,EACtB,EACEN,oBAAoB,EACpBP,yBAAyB,EACgB;IAE3CA,0BAA0Bc,kBAAkB,CAAC;QAC3CC,QAAQH;QACRI,aAAa7B,YAAY8B,IAAI;IAC/B;IAEA,MAAMC,sBAAsBzB,uBAC1BC,YAAYmB,SAASM,kBAAkB;IAGzCZ,qBAAqBa,gBAAgB,CAAC;QACpCF;QACAG,SAAS;YAAEN,QAAQH;QAAO;QAC1BU,6BAA6B;IAC/B;AACF"}

package/dist/esm/internals/simulation/files.js

@@ -0,0 +1,19 @@
+import { AuxiliaryFileEncoding } from '@metamask/snaps-sdk';
+import { encodeAuxiliaryFile, normalizeRelative } from '@metamask/snaps-utils';
+/**
+ * Get a statically defined Snap file from an array of files.
+ *
+ * @param files - The Snap files.
+ * @param path - The file path.
+ * @param encoding - The requested file encoding.
+ * @returns The file in the requested encoding if found, otherwise null.
+ */ export async function getSnapFile(files, path, encoding = AuxiliaryFileEncoding.Base64) {
+    const normalizedPath = normalizeRelative(path);
+    const base64 = files.find((file)=>file.path === normalizedPath)?.toString('base64');
+    if (!base64) {
+        return null;
+    }
+    return await encodeAuxiliaryFile(base64, encoding);
+}
+
+//# sourceMappingURL=files.js.map

package/dist/esm/internals/simulation/files.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/internals/simulation/files.ts"],"sourcesContent":["import { AuxiliaryFileEncoding } from '@metamask/snaps-sdk';\nimport type { VirtualFile } from '@metamask/snaps-utils';\nimport { encodeAuxiliaryFile, normalizeRelative } from '@metamask/snaps-utils';\n\n/**\n * Get a statically defined Snap file from an array of files.\n *\n * @param files - The Snap files.\n * @param path - The file path.\n * @param encoding - The requested file encoding.\n * @returns The file in the requested encoding if found, otherwise null.\n */\nexport async function getSnapFile(\n  files: VirtualFile[],\n  path: string,\n  encoding: AuxiliaryFileEncoding = AuxiliaryFileEncoding.Base64,\n) {\n  const normalizedPath = normalizeRelative(path);\n  const base64 = files\n    .find((file) => file.path === normalizedPath)\n    ?.toString('base64');\n\n  if (!base64) {\n    return null;\n  }\n\n  return await encodeAuxiliaryFile(base64, encoding);\n}\n"],"names":["AuxiliaryFileEncoding","encodeAuxiliaryFile","normalizeRelative","getSnapFile","files","path","encoding","Base64","normalizedPath","base64","find","file","toString"],"mappings":"AAAA,SAASA,qBAAqB,QAAQ,sBAAsB;AAE5D,SAASC,mBAAmB,EAAEC,iBAAiB,QAAQ,wBAAwB;AAE/E;;;;;;;CAOC,GACD,OAAO,eAAeC,YACpBC,KAAoB,EACpBC,IAAY,EACZC,WAAkCN,sBAAsBO,MAAM;IAE9D,MAAMC,iBAAiBN,kBAAkBG;IACzC,MAAMI,SAASL,MACZM,IAAI,CAAC,CAACC,OAASA,KAAKN,IAAI,KAAKG,iBAC5BI,SAAS;IAEb,IAAI,CAACH,QAAQ;QACX,OAAO;IACT;IAEA,OAAO,MAAMR,oBAAoBQ,QAAQH;AAC3C"}

package/dist/esm/internals/simulation/index.js

@@ -0,0 +1,7 @@
+export * from './constants';
+export * from './interface';
+export * from './simulation';
+export * from './options';
+export * from './store';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/internals/simulation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/internals/simulation/index.ts"],"sourcesContent":["export * from './constants';\nexport * from './interface';\nexport * from './simulation';\nexport * from './options';\nexport * from './store';\n"],"names":[],"mappings":"AAAA,cAAc,cAAc;AAC5B,cAAc,cAAc;AAC5B,cAAc,eAAe;AAC7B,cAAc,YAAY;AAC1B,cAAc,UAAU"}

package/dist/esm/internals/simulation/interface.js

@@ -0,0 +1,95 @@
+import { DialogType } from '@metamask/snaps-sdk';
+import { put, select, take } from 'redux-saga/effects';
+import { getCurrentInterface, resolveInterface, setInterface } from './store';
+/**
+ * Get a user interface object from a type and content object.
+ *
+ * @param runSaga - A function to run a saga outside the usual Redux flow.
+ * @param type - The type of the interface.
+ * @param content - The content to show in the interface.
+ * @returns The user interface object.
+ */ export function getInterfaceResponse(runSaga, type, content) {
+    switch(type){
+        case DialogType.Alert:
+            return {
+                type,
+                content,
+                ok: resolveWith(runSaga, null)
+            };
+        case DialogType.Confirmation:
+            return {
+                type,
+                content,
+                ok: resolveWith(runSaga, true),
+                cancel: resolveWith(runSaga, false)
+            };
+        case DialogType.Prompt:
+            return {
+                type,
+                content,
+                ok: resolveWithInput(runSaga),
+                cancel: resolveWith(runSaga, null)
+            };
+        default:
+            throw new Error(`Unknown or unsupported dialog type: "${String(type)}".`);
+    }
+}
+/**
+ * Resolve the current user interface with the given value. This returns a
+ * function that can be used to resolve the user interface.
+ *
+ * @param runSaga - A function to run a saga outside the usual Redux flow.
+ * @param value - The value to resolve the user interface with.
+ * @returns A function that can be used to resolve the user interface.
+ */ function resolveWith(runSaga, value) {
+    /**
+   * Resolve the current user interface with the given value.
+   *
+   * @yields Puts the resolve user interface action.
+   */ function* resolveWithSaga() {
+        yield put(resolveInterface(value));
+    }
+    return async ()=>{
+        await runSaga(resolveWithSaga).toPromise();
+    };
+}
+/**
+ * Resolve the current user interface with the provided input. This returns a
+ * function that can be used to resolve the user interface.
+ *
+ * @param runSaga - A function to run a saga outside the usual Redux flow.
+ * @returns A function that can be used to resolve the user interface.
+ */ function resolveWithInput(runSaga) {
+    /**
+   * Resolve the current user interface with the given value.
+   *
+   * @param value - The value to resolve the user interface with.
+   * @yields Puts the resolve user interface action.
+   */ function* resolveWithSaga(value) {
+        yield put(resolveInterface(value));
+    }
+    return async (value = '')=>{
+        await runSaga(resolveWithSaga, value).toPromise();
+    };
+}
+/**
+ * Get a user interface object from a Snap.
+ *
+ * @param runSaga - A function to run a saga outside the usual Redux flow.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger used to call actions.
+ * @yields Takes the set interface action.
+ * @returns The user interface object.
+ */ export function* getInterface(runSaga, snapId, controllerMessenger) {
+    const currentInterface = yield select(getCurrentInterface);
+    if (currentInterface) {
+        const { content } = controllerMessenger.call('SnapInterfaceController:getInterface', snapId, currentInterface.id);
+        return getInterfaceResponse(runSaga, currentInterface.type, content);
+    }
+    const { payload } = yield take(setInterface.type);
+    const { type, id } = payload;
+    const { content } = controllerMessenger.call('SnapInterfaceController:getInterface', snapId, id);
+    return getInterfaceResponse(runSaga, type, content);
+}
+
+//# sourceMappingURL=interface.js.map

package/dist/esm/internals/simulation/interface.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/internals/simulation/interface.ts"],"sourcesContent":["import type { Component, SnapId } from '@metamask/snaps-sdk';\nimport { DialogType } from '@metamask/snaps-sdk';\nimport type { PayloadAction } from '@reduxjs/toolkit';\nimport type { SagaIterator } from 'redux-saga';\nimport { put, select, take } from 'redux-saga/effects';\n\nimport type { SnapInterface } from '../../types';\nimport type { RootControllerMessenger } from './controllers';\nimport type { Interface, RunSagaFunction } from './store';\nimport { getCurrentInterface, resolveInterface, setInterface } from './store';\n\n/**\n * Get a user interface object from a type and content object.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @param type - The type of the interface.\n * @param content - The content to show in the interface.\n * @returns The user interface object.\n */\nexport function getInterfaceResponse(\n  runSaga: RunSagaFunction,\n  type: DialogType,\n  content: Component,\n): SnapInterface {\n  switch (type) {\n    case DialogType.Alert:\n      return {\n        type,\n        content,\n        ok: resolveWith(runSaga, null),\n      };\n\n    case DialogType.Confirmation:\n      return {\n        type,\n        content,\n\n        ok: resolveWith(runSaga, true),\n        cancel: resolveWith(runSaga, false),\n      };\n\n    case DialogType.Prompt:\n      return {\n        type,\n        content,\n\n        ok: resolveWithInput(runSaga),\n        cancel: resolveWith(runSaga, null),\n      };\n\n    default:\n      throw new Error(`Unknown or unsupported dialog type: \"${String(type)}\".`);\n  }\n}\n\n/**\n * Resolve the current user interface with the given value. This returns a\n * function that can be used to resolve the user interface.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @param value - The value to resolve the user interface with.\n * @returns A function that can be used to resolve the user interface.\n */\nfunction resolveWith(runSaga: RunSagaFunction, value: unknown) {\n  /**\n   * Resolve the current user interface with the given value.\n   *\n   * @yields Puts the resolve user interface action.\n   */\n  function* resolveWithSaga(): SagaIterator {\n    yield put(resolveInterface(value));\n  }\n\n  return async () => {\n    await runSaga(resolveWithSaga).toPromise();\n  };\n}\n\n/**\n * Resolve the current user interface with the provided input. This returns a\n * function that can be used to resolve the user interface.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A function that can be used to resolve the user interface.\n */\nfunction resolveWithInput(runSaga: RunSagaFunction) {\n  /**\n   * Resolve the current user interface with the given value.\n   *\n   * @param value - The value to resolve the user interface with.\n   * @yields Puts the resolve user interface action.\n   */\n  function* resolveWithSaga(value: string): SagaIterator {\n    yield put(resolveInterface(value));\n  }\n\n  return async (value = '') => {\n    await runSaga(resolveWithSaga, value).toPromise();\n  };\n}\n\n/**\n * Get a user interface object from a Snap.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @param snapId - The Snap ID.\n * @param controllerMessenger - The controller messenger used to call actions.\n * @yields Takes the set interface action.\n * @returns The user interface object.\n */\nexport function* getInterface(\n  runSaga: RunSagaFunction,\n  snapId: SnapId,\n  controllerMessenger: RootControllerMessenger,\n): SagaIterator<SnapInterface> {\n  const currentInterface: Interface | null = yield select(getCurrentInterface);\n  if (currentInterface) {\n    const { content } = controllerMessenger.call(\n      'SnapInterfaceController:getInterface',\n      snapId,\n      currentInterface.id,\n    );\n    return getInterfaceResponse(runSaga, currentInterface.type, content);\n  }\n\n  const { payload }: PayloadAction<Interface> = yield take(setInterface.type);\n  const { type, id } = payload;\n\n  const { content } = controllerMessenger.call(\n    'SnapInterfaceController:getInterface',\n    snapId,\n    id,\n  );\n\n  return getInterfaceResponse(runSaga, type, content);\n}\n"],"names":["DialogType","put","select","take","getCurrentInterface","resolveInterface","setInterface","getInterfaceResponse","runSaga","type","content","Alert","ok","resolveWith","Confirmation","cancel","Prompt","resolveWithInput","Error","String","value","resolveWithSaga","toPromise","getInterface","snapId","controllerMessenger","currentInterface","call","id","payload"],"mappings":"AACA,SAASA,UAAU,QAAQ,sBAAsB;AAGjD,SAASC,GAAG,EAAEC,MAAM,EAAEC,IAAI,QAAQ,qBAAqB;AAKvD,SAASC,mBAAmB,EAAEC,gBAAgB,EAAEC,YAAY,QAAQ,UAAU;AAE9E;;;;;;;CAOC,GACD,OAAO,SAASC,qBACdC,OAAwB,EACxBC,IAAgB,EAChBC,OAAkB;IAElB,OAAQD;QACN,KAAKT,WAAWW,KAAK;YACnB,OAAO;gBACLF;gBACAC;gBACAE,IAAIC,YAAYL,SAAS;YAC3B;QAEF,KAAKR,WAAWc,YAAY;YAC1B,OAAO;gBACLL;gBACAC;gBAEAE,IAAIC,YAAYL,SAAS;gBACzBO,QAAQF,YAAYL,SAAS;YAC/B;QAEF,KAAKR,WAAWgB,MAAM;YACpB,OAAO;gBACLP;gBACAC;gBAEAE,IAAIK,iBAAiBT;gBACrBO,QAAQF,YAAYL,SAAS;YAC/B;QAEF;YACE,MAAM,IAAIU,MAAM,CAAC,qCAAqC,EAAEC,OAAOV,MAAM,EAAE,CAAC;IAC5E;AACF;AAEA;;;;;;;CAOC,GACD,SAASI,YAAYL,OAAwB,EAAEY,KAAc;IAC3D;;;;GAIC,GACD,UAAUC;QACR,MAAMpB,IAAII,iBAAiBe;IAC7B;IAEA,OAAO;QACL,MAAMZ,QAAQa,iBAAiBC,SAAS;IAC1C;AACF;AAEA;;;;;;CAMC,GACD,SAASL,iBAAiBT,OAAwB;IAChD;;;;;GAKC,GACD,UAAUa,gBAAgBD,KAAa;QACrC,MAAMnB,IAAII,iBAAiBe;IAC7B;IAEA,OAAO,OAAOA,QAAQ,EAAE;QACtB,MAAMZ,QAAQa,iBAAiBD,OAAOE,SAAS;IACjD;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,UAAUC,aACff,OAAwB,EACxBgB,MAAc,EACdC,mBAA4C;IAE5C,MAAMC,mBAAqC,MAAMxB,OAAOE;IACxD,IAAIsB,kBAAkB;QACpB,MAAM,EAAEhB,OAAO,EAAE,GAAGe,oBAAoBE,IAAI,CAC1C,wCACAH,QACAE,iBAAiBE,EAAE;QAErB,OAAOrB,qBAAqBC,SAASkB,iBAAiBjB,IAAI,EAAEC;IAC9D;IAEA,MAAM,EAAEmB,OAAO,EAAE,GAA6B,MAAM1B,KAAKG,aAAaG,IAAI;IAC1E,MAAM,EAAEA,IAAI,EAAEmB,EAAE,EAAE,GAAGC;IAErB,MAAM,EAAEnB,OAAO,EAAE,GAAGe,oBAAoBE,IAAI,CAC1C,wCACAH,QACAI;IAGF,OAAOrB,qBAAqBC,SAASC,MAAMC;AAC7C"}

package/dist/esm/internals/simulation/methods/constants.js

@@ -0,0 +1,69 @@
+export const EXCLUDED_SNAP_ENDOWMENTS = [];
+export const EXCLUDED_SNAP_PERMISSIONS = [];
+/**
+ * All unrestricted methods recognized by the `PermissionController`.
+ * Unrestricted methods are ignored by the permission system, but every
+ * JSON-RPC request seen by the permission system must correspond to a
+ * restricted or unrestricted method, or the request will be rejected with a
+ * "method not found" error.
+ */ export const UNRESTRICTED_METHODS = Object.freeze([
+    'eth_blockNumber',
+    'eth_call',
+    'eth_chainId',
+    'eth_coinbase',
+    'eth_decrypt',
+    'eth_estimateGas',
+    'eth_feeHistory',
+    'eth_gasPrice',
+    'eth_getBalance',
+    'eth_getBlockByHash',
+    'eth_getBlockByNumber',
+    'eth_getBlockTransactionCountByHash',
+    'eth_getBlockTransactionCountByNumber',
+    'eth_getCode',
+    'eth_getEncryptionPublicKey',
+    'eth_getFilterChanges',
+    'eth_getFilterLogs',
+    'eth_getLogs',
+    'eth_getProof',
+    'eth_getStorageAt',
+    'eth_getTransactionByBlockHashAndIndex',
+    'eth_getTransactionByBlockNumberAndIndex',
+    'eth_getTransactionByHash',
+    'eth_getTransactionCount',
+    'eth_getTransactionReceipt',
+    'eth_getUncleByBlockHashAndIndex',
+    'eth_getUncleByBlockNumberAndIndex',
+    'eth_getUncleCountByBlockHash',
+    'eth_getUncleCountByBlockNumber',
+    'eth_getWork',
+    'eth_hashrate',
+    'eth_mining',
+    'eth_newBlockFilter',
+    'eth_newFilter',
+    'eth_newPendingTransactionFilter',
+    'eth_protocolVersion',
+    'eth_sendRawTransaction',
+    'eth_sendTransaction',
+    'eth_sign',
+    'eth_signTypedData',
+    'eth_signTypedData_v1',
+    'eth_signTypedData_v3',
+    'eth_signTypedData_v4',
+    'eth_submitHashrate',
+    'eth_submitWork',
+    'eth_syncing',
+    'eth_uninstallFilter',
+    'metamask_getProviderState',
+    'metamask_watchAsset',
+    'net_listening',
+    'net_peerCount',
+    'net_version',
+    'personal_ecRecover',
+    'personal_sign',
+    'wallet_watchAsset',
+    'web3_clientVersion',
+    'web3_sha3'
+]);
+
+//# sourceMappingURL=constants.js.map