@metamask/snaps-controllers 0.24.0

package/dist/multichain/middleware.d.ts

@@ -0,0 +1,14 @@
+import { JsonRpcMiddleware, JsonRpcRequest } from 'json-rpc-engine';
+import { ConnectArguments, Session, MultiChainRequest } from '@metamask/snaps-utils';
+/**
+ * Creates a middleware that handles requests to the multichain controller.
+ *
+ * @param hooks - The hooks required by the middleware.
+ * @param hooks.onConnect - The onConnect hook.
+ * @param hooks.onRequest - The onRequest hook.
+ * @returns The middleware.
+ */
+export declare function createMultiChainMiddleware({ onConnect, onRequest, }: {
+    onConnect: (origin: string, requestedNamespaces: ConnectArguments) => Promise<Session>;
+    onRequest: (origin: string, data: MultiChainRequest) => Promise<unknown>;
+}): JsonRpcMiddleware<Omit<JsonRpcRequest<unknown>, 'id' | 'jsonrpc'>, any>;

package/dist/multichain/middleware.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMultiChainMiddleware = void 0;
+const json_rpc_engine_1 = require("json-rpc-engine");
+const utils_1 = require("@metamask/utils");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+/**
+ * Creates a middleware that handles requests to the multichain controller.
+ *
+ * @param hooks - The hooks required by the middleware.
+ * @param hooks.onConnect - The onConnect hook.
+ * @param hooks.onRequest - The onRequest hook.
+ * @returns The middleware.
+ */
+function createMultiChainMiddleware({ onConnect, onRequest, }) {
+    return (0, json_rpc_engine_1.createAsyncMiddleware)(async function middleware(req, res, next) {
+        // This is added by other middleware
+        const { origin, params: unwrapped } = req;
+        if (req.method !== 'wallet_multiChainRequestHack') {
+            await next();
+            return;
+        }
+        (0, utils_1.assert)(unwrapped !== undefined, `Invalid params for ${req.method}`);
+        switch (unwrapped.method) {
+            case 'caip_request': {
+                (0, snaps_utils_1.assertIsMultiChainRequest)(unwrapped.params);
+                res.result = await onRequest(origin, unwrapped.params);
+                return;
+            }
+            case 'metamask_handshake': {
+                (0, snaps_utils_1.assertIsConnectArguments)(unwrapped.params);
+                res.result = await onConnect(origin, unwrapped.params);
+                return;
+            }
+            default: {
+                await next();
+            }
+        }
+    });
+}
+exports.createMultiChainMiddleware = createMultiChainMiddleware;
+//# sourceMappingURL=middleware.js.map

