@metamask/snaps-execution-environments 0.24.0

package/LICENSE

@@ -0,0 +1,20 @@
+Copyright ConsenSys Software Inc. 2022. All rights reserved.
+
+You acknowledge and agree that ConsenSys Software Inc. (“ConsenSys”) (or ConsenSys’s licensors) own all legal right, title and interest in and to the work, software, application, source code, documentation and any other documents in this repository (collectively, the “Program”), including any intellectual property rights which subsist in the Program (whether those rights happen to be registered or not, and wherever in the world those rights may exist), whether in source code or any other form.
+
+Subject to the limited license below, you may not (and you may not permit anyone else to) distribute, publish, copy, modify, merge, combine with another program, create derivative works of, reverse engineer, decompile or otherwise attempt to extract the source code of, the Program or any part thereof, except that you may contribute to this repository.
+
+You are granted a non-exclusive, non-transferable, non-sublicensable license to distribute, publish, copy, modify, merge, combine with another program or create derivative works of the Program (such resulting program, collectively, the “Resulting Program”) solely for Non-Commercial Use as long as you:
+
+1.  give prominent notice (“Notice”) with each copy of the Resulting Program that the Program is used in the Resulting Program and that the Program is the copyright of ConsenSys; and
+2.  subject the Resulting Program and any distribution, publication, copy, modification, merger therewith, combination with another program or derivative works thereof to the same Notice requirement and Non-Commercial Use restriction set forth herein.
+
+“Non-Commercial Use” means each use as described in clauses (1)-(3) below, as reasonably determined by ConsenSys in its sole discretion:
+
+1.  personal use for research, personal study, private entertainment, hobby projects or amateur pursuits, in each case without any anticipated commercial application;
+2.  use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization or government institution; or
+3.  the number of monthly active users of the Resulting Program across all versions thereof and platforms globally do not exceed 10,000 at any time.
+
+You will not use any trade mark, service mark, trade name, logo of ConsenSys or any other company or organization in a way that is likely or intended to cause confusion about the owner or authorized user of such marks, names or logos.
+
+If you have any questions, comments or interest in pursuing any other use cases, please reach out to us at metamask.license@consensys.net.

package/README.md

