@metamask/snaps-execution-environments 1.0.2 → 2.0.0

package/dist/esm/common/BaseSnapExecutor.js

@@ -0,0 +1,408 @@
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
+/// <reference path="../../../../node_modules/ses/types.d.ts" />
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+import { StreamProvider } from '@metamask/providers';
+import { SNAP_EXPORT_NAMES, logError, SNAP_EXPORTS } from '@metamask/snaps-utils';
+import { isObject, isValidJson, assert, isJsonRpcRequest, hasProperty, getSafeJson } from '@metamask/utils';
+import { errorCodes, ethErrors, serializeError } from 'eth-rpc-errors';
+import { createIdRemapMiddleware } from 'json-rpc-engine';
+import { validate } from 'superstruct';
+import { log } from '../logging';
+import EEOpenRPCDocument from '../openrpc.json';
+import { getCommandMethodImplementations } from './commands';
+import { createEndowments } from './endowments';
+import { addEventListener, removeEventListener } from './globalEvents';
+import { sortParamKeys } from './sortParams';
+import { assertEthereumOutboundRequest, assertSnapOutboundRequest, constructError, proxyStreamProvider, withTeardown } from './utils';
+import { ExecuteSnapRequestArgumentsStruct, PingRequestArgumentsStruct, SnapRpcRequestArgumentsStruct, TerminateRequestArgumentsStruct } from './validation';
+const fallbackError = {
+    code: 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: PingRequestArgumentsStruct,
+        params: []
+    },
+    executeSnap: {
+        struct: ExecuteSnapRequestArgumentsStruct,
+        params: [
+            'snapId',
+            'sourceCode',
+            'endowments'
+        ]
+    },
+    terminate: {
+        struct: TerminateRequestArgumentsStruct,
+        params: []
+    },
+    snapRpc: {
+        struct: SnapRpcRequestArgumentsStruct,
+        params: [
+            'target',
+            'handler',
+            'origin',
+            'request'
+        ]
+    }
+};
+export class BaseSnapExecutor {
+    errorHandler(error, data) {
+        const constructedError = constructError(error);
+        const serializedError = 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 (!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: EEOpenRPCDocument
+            });
+            return;
+        }
+        if (!hasProperty(EXECUTION_ENVIRONMENT_METHODS, method)) {
+            this.respond(id, {
+                error: ethErrors.rpc.methodNotFound({
+                    data: {
+                        method
+                    }
+                }).serialize()
+            });
+            return;
+        }
+        const methodObject = EXECUTION_ENVIRONMENT_METHODS[method];
+        // support params by-name and by-position
+        const paramsAsArray = sortParamKeys(methodObject.params, params);
+        const [error] = validate(paramsAsArray, methodObject.struct);
+        if (error) {
+            this.respond(id, {
+                error: 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: serializeError(rpcError, {
+                    fallbackError
+                })
+            });
+        }
+    }
+    notify(requestObject) {
+        if (!isValidJson(requestObject) || !isObject(requestObject)) {
+            throw new Error('JSON-RPC notifications must be JSON serializable objects');
+        }
+        this.commandStream.write({
+            ...requestObject,
+            jsonrpc: '2.0'
+        });
+    }
+    respond(id, requestObject) {
+        if (!isValidJson(requestObject) || !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 snapId - The id 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(snapId, sourceCode, _endowments) {
+        log(`Starting snap '${snapId}' in worker.`);
+        if (this.snapPromiseErrorHandler) {
+            removeEventListener('unhandledrejection', this.snapPromiseErrorHandler);
+        }
+        if (this.snapErrorHandler) {
+            removeEventListener('error', this.snapErrorHandler);
+        }
+        this.snapErrorHandler = (error)=>{
+            this.errorHandler(error.error, {
+                snapId
+            });
+        };
+        this.snapPromiseErrorHandler = (error)=>{
+            this.errorHandler(error instanceof Error ? error : error.reason, {
+                snapId
+            });
+        };
+        const provider = new StreamProvider(this.rpcStream, {
+            jsonRpcStreamName: 'metamask-provider',
+            rpcMiddleware: [
+                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 } = createEndowments(snap, ethereum, snapId, _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(snapId, {
+                idleTeardown: endowmentTeardown,
+                runningEvaluations: new Set(),
+                exports: {}
+            });
+            addEventListener('unhandledRejection', this.snapPromiseErrorHandler);
+            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(snapId, ()=>{
+                compartment.evaluate(sourceCode);
+                this.registerSnapExports(snapId, snapModule);
+            });
+        } catch (error) {
+            this.removeSnap(snapId);
+            throw new Error(`Error while running snap '${snapId}': ${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(snapId, snapModule) {
+        const data = this.snapData.get(snapId);
+        // Somebody deleted the snap before we could register.
+        if (!data) {
+            return;
+        }
+        data.exports = SNAP_EXPORT_NAMES.reduce((acc, exportName)=>{
+            const snapExport = snapModule.exports[exportName];
+            const { validator } = SNAP_EXPORTS[exportName];
+            if (validator(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)=>{
+            const sanitizedArgs = getSafeJson(args);
+            assertSnapOutboundRequest(sanitizedArgs);
+            this.notify({
+                method: 'OutboundRequest'
+            });
+            try {
+                return await 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)=>{
+            const sanitizedArgs = getSafeJson(args);
+            assertEthereumOutboundRequest(sanitizedArgs);
+            this.notify({
+                method: 'OutboundRequest'
+            });
+            try {
+                return await withTeardown(originalRequest(sanitizedArgs), this);
+            } finally{
+                this.notify({
+                    method: 'OutboundResponse'
+                });
+            }
+        };
+        const streamProviderProxy = proxyStreamProvider(provider, request);
+        return harden(streamProviderProxy);
+    }
+    /**
+   * Removes the snap with the given name.
+   *
+   * @param snapId - The id of the snap to remove.
+   */ removeSnap(snapId) {
+        this.snapData.delete(snapId);
+    }
+    /**
+   * 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 snapId - The id 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(snapId, executor) {
+        const data = this.snapData.get(snapId);
+        if (data === undefined) {
+            throw new Error(`Tried to execute in context of unknown snap: "${snapId}".`);
+        }
+        let stop;
+        const stopPromise = new Promise((_, reject)=>stop = ()=>reject(// TODO(rekmarks): Specify / standardize error code for this case.
+                ethErrors.rpc.internal(`The snap "${snapId}" 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();
+            }
+        }
+    }
+    constructor(commandStream, rpcStream){
+        _define_property(this, "snapData", void 0);
+        _define_property(this, "commandStream", void 0);
+        _define_property(this, "rpcStream", void 0);
+        _define_property(this, "methods", void 0);
+        _define_property(this, "snapErrorHandler", void 0);
+        _define_property(this, "snapPromiseErrorHandler", void 0);
+        _define_property(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.
+                logError(error);
+            });
+        });
+        this.rpcStream = rpcStream;
+        this.methods = getCommandMethodImplementations(this.startSnap.bind(this), async (target, handlerType, args)=>{
+            const data = this.snapData.get(target);
+            // We're capturing the handler in case someone modifies the data object
+            // before the call.
+            const handler = data?.exports[handlerType];
+            const { required } = SNAP_EXPORTS[handlerType];
+            assert(!required || handler !== undefined, `No ${handlerType} handler exported for snap "${target}`);
+            // Certain handlers are not required. If they are not exported, we
+            // return null.
+            if (!handler) {
+                return null;
+            }
+            // 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 getSafeJson(result);
+            } catch (error) {
+                throw new TypeError(`Received non-JSON-serializable value: ${error.message.replace(/^Assertion failed: /u, '')}`);
+            }
+        }, this.onTerminate.bind(this));
+    }
+}
+
+//# sourceMappingURL=BaseSnapExecutor.js.map

package/dist/esm/common/BaseSnapExecutor.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/common/BaseSnapExecutor.ts"],"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 type { RequestArguments } from '@metamask/providers/dist/BaseProvider';\nimport type { SnapsGlobalObject } from '@metamask/rpc-methods';\nimport type {\n  SnapExports,\n  HandlerType,\n  SnapExportsParameters,\n} from '@metamask/snaps-utils';\nimport {\n  SNAP_EXPORT_NAMES,\n  logError,\n  SNAP_EXPORTS,\n} from '@metamask/snaps-utils';\nimport type {\n  JsonRpcNotification,\n  JsonRpcId,\n  JsonRpcRequest,\n  Json,\n} from '@metamask/utils';\nimport {\n  isObject,\n  isValidJson,\n  assert,\n  isJsonRpcRequest,\n  hasProperty,\n  getSafeJson,\n} from '@metamask/utils';\nimport { errorCodes, ethErrors, serializeError } from 'eth-rpc-errors';\nimport { createIdRemapMiddleware } from 'json-rpc-engine';\nimport type { Duplex } from 'stream';\nimport { validate } from 'superstruct';\n\nimport { log } from '../logging';\nimport EEOpenRPCDocument from '../openrpc.json';\nimport type { CommandMethodsMapping } from './commands';\nimport { getCommandMethodImplementations } from './commands';\nimport { createEndowments } from './endowments';\nimport { addEventListener, removeEventListener } from './globalEvents';\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} 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\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: ['snapId', '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, handlerType, args) => {\n        const data = this.snapData.get(target);\n        // We're capturing the handler in case someone modifies the data object\n        // before the call.\n        const handler = data?.exports[handlerType];\n        const { required } = SNAP_EXPORTS[handlerType];\n\n        assert(\n          !required || handler !== undefined,\n          `No ${handlerType} handler exported for snap \"${target}`,\n        );\n\n        // Certain handlers are not required. If they are not exported, we\n        // return null.\n        if (!handler) {\n          return null;\n        }\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 snapId - The id 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    snapId: string,\n    sourceCode: string,\n    _endowments?: string[],\n  ): Promise<void> {\n    log(`Starting snap '${snapId}' 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, { snapId });\n    };\n\n    this.snapPromiseErrorHandler = (error: PromiseRejectionEvent) => {\n      this.errorHandler(error instanceof Error ? error : error.reason, {\n        snapId,\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        snapId,\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(snapId, {\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(snapId, () => {\n        compartment.evaluate(sourceCode);\n        this.registerSnapExports(snapId, snapModule);\n      });\n    } catch (error) {\n      this.removeSnap(snapId);\n      throw new Error(\n        `Error while running snap '${snapId}': ${(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(snapId: string, snapModule: any) {\n    const data = this.snapData.get(snapId);\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      const { validator } = SNAP_EXPORTS[exportName];\n      if (validator(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      const sanitizedArgs = getSafeJson(args) as RequestArguments;\n      assertSnapOutboundRequest(sanitizedArgs);\n      this.notify({ method: 'OutboundRequest' });\n      try {\n        return await withTeardown(originalRequest(sanitizedArgs), this as any);\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      const sanitizedArgs = getSafeJson(args) as RequestArguments;\n      assertEthereumOutboundRequest(sanitizedArgs);\n      this.notify({ method: 'OutboundRequest' });\n      try {\n        return await withTeardown(originalRequest(sanitizedArgs), this as any);\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 snapId - The id of the snap to remove.\n   */\n  private removeSnap(snapId: string): void {\n    this.snapData.delete(snapId);\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 snapId - The id 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    snapId: string,\n    executor: () => Promise<Result> | Result,\n  ): Promise<Result> {\n    const data = this.snapData.get(snapId);\n    if (data === undefined) {\n      throw new Error(\n        `Tried to execute in context of unknown snap: \"${snapId}\".`,\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 \"${snapId}\" 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"],"names":["StreamProvider","SNAP_EXPORT_NAMES","logError","SNAP_EXPORTS","isObject","isValidJson","assert","isJsonRpcRequest","hasProperty","getSafeJson","errorCodes","ethErrors","serializeError","createIdRemapMiddleware","validate","log","EEOpenRPCDocument","getCommandMethodImplementations","createEndowments","addEventListener","removeEventListener","sortParamKeys","assertEthereumOutboundRequest","assertSnapOutboundRequest","constructError","proxyStreamProvider","withTeardown","ExecuteSnapRequestArgumentsStruct","PingRequestArgumentsStruct","SnapRpcRequestArgumentsStruct","TerminateRequestArgumentsStruct","fallbackError","code","rpc","internal","message","EXECUTION_ENVIRONMENT_METHODS","ping","struct","params","executeSnap","terminate","snapRpc","BaseSnapExecutor","errorHandler","error","data","constructedError","serializedError","shouldIncludeStack","sentData","stack","notify","method","onCommandRequest","Error","id","respond","result","methodNotFound","serialize","methodObject","paramsAsArray","invalidParams","methods","rpcError","requestObject","commandStream","write","jsonrpc","startSnap","snapId","sourceCode","_endowments","snapPromiseErrorHandler","snapErrorHandler","reason","provider","rpcStream","jsonRpcStreamName","rpcMiddleware","initialize","snap","createSnapGlobal","ethereum","createEIP1193Provider","snapModule","exports","endowments","teardown","endowmentTeardown","snapData","set","idleTeardown","runningEvaluations","Set","compartment","Compartment","module","globalThis","self","global","window","executeInSnapContext","evaluate","registerSnapExports","removeSnap","onTerminate","forEach","evaluation","stop","clear","get","reduce","acc","exportName","snapExport","validator","originalRequest","request","bind","args","sanitizedArgs","snapGlobalProxy","Proxy","has","_target","prop","includes","undefined","harden","streamProviderProxy","delete","executor","stopPromise","Promise","_","reject","evaluationData","add","race","size","lastTeardown","Map","on","catch","target","handlerType","handler","required","TypeError","replace"],"mappings":"AAAA,qFAAqF;AACrF,gEAAgE;;;;;;;;;;;;;;AAChE,SAASA,cAAc,QAAQ,sBAAsB;AAQrD,SACEC,iBAAiB,EACjBC,QAAQ,EACRC,YAAY,QACP,wBAAwB;AAO/B,SACEC,QAAQ,EACRC,WAAW,EACXC,MAAM,EACNC,gBAAgB,EAChBC,WAAW,EACXC,WAAW,QACN,kBAAkB;AACzB,SAASC,UAAU,EAAEC,SAAS,EAAEC,cAAc,QAAQ,iBAAiB;AACvE,SAASC,uBAAuB,QAAQ,kBAAkB;AAE1D,SAASC,QAAQ,QAAQ,cAAc;AAEvC,SAASC,GAAG,QAAQ,aAAa;AACjC,OAAOC,uBAAuB,kBAAkB;AAEhD,SAASC,+BAA+B,QAAQ,aAAa;AAC7D,SAASC,gBAAgB,QAAQ,eAAe;AAChD,SAASC,gBAAgB,EAAEC,mBAAmB,QAAQ,iBAAiB;AACvE,SAASC,aAAa,QAAQ,eAAe;AAC7C,SACEC,6BAA6B,EAC7BC,yBAAyB,EACzBC,cAAc,EACdC,mBAAmB,EACnBC,YAAY,QACP,UAAU;AACjB,SACEC,iCAAiC,EACjCC,0BAA0B,EAC1BC,6BAA6B,EAC7BC,+BAA+B,QAC1B,eAAe;AAYtB,MAAMC,gBAAgB;IACpBC,MAAMtB,WAAWuB,GAAG,CAACC,QAAQ;IAC7BC,SAAS;AACX;AAUA;;;;CAIC,GACD,MAAMC,gCAAgC;IACpCC,MAAM;QACJC,QAAQV;QACRW,QAAQ,EAAE;IACZ;IACAC,aAAa;QACXF,QAAQX;QACRY,QAAQ;YAAC;YAAU;YAAc;SAAa;IAChD;IACAE,WAAW;QACTH,QAAQR;QACRS,QAAQ,EAAE;IACZ;IACAG,SAAS;QACPJ,QAAQT;QACRU,QAAQ;YAAC;YAAU;YAAW;YAAU;SAAU;IACpD;AACF;AAIA,OAAO,MAAMI;IAwEHC,aAAaC,KAAc,EAAEC,IAA0B,EAAE;QAC/D,MAAMC,mBAAmBvB,eAAeqB;QACxC,MAAMG,kBAAkBpC,eAAemC,kBAAkB;YACvDhB;YACAkB,oBAAoB;QACtB;QAEA,gEAAgE;QAChE,MAAMC,WAAiB;YAAE,GAAGJ,IAAI;YAAEK,OAAOJ,kBAAkBI,SAAS;QAAK;QAEzE,IAAI,CAACC,MAAM,CAAC;YACVC,QAAQ;YACRd,QAAQ;gBACNM,OAAO;oBACL,GAAGG,eAAe;oBAClBF,MAAMI;gBACR;YACF;QACF;IACF;IAEA,MAAcI,iBAAiBnB,OAAuB,EAAE;QACtD,IAAI,CAAC5B,iBAAiB4B,UAAU;YAC9B,MAAM,IAAIoB,MAAM;QAClB;QAEA,MAAM,EAAEC,EAAE,EAAEH,MAAM,EAAEd,MAAM,EAAE,GAAGJ;QAC/B,IAAIkB,WAAW,gBAAgB;YAC7B,IAAI,CAACI,OAAO,CAACD,IAAI;gBACfE,QAAQ1C;YACV;YACA;QACF;QAEA,IAAI,CAACR,YAAY4B,+BAA+BiB,SAAS;YACvD,IAAI,CAACI,OAAO,CAACD,IAAI;gBACfX,OAAOlC,UAAUsB,GAAG,CACjB0B,cAAc,CAAC;oBACdb,MAAM;wBACJO;oBACF;gBACF,GACCO,SAAS;YACd;YACA;QACF;QAEA,MAAMC,eAAezB,6BAA6B,CAACiB,OAAwB;QAE3E,yCAAyC;QACzC,MAAMS,gBAAgBzC,cAAcwC,aAAatB,MAAM,EAAEA;QAEzD,MAAM,CAACM,MAAM,GAAG/B,SAAmBgD,eAAeD,aAAavB,MAAM;QACrE,IAAIO,OAAO;YACT,IAAI,CAACY,OAAO,CAACD,IAAI;gBACfX,OAAOlC,UAAUsB,GAAG,CACjB8B,aAAa,CAAC;oBACb5B,SAAS,CAAC,+BAA+B,EAAEkB,OAAO,GAAG,EAAER,MAAMV,OAAO,CAAC,CAAC,CAAC;oBACvEW,MAAM;wBACJO;wBACAd,QAAQuB;oBACV;gBACF,GACCF,SAAS;YACd;YACA;QACF;QAEA,IAAI;YACF,MAAMF,SAAS,MAAM,AAAC,IAAI,CAACM,OAAO,AAAQ,CAACX,OAAO,IAAIS;YACtD,IAAI,CAACL,OAAO,CAACD,IAAI;gBAAEE;YAAO;QAC5B,EAAE,OAAOO,UAAU;YACjB,IAAI,CAACR,OAAO,CAACD,IAAI;gBACfX,OAAOjC,eAAeqD,UAAU;oBAC9BlC;gBACF;YACF;QACF;IACF;IAEUqB,OAAOc,aAAmD,EAAE;QACpE,IAAI,CAAC7D,YAAY6D,kBAAkB,CAAC9D,SAAS8D,gBAAgB;YAC3D,MAAM,IAAIX,MACR;QAEJ;QAEA,IAAI,CAACY,aAAa,CAACC,KAAK,CAAC;YACvB,GAAGF,aAAa;YAChBG,SAAS;QACX;IACF;IAEUZ,QAAQD,EAAa,EAAEU,aAAsC,EAAE;QACvE,IAAI,CAAC7D,YAAY6D,kBAAkB,CAAC9D,SAAS8D,gBAAgB;YAC3D,MAAM,IAAIX,MAAM;QAClB;QAEA,IAAI,CAACY,aAAa,CAACC,KAAK,CAAC;YACvB,GAAGF,aAAa;YAChBV;YACAa,SAAS;QACX;IACF;IAEA;;;;;;;GAOC,GACD,MAAgBC,UACdC,MAAc,EACdC,UAAkB,EAClBC,WAAsB,EACP;QACf1D,IAAI,CAAC,eAAe,EAAEwD,OAAO,YAAY,CAAC;QAC1C,IAAI,IAAI,CAACG,uBAAuB,EAAE;YAChCtD,oBAAoB,sBAAsB,IAAI,CAACsD,uBAAuB;QACxE;QAEA,IAAI,IAAI,CAACC,gBAAgB,EAAE;YACzBvD,oBAAoB,SAAS,IAAI,CAACuD,gBAAgB;QACpD;QAEA,IAAI,CAACA,gBAAgB,GAAG,CAAC9B;YACvB,IAAI,CAACD,YAAY,CAACC,MAAMA,KAAK,EAAE;gBAAE0B;YAAO;QAC1C;QAEA,IAAI,CAACG,uBAAuB,GAAG,CAAC7B;YAC9B,IAAI,CAACD,YAAY,CAACC,iBAAiBU,QAAQV,QAAQA,MAAM+B,MAAM,EAAE;gBAC/DL;YACF;QACF;QAEA,MAAMM,WAAW,IAAI7E,eAAe,IAAI,CAAC8E,SAAS,EAAE;YAClDC,mBAAmB;YACnBC,eAAe;gBAACnE;aAA0B;QAC5C;QAEA,MAAMgE,SAASI,UAAU;QAEzB,MAAMC,OAAO,IAAI,CAACC,gBAAgB,CAACN;QACnC,MAAMO,WAAW,IAAI,CAACC,qBAAqB,CAACR;QAC5C,wFAAwF;QACxF,MAAMS,aAAkB;YAAEC,SAAS,CAAC;QAAE;QAEtC,IAAI;YACF,MAAM,EAAEC,UAAU,EAAEC,UAAUC,iBAAiB,EAAE,GAAGxE,iBAClDgE,MACAE,UACAb,QACAE;YAGF,gEAAgE;YAChE,mEAAmE;YACnE,IAAI,CAACkB,QAAQ,CAACC,GAAG,CAACrB,QAAQ;gBACxBsB,cAAcH;gBACdI,oBAAoB,IAAIC;gBACxBR,SAAS,CAAC;YACZ;YAEApE,iBAAiB,sBAAsB,IAAI,CAACuD,uBAAuB;YACnEvD,iBAAiB,SAAS,IAAI,CAACwD,gBAAgB;YAE/C,MAAMqB,cAAc,IAAIC,YAAY;gBAClC,GAAGT,UAAU;gBACbU,QAAQZ;gBACRC,SAASD,WAAWC,OAAO;YAC7B;YACA,qEAAqE;YACrE,kEAAkE;YAClE,EAAE;YACF,wDAAwD;YACxD,yCAAyC;YACzCS,YAAYG,UAAU,CAACC,IAAI,GAAGJ,YAAYG,UAAU;YACpDH,YAAYG,UAAU,CAACE,MAAM,GAAGL,YAAYG,UAAU;YACtDH,YAAYG,UAAU,CAACG,MAAM,GAAGN,YAAYG,UAAU;YAEtD,MAAM,IAAI,CAACI,oBAAoB,CAAChC,QAAQ;gBACtCyB,YAAYQ,QAAQ,CAAChC;gBACrB,IAAI,CAACiC,mBAAmB,CAAClC,QAAQe;YACnC;QACF,EAAE,OAAOzC,OAAO;YACd,IAAI,CAAC6D,UAAU,CAACnC;YAChB,MAAM,IAAIhB,MACR,CAAC,0BAA0B,EAAEgB,OAAO,GAAG,EAAE,AAAC1B,MAAgBV,OAAO,CAAC,CAAC;QAEvE;IACF;IAEA;;;GAGC,GACD,AAAUwE,cAAc;QACtB,uCAAuC;QACvC,+DAA+D;QAC/D,6CAA6C;QAC7C,IAAI,CAAChB,QAAQ,CAACiB,OAAO,CAAC,CAAC9D,OACrBA,KAAKgD,kBAAkB,CAACc,OAAO,CAAC,CAACC,aAAeA,WAAWC,IAAI;QAEjE,IAAI,CAACnB,QAAQ,CAACoB,KAAK;IACrB;IAEQN,oBAAoBlC,MAAc,EAAEe,UAAe,EAAE;QAC3D,MAAMxC,OAAO,IAAI,CAAC6C,QAAQ,CAACqB,GAAG,CAACzC;QAC/B,sDAAsD;QACtD,IAAI,CAACzB,MAAM;YACT;QACF;QAEAA,KAAKyC,OAAO,GAAGtF,kBAAkBgH,MAAM,CAAC,CAACC,KAAKC;YAC5C,MAAMC,aAAa9B,WAAWC,OAAO,CAAC4B,WAAW;YACjD,MAAM,EAAEE,SAAS,EAAE,GAAGlH,YAAY,CAACgH,WAAW;YAC9C,IAAIE,UAAUD,aAAa;gBACzB,OAAO;oBAAE,GAAGF,GAAG;oBAAE,CAACC,WAAW,EAAEC;gBAAW;YAC5C;YACA,OAAOF;QACT,GAAG,CAAC;IACN;IAEA;;;;;GAKC,GACD,AAAQ/B,iBAAiBN,QAAwB,EAAqB;QACpE,MAAMyC,kBAAkBzC,SAAS0C,OAAO,CAACC,IAAI,CAAC3C;QAE9C,MAAM0C,UAAU,OAAOE;YACrB,MAAMC,gBAAgBjH,YAAYgH;YAClClG,0BAA0BmG;YAC1B,IAAI,CAACtE,MAAM,CAAC;gBAAEC,QAAQ;YAAkB;YACxC,IAAI;gBACF,OAAO,MAAM3B,aAAa4F,gBAAgBI,gBAAgB,IAAI;YAChE,SAAU;gBACR,IAAI,CAACtE,MAAM,CAAC;oBAAEC,QAAQ;gBAAmB;YAC3C;QACF;QAEA,qEAAqE;QACrE,sDAAsD;QACtD,MAAMsE,kBAAkB,IAAIC,MAC1B,CAAC,GACD;YACEC,KAAIC,OAAe,EAAEC,IAAqB;gBACxC,OAAO,OAAOA,SAAS,YAAY;oBAAC;iBAAU,CAACC,QAAQ,CAACD;YAC1D;YACAf,KAAIc,OAAO,EAAEC,IAA0B;gBACrC,IAAIA,SAAS,WAAW;oBACtB,OAAOR;gBACT;gBAEA,OAAOU;YACT;QACF;QAGF,OAAOC,OAAOP;IAChB;IAEA;;;;;GAKC,GACD,AAAQtC,sBAAsBR,QAAwB,EAAkB;QACtE,MAAMyC,kBAAkBzC,SAAS0C,OAAO,CAACC,IAAI,CAAC3C;QAE9C,MAAM0C,UAAU,OAAOE;YACrB,MAAMC,gBAAgBjH,YAAYgH;YAClCnG,8BAA8BoG;YAC9B,IAAI,CAACtE,MAAM,CAAC;gBAAEC,QAAQ;YAAkB;YACxC,IAAI;gBACF,OAAO,MAAM3B,aAAa4F,gBAAgBI,gBAAgB,IAAI;YAChE,SAAU;gBACR,IAAI,CAACtE,MAAM,CAAC;oBAAEC,QAAQ;gBAAmB;YAC3C;QACF;QAEA,MAAM8E,sBAAsB1G,oBAAoBoD,UAAU0C;QAE1D,OAAOW,OAAOC;IAChB;IAEA;;;;GAIC,GACD,AAAQzB,WAAWnC,MAAc,EAAQ;QACvC,IAAI,CAACoB,QAAQ,CAACyC,MAAM,CAAC7D;IACvB;IAEA;;;;;;;;;;GAUC,GACD,MAAcgC,qBACZhC,MAAc,EACd8D,QAAwC,EACvB;QACjB,MAAMvF,OAAO,IAAI,CAAC6C,QAAQ,CAACqB,GAAG,CAACzC;QAC/B,IAAIzB,SAASmF,WAAW;YACtB,MAAM,IAAI1E,MACR,CAAC,8CAA8C,EAAEgB,OAAO,EAAE,CAAC;QAE/D;QAEA,IAAIuC;QACJ,MAAMwB,cAAc,IAAIC,QACtB,CAACC,GAAGC,SACD3B,OAAO,IACN2B,OACE,kEAAkE;gBAClE9H,UAAUsB,GAAG,CAACC,QAAQ,CACpB,CAAC,UAAU,EAAEqC,OAAO,uCAAuC,CAAC;QAKtE,oEAAoE;QACpE,MAAMmE,iBAAiB;YAAE5B,MAAMA;QAAM;QAErC,IAAI;YACFhE,KAAKgD,kBAAkB,CAAC6C,GAAG,CAACD;YAC5B,8CAA8C;YAC9C,oEAAoE;YACpE,uCAAuC;YACvC,OAAO,MAAMH,QAAQK,IAAI,CAAC;gBAACP;gBAAYC;aAAY;QACrD,SAAU;YACRxF,KAAKgD,kBAAkB,CAACsC,MAAM,CAACM;YAE/B,IAAI5F,KAAKgD,kBAAkB,CAAC+C,IAAI,KAAK,GAAG;gBACtC,IAAI,CAACC,YAAY,IAAI;gBACrB,MAAMhG,KAAK+C,YAAY;YACzB;QACF;IACF;IAxZA,YAAsB1B,aAAqB,EAAEW,SAAiB,CAAE;QAdhE,uBAAiBa,YAAjB,KAAA;QAEA,uBAAiBxB,iBAAjB,KAAA;QAEA,uBAAiBW,aAAjB,KAAA;QAEA,uBAAiBd,WAAjB,KAAA;QAEA,uBAAQW,oBAAR,KAAA;QAEA,uBAAQD,2BAAR,KAAA;QAEA,uBAAQoE,gBAAe;QAGrB,IAAI,CAACnD,QAAQ,GAAG,IAAIoD;QACpB,IAAI,CAAC5E,aAAa,GAAGA;QACrB,IAAI,CAACA,aAAa,CAAC6E,EAAE,CAAC,QAAQ,CAAClG;YAC7B,IAAI,CAACQ,gBAAgB,CAACR,MAAMmG,KAAK,CAAC,CAACpG;gBACjC,qCAAqC;gBACrC3C,SAAS2C;YACX;QACF;QACA,IAAI,CAACiC,SAAS,GAAGA;QAEjB,IAAI,CAACd,OAAO,GAAG/C,gCACb,IAAI,CAACqD,SAAS,CAACkD,IAAI,CAAC,IAAI,GACxB,OAAO0B,QAAQC,aAAa1B;YAC1B,MAAM3E,OAAO,IAAI,CAAC6C,QAAQ,CAACqB,GAAG,CAACkC;YAC/B,uEAAuE;YACvE,mBAAmB;YACnB,MAAME,UAAUtG,MAAMyC,OAAO,CAAC4D,YAAY;YAC1C,MAAM,EAAEE,QAAQ,EAAE,GAAGlJ,YAAY,CAACgJ,YAAY;YAE9C7I,OACE,CAAC+I,YAAYD,YAAYnB,WACzB,CAAC,GAAG,EAAEkB,YAAY,4BAA4B,EAAED,OAAO,CAAC;YAG1D,kEAAkE;YAClE,eAAe;YACf,IAAI,CAACE,SAAS;gBACZ,OAAO;YACT;YAEA,mCAAmC;YACnC,IAAI1F,SAAS,MAAM,IAAI,CAAC6C,oBAAoB,CAAC2C,QAAQ,IACnDE,QAAQ3B;YAGV,0EAA0E;YAC1E,IAAI/D,WAAWuE,WAAW;gBACxBvE,SAAS;YACX;YAEA,uEAAuE;YACvE,IAAI;gBACF,OAAOjD,YAAYiD;YACrB,EAAE,OAAOb,OAAO;gBACd,MAAM,IAAIyG,UACR,CAAC,sCAAsC,EAAEzG,MAAMV,OAAO,CAACoH,OAAO,CAC5D,wBACA,IACA,CAAC;YAEP;QACF,GACA,IAAI,CAAC5C,WAAW,CAACa,IAAI,CAAC,IAAI;IAE9B;AAkWF"}

package/dist/esm/common/commands.js

@@ -0,0 +1,80 @@
+import { HandlerType } from '@metamask/snaps-utils';
+import { assertExhaustive } from '@metamask/utils';
+import { assertIsOnTransactionRequestArguments, assertIsOnNameLookupRequestArguments } from './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.
+ */ export function getHandlerArguments(origin, handler, request) {
+    // `request` is already validated by the time this function is called.
+    switch(handler){
+        case HandlerType.OnTransaction:
+            {
+                assertIsOnTransactionRequestArguments(request.params);
+                const { transaction, chainId, transactionOrigin } = request.params;
+                return {
+                    transaction,
+                    chainId,
+                    transactionOrigin
+                };
+            }
+        case HandlerType.OnNameLookup:
+            {
+                assertIsOnNameLookupRequestArguments(request.params);
+                // TS complains that domain/address are not part of the type
+                // casting here as we've already validated the request args in the above step.
+                const { chainId, domain, address } = request.params;
+                return domain ? {
+                    chainId,
+                    domain
+                } : {
+                    chainId,
+                    address
+                };
+            }
+        case HandlerType.OnRpcRequest:
+            return {
+                origin,
+                request
+            };
+        case HandlerType.OnCronjob:
+        case HandlerType.OnInstall:
+        case HandlerType.OnUpdate:
+            return {
+                request
+            };
+        default:
+            return assertExhaustive(handler);
+    }
+}
+/**
+ * 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 function getCommandMethodImplementations(startSnap, invokeSnap, onTerminate) {
+    return {
+        ping: async ()=>Promise.resolve('OK'),
+        terminate: async ()=>{
+            onTerminate();
+            return Promise.resolve('OK');
+        },
+        executeSnap: async (snapId, sourceCode, endowments)=>{
+            await startSnap(snapId, sourceCode, endowments);
+            return 'OK';
+        },
+        snapRpc: async (target, handler, origin, request)=>{
+            return await invokeSnap(target, handler, getHandlerArguments(origin, handler, request)) ?? null;
+        }
+    };
+}
+
+//# sourceMappingURL=commands.js.map

package/dist/esm/common/commands.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/common/commands.ts"],"sourcesContent":["import { HandlerType } from '@metamask/snaps-utils';\nimport { assertExhaustive } from '@metamask/utils';\n\nimport type { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';\nimport type {\n  ExecuteSnap,\n  JsonRpcRequestWithoutId,\n  Ping,\n  PossibleLookupRequestArgs,\n  SnapRpc,\n  Terminate,\n} from './validation';\nimport {\n  assertIsOnTransactionRequestArguments,\n  assertIsOnNameLookupRequestArguments,\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    case HandlerType.OnNameLookup: {\n      assertIsOnNameLookupRequestArguments(request.params);\n\n      // TS complains that domain/address are not part of the type\n      // casting here as we've already validated the request args in the above step.\n      const { chainId, domain, address } =\n        request.params as unknown as PossibleLookupRequestArgs;\n\n      return domain\n        ? {\n            chainId,\n            domain,\n          }\n        : {\n            chainId,\n            address,\n          };\n    }\n    case HandlerType.OnRpcRequest:\n      return { origin, request };\n\n    case HandlerType.OnCronjob:\n    case HandlerType.OnInstall:\n    case HandlerType.OnUpdate:\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 (snapId, sourceCode, endowments) => {\n      await startSnap(snapId, 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"],"names":["HandlerType","assertExhaustive","assertIsOnTransactionRequestArguments","assertIsOnNameLookupRequestArguments","getHandlerArguments","origin","handler","request","OnTransaction","params","transaction","chainId","transactionOrigin","OnNameLookup","domain","address","OnRpcRequest","OnCronjob","OnInstall","OnUpdate","getCommandMethodImplementations","startSnap","invokeSnap","onTerminate","ping","Promise","resolve","terminate","executeSnap","snapId","sourceCode","endowments","snapRpc","target"],"mappings":"AAAA,SAASA,WAAW,QAAQ,wBAAwB;AACpD,SAASC,gBAAgB,QAAQ,kBAAkB;AAWnD,SACEC,qCAAqC,EACrCC,oCAAoC,QAC/B,eAAe;AAStB;;;;;;;CAOC,GACD,OAAO,SAASC,oBACdC,MAAc,EACdC,OAAoB,EACpBC,OAAgC;IAEhC,sEAAsE;IAEtE,OAAQD;QACN,KAAKN,YAAYQ,aAAa;YAAE;gBAC9BN,sCAAsCK,QAAQE,MAAM;gBAEpD,MAAM,EAAEC,WAAW,EAAEC,OAAO,EAAEC,iBAAiB,EAAE,GAAGL,QAAQE,MAAM;gBAClE,OAAO;oBACLC;oBACAC;oBACAC;gBACF;YACF;QACA,KAAKZ,YAAYa,YAAY;YAAE;gBAC7BV,qCAAqCI,QAAQE,MAAM;gBAEnD,4DAA4D;gBAC5D,8EAA8E;gBAC9E,MAAM,EAAEE,OAAO,EAAEG,MAAM,EAAEC,OAAO,EAAE,GAChCR,QAAQE,MAAM;gBAEhB,OAAOK,SACH;oBACEH;oBACAG;gBACF,IACA;oBACEH;oBACAI;gBACF;YACN;QACA,KAAKf,YAAYgB,YAAY;YAC3B,OAAO;gBAAEX;gBAAQE;YAAQ;QAE3B,KAAKP,YAAYiB,SAAS;QAC1B,KAAKjB,YAAYkB,SAAS;QAC1B,KAAKlB,YAAYmB,QAAQ;YACvB,OAAO;gBAAEZ;YAAQ;QAEnB;YACE,OAAON,iBAAiBK;IAC5B;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASc,gCACdC,SAA8D,EAC9DC,UAAsB,EACtBC,WAAuB;IAEvB,OAAO;QACLC,MAAM,UAAYC,QAAQC,OAAO,CAAC;QAClCC,WAAW;YACTJ;YACA,OAAOE,QAAQC,OAAO,CAAC;QACzB;QAEAE,aAAa,OAAOC,QAAQC,YAAYC;YACtC,MAAMV,UAAUQ,QAAQC,YAAYC;YACpC,OAAO;QACT;QAEAC,SAAS,OAAOC,QAAQ3B,SAASD,QAAQE;YACvC,OACE,AAAC,MAAMe,WACLW,QACA3B,SACAF,oBAAoBC,QAAQC,SAASC,aACjC;QAEV;IACF;AACF"}