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

package/dist/openrpc.json

@@ -0,0 +1,210 @@
+{
+    "openrpc": "1.2.4",
+    "info": {
+        "title": "MetaMask Snaps Execution Environment API",
+        "version": "0.0.0-development"
+    },
+    "methods": [
+        {
+            "name": "ping",
+            "description": "confirms that a connection has been established with the execution environment",
+            "params": [],
+            "result": {
+                "name": "PingResult",
+                "schema": {
+                    "$ref": "#/components/schemas/OK"
+                }
+            }
+        },
+        {
+            "name": "terminate",
+            "description": "tells the execution environment that it is being shut down",
+            "params": [],
+            "result": {
+                "name": "TerminateResult",
+                "schema": {
+                    "$ref": "#/components/schemas/OK"
+                }
+            }
+        },
+        {
+            "name": "executeSnap",
+            "description": "executes a snap in the environment. The snap can then be interacted with via `snapRpc`",
+            "params": [
+                {
+                    "name": "snapName",
+                    "required": true,
+                    "description": "the name of the snap",
+                    "schema": {
+                        "title": "SnapName",
+                        "type": "string"
+                    }
+                },
+                {
+                    "name": "sourceCode",
+                    "description": "a snaps source code that gets executed in the environment",
+                    "required": true,
+                    "schema": {
+                        "title": "SourceCode",
+                        "type": "string"
+                    }
+                },
+                {
+                    "name": "endowments",
+                    "description": "A list of endowments to provide to SES",
+                    "required": false,
+                    "schema": {
+                        "title": "Endowments",
+                        "description": "An array of the names of the endowments",
+                        "type": "array",
+                        "items": {
+                            "title": "Endowment",
+                            "type": "string"
+                        }
+                    }
+                }
+            ],
+            "result": {
+                "name": "executeSnapResult",
+                "schema": {
+                    "$ref": "#/components/schemas/OK"
+                }
+            },
+            "examples": [
+                {
+                    "name": "BasicTestSnapExecuteExample",
+                    "params": [
+                        {
+                            "name": "snapName",
+                            "value": "TestSnap"
+                        },
+                        {
+                            "name": "sourceCode",
+                            "value": "module.exports.onRpcRequest = async ({ request }) => { return request.method + request.id }"
+                        }
+                    ],
+                    "result": {
+                        "name": "BasicTestSnapExampleResult",
+                        "value": "OK"
+                    }
+                }
+            ]
+        },
+        {
+            "name": "snapRpc",
+            "params": [
+                {
+                    "name": "target",
+                    "required": true,
+                    "description": "the name of the snap",
+                    "schema": {
+                        "title": "Target",
+                        "type": "string"
+                    }
+                },
+                {
+                    "name": "handler",
+                    "required": true,
+                    "description": "the handler to trigger on the snap",
+                    "schema": {
+                        "title": "Handler",
+                        "type": "string",
+                        "enum": ["onRpcRequest", "onTransaction", "keyring"]
+                    }
+                },
+                {
+                    "name": "origin",
+                    "required": true,
+                    "description": "Origin of the snap JSON-RPC request",
+                    "schema": {
+                        "title": "Origin",
+                        "type": "string"
+                    }
+                },
+                {
+                    "name": "request",
+                    "required": true,
+                    "description": "JSON-RPC request",
+                    "schema": {
+                        "$ref": "#/components/schemas/JsonRpcRequest"
+                    }
+                }
+            ],
+            "result": {
+                "name": "HandleSnapRpcResult",
+                "schema": {
+                    "title": "SnapRpcResult"
+                }
+            },
+            "examples": [
+                {
+                    "name": "TestSnapExample",
+                    "params": [
+                        {
+                            "name": "target",
+                            "value": "TestSnap"
+                        },
+                        {
+                            "name": "origin",
+                            "value": "foo.com"
+                        },
+                        {
+                            "name": "request",
+                            "value": {
+                                "jsonrpc": "2.0",
+                                "method": "hello",
+                                "params": [],
+                                "id": 1
+                            }
+                        }
+                    ],
+                    "result": {
+                        "name": "TestSnapResultExample",
+                        "value": "hello1"
+                    }
+                }
+            ]
+        }
+    ],
+    "components": {
+        "schemas": {
+            "OK": {
+                "title": "OK",
+                "type": "string",
+                "const": "OK"
+            },
+            "JsonRpcRequest": {
+                "title": "JsonRpcRequest",
+                "type": "object",
+                "required": ["jsonrpc", "method"],
+                "properties": {
+                    "jsonrpc": {
+                        "title": "JSONRPCString",
+                        "type": "string",
+                        "const": "2.0"
+                    },
+                    "id": {
+                        "title": "JSONRPCID",
+                        "oneOf": [
+                            {
+                                "type": "string"
+                            },
+                            {
+                                "type": "number"
+                            }
+                        ]
+                    },
+                    "method": {
+                        "title": "JSONRPCMethod",
+                        "description": "the name of the method",
+                        "type": "string"
+                    },
+                    "params": {
+                        "title": "JSONRPCParams",
+                        "type": ["array", "object"]
+                    }
+                }
+            }
+        }
+    }
+}