@@ -0,0 +1,3 @@
+# @metamask/snaps-execution-environments
+
+Execution environments for [MetaMask Snaps](https://docs.metamask.io/guide/snaps.html), sandboxed using [Secure EcmaScript (SES)](https://github.com/endojs/endo/tree/master/packages/ses).

package/dist/common/BaseSnapExecutor.d.ts

@@ -0,0 +1,68 @@
+/// <reference types="node" />
+/// <reference types="ses" />
+import { Duplex } from 'stream';
+import { JsonRpcNotification, JsonRpcId, Json } from '@metamask/utils';
+import { HandlerType, SnapExportsParameters } from '@metamask/snaps-utils';
+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 {
+    private snapData;
+    private commandStream;
+    private rpcStream;
+    private methods;
+    private snapErrorHandler?;
+    private snapPromiseErrorHandler?;
+    private lastTeardown;
+    protected constructor(commandStream: Duplex, rpcStream: Duplex);
+    private errorHandler;
+    private onCommandRequest;
+    protected notify(requestObject: Omit<JsonRpcNotification<Record<string, Json> | Json[] | undefined>, 'jsonrpc'>): void;
+    protected respond(id: JsonRpcId, requestObject: Record<string, unknown>): void;
+    /**
+     * 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.
+     */
+    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.
+     */
+    protected onTerminate(): void;
+    private registerSnapExports;
+    /**
+     * Instantiates a snap API object (i.e. `globalThis.snap`).
+     *
+     * @param provider - A StreamProvider connected to MetaMask.
+     * @returns The snap provider object.
+     */
+    private createSnapGlobal;
+    /**
+     * 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.
+     */
+    private createEIP1193Provider;
+    /**
+     * Removes the snap with the given name.
+     *
+     * @param snapName - The name of the snap to remove.
+     */
+    private removeSnap;
+    /**
+     * 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.
+     */
+    private executeInSnapContext;
+}

package/dist/common/BaseSnapExecutor.js

@@ -0,0 +1,324 @@
+"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;
+const providers_1 = require("@metamask/providers");
+const json_rpc_engine_1 = require("json-rpc-engine");
+const eth_rpc_errors_1 = require("eth-rpc-errors");
+const utils_1 = require("@metamask/utils");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const superstruct_1 = require("superstruct");
+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', this.onCommandRequest.bind(this));
+        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 === null || data === void 0 ? void 0 : data.exports.keyring)
+                : data === null || data === void 0 ? void 0 : 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;
+            }
+            (0, utils_1.assert)((0, utils_1.isValidJson)(result), new TypeError('Received non-JSON-serializable value.'));
+            return result;
+        }, this.onTerminate.bind(this));
+    }
+    errorHandler(error, data) {
+        var _a;
+        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 = Object.assign(Object.assign({}, data), { stack: (_a = constructedError === null || constructedError === void 0 ? void 0 : constructedError.stack) !== null && _a !== void 0 ? _a : null });
+        this.notify({
+            method: 'UnhandledError',
+            params: {
+                error: Object.assign(Object.assign({}, 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 (e) {
+            this.respond(id, {
+                error: (0, eth_rpc_errors_1.serializeError)(e, {
+                    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(Object.assign(Object.assign({}, 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(Object.assign(Object.assign({}, 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) {
+        console.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(Object.assign(Object.assign({}, endowments), { module: snapModule, exports: snapModule.exports, window: Object.assign({}, endowments), self: Object.assign({}, endowments) }));
+            await this.executeInSnapContext(snapName, () => {
+                compartment.evaluate(sourceCode);
+                this.registerSnapExports(snapName, snapModule);
+            });
+        }
+        catch (err) {
+            this.removeSnap(snapName);
+            throw new Error(`Error while running snap '${snapName}': ${err.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 Object.assign(Object.assign({}, 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;
+        const request = async (args) => {
+            (0, utils_1.assert)(args.method.startsWith('wallet_') || args.method.startsWith('snap_'), 'The global Snap API only allows RPC methods starting with `wallet_*` and `snap_*`.');
+            this.notify({ method: 'OutboundRequest' });
+            try {
+                return await (0, utils_2.withTeardown)(originalRequest(args), this);
+            }
+            finally {
+                this.notify({ method: 'OutboundResponse' });
+            }
+        };
+        return { request };
+    }
+    /**
+     * 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;
+        provider.request = async (args) => {
+            (0, utils_1.assert)(!args.method.startsWith('snap_'), eth_rpc_errors_1.ethErrors.rpc.methodNotFound({
+                data: {
+                    method: args.method,
+                },
+            }));
+            this.notify({ method: 'OutboundRequest' });
+            try {
+                return await (0, utils_2.withTeardown)(originalRequest(args), this);
+            }
+            finally {
+                this.notify({ method: 'OutboundResponse' });
+            }
+        };
+        return provider;
+    }
+    /**
+     * 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":";;;;;;AAGA,mDAAqD;AACrD,qDAA0D;AAE1D,mDAAuE;AACvE,2CAWyB;AACzB,uDAI+B;AAE/B,6CAAuC;AAEvC,mEAAgD;AAChD,yCAGoB;AACpB,6CAAgD;AAChD,iDAAuE;AACvE,uCAAwC;AACxC,6CAA6C;AAC7C,mCAAuD;AACvD,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;AAEF,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,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChE,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,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CAAC,OAAO,CAAC;gBAC5D,CAAC,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,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,IAAA,cAAM,EACJ,IAAA,mBAAW,EAAC,MAAM,CAAC,EACnB,IAAI,SAAS,CAAC,uCAAuC,CAAC,CACvD,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,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,mCAAc,IAAI,KAAE,KAAK,EAAE,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,KAAK,mCAAI,IAAI,GAAE,CAAC;QAE3E,IAAI,CAAC,MAAM,CAAC;YACV,MAAM,EAAE,gBAAgB;YACxB,MAAM,EAAE;gBACN,KAAK,kCACA,eAAe,KAClB,IAAI,EAAE,QAAQ,GACf;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,OAAsC;QACnE,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,GAChB,6BAA6B,CAC3B,MAAoD,CACrD,CAAC;QAEJ,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,CAAC,EAAE;YACV,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,KAAK,EAAE,IAAA,+BAAc,EAAC,CAAC,EAAE;oBACvB,aAAa;iBACd,CAAC;aACH,CAAC,CAAC;SACJ;IACH,CAAC;IAES,MAAM,CACd,aAGC;QAED,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,iCACnB,aAAa,KAChB,OAAO,EAAE,KAAK,IACd,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,iCACnB,aAAa,KAChB,EAAE,EACF,OAAO,EAAE,KAAK,IACd,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,SAAS,CACvB,QAAgB,EAChB,UAAkB,EAClB,WAAsB;QAEtB,OAAO,CAAC,GAAG,CAAC,kBAAkB,QAAQ,aAAa,CAAC,CAAC;QACrD,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,iCAC9B,UAAU,KACb,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,UAAU,CAAC,OAAO,EAC3B,MAAM,oBAAO,UAAU,GACvB,IAAI,oBAAO,UAAU,KACrB,CAAC;YAEH,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,GAAG,EAAE;YACZ,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,6BAA6B,QAAQ,MAAO,GAAa,CAAC,OAAO,EAAE,CACpE,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,uCAAY,GAAG,KAAE,CAAC,UAAU,CAAC,EAAE,UAAU,IAAG;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;QAEzC,MAAM,OAAO,GAAG,KAAK,EAAE,IAAsB,EAAE,EAAE;YAC/C,IAAA,cAAM,EACJ,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EACpE,oFAAoF,CACrF,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC3C,IAAI;gBACF,OAAO,MAAM,IAAA,oBAAY,EAAC,eAAe,CAAC,IAAI,CAAC,EAAE,IAAW,CAAC,CAAC;aAC/D;oBAAS;gBACR,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC;aAC7C;QACH,CAAC,CAAC;QAEF,OAAO,EAAE,OAAO,EAAE,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,QAAwB;QACpD,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC;QAEzC,QAAQ,CAAC,OAAO,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE;YAChC,IAAA,cAAM,EACJ,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EAChC,0BAAS,CAAC,GAAG,CAAC,cAAc,CAAC;gBAC3B,IAAI,EAAE;oBACJ,MAAM,EAAE,IAAI,CAAC,MAAM;iBACpB;aACF,CAAC,CACH,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC3C,IAAI;gBACF,OAAO,MAAM,IAAA,oBAAY,EAAC,eAAe,CAAC,IAAI,CAAC,EAAE,IAAW,CAAC,CAAC;aAC/D;oBAAS;gBACR,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC;aAC7C;QACH,CAAC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,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;AA1YD,4CA0YC","sourcesContent":["// eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment\n/// <reference path=\"../../../../node_modules/ses/index.d.ts\" />\nimport { Duplex } from 'stream';\nimport { StreamProvider } from '@metamask/providers';\nimport { createIdRemapMiddleware } from 'json-rpc-engine';\nimport { SnapExports, SnapsGlobalObject } from '@metamask/snaps-types';\nimport { errorCodes, ethErrors, serializeError } from 'eth-rpc-errors';\nimport {\n  isObject,\n  isValidJson,\n  JsonRpcNotification,\n  assert,\n  isJsonRpcRequest,\n  JsonRpcId,\n  JsonRpcRequest,\n  JsonRpcParams,\n  Json,\n  hasProperty,\n} from '@metamask/utils';\nimport {\n  HandlerType,\n  SnapExportsParameters,\n  SNAP_EXPORT_NAMES,\n} from '@metamask/snaps-utils';\n\nimport { validate } from 'superstruct';\nimport { RequestArguments } from '@metamask/providers/dist/BaseProvider';\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 { constructError, withTeardown } 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\nexport class BaseSnapExecutor {\n  private snapData: Map<string, SnapData>;\n\n  private commandStream: Duplex;\n\n  private rpcStream: Duplex;\n\n  private 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', this.onCommandRequest.bind(this));\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        assert(\n          isValidJson(result),\n          new TypeError('Received non-JSON-serializable value.'),\n        );\n        return result;\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<JsonRpcParams>) {\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 =\n      EXECUTION_ENVIRONMENT_METHODS[\n        method as keyof typeof EXECUTION_ENVIRONMENT_METHODS\n      ];\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 (e) {\n      this.respond(id, {\n        error: serializeError(e, {\n          fallbackError,\n        }),\n      });\n    }\n  }\n\n  protected notify(\n    requestObject: Omit<\n      JsonRpcNotification<Record<string, Json> | Json[] | undefined>,\n      'jsonrpc'\n    >,\n  ) {\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    console.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        window: { ...endowments },\n        self: { ...endowments },\n      });\n\n      await this.executeInSnapContext(snapName, () => {\n        compartment.evaluate(sourceCode);\n        this.registerSnapExports(snapName, snapModule);\n      });\n    } catch (err) {\n      this.removeSnap(snapName);\n      throw new Error(\n        `Error while running snap '${snapName}': ${(err 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;\n\n    const request = async (args: RequestArguments) => {\n      assert(\n        args.method.startsWith('wallet_') || args.method.startsWith('snap_'),\n        'The global Snap API only allows RPC methods starting with `wallet_*` and `snap_*`.',\n      );\n      this.notify({ method: 'OutboundRequest' });\n      try {\n        return await withTeardown(originalRequest(args), this as any);\n      } finally {\n        this.notify({ method: 'OutboundResponse' });\n      }\n    };\n\n    return { request };\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;\n\n    provider.request = async (args) => {\n      assert(\n        !args.method.startsWith('snap_'),\n        ethErrors.rpc.methodNotFound({\n          data: {\n            method: args.method,\n          },\n        }),\n      );\n      this.notify({ method: 'OutboundRequest' });\n      try {\n        return await withTeardown(originalRequest(args), this as any);\n      } finally {\n        this.notify({ method: 'OutboundResponse' });\n      }\n    };\n\n    return provider;\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/common/commands.d.ts

@@ -0,0 +1,30 @@
+import { HandlerType } from '@metamask/snaps-utils';
+import { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';
+import { ExecuteSnap, JsonRpcRequestWithoutId, Ping, SnapRpc, Terminate } from './validation';
+export declare type CommandMethodsMapping = {
+    ping: Ping;
+    terminate: Terminate;
+    executeSnap: ExecuteSnap;
+    snapRpc: SnapRpc;
+};
+/**
+ * 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.
+ */
+export declare function getHandlerArguments(origin: string, handler: HandlerType, request: JsonRpcRequestWithoutId): InvokeSnapArgs;
+/**
+ * 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.
+ */
+export declare function getCommandMethodImplementations(startSnap: (...args: Parameters<ExecuteSnap>) => Promise<void>, invokeSnap: InvokeSnap, onTerminate: () => void): CommandMethodsMapping;

package/dist/common/commands.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCommandMethodImplementations = exports.getHandlerArguments = void 0;
+const utils_1 = require("@metamask/utils");
+const snaps_utils_1 = require("@metamask/snaps-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 () => {
+            return 'OK';
+        },
+        terminate: async () => {
+            onTerminate();
+            return 'OK';
+        },
+        executeSnap: async (snapName, sourceCode, endowments) => {
+            await startSnap(snapName, sourceCode, endowments);
+            return 'OK';
+        },
+        snapRpc: async (target, handler, origin, request) => {
+            var _a;
+            return ((_a = (await invokeSnap(target, handler, getHandlerArguments(origin, handler, request)))) !== null && _a !== void 0 ? _a : 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,2CAAmD;AACnD,uDAAoD;AAEpD,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;YACf,OAAO,IAAI,CAAC;QACd,CAAC;QAED,SAAS,EAAE,KAAK,IAAI,EAAE;YACpB,WAAW,EAAE,CAAC;YACd,OAAO,IAAI,CAAC;QACd,CAAC;QAED,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE;YACtD,MAAM,SAAS,CAAC,QAAkB,EAAE,UAAoB,EAAE,UAAU,CAAC,CAAC;YACtE,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;;YAClD,OAAO,CACL,MAAA,CAAC,MAAM,UAAU,CACf,MAAM,EACN,OAAO,EACP,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAC9C,CAAC,mCAAI,IAAI,CACX,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA9BD,0EA8BC","sourcesContent":["import { assertExhaustive } from '@metamask/utils';\nimport { HandlerType } from '@metamask/snaps-utils';\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 () => {\n      return 'OK';\n    },\n\n    terminate: async () => {\n      onTerminate();\n      return 'OK';\n    },\n\n    executeSnap: async (snapName, sourceCode, endowments) => {\n      await startSnap(snapName as string, sourceCode as string, 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/common/endowments/crypto.d.ts

@@ -0,0 +1,8 @@
+declare const endowmentModule: {
+    names: readonly ["crypto", "SubtleCrypto"];
+    factory: () => {
+        readonly crypto: any;
+        readonly SubtleCrypto: any;
+    };
+};
+export default endowmentModule;

package/dist/common/endowments/crypto.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const globalObject_1 = require("../globalObject");
+const createCrypto = () => {
+    if ('crypto' in globalObject_1.rootRealmGlobal &&
+        typeof globalObject_1.rootRealmGlobal.crypto === 'object' &&
+        'SubtleCrypto' in globalObject_1.rootRealmGlobal &&
+        typeof globalObject_1.rootRealmGlobal.SubtleCrypto === 'function') {
+        return {
+            crypto: globalObject_1.rootRealmGlobal.crypto,
+            SubtleCrypto: globalObject_1.rootRealmGlobal.SubtleCrypto,
+        };
+    }
+    // For now, we expose the experimental webcrypto API for Node.js execution environments
+    // TODO: Figure out if this is enough long-term or if we should use a polyfill.
+    /* eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires, node/global-require */
+    const crypto = require('crypto').webcrypto;
+    return { crypto, SubtleCrypto: crypto.subtle.constructor };
+};
+const endowmentModule = {
+    names: ['crypto', 'SubtleCrypto'],
+    factory: createCrypto,
+};
+exports.default = endowmentModule;
+//# sourceMappingURL=crypto.js.map

package/dist/common/endowments/crypto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.js","sourceRoot":"","sources":["../../../src/common/endowments/crypto.ts"],"names":[],"mappings":";;AAAA,kDAAkD;AAElD,MAAM,YAAY,GAAG,GAAG,EAAE;IACxB,IACE,QAAQ,IAAI,8BAAe;QAC3B,OAAO,8BAAe,CAAC,MAAM,KAAK,QAAQ;QAC1C,cAAc,IAAI,8BAAe;QACjC,OAAO,8BAAe,CAAC,YAAY,KAAK,UAAU,EAClD;QACA,OAAO;YACL,MAAM,EAAE,8BAAe,CAAC,MAAM;YAC9B,YAAY,EAAE,8BAAe,CAAC,YAAY;SAC3C,CAAC;KACH;IACD,uFAAuF;IACvF,+EAA+E;IAC/E,6HAA6H;IAC7H,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC;IAC3C,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,EAAW,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG;IACtB,KAAK,EAAE,CAAC,QAAQ,EAAE,cAAc,CAAU;IAC1C,OAAO,EAAE,YAAY;CACtB,CAAC;AACF,kBAAe,eAAe,CAAC","sourcesContent":["import { rootRealmGlobal } from '../globalObject';\n\nconst createCrypto = () => {\n  if (\n    'crypto' in rootRealmGlobal &&\n    typeof rootRealmGlobal.crypto === 'object' &&\n    'SubtleCrypto' in rootRealmGlobal &&\n    typeof rootRealmGlobal.SubtleCrypto === 'function'\n  ) {\n    return {\n      crypto: rootRealmGlobal.crypto,\n      SubtleCrypto: rootRealmGlobal.SubtleCrypto,\n    };\n  }\n  // For now, we expose the experimental webcrypto API for Node.js execution environments\n  // TODO: Figure out if this is enough long-term or if we should use a polyfill.\n  /* eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires, node/global-require */\n  const crypto = require('crypto').webcrypto;\n  return { crypto, SubtleCrypto: crypto.subtle.constructor } as const;\n};\n\nconst endowmentModule = {\n  names: ['crypto', 'SubtleCrypto'] as const,\n  factory: createCrypto,\n};\nexport default endowmentModule;\n"]}

package/dist/common/endowments/index.d.ts

@@ -0,0 +1,25 @@
+import { SnapsGlobalObject } from '@metamask/snaps-types';
+import { StreamProvider } from '@metamask/providers';
+/**
+ * Gets the endowments for a particular Snap. Some endowments, like `setTimeout`
+ * and `clearTimeout`, must be attenuated so that they can only affect behavior
+ * within the Snap's own realm. Therefore, we use factory functions to create
+ * such attenuated / modified endowments. Otherwise, the value that's on the
+ * root realm global will be used.
+ *
+ * @param snap - The Snaps global API object.
+ * @param ethereum - The Snap's EIP-1193 provider object.
+ * @param endowments - The list of endowments to provide to the snap.
+ * @returns An object containing the Snap's endowments.
+ */
+export declare function createEndowments(snap: SnapsGlobalObject, ethereum: StreamProvider, endowments?: string[]): {
+    endowments: Record<string, unknown>;
+    teardown: () => Promise<void>;
+};
+/**
+ * Checks whether the specified function is a constructor.
+ *
+ * @param value - Any function value.
+ * @returns Whether the specified function is a constructor.
+ */
+export declare function isConstructor<T extends Function>(value: T): boolean;