@metamask/snaps-controllers 5.0.1 → 6.0.1

package/dist/chunk-IGC4E7PI.mjs

@@ -0,0 +1,71 @@
+import {
+  __privateAdd,
+  __privateGet,
+  __privateSet
+} from "./chunk-YRZVIDCF.mjs";
+
+// src/services/webview/WebViewMessageStream.ts
+import { BasePostMessageStream } from "@metamask/post-message-stream";
+import { isValidStreamMessage } from "@metamask/post-message-stream/dist/utils";
+import { logError } from "@metamask/snaps-utils";
+import { assert, bytesToBase64, stringToBytes } from "@metamask/utils";
+var _name, _target, _webView;
+var WebViewMessageStream = class extends BasePostMessageStream {
+  /**
+   * Creates a stream for communicating with other streams inside a WebView.
+   *
+   * @param args - Options bag.
+   * @param args.name - The name of the stream. Used to differentiate between
+   * multiple streams sharing the same window object.
+   * @param args.target - The name of the stream to exchange messages with.
+   * @param args.getWebView - A asynchronous getter for the webview.
+   */
+  constructor({ name, target, getWebView }) {
+    super();
+    __privateAdd(this, _name, void 0);
+    __privateAdd(this, _target, void 0);
+    __privateAdd(this, _webView, void 0);
+    __privateSet(this, _name, name);
+    __privateSet(this, _target, target);
+    this._onMessage = this._onMessage.bind(this);
+    getWebView().then((webView) => {
+      __privateSet(this, _webView, webView);
+      webView.registerMessageListener(this._onMessage);
+      this._handshake();
+    }).catch((error) => {
+      logError(error);
+    });
+  }
+  _postMessage(data) {
+    assert(__privateGet(this, _webView));
+    const json = JSON.stringify({
+      target: __privateGet(this, _target),
+      data
+    });
+    const bytes = stringToBytes(json);
+    const base64 = bytesToBase64(bytes);
+    __privateGet(this, _webView).injectJavaScript(`window.postMessage('${base64}')`);
+  }
+  _onMessage(event) {
+    if (typeof event.data !== "string") {
+      return;
+    }
+    const message = JSON.parse(event.data);
+    if (!isValidStreamMessage(message) || message.target !== __privateGet(this, _name)) {
+      return;
+    }
+    this._onData(message.data);
+  }
+  _destroy() {
+    assert(__privateGet(this, _webView));
+    __privateGet(this, _webView).unregisterMessageListener(this._onMessage);
+  }
+};
+_name = new WeakMap();
+_target = new WeakMap();
+_webView = new WeakMap();
+
+export {
+  WebViewMessageStream
+};
+//# sourceMappingURL=chunk-IGC4E7PI.mjs.map