package/dist/multichain/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../src/multichain/middleware.ts"],"names":[],"mappings":";;;AAAA,qDAIyB;AACzB,2CAAyC;AACzC,uDAM+B;AAE/B;;;;;;;GAOG;AACH,SAAgB,0BAA0B,CAAC,EACzC,SAAS,EACT,SAAS,GAOV;IACC,OAAO,IAAA,uCAAqB,EAAC,KAAK,UAAU,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI;QACnE,oCAAoC;QACpC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,GAEhB,CAAC;QACvB,IAAI,GAAG,CAAC,MAAM,KAAK,8BAA8B,EAAE;YACjD,MAAM,IAAI,EAAE,CAAC;YACb,OAAO;SACR;QAED,IAAA,cAAM,EAAC,SAAS,KAAK,SAAS,EAAE,sBAAsB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QAEpE,QAAQ,SAAS,CAAC,MAAM,EAAE;YACxB,KAAK,cAAc,CAAC,CAAC;gBACnB,IAAA,uCAAyB,EAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAC5C,GAAG,CAAC,MAAM,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;gBACvD,OAAO;aACR;YAED,KAAK,oBAAoB,CAAC,CAAC;gBACzB,IAAA,sCAAwB,EAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAC3C,GAAG,CAAC,MAAM,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;gBACvD,OAAO;aACR;YAED,OAAO,CAAC,CAAC;gBACP,MAAM,IAAI,EAAE,CAAC;aACd;SACF;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAxCD,gEAwCC","sourcesContent":["import {\n  createAsyncMiddleware,\n  JsonRpcMiddleware,\n  JsonRpcRequest,\n} from 'json-rpc-engine';\nimport { assert } from '@metamask/utils';\nimport {\n  assertIsConnectArguments,\n  assertIsMultiChainRequest,\n  ConnectArguments,\n  Session,\n  MultiChainRequest,\n} from '@metamask/snaps-utils';\n\n/**\n * Creates a middleware that handles requests to the multichain controller.\n *\n * @param hooks - The hooks required by the middleware.\n * @param hooks.onConnect - The onConnect hook.\n * @param hooks.onRequest - The onRequest hook.\n * @returns The middleware.\n */\nexport function createMultiChainMiddleware({\n  onConnect,\n  onRequest,\n}: {\n  onConnect: (\n    origin: string,\n    requestedNamespaces: ConnectArguments,\n  ) => Promise<Session>;\n  onRequest: (origin: string, data: MultiChainRequest) => Promise<unknown>;\n}): JsonRpcMiddleware<Omit<JsonRpcRequest<unknown>, 'id' | 'jsonrpc'>, any> {\n  return createAsyncMiddleware(async function middleware(req, res, next) {\n    // This is added by other middleware\n    const { origin, params: unwrapped } = req as JsonRpcRequest<\n      JsonRpcRequest<unknown>\n    > & { origin: string };\n    if (req.method !== 'wallet_multiChainRequestHack') {\n      await next();\n      return;\n    }\n\n    assert(unwrapped !== undefined, `Invalid params for ${req.method}`);\n\n    switch (unwrapped.method) {\n      case 'caip_request': {\n        assertIsMultiChainRequest(unwrapped.params);\n        res.result = await onRequest(origin, unwrapped.params);\n        return;\n      }\n\n      case 'metamask_handshake': {\n        assertIsConnectArguments(unwrapped.params);\n        res.result = await onConnect(origin, unwrapped.params);\n        return;\n      }\n\n      default: {\n        await next();\n      }\n    }\n  });\n}\n"]}

package/dist/services/AbstractExecutionService.d.ts

@@ -0,0 +1,124 @@
+/// <reference types="node" />
+import { Duplex } from 'stream';
+import ObjectMultiplex from '@metamask/object-multiplex';
+import { SnapRpcHookArgs } from '@metamask/snaps-utils';
+import { BasePostMessageStream } from '@metamask/post-message-stream';
+import { JsonRpcEngine } from 'json-rpc-engine';
+import { ExecutionService, ExecutionServiceMessenger, SnapExecutionData } from './ExecutionService';
+export declare type SetupSnapProvider = (snapId: string, stream: Duplex) => void;
+export declare type ExecutionServiceArgs = {
+    setupSnapProvider: SetupSnapProvider;
+    messenger: ExecutionServiceMessenger;
+    terminationTimeout?: number;
+};
+export declare type JobStreams = {
+    command: Duplex;
+    rpc: Duplex;
+    _connection: BasePostMessageStream;
+};
+export declare type Job<WorkerType> = {
+    id: string;
+    streams: JobStreams;
+    rpcEngine: JsonRpcEngine;
+    worker: WorkerType;
+};
+export declare abstract class AbstractExecutionService<WorkerType> implements ExecutionService {
+    #private;
+    protected jobs: Map<string, Job<WorkerType>>;
+    private setupSnapProvider;
+    constructor({ setupSnapProvider, messenger, terminationTimeout, }: ExecutionServiceArgs);
+    /**
+     * Constructor helper for registering the controller's messaging system
+     * actions.
+     */
+    private registerMessageHandlers;
+    /**
+     * Performs additional necessary work during job termination. **MUST** be
+     * implemented by concrete implementations. See
+     * {@link AbstractExecutionService.terminate} for details.
+     *
+     * @param job - The object corresponding to the job to be terminated.
+     */
+    protected abstract terminateJob(job: Job<WorkerType>): void;
+    /**
+     * 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.
+     */
+    terminate(jobId: string): Promise<void>;
+    /**
+     * 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.
+     */
+    protected initJob(): Promise<Job<WorkerType>>;
+    /**
+     * 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.
+     */
+    protected initStreams(jobId: string): Promise<{
+        streams: JobStreams;
+        worker: WorkerType;
+    }>;
+    /**
+     * Abstract function implemented by implementing class that spins up a new worker for a 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.
+     */
+    protected abstract initEnvStream(jobId: string): Promise<{
+        worker: WorkerType;
+        stream: BasePostMessageStream;
+    }>;
+    /**
+     * 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.
+     */
+    terminateSnap(snapId: string): Promise<void>;
+    terminateAllSnaps(): Promise<void>;
+    /**
+     * 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.
+     */
+    private getRpcRequestHandler;
+    /**
+     * 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.
+     */
+    executeSnap(snapData: SnapExecutionData): Promise<string>;
+    private command;
+    /**
+     * 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.
+     */
+    handleRpcRequest(snapId: string, options: SnapRpcHookArgs): Promise<unknown>;
+}
+/**
+ * Sets up stream multiplexing for the given stream.
+ *
+ * @param connectionStream - The stream to mux.
+ * @param streamName - The name of the stream, for identification in errors.
+ * @returns The multiplexed stream.
+ */
+export declare function setupMultiplex(connectionStream: Duplex, streamName: string): ObjectMultiplex;

package/dist/services/AbstractExecutionService.js

@@ -0,0 +1,316 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _AbstractExecutionService_instances, _AbstractExecutionService_snapRpcHooks, _AbstractExecutionService_snapToJobMap, _AbstractExecutionService_jobToSnapMap, _AbstractExecutionService_messenger, _AbstractExecutionService_terminationTimeout, _AbstractExecutionService_removeSnapHooks, _AbstractExecutionService_createSnapHooks, _AbstractExecutionService_getJobForSnap, _AbstractExecutionService_getSnapForJob, _AbstractExecutionService_mapSnapAndJob, _AbstractExecutionService_removeSnapAndJobMapping;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupMultiplex = exports.AbstractExecutionService = void 0;
+const object_multiplex_1 = __importDefault(require("@metamask/object-multiplex"));
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const json_rpc_engine_1 = require("json-rpc-engine");
+const json_rpc_middleware_stream_1 = require("json-rpc-middleware-stream");
+const nanoid_1 = require("nanoid");
+const pump_1 = __importDefault(require("pump"));
+const utils_2 = require("../utils");
+const controllerName = 'ExecutionService';
+class AbstractExecutionService {
+    constructor({ setupSnapProvider, messenger, terminationTimeout = utils_1.Duration.Second, }) {
+        _AbstractExecutionService_instances.add(this);
+        _AbstractExecutionService_snapRpcHooks.set(this, void 0);
+        _AbstractExecutionService_snapToJobMap.set(this, void 0);
+        _AbstractExecutionService_jobToSnapMap.set(this, void 0);
+        _AbstractExecutionService_messenger.set(this, void 0);
+        _AbstractExecutionService_terminationTimeout.set(this, void 0);
+        __classPrivateFieldSet(this, _AbstractExecutionService_snapRpcHooks, new Map(), "f");
+        this.jobs = new Map();
+        this.setupSnapProvider = setupSnapProvider;
+        __classPrivateFieldSet(this, _AbstractExecutionService_snapToJobMap, new Map(), "f");
+        __classPrivateFieldSet(this, _AbstractExecutionService_jobToSnapMap, new Map(), "f");
+        __classPrivateFieldSet(this, _AbstractExecutionService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _AbstractExecutionService_terminationTimeout, terminationTimeout, "f");
+        this.registerMessageHandlers();
+    }
+    /**
+     * Constructor helper for registering the controller's messaging system
+     * actions.
+     */
+    registerMessageHandlers() {
+        __classPrivateFieldGet(this, _AbstractExecutionService_messenger, "f").registerActionHandler(`${controllerName}:handleRpcRequest`, (snapId, options) => this.handleRpcRequest(snapId, options));
+        __classPrivateFieldGet(this, _AbstractExecutionService_messenger, "f").registerActionHandler(`${controllerName}:executeSnap`, (snapData) => this.executeSnap(snapData));
+        __classPrivateFieldGet(this, _AbstractExecutionService_messenger, "f").registerActionHandler(`${controllerName}:terminateSnap`, (snapId) => this.terminateSnap(snapId));
+        __classPrivateFieldGet(this, _AbstractExecutionService_messenger, "f").registerActionHandler(`${controllerName}:terminateAllSnaps`, () => 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.`);
+        }
+        // Ping worker and tell it to run teardown, continue with termination if it takes too long
+        const result = await (0, utils_2.withTimeout)(this.command(jobId, {
+            jsonrpc: '2.0',
+            method: 'terminate',
+            params: [],
+            id: (0, nanoid_1.nanoid)(),
+        }), __classPrivateFieldGet(this, _AbstractExecutionService_terminationTimeout, "f"));
+        if (result === utils_2.hasTimedOut || result !== 'OK') {
+            // We tried to shutdown gracefully but failed. This probably means the Snap is in infite loop and
+            // hogging down the whole JS process.
+            // TODO(ritave): It might be doing weird things such as posting a lot of setTimeouts. Add a test to ensure that this behaviour
+            //               doesn't leak into other workers. Especially important in IframeExecutionEnvironment since they all share the same
+            //               JS process.
+            console.error(`Job "${jobId}" failed to terminate gracefully.`, result);
+        }
+        Object.values(jobWrapper.streams).forEach((stream) => {
+            try {
+                !stream.destroyed && stream.destroy();
+                stream.removeAllListeners();
+            }
+            catch (err) {
+                console.error('Error while destroying stream', err);
+            }
+        });
+        this.terminateJob(jobWrapper);
+        __classPrivateFieldGet(this, _AbstractExecutionService_instances, "m", _AbstractExecutionService_removeSnapAndJobMapping).call(this, jobId);
+        this.jobs.delete(jobId);
+        console.log(`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 = (0, nanoid_1.nanoid)();
+        const { streams, worker } = await this.initStreams(jobId);
+        const rpcEngine = new json_rpc_engine_1.JsonRpcEngine();
+        const jsonRpcConnection = (0, json_rpc_middleware_stream_1.createStreamMiddleware)();
+        (0, pump_1.default)(jsonRpcConnection.stream, streams.command, jsonRpcConnection.stream);
+        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);
+        // Typecast justification: stream type mismatch
+        const mux = setupMultiplex(envStream, `Job: "${jobId}"`);
+        const commandStream = mux.createStream(snaps_utils_1.SNAP_STREAM_NAMES.COMMAND);
+        // Handle out-of-band errors, i.e. errors thrown from the snap outside of the req/res cycle.
+        // Also keep track of outbound request/responses
+        const notificationHandler = (message) => {
+            if (!(0, utils_1.isJsonRpcNotification)(message)) {
+                return;
+            }
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const snapId = __classPrivateFieldGet(this, _AbstractExecutionService_jobToSnapMap, "f").get(jobId);
+            if (message.method === 'OutboundRequest') {
+                __classPrivateFieldGet(this, _AbstractExecutionService_messenger, "f").publish('ExecutionService:outboundRequest', snapId);
+            }
+            else if (message.method === 'OutboundResponse') {
+                __classPrivateFieldGet(this, _AbstractExecutionService_messenger, "f").publish('ExecutionService:outboundResponse', snapId);
+            }
+            else if (message.method === 'UnhandledError') {
+                if ((0, utils_1.isObject)(message.params) && message.params.error) {
+                    __classPrivateFieldGet(this, _AbstractExecutionService_messenger, "f").publish('ExecutionService:unhandledError', snapId, message.params.error);
+                    commandStream.removeListener('data', notificationHandler);
+                }
+                else {
+                    console.error(new Error(`Received malformed "${message.method}" command stream notification.`));
+                }
+            }
+            else {
+                console.error(new Error(`Received unexpected command stream notification "${message.method}".`));
+            }
+        };
+        commandStream.on('data', notificationHandler);
+        const rpcStream = mux.createStream(snaps_utils_1.SNAP_STREAM_NAMES.JSON_RPC);
+        // Typecast: stream type mismatch
+        return {
+            streams: {
+                command: commandStream,
+                rpc: rpcStream,
+                _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 = __classPrivateFieldGet(this, _AbstractExecutionService_snapToJobMap, "f").get(snapId);
+        if (jobId) {
+            await this.terminate(jobId);
+        }
+    }
+    async terminateAllSnaps() {
+        await Promise.all([...this.jobs.keys()].map((jobId) => this.terminate(jobId)));
+        __classPrivateFieldGet(this, _AbstractExecutionService_snapRpcHooks, "f").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.
+     */
+    async getRpcRequestHandler(snapId) {
+        return __classPrivateFieldGet(this, _AbstractExecutionService_snapRpcHooks, "f").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 (__classPrivateFieldGet(this, _AbstractExecutionService_snapToJobMap, "f").has(snapData.snapId)) {
+            throw new Error(`Snap "${snapData.snapId}" is already being executed.`);
+        }
+        const job = await this.initJob();
+        __classPrivateFieldGet(this, _AbstractExecutionService_instances, "m", _AbstractExecutionService_mapSnapAndJob).call(this, snapData.snapId, job.id);
+        // Ping the worker to ensure that it started up
+        await this.command(job.id, {
+            jsonrpc: '2.0',
+            method: 'ping',
+            id: (0, nanoid_1.nanoid)(),
+        });
+        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: (0, nanoid_1.nanoid)(),
+        });
+        __classPrivateFieldGet(this, _AbstractExecutionService_instances, "m", _AbstractExecutionService_createSnapHooks).call(this, snapData.snapId, job.id);
+        return result;
+    }
+    // Cannot be hash private yet because of tests.
+    async command(jobId, message) {
+        if (typeof message !== 'object') {
+            throw new Error('Must send object.');
+        }
+        const job = this.jobs.get(jobId);
+        if (!job) {
+            throw new Error(`Job with id "${jobId}" not found.`);
+        }
+        console.log('Parent: Sending Command', message);
+        const response = await job.rpcEngine.handle(message);
+        if (response.error) {
+            throw new Error(response.error.message);
+        }
+        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 = await this.getRpcRequestHandler(snapId);
+        if (!rpcRequestHandler) {
+            throw new Error(`Snap execution service returned no RPC handler for running snap "${snapId}".`);
+        }
+        return rpcRequestHandler(options);
+    }
+}
+exports.AbstractExecutionService = AbstractExecutionService;
+_AbstractExecutionService_snapRpcHooks = new WeakMap(), _AbstractExecutionService_snapToJobMap = new WeakMap(), _AbstractExecutionService_jobToSnapMap = new WeakMap(), _AbstractExecutionService_messenger = new WeakMap(), _AbstractExecutionService_terminationTimeout = new WeakMap(), _AbstractExecutionService_instances = new WeakSet(), _AbstractExecutionService_removeSnapHooks = function _AbstractExecutionService_removeSnapHooks(snapId) {
+    __classPrivateFieldGet(this, _AbstractExecutionService_snapRpcHooks, "f").delete(snapId);
+}, _AbstractExecutionService_createSnapHooks = function _AbstractExecutionService_createSnapHooks(snapId, workerId) {
+    const rpcHook = async ({ origin, handler, request }) => {
+        return await this.command(workerId, {
+            id: (0, nanoid_1.nanoid)(),
+            jsonrpc: '2.0',
+            method: 'snapRpc',
+            params: {
+                origin,
+                handler,
+                request,
+                target: snapId,
+            },
+        });
+    };
+    __classPrivateFieldGet(this, _AbstractExecutionService_snapRpcHooks, "f").set(snapId, rpcHook);
+}, _AbstractExecutionService_getJobForSnap = function _AbstractExecutionService_getJobForSnap(snapId) {
+    return __classPrivateFieldGet(this, _AbstractExecutionService_snapToJobMap, "f").get(snapId);
+}, _AbstractExecutionService_getSnapForJob = function _AbstractExecutionService_getSnapForJob(jobId) {
+    return __classPrivateFieldGet(this, _AbstractExecutionService_jobToSnapMap, "f").get(jobId);
+}, _AbstractExecutionService_mapSnapAndJob = function _AbstractExecutionService_mapSnapAndJob(snapId, jobId) {
+    __classPrivateFieldGet(this, _AbstractExecutionService_snapToJobMap, "f").set(snapId, jobId);
+    __classPrivateFieldGet(this, _AbstractExecutionService_jobToSnapMap, "f").set(jobId, snapId);
+}, _AbstractExecutionService_removeSnapAndJobMapping = function _AbstractExecutionService_removeSnapAndJobMapping(jobId) {
+    const snapId = __classPrivateFieldGet(this, _AbstractExecutionService_jobToSnapMap, "f").get(jobId);
+    if (!snapId) {
+        throw new Error(`job: "${jobId}" has no mapped snap.`);
+    }
+    __classPrivateFieldGet(this, _AbstractExecutionService_jobToSnapMap, "f").delete(jobId);
+    __classPrivateFieldGet(this, _AbstractExecutionService_snapToJobMap, "f").delete(snapId);
+    __classPrivateFieldGet(this, _AbstractExecutionService_instances, "m", _AbstractExecutionService_removeSnapHooks).call(this, snapId);
+};
+/**
+ * Sets up stream multiplexing for the given stream.
+ *
+ * @param connectionStream - The stream to mux.
+ * @param streamName - The name of the stream, for identification in errors.
+ * @returns The multiplexed stream.
+ */
+function setupMultiplex(connectionStream, streamName) {
+    const mux = new object_multiplex_1.default();
+    (0, pump_1.default)(connectionStream, 
+    // Typecast: stream type mismatch
+    mux, connectionStream, (err) => {
+        if (err) {
+            streamName
+                ? console.error(`"${streamName}" stream failure.`, err)
+                : console.error(err);
+        }
+    });
+    return mux;
+}
+exports.setupMultiplex = setupMultiplex;
+//# sourceMappingURL=AbstractExecutionService.js.map

package/dist/services/AbstractExecutionService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractExecutionService.js","sourceRoot":"","sources":["../../src/services/AbstractExecutionService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAEA,kFAAyD;AACzD,uDAI+B;AAG/B,2CAMyB;AACzB,qDAKyB;AACzB,2EAAoE;AACpE,mCAAgC;AAChC,gDAAwB;AACxB,oCAAoD;AAQpD,MAAM,cAAc,GAAG,kBAAkB,CAAC;AAuB1C,MAAsB,wBAAwB;IAmB5C,YAAY,EACV,iBAAiB,EACjB,SAAS,EACT,kBAAkB,GAAG,gBAAQ,CAAC,MAAM,GACf;;QApBvB,yDAAwC;QAQxC,yDAAmC;QAEnC,yDAAmC;QAEnC,sDAAsC;QAEtC,+DAA4B;QAO1B,uBAAA,IAAI,0CAAiB,IAAI,GAAG,EAAE,MAAA,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,uBAAA,IAAI,0CAAiB,IAAI,GAAG,EAAE,MAAA,CAAC;QAC/B,uBAAA,IAAI,0CAAiB,IAAI,GAAG,EAAE,MAAA,CAAC;QAC/B,uBAAA,IAAI,uCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,gDAAuB,kBAAkB,MAAA,CAAC;QAE9C,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAED;;;OAGG;IACK,uBAAuB;QAC7B,uBAAA,IAAI,2CAAW,CAAC,qBAAqB,CACnC,GAAG,cAAc,mBAAmB,EACpC,CAAC,MAAc,EAAE,OAAwB,EAAE,EAAE,CAC3C,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,CACzC,CAAC;QAEF,uBAAA,IAAI,2CAAW,CAAC,qBAAqB,CACnC,GAAG,cAAc,cAAc,EAC/B,CAAC,QAA2B,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAC5D,CAAC;QAEF,uBAAA,IAAI,2CAAW,CAAC,qBAAqB,CACnC,GAAG,cAAc,gBAAgB,EACjC,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAC/C,CAAC;QAEF,uBAAA,IAAI,2CAAW,CAAC,qBAAqB,CACnC,GAAG,cAAc,oBAAoB,EACrC,GAAG,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAC/B,CAAC;IACJ,CAAC;IAWD;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CAAC,KAAa;QAClC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,gBAAgB,KAAK,cAAc,CAAC,CAAC;SACtD;QAED,0FAA0F;QAC1F,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAW,EAC9B,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;YAClB,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,WAAW;YACnB,MAAM,EAAE,EAAE;YACV,EAAE,EAAE,IAAA,eAAM,GAAE;SACb,CAAC,EACF,uBAAA,IAAI,oDAAoB,CACzB,CAAC;QAEF,IAAI,MAAM,KAAK,mBAAW,IAAI,MAAM,KAAK,IAAI,EAAE;YAC7C,iGAAiG;YACjG,qCAAqC;YACrC,8HAA8H;YAC9H,kIAAkI;YAClI,4BAA4B;YAC5B,OAAO,CAAC,KAAK,CAAC,QAAQ,KAAK,mCAAmC,EAAE,MAAM,CAAC,CAAC;SACzE;QAED,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACnD,IAAI;gBACF,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACtC,MAAM,CAAC,kBAAkB,EAAE,CAAC;aAC7B;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;aACrD;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAE9B,uBAAA,IAAI,8FAAyB,MAA7B,IAAI,EAA0B,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,eAAe,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,OAAO;QACrB,MAAM,KAAK,GAAG,IAAA,eAAM,GAAE,CAAC;QACvB,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,SAAS,GAAG,IAAI,+BAAa,EAAE,CAAC;QAEtC,MAAM,iBAAiB,GAAG,IAAA,mDAAsB,GAAE,CAAC;QAEnD,IAAA,cAAI,EAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAE1E,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAE7C,MAAM,WAAW,GAAG;YAClB,EAAE,EAAE,KAAK;YACT,OAAO;YACP,SAAS;YACT,MAAM;SACP,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAElC,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,WAAW,CACzB,KAAa;QAEb,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACtE,+CAA+C;QAC/C,MAAM,GAAG,GAAG,cAAc,CACxB,SAA8B,EAC9B,SAAS,KAAK,GAAG,CAClB,CAAC;QAEF,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,OAAO,CAAC,CAAC;QAElE,4FAA4F;QAC5F,gDAAgD;QAChD,MAAM,mBAAmB,GAAG,CAC1B,OAEsD,EACtD,EAAE;YACF,IAAI,CAAC,IAAA,6BAAqB,EAAC,OAAO,CAAC,EAAE;gBACnC,OAAO;aACR;YAED,oEAAoE;YACpE,MAAM,MAAM,GAAG,uBAAA,IAAI,8CAAc,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;YAC9C,IAAI,OAAO,CAAC,MAAM,KAAK,iBAAiB,EAAE;gBACxC,uBAAA,IAAI,2CAAW,CAAC,OAAO,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;aACrE;iBAAM,IAAI,OAAO,CAAC,MAAM,KAAK,kBAAkB,EAAE;gBAChD,uBAAA,IAAI,2CAAW,CAAC,OAAO,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;aACtE;iBAAM,IAAI,OAAO,CAAC,MAAM,KAAK,gBAAgB,EAAE;gBAC9C,IAAI,IAAA,gBAAQ,EAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE;oBACpD,uBAAA,IAAI,2CAAW,CAAC,OAAO,CACrB,iCAAiC,EACjC,MAAM,EACN,OAAO,CAAC,MAAM,CAAC,KAAsB,CACtC,CAAC;oBACF,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;iBAC3D;qBAAM;oBACL,OAAO,CAAC,KAAK,CACX,IAAI,KAAK,CACP,uBAAuB,OAAO,CAAC,MAAM,gCAAgC,CACtE,CACF,CAAC;iBACH;aACF;iBAAM;gBACL,OAAO,CAAC,KAAK,CACX,IAAI,KAAK,CACP,oDAAoD,OAAO,CAAC,MAAM,IAAI,CACvE,CACF,CAAC;aACH;QACH,CAAC,CAAC;QACF,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,QAAQ,CAAC,CAAC;QAE/D,iCAAiC;QACjC,OAAO;YACL,OAAO,EAAE;gBACP,OAAO,EAAE,aAAkC;gBAC3C,GAAG,EAAE,SAAS;gBACd,WAAW,EAAE,SAAS;aACvB;YACD,MAAM;SACP,CAAC;IACJ,CAAC;IAYD;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAC,MAAc;QAChC,MAAM,KAAK,GAAG,uBAAA,IAAI,8CAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,KAAK,EAAE;YACT,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SAC7B;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB;QACrB,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAC5D,CAAC;QACF,uBAAA,IAAI,8CAAc,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,oBAAoB,CAAC,MAAc;QAC/C,OAAO,uBAAA,IAAI,8CAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,WAAW,CAAC,QAA2B;QAC3C,IAAI,uBAAA,IAAI,8CAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,SAAS,QAAQ,CAAC,MAAM,8BAA8B,CAAC,CAAC;SACzE;QAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACjC,uBAAA,IAAI,oFAAe,MAAnB,IAAI,EAAgB,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QAE7C,+CAA+C;QAC/C,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE;YACzB,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,MAAM;YACd,EAAE,EAAE,IAAA,eAAM,GAAE;SACb,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,GAAwB,CAAC;QAEvD,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE;YACxC,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,QAAQ;YAChB,EAAE,EAAE,IAAA,eAAM,GAAE;SACb,CAAC,CAAC;QACH,uBAAA,IAAI,sFAAiB,MAArB,IAAI,EAAkB,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QAC/C,OAAO,MAAgB,CAAC;IAC1B,CAAC;IAED,+CAA+C;IACvC,KAAK,CAAC,OAAO,CACnB,KAAa,EACb,OAAgC;QAEhC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;SACtC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,KAAK,CAAC,gBAAgB,KAAK,cAAc,CAAC,CAAC;SACtD;QAED,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;QAChD,MAAM,QAAQ,GACZ,MAAM,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,QAAQ,CAAC,KAAK,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SACzC;QACD,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IA4DD;;;;;;OAMG;IACI,KAAK,CAAC,gBAAgB,CAC3B,MAAc,EACd,OAAwB;QAExB,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAElE,IAAI,CAAC,iBAAiB,EAAE;YACtB,MAAM,IAAI,KAAK,CACb,oEAAoE,MAAM,IAAI,CAC/E,CAAC;SACH;QAED,OAAO,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;CACF;AArZD,4DAqZC;+aA/EkB,MAAc;IAC7B,uBAAA,IAAI,8CAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC,iGAEgB,MAAc,EAAE,QAAgB;IAC/C,MAAM,OAAO,GAAG,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAmB,EAAE,EAAE;QACtE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;YAClC,EAAE,EAAE,IAAA,eAAM,GAAE;YACZ,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE;gBACN,MAAM;gBACN,OAAO;gBACP,OAAO;gBACP,MAAM,EAAE,MAAM;aACf;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,uBAAA,IAAI,8CAAc,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC1C,CAAC,6FAQc,MAAc;IAC3B,OAAO,uBAAA,IAAI,8CAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC,6FAQc,KAAa;IAC1B,OAAO,uBAAA,IAAI,8CAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACvC,CAAC,6FAEc,MAAc,EAAE,KAAa;IAC1C,uBAAA,IAAI,8CAAc,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACtC,uBAAA,IAAI,8CAAc,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACxC,CAAC,iHAEwB,KAAa;IACpC,MAAM,MAAM,GAAG,uBAAA,IAAI,8CAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,uBAAuB,CAAC,CAAC;KACxD;IAED,uBAAA,IAAI,8CAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjC,uBAAA,IAAI,8CAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAClC,uBAAA,IAAI,sFAAiB,MAArB,IAAI,EAAkB,MAAM,CAAC,CAAC;AAChC,CAAC;AAyBH;;;;;;GAMG;AACH,SAAgB,cAAc,CAC5B,gBAAwB,EACxB,UAAkB;IAElB,MAAM,GAAG,GAAG,IAAI,0BAAe,EAAE,CAAC;IAClC,IAAA,cAAI,EACF,gBAAgB;IAChB,iCAAiC;IACjC,GAAwB,EACxB,gBAAgB,EAChB,CAAC,GAAG,EAAE,EAAE;QACN,IAAI,GAAG,EAAE;YACP,UAAU;gBACR,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,UAAU,mBAAmB,EAAE,GAAG,CAAC;gBACvD,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACxB;IACH,CAAC,CACF,CAAC;IACF,OAAO,GAAG,CAAC;AACb,CAAC;AAnBD,wCAmBC","sourcesContent":["import { Duplex } from 'stream';\n\nimport ObjectMultiplex from '@metamask/object-multiplex';\nimport {\n  SnapRpcHook,\n  SnapRpcHookArgs,\n  SNAP_STREAM_NAMES,\n} from '@metamask/snaps-utils';\n\nimport { BasePostMessageStream } from '@metamask/post-message-stream';\nimport {\n  Duration,\n  isJsonRpcNotification,\n  isObject,\n  Json,\n  JsonRpcNotification,\n} from '@metamask/utils';\nimport {\n  JsonRpcEngine,\n  // TODO: Replace with @metamask/utils version after bumping json-rpc-engine\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from 'json-rpc-engine';\nimport { createStreamMiddleware } from 'json-rpc-middleware-stream';\nimport { nanoid } from 'nanoid';\nimport pump from 'pump';\nimport { hasTimedOut, withTimeout } from '../utils';\nimport {\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 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      (snapId: string, options: SnapRpcHookArgs) =>\n        this.handleRpcRequest(snapId, options),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:executeSnap`,\n      (snapData: SnapExecutionData) => this.executeSnap(snapData),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateSnap`,\n      (snapId: string) => this.terminateSnap(snapId),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateAllSnaps`,\n      () => 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 infite 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      console.error(`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 (err) {\n        console.error('Error while destroying stream', err);\n      }\n    });\n\n    this.terminateJob(jobWrapper);\n\n    this.#removeSnapAndJobMapping(jobId);\n    this.jobs.delete(jobId);\n    console.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    pump(jsonRpcConnection.stream, streams.command, jsonRpcConnection.stream);\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    // Typecast justification: stream type mismatch\n    const mux = setupMultiplex(\n      envStream as unknown as Duplex,\n      `Job: \"${jobId}\"`,\n    );\n\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<unknown>\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          console.error(\n            new Error(\n              `Received malformed \"${message.method}\" command stream notification.`,\n            ),\n          );\n        }\n      } else {\n        console.error(\n          new Error(\n            `Received unexpected command stream notification \"${message.method}\".`,\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 as unknown as Duplex,\n        rpc: rpcStream,\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((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 async 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 as unknown as Duplex;\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<unknown>,\n  ): Promise<unknown> {\n    if (typeof message !== 'object') {\n      throw new Error('Must send object.');\n    }\n\n    const job = this.jobs.get(jobId);\n    if (!job) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    console.log('Parent: Sending Command', message);\n    const response: PendingJsonRpcResponse<unknown> =\n      await job.rpcEngine.handle(message);\n    if (response.error) {\n      throw new Error(response.error.message);\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,\n          target: snapId,\n        },\n      });\n    };\n\n    this.#snapRpcHooks.set(snapId, rpcHook);\n  }\n\n  /**\n   * Gets the job id for a given snap.\n   *\n   * @param snapId - A given snap id.\n   * @returns The ID of the snap's job.\n   */\n  #getJobForSnap(snapId: string): string | undefined {\n    return this.#snapToJobMap.get(snapId);\n  }\n\n  /**\n   * Gets the snap id for a given job.\n   *\n   * @param jobId - A given job id.\n   * @returns The ID of the snap that is running the job.\n   */\n  #getSnapForJob(jobId: string): string | undefined {\n    return this.#jobToSnapMap.get(jobId);\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 = await 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  pump(\n    connectionStream,\n    // Typecast: stream type mismatch\n    mux as unknown as Duplex,\n    connectionStream,\n    (err) => {\n      if (err) {\n        streamName\n          ? console.error(`\"${streamName}\" stream failure.`, err)\n          : console.error(err);\n      }\n    },\n  );\n  return mux;\n}\n"]}

package/dist/services/ExecutionService.d.ts

@@ -0,0 +1,68 @@
+import { RestrictedControllerMessenger } from '@metamask/controllers';
+import { SnapId, SnapRpcHookArgs } from '@metamask/snaps-utils';
+import { Json } from '@metamask/types';
+declare type TerminateSnap = (snapId: string) => Promise<void>;
+declare type TerminateAll = () => Promise<void>;
+declare type ExecuteSnap = (snapData: SnapExecutionData) => Promise<unknown>;
+declare type HandleRpcRequest = (snapId: string, options: SnapRpcHookArgs) => Promise<unknown>;
+export interface ExecutionService {
+    terminateSnap: TerminateSnap;
+    terminateAllSnaps: TerminateAll;
+    executeSnap: ExecuteSnap;
+    handleRpcRequest: HandleRpcRequest;
+}
+export declare type SnapExecutionData = {
+    snapId: string;
+    sourceCode: string;
+    endowments?: Json;
+};
+export declare type SnapErrorJson = {
+    message: string;
+    code: number;
+    data?: Json;
+};
+declare const controllerName = "ExecutionService";
+export declare type ErrorMessageEvent = {
+    type: 'ExecutionService:unhandledError';
+    payload: [SnapId, SnapErrorJson];
+};
+export declare type OutboundRequest = {
+    type: 'ExecutionService:outboundRequest';
+    payload: [SnapId];
+};
+export declare type OutboundResponse = {
+    type: 'ExecutionService:outboundResponse';
+    payload: [SnapId];
+};
+export declare type ExecutionServiceEvents = ErrorMessageEvent | OutboundRequest | OutboundResponse;
+/**
+ * Handles RPC request.
+ */
+export declare type HandleRpcRequestAction = {
+    type: `${typeof controllerName}:handleRpcRequest`;
+    handler: ExecutionService['handleRpcRequest'];
+};
+/**
+ * Executes a given snap.
+ */
+export declare type ExecuteSnapAction = {
+    type: `${typeof controllerName}:executeSnap`;
+    handler: ExecutionService['executeSnap'];
+};
+/**
+ * Terminates a given snap.
+ */
+export declare type TerminateSnapAction = {
+    type: `${typeof controllerName}:terminateSnap`;
+    handler: ExecutionService['terminateSnap'];
+};
+/**
+ * Terminates all snaps.
+ */
+export declare type TerminateAllSnapsAction = {
+    type: `${typeof controllerName}:terminateAllSnaps`;
+    handler: ExecutionService['terminateAllSnaps'];
+};
+export declare type ExecutionServiceActions = HandleRpcRequestAction | ExecuteSnapAction | TerminateSnapAction | TerminateAllSnapsAction;
+export declare type ExecutionServiceMessenger = RestrictedControllerMessenger<'ExecutionService', ExecutionServiceActions, ExecutionServiceEvents, ExecutionServiceActions['type'], ExecutionServiceEvents['type']>;
+export {};

package/dist/services/ExecutionService.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const controllerName = 'ExecutionService';
+//# sourceMappingURL=ExecutionService.js.map

package/dist/services/ExecutionService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExecutionService.js","sourceRoot":"","sources":["../../src/services/ExecutionService.ts"],"names":[],"mappings":";;AAiCA,MAAM,cAAc,GAAG,kBAAkB,CAAC","sourcesContent":["import { RestrictedControllerMessenger } from '@metamask/controllers';\nimport { SnapId, SnapRpcHookArgs } from '@metamask/snaps-utils';\n\nimport { Json } from '@metamask/types';\n\ntype TerminateSnap = (snapId: string) => Promise<void>;\ntype TerminateAll = () => Promise<void>;\ntype ExecuteSnap = (snapData: SnapExecutionData) => Promise<unknown>;\n\ntype HandleRpcRequest = (\n  snapId: string,\n  options: SnapRpcHookArgs,\n) => Promise<unknown>;\n\nexport interface ExecutionService {\n  terminateSnap: TerminateSnap;\n  terminateAllSnaps: TerminateAll;\n  executeSnap: ExecuteSnap;\n  handleRpcRequest: HandleRpcRequest;\n}\n\nexport type SnapExecutionData = {\n  snapId: string;\n  sourceCode: string;\n  endowments?: Json;\n};\n\nexport type SnapErrorJson = {\n  message: string;\n  code: number;\n  data?: Json;\n};\n\nconst controllerName = 'ExecutionService';\n\nexport type ErrorMessageEvent = {\n  type: 'ExecutionService:unhandledError';\n  payload: [SnapId, SnapErrorJson];\n};\n\nexport type OutboundRequest = {\n  type: 'ExecutionService:outboundRequest';\n  payload: [SnapId];\n};\n\nexport type OutboundResponse = {\n  type: 'ExecutionService:outboundResponse';\n  payload: [SnapId];\n};\n\nexport type ExecutionServiceEvents =\n  | ErrorMessageEvent\n  | OutboundRequest\n  | OutboundResponse;\n\n/**\n * Handles RPC request.\n */\nexport type HandleRpcRequestAction = {\n  type: `${typeof controllerName}:handleRpcRequest`;\n  handler: ExecutionService['handleRpcRequest'];\n};\n\n/**\n * Executes a given snap.\n */\nexport type ExecuteSnapAction = {\n  type: `${typeof controllerName}:executeSnap`;\n  handler: ExecutionService['executeSnap'];\n};\n\n/**\n * Terminates a given snap.\n */\nexport type TerminateSnapAction = {\n  type: `${typeof controllerName}:terminateSnap`;\n  handler: ExecutionService['terminateSnap'];\n};\n\n/**\n * Terminates all snaps.\n */\nexport type TerminateAllSnapsAction = {\n  type: `${typeof controllerName}:terminateAllSnaps`;\n  handler: ExecutionService['terminateAllSnaps'];\n};\n\nexport type ExecutionServiceActions =\n  | HandleRpcRequestAction\n  | ExecuteSnapAction\n  | TerminateSnapAction\n  | TerminateAllSnapsAction;\n\nexport type ExecutionServiceMessenger = RestrictedControllerMessenger<\n  'ExecutionService',\n  ExecutionServiceActions,\n  ExecutionServiceEvents,\n  ExecutionServiceActions['type'],\n  ExecutionServiceEvents['type']\n>;\n"]}

package/dist/services/browser.d.ts

@@ -0,0 +1,3 @@
+export * from './AbstractExecutionService';
+export * from './ExecutionService';
+export * from './iframe';