package/package.json

@@ -1,48 +1,15 @@
 {
   "name": "@metamask/snaps-execution-environments",
-  "version": "0.35.0-flask.1",
+  "version": "1.0.0-prerelease.1",
   "description": "Snap sandbox environments for executing SES javascript",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
   },
-  "sideEffects": false,
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js",
-      "types": "./dist/types/index.d.ts"
-    },
-    "./package.json": "./package.json",
-    "./dist/cjs/*": {
-      "require": "./dist/cjs/*.js",
-      "types": "./dist/types/*.d.ts"
-    },
-    "./dist/esm/*": {
-      "import": "./dist/esm/*.js",
-      "types": "./dist/types/*.d.ts"
-    }
-  },
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "./dist/types/*"
-      ],
-      "./dist/cjs/*": [
-        "./dist/types/*"
-      ],
-      "./dist/esm/*": [
-        "./dist/types/*"
-      ]
-    }
-  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "dist/cjs/**",
-    "dist/esm/**",
-    "dist/types/**"
+    "dist/"
   ],
   "scripts": {
     "test": "rimraf coverage && jest && yarn test:browser && yarn posttest",
@@ -50,37 +17,33 @@
     "test:browser": "wdio run wdio.config.ts",
     "test:ci": "yarn test",
     "test:watch": "jest --watch",
-    "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:eslint": "eslint . --cache --ext js,ts",
+    "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' --ignore-path .gitignore",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "lint:changelog": "yarn auto-changelog validate",
-    "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog",
+    "lint": "yarn lint:eslint && yarn lint:misc --check",
     "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",
-    "lint:ci": "yarn lint",
-    "start": "node scripts/start.js"
+    "publish:package": "../../scripts/publish-package.sh"
   },
   "dependencies": {
     "@metamask/object-multiplex": "^1.2.0",
-    "@metamask/post-message-stream": "^6.1.2",
-    "@metamask/providers": "^11.0.0",
-    "@metamask/rpc-methods": "^0.35.0-flask.1",
-    "@metamask/snaps-utils": "^0.35.0-flask.1",
+    "@metamask/post-message-stream": "^6.1.1",
+    "@metamask/providers": "^10.2.0",
+    "@metamask/rpc-methods": "^1.0.0-prerelease.1",
+    "@metamask/snaps-utils": "^1.0.0-prerelease.1",
     "@metamask/utils": "^6.0.1",
     "eth-rpc-errors": "^4.0.3",
     "json-rpc-engine": "^6.1.0",
-    "nanoid": "^3.1.31",
     "pump": "^3.0.0",
     "ses": "^0.18.1",
     "stream-browserify": "^3.0.0",
@@ -92,7 +55,7 @@
     "@babel/preset-typescript": "^7.20.12",
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
-    "@lavamoat/allow-scripts": "^2.3.1",
+    "@lavamoat/allow-scripts": "^2.0.3",
     "@lavamoat/lavapack": "^5.1.2",
     "@lavamoat/lavatube": "^0.0.1",
     "@metamask/auto-changelog": "^3.1.0",
@@ -100,26 +63,22 @@
     "@metamask/eslint-config-jest": "^11.0.0",
     "@metamask/eslint-config-nodejs": "^11.0.1",
     "@metamask/eslint-config-typescript": "^11.0.0",
-    "@swc/cli": "^0.1.62",
-    "@swc/core": "^1.3.66",
-    "@swc/jest": "^0.2.26",
-    "@types/express": "^4.17.17",
     "@types/jest": "^27.5.1",
     "@types/node": "^20.3.1",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",
-    "@wdio/browser-runner": "^8.5.2",
-    "@wdio/cli": "^8.5.2",
-    "@wdio/globals": "^8.5.2",
-    "@wdio/mocha-framework": "^8.5.2",
-    "@wdio/spec-reporter": "^8.5.2",
-    "@wdio/static-server-service": "^8.5.2",
+    "@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",
     "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",
-    "esbuild": "^0.17.15",
     "eslint": "^8.27.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
@@ -140,16 +99,16 @@
     "prettier-plugin-packagejson": "^2.2.11",
     "process": "^0.11.10",
     "rimraf": "^4.1.2",
-    "serve-handler": "^6.1.5",
     "terser": "^5.17.7",
+    "ts-jest": "^29.0.0",
     "ts-node": "^10.9.1",
-    "tsconfig-paths": "^4.2.0",
+    "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.5.2",
+    "webdriverio": "^8.3.10",
     "yargs": "^17.7.1"
   },
   "engines": {