package/dist/chunk-IGC4E7PI.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/services/webview/WebViewMessageStream.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 { logError } from '@metamask/snaps-utils';\nimport { assert, bytesToBase64, stringToBytes } from '@metamask/utils';\n\nexport type WebViewInterface = {\n  injectJavaScript(js: string): void;\n  registerMessageListener(listener: (event: PostMessageEvent) => void): void;\n  unregisterMessageListener(listener: (event: PostMessageEvent) => void): void;\n};\n\ntype WebViewStreamArgs = {\n  name: string;\n  target: string;\n  getWebView: () => Promise<WebViewInterface>;\n};\n\n/**\n * A special postMessage stream used to interface with a WebView.\n */\n\nexport class WebViewMessageStream extends BasePostMessageStream {\n  #name;\n\n  #target;\n\n  #webView: WebViewInterface | undefined;\n\n  /**\n   * Creates a stream for communicating with other streams inside a WebView.\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.\n   * @param args.target - The name of the stream to exchange messages with.\n   * @param args.getWebView - A asynchronous getter for the webview.\n   */\n  constructor({ name, target, getWebView }: WebViewStreamArgs) {\n    super();\n\n    this.#name = name;\n    this.#target = target;\n\n    this._onMessage = this._onMessage.bind(this);\n\n    // This is a bit atypical from other post-message streams.\n    // We have to wait for the WebView to fully load before we can continue using the stream.\n    getWebView()\n      .then((webView) => {\n        this.#webView = webView;\n        // This method is already bound.\n        // eslint-disable-next-line @typescript-eslint/unbound-method\n        webView.registerMessageListener(this._onMessage);\n        this._handshake();\n      })\n      .catch((error) => {\n        logError(error);\n      });\n  }\n\n  protected _postMessage(data: unknown): void {\n    assert(this.#webView);\n    const json = JSON.stringify({\n      target: this.#target,\n      data,\n    });\n\n    // To prevent XSS, we base64 encode the message before injecting it.\n    // This adds significant performance overhead.\n    // TODO: Should we use mobile native base64 here?\n    const bytes = stringToBytes(json);\n    const base64 = bytesToBase64(bytes);\n    this.#webView.injectJavaScript(`window.postMessage('${base64}')`);\n  }\n\n  private _onMessage(event: PostMessageEvent): void {\n    if (typeof event.data !== 'string') {\n      return;\n    }\n\n    const message = JSON.parse(event.data);\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    assert(this.#webView);\n    // This method is already bound.\n    // eslint-disable-next-line @typescript-eslint/unbound-method\n    this.#webView.unregisterMessageListener(this._onMessage);\n  }\n}\n"],"mappings":";;;;;;;AACA,SAAS,6BAA6B;AACtC,SAAS,4BAA4B;AACrC,SAAS,gBAAgB;AACzB,SAAS,QAAQ,eAAe,qBAAqB;AAJrD;AAsBO,IAAM,uBAAN,cAAmC,sBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgB9D,YAAY,EAAE,MAAM,QAAQ,WAAW,GAAsB;AAC3D,UAAM;AAhBR;AAEA;AAEA;AAcE,uBAAK,OAAQ;AACb,uBAAK,SAAU;AAEf,SAAK,aAAa,KAAK,WAAW,KAAK,IAAI;AAI3C,eAAW,EACR,KAAK,CAAC,YAAY;AACjB,yBAAK,UAAW;AAGhB,cAAQ,wBAAwB,KAAK,UAAU;AAC/C,WAAK,WAAW;AAAA,IAClB,CAAC,EACA,MAAM,CAAC,UAAU;AAChB,eAAS,KAAK;AAAA,IAChB,CAAC;AAAA,EACL;AAAA,EAEU,aAAa,MAAqB;AAC1C,WAAO,mBAAK,SAAQ;AACpB,UAAM,OAAO,KAAK,UAAU;AAAA,MAC1B,QAAQ,mBAAK;AAAA,MACb;AAAA,IACF,CAAC;AAKD,UAAM,QAAQ,cAAc,IAAI;AAChC,UAAM,SAAS,cAAc,KAAK;AAClC,uBAAK,UAAS,iBAAiB,uBAAuB,MAAM,IAAI;AAAA,EAClE;AAAA,EAEQ,WAAW,OAA+B;AAChD,QAAI,OAAO,MAAM,SAAS,UAAU;AAClC;AAAA,IACF;AAEA,UAAM,UAAU,KAAK,MAAM,MAAM,IAAI;AAIrC,QAAI,CAAC,qBAAqB,OAAO,KAAK,QAAQ,WAAW,mBAAK,QAAO;AACnE;AAAA,IACF;AAEA,SAAK,QAAQ,QAAQ,IAAI;AAAA,EAC3B;AAAA,EAEA,WAAW;AACT,WAAO,mBAAK,SAAQ;AAGpB,uBAAK,UAAS,0BAA0B,KAAK,UAAU;AAAA,EACzD;AACF;AA3EE;AAEA;AAEA;","names":[]}

package/dist/chunk-IMBPDTVN.mjs

@@ -0,0 +1,72 @@
+import {
+  ProxyExecutionService
+} from "./chunk-KF4PCKG7.mjs";
+import {
+  __privateAdd,
+  __privateMethod
+} from "./chunk-YRZVIDCF.mjs";
+
+// src/services/offscreen/OffscreenExecutionService.ts
+import { BrowserRuntimePostMessageStream } from "@metamask/post-message-stream";
+var _createDocument, createDocument_fn;
+var OffscreenExecutionService = class extends ProxyExecutionService {
+  /**
+   * Create a new offscreen execution service.
+   *
+   * @param args - The constructor arguments.
+   * @param args.documentUrl - The URL of the offscreen document to use as the
+   * execution environment. This must be a URL relative to the location where
+   * this is called. This cannot be a public (http(s)) URL.
+   * @param args.messenger - The messenger to use for communication with the
+   * `SnapController`.
+   * @param args.setupSnapProvider - The function to use to set up the snap
+   * provider.
+   */
+  constructor({
+    documentUrl,
+    messenger,
+    setupSnapProvider
+  }) {
+    super({
+      messenger,
+      setupSnapProvider,
+      stream: new BrowserRuntimePostMessageStream({
+        name: "parent",
+        target: "child"
+      })
+    });
+    /**
+     * Creates the offscreen document to be used as the execution environment.
+     *
+     * If the document already exists, this does nothing.
+     */
+    __privateAdd(this, _createDocument);
+    this.documentUrl = documentUrl;
+  }
+  /**
+   * Create a new stream for the specified job. This wraps the runtime stream
+   * in a stream specific to the job.
+   *
+   * @param jobId - The job ID.
+   */
+  async initEnvStream(jobId) {
+    await __privateMethod(this, _createDocument, createDocument_fn).call(this);
+    return super.initEnvStream(jobId);
+  }
+};
+_createDocument = new WeakSet();
+createDocument_fn = async function() {
+  if (await chrome.offscreen.hasDocument()) {
+    return;
+  }
+  await chrome.offscreen.createDocument({
+    justification: "MetaMask Snaps Execution Environment",
+    reasons: ["IFRAME_SCRIPTING"],
+    url: this.documentUrl.toString()
+  });
+};
+
+export {
+  OffscreenExecutionService
+};
+//# sourceMappingURL=chunk-IMBPDTVN.mjs.map

package/dist/chunk-IMBPDTVN.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/services/offscreen/OffscreenExecutionService.ts"],"sourcesContent":["import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream';\n\nimport type { ExecutionServiceArgs } from '../AbstractExecutionService';\nimport { ProxyExecutionService } from '../proxy/ProxyExecutionService';\n\ntype OffscreenExecutionEnvironmentServiceArgs = {\n  documentUrl: URL;\n} & ExecutionServiceArgs;\n\nexport class OffscreenExecutionService extends ProxyExecutionService {\n  public readonly documentUrl: URL;\n\n  /**\n   * Create a new offscreen execution service.\n   *\n   * @param args - The constructor arguments.\n   * @param args.documentUrl - The URL of the offscreen document to use as the\n   * execution environment. This must be a URL relative to the location where\n   * this is called. This cannot be a public (http(s)) URL.\n   * @param args.messenger - The messenger to use for communication with the\n   * `SnapController`.\n   * @param args.setupSnapProvider - The function to use to set up the snap\n   * provider.\n   */\n  constructor({\n    documentUrl,\n    messenger,\n    setupSnapProvider,\n  }: OffscreenExecutionEnvironmentServiceArgs) {\n    super({\n      messenger,\n      setupSnapProvider,\n      stream: new BrowserRuntimePostMessageStream({\n        name: 'parent',\n        target: 'child',\n      }),\n    });\n\n    this.documentUrl = documentUrl;\n  }\n\n  /**\n   * Create a new stream for the specified job. This wraps the runtime stream\n   * in a stream specific to the job.\n   *\n   * @param jobId - The job ID.\n   */\n  protected async initEnvStream(jobId: string) {\n    // Lazily create the offscreen document.\n    await this.#createDocument();\n\n    return super.initEnvStream(jobId);\n  }\n\n  /**\n   * Creates the offscreen document to be used as the execution environment.\n   *\n   * If the document already exists, this does nothing.\n   */\n  async #createDocument() {\n    // Extensions can only have a single offscreen document.\n    if (await chrome.offscreen.hasDocument()) {\n      return;\n    }\n\n    await chrome.offscreen.createDocument({\n      justification: 'MetaMask Snaps Execution Environment',\n      reasons: ['IFRAME_SCRIPTING' as chrome.offscreen.Reason],\n      url: this.documentUrl.toString(),\n    });\n  }\n}\n"],"mappings":";;;;;;;;;AAAA,SAAS,uCAAuC;AAAhD;AASO,IAAM,4BAAN,cAAwC,sBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAenE,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAA6C;AAC3C,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA,QAAQ,IAAI,gCAAgC;AAAA,QAC1C,MAAM;AAAA,QACN,QAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAuBH;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AArBJ,SAAK,cAAc;AAAA,EACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAgB,cAAc,OAAe;AAE3C,UAAM,sBAAK,oCAAL;AAEN,WAAO,MAAM,cAAc,KAAK;AAAA,EAClC;AAmBF;AAZQ;AAAA,oBAAe,iBAAG;AAEtB,MAAI,MAAM,OAAO,UAAU,YAAY,GAAG;AACxC;AAAA,EACF;AAEA,QAAM,OAAO,UAAU,eAAe;AAAA,IACpC,eAAe;AAAA,IACf,SAAS,CAAC,kBAA6C;AAAA,IACvD,KAAK,KAAK,YAAY,SAAS;AAAA,EACjC,CAAC;AACH;","names":[]}

package/dist/chunk-J4PGHMLL.js

@@ -0,0 +1,38 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkJDHKH5YUjs = require('./chunk-JDHKH5YU.js');
+
+
+var _chunkEXN2TFDJjs = require('./chunk-EXN2TFDJ.js');
+
+// src/services/node-js/NodeProcessExecutionService.ts
+var _postmessagestream = require('@metamask/post-message-stream');
+var _child_process = require('child_process');
+var NodeProcessExecutionService = class extends _chunkJDHKH5YUjs.AbstractExecutionService {
+  async initEnvStream() {
+    const worker = _child_process.fork.call(void 0, 
+      _chunkEXN2TFDJjs.__require.resolve(
+        "@metamask/snaps-execution-environments/dist/browserify/node-process/bundle.js"
+      ),
+      {
+        stdio: "pipe"
+      }
+    );
+    worker.stdout?.on("data", (data) => {
+      console.log(data.toString());
+    });
+    worker.stderr?.on("data", (data) => {
+      console.error(data.toString());
+    });
+    const stream = new (0, _postmessagestream.ProcessParentMessageStream)({ process: worker });
+    return Promise.resolve({ worker, stream });
+  }
+  terminateJob(jobWrapper) {
+    jobWrapper.worker.kill();
+  }
+};
+
+
+
+exports.NodeProcessExecutionService = NodeProcessExecutionService;
+//# sourceMappingURL=chunk-J4PGHMLL.js.map

package/dist/chunk-J4PGHMLL.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/services/node-js/NodeProcessExecutionService.ts"],"names":[],"mappings":";;;;;;;;AACA,SAAS,kCAAkC;AAE3C,SAAS,YAAY;AAKd,IAAM,8BAAN,cAA0C,yBAAuC;AAAA,EACtF,MAAgB,gBAGb;AACD,UAAM,SAAS;AAAA,MACb,UAAQ;AAAA,QACN;AAAA,MACF;AAAA,MACA;AAAA,QACE,OAAO;AAAA,MACT;AAAA,IACF;AAIA,WAAO,QAAQ,GAAG,QAAQ,CAAC,SAAS;AAElC,cAAQ,IAAI,KAAK,SAAS,CAAC;AAAA,IAC7B,CAAC;AAED,WAAO,QAAQ,GAAG,QAAQ,CAAC,SAAS;AAElC,cAAQ,MAAM,KAAK,SAAS,CAAC;AAAA,IAC/B,CAAC;AAED,UAAM,SAAS,IAAI,2BAA2B,EAAE,SAAS,OAAO,CAAC;AACjE,WAAO,QAAQ,QAAQ,EAAE,QAAQ,OAAO,CAAC;AAAA,EAC3C;AAAA,EAEU,aAAa,YAAqC;AAC1D,eAAW,OAAO,KAAK;AAAA,EACzB;AACF","sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { ProcessParentMessageStream } from '@metamask/post-message-stream';\nimport type { ChildProcess } from 'child_process';\nimport { fork } from 'child_process';\n\nimport type { Job } from '..';\nimport { AbstractExecutionService } from '..';\n\nexport class NodeProcessExecutionService extends AbstractExecutionService<ChildProcess> {\n  protected async initEnvStream(): Promise<{\n    worker: ChildProcess;\n    stream: BasePostMessageStream;\n  }> {\n    const worker = fork(\n      require.resolve(\n        '@metamask/snaps-execution-environments/dist/browserify/node-process/bundle.js',\n      ),\n      {\n        stdio: 'pipe',\n      },\n    );\n\n    // Capturing `stdout` and `stderr` from the worker prevents the worker from\n    // writing to them directly, making it easier to capture them Jest.\n    worker.stdout?.on('data', (data) => {\n      // eslint-disable-next-line no-console\n      console.log(data.toString());\n    });\n\n    worker.stderr?.on('data', (data) => {\n      // eslint-disable-next-line no-console\n      console.error(data.toString());\n    });\n\n    const stream = new ProcessParentMessageStream({ process: worker });\n    return Promise.resolve({ worker, stream });\n  }\n\n  protected terminateJob(jobWrapper: Job<ChildProcess>): void {\n    jobWrapper.worker.kill();\n  }\n}\n"]}

package/dist/chunk-JAUAKTUL.js

@@ -0,0 +1 @@
+"use strict";//# sourceMappingURL=chunk-JAUAKTUL.js.map

package/dist/chunk-JAUAKTUL.js.map

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

package/dist/chunk-JDHKH5YU.js

@@ -0,0 +1,354 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _chunkNXZVKBSVjs = require('./chunk-NXZVKBSV.js');
+
+
+
+var _chunkXE5IWVNVjs = require('./chunk-XE5IWVNV.js');
+
+
+
+
+
+var _chunkEXN2TFDJjs = require('./chunk-EXN2TFDJ.js');
+
+// src/services/AbstractExecutionService.ts
+var _jsonrpcengine = require('@metamask/json-rpc-engine');
+var _objectmultiplex = require('@metamask/object-multiplex'); var _objectmultiplex2 = _interopRequireDefault(_objectmultiplex);
+var _rpcerrors = require('@metamask/rpc-errors');
+var _snapsutils = require('@metamask/snaps-utils');
+
+
+
+
+
+var _utils = require('@metamask/utils');
+var _jsonrpcmiddlewarestream = require('json-rpc-middleware-stream');
+var _nanoid = require('nanoid');
+var _readablestream = require('readable-stream');
+var controllerName = "ExecutionService";
+var _snapRpcHooks, _snapToJobMap, _jobToSnapMap, _messenger, _terminationTimeout, _removeSnapHooks, removeSnapHooks_fn, _createSnapHooks, createSnapHooks_fn, _mapSnapAndJob, mapSnapAndJob_fn, _removeSnapAndJobMapping, removeSnapAndJobMapping_fn;
+var AbstractExecutionService = class {
+  constructor({
+    setupSnapProvider,
+    messenger,
+    terminationTimeout = _utils.Duration.Second
+  }) {
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _removeSnapHooks);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _createSnapHooks);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _mapSnapAndJob);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _removeSnapAndJobMapping);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _snapRpcHooks, void 0);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _snapToJobMap, void 0);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _jobToSnapMap, void 0);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _messenger, void 0);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _terminationTimeout, void 0);
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _snapRpcHooks, /* @__PURE__ */ new Map());
+    this.jobs = /* @__PURE__ */ new Map();
+    this.setupSnapProvider = setupSnapProvider;
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _snapToJobMap, /* @__PURE__ */ new Map());
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _jobToSnapMap, /* @__PURE__ */ new Map());
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _messenger, messenger);
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _terminationTimeout, terminationTimeout);
+    this.registerMessageHandlers();
+  }
+  /**
+   * Constructor helper for registering the controller's messaging system
+   * actions.
+   */
+  registerMessageHandlers() {
+    _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _messenger).registerActionHandler(
+      `${controllerName}:handleRpcRequest`,
+      async (snapId, options) => this.handleRpcRequest(snapId, options)
+    );
+    _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _messenger).registerActionHandler(
+      `${controllerName}:executeSnap`,
+      async (snapData) => this.executeSnap(snapData)
+    );
+    _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _messenger).registerActionHandler(
+      `${controllerName}:terminateSnap`,
+      async (snapId) => this.terminateSnap(snapId)
+    );
+    _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _messenger).registerActionHandler(
+      `${controllerName}:terminateAllSnaps`,
+      async () => this.terminateAllSnaps()
+    );
+  }
+  /**
+   * Terminates the job with the specified ID and deletes all its associated
+   * data. Any subsequent messages targeting the job will fail with an error.
+   * Throws an error if the specified job does not exist, or if termination
+   * fails unexpectedly.
+   *
+   * @param jobId - The id of the job to be terminated.
+   */
+  async terminate(jobId) {
+    const jobWrapper = this.jobs.get(jobId);
+    if (!jobWrapper) {
+      throw new Error(`Job with id "${jobId}" not found.`);
+    }
+    const result = await _chunkXE5IWVNVjs.withTimeout.call(void 0, 
+      this.command(jobId, {
+        jsonrpc: "2.0",
+        method: "terminate",
+        params: [],
+        id: _nanoid.nanoid.call(void 0, )
+      }),
+      _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _terminationTimeout)
+    );
+    if (result === _chunkXE5IWVNVjs.hasTimedOut || result !== "OK") {
+      _snapsutils.logError.call(void 0, `Job "${jobId}" failed to terminate gracefully.`, result);
+    }
+    Object.values(jobWrapper.streams).forEach((stream) => {
+      try {
+        !stream.destroyed && stream.destroy();
+        stream.removeAllListeners();
+      } catch (error) {
+        _snapsutils.logError.call(void 0, "Error while destroying stream", error);
+      }
+    });
+    this.terminateJob(jobWrapper);
+    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _removeSnapAndJobMapping, removeSnapAndJobMapping_fn).call(this, jobId);
+    this.jobs.delete(jobId);
+    _chunkNXZVKBSVjs.log.call(void 0, `Job "${jobId}" terminated.`);
+  }
+  /**
+   * Initiates a job for a snap.
+   *
+   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.
+   *
+   * @returns Information regarding the created job.
+   */
+  async initJob() {
+    const jobId = _nanoid.nanoid.call(void 0, );
+    const { streams, worker } = await this.initStreams(jobId);
+    const rpcEngine = new (0, _jsonrpcengine.JsonRpcEngine)();
+    const jsonRpcConnection = _jsonrpcmiddlewarestream.createStreamMiddleware.call(void 0, );
+    _readablestream.pipeline.call(void 0, 
+      jsonRpcConnection.stream,
+      streams.command,
+      jsonRpcConnection.stream,
+      (error) => {
+        if (error) {
+          _snapsutils.logError.call(void 0, `Command stream failure.`, error);
+        }
+      }
+    );
+    rpcEngine.push(jsonRpcConnection.middleware);
+    const envMetadata = {
+      id: jobId,
+      streams,
+      rpcEngine,
+      worker
+    };
+    this.jobs.set(jobId, envMetadata);
+    return envMetadata;
+  }
+  /**
+   * Sets up the streams for an initiated job.
+   *
+   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.
+   *
+   * @param jobId - The id of the job.
+   * @returns The streams to communicate with the worker and the worker itself.
+   */
+  async initStreams(jobId) {
+    const { worker, stream: envStream } = await this.initEnvStream(jobId);
+    const mux = setupMultiplex(envStream, `Job: "${jobId}"`);
+    const commandStream = mux.createStream(_snapsutils.SNAP_STREAM_NAMES.COMMAND);
+    const notificationHandler = (message) => {
+      if (!_utils.isJsonRpcNotification.call(void 0, message)) {
+        return;
+      }
+      const snapId = _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _jobToSnapMap).get(jobId);
+      if (message.method === "OutboundRequest") {
+        _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _messenger).publish("ExecutionService:outboundRequest", snapId);
+      } else if (message.method === "OutboundResponse") {
+        _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _messenger).publish("ExecutionService:outboundResponse", snapId);
+      } else if (message.method === "UnhandledError") {
+        if (_utils.isObject.call(void 0, message.params) && message.params.error) {
+          _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _messenger).publish(
+            "ExecutionService:unhandledError",
+            snapId,
+            message.params.error
+          );
+          commandStream.removeListener("data", notificationHandler);
+        } else {
+          _snapsutils.logError.call(void 0, 
+            new Error(
+              `Received malformed "${message.method}" command stream notification.`
+            )
+          );
+        }
+      } else {
+        _snapsutils.logError.call(void 0, 
+          new Error(
+            `Received unexpected command stream notification "${message.method}".`
+          )
+        );
+      }
+    };
+    commandStream.on("data", notificationHandler);
+    const rpcStream = mux.createStream(_snapsutils.SNAP_STREAM_NAMES.JSON_RPC);
+    return {
+      streams: {
+        command: commandStream,
+        rpc: rpcStream,
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        _connection: envStream
+      },
+      worker
+    };
+  }
+  /**
+   * Terminates the Snap with the specified ID. May throw an error if
+   * termination unexpectedly fails, but will not fail if no job for the snap
+   * with the specified ID is found.
+   *
+   * @param snapId - The ID of the snap to terminate.
+   */
+  async terminateSnap(snapId) {
+    const jobId = _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _snapToJobMap).get(snapId);
+    if (jobId) {
+      await this.terminate(jobId);
+    }
+  }
+  async terminateAllSnaps() {
+    await Promise.all(
+      [...this.jobs.keys()].map(async (jobId) => this.terminate(jobId))
+    );
+    _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _snapRpcHooks).clear();
+  }
+  /**
+   * Gets the RPC request handler for the given snap.
+   *
+   * @param snapId - The id of the Snap whose message handler to get.
+   * @returns The RPC request handler for the snap.
+   */
+  getRpcRequestHandler(snapId) {
+    return _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _snapRpcHooks).get(snapId);
+  }
+  /**
+   * Initializes and executes a snap, setting up the communication channels to the snap etc.
+   *
+   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.
+   *
+   * @param snapData - Data needed for Snap execution.
+   * @returns A string `OK` if execution succeeded.
+   * @throws If the execution service returns an error.
+   */
+  async executeSnap(snapData) {
+    if (_chunkEXN2TFDJjs.__privateGet.call(void 0, this, _snapToJobMap).has(snapData.snapId)) {
+      throw new Error(`Snap "${snapData.snapId}" is already being executed.`);
+    }
+    const job = await this.initJob();
+    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _mapSnapAndJob, mapSnapAndJob_fn).call(this, snapData.snapId, job.id);
+    await this.command(job.id, {
+      jsonrpc: "2.0",
+      method: "ping",
+      id: _nanoid.nanoid.call(void 0, )
+    });
+    const rpcStream = job.streams.rpc;
+    this.setupSnapProvider(snapData.snapId, rpcStream);
+    const result = await this.command(job.id, {
+      jsonrpc: "2.0",
+      method: "executeSnap",
+      params: snapData,
+      id: _nanoid.nanoid.call(void 0, )
+    });
+    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _createSnapHooks, createSnapHooks_fn).call(this, snapData.snapId, job.id);
+    return result;
+  }
+  // Cannot be hash private yet because of tests.
+  async command(jobId, message) {
+    _utils.assertIsJsonRpcRequest.call(void 0, message);
+    const job = this.jobs.get(jobId);
+    if (!job) {
+      throw new Error(`Job with id "${jobId}" not found.`);
+    }
+    _chunkNXZVKBSVjs.log.call(void 0, "Parent: Sending Command", message);
+    const response = await job.rpcEngine.handle(
+      message
+    );
+    if (response.error) {
+      throw new (0, _rpcerrors.JsonRpcError)(
+        response.error.code,
+        response.error.message,
+        response.error.data
+      );
+    }
+    return response.result;
+  }
+  /**
+   * Handle RPC request.
+   *
+   * @param snapId - The ID of the recipient snap.
+   * @param options - Bag of options to pass to the RPC handler.
+   * @returns Promise that can handle the request.
+   */
+  async handleRpcRequest(snapId, options) {
+    const rpcRequestHandler = this.getRpcRequestHandler(snapId);
+    if (!rpcRequestHandler) {
+      throw new Error(
+        `Snap execution service returned no RPC handler for running snap "${snapId}".`
+      );
+    }
+    return rpcRequestHandler(options);
+  }
+};
+_snapRpcHooks = new WeakMap();
+_snapToJobMap = new WeakMap();
+_jobToSnapMap = new WeakMap();
+_messenger = new WeakMap();
+_terminationTimeout = new WeakMap();
+_removeSnapHooks = new WeakSet();
+removeSnapHooks_fn = function(snapId) {
+  _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _snapRpcHooks).delete(snapId);
+};
+_createSnapHooks = new WeakSet();
+createSnapHooks_fn = function(snapId, workerId) {
+  const rpcHook = async ({ origin, handler, request }) => {
+    return await this.command(workerId, {
+      id: _nanoid.nanoid.call(void 0, ),
+      jsonrpc: "2.0",
+      method: "snapRpc",
+      params: {
+        origin,
+        handler,
+        request,
+        target: snapId
+      }
+    });
+  };
+  _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _snapRpcHooks).set(snapId, rpcHook);
+};
+_mapSnapAndJob = new WeakSet();
+mapSnapAndJob_fn = function(snapId, jobId) {
+  _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _snapToJobMap).set(snapId, jobId);
+  _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _jobToSnapMap).set(jobId, snapId);
+};
+_removeSnapAndJobMapping = new WeakSet();
+removeSnapAndJobMapping_fn = function(jobId) {
+  const snapId = _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _jobToSnapMap).get(jobId);
+  if (!snapId) {
+    throw new Error(`job: "${jobId}" has no mapped snap.`);
+  }
+  _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _jobToSnapMap).delete(jobId);
+  _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _snapToJobMap).delete(snapId);
+  _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _removeSnapHooks, removeSnapHooks_fn).call(this, snapId);
+};
+function setupMultiplex(connectionStream, streamName) {
+  const mux = new (0, _objectmultiplex2.default)();
+  _readablestream.pipeline.call(void 0, connectionStream, mux, connectionStream, (error) => {
+    if (error) {
+      streamName ? _snapsutils.logError.call(void 0, `"${streamName}" stream failure.`, error) : _snapsutils.logError.call(void 0, error);
+    }
+  });
+  return mux;
+}
+
+
+
+
+exports.AbstractExecutionService = AbstractExecutionService; exports.setupMultiplex = setupMultiplex;
+//# sourceMappingURL=chunk-JDHKH5YU.js.map

