@metamask/snaps-execution-environments 3.4.3 → 4.0.0

package/dist/esm/proxy/ProxySnapExecutor.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/proxy/ProxySnapExecutor.ts"],"sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { WindowPostMessageStream } from '@metamask/post-message-stream';\n// eslint-disable-next-line import/no-extraneous-dependencies\nimport packageJson from '@metamask/snaps-execution-environments/package.json';\nimport { createWindow, logError } from '@metamask/snaps-utils';\nimport type { JsonRpcRequest } from '@metamask/utils';\nimport { assert } from '@metamask/utils';\n\ntype ExecutorJob = {\n  id: string;\n  window: Window;\n  stream: WindowPostMessageStream;\n};\n\nconst IFRAME_URL = `https://execution.metamask.io/iframe/${packageJson.version}/index.html`;\n\n/**\n * A \"proxy\" snap executor that uses a level of indirection to execute snaps.\n *\n * Useful for multiple execution environments.\n *\n * This is not a traditional snap executor, as it does not execute snaps itself.\n * Instead, it creates an iframe window for each snap execution, and sends the\n * snap execution request to the iframe window. The iframe window is responsible\n * for executing the snap.\n *\n * This executor is persisted between snap executions. The executor essentially\n * acts as a proxy between the client and the iframe execution environment.\n */\nexport class ProxySnapExecutor {\n  readonly #stream: BasePostMessageStream;\n\n  readonly #frameUrl: string;\n\n  readonly jobs: Record<string, ExecutorJob> = {};\n\n  /**\n   * Initialize the executor with the given stream. This is a wrapper around the\n   * constructor.\n   *\n   * @param stream - The stream to use for communication.\n   * @param frameUrl - An optional URL for the iframe to use.\n   * @returns The initialized executor.\n   */\n  static initialize(stream: BasePostMessageStream, frameUrl = IFRAME_URL) {\n    return new ProxySnapExecutor(stream, frameUrl);\n  }\n\n  constructor(stream: BasePostMessageStream, frameUrl: string) {\n    this.#stream = stream;\n    this.#stream.on('data', this.#onData.bind(this));\n    this.#frameUrl = frameUrl;\n  }\n\n  /**\n   * Handle an incoming message from a `ProxyExecutionService`. This\n   * assumes that the message contains a `jobId` property, and a JSON-RPC\n   * request in the `data` property.\n   *\n   * @param data - The message data.\n   * @param data.data - The JSON-RPC request.\n   * @param data.jobId - The job ID.\n   */\n  #onData(data: { data: JsonRpcRequest; jobId: string }) {\n    const { jobId, data: request } = data;\n\n    if (!this.jobs[jobId]) {\n      // This ensures that a job is initialized before it is used. To avoid\n      // code duplication, we call the `#onData` method again, which will\n      // run the rest of the logic after initialization.\n      this.#initializeJob(jobId)\n        .then(() => {\n          this.#onData(data);\n        })\n        .catch((error) => {\n          logError('[Worker] Error initializing job:', error);\n        });\n\n      return;\n    }\n\n    // This is a method specific to the `OffscreenSnapExecutor`, as the service\n    // itself does not have access to the iframes directly.\n    if (request.method === 'terminateJob') {\n      this.#terminateJob(jobId);\n      return;\n    }\n\n    this.jobs[jobId].stream.write(request);\n  }\n\n  /**\n   * Create a new iframe and set up a stream to communicate with it.\n   *\n   * @param jobId - The job ID.\n   */\n  async #initializeJob(jobId: string): Promise<ExecutorJob> {\n    const window = await createWindow(this.#frameUrl, jobId);\n    const jobStream = new WindowPostMessageStream({\n      name: 'parent',\n      target: 'child',\n      targetWindow: window, // iframe's internal window\n      targetOrigin: '*',\n    });\n\n    // Write messages from the iframe to the parent, wrapped with the job ID.\n    jobStream.on('data', (data) => {\n      this.#stream.write({ data, jobId });\n    });\n\n    this.jobs[jobId] = { id: jobId, window, stream: jobStream };\n    return this.jobs[jobId];\n  }\n\n  /**\n   * Terminate the job with the given ID. This will close the iframe and delete\n   * the job from the internal job map.\n   *\n   * @param jobId - The job ID.\n   */\n  #terminateJob(jobId: string) {\n    assert(this.jobs[jobId], `Job \"${jobId}\" not found.`);\n\n    const iframe = document.getElementById(jobId);\n    assert(iframe, `Iframe with ID \"${jobId}\" not found.`);\n\n    iframe.remove();\n    this.jobs[jobId].stream.destroy();\n    delete this.jobs[jobId];\n  }\n}\n"],"names":["WindowPostMessageStream","packageJson","createWindow","logError","assert","IFRAME_URL","version","ProxySnapExecutor","initialize","stream","frameUrl","constructor","jobs","on","onData","bind","data","jobId","request","initializeJob","then","catch","error","method","terminateJob","write","window","jobStream","name","target","targetWindow","targetOrigin","id","iframe","document","getElementById","remove","destroy"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,SAASA,uBAAuB,QAAQ,gCAAgC;AACxE,6DAA6D;AAC7D,OAAOC,iBAAiB,sDAAsD;AAC9E,SAASC,YAAY,EAAEC,QAAQ,QAAQ,wBAAwB;AAE/D,SAASC,MAAM,QAAQ,kBAAkB;AAQzC,MAAMC,aAAa,CAAC,qCAAqC,EAAEJ,YAAYK,OAAO,CAAC,WAAW,CAAC;IAgBhF,uCAEA,yCAsBT;;;;;;;;GAQC,GACD,uCAiCM,8CAkBN;;;;;GAKC,GACD;AAxGF;;;;;;;;;;;;CAYC,GACD,OAAO,MAAMC;IAOX;;;;;;;GAOC,GACD,OAAOC,WAAWC,MAA6B,EAAEC,WAAWL,UAAU,EAAE;QACtE,OAAO,IAAIE,kBAAkBE,QAAQC;IACvC;IAEAC,YAAYF,MAA6B,EAAEC,QAAgB,CAAE;QAe7D,iCAAA;QA4BA;;;;GAIC,GACD,iCAAM;QAwBN,iCAAA;QA1FA,gCAAS;;mBAAT,KAAA;;QAEA,gCAAS;;mBAAT,KAAA;;QAEA,uBAASE,QAAoC,CAAC;uCAetCH,SAASA;QACf,yBAAA,IAAI,EAAEA,SAAOI,EAAE,CAAC,QAAQ,0BAAA,IAAI,EAAEC,SAAAA,QAAOC,IAAI,CAAC,IAAI;uCACxCL,WAAWA;IACnB;AA8EF;AAnEE,SAAA,OAAQM,IAA6C;IACnD,MAAM,EAAEC,KAAK,EAAED,MAAME,OAAO,EAAE,GAAGF;IAEjC,IAAI,CAAC,IAAI,CAACJ,IAAI,CAACK,MAAM,EAAE;QACrB,qEAAqE;QACrE,mEAAmE;QACnE,kDAAkD;QAClD,0BAAA,IAAI,EAAEE,gBAAAA,oBAAN,IAAI,EAAgBF,OACjBG,IAAI,CAAC;YACJ,0BAAA,IAAI,EAAEN,SAAAA,aAAN,IAAI,EAASE;QACf,GACCK,KAAK,CAAC,CAACC;YACNnB,SAAS,oCAAoCmB;QAC/C;QAEF;IACF;IAEA,2EAA2E;IAC3E,uDAAuD;IACvD,IAAIJ,QAAQK,MAAM,KAAK,gBAAgB;QACrC,0BAAA,IAAI,EAAEC,eAAAA,mBAAN,IAAI,EAAeP;QACnB;IACF;IAEA,IAAI,CAACL,IAAI,CAACK,MAAM,CAACR,MAAM,CAACgB,KAAK,CAACP;AAChC;AAOA,eAAA,cAAqBD,KAAa;IAChC,MAAMS,SAAS,MAAMxB,sCAAa,IAAI,EAAEQ,YAAUO;IAClD,MAAMU,YAAY,IAAI3B,wBAAwB;QAC5C4B,MAAM;QACNC,QAAQ;QACRC,cAAcJ;QACdK,cAAc;IAChB;IAEA,yEAAyE;IACzEJ,UAAUd,EAAE,CAAC,QAAQ,CAACG;QACpB,yBAAA,IAAI,EAAEP,SAAOgB,KAAK,CAAC;YAAET;YAAMC;QAAM;IACnC;IAEA,IAAI,CAACL,IAAI,CAACK,MAAM,GAAG;QAAEe,IAAIf;QAAOS;QAAQjB,QAAQkB;IAAU;IAC1D,OAAO,IAAI,CAACf,IAAI,CAACK,MAAM;AACzB;AAQA,SAAA,aAAcA,KAAa;IACzBb,OAAO,IAAI,CAACQ,IAAI,CAACK,MAAM,EAAE,CAAC,KAAK,EAAEA,MAAM,YAAY,CAAC;IAEpD,MAAMgB,SAASC,SAASC,cAAc,CAAClB;IACvCb,OAAO6B,QAAQ,CAAC,gBAAgB,EAAEhB,MAAM,YAAY,CAAC;IAErDgB,OAAOG,MAAM;IACb,IAAI,CAACxB,IAAI,CAACK,MAAM,CAACR,MAAM,CAAC4B,OAAO;IAC/B,OAAO,IAAI,CAACzB,IAAI,CAACK,MAAM;AACzB"}

package/dist/esm/proxy/index.js

@@ -0,0 +1,3 @@
+export * from './ProxySnapExecutor';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/proxy/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/proxy/index.ts"],"sourcesContent":["export * from './ProxySnapExecutor';\n"],"names":[],"mappings":"AAAA,cAAc,sBAAsB"}

package/dist/esm/webview/WebViewExecutorStream.js

@@ -0,0 +1,111 @@
+function _check_private_redeclaration(obj, privateCollection) {
+    if (privateCollection.has(obj)) {
+        throw new TypeError("Cannot initialize the same private elements twice on an object");
+    }
+}
+function _class_apply_descriptor_get(receiver, descriptor) {
+    if (descriptor.get) {
+        return descriptor.get.call(receiver);
+    }
+    return descriptor.value;
+}
+function _class_apply_descriptor_set(receiver, descriptor, value) {
+    if (descriptor.set) {
+        descriptor.set.call(receiver, value);
+    } else {
+        if (!descriptor.writable) {
+            throw new TypeError("attempted to set read only private field");
+        }
+        descriptor.value = value;
+    }
+}
+function _class_extract_field_descriptor(receiver, privateMap, action) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to " + action + " private field on non-instance");
+    }
+    return privateMap.get(receiver);
+}
+function _class_private_field_get(receiver, privateMap) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
+    return _class_apply_descriptor_get(receiver, descriptor);
+}
+function _class_private_field_init(obj, privateMap, value) {
+    _check_private_redeclaration(obj, privateMap);
+    privateMap.set(obj, value);
+}
+function _class_private_field_set(receiver, privateMap, value) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
+    _class_apply_descriptor_set(receiver, descriptor, value);
+    return value;
+}
+import { BasePostMessageStream } from '@metamask/post-message-stream';
+import { isValidStreamMessage } from '@metamask/post-message-stream/dist/utils';
+import { base64ToBytes, bytesToString } from '@metamask/utils';
+var _name = /*#__PURE__*/ new WeakMap(), _target = /*#__PURE__*/ new WeakMap(), _targetWindow = /*#__PURE__*/ new WeakMap();
+export class WebViewExecutorStream extends BasePostMessageStream {
+    /**
+   * Webview needs to receive strings only on postMessage. That's the main difference between this and the original window post message stream.
+   * Reference: https://github.com/react-native-webview/react-native-webview/blob/master/docs/Guide.md?plain=1#L471
+   */ _postMessage(data) {
+        _class_private_field_get(this, _targetWindow).postMessage(JSON.stringify({
+            target: _class_private_field_get(this, _target),
+            data
+        }));
+    }
+    _onMessage(event) {
+        if (typeof event.data !== 'string') {
+            return;
+        }
+        const bytes = base64ToBytes(event.data);
+        const message = JSON.parse(bytesToString(bytes));
+        // Notice that we don't check targetWindow or targetOrigin here.
+        // This doesn't seem possible to do in RN.
+        if (!isValidStreamMessage(message) || message.target !== _class_private_field_get(this, _name)) {
+            return;
+        }
+        this._onData(message.data);
+    }
+    _destroy() {
+        // This method is already bound.
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        window.removeEventListener('message', this._onMessage, false);
+    }
+    /**
+   * A special post-message-stream to be used by the WebView executor.
+   *
+   * This stream is different in a few ways:
+   * - It expects data to be base64 encoded
+   * - It stringifies the data it posts
+   * - It does less validation of origins
+   *
+   * @param args - Options bag.
+   * @param args.name - The name of the stream. Used to differentiate between
+   * multiple streams sharing the same window object. child:WebView
+   * @param args.target - The name of the stream to exchange messages with. parent:rnside
+   * @param args.targetWindow - The window object of the target stream.
+   */ constructor({ name, target, targetWindow }){
+        super();
+        _class_private_field_init(this, _name, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_init(this, _target, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_init(this, _targetWindow, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_set(this, _name, name);
+        _class_private_field_set(this, _target, target);
+        _class_private_field_set(this, _targetWindow, targetWindow);
+        this._onMessage = this._onMessage.bind(this);
+        // This method is already bound.
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        window.addEventListener('message', this._onMessage, false);
+        this._handshake();
+    }
+}
+
+//# sourceMappingURL=WebViewExecutorStream.js.map

package/dist/esm/webview/WebViewExecutorStream.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/webview/WebViewExecutorStream.ts"],"sourcesContent":["import type { PostMessageEvent } from '@metamask/post-message-stream';\nimport { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { isValidStreamMessage } from '@metamask/post-message-stream/dist/utils';\nimport { base64ToBytes, bytesToString } from '@metamask/utils';\n\ntype WebViewExecutorStreamArgs = {\n  name: string;\n  target: string;\n  targetWindow: Window['ReactNativeWebView'];\n};\n\nexport class WebViewExecutorStream extends BasePostMessageStream {\n  #name;\n\n  #target;\n\n  #targetWindow;\n\n  /**\n   * A special post-message-stream to be used by the WebView executor.\n   *\n   * This stream is different in a few ways:\n   * - It expects data to be base64 encoded\n   * - It stringifies the data it posts\n   * - It does less validation of origins\n   *\n   * @param args - Options bag.\n   * @param args.name - The name of the stream. Used to differentiate between\n   * multiple streams sharing the same window object. child:WebView\n   * @param args.target - The name of the stream to exchange messages with. parent:rnside\n   * @param args.targetWindow - The window object of the target stream.\n   */\n\n  constructor({ name, target, targetWindow }: WebViewExecutorStreamArgs) {\n    super();\n\n    this.#name = name;\n    this.#target = target;\n    this.#targetWindow = targetWindow;\n\n    this._onMessage = this._onMessage.bind(this);\n\n    // This method is already bound.\n    // eslint-disable-next-line @typescript-eslint/unbound-method\n    window.addEventListener('message', this._onMessage as any, false);\n\n    this._handshake();\n  }\n\n  /**\n   * Webview needs to receive strings only on postMessage. That's the main difference between this and the original window post message stream.\n   * Reference: https://github.com/react-native-webview/react-native-webview/blob/master/docs/Guide.md?plain=1#L471\n   */\n\n  protected _postMessage(data: unknown): void {\n    this.#targetWindow.postMessage(\n      JSON.stringify({\n        target: this.#target,\n        data,\n      }),\n    );\n  }\n\n  private _onMessage(event: PostMessageEvent): void {\n    if (typeof event.data !== 'string') {\n      return;\n    }\n\n    const bytes = base64ToBytes(event.data);\n    const message = JSON.parse(bytesToString(bytes));\n\n    // Notice that we don't check targetWindow or targetOrigin here.\n    // This doesn't seem possible to do in RN.\n    if (!isValidStreamMessage(message) || message.target !== this.#name) {\n      return;\n    }\n\n    this._onData(message.data);\n  }\n\n  _destroy() {\n    // This method is already bound.\n    // eslint-disable-next-line @typescript-eslint/unbound-method\n    window.removeEventListener('message', this._onMessage as any, false);\n  }\n}\n"],"names":["BasePostMessageStream","isValidStreamMessage","base64ToBytes","bytesToString","WebViewExecutorStream","_postMessage","data","targetWindow","postMessage","JSON","stringify","target","_onMessage","event","bytes","message","parse","name","_onData","_destroy","window","removeEventListener","constructor","bind","addEventListener","_handshake"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,SAASA,qBAAqB,QAAQ,gCAAgC;AACtE,SAASC,oBAAoB,QAAQ,2CAA2C;AAChF,SAASC,aAAa,EAAEC,aAAa,QAAQ,kBAAkB;IAS7D,qCAEA,uCAEA;AALF,OAAO,MAAMC,8BAA8BJ;IAsCzC;;;GAGC,GAED,AAAUK,aAAaC,IAAa,EAAQ;QAC1C,yBAAA,IAAI,EAAEC,eAAaC,WAAW,CAC5BC,KAAKC,SAAS,CAAC;YACbC,MAAM,2BAAE,IAAI,EAAEA;YACdL;QACF;IAEJ;IAEQM,WAAWC,KAAuB,EAAQ;QAChD,IAAI,OAAOA,MAAMP,IAAI,KAAK,UAAU;YAClC;QACF;QAEA,MAAMQ,QAAQZ,cAAcW,MAAMP,IAAI;QACtC,MAAMS,UAAUN,KAAKO,KAAK,CAACb,cAAcW;QAEzC,gEAAgE;QAChE,0CAA0C;QAC1C,IAAI,CAACb,qBAAqBc,YAAYA,QAAQJ,MAAM,8BAAK,IAAI,EAAEM,QAAM;YACnE;QACF;QAEA,IAAI,CAACC,OAAO,CAACH,QAAQT,IAAI;IAC3B;IAEAa,WAAW;QACT,gCAAgC;QAChC,6DAA6D;QAC7DC,OAAOC,mBAAmB,CAAC,WAAW,IAAI,CAACT,UAAU,EAAS;IAChE;IAlEA;;;;;;;;;;;;;GAaC,GAEDU,YAAY,EAAEL,IAAI,EAAEN,MAAM,EAAEJ,YAAY,EAA6B,CAAE;QACrE,KAAK;QAtBP,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;uCAoBQU,OAAOA;uCACPN,SAASA;uCACTJ,eAAeA;QAErB,IAAI,CAACK,UAAU,GAAG,IAAI,CAACA,UAAU,CAACW,IAAI,CAAC,IAAI;QAE3C,gCAAgC;QAChC,6DAA6D;QAC7DH,OAAOI,gBAAgB,CAAC,WAAW,IAAI,CAACZ,UAAU,EAAS;QAE3D,IAAI,CAACa,UAAU;IACjB;AAsCF"}

package/dist/esm/webview/index.js

@@ -0,0 +1,15 @@
+import { executeLockdownEvents } from '../common/lockdown/lockdown-events';
+import { executeLockdownMore } from '../common/lockdown/lockdown-more';
+import { ProxySnapExecutor } from '../proxy/ProxySnapExecutor';
+import { WebViewExecutorStream } from './WebViewExecutorStream';
+// Lockdown is already applied in LavaMoat
+executeLockdownMore();
+executeLockdownEvents();
+const parentStream = new WebViewExecutorStream({
+    name: 'child',
+    target: 'parent',
+    targetWindow: window.ReactNativeWebView
+});
+ProxySnapExecutor.initialize(parentStream);
+
+//# sourceMappingURL=index.js.map

package/dist/esm/webview/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/webview/index.ts"],"sourcesContent":["import { executeLockdownEvents } from '../common/lockdown/lockdown-events';\nimport { executeLockdownMore } from '../common/lockdown/lockdown-more';\nimport { ProxySnapExecutor } from '../proxy/ProxySnapExecutor';\nimport { WebViewExecutorStream } from './WebViewExecutorStream';\n\n// Lockdown is already applied in LavaMoat\nexecuteLockdownMore();\nexecuteLockdownEvents();\n\nconst parentStream = new WebViewExecutorStream({\n  name: 'child', // webview\n  target: 'parent', // rnside\n  targetWindow: window.ReactNativeWebView,\n});\n\nProxySnapExecutor.initialize(parentStream);\n"],"names":["executeLockdownEvents","executeLockdownMore","ProxySnapExecutor","WebViewExecutorStream","parentStream","name","target","targetWindow","window","ReactNativeWebView","initialize"],"mappings":"AAAA,SAASA,qBAAqB,QAAQ,qCAAqC;AAC3E,SAASC,mBAAmB,QAAQ,mCAAmC;AACvE,SAASC,iBAAiB,QAAQ,6BAA6B;AAC/D,SAASC,qBAAqB,QAAQ,0BAA0B;AAEhE,0CAA0C;AAC1CF;AACAD;AAEA,MAAMI,eAAe,IAAID,sBAAsB;IAC7CE,MAAM;IACNC,QAAQ;IACRC,cAAcC,OAAOC,kBAAkB;AACzC;AAEAP,kBAAkBQ,UAAU,CAACN"}

package/dist/types/common/validation.d.ts

@@ -62,6 +62,23 @@ export declare type OnTransactionRequestArguments = Infer<typeof OnTransactionRe
  * object.
  */
 export declare function assertIsOnTransactionRequestArguments(value: unknown): asserts value is OnTransactionRequestArguments;
+export declare const OnSignatureRequestArgumentsStruct: import("superstruct").Struct<{
+    signature: Record<string, Json>;
+    signatureOrigin: string | null;
+}, {
+    signature: import("superstruct").Struct<Record<string, Json>, null>;
+    signatureOrigin: import("superstruct").Struct<string | null, null>;
+}>;
+export declare type OnSignatureRequestArguments = Infer<typeof OnSignatureRequestArgumentsStruct>;
+/**
+ * Asserts that the given value is a valid {@link OnSignatureRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnSignatureRequestArguments}
+ * object.
+ */
+export declare function assertIsOnSignatureRequestArguments(value: unknown): asserts value is OnSignatureRequestArguments;
 declare const baseNameLookupArgs: {
     chainId: import("superstruct").Struct<`${string}:${string}`, null>;
 };
@@ -86,6 +103,37 @@ export declare type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {
  * object.
  */
 export declare function assertIsOnNameLookupRequestArguments(value: unknown): asserts value is OnNameLookupRequestArguments;
+export declare const OnUserInputArgumentsStruct: import("superstruct").Struct<{
+    id: string;
+    event: {
+        type: import("@metamask/snaps-sdk").UserInputEventType.ButtonClickEvent;
+        name?: string | undefined;
+    } | {
+        value: Record<string, string>;
+        type: import("@metamask/snaps-sdk").UserInputEventType.FormSubmitEvent;
+        name: string;
+    };
+}, {
+    id: import("superstruct").Struct<string, null>;
+    event: import("superstruct").Struct<{
+        type: import("@metamask/snaps-sdk").UserInputEventType.ButtonClickEvent;
+        name?: string | undefined;
+    } | {
+        value: Record<string, string>;
+        type: import("@metamask/snaps-sdk").UserInputEventType.FormSubmitEvent;
+        name: string;
+    }, null>;
+}>;
+export declare type OnUserInputArguments = Infer<typeof OnUserInputArgumentsStruct>;
+/**
+ * Asserts that the given value is a valid {@link OnUserInputArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnUserInputArguments}
+ * object.
+ */
+export declare function assertIsOnUserInputRequestArguments(value: unknown): asserts value is OnUserInputArguments;
 declare const OkResponseStruct: import("superstruct").Struct<{
     result: "OK";
     id: string | number | null;

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './proxy';

package/dist/types/{offscreen/OffscreenSnapExecutor.d.ts → proxy/ProxySnapExecutor.d.ts}

@@ -6,20 +6,19 @@ declare type ExecutorJob = {
     stream: WindowPostMessageStream;
 };
 /**
- * A snap executor using the Offscreen Documents API.
+ * A "proxy" snap executor that uses a level of indirection to execute snaps.
+ *
+ * Useful for multiple execution environments.
  *
  * This is not a traditional snap executor, as it does not execute snaps itself.
  * Instead, it creates an iframe window for each snap execution, and sends the
  * snap execution request to the iframe window. The iframe window is responsible
  * for executing the snap.
  *
- * Extensions can only have a single offscreen document, so this executor is
- * persisted between snap executions. The offscreen snap executor essentially
- * acts as a proxy between the extension and the iframe execution environment.
- *
- * @see https://developer.chrome.com/docs/extensions/reference/offscreen/
+ * This executor is persisted between snap executions. The executor essentially
+ * acts as a proxy between the client and the iframe execution environment.
  */
-export declare class OffscreenSnapExecutor {
+export declare class ProxySnapExecutor {
     #private;
     readonly jobs: Record<string, ExecutorJob>;
     /**
@@ -27,9 +26,10 @@ export declare class OffscreenSnapExecutor {
      * constructor.
      *
      * @param stream - The stream to use for communication.
+     * @param frameUrl - An optional URL for the iframe to use.
      * @returns The initialized executor.
      */
-    static initialize(stream: BasePostMessageStream): OffscreenSnapExecutor;
-    constructor(stream: BasePostMessageStream);
+    static initialize(stream: BasePostMessageStream, frameUrl?: string): ProxySnapExecutor;
+    constructor(stream: BasePostMessageStream, frameUrl: string);
 }
 export {};

package/dist/types/proxy/index.d.ts

@@ -0,0 +1 @@
+export * from './ProxySnapExecutor';

package/dist/types/webview/WebViewExecutorStream.d.ts

@@ -0,0 +1,32 @@
+import { BasePostMessageStream } from '@metamask/post-message-stream';
+declare type WebViewExecutorStreamArgs = {
+    name: string;
+    target: string;
+    targetWindow: Window['ReactNativeWebView'];
+};
+export declare class WebViewExecutorStream extends BasePostMessageStream {
+    #private;
+    /**
+     * A special post-message-stream to be used by the WebView executor.
+     *
+     * This stream is different in a few ways:
+     * - It expects data to be base64 encoded
+     * - It stringifies the data it posts
+     * - It does less validation of origins
+     *
+     * @param args - Options bag.
+     * @param args.name - The name of the stream. Used to differentiate between
+     * multiple streams sharing the same window object. child:WebView
+     * @param args.target - The name of the stream to exchange messages with. parent:rnside
+     * @param args.targetWindow - The window object of the target stream.
+     */
+    constructor({ name, target, targetWindow }: WebViewExecutorStreamArgs);
+    /**
+     * Webview needs to receive strings only on postMessage. That's the main difference between this and the original window post message stream.
+     * Reference: https://github.com/react-native-webview/react-native-webview/blob/master/docs/Guide.md?plain=1#L471
+     */
+    protected _postMessage(data: unknown): void;
+    private _onMessage;
+    _destroy(): void;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-execution-environments",
-  "version": "3.4.3",
+  "version": "4.0.0",
   "description": "Snap sandbox environments for executing SES javascript",
   "repository": {
     "type": "git",
@@ -44,14 +44,14 @@
     "lint:dependencies": "depcheck"
   },
   "dependencies": {
-    "@metamask/json-rpc-engine": "^7.3.1",
+    "@metamask/json-rpc-engine": "^7.3.2",
     "@metamask/object-multiplex": "^2.0.0",
-    "@metamask/post-message-stream": "^7.0.0",
+    "@metamask/post-message-stream": "^8.0.0",
     "@metamask/providers": "^14.0.2",
     "@metamask/rpc-errors": "^6.1.0",
-    "@metamask/snaps-sdk": "^1.3.1",
-    "@metamask/snaps-utils": "^5.1.1",
-    "@metamask/utils": "^8.2.1",
+    "@metamask/snaps-sdk": "^2.0.0",
+    "@metamask/snaps-utils": "^6.0.0",
+    "@metamask/utils": "^8.3.0",
     "nanoid": "^3.1.31",
     "readable-stream": "^3.6.2",
     "superstruct": "^1.0.3"
@@ -62,10 +62,10 @@
     "@babel/preset-typescript": "^7.23.2",
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
-    "@lavamoat/allow-scripts": "^2.5.1",
-    "@lavamoat/lavapack": "^5.4.1",
-    "@lavamoat/lavatube": "^0.2.3",
-    "@metamask/auto-changelog": "^3.4.3",
+    "@lavamoat/allow-scripts": "^3.0.0",
+    "@lavamoat/lavapack": "^6.0.2",
+    "@lavamoat/lavatube": "^1.0.0",
+    "@metamask/auto-changelog": "^3.4.4",
     "@metamask/eslint-config": "^12.1.0",
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",
@@ -105,13 +105,13 @@
     "jest": "^29.0.2",
     "jest-environment-node": "^29.5.0",
     "jest-fetch-mock": "^3.0.3",
-    "lavamoat": "^7.3.1",
-    "lavamoat-browserify": "^15.9.1",
+    "lavamoat": "^8.0.2",
+    "lavamoat-browserify": "^17.0.2",
     "prettier": "^2.7.1",
     "prettier-plugin-packagejson": "^2.2.11",
     "rimraf": "^4.1.2",
     "serve-handler": "^6.1.5",
-    "ses": "^0.18.8",
+    "ses": "^1.1.0",
     "terser": "^5.17.7",
     "ts-node": "^10.9.1",
     "typescript": "~4.8.4",