@metamask/snaps-execution-environments 0.38.1-flask.1 → 1.0.0

package/dist/{types/common → common}/BaseSnapExecutor.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="node" />
 /// <reference types="ses" />
-import type { HandlerType, SnapExportsParameters } from '@metamask/snaps-utils';
-import type { JsonRpcNotification, JsonRpcId, Json } from '@metamask/utils';
-import type { Duplex } from 'stream';
+import { HandlerType, SnapExportsParameters } from '@metamask/snaps-utils';
+import { JsonRpcNotification, JsonRpcId, Json } from '@metamask/utils';
+import { Duplex } from 'stream';
 export declare type InvokeSnapArgs = Omit<SnapExportsParameters[0], 'chainId'>;
 export declare type InvokeSnap = (target: string, handler: HandlerType, args: InvokeSnapArgs | undefined) => Promise<Json>;
 export declare class BaseSnapExecutor {
@@ -22,11 +22,11 @@ export declare class BaseSnapExecutor {
      * Attempts to evaluate a snap in SES. Generates APIs for the snap. May throw
      * on errors.
      *
-     * @param snapId - The id of the snap.
+     * @param snapName - The name of the snap.
      * @param sourceCode - The source code of the snap, in IIFE format.
      * @param _endowments - An array of the names of the endowments.
      */
-    protected startSnap(snapId: string, sourceCode: string, _endowments?: string[]): Promise<void>;
+    protected startSnap(snapName: string, sourceCode: string, _endowments?: string[]): Promise<void>;
     /**
      * Cancels all running evaluations of all snaps and clears all snap data.
      * NOTE:** Should only be called in response to the `terminate` RPC command.
@@ -50,7 +50,7 @@ export declare class BaseSnapExecutor {
     /**
      * Removes the snap with the given name.
      *
-     * @param snapId - The id of the snap to remove.
+     * @param snapName - The name of the snap to remove.
      */
     private removeSnap;
     /**
@@ -59,7 +59,7 @@ export declare class BaseSnapExecutor {
      * counted as an evaluation of the specified snap. When the count of running
      * evaluations of a snap reaches zero, its endowments are torn down.
      *
-     * @param snapId - The id of the snap whose context to execute in.
+     * @param snapName - The name of the snap whose context to execute in.
      * @param executor - The function that will be executed in the snap's context.
      * @returns The executor's return value.
      * @template Result - The return value of the executor.

package/dist/common/BaseSnapExecutor.js

@@ -0,0 +1,370 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseSnapExecutor = void 0;
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
+/// <reference path="../../../../node_modules/ses/types.d.ts" />
+const providers_1 = require("@metamask/providers");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const eth_rpc_errors_1 = require("eth-rpc-errors");
+const json_rpc_engine_1 = require("json-rpc-engine");
+const superstruct_1 = require("superstruct");
+const logging_1 = require("../logging");
+const openrpc_json_1 = __importDefault(require("../openrpc.json"));
+const commands_1 = require("./commands");
+const endowments_1 = require("./endowments");
+const globalEvents_1 = require("./globalEvents");
+const keyring_1 = require("./keyring");
+const sortParams_1 = require("./sortParams");
+const utils_2 = require("./utils");
+const validation_1 = require("./validation");
+const fallbackError = {
+    code: eth_rpc_errors_1.errorCodes.rpc.internal,
+    message: 'Execution Environment Error',
+};
+/**
+ * The supported methods in the execution environment. The validator checks the
+ * incoming JSON-RPC request, and the `params` property is used for sorting the
+ * parameters, if they are an object.
+ */
+const EXECUTION_ENVIRONMENT_METHODS = {
+    ping: {
+        struct: validation_1.PingRequestArgumentsStruct,
+        params: [],
+    },
+    executeSnap: {
+        struct: validation_1.ExecuteSnapRequestArgumentsStruct,
+        params: ['snapName', 'sourceCode', 'endowments'],
+    },
+    terminate: {
+        struct: validation_1.TerminateRequestArgumentsStruct,
+        params: [],
+    },
+    snapRpc: {
+        struct: validation_1.SnapRpcRequestArgumentsStruct,
+        params: ['target', 'handler', 'origin', 'request'],
+    },
+};
+class BaseSnapExecutor {
+    constructor(commandStream, rpcStream) {
+        this.lastTeardown = 0;
+        this.snapData = new Map();
+        this.commandStream = commandStream;
+        this.commandStream.on('data', (data) => {
+            this.onCommandRequest(data).catch((error) => {
+                // TODO: Decide how to handle errors.
+                (0, snaps_utils_1.logError)(error);
+            });
+        });
+        this.rpcStream = rpcStream;
+        this.methods = (0, commands_1.getCommandMethodImplementations)(this.startSnap.bind(this), async (target, handlerName, args) => {
+            const data = this.snapData.get(target);
+            // We're capturing the handler in case someone modifies the data object before the call
+            const handler = handlerName === snaps_utils_1.HandlerType.SnapKeyring
+                ? (0, keyring_1.wrapKeyring)(this.notify.bind(this), data?.exports.keyring)
+                : data?.exports[handlerName];
+            (0, utils_1.assert)(handler !== undefined, `No ${handlerName} handler exported for snap "${target}`);
+            // TODO: fix handler args type cast
+            let result = await this.executeInSnapContext(target, () => handler(args));
+            // The handler might not return anything, but undefined is not valid JSON.
+            if (result === undefined) {
+                result = null;
+            }
+            // /!\ Always return only sanitized JSON to prevent security flaws. /!\
+            try {
+                return (0, utils_1.getSafeJson)(result);
+            }
+            catch (error) {
+                throw new TypeError(`Received non-JSON-serializable value: ${error.message.replace(/^Assertion failed: /u, '')}`);
+            }
+        }, this.onTerminate.bind(this));
+    }
+    errorHandler(error, data) {
+        const constructedError = (0, utils_2.constructError)(error);
+        const serializedError = (0, eth_rpc_errors_1.serializeError)(constructedError, {
+            fallbackError,
+            shouldIncludeStack: false,
+        });
+        // We're setting it this way to avoid sentData.stack = undefined
+        const sentData = { ...data, stack: constructedError?.stack ?? null };
+        this.notify({
+            method: 'UnhandledError',
+            params: {
+                error: {
+                    ...serializedError,
+                    data: sentData,
+                },
+            },
+        });
+    }
+    async onCommandRequest(message) {
+        if (!(0, utils_1.isJsonRpcRequest)(message)) {
+            throw new Error('Command stream received a non-JSON-RPC request.');
+        }
+        const { id, method, params } = message;
+        if (method === 'rpc.discover') {
+            this.respond(id, {
+                result: openrpc_json_1.default,
+            });
+            return;
+        }
+        if (!(0, utils_1.hasProperty)(EXECUTION_ENVIRONMENT_METHODS, method)) {
+            this.respond(id, {
+                error: eth_rpc_errors_1.ethErrors.rpc
+                    .methodNotFound({
+                    data: {
+                        method,
+                    },
+                })
+                    .serialize(),
+            });
+            return;
+        }
+        const methodObject = EXECUTION_ENVIRONMENT_METHODS[method];
+        // support params by-name and by-position
+        const paramsAsArray = (0, sortParams_1.sortParamKeys)(methodObject.params, params);
+        const [error] = (0, superstruct_1.validate)(paramsAsArray, methodObject.struct);
+        if (error) {
+            this.respond(id, {
+                error: eth_rpc_errors_1.ethErrors.rpc
+                    .invalidParams({
+                    message: `Invalid parameters for method "${method}": ${error.message}.`,
+                    data: {
+                        method,
+                        params: paramsAsArray,
+                    },
+                })
+                    .serialize(),
+            });
+            return;
+        }
+        try {
+            const result = await this.methods[method](...paramsAsArray);
+            this.respond(id, { result });
+        }
+        catch (rpcError) {
+            this.respond(id, {
+                error: (0, eth_rpc_errors_1.serializeError)(rpcError, {
+                    fallbackError,
+                }),
+            });
+        }
+    }
+    notify(requestObject) {
+        if (!(0, utils_1.isValidJson)(requestObject) || !(0, utils_1.isObject)(requestObject)) {
+            throw new Error('JSON-RPC notifications must be JSON serializable objects');
+        }
+        this.commandStream.write({
+            ...requestObject,
+            jsonrpc: '2.0',
+        });
+    }
+    respond(id, requestObject) {
+        if (!(0, utils_1.isValidJson)(requestObject) || !(0, utils_1.isObject)(requestObject)) {
+            throw new Error('JSON-RPC responses must be JSON serializable objects.');
+        }
+        this.commandStream.write({
+            ...requestObject,
+            id,
+            jsonrpc: '2.0',
+        });
+    }
+    /**
+     * Attempts to evaluate a snap in SES. Generates APIs for the snap. May throw
+     * on errors.
+     *
+     * @param snapName - The name of the snap.
+     * @param sourceCode - The source code of the snap, in IIFE format.
+     * @param _endowments - An array of the names of the endowments.
+     */
+    async startSnap(snapName, sourceCode, _endowments) {
+        (0, logging_1.log)(`Starting snap '${snapName}' in worker.`);
+        if (this.snapPromiseErrorHandler) {
+            (0, globalEvents_1.removeEventListener)('unhandledrejection', this.snapPromiseErrorHandler);
+        }
+        if (this.snapErrorHandler) {
+            (0, globalEvents_1.removeEventListener)('error', this.snapErrorHandler);
+        }
+        this.snapErrorHandler = (error) => {
+            this.errorHandler(error.error, { snapName });
+        };
+        this.snapPromiseErrorHandler = (error) => {
+            this.errorHandler(error instanceof Error ? error : error.reason, {
+                snapName,
+            });
+        };
+        const provider = new providers_1.StreamProvider(this.rpcStream, {
+            jsonRpcStreamName: 'metamask-provider',
+            rpcMiddleware: [(0, json_rpc_engine_1.createIdRemapMiddleware)()],
+        });
+        await provider.initialize();
+        const snap = this.createSnapGlobal(provider);
+        const ethereum = this.createEIP1193Provider(provider);
+        // We specifically use any type because the Snap can modify the object any way they want
+        const snapModule = { exports: {} };
+        try {
+            const { endowments, teardown: endowmentTeardown } = (0, endowments_1.createEndowments)(snap, ethereum, _endowments);
+            // !!! Ensure that this is the only place the data is being set.
+            // Other methods access the object value and mutate its properties.
+            this.snapData.set(snapName, {
+                idleTeardown: endowmentTeardown,
+                runningEvaluations: new Set(),
+                exports: {},
+            });
+            (0, globalEvents_1.addEventListener)('unhandledRejection', this.snapPromiseErrorHandler);
+            (0, globalEvents_1.addEventListener)('error', this.snapErrorHandler);
+            const compartment = new Compartment({
+                ...endowments,
+                module: snapModule,
+                exports: snapModule.exports,
+            });
+            // All of those are JavaScript runtime specific and self referential,
+            // but we add them for compatibility sake with external libraries.
+            //
+            // We can't do that in the injected globals object above
+            // because SES creates its own globalThis
+            compartment.globalThis.self = compartment.globalThis;
+            compartment.globalThis.global = compartment.globalThis;
+            compartment.globalThis.window = compartment.globalThis;
+            await this.executeInSnapContext(snapName, () => {
+                compartment.evaluate(sourceCode);
+                this.registerSnapExports(snapName, snapModule);
+            });
+        }
+        catch (error) {
+            this.removeSnap(snapName);
+            throw new Error(`Error while running snap '${snapName}': ${error.message}`);
+        }
+    }
+    /**
+     * Cancels all running evaluations of all snaps and clears all snap data.
+     * NOTE:** Should only be called in response to the `terminate` RPC command.
+     */
+    onTerminate() {
+        // `stop()` tears down snap endowments.
+        // Teardown will also be run for each snap as soon as there are
+        // no more running evaluations for that snap.
+        this.snapData.forEach((data) => data.runningEvaluations.forEach((evaluation) => evaluation.stop()));
+        this.snapData.clear();
+    }
+    registerSnapExports(snapName, snapModule) {
+        const data = this.snapData.get(snapName);
+        // Somebody deleted the Snap before we could register
+        if (!data) {
+            return;
+        }
+        data.exports = snaps_utils_1.SNAP_EXPORT_NAMES.reduce((acc, exportName) => {
+            const snapExport = snapModule.exports[exportName];
+            if ((0, validation_1.validateExport)(exportName, snapExport)) {
+                return { ...acc, [exportName]: snapExport };
+            }
+            return acc;
+        }, {});
+    }
+    /**
+     * Instantiates a snap API object (i.e. `globalThis.snap`).
+     *
+     * @param provider - A StreamProvider connected to MetaMask.
+     * @returns The snap provider object.
+     */
+    createSnapGlobal(provider) {
+        const originalRequest = provider.request.bind(provider);
+        const request = async (args) => {
+            (0, utils_2.assertSnapOutboundRequest)(args);
+            const sanitizedArgs = (0, utils_1.getSafeJson)(args);
+            this.notify({ method: 'OutboundRequest' });
+            try {
+                return await (0, utils_2.withTeardown)(originalRequest(sanitizedArgs), this);
+            }
+            finally {
+                this.notify({ method: 'OutboundResponse' });
+            }
+        };
+        // Proxy target is intentionally set to be an empty object, to ensure
+        // that access to the prototype chain is not possible.
+        const snapGlobalProxy = new Proxy({}, {
+            has(_target, prop) {
+                return typeof prop === 'string' && ['request'].includes(prop);
+            },
+            get(_target, prop) {
+                if (prop === 'request') {
+                    return request;
+                }
+                return undefined;
+            },
+        });
+        return harden(snapGlobalProxy);
+    }
+    /**
+     * Instantiates an EIP-1193 Ethereum provider object (i.e. `globalThis.ethereum`).
+     *
+     * @param provider - A StreamProvider connected to MetaMask.
+     * @returns The EIP-1193 Ethereum provider object.
+     */
+    createEIP1193Provider(provider) {
+        const originalRequest = provider.request.bind(provider);
+        const request = async (args) => {
+            (0, utils_2.assertEthereumOutboundRequest)(args);
+            const sanitizedArgs = (0, utils_1.getSafeJson)(args);
+            this.notify({ method: 'OutboundRequest' });
+            try {
+                return await (0, utils_2.withTeardown)(originalRequest(sanitizedArgs), this);
+            }
+            finally {
+                this.notify({ method: 'OutboundResponse' });
+            }
+        };
+        const streamProviderProxy = (0, utils_2.proxyStreamProvider)(provider, request);
+        return harden(streamProviderProxy);
+    }
+    /**
+     * Removes the snap with the given name.
+     *
+     * @param snapName - The name of the snap to remove.
+     */
+    removeSnap(snapName) {
+        this.snapData.delete(snapName);
+    }
+    /**
+     * Calls the specified executor function in the context of the specified snap.
+     * Essentially, this means that the operation performed by the executor is
+     * counted as an evaluation of the specified snap. When the count of running
+     * evaluations of a snap reaches zero, its endowments are torn down.
+     *
+     * @param snapName - The name of the snap whose context to execute in.
+     * @param executor - The function that will be executed in the snap's context.
+     * @returns The executor's return value.
+     * @template Result - The return value of the executor.
+     */
+    async executeInSnapContext(snapName, executor) {
+        const data = this.snapData.get(snapName);
+        if (data === undefined) {
+            throw new Error(`Tried to execute in context of unknown snap: "${snapName}".`);
+        }
+        let stop;
+        const stopPromise = new Promise((_, reject) => (stop = () => reject(
+        // TODO(rekmarks): Specify / standardize error code for this case.
+        eth_rpc_errors_1.ethErrors.rpc.internal(`The snap "${snapName}" has been terminated during execution.`))));
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const evaluationData = { stop: stop };
+        try {
+            data.runningEvaluations.add(evaluationData);
+            // Notice that we have to await this executor.
+            // If we didn't, we would decrease the amount of running evaluations
+            // before the promise actually resolves
+            return await Promise.race([executor(), stopPromise]);
+        }
+        finally {
+            data.runningEvaluations.delete(evaluationData);
+            if (data.runningEvaluations.size === 0) {
+                this.lastTeardown += 1;
+                await data.idleTeardown();
+            }
+        }
+    }
+}
+exports.BaseSnapExecutor = BaseSnapExecutor;
+//# sourceMappingURL=BaseSnapExecutor.js.map

package/dist/common/BaseSnapExecutor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseSnapExecutor.js","sourceRoot":"","sources":["../../src/common/BaseSnapExecutor.ts"],"names":[],"mappings":";;;;;;AAAA,qFAAqF;AACrF,gEAAgE;AAChE,mDAAqD;AAGrD,uDAM+B;AAC/B,2CAWyB;AACzB,mDAAuE;AACvE,qDAA0D;AAE1D,6CAAuC;AAEvC,wCAAiC;AACjC,mEAAgD;AAChD,yCAGoB;AACpB,6CAAgD;AAChD,iDAAuE;AACvE,uCAAwC;AACxC,6CAA6C;AAC7C,mCAMiB;AACjB,6CAMsB;AAYtB,MAAM,aAAa,GAAG;IACpB,IAAI,EAAE,2BAAU,CAAC,GAAG,CAAC,QAAQ;IAC7B,OAAO,EAAE,6BAA6B;CACvC,CAAC;AAYF;;;;GAIG;AACH,MAAM,6BAA6B,GAAG;IACpC,IAAI,EAAE;QACJ,MAAM,EAAE,uCAA0B;QAClC,MAAM,EAAE,EAAE;KACX;IACD,WAAW,EAAE;QACX,MAAM,EAAE,8CAAiC;QACzC,MAAM,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,YAAY,CAAC;KACjD;IACD,SAAS,EAAE;QACT,MAAM,EAAE,4CAA+B;QACvC,MAAM,EAAE,EAAE;KACX;IACD,OAAO,EAAE;QACP,MAAM,EAAE,0CAA6B;QACrC,MAAM,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC;KACnD;CACF,CAAC;AAIF,MAAa,gBAAgB;IAe3B,YAAsB,aAAqB,EAAE,SAAiB;QAFtD,iBAAY,GAAG,CAAC,CAAC;QAGvB,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YACrC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC1C,qCAAqC;gBACrC,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,CAAC,OAAO,GAAG,IAAA,0CAA+B,EAC5C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EACzB,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACvC,uFAAuF;YACvF,MAAM,OAAO,GACX,WAAW,KAAK,yBAAW,CAAC,WAAW;gBACrC,CAAC,CAAC,IAAA,qBAAW,EAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC;gBAC5D,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;YACjC,IAAA,cAAM,EACJ,OAAO,KAAK,SAAS,EACrB,MAAM,WAAW,+BAA+B,MAAM,EAAE,CACzD,CAAC;YACF,mCAAmC;YACnC,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,GAAG,EAAE,CACxD,OAAO,CAAC,IAAW,CAAC,CACrB,CAAC;YAEF,0EAA0E;YAC1E,IAAI,MAAM,KAAK,SAAS,EAAE;gBACxB,MAAM,GAAG,IAAI,CAAC;aACf;YAED,uEAAuE;YACvE,IAAI;gBACF,OAAO,IAAA,mBAAW,EAAC,MAAM,CAAC,CAAC;aAC5B;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,SAAS,CACjB,yCAAyC,KAAK,CAAC,OAAO,CAAC,OAAO,CAC5D,sBAAsB,EACtB,EAAE,CACH,EAAE,CACJ,CAAC;aACH;QACH,CAAC,EACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5B,CAAC;IACJ,CAAC;IAEO,YAAY,CAAC,KAAc,EAAE,IAA0B;QAC7D,MAAM,gBAAgB,GAAG,IAAA,sBAAc,EAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,eAAe,GAAG,IAAA,+BAAc,EAAC,gBAAgB,EAAE;YACvD,aAAa;YACb,kBAAkB,EAAE,KAAK;SAC1B,CAAC,CAAC;QAEH,gEAAgE;QAChE,MAAM,QAAQ,GAAS,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC;QAE3E,IAAI,CAAC,MAAM,CAAC;YACV,MAAM,EAAE,gBAAgB;YACxB,MAAM,EAAE;gBACN,KAAK,EAAE;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACpD,IAAI,CAAC,IAAA,wBAAgB,EAAC,OAAO,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QAED,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QACvC,IAAI,MAAM,KAAK,cAAc,EAAE;YAC7B,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,MAAM,EAAE,sBAAiB;aAC1B,CAAC,CAAC;YACH,OAAO;SACR;QAED,IAAI,CAAC,IAAA,mBAAW,EAAC,6BAA6B,EAAE,MAAM,CAAC,EAAE;YACvD,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,KAAK,EAAE,0BAAS,CAAC,GAAG;qBACjB,cAAc,CAAC;oBACd,IAAI,EAAE;wBACJ,MAAM;qBACP;iBACF,CAAC;qBACD,SAAS,EAAE;aACf,CAAC,CAAC;YACH,OAAO;SACR;QAED,MAAM,YAAY,GAAG,6BAA6B,CAAC,MAAuB,CAAC,CAAC;QAE5E,yCAAyC;QACzC,MAAM,aAAa,GAAG,IAAA,0BAAa,EAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAEjE,MAAM,CAAC,KAAK,CAAC,GAAG,IAAA,sBAAQ,EAAW,aAAa,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QACvE,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,KAAK,EAAE,0BAAS,CAAC,GAAG;qBACjB,aAAa,CAAC;oBACb,OAAO,EAAE,kCAAkC,MAAM,MAAM,KAAK,CAAC,OAAO,GAAG;oBACvE,IAAI,EAAE;wBACJ,MAAM;wBACN,MAAM,EAAE,aAAa;qBACtB;iBACF,CAAC;qBACD,SAAS,EAAE;aACf,CAAC,CAAC;YACH,OAAO;SACR;QAED,IAAI;YACF,MAAM,MAAM,GAAG,MAAO,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;SAC9B;QAAC,OAAO,QAAQ,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,KAAK,EAAE,IAAA,+BAAc,EAAC,QAAQ,EAAE;oBAC9B,aAAa;iBACd,CAAC;aACH,CAAC,CAAC;SACJ;IACH,CAAC;IAES,MAAM,CAAC,aAAmD;QAClE,IAAI,CAAC,IAAA,mBAAW,EAAC,aAAa,CAAC,IAAI,CAAC,IAAA,gBAAQ,EAAC,aAAa,CAAC,EAAE;YAC3D,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;SACH;QAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YACvB,GAAG,aAAa;YAChB,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;IACL,CAAC;IAES,OAAO,CAAC,EAAa,EAAE,aAAsC;QACrE,IAAI,CAAC,IAAA,mBAAW,EAAC,aAAa,CAAC,IAAI,CAAC,IAAA,gBAAQ,EAAC,aAAa,CAAC,EAAE;YAC3D,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC1E;QAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YACvB,GAAG,aAAa;YAChB,EAAE;YACF,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,SAAS,CACvB,QAAgB,EAChB,UAAkB,EAClB,WAAsB;QAEtB,IAAA,aAAG,EAAC,kBAAkB,QAAQ,cAAc,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,uBAAuB,EAAE;YAChC,IAAA,kCAAmB,EAAC,oBAAoB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;SACzE;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,IAAA,kCAAmB,EAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACrD;QAED,IAAI,CAAC,gBAAgB,GAAG,CAAC,KAAiB,EAAE,EAAE;YAC5C,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC,CAAC;QAEF,IAAI,CAAC,uBAAuB,GAAG,CAAC,KAA4B,EAAE,EAAE;YAC9D,IAAI,CAAC,YAAY,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE;gBAC/D,QAAQ;aACT,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,0BAAc,CAAC,IAAI,CAAC,SAAS,EAAE;YAClD,iBAAiB,EAAE,mBAAmB;YACtC,aAAa,EAAE,CAAC,IAAA,yCAAuB,GAAE,CAAC;SAC3C,CAAC,CAAC;QAEH,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;QAE5B,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QACtD,wFAAwF;QACxF,MAAM,UAAU,GAAQ,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAExC,IAAI;YACF,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,iBAAiB,EAAE,GAAG,IAAA,6BAAgB,EAClE,IAAI,EACJ,QAAQ,EACR,WAAW,CACZ,CAAC;YAEF,gEAAgE;YAChE,mEAAmE;YACnE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE;gBAC1B,YAAY,EAAE,iBAAiB;gBAC/B,kBAAkB,EAAE,IAAI,GAAG,EAAE;gBAC7B,OAAO,EAAE,EAAE;aACZ,CAAC,CAAC;YAEH,IAAA,+BAAgB,EAAC,oBAAoB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACrE,IAAA,+BAAgB,EAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAEjD,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC;gBAClC,GAAG,UAAU;gBACb,MAAM,EAAE,UAAU;gBAClB,OAAO,EAAE,UAAU,CAAC,OAAO;aAC5B,CAAC,CAAC;YACH,qEAAqE;YACrE,kEAAkE;YAClE,EAAE;YACF,wDAAwD;YACxD,yCAAyC;YACzC,WAAW,CAAC,UAAU,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC;YACrD,WAAW,CAAC,UAAU,CAAC,MAAM,GAAG,WAAW,CAAC,UAAU,CAAC;YACvD,WAAW,CAAC,UAAU,CAAC,MAAM,GAAG,WAAW,CAAC,UAAU,CAAC;YAEvD,MAAM,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,GAAG,EAAE;gBAC7C,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACjC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,6BAA6B,QAAQ,MAAO,KAAe,CAAC,OAAO,EAAE,CACtE,CAAC;SACH;IACH,CAAC;IAED;;;OAGG;IACO,WAAW;QACnB,uCAAuC;QACvC,+DAA+D;QAC/D,6CAA6C;QAC7C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7B,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CACnE,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAEO,mBAAmB,CAAC,QAAgB,EAAE,UAAe;QAC3D,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,qDAAqD;QACrD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QAED,IAAI,CAAC,OAAO,GAAG,+BAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE;YAC1D,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAClD,IAAI,IAAA,2BAAc,EAAC,UAAU,EAAE,UAAU,CAAC,EAAE;gBAC1C,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC;aAC7C;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;;OAKG;IACK,gBAAgB,CAAC,QAAwB;QAC/C,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExD,MAAM,OAAO,GAAG,KAAK,EAAE,IAAsB,EAAE,EAAE;YAC/C,IAAA,iCAAyB,EAAC,IAAI,CAAC,CAAC;YAChC,MAAM,aAAa,GAAG,IAAA,mBAAW,EAAC,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC3C,IAAI;gBACF,OAAO,MAAM,IAAA,oBAAY,EACvB,eAAe,CAAC,aAA4C,CAAC,EAC7D,IAAW,CACZ,CAAC;aACH;oBAAS;gBACR,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC;aAC7C;QACH,CAAC,CAAC;QAEF,qEAAqE;QACrE,sDAAsD;QACtD,MAAM,eAAe,GAAG,IAAI,KAAK,CAC/B,EAAE,EACF;YACE,GAAG,CAAC,OAAe,EAAE,IAAqB;gBACxC,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAChE,CAAC;YACD,GAAG,CAAC,OAAO,EAAE,IAA0B;gBACrC,IAAI,IAAI,KAAK,SAAS,EAAE;oBACtB,OAAO,OAAO,CAAC;iBAChB;gBAED,OAAO,SAAS,CAAC;YACnB,CAAC;SACF,CACmB,CAAC;QAEvB,OAAO,MAAM,CAAC,eAAe,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,QAAwB;QACpD,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExD,MAAM,OAAO,GAAG,KAAK,EAAE,IAAsB,EAAE,EAAE;YAC/C,IAAA,qCAA6B,EAAC,IAAI,CAAC,CAAC;YACpC,MAAM,aAAa,GAAG,IAAA,mBAAW,EAAC,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC3C,IAAI;gBACF,OAAO,MAAM,IAAA,oBAAY,EACvB,eAAe,CAAC,aAA4C,CAAC,EAC7D,IAAW,CACZ,CAAC;aACH;oBAAS;gBACR,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC;aAC7C;QACH,CAAC,CAAC;QAEF,MAAM,mBAAmB,GAAG,IAAA,2BAAmB,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEnE,OAAO,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACK,UAAU,CAAC,QAAgB;QACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACK,KAAK,CAAC,oBAAoB,CAChC,QAAgB,EAChB,QAAwC;QAExC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,MAAM,IAAI,KAAK,CACb,iDAAiD,QAAQ,IAAI,CAC9D,CAAC;SACH;QAED,IAAI,IAAgB,CAAC;QACrB,MAAM,WAAW,GAAG,IAAI,OAAO,CAC7B,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CACZ,CAAC,IAAI,GAAG,GAAG,EAAE,CACX,MAAM;QACJ,kEAAkE;QAClE,0BAAS,CAAC,GAAG,CAAC,QAAQ,CACpB,aAAa,QAAQ,yCAAyC,CAC/D,CACF,CAAC,CACP,CAAC;QAEF,oEAAoE;QACpE,MAAM,cAAc,GAAG,EAAE,IAAI,EAAE,IAAK,EAAE,CAAC;QAEvC,IAAI;YACF,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC5C,8CAA8C;YAC9C,oEAAoE;YACpE,uCAAuC;YACvC,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;SACtD;gBAAS;YACR,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAE/C,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,KAAK,CAAC,EAAE;gBACtC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;gBACvB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;aAC3B;SACF;IACH,CAAC;CACF;AAraD,4CAqaC","sourcesContent":["// eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment\n/// <reference path=\"../../../../node_modules/ses/types.d.ts\" />\nimport { StreamProvider } from '@metamask/providers';\nimport { RequestArguments } from '@metamask/providers/dist/BaseProvider';\nimport { SnapsGlobalObject } from '@metamask/rpc-methods';\nimport {\n  SnapExports,\n  HandlerType,\n  SnapExportsParameters,\n  SNAP_EXPORT_NAMES,\n  logError,\n} from '@metamask/snaps-utils';\nimport {\n  isObject,\n  isValidJson,\n  JsonRpcNotification,\n  assert,\n  isJsonRpcRequest,\n  JsonRpcId,\n  JsonRpcRequest,\n  Json,\n  hasProperty,\n  getSafeJson,\n} from '@metamask/utils';\nimport { errorCodes, ethErrors, serializeError } from 'eth-rpc-errors';\nimport { createIdRemapMiddleware } from 'json-rpc-engine';\nimport { Duplex } from 'stream';\nimport { validate } from 'superstruct';\n\nimport { log } from '../logging';\nimport EEOpenRPCDocument from '../openrpc.json';\nimport {\n  CommandMethodsMapping,\n  getCommandMethodImplementations,\n} from './commands';\nimport { createEndowments } from './endowments';\nimport { addEventListener, removeEventListener } from './globalEvents';\nimport { wrapKeyring } from './keyring';\nimport { sortParamKeys } from './sortParams';\nimport {\n  assertEthereumOutboundRequest,\n  assertSnapOutboundRequest,\n  constructError,\n  proxyStreamProvider,\n  withTeardown,\n} from './utils';\nimport {\n  ExecuteSnapRequestArgumentsStruct,\n  PingRequestArgumentsStruct,\n  SnapRpcRequestArgumentsStruct,\n  TerminateRequestArgumentsStruct,\n  validateExport,\n} from './validation';\n\ntype EvaluationData = {\n  stop: () => void;\n};\n\ntype SnapData = {\n  exports: SnapExports;\n  runningEvaluations: Set<EvaluationData>;\n  idleTeardown: () => Promise<void>;\n};\n\nconst fallbackError = {\n  code: errorCodes.rpc.internal,\n  message: 'Execution Environment Error',\n};\n\n// TODO: `KeyringParameters` expects a `chainId` for certain methods, but we're\n// not providing it in `getHandlerArguments`, resulting in type errors.\nexport type InvokeSnapArgs = Omit<SnapExportsParameters[0], 'chainId'>;\n\nexport type InvokeSnap = (\n  target: string,\n  handler: HandlerType,\n  args: InvokeSnapArgs | undefined,\n) => Promise<Json>;\n\n/**\n * The supported methods in the execution environment. The validator checks the\n * incoming JSON-RPC request, and the `params` property is used for sorting the\n * parameters, if they are an object.\n */\nconst EXECUTION_ENVIRONMENT_METHODS = {\n  ping: {\n    struct: PingRequestArgumentsStruct,\n    params: [],\n  },\n  executeSnap: {\n    struct: ExecuteSnapRequestArgumentsStruct,\n    params: ['snapName', 'sourceCode', 'endowments'],\n  },\n  terminate: {\n    struct: TerminateRequestArgumentsStruct,\n    params: [],\n  },\n  snapRpc: {\n    struct: SnapRpcRequestArgumentsStruct,\n    params: ['target', 'handler', 'origin', 'request'],\n  },\n};\n\ntype Methods = typeof EXECUTION_ENVIRONMENT_METHODS;\n\nexport class BaseSnapExecutor {\n  private readonly snapData: Map<string, SnapData>;\n\n  private readonly commandStream: Duplex;\n\n  private readonly rpcStream: Duplex;\n\n  private readonly methods: CommandMethodsMapping;\n\n  private snapErrorHandler?: (event: ErrorEvent) => void;\n\n  private snapPromiseErrorHandler?: (event: PromiseRejectionEvent) => void;\n\n  private lastTeardown = 0;\n\n  protected constructor(commandStream: Duplex, rpcStream: Duplex) {\n    this.snapData = new Map();\n    this.commandStream = commandStream;\n    this.commandStream.on('data', (data) => {\n      this.onCommandRequest(data).catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n    });\n    this.rpcStream = rpcStream;\n\n    this.methods = getCommandMethodImplementations(\n      this.startSnap.bind(this),\n      async (target, handlerName, args) => {\n        const data = this.snapData.get(target);\n        // We're capturing the handler in case someone modifies the data object before the call\n        const handler =\n          handlerName === HandlerType.SnapKeyring\n            ? wrapKeyring(this.notify.bind(this), data?.exports.keyring)\n            : data?.exports[handlerName];\n        assert(\n          handler !== undefined,\n          `No ${handlerName} handler exported for snap \"${target}`,\n        );\n        // TODO: fix handler args type cast\n        let result = await this.executeInSnapContext(target, () =>\n          handler(args as any),\n        );\n\n        // The handler might not return anything, but undefined is not valid JSON.\n        if (result === undefined) {\n          result = null;\n        }\n\n        // /!\\ Always return only sanitized JSON to prevent security flaws. /!\\\n        try {\n          return getSafeJson(result);\n        } catch (error) {\n          throw new TypeError(\n            `Received non-JSON-serializable value: ${error.message.replace(\n              /^Assertion failed: /u,\n              '',\n            )}`,\n          );\n        }\n      },\n      this.onTerminate.bind(this),\n    );\n  }\n\n  private errorHandler(error: unknown, data: Record<string, Json>) {\n    const constructedError = constructError(error);\n    const serializedError = serializeError(constructedError, {\n      fallbackError,\n      shouldIncludeStack: false,\n    });\n\n    // We're setting it this way to avoid sentData.stack = undefined\n    const sentData: Json = { ...data, stack: constructedError?.stack ?? null };\n\n    this.notify({\n      method: 'UnhandledError',\n      params: {\n        error: {\n          ...serializedError,\n          data: sentData,\n        },\n      },\n    });\n  }\n\n  private async onCommandRequest(message: JsonRpcRequest) {\n    if (!isJsonRpcRequest(message)) {\n      throw new Error('Command stream received a non-JSON-RPC request.');\n    }\n\n    const { id, method, params } = message;\n    if (method === 'rpc.discover') {\n      this.respond(id, {\n        result: EEOpenRPCDocument,\n      });\n      return;\n    }\n\n    if (!hasProperty(EXECUTION_ENVIRONMENT_METHODS, method)) {\n      this.respond(id, {\n        error: ethErrors.rpc\n          .methodNotFound({\n            data: {\n              method,\n            },\n          })\n          .serialize(),\n      });\n      return;\n    }\n\n    const methodObject = EXECUTION_ENVIRONMENT_METHODS[method as keyof Methods];\n\n    // support params by-name and by-position\n    const paramsAsArray = sortParamKeys(methodObject.params, params);\n\n    const [error] = validate<any, any>(paramsAsArray, methodObject.struct);\n    if (error) {\n      this.respond(id, {\n        error: ethErrors.rpc\n          .invalidParams({\n            message: `Invalid parameters for method \"${method}\": ${error.message}.`,\n            data: {\n              method,\n              params: paramsAsArray,\n            },\n          })\n          .serialize(),\n      });\n      return;\n    }\n\n    try {\n      const result = await (this.methods as any)[method](...paramsAsArray);\n      this.respond(id, { result });\n    } catch (rpcError) {\n      this.respond(id, {\n        error: serializeError(rpcError, {\n          fallbackError,\n        }),\n      });\n    }\n  }\n\n  protected notify(requestObject: Omit<JsonRpcNotification, 'jsonrpc'>) {\n    if (!isValidJson(requestObject) || !isObject(requestObject)) {\n      throw new Error(\n        'JSON-RPC notifications must be JSON serializable objects',\n      );\n    }\n\n    this.commandStream.write({\n      ...requestObject,\n      jsonrpc: '2.0',\n    });\n  }\n\n  protected respond(id: JsonRpcId, requestObject: Record<string, unknown>) {\n    if (!isValidJson(requestObject) || !isObject(requestObject)) {\n      throw new Error('JSON-RPC responses must be JSON serializable objects.');\n    }\n\n    this.commandStream.write({\n      ...requestObject,\n      id,\n      jsonrpc: '2.0',\n    });\n  }\n\n  /**\n   * Attempts to evaluate a snap in SES. Generates APIs for the snap. May throw\n   * on errors.\n   *\n   * @param snapName - The name of the snap.\n   * @param sourceCode - The source code of the snap, in IIFE format.\n   * @param _endowments - An array of the names of the endowments.\n   */\n  protected async startSnap(\n    snapName: string,\n    sourceCode: string,\n    _endowments?: string[],\n  ): Promise<void> {\n    log(`Starting snap '${snapName}' in worker.`);\n    if (this.snapPromiseErrorHandler) {\n      removeEventListener('unhandledrejection', this.snapPromiseErrorHandler);\n    }\n\n    if (this.snapErrorHandler) {\n      removeEventListener('error', this.snapErrorHandler);\n    }\n\n    this.snapErrorHandler = (error: ErrorEvent) => {\n      this.errorHandler(error.error, { snapName });\n    };\n\n    this.snapPromiseErrorHandler = (error: PromiseRejectionEvent) => {\n      this.errorHandler(error instanceof Error ? error : error.reason, {\n        snapName,\n      });\n    };\n\n    const provider = new StreamProvider(this.rpcStream, {\n      jsonRpcStreamName: 'metamask-provider',\n      rpcMiddleware: [createIdRemapMiddleware()],\n    });\n\n    await provider.initialize();\n\n    const snap = this.createSnapGlobal(provider);\n    const ethereum = this.createEIP1193Provider(provider);\n    // We specifically use any type because the Snap can modify the object any way they want\n    const snapModule: any = { exports: {} };\n\n    try {\n      const { endowments, teardown: endowmentTeardown } = createEndowments(\n        snap,\n        ethereum,\n        _endowments,\n      );\n\n      // !!! Ensure that this is the only place the data is being set.\n      // Other methods access the object value and mutate its properties.\n      this.snapData.set(snapName, {\n        idleTeardown: endowmentTeardown,\n        runningEvaluations: new Set(),\n        exports: {},\n      });\n\n      addEventListener('unhandledRejection', this.snapPromiseErrorHandler);\n      addEventListener('error', this.snapErrorHandler);\n\n      const compartment = new Compartment({\n        ...endowments,\n        module: snapModule,\n        exports: snapModule.exports,\n      });\n      // All of those are JavaScript runtime specific and self referential,\n      // but we add them for compatibility sake with external libraries.\n      //\n      // We can't do that in the injected globals object above\n      // because SES creates its own globalThis\n      compartment.globalThis.self = compartment.globalThis;\n      compartment.globalThis.global = compartment.globalThis;\n      compartment.globalThis.window = compartment.globalThis;\n\n      await this.executeInSnapContext(snapName, () => {\n        compartment.evaluate(sourceCode);\n        this.registerSnapExports(snapName, snapModule);\n      });\n    } catch (error) {\n      this.removeSnap(snapName);\n      throw new Error(\n        `Error while running snap '${snapName}': ${(error as Error).message}`,\n      );\n    }\n  }\n\n  /**\n   * Cancels all running evaluations of all snaps and clears all snap data.\n   * NOTE:** Should only be called in response to the `terminate` RPC command.\n   */\n  protected onTerminate() {\n    // `stop()` tears down snap endowments.\n    // Teardown will also be run for each snap as soon as there are\n    // no more running evaluations for that snap.\n    this.snapData.forEach((data) =>\n      data.runningEvaluations.forEach((evaluation) => evaluation.stop()),\n    );\n    this.snapData.clear();\n  }\n\n  private registerSnapExports(snapName: string, snapModule: any) {\n    const data = this.snapData.get(snapName);\n    // Somebody deleted the Snap before we could register\n    if (!data) {\n      return;\n    }\n\n    data.exports = SNAP_EXPORT_NAMES.reduce((acc, exportName) => {\n      const snapExport = snapModule.exports[exportName];\n      if (validateExport(exportName, snapExport)) {\n        return { ...acc, [exportName]: snapExport };\n      }\n      return acc;\n    }, {});\n  }\n\n  /**\n   * Instantiates a snap API object (i.e. `globalThis.snap`).\n   *\n   * @param provider - A StreamProvider connected to MetaMask.\n   * @returns The snap provider object.\n   */\n  private createSnapGlobal(provider: StreamProvider): SnapsGlobalObject {\n    const originalRequest = provider.request.bind(provider);\n\n    const request = async (args: RequestArguments) => {\n      assertSnapOutboundRequest(args);\n      const sanitizedArgs = getSafeJson(args);\n      this.notify({ method: 'OutboundRequest' });\n      try {\n        return await withTeardown(\n          originalRequest(sanitizedArgs as unknown as RequestArguments),\n          this as any,\n        );\n      } finally {\n        this.notify({ method: 'OutboundResponse' });\n      }\n    };\n\n    // Proxy target is intentionally set to be an empty object, to ensure\n    // that access to the prototype chain is not possible.\n    const snapGlobalProxy = new Proxy(\n      {},\n      {\n        has(_target: object, prop: string | symbol) {\n          return typeof prop === 'string' && ['request'].includes(prop);\n        },\n        get(_target, prop: keyof StreamProvider) {\n          if (prop === 'request') {\n            return request;\n          }\n\n          return undefined;\n        },\n      },\n    ) as SnapsGlobalObject;\n\n    return harden(snapGlobalProxy);\n  }\n\n  /**\n   * Instantiates an EIP-1193 Ethereum provider object (i.e. `globalThis.ethereum`).\n   *\n   * @param provider - A StreamProvider connected to MetaMask.\n   * @returns The EIP-1193 Ethereum provider object.\n   */\n  private createEIP1193Provider(provider: StreamProvider): StreamProvider {\n    const originalRequest = provider.request.bind(provider);\n\n    const request = async (args: RequestArguments) => {\n      assertEthereumOutboundRequest(args);\n      const sanitizedArgs = getSafeJson(args);\n      this.notify({ method: 'OutboundRequest' });\n      try {\n        return await withTeardown(\n          originalRequest(sanitizedArgs as unknown as RequestArguments),\n          this as any,\n        );\n      } finally {\n        this.notify({ method: 'OutboundResponse' });\n      }\n    };\n\n    const streamProviderProxy = proxyStreamProvider(provider, request);\n\n    return harden(streamProviderProxy);\n  }\n\n  /**\n   * Removes the snap with the given name.\n   *\n   * @param snapName - The name of the snap to remove.\n   */\n  private removeSnap(snapName: string): void {\n    this.snapData.delete(snapName);\n  }\n\n  /**\n   * Calls the specified executor function in the context of the specified snap.\n   * Essentially, this means that the operation performed by the executor is\n   * counted as an evaluation of the specified snap. When the count of running\n   * evaluations of a snap reaches zero, its endowments are torn down.\n   *\n   * @param snapName - The name of the snap whose context to execute in.\n   * @param executor - The function that will be executed in the snap's context.\n   * @returns The executor's return value.\n   * @template Result - The return value of the executor.\n   */\n  private async executeInSnapContext<Result>(\n    snapName: string,\n    executor: () => Promise<Result> | Result,\n  ): Promise<Result> {\n    const data = this.snapData.get(snapName);\n    if (data === undefined) {\n      throw new Error(\n        `Tried to execute in context of unknown snap: \"${snapName}\".`,\n      );\n    }\n\n    let stop: () => void;\n    const stopPromise = new Promise<never>(\n      (_, reject) =>\n        (stop = () =>\n          reject(\n            // TODO(rekmarks): Specify / standardize error code for this case.\n            ethErrors.rpc.internal(\n              `The snap \"${snapName}\" has been terminated during execution.`,\n            ),\n          )),\n    );\n\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    const evaluationData = { stop: stop! };\n\n    try {\n      data.runningEvaluations.add(evaluationData);\n      // Notice that we have to await this executor.\n      // If we didn't, we would decrease the amount of running evaluations\n      // before the promise actually resolves\n      return await Promise.race([executor(), stopPromise]);\n    } finally {\n      data.runningEvaluations.delete(evaluationData);\n\n      if (data.runningEvaluations.size === 0) {\n        this.lastTeardown += 1;\n        await data.idleTeardown();\n      }\n    }\n  }\n}\n"]}

package/dist/{types/common → common}/commands.d.ts

@@ -1,6 +1,6 @@
 import { HandlerType } from '@metamask/snaps-utils';
-import type { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';
-import type { ExecuteSnap, JsonRpcRequestWithoutId, Ping, SnapRpc, Terminate } from './validation';
+import { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';
+import { ExecuteSnap, JsonRpcRequestWithoutId, Ping, SnapRpc, Terminate } from './validation';
 export declare type CommandMethodsMapping = {
     ping: Ping;
     terminate: Terminate;

package/dist/common/commands.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCommandMethodImplementations = exports.getHandlerArguments = void 0;
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const validation_1 = require("./validation");
+/**
+ * Formats the arguments for the given handler.
+ *
+ * @param origin - The origin of the request.
+ * @param handler - The handler to pass the request to.
+ * @param request - The request object.
+ * @returns The formatted arguments.
+ */
+function getHandlerArguments(origin, handler, request) {
+    // `request` is already validated by the time this function is called.
+    switch (handler) {
+        case snaps_utils_1.HandlerType.OnTransaction: {
+            (0, validation_1.assertIsOnTransactionRequestArguments)(request.params);
+            const { transaction, chainId, transactionOrigin } = request.params;
+            return {
+                transaction,
+                chainId,
+                transactionOrigin,
+            };
+        }
+        case snaps_utils_1.HandlerType.OnRpcRequest:
+        case snaps_utils_1.HandlerType.SnapKeyring:
+            return { origin, request };
+        case snaps_utils_1.HandlerType.OnCronjob:
+            return { request };
+        default:
+            return (0, utils_1.assertExhaustive)(handler);
+    }
+}
+exports.getHandlerArguments = getHandlerArguments;
+/**
+ * Gets an object mapping internal, "command" JSON-RPC method names to their
+ * implementations.
+ *
+ * @param startSnap - A function that starts a snap.
+ * @param invokeSnap - A function that invokes the RPC method handler of a
+ * snap.
+ * @param onTerminate - A function that will be called when this executor is
+ * terminated in order to handle cleanup tasks.
+ * @returns An object containing the "command" method implementations.
+ */
+function getCommandMethodImplementations(startSnap, invokeSnap, onTerminate) {
+    return {
+        ping: async () => Promise.resolve('OK'),
+        terminate: async () => {
+            onTerminate();
+            return Promise.resolve('OK');
+        },
+        executeSnap: async (snapName, sourceCode, endowments) => {
+            await startSnap(snapName, sourceCode, endowments);
+            return 'OK';
+        },
+        snapRpc: async (target, handler, origin, request) => {
+            return ((await invokeSnap(target, handler, getHandlerArguments(origin, handler, request))) ?? null);
+        },
+    };
+}
+exports.getCommandMethodImplementations = getCommandMethodImplementations;
+//# sourceMappingURL=commands.js.map

package/dist/common/commands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../src/common/commands.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,2CAAmD;AAGnD,6CAOsB;AAStB;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,MAAc,EACd,OAAoB,EACpB,OAAgC;IAEhC,sEAAsE;IAEtE,QAAQ,OAAO,EAAE;QACf,KAAK,yBAAW,CAAC,aAAa,CAAC,CAAC;YAC9B,IAAA,kDAAqC,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEtD,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;YACnE,OAAO;gBACL,WAAW;gBACX,OAAO;gBACP,iBAAiB;aAClB,CAAC;SACH;QAED,KAAK,yBAAW,CAAC,YAAY,CAAC;QAC9B,KAAK,yBAAW,CAAC,WAAW;YAC1B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QAE7B,KAAK,yBAAW,CAAC,SAAS;YACxB,OAAO,EAAE,OAAO,EAAE,CAAC;QAErB;YACE,OAAO,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC;KACpC;AACH,CAAC;AA7BD,kDA6BC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,+BAA+B,CAC7C,SAA8D,EAC9D,UAAsB,EACtB,WAAuB;IAEvB,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACvC,SAAS,EAAE,KAAK,IAAI,EAAE;YACpB,WAAW,EAAE,CAAC;YACd,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAED,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE;YACtD,MAAM,SAAS,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;YAClD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;YAClD,OAAO,CACL,CAAC,MAAM,UAAU,CACf,MAAM,EACN,OAAO,EACP,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAC9C,CAAC,IAAI,IAAI,CACX,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA3BD,0EA2BC","sourcesContent":["import { HandlerType } from '@metamask/snaps-utils';\nimport { assertExhaustive } from '@metamask/utils';\n\nimport { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';\nimport {\n  assertIsOnTransactionRequestArguments,\n  ExecuteSnap,\n  JsonRpcRequestWithoutId,\n  Ping,\n  SnapRpc,\n  Terminate,\n} from './validation';\n\nexport type CommandMethodsMapping = {\n  ping: Ping;\n  terminate: Terminate;\n  executeSnap: ExecuteSnap;\n  snapRpc: SnapRpc;\n};\n\n/**\n * Formats the arguments for the given handler.\n *\n * @param origin - The origin of the request.\n * @param handler - The handler to pass the request to.\n * @param request - The request object.\n * @returns The formatted arguments.\n */\nexport function getHandlerArguments(\n  origin: string,\n  handler: HandlerType,\n  request: JsonRpcRequestWithoutId,\n): InvokeSnapArgs {\n  // `request` is already validated by the time this function is called.\n\n  switch (handler) {\n    case HandlerType.OnTransaction: {\n      assertIsOnTransactionRequestArguments(request.params);\n\n      const { transaction, chainId, transactionOrigin } = request.params;\n      return {\n        transaction,\n        chainId,\n        transactionOrigin,\n      };\n    }\n\n    case HandlerType.OnRpcRequest:\n    case HandlerType.SnapKeyring:\n      return { origin, request };\n\n    case HandlerType.OnCronjob:\n      return { request };\n\n    default:\n      return assertExhaustive(handler);\n  }\n}\n\n/**\n * Gets an object mapping internal, \"command\" JSON-RPC method names to their\n * implementations.\n *\n * @param startSnap - A function that starts a snap.\n * @param invokeSnap - A function that invokes the RPC method handler of a\n * snap.\n * @param onTerminate - A function that will be called when this executor is\n * terminated in order to handle cleanup tasks.\n * @returns An object containing the \"command\" method implementations.\n */\nexport function getCommandMethodImplementations(\n  startSnap: (...args: Parameters<ExecuteSnap>) => Promise<void>,\n  invokeSnap: InvokeSnap,\n  onTerminate: () => void,\n): CommandMethodsMapping {\n  return {\n    ping: async () => Promise.resolve('OK'),\n    terminate: async () => {\n      onTerminate();\n      return Promise.resolve('OK');\n    },\n\n    executeSnap: async (snapName, sourceCode, endowments) => {\n      await startSnap(snapName, sourceCode, endowments);\n      return 'OK';\n    },\n\n    snapRpc: async (target, handler, origin, request) => {\n      return (\n        (await invokeSnap(\n          target,\n          handler,\n          getHandlerArguments(origin, handler, request),\n        )) ?? null\n      );\n    },\n  };\n}\n"]}

package/dist/{types/common → common}/endowments/commonEndowmentFactory.d.ts

@@ -1,10 +1,6 @@
-import type { SnapId } from '@metamask/snaps-utils';
-export declare type EndowmentFactoryOptions = {
-    snapId?: SnapId;
-};
 export declare type EndowmentFactory = {
     names: readonly string[];
-    factory: (options?: EndowmentFactoryOptions) => {
+    factory: () => {
         [key: string]: unknown;
     };
 };

package/dist/common/endowments/commonEndowmentFactory.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globalObject_1 = require("../globalObject");
+const crypto_1 = __importDefault(require("./crypto"));
+const date_1 = __importDefault(require("./date"));
+const interval_1 = __importDefault(require("./interval"));
+const math_1 = __importDefault(require("./math"));
+const network_1 = __importDefault(require("./network"));
+const textDecoder_1 = __importDefault(require("./textDecoder"));
+const textEncoder_1 = __importDefault(require("./textEncoder"));
+const timeout_1 = __importDefault(require("./timeout"));
+// Array of common endowments
+const commonEndowments = [
+    { endowment: AbortController, name: 'AbortController' },
+    { endowment: AbortSignal, name: 'AbortSignal' },
+    { endowment: ArrayBuffer, name: 'ArrayBuffer' },
+    { endowment: atob, name: 'atob', bind: true },
+    { endowment: BigInt, name: 'BigInt' },
+    { endowment: BigInt64Array, name: 'BigInt64Array' },
+    { endowment: BigUint64Array, name: 'BigUint64Array' },
+    { endowment: btoa, name: 'btoa', bind: true },
+    { endowment: console, name: 'console' },
+    { endowment: DataView, name: 'DataView' },
+    { endowment: Float32Array, name: 'Float32Array' },
+    { endowment: Float64Array, name: 'Float64Array' },
+    { endowment: Int8Array, name: 'Int8Array' },
+    { endowment: Int16Array, name: 'Int16Array' },
+    { endowment: Int32Array, name: 'Int32Array' },
+    { endowment: Uint8Array, name: 'Uint8Array' },
+    { endowment: Uint8ClampedArray, name: 'Uint8ClampedArray' },
+    { endowment: Uint16Array, name: 'Uint16Array' },
+    { endowment: Uint32Array, name: 'Uint32Array' },
+    { endowment: URL, name: 'URL' },
+    { endowment: WebAssembly, name: 'WebAssembly' },
+];
+/**
+ * Creates a consolidated collection of common endowments.
+ * This function will return factories for all common endowments including
+ * the additionally attenuated. All hardened with SES.
+ *
+ * @returns An object with common endowments.
+ */
+const buildCommonEndowments = () => {
+    const endowmentFactories = [
+        crypto_1.default,
+        interval_1.default,
+        math_1.default,
+        network_1.default,
+        timeout_1.default,
+        textDecoder_1.default,
+        textEncoder_1.default,
+        date_1.default,
+    ];
+    commonEndowments.forEach((endowmentSpecification) => {
+        const endowment = {
+            names: [endowmentSpecification.name],
+            factory: () => {
+                const boundEndowment = typeof endowmentSpecification.endowment === 'function' &&
+                    endowmentSpecification.bind
+                    ? endowmentSpecification.endowment.bind(globalObject_1.rootRealmGlobal)
+                    : endowmentSpecification.endowment;
+                return {
+                    [endowmentSpecification.name]: harden(boundEndowment),
+                };
+            },
+        };
+        endowmentFactories.push(endowment);
+    });
+    return endowmentFactories;
+};
+exports.default = buildCommonEndowments;
+//# sourceMappingURL=commonEndowmentFactory.js.map