package/dist/chunk-JDHKH5YU.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/services/AbstractExecutionService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,SAAS,qBAAqB;AAC9B,OAAO,qBAAqB;AAE5B,SAAS,oBAAoB;AAE7B,SAAS,mBAAmB,gBAAgB;AAO5C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,8BAA8B;AACvC,SAAS,cAAc;AACvB,SAAS,gBAAgB;AAYzB,IAAM,iBAAiB;AAhCvB;AAuDO,IAAe,2BAAf,MAEP;AAAA,EAiBE,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA,qBAAqB,SAAS;AAAA,EAChC,GAAyB;AA0TzB;AAIA;AAkBA;AAKA;AAzWA;AAQA;AAEA;AAEA;AAEA;AAOE,uBAAK,eAAgB,oBAAI,IAAI;AAC7B,SAAK,OAAO,oBAAI,IAAI;AACpB,SAAK,oBAAoB;AACzB,uBAAK,eAAgB,oBAAI,IAAI;AAC7B,uBAAK,eAAgB,oBAAI,IAAI;AAC7B,uBAAK,YAAa;AAClB,uBAAK,qBAAsB;AAE3B,SAAK,wBAAwB;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,0BAAgC;AACtC,uBAAK,YAAW;AAAA,MACd,GAAG,cAAc;AAAA,MACjB,OAAO,QAAgB,YACrB,KAAK,iBAAiB,QAAQ,OAAO;AAAA,IACzC;AAEA,uBAAK,YAAW;AAAA,MACd,GAAG,cAAc;AAAA,MACjB,OAAO,aAAgC,KAAK,YAAY,QAAQ;AAAA,IAClE;AAEA,uBAAK,YAAW;AAAA,MACd,GAAG,cAAc;AAAA,MACjB,OAAO,WAAmB,KAAK,cAAc,MAAM;AAAA,IACrD;AAEA,uBAAK,YAAW;AAAA,MACd,GAAG,cAAc;AAAA,MACjB,YAAY,KAAK,kBAAkB;AAAA,IACrC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,MAAa,UAAU,OAA8B;AACnD,UAAM,aAAa,KAAK,KAAK,IAAI,KAAK;AACtC,QAAI,CAAC,YAAY;AACf,YAAM,IAAI,MAAM,gBAAgB,KAAK,cAAc;AAAA,IACrD;AAGA,UAAM,SAAS,MAAM;AAAA,MACnB,KAAK,QAAQ,OAAO;AAAA,QAClB,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,QAAQ,CAAC;AAAA,QACT,IAAI,OAAO;AAAA,MACb,CAAC;AAAA,MACD,mBAAK;AAAA,IACP;AAEA,QAAI,WAAW,eAAe,WAAW,MAAM;AAM7C,eAAS,QAAQ,KAAK,qCAAqC,MAAM;AAAA,IACnE;AAEA,WAAO,OAAO,WAAW,OAAO,EAAE,QAAQ,CAAC,WAAW;AACpD,UAAI;AACF,SAAC,OAAO,aAAa,OAAO,QAAQ;AACpC,eAAO,mBAAmB;AAAA,MAC5B,SAAS,OAAO;AACd,iBAAS,iCAAiC,KAAK;AAAA,MACjD;AAAA,IACF,CAAC;AAED,SAAK,aAAa,UAAU;AAE5B,0BAAK,sDAAL,WAA8B;AAC9B,SAAK,KAAK,OAAO,KAAK;AACtB,QAAI,QAAQ,KAAK,eAAe;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAgB,UAAoC;AAClD,UAAM,QAAQ,OAAO;AACrB,UAAM,EAAE,SAAS,OAAO,IAAI,MAAM,KAAK,YAAY,KAAK;AACxD,UAAM,YAAY,IAAI,cAAc;AAEpC,UAAM,oBAAoB,uBAAuB;AAEjD;AAAA,MACE,kBAAkB;AAAA,MAClB,QAAQ;AAAA,MACR,kBAAkB;AAAA,MAClB,CAAC,UAAU;AACT,YAAI,OAAO;AACT,mBAAS,2BAA2B,KAAK;AAAA,QAC3C;AAAA,MACF;AAAA,IACF;AAEA,cAAU,KAAK,kBAAkB,UAAU;AAE3C,UAAM,cAAc;AAAA,MAClB,IAAI;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,SAAK,KAAK,IAAI,OAAO,WAAW;AAEhC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAgB,YACd,OACsD;AACtD,UAAM,EAAE,QAAQ,QAAQ,UAAU,IAAI,MAAM,KAAK,cAAc,KAAK;AACpE,UAAM,MAAM,eAAe,WAAW,SAAS,KAAK,GAAG;AACvD,UAAM,gBAAgB,IAAI,aAAa,kBAAkB,OAAO;AAIhE,UAAM,sBAAsB,CAC1B,YAGG;AACH,UAAI,CAAC,sBAAsB,OAAO,GAAG;AACnC;AAAA,MACF;AAGA,YAAM,SAAS,mBAAK,eAAc,IAAI,KAAK;AAC3C,UAAI,QAAQ,WAAW,mBAAmB;AACxC,2BAAK,YAAW,QAAQ,oCAAoC,MAAM;AAAA,MACpE,WAAW,QAAQ,WAAW,oBAAoB;AAChD,2BAAK,YAAW,QAAQ,qCAAqC,MAAM;AAAA,MACrE,WAAW,QAAQ,WAAW,kBAAkB;AAC9C,YAAI,SAAS,QAAQ,MAAM,KAAK,QAAQ,OAAO,OAAO;AACpD,6BAAK,YAAW;AAAA,YACd;AAAA,YACA;AAAA,YACA,QAAQ,OAAO;AAAA,UACjB;AACA,wBAAc,eAAe,QAAQ,mBAAmB;AAAA,QAC1D,OAAO;AACL;AAAA,YACE,IAAI;AAAA,cACF,uBAAuB,QAAQ,MAAM;AAAA,YACvC;AAAA,UACF;AAAA,QACF;AAAA,MACF,OAAO;AACL;AAAA,UACE,IAAI;AAAA,YACF,oDAAoD,QAAQ,MAAM;AAAA,UACpE;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,kBAAc,GAAG,QAAQ,mBAAmB;AAC5C,UAAM,YAAY,IAAI,aAAa,kBAAkB,QAAQ;AAG7D,WAAO;AAAA,MACL,SAAS;AAAA,QACP,SAAS;AAAA,QACT,KAAK;AAAA;AAAA,QAEL,aAAa;AAAA,MACf;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,MAAM,cAAc,QAAgB;AAClC,UAAM,QAAQ,mBAAK,eAAc,IAAI,MAAM;AAC3C,QAAI,OAAO;AACT,YAAM,KAAK,UAAU,KAAK;AAAA,IAC5B;AAAA,EACF;AAAA,EAEA,MAAM,oBAAoB;AACxB,UAAM,QAAQ;AAAA,MACZ,CAAC,GAAG,KAAK,KAAK,KAAK,CAAC,EAAE,IAAI,OAAO,UAAU,KAAK,UAAU,KAAK,CAAC;AAAA,IAClE;AACA,uBAAK,eAAc,MAAM;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,qBAAqB,QAAgB;AAC3C,WAAO,mBAAK,eAAc,IAAI,MAAM;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAM,YAAY,UAA8C;AAC9D,QAAI,mBAAK,eAAc,IAAI,SAAS,MAAM,GAAG;AAC3C,YAAM,IAAI,MAAM,SAAS,SAAS,MAAM,8BAA8B;AAAA,IACxE;AAEA,UAAM,MAAM,MAAM,KAAK,QAAQ;AAC/B,0BAAK,kCAAL,WAAoB,SAAS,QAAQ,IAAI;AAGzC,UAAM,KAAK,QAAQ,IAAI,IAAI;AAAA,MACzB,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,IAAI,OAAO;AAAA,IACb,CAAC;AAED,UAAM,YAAY,IAAI,QAAQ;AAE9B,SAAK,kBAAkB,SAAS,QAAQ,SAAS;AAEjD,UAAM,SAAS,MAAM,KAAK,QAAQ,IAAI,IAAI;AAAA,MACxC,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,QAAQ;AAAA,MACR,IAAI,OAAO;AAAA,IACb,CAAC;AACD,0BAAK,sCAAL,WAAsB,SAAS,QAAQ,IAAI;AAC3C,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,MAAc,QACZ,OACA,SAC2B;AAC3B,2BAAuB,OAAO;AAE9B,UAAM,MAAM,KAAK,KAAK,IAAI,KAAK;AAC/B,QAAI,CAAC,KAAK;AACR,YAAM,IAAI,MAAM,gBAAgB,KAAK,cAAc;AAAA,IACrD;AAEA,QAAI,2BAA2B,OAAO;AACtC,UAAM,WAAyC,MAAM,IAAI,UAAU;AAAA,MACjE;AAAA,IACF;AAEA,QAAI,SAAS,OAAO;AAClB,YAAM,IAAI;AAAA,QACR,SAAS,MAAM;AAAA,QACf,SAAS,MAAM;AAAA,QACf,SAAS,MAAM;AAAA,MACjB;AAAA,IACF;AAEA,WAAO,SAAS;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA+CA,MAAa,iBACX,QACA,SACkB;AAClB,UAAM,oBAAoB,KAAK,qBAAqB,MAAM;AAE1D,QAAI,CAAC,mBAAmB;AACtB,YAAM,IAAI;AAAA,QACR,oEAAoE,MAAM;AAAA,MAC5E;AAAA,IACF;AAEA,WAAO,kBAAkB,OAAO;AAAA,EAClC;AACF;AAzYE;AAQA;AAEA;AAEA;AAEA;AAgUA;AAAA,qBAAgB,SAAC,QAAgB;AAC/B,qBAAK,eAAc,OAAO,MAAM;AAClC;AAEA;AAAA,qBAAgB,SAAC,QAAgB,UAAkB;AACjD,QAAM,UAAU,OAAO,EAAE,QAAQ,SAAS,QAAQ,MAAuB;AACvE,WAAO,MAAM,KAAK,QAAQ,UAAU;AAAA,MAClC,IAAI,OAAO;AAAA,MACX,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,QAAQ;AAAA,QACN;AAAA,QACA;AAAA,QACA;AAAA,QACA,QAAQ;AAAA,MACV;AAAA,IACF,CAAC;AAAA,EACH;AAEA,qBAAK,eAAc,IAAI,QAAQ,OAAO;AACxC;AAEA;AAAA,mBAAc,SAAC,QAAgB,OAAqB;AAClD,qBAAK,eAAc,IAAI,QAAQ,KAAK;AACpC,qBAAK,eAAc,IAAI,OAAO,MAAM;AACtC;AAEA;AAAA,6BAAwB,SAAC,OAAqB;AAC5C,QAAM,SAAS,mBAAK,eAAc,IAAI,KAAK;AAC3C,MAAI,CAAC,QAAQ;AACX,UAAM,IAAI,MAAM,SAAS,KAAK,uBAAuB;AAAA,EACvD;AAEA,qBAAK,eAAc,OAAO,KAAK;AAC/B,qBAAK,eAAc,OAAO,MAAM;AAChC,wBAAK,sCAAL,WAAsB;AACxB;AAgCK,SAAS,eACd,kBACA,YACiB;AACjB,QAAM,MAAM,IAAI,gBAAgB;AAChC,WAAS,kBAAkB,KAAK,kBAAkB,CAAC,UAAU;AAC3D,QAAI,OAAO;AACT,mBACI,SAAS,IAAI,UAAU,qBAAqB,KAAK,IACjD,SAAS,KAAK;AAAA,IACpB;AAAA,EACF,CAAC;AACD,SAAO;AACT","sourcesContent":["import { JsonRpcEngine } from '@metamask/json-rpc-engine';\nimport ObjectMultiplex from '@metamask/object-multiplex';\nimport type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { JsonRpcError } from '@metamask/rpc-errors';\nimport type { SnapRpcHook, SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport { SNAP_STREAM_NAMES, logError } from '@metamask/snaps-utils';\nimport type {\n  Json,\n  JsonRpcNotification,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\nimport {\n  Duration,\n  assertIsJsonRpcRequest,\n  isJsonRpcNotification,\n  isObject,\n} from '@metamask/utils';\nimport { createStreamMiddleware } from 'json-rpc-middleware-stream';\nimport { nanoid } from 'nanoid';\nimport { pipeline } from 'readable-stream';\nimport type { Duplex } from 'readable-stream';\n\nimport { log } from '../logging';\nimport { hasTimedOut, withTimeout } from '../utils';\nimport type {\n  ExecutionService,\n  ExecutionServiceMessenger,\n  SnapErrorJson,\n  SnapExecutionData,\n} from './ExecutionService';\n\nconst controllerName = 'ExecutionService';\n\nexport type SetupSnapProvider = (snapId: string, stream: Duplex) => void;\n\nexport type ExecutionServiceArgs = {\n  setupSnapProvider: SetupSnapProvider;\n  messenger: ExecutionServiceMessenger;\n  terminationTimeout?: number;\n};\n\nexport type JobStreams = {\n  command: Duplex;\n  rpc: Duplex;\n  _connection: BasePostMessageStream;\n};\n\nexport type Job<WorkerType> = {\n  id: string;\n  streams: JobStreams;\n  rpcEngine: JsonRpcEngine;\n  worker: WorkerType;\n};\n\nexport abstract class AbstractExecutionService<WorkerType>\n  implements ExecutionService\n{\n  #snapRpcHooks: Map<string, SnapRpcHook>;\n\n  // Cannot be hash private yet because of tests.\n  protected jobs: Map<string, Job<WorkerType>>;\n\n  // Cannot be hash private yet because of tests.\n  private readonly setupSnapProvider: SetupSnapProvider;\n\n  #snapToJobMap: Map<string, string>;\n\n  #jobToSnapMap: Map<string, string>;\n\n  #messenger: ExecutionServiceMessenger;\n\n  #terminationTimeout: number;\n\n  constructor({\n    setupSnapProvider,\n    messenger,\n    terminationTimeout = Duration.Second,\n  }: ExecutionServiceArgs) {\n    this.#snapRpcHooks = new Map();\n    this.jobs = new Map();\n    this.setupSnapProvider = setupSnapProvider;\n    this.#snapToJobMap = new Map();\n    this.#jobToSnapMap = new Map();\n    this.#messenger = messenger;\n    this.#terminationTimeout = terminationTimeout;\n\n    this.registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering the controller's messaging system\n   * actions.\n   */\n  private registerMessageHandlers(): void {\n    this.#messenger.registerActionHandler(\n      `${controllerName}:handleRpcRequest`,\n      async (snapId: string, options: SnapRpcHookArgs) =>\n        this.handleRpcRequest(snapId, options),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:executeSnap`,\n      async (snapData: SnapExecutionData) => this.executeSnap(snapData),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateSnap`,\n      async (snapId: string) => this.terminateSnap(snapId),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateAllSnaps`,\n      async () => this.terminateAllSnaps(),\n    );\n  }\n\n  /**\n   * Performs additional necessary work during job termination. **MUST** be\n   * implemented by concrete implementations. See\n   * {@link AbstractExecutionService.terminate} for details.\n   *\n   * @param job - The object corresponding to the job to be terminated.\n   */\n  protected abstract terminateJob(job: Job<WorkerType>): void;\n\n  /**\n   * Terminates the job with the specified ID and deletes all its associated\n   * data. Any subsequent messages targeting the job will fail with an error.\n   * Throws an error if the specified job does not exist, or if termination\n   * fails unexpectedly.\n   *\n   * @param jobId - The id of the job to be terminated.\n   */\n  public async terminate(jobId: string): Promise<void> {\n    const jobWrapper = this.jobs.get(jobId);\n    if (!jobWrapper) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    // Ping worker and tell it to run teardown, continue with termination if it takes too long\n    const result = await withTimeout(\n      this.command(jobId, {\n        jsonrpc: '2.0',\n        method: 'terminate',\n        params: [],\n        id: nanoid(),\n      }),\n      this.#terminationTimeout,\n    );\n\n    if (result === hasTimedOut || result !== 'OK') {\n      // We tried to shutdown gracefully but failed. This probably means the Snap is in infinite loop and\n      // hogging down the whole JS process.\n      // TODO(ritave): It might be doing weird things such as posting a lot of setTimeouts. Add a test to ensure that this behaviour\n      //               doesn't leak into other workers. Especially important in IframeExecutionEnvironment since they all share the same\n      //               JS process.\n      logError(`Job \"${jobId}\" failed to terminate gracefully.`, result);\n    }\n\n    Object.values(jobWrapper.streams).forEach((stream) => {\n      try {\n        !stream.destroyed && stream.destroy();\n        stream.removeAllListeners();\n      } catch (error) {\n        logError('Error while destroying stream', error);\n      }\n    });\n\n    this.terminateJob(jobWrapper);\n\n    this.#removeSnapAndJobMapping(jobId);\n    this.jobs.delete(jobId);\n    log(`Job \"${jobId}\" terminated.`);\n  }\n\n  /**\n   * Initiates a job for a snap.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @returns Information regarding the created job.\n   */\n  protected async initJob(): Promise<Job<WorkerType>> {\n    const jobId = nanoid();\n    const { streams, worker } = await this.initStreams(jobId);\n    const rpcEngine = new JsonRpcEngine();\n\n    const jsonRpcConnection = createStreamMiddleware();\n\n    pipeline(\n      jsonRpcConnection.stream,\n      streams.command,\n      jsonRpcConnection.stream,\n      (error) => {\n        if (error) {\n          logError(`Command stream failure.`, error);\n        }\n      },\n    );\n\n    rpcEngine.push(jsonRpcConnection.middleware);\n\n    const envMetadata = {\n      id: jobId,\n      streams,\n      rpcEngine,\n      worker,\n    };\n    this.jobs.set(jobId, envMetadata);\n\n    return envMetadata;\n  }\n\n  /**\n   * Sets up the streams for an initiated job.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @param jobId - The id of the job.\n   * @returns The streams to communicate with the worker and the worker itself.\n   */\n  protected async initStreams(\n    jobId: string,\n  ): Promise<{ streams: JobStreams; worker: WorkerType }> {\n    const { worker, stream: envStream } = await this.initEnvStream(jobId);\n    const mux = setupMultiplex(envStream, `Job: \"${jobId}\"`);\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n\n    // Handle out-of-band errors, i.e. errors thrown from the snap outside of the req/res cycle.\n    // Also keep track of outbound request/responses\n    const notificationHandler = (\n      message:\n        | JsonRpcRequest\n        | JsonRpcNotification<Json[] | Record<string, Json>>,\n    ) => {\n      if (!isJsonRpcNotification(message)) {\n        return;\n      }\n\n      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n      const snapId = this.#jobToSnapMap.get(jobId)!;\n      if (message.method === 'OutboundRequest') {\n        this.#messenger.publish('ExecutionService:outboundRequest', snapId);\n      } else if (message.method === 'OutboundResponse') {\n        this.#messenger.publish('ExecutionService:outboundResponse', snapId);\n      } else if (message.method === 'UnhandledError') {\n        if (isObject(message.params) && message.params.error) {\n          this.#messenger.publish(\n            'ExecutionService:unhandledError',\n            snapId,\n            message.params.error as SnapErrorJson,\n          );\n          commandStream.removeListener('data', notificationHandler);\n        } else {\n          logError(\n            new Error(\n              `Received malformed \"${message.method}\" command stream notification.`,\n            ),\n          );\n        }\n      } else {\n        logError(\n          new Error(\n            `Received unexpected command stream notification \"${message.method}\".`,\n          ),\n        );\n      }\n    };\n\n    commandStream.on('data', notificationHandler);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC);\n\n    // Typecast: stream type mismatch\n    return {\n      streams: {\n        command: commandStream,\n        rpc: rpcStream,\n        // eslint-disable-next-line @typescript-eslint/naming-convention\n        _connection: envStream,\n      },\n      worker,\n    };\n  }\n\n  /**\n   * Abstract function implemented by implementing class that spins up a new worker for a job.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   */\n  protected abstract initEnvStream(jobId: string): Promise<{\n    worker: WorkerType;\n    stream: BasePostMessageStream;\n  }>;\n\n  /**\n   * Terminates the Snap with the specified ID. May throw an error if\n   * termination unexpectedly fails, but will not fail if no job for the snap\n   * with the specified ID is found.\n   *\n   * @param snapId - The ID of the snap to terminate.\n   */\n  async terminateSnap(snapId: string) {\n    const jobId = this.#snapToJobMap.get(snapId);\n    if (jobId) {\n      await this.terminate(jobId);\n    }\n  }\n\n  async terminateAllSnaps() {\n    await Promise.all(\n      [...this.jobs.keys()].map(async (jobId) => this.terminate(jobId)),\n    );\n    this.#snapRpcHooks.clear();\n  }\n\n  /**\n   * Gets the RPC request handler for the given snap.\n   *\n   * @param snapId - The id of the Snap whose message handler to get.\n   * @returns The RPC request handler for the snap.\n   */\n  private getRpcRequestHandler(snapId: string) {\n    return this.#snapRpcHooks.get(snapId);\n  }\n\n  /**\n   * Initializes and executes a snap, setting up the communication channels to the snap etc.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @param snapData - Data needed for Snap execution.\n   * @returns A string `OK` if execution succeeded.\n   * @throws If the execution service returns an error.\n   */\n  async executeSnap(snapData: SnapExecutionData): Promise<string> {\n    if (this.#snapToJobMap.has(snapData.snapId)) {\n      throw new Error(`Snap \"${snapData.snapId}\" is already being executed.`);\n    }\n\n    const job = await this.initJob();\n    this.#mapSnapAndJob(snapData.snapId, job.id);\n\n    // Ping the worker to ensure that it started up\n    await this.command(job.id, {\n      jsonrpc: '2.0',\n      method: 'ping',\n      id: nanoid(),\n    });\n\n    const rpcStream = job.streams.rpc;\n\n    this.setupSnapProvider(snapData.snapId, rpcStream);\n\n    const result = await this.command(job.id, {\n      jsonrpc: '2.0',\n      method: 'executeSnap',\n      params: snapData,\n      id: nanoid(),\n    });\n    this.#createSnapHooks(snapData.snapId, job.id);\n    return result as string;\n  }\n\n  // Cannot be hash private yet because of tests.\n  private async command(\n    jobId: string,\n    message: JsonRpcRequest,\n  ): Promise<Json | undefined> {\n    assertIsJsonRpcRequest(message);\n\n    const job = this.jobs.get(jobId);\n    if (!job) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    log('Parent: Sending Command', message);\n    const response: PendingJsonRpcResponse<Json> = await job.rpcEngine.handle(\n      message,\n    );\n\n    if (response.error) {\n      throw new JsonRpcError(\n        response.error.code,\n        response.error.message,\n        response.error.data,\n      );\n    }\n\n    return response.result;\n  }\n\n  #removeSnapHooks(snapId: string) {\n    this.#snapRpcHooks.delete(snapId);\n  }\n\n  #createSnapHooks(snapId: string, workerId: string) {\n    const rpcHook = async ({ origin, handler, request }: SnapRpcHookArgs) => {\n      return await this.command(workerId, {\n        id: nanoid(),\n        jsonrpc: '2.0',\n        method: 'snapRpc',\n        params: {\n          origin,\n          handler,\n          request: request as JsonRpcRequest,\n          target: snapId,\n        },\n      });\n    };\n\n    this.#snapRpcHooks.set(snapId, rpcHook);\n  }\n\n  #mapSnapAndJob(snapId: string, jobId: string): void {\n    this.#snapToJobMap.set(snapId, jobId);\n    this.#jobToSnapMap.set(jobId, snapId);\n  }\n\n  #removeSnapAndJobMapping(jobId: string): void {\n    const snapId = this.#jobToSnapMap.get(jobId);\n    if (!snapId) {\n      throw new Error(`job: \"${jobId}\" has no mapped snap.`);\n    }\n\n    this.#jobToSnapMap.delete(jobId);\n    this.#snapToJobMap.delete(snapId);\n    this.#removeSnapHooks(snapId);\n  }\n\n  /**\n   * Handle RPC request.\n   *\n   * @param snapId - The ID of the recipient snap.\n   * @param options - Bag of options to pass to the RPC handler.\n   * @returns Promise that can handle the request.\n   */\n  public async handleRpcRequest(\n    snapId: string,\n    options: SnapRpcHookArgs,\n  ): Promise<unknown> {\n    const rpcRequestHandler = this.getRpcRequestHandler(snapId);\n\n    if (!rpcRequestHandler) {\n      throw new Error(\n        `Snap execution service returned no RPC handler for running snap \"${snapId}\".`,\n      );\n    }\n\n    return rpcRequestHandler(options);\n  }\n}\n\n/**\n * Sets up stream multiplexing for the given stream.\n *\n * @param connectionStream - The stream to mux.\n * @param streamName - The name of the stream, for identification in errors.\n * @returns The multiplexed stream.\n */\nexport function setupMultiplex(\n  connectionStream: Duplex,\n  streamName: string,\n): ObjectMultiplex {\n  const mux = new ObjectMultiplex();\n  pipeline(connectionStream, mux, connectionStream, (error) => {\n    if (error) {\n      streamName\n        ? logError(`\"${streamName}\" stream failure.`, error)\n        : logError(error);\n    }\n  });\n  return mux;\n}\n"]}

package/dist/chunk-JW7WBUL7.js

@@ -0,0 +1 @@
+"use strict";//# sourceMappingURL=chunk-JW7WBUL7.js.map

package/dist/chunk-JW7WBUL7.js.map

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