@metamask/snaps-execution-environments 1.0.2 → 2.0.0

package/dist/types/common/endowments/console.d.ts

@@ -0,0 +1,45 @@
+import type { EndowmentFactoryOptions } from './commonEndowmentFactory';
+export declare const consoleAttenuatedMethods: Set<string>;
+/**
+ * A set of all the `console` values that will be passed to the snap. This has
+ * all the values that are available in both the browser and Node.js.
+ */
+export declare const consoleMethods: Set<string>;
+/**
+ * Create a a {@link console} object, with the same properties as the global
+ * {@link console} object, but with some methods replaced.
+ *
+ * @param options - Factory options used in construction of the endowment.
+ * @param options.snapId - The id of the snap that will interact with the endowment.
+ * @returns The {@link console} object with the replaced methods.
+ */
+declare function createConsole({ snapId }?: EndowmentFactoryOptions): {
+    console: {
+        error: {
+            (...data: any[]): void;
+            (message?: any, ...optionalParams: any[]): void;
+        };
+        log: {
+            (...data: any[]): void;
+            (message?: any, ...optionalParams: any[]): void;
+        };
+        warn: {
+            (...data: any[]): void;
+            (message?: any, ...optionalParams: any[]): void;
+        };
+        debug: {
+            (...data: any[]): void;
+            (message?: any, ...optionalParams: any[]): void;
+        };
+        info: {
+            (...data: any[]): void;
+            (message?: any, ...optionalParams: any[]): void;
+        };
+        assert: (value: any, message?: string | undefined, ...optionalParams: any[]) => void;
+    };
+};
+declare const endowmentModule: {
+    names: readonly ["console"];
+    factory: typeof createConsole;
+};
+export default endowmentModule;

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

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

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

@@ -1,5 +1,6 @@
-import { StreamProvider } from '@metamask/providers';
-import { SnapsGlobalObject } from '@metamask/rpc-methods';
+import type { StreamProvider } from '@metamask/providers';
+import type { SnapsGlobalObject } from '@metamask/rpc-methods';
+import type { SnapId } from '@metamask/snaps-utils';
 /**
  * Gets the endowments for a particular Snap. Some endowments, like `setTimeout`
  * and `clearTimeout`, must be attenuated so that they can only affect behavior
@@ -9,10 +10,11 @@ import { SnapsGlobalObject } from '@metamask/rpc-methods';
  *
  * @param snap - The Snaps global API object.
  * @param ethereum - The Snap's EIP-1193 provider object.
+ * @param snapId - The id of the snap that will use the created endowments.
  * @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[]): {
+export declare function createEndowments(snap: SnapsGlobalObject, ethereum: StreamProvider, snapId: SnapId, endowments?: string[]): {
     endowments: Record<string, unknown>;
     teardown: () => Promise<void>;
 };

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

@@ -1,3 +1,4 @@
+/// <reference types="webpack-env" />
 /// <reference types="node" />
 /**
  * Adds an event listener platform agnostically, trying both `globalThis.addEventListener` and `globalThis.process.on`

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

@@ -1,4 +1,4 @@
-import { JsonRpcParams } from '@metamask/utils';
+import type { JsonRpcParams } from '@metamask/utils';
 /**
  * Deterministically sort JSON-RPC parameter keys. This makes it possible to
  * support both arrays and objects as parameters. Objects are sorted and turned

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

@@ -1,5 +1,5 @@
-import { StreamProvider } from '@metamask/providers';
-import { RequestArguments } from '@metamask/providers/dist/BaseProvider';
+import type { StreamProvider } from '@metamask/providers';
+import type { RequestArguments } from '@metamask/providers/dist/BaseProvider';
 /**
  * Takes an error that was thrown, determines if it is
  * an error object. If it is then it will return that. Otherwise,
@@ -19,9 +19,9 @@ export declare function constructError(originalError: unknown): Error | undefine
  * @param teardownRef.lastTeardown - Number of the last teardown.
  * @returns New proxy promise.
  */
-export declare function withTeardown<T>(originalPromise: Promise<T>, teardownRef: {
+export declare function withTeardown<Type>(originalPromise: Promise<Type>, teardownRef: {
     lastTeardown: number;
-}): Promise<T>;
+}): Promise<Type>;
 /**
  * Returns a Proxy that narrows down (attenuates) the fields available on
  * the StreamProvider and replaces the request implementation.
@@ -31,6 +31,7 @@ export declare function withTeardown<T>(originalPromise: Promise<T>, teardownRef
  * @returns Proxy to the StreamProvider instance.
  */
 export declare function proxyStreamProvider(provider: StreamProvider, request: unknown): StreamProvider;
+export declare const BLOCKED_RPC_METHODS: readonly string[];
 /**
  * Asserts the validity of request arguments for a snap outbound request using the `snap.request` API.
  *

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

@@ -1,14 +1,6 @@
 import { HandlerType } from '@metamask/snaps-utils';
-import { Json, JsonRpcSuccess } from '@metamask/utils';
-import { Infer } from 'superstruct';
-/**
- * Validates a given snap export.
- *
- * @param type - The type of export expected.
- * @param snapExport - The export itself.
- * @returns True if the export matches the expected shape, false otherwise.
- */
-export declare function validateExport(type: HandlerType, snapExport: unknown): boolean;
+import type { Json, JsonRpcSuccess } from '@metamask/utils';
+import type { Infer } from 'superstruct';
 export declare const JsonRpcRequestWithoutIdStruct: import("superstruct").Struct<{
     method: string;
     jsonrpc: "2.0";
@@ -70,6 +62,30 @@ export declare type OnTransactionRequestArguments = Infer<typeof OnTransactionRe
  * object.
  */
 export declare function assertIsOnTransactionRequestArguments(value: unknown): asserts value is OnTransactionRequestArguments;
+declare const baseNameLookupArgs: {
+    chainId: import("superstruct").Struct<string, null>;
+};
+export declare const OnNameLookupRequestArgumentsStruct: import("superstruct").Struct<{
+    chainId: string;
+    address: string;
+} | {
+    chainId: string;
+    domain: string;
+}, null>;
+export declare type OnNameLookupRequestArguments = Infer<typeof OnNameLookupRequestArgumentsStruct>;
+export declare type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {
+    address?: string;
+    domain?: string;
+};
+/**
+ * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnNameLookupRequestArguments}
+ * object.
+ */
+export declare function assertIsOnNameLookupRequestArguments(value: unknown): asserts value is OnNameLookupRequestArguments;
 declare const OkResponseStruct: import("superstruct").Struct<{
     id: string | number | null;
     jsonrpc: "2.0";

package/dist/{iframe → types/iframe}/IFrameSnapExecutor.d.ts

@@ -1,4 +1,4 @@
-import { BasePostMessageStream } from '@metamask/post-message-stream';
+import type { BasePostMessageStream } from '@metamask/post-message-stream';
 import { BaseSnapExecutor } from '../common/BaseSnapExecutor';
 export declare class IFrameSnapExecutor extends BaseSnapExecutor {
     /**

package/dist/{offscreen → types/offscreen}/OffscreenSnapExecutor.d.ts

@@ -1,4 +1,5 @@
-import { BasePostMessageStream, WindowPostMessageStream } from '@metamask/post-message-stream';
+import type { BasePostMessageStream } from '@metamask/post-message-stream';
+import { WindowPostMessageStream } from '@metamask/post-message-stream';
 declare type ExecutorJob = {
     id: string;
     window: Window;

package/dist/types/webworker/executor/WebWorkerSnapExecutor.d.ts

@@ -0,0 +1,13 @@
+import type { BasePostMessageStream } from '@metamask/post-message-stream';
+import { BaseSnapExecutor } from '../../common/BaseSnapExecutor';
+export declare class WebWorkerSnapExecutor extends BaseSnapExecutor {
+    /**
+     * Initialize the WebWorkerSnapExecutor. This creates a post message stream
+     * from and to the parent window, for two-way communication with the iframe.
+     *
+     * @param stream - The stream to use for communication.
+     * @returns An instance of `WebWorkerSnapExecutor`, with the initialized post
+     * message streams.
+     */
+    static initialize(stream?: BasePostMessageStream): WebWorkerSnapExecutor;
+}

package/dist/types/webworker/executor/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/webworker/pool/WebWorkerPool.d.ts

@@ -0,0 +1,23 @@
+import type { BasePostMessageStream } from '@metamask/post-message-stream';
+import { WebWorkerParentPostMessageStream } from '@metamask/post-message-stream';
+declare type ExecutorJob = {
+    id: string;
+    worker: Worker;
+    stream: WebWorkerParentPostMessageStream;
+};
+/**
+ * A snap executor using the WebWorker API.
+ *
+ * This is not a traditional snap executor, as it does not execute snaps itself.
+ * Instead, it creates a pool of webworkers for each snap execution, and sends
+ * the snap execution request to the webworker. The webworker is responsible for
+ * executing the snap.
+ */
+export declare class WebWorkerPool {
+    #private;
+    readonly pool: Worker[];
+    readonly jobs: Map<string, ExecutorJob>;
+    static initialize(stream?: BasePostMessageStream, url?: string, poolSize?: number): WebWorkerPool;
+    constructor(stream: BasePostMessageStream, url: string, poolSize?: number);
+}
+export {};

package/dist/types/webworker/pool/index.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "@metamask/snaps-execution-environments",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "Snap sandbox environments for executing SES javascript",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
   "files": [
-    "dist/"
+    "dist/cjs/**",
+    "dist/esm/**",
+    "dist/types/**",
+    "dist/browserify/**"
   ],
   "scripts": {
     "test": "rimraf coverage && jest && yarn test:browser && yarn posttest",
@@ -17,36 +22,38 @@
     "test:browser": "wdio run wdio.config.ts",
     "test:ci": "yarn test",
     "test:watch": "jest --watch",
-    "lint:eslint": "eslint . --cache --ext js,ts",
-    "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' --ignore-path .gitignore",
+    "lint:eslint": "eslint . --cache --ext js,ts,jsx,tsx",
+    "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" --ignore-path ./.prettierignore",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
-    "lint:changelog": "yarn auto-changelog validate",
-    "lint": "yarn lint:eslint && yarn lint:misc --check",
-    "clean": "rimraf '*.tsbuildinfo' 'dist/*' 'src/__GENERATED__/' 'coverage/*' '__test__/*'",
+    "lint:changelog": "../../scripts/validate-changelog.sh @metamask/snaps-execution-environments",
+    "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog && yarn lint:dependencies",
+    "clean": "rimraf '*.tsbuildinfo' 'dist' 'src/__GENERATED__/' 'coverage/*' '__test__/*'",
+    "build": "yarn build:source && yarn build:types",
+    "build:source": "yarn build:esm && yarn build:cjs",
+    "build:types": "tsc --project tsconfig.build.json",
+    "build:esm": "swc src --out-dir dist/esm --config-file ../../.swcrc.build.json --config module.type=es6",
+    "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
     "build:post-tsc": "yarn build:lavamoat",
-    "build:tsc": "tsc --project tsconfig.build.json",
-    "build": "yarn build:tsc && yarn build:post-tsc",
-    "build:test": "yarn build:lavamoat",
     "build:lavamoat": "lavamoat scripts/build.js --policy lavamoat/build-system/policy.json  --policyOverride lavamoat/build-system/policy-override.json",
     "build:lavamoat:policy": "yarn build:lavamoat --writeAutoPolicy && node scripts/build.js --writeAutoPolicy",
     "auto-changelog-init": "auto-changelog init",
     "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
-    "publish:package": "../../scripts/publish-package.sh"
+    "lint:ci": "yarn lint",
+    "start": "node scripts/start.js",
+    "lint:dependencies": "depcheck"
   },
   "dependencies": {
     "@metamask/object-multiplex": "^1.2.0",
-    "@metamask/post-message-stream": "^6.1.1",
-    "@metamask/providers": "^10.2.0",
-    "@metamask/rpc-methods": "^1.0.2",
-    "@metamask/snaps-utils": "^1.0.2",
-    "@metamask/utils": "^6.0.1",
+    "@metamask/post-message-stream": "^7.0.0",
+    "@metamask/providers": "^11.1.1",
+    "@metamask/rpc-methods": "^2.0.0",
+    "@metamask/snaps-utils": "^2.0.0",
+    "@metamask/utils": "^8.1.0",
     "eth-rpc-errors": "^4.0.3",
     "json-rpc-engine": "^6.1.0",
-    "pump": "^3.0.0",
-    "ses": "^0.18.1",
-    "stream-browserify": "^3.0.0",
+    "nanoid": "^3.1.31",
     "superstruct": "^1.0.3"
   },
   "devDependencies": {
@@ -59,57 +66,61 @@
     "@lavamoat/lavapack": "^5.2.1",
     "@lavamoat/lavatube": "^0.2.3",
     "@metamask/auto-changelog": "^3.1.0",
-    "@metamask/eslint-config": "^11.0.0",
-    "@metamask/eslint-config-jest": "^11.0.0",
-    "@metamask/eslint-config-nodejs": "^11.0.1",
-    "@metamask/eslint-config-typescript": "^11.0.0",
+    "@metamask/eslint-config": "^12.1.0",
+    "@metamask/eslint-config-jest": "^12.1.0",
+    "@metamask/eslint-config-nodejs": "^12.1.0",
+    "@metamask/eslint-config-typescript": "^12.1.0",
+    "@swc/cli": "^0.1.62",
+    "@swc/core": "1.3.78",
+    "@swc/jest": "^0.2.26",
+    "@types/express": "^4.17.17",
     "@types/jest": "^27.5.1",
-    "@types/node": "^20.3.1",
+    "@types/node": "18.14.2",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",
-    "@wdio/browser-runner": "^8.3.10",
-    "@wdio/cli": "^8.3.10",
-    "@wdio/globals": "^8.3.10",
-    "@wdio/mocha-framework": "^8.3.0",
-    "@wdio/spec-reporter": "^8.3.0",
-    "@wdio/static-server-service": "^8.3.0",
-    "babel-loader": "^9.1.2",
+    "@wdio/browser-runner": "^8.15.9",
+    "@wdio/cli": "^8.15.9",
+    "@wdio/globals": "^8.15.9",
+    "@wdio/mocha-framework": "^8.15.9",
+    "@wdio/spec-reporter": "^8.15.7",
+    "@wdio/static-server-service": "^8.15.7",
     "babel-plugin-tsconfig-paths-module-resolver": "^1.0.4",
     "babelify": "^10.0.0",
     "browserify": "^17.0.0",
-    "buffer": "^6.0.3",
     "deepmerge": "^4.2.2",
+    "depcheck": "^1.4.5",
+    "esbuild": "^0.18.10",
     "eslint": "^8.27.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jest": "^27.1.5",
     "eslint-plugin-jsdoc": "^39.6.2",
-    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.1",
     "expect-webdriverio": "^4.1.2",
+    "express": "^4.18.2",
     "istanbul-lib-coverage": "^3.2.0",
     "istanbul-lib-report": "^3.0.0",
     "istanbul-reports": "^3.1.5",
     "jest": "^29.0.2",
+    "jest-environment-node": "^29.5.0",
     "jest-fetch-mock": "^3.0.3",
     "lavamoat": "^7.0.0",
     "lavamoat-browserify": "^15.7.1",
-    "memfs": "^3.4.13",
     "prettier": "^2.7.1",
     "prettier-plugin-packagejson": "^2.2.11",
-    "process": "^0.11.10",
     "rimraf": "^4.1.2",
+    "serve-handler": "^6.1.5",
     "ses": "^0.18.7",
     "terser": "^5.17.7",
-    "ts-jest": "^29.0.0",
     "ts-node": "^10.9.1",
-    "tsconfig-paths": "^4.1.2",
     "typescript": "~4.8.4",
     "vite": "^4.3.9",
     "vite-tsconfig-paths": "^4.0.5",
     "wdio-chromedriver-service": "^8.1.1",
-    "wdio-geckodriver-service": "^4.1.0",
-    "webdriverio": "^8.3.10",
+    "wdio-geckodriver-service": "^5.0.2",
+    "webdriverio": "^8.15.9",
     "yargs": "^17.7.1"
   },
   "engines": {