@metamask/snaps-execution-environments 6.6.1 → 6.7.0

package/dist/common/sortParams.mjs

@@ -1,8 +1,31 @@
-import {
-  sortParamKeys
-} from "../chunk-BTEAZZKP.mjs";
-import "../chunk-YRZVIDCF.mjs";
-export {
-  sortParamKeys
+// original source sortParamKeys from: https://github.com/etclabscore/sig.tools/blob/master/src/postMessageServer/postMessageServer.ts#L75-L77
+/**
+ * Deterministically sort JSON-RPC parameter keys. This makes it possible to
+ * support both arrays and objects as parameters. Objects are sorted and turned
+ * into arrays, for easier consumption by the snap.
+ *
+ * The order is defined by the `method` parameter.
+ *
+ * @param methodParams - The parameters of the JSON-RPC method, which
+ * determines the ordering for the parameters.
+ * @param params - JSON-RPC parameters as object or array.
+ * @returns The values for the sorted keys. If `params` is not provided, this
+ * returns an empty array. If `params` is an array, this returns the same
+ * `params`.
+ */
+export const sortParamKeys = (methodParams, params) => {
+    if (!params) {
+        return [];
+    }
+    if (params instanceof Array) {
+        return params;
+    }
+    const methodParamsOrder = methodParams.reduce((paramsOrderObj, paramsName, i) => ({
+        ...paramsOrderObj,
+        [paramsName]: i,
+    }), {});
+    return Object.entries(params)
+        .sort(([name1, _1], [name2, _2]) => methodParamsOrder[name1] - methodParamsOrder[name2])
+        .map(([_, val]) => val);
 };
 //# sourceMappingURL=sortParams.mjs.map

package/dist/common/sortParams.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"sortParams.mjs","sourceRoot":"","sources":["../../src/common/sortParams.ts"],"names":[],"mappings":"AAAA,8IAA8I;AAI9I;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,YAAsB,EACtB,MAAsB,EACtB,EAAE;IACF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,MAAM,YAAY,KAAK,EAAE,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,iBAAiB,GAA4B,YAAY,CAAC,MAAM,CACpE,CAAC,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAClC,GAAG,cAAc;QACjB,CAAC,UAAU,CAAC,EAAE,CAAC;KAChB,CAAC,EACF,EAAE,CACH,CAAC;IAEF,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;SAC1B,IAAI,CACH,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,CAC3B,iBAAiB,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,CACtD;SACA,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;AAC5B,CAAC,CAAC","sourcesContent":["// original source sortParamKeys from: https://github.com/etclabscore/sig.tools/blob/master/src/postMessageServer/postMessageServer.ts#L75-L77\n\nimport type { JsonRpcParams } from '@metamask/utils';\n\n/**\n * Deterministically sort JSON-RPC parameter keys. This makes it possible to\n * support both arrays and objects as parameters. Objects are sorted and turned\n * into arrays, for easier consumption by the snap.\n *\n * The order is defined by the `method` parameter.\n *\n * @param methodParams - The parameters of the JSON-RPC method, which\n * determines the ordering for the parameters.\n * @param params - JSON-RPC parameters as object or array.\n * @returns The values for the sorted keys. If `params` is not provided, this\n * returns an empty array. If `params` is an array, this returns the same\n * `params`.\n */\nexport const sortParamKeys = (\n  methodParams: string[],\n  params?: JsonRpcParams,\n) => {\n  if (!params) {\n    return [];\n  }\n\n  if (params instanceof Array) {\n    return params;\n  }\n\n  const methodParamsOrder: { [k: string]: number } = methodParams.reduce(\n    (paramsOrderObj, paramsName, i) => ({\n      ...paramsOrderObj,\n      [paramsName]: i,\n    }),\n    {},\n  );\n\n  return Object.entries(params)\n    .sort(\n      ([name1, _1], [name2, _2]) =>\n        methodParamsOrder[name1] - methodParamsOrder[name2],\n    )\n    .map(([_, val]) => val);\n};\n"]}

package/dist/common/utils.cjs

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidResponse = exports.sanitizeRequestArguments = exports.assertEthereumOutboundRequest = exports.assertSnapOutboundRequest = exports.BLOCKED_RPC_METHODS = exports.proxyStreamProvider = exports.withTeardown = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const utils_1 = require("@metamask/utils");
+const logging_1 = require("../logging.cjs");
+// 64 MB - we chose this number because it is the size limit for postMessage
+// between the extension and the dapp enforced by Chrome.
+const MAX_RESPONSE_JSON_SIZE = 64000000;
+/**
+ * Make proxy for Promise and handle the teardown process properly.
+ * If the teardown is called in the meanwhile, Promise result will not be
+ * exposed to the snap anymore and warning will be logged to the console.
+ *
+ * @param originalPromise - Original promise.
+ * @param teardownRef - Reference containing teardown count.
+ * @param teardownRef.lastTeardown - Number of the last teardown.
+ * @returns New proxy promise.
+ */
+async function withTeardown(originalPromise, teardownRef) {
+    const myTeardown = teardownRef.lastTeardown;
+    return new Promise((resolve, reject) => {
+        originalPromise
+            .then((value) => {
+            if (teardownRef.lastTeardown === myTeardown) {
+                resolve(value);
+            }
+            else {
+                (0, logging_1.log)('Late promise received after Snap finished execution. Promise will be dropped.');
+            }
+        })
+            .catch((reason) => {
+            if (teardownRef.lastTeardown === myTeardown) {
+                reject(reason);
+            }
+            else {
+                (0, logging_1.log)('Late promise received after Snap finished execution. Promise will be dropped.');
+            }
+        });
+    });
+}
+exports.withTeardown = withTeardown;
+/**
+ * Returns a Proxy that only allows access to a `request` function.
+ * This is useful for replacing StreamProvider with an attenuated version.
+ *
+ * @param request - Custom attenuated request function.
+ * @returns Proxy that mimics a StreamProvider instance.
+ */
+function proxyStreamProvider(request) {
+    // Proxy target is intentionally set to be an empty object, to ensure
+    // that access to the prototype chain is not possible.
+    const proxy = new Proxy({}, {
+        has(_target, prop) {
+            return typeof prop === 'string' && ['request'].includes(prop);
+        },
+        get(_target, prop) {
+            if (prop === 'request') {
+                return request;
+            }
+            return undefined;
+        },
+    });
+    return proxy;
+}
+exports.proxyStreamProvider = proxyStreamProvider;
+// We're blocking these RPC methods for v1, will revisit later.
+exports.BLOCKED_RPC_METHODS = Object.freeze([
+    'wallet_requestPermissions',
+    'wallet_revokePermissions',
+    // We disallow all of these confirmations for now, since the screens are not ready for Snaps.
+    'eth_sendTransaction',
+    'eth_sign',
+    'eth_signTypedData',
+    'eth_signTypedData_v1',
+    'eth_signTypedData_v3',
+    'eth_signTypedData_v4',
+    'eth_decrypt',
+    'eth_getEncryptionPublicKey',
+    'wallet_addEthereumChain',
+    'wallet_switchEthereumChain',
+    'wallet_watchAsset',
+    'wallet_registerOnboarding',
+    'wallet_scanQRCode',
+]);
+/**
+ * Asserts the validity of request arguments for a snap outbound request using the `snap.request` API.
+ *
+ * @param args - The arguments to validate.
+ */
+function assertSnapOutboundRequest(args) {
+    // Disallow any non `wallet_` or `snap_` methods for separation of concerns.
+    (0, utils_1.assert)(String.prototype.startsWith.call(args.method, 'wallet_') ||
+        String.prototype.startsWith.call(args.method, 'snap_'), 'The global Snap API only allows RPC methods starting with `wallet_*` and `snap_*`.', rpc_errors_1.rpcErrors.methodNotSupported);
+    (0, utils_1.assert)(!exports.BLOCKED_RPC_METHODS.includes(args.method), rpc_errors_1.rpcErrors.methodNotFound({
+        data: {
+            method: args.method,
+        },
+    }));
+    (0, utils_1.assertStruct)(args, utils_1.JsonStruct, 'Provided value is not JSON-RPC compatible', rpc_errors_1.rpcErrors.invalidParams);
+}
+exports.assertSnapOutboundRequest = assertSnapOutboundRequest;
+/**
+ * Asserts the validity of request arguments for an ethereum outbound request using the `ethereum.request` API.
+ *
+ * @param args - The arguments to validate.
+ */
+function assertEthereumOutboundRequest(args) {
+    // Disallow snaps methods for separation of concerns.
+    (0, utils_1.assert)(!String.prototype.startsWith.call(args.method, 'snap_'), rpc_errors_1.rpcErrors.methodNotFound({
+        data: {
+            method: args.method,
+        },
+    }));
+    (0, utils_1.assert)(!exports.BLOCKED_RPC_METHODS.includes(args.method), rpc_errors_1.rpcErrors.methodNotFound({
+        data: {
+            method: args.method,
+        },
+    }));
+    (0, utils_1.assertStruct)(args, utils_1.JsonStruct, 'Provided value is not JSON-RPC compatible', rpc_errors_1.rpcErrors.invalidParams);
+}
+exports.assertEthereumOutboundRequest = assertEthereumOutboundRequest;
+/**
+ * Gets a sanitized value to be used for passing to the underlying MetaMask provider.
+ *
+ * @param value - An unsanitized value from a snap.
+ * @returns A sanitized value ready to be passed to a MetaMask provider.
+ */
+function sanitizeRequestArguments(value) {
+    // Before passing to getSafeJson we run the value through JSON serialization.
+    // This lets request arguments contain undefined which is normally disallowed.
+    const json = JSON.parse(JSON.stringify(value));
+    return (0, utils_1.getSafeJson)(json);
+}
+exports.sanitizeRequestArguments = sanitizeRequestArguments;
+/**
+ * Check if the input is a valid response.
+ *
+ * @param response - The response.
+ * @returns True if the response is valid, otherwise false.
+ */
+function isValidResponse(response) {
+    if (!(0, utils_1.isObject)(response)) {
+        return false;
+    }
+    try {
+        // If the JSON is invalid this will throw and we should return false.
+        const size = (0, utils_1.getJsonSize)(response);
+        return size < MAX_RESPONSE_JSON_SIZE;
+    }
+    catch {
+        return false;
+    }
+}
+exports.isValidResponse = isValidResponse;
+//# sourceMappingURL=utils.cjs.map

package/dist/common/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../../src/common/utils.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,2CAOyB;AAEzB,4CAAiC;AAEjC,4EAA4E;AAC5E,yDAAyD;AACzD,MAAM,sBAAsB,GAAG,QAAU,CAAC;AAE1C;;;;;;;;;GASG;AACI,KAAK,UAAU,YAAY,CAChC,eAA8B,EAC9B,WAAqC;IAErC,MAAM,UAAU,GAAG,WAAW,CAAC,YAAY,CAAC;IAC5C,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,eAAe;aACZ,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;gBAC5C,OAAO,CAAC,KAAK,CAAC,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,IAAA,aAAG,EACD,+EAA+E,CAChF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;YAChB,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,IAAA,aAAG,EACD,+EAA+E,CAChF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AA1BD,oCA0BC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,OAAgB;IAClD,qEAAqE;IACrE,sDAAsD;IACtD,MAAM,KAAK,GAAG,IAAI,KAAK,CACrB,EAAE,EACF;QACE,GAAG,CAAC,OAAe,EAAE,IAAqB;YACxC,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChE,CAAC;QACD,GAAG,CAAC,OAAO,EAAE,IAA0B;YACrC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,OAAO,OAAO,CAAC;YACjB,CAAC;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;KACF,CACF,CAAC;IAEF,OAAO,KAAuB,CAAC;AACjC,CAAC;AApBD,kDAoBC;AAED,+DAA+D;AAClD,QAAA,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C,2BAA2B;IAC3B,0BAA0B;IAC1B,6FAA6F;IAC7F,qBAAqB;IACrB,UAAU;IACV,mBAAmB;IACnB,sBAAsB;IACtB,sBAAsB;IACtB,sBAAsB;IACtB,aAAa;IACb,4BAA4B;IAC5B,yBAAyB;IACzB,4BAA4B;IAC5B,mBAAmB;IACnB,2BAA2B;IAC3B,mBAAmB;CACpB,CAAC,CAAC;AAEH;;;;GAIG;AACH,SAAgB,yBAAyB,CAAC,IAAsB;IAC9D,4EAA4E;IAC5E,IAAA,cAAM,EACJ,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC;QACtD,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,oFAAoF,EACpF,sBAAS,CAAC,kBAAkB,CAC7B,CAAC;IACF,IAAA,cAAM,EACJ,CAAC,2BAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAC1C,sBAAS,CAAC,cAAc,CAAC;QACvB,IAAI,EAAE;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB;KACF,CAAC,CACH,CAAC;IACF,IAAA,oBAAY,EACV,IAAI,EACJ,kBAAU,EACV,2CAA2C,EAC3C,sBAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAtBD,8DAsBC;AAED;;;;GAIG;AACH,SAAgB,6BAA6B,CAAC,IAAsB;IAClE,qDAAqD;IACrD,IAAA,cAAM,EACJ,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,EACvD,sBAAS,CAAC,cAAc,CAAC;QACvB,IAAI,EAAE;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB;KACF,CAAC,CACH,CAAC;IACF,IAAA,cAAM,EACJ,CAAC,2BAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAC1C,sBAAS,CAAC,cAAc,CAAC;QACvB,IAAI,EAAE;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB;KACF,CAAC,CACH,CAAC;IACF,IAAA,oBAAY,EACV,IAAI,EACJ,kBAAU,EACV,2CAA2C,EAC3C,sBAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAxBD,sEAwBC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,KAAc;IACrD,6EAA6E;IAC7E,8EAA8E;IAC9E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/C,OAAO,IAAA,mBAAW,EAAC,IAAI,CAAqB,CAAC;AAC/C,CAAC;AALD,4DAKC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,QAAiC;IAC/D,IAAI,CAAC,IAAA,gBAAQ,EAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,qEAAqE;QACrE,MAAM,IAAI,GAAG,IAAA,mBAAW,EAAC,QAAQ,CAAC,CAAC;QACnC,OAAO,IAAI,GAAG,sBAAsB,CAAC;IACvC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAZD,0CAYC","sourcesContent":["import type { StreamProvider, RequestArguments } from '@metamask/providers';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport {\n  assert,\n  assertStruct,\n  getJsonSize,\n  getSafeJson,\n  isObject,\n  JsonStruct,\n} from '@metamask/utils';\n\nimport { log } from '../logging';\n\n// 64 MB - we chose this number because it is the size limit for postMessage\n// between the extension and the dapp enforced by Chrome.\nconst MAX_RESPONSE_JSON_SIZE = 64_000_000;\n\n/**\n * Make proxy for Promise and handle the teardown process properly.\n * If the teardown is called in the meanwhile, Promise result will not be\n * exposed to the snap anymore and warning will be logged to the console.\n *\n * @param originalPromise - Original promise.\n * @param teardownRef - Reference containing teardown count.\n * @param teardownRef.lastTeardown - Number of the last teardown.\n * @returns New proxy promise.\n */\nexport async function withTeardown<Type>(\n  originalPromise: Promise<Type>,\n  teardownRef: { lastTeardown: number },\n): Promise<Type> {\n  const myTeardown = teardownRef.lastTeardown;\n  return new Promise<Type>((resolve, reject) => {\n    originalPromise\n      .then((value) => {\n        if (teardownRef.lastTeardown === myTeardown) {\n          resolve(value);\n        } else {\n          log(\n            'Late promise received after Snap finished execution. Promise will be dropped.',\n          );\n        }\n      })\n      .catch((reason) => {\n        if (teardownRef.lastTeardown === myTeardown) {\n          reject(reason);\n        } else {\n          log(\n            'Late promise received after Snap finished execution. Promise will be dropped.',\n          );\n        }\n      });\n  });\n}\n\n/**\n * Returns a Proxy that only allows access to a `request` function.\n * This is useful for replacing StreamProvider with an attenuated version.\n *\n * @param request - Custom attenuated request function.\n * @returns Proxy that mimics a StreamProvider instance.\n */\nexport function proxyStreamProvider(request: unknown): StreamProvider {\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 proxy = 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  );\n\n  return proxy as StreamProvider;\n}\n\n// We're blocking these RPC methods for v1, will revisit later.\nexport const BLOCKED_RPC_METHODS = Object.freeze([\n  'wallet_requestPermissions',\n  'wallet_revokePermissions',\n  // We disallow all of these confirmations for now, since the screens are not ready for Snaps.\n  'eth_sendTransaction',\n  'eth_sign',\n  'eth_signTypedData',\n  'eth_signTypedData_v1',\n  'eth_signTypedData_v3',\n  'eth_signTypedData_v4',\n  'eth_decrypt',\n  'eth_getEncryptionPublicKey',\n  'wallet_addEthereumChain',\n  'wallet_switchEthereumChain',\n  'wallet_watchAsset',\n  'wallet_registerOnboarding',\n  'wallet_scanQRCode',\n]);\n\n/**\n * Asserts the validity of request arguments for a snap outbound request using the `snap.request` API.\n *\n * @param args - The arguments to validate.\n */\nexport function assertSnapOutboundRequest(args: RequestArguments) {\n  // Disallow any non `wallet_` or `snap_` methods for separation of concerns.\n  assert(\n    String.prototype.startsWith.call(args.method, 'wallet_') ||\n      String.prototype.startsWith.call(args.method, 'snap_'),\n    'The global Snap API only allows RPC methods starting with `wallet_*` and `snap_*`.',\n    rpcErrors.methodNotSupported,\n  );\n  assert(\n    !BLOCKED_RPC_METHODS.includes(args.method),\n    rpcErrors.methodNotFound({\n      data: {\n        method: args.method,\n      },\n    }),\n  );\n  assertStruct(\n    args,\n    JsonStruct,\n    'Provided value is not JSON-RPC compatible',\n    rpcErrors.invalidParams,\n  );\n}\n\n/**\n * Asserts the validity of request arguments for an ethereum outbound request using the `ethereum.request` API.\n *\n * @param args - The arguments to validate.\n */\nexport function assertEthereumOutboundRequest(args: RequestArguments) {\n  // Disallow snaps methods for separation of concerns.\n  assert(\n    !String.prototype.startsWith.call(args.method, 'snap_'),\n    rpcErrors.methodNotFound({\n      data: {\n        method: args.method,\n      },\n    }),\n  );\n  assert(\n    !BLOCKED_RPC_METHODS.includes(args.method),\n    rpcErrors.methodNotFound({\n      data: {\n        method: args.method,\n      },\n    }),\n  );\n  assertStruct(\n    args,\n    JsonStruct,\n    'Provided value is not JSON-RPC compatible',\n    rpcErrors.invalidParams,\n  );\n}\n\n/**\n * Gets a sanitized value to be used for passing to the underlying MetaMask provider.\n *\n * @param value - An unsanitized value from a snap.\n * @returns A sanitized value ready to be passed to a MetaMask provider.\n */\nexport function sanitizeRequestArguments(value: unknown): RequestArguments {\n  // Before passing to getSafeJson we run the value through JSON serialization.\n  // This lets request arguments contain undefined which is normally disallowed.\n  const json = JSON.parse(JSON.stringify(value));\n  return getSafeJson(json) as RequestArguments;\n}\n\n/**\n * Check if the input is a valid response.\n *\n * @param response - The response.\n * @returns True if the response is valid, otherwise false.\n */\nexport function isValidResponse(response: Record<string, unknown>) {\n  if (!isObject(response)) {\n    return false;\n  }\n\n  try {\n    // If the JSON is invalid this will throw and we should return false.\n    const size = getJsonSize(response);\n    return size < MAX_RESPONSE_JSON_SIZE;\n  } catch {\n    return false;\n  }\n}\n"]}

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

@@ -1,4 +1,4 @@
-import type { StreamProvider, RequestArguments } from '@metamask/providers';
+import type { StreamProvider, RequestArguments } from "@metamask/providers";
 /**
  * Make proxy for Promise and handle the teardown process properly.
  * If the teardown is called in the meanwhile, Promise result will not be
@@ -47,3 +47,4 @@ export declare function sanitizeRequestArguments(value: unknown): RequestArgumen
  * @returns True if the response is valid, otherwise false.
  */
 export declare function isValidResponse(response: Record<string, unknown>): boolean;
+//# sourceMappingURL=utils.d.cts.map

package/dist/common/utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../../src/common/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,4BAA4B;AAiB5E;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAAC,IAAI,EACrC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,EAC9B,WAAW,EAAE;IAAE,YAAY,EAAE,MAAM,CAAA;CAAE,GACpC,OAAO,CAAC,IAAI,CAAC,CAuBf;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,cAAc,CAoBpE;AAGD,eAAO,MAAM,mBAAmB,mBAiB9B,CAAC;AAEH;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,gBAAgB,QAsB/D;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,gBAAgB,QAwBnE;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAKzE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WAYhE"}

package/dist/common/utils.d.mts

@@ -0,0 +1,50 @@
+import type { StreamProvider, RequestArguments } from "@metamask/providers";
+/**
+ * Make proxy for Promise and handle the teardown process properly.
+ * If the teardown is called in the meanwhile, Promise result will not be
+ * exposed to the snap anymore and warning will be logged to the console.
+ *
+ * @param originalPromise - Original promise.
+ * @param teardownRef - Reference containing teardown count.
+ * @param teardownRef.lastTeardown - Number of the last teardown.
+ * @returns New proxy promise.
+ */
+export declare function withTeardown<Type>(originalPromise: Promise<Type>, teardownRef: {
+    lastTeardown: number;
+}): Promise<Type>;
+/**
+ * Returns a Proxy that only allows access to a `request` function.
+ * This is useful for replacing StreamProvider with an attenuated version.
+ *
+ * @param request - Custom attenuated request function.
+ * @returns Proxy that mimics a StreamProvider instance.
+ */
+export declare function proxyStreamProvider(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.
+ *
+ * @param args - The arguments to validate.
+ */
+export declare function assertSnapOutboundRequest(args: RequestArguments): void;
+/**
+ * Asserts the validity of request arguments for an ethereum outbound request using the `ethereum.request` API.
+ *
+ * @param args - The arguments to validate.
+ */
+export declare function assertEthereumOutboundRequest(args: RequestArguments): void;
+/**
+ * Gets a sanitized value to be used for passing to the underlying MetaMask provider.
+ *
+ * @param value - An unsanitized value from a snap.
+ * @returns A sanitized value ready to be passed to a MetaMask provider.
+ */
+export declare function sanitizeRequestArguments(value: unknown): RequestArguments;
+/**
+ * Check if the input is a valid response.
+ *
+ * @param response - The response.
+ * @returns True if the response is valid, otherwise false.
+ */
+export declare function isValidResponse(response: Record<string, unknown>): boolean;
+//# sourceMappingURL=utils.d.mts.map

package/dist/common/utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../src/common/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,4BAA4B;AAiB5E;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAAC,IAAI,EACrC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,EAC9B,WAAW,EAAE;IAAE,YAAY,EAAE,MAAM,CAAA;CAAE,GACpC,OAAO,CAAC,IAAI,CAAC,CAuBf;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,cAAc,CAoBpE;AAGD,eAAO,MAAM,mBAAmB,mBAiB9B,CAAC;AAEH;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,gBAAgB,QAsB/D;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,gBAAgB,QAwBnE;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAKzE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WAYhE"}

package/dist/common/utils.mjs

@@ -1,21 +1,147 @@
-import {
-  BLOCKED_RPC_METHODS,
-  assertEthereumOutboundRequest,
-  assertSnapOutboundRequest,
-  isValidResponse,
-  proxyStreamProvider,
-  sanitizeRequestArguments,
-  withTeardown
-} from "../chunk-HL2TTKF3.mjs";
-import "../chunk-5DEV3QQU.mjs";
-import "../chunk-YRZVIDCF.mjs";
-export {
-  BLOCKED_RPC_METHODS,
-  assertEthereumOutboundRequest,
-  assertSnapOutboundRequest,
-  isValidResponse,
-  proxyStreamProvider,
-  sanitizeRequestArguments,
-  withTeardown
-};
+import { rpcErrors } from "@metamask/rpc-errors";
+import { assert, assertStruct, getJsonSize, getSafeJson, isObject, JsonStruct } from "@metamask/utils";
+import { log } from "../logging.mjs";
+// 64 MB - we chose this number because it is the size limit for postMessage
+// between the extension and the dapp enforced by Chrome.
+const MAX_RESPONSE_JSON_SIZE = 64000000;
+/**
+ * Make proxy for Promise and handle the teardown process properly.
+ * If the teardown is called in the meanwhile, Promise result will not be
+ * exposed to the snap anymore and warning will be logged to the console.
+ *
+ * @param originalPromise - Original promise.
+ * @param teardownRef - Reference containing teardown count.
+ * @param teardownRef.lastTeardown - Number of the last teardown.
+ * @returns New proxy promise.
+ */
+export async function withTeardown(originalPromise, teardownRef) {
+    const myTeardown = teardownRef.lastTeardown;
+    return new Promise((resolve, reject) => {
+        originalPromise
+            .then((value) => {
+            if (teardownRef.lastTeardown === myTeardown) {
+                resolve(value);
+            }
+            else {
+                log('Late promise received after Snap finished execution. Promise will be dropped.');
+            }
+        })
+            .catch((reason) => {
+            if (teardownRef.lastTeardown === myTeardown) {
+                reject(reason);
+            }
+            else {
+                log('Late promise received after Snap finished execution. Promise will be dropped.');
+            }
+        });
+    });
+}
+/**
+ * Returns a Proxy that only allows access to a `request` function.
+ * This is useful for replacing StreamProvider with an attenuated version.
+ *
+ * @param request - Custom attenuated request function.
+ * @returns Proxy that mimics a StreamProvider instance.
+ */
+export function proxyStreamProvider(request) {
+    // Proxy target is intentionally set to be an empty object, to ensure
+    // that access to the prototype chain is not possible.
+    const proxy = new Proxy({}, {
+        has(_target, prop) {
+            return typeof prop === 'string' && ['request'].includes(prop);
+        },
+        get(_target, prop) {
+            if (prop === 'request') {
+                return request;
+            }
+            return undefined;
+        },
+    });
+    return proxy;
+}
+// We're blocking these RPC methods for v1, will revisit later.
+export const BLOCKED_RPC_METHODS = Object.freeze([
+    'wallet_requestPermissions',
+    'wallet_revokePermissions',
+    // We disallow all of these confirmations for now, since the screens are not ready for Snaps.
+    'eth_sendTransaction',
+    'eth_sign',
+    'eth_signTypedData',
+    'eth_signTypedData_v1',
+    'eth_signTypedData_v3',
+    'eth_signTypedData_v4',
+    'eth_decrypt',
+    'eth_getEncryptionPublicKey',
+    'wallet_addEthereumChain',
+    'wallet_switchEthereumChain',
+    'wallet_watchAsset',
+    'wallet_registerOnboarding',
+    'wallet_scanQRCode',
+]);
+/**
+ * Asserts the validity of request arguments for a snap outbound request using the `snap.request` API.
+ *
+ * @param args - The arguments to validate.
+ */
+export function assertSnapOutboundRequest(args) {
+    // Disallow any non `wallet_` or `snap_` methods for separation of concerns.
+    assert(String.prototype.startsWith.call(args.method, 'wallet_') ||
+        String.prototype.startsWith.call(args.method, 'snap_'), 'The global Snap API only allows RPC methods starting with `wallet_*` and `snap_*`.', rpcErrors.methodNotSupported);
+    assert(!BLOCKED_RPC_METHODS.includes(args.method), rpcErrors.methodNotFound({
+        data: {
+            method: args.method,
+        },
+    }));
+    assertStruct(args, JsonStruct, 'Provided value is not JSON-RPC compatible', rpcErrors.invalidParams);
+}
+/**
+ * Asserts the validity of request arguments for an ethereum outbound request using the `ethereum.request` API.
+ *
+ * @param args - The arguments to validate.
+ */
+export function assertEthereumOutboundRequest(args) {
+    // Disallow snaps methods for separation of concerns.
+    assert(!String.prototype.startsWith.call(args.method, 'snap_'), rpcErrors.methodNotFound({
+        data: {
+            method: args.method,
+        },
+    }));
+    assert(!BLOCKED_RPC_METHODS.includes(args.method), rpcErrors.methodNotFound({
+        data: {
+            method: args.method,
+        },
+    }));
+    assertStruct(args, JsonStruct, 'Provided value is not JSON-RPC compatible', rpcErrors.invalidParams);
+}
+/**
+ * Gets a sanitized value to be used for passing to the underlying MetaMask provider.
+ *
+ * @param value - An unsanitized value from a snap.
+ * @returns A sanitized value ready to be passed to a MetaMask provider.
+ */
+export function sanitizeRequestArguments(value) {
+    // Before passing to getSafeJson we run the value through JSON serialization.
+    // This lets request arguments contain undefined which is normally disallowed.
+    const json = JSON.parse(JSON.stringify(value));
+    return getSafeJson(json);
+}
+/**
+ * Check if the input is a valid response.
+ *
+ * @param response - The response.
+ * @returns True if the response is valid, otherwise false.
+ */
+export function isValidResponse(response) {
+    if (!isObject(response)) {
+        return false;
+    }
+    try {
+        // If the JSON is invalid this will throw and we should return false.
+        const size = getJsonSize(response);
+        return size < MAX_RESPONSE_JSON_SIZE;
+    }
+    catch {
+        return false;
+    }
+}
 //# sourceMappingURL=utils.mjs.map

package/dist/common/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../src/common/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AACjD,OAAO,EACL,MAAM,EACN,YAAY,EACZ,WAAW,EACX,WAAW,EACX,QAAQ,EACR,UAAU,EACX,wBAAwB;AAEzB,OAAO,EAAE,GAAG,EAAE,uBAAmB;AAEjC,4EAA4E;AAC5E,yDAAyD;AACzD,MAAM,sBAAsB,GAAG,QAAU,CAAC;AAE1C;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,eAA8B,EAC9B,WAAqC;IAErC,MAAM,UAAU,GAAG,WAAW,CAAC,YAAY,CAAC;IAC5C,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,eAAe;aACZ,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;gBAC5C,OAAO,CAAC,KAAK,CAAC,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,GAAG,CACD,+EAA+E,CAChF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;YAChB,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,GAAG,CACD,+EAA+E,CAChF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAgB;IAClD,qEAAqE;IACrE,sDAAsD;IACtD,MAAM,KAAK,GAAG,IAAI,KAAK,CACrB,EAAE,EACF;QACE,GAAG,CAAC,OAAe,EAAE,IAAqB;YACxC,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChE,CAAC;QACD,GAAG,CAAC,OAAO,EAAE,IAA0B;YACrC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,OAAO,OAAO,CAAC;YACjB,CAAC;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;KACF,CACF,CAAC;IAEF,OAAO,KAAuB,CAAC;AACjC,CAAC;AAED,+DAA+D;AAC/D,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C,2BAA2B;IAC3B,0BAA0B;IAC1B,6FAA6F;IAC7F,qBAAqB;IACrB,UAAU;IACV,mBAAmB;IACnB,sBAAsB;IACtB,sBAAsB;IACtB,sBAAsB;IACtB,aAAa;IACb,4BAA4B;IAC5B,yBAAyB;IACzB,4BAA4B;IAC5B,mBAAmB;IACnB,2BAA2B;IAC3B,mBAAmB;CACpB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CAAC,IAAsB;IAC9D,4EAA4E;IAC5E,MAAM,CACJ,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC;QACtD,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,oFAAoF,EACpF,SAAS,CAAC,kBAAkB,CAC7B,CAAC;IACF,MAAM,CACJ,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAC1C,SAAS,CAAC,cAAc,CAAC;QACvB,IAAI,EAAE;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB;KACF,CAAC,CACH,CAAC;IACF,YAAY,CACV,IAAI,EACJ,UAAU,EACV,2CAA2C,EAC3C,SAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAAC,IAAsB;IAClE,qDAAqD;IACrD,MAAM,CACJ,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,EACvD,SAAS,CAAC,cAAc,CAAC;QACvB,IAAI,EAAE;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB;KACF,CAAC,CACH,CAAC;IACF,MAAM,CACJ,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAC1C,SAAS,CAAC,cAAc,CAAC;QACvB,IAAI,EAAE;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB;KACF,CAAC,CACH,CAAC;IACF,YAAY,CACV,IAAI,EACJ,UAAU,EACV,2CAA2C,EAC3C,SAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,6EAA6E;IAC7E,8EAA8E;IAC9E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/C,OAAO,WAAW,CAAC,IAAI,CAAqB,CAAC;AAC/C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,QAAiC;IAC/D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,qEAAqE;QACrE,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACnC,OAAO,IAAI,GAAG,sBAAsB,CAAC;IACvC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC","sourcesContent":["import type { StreamProvider, RequestArguments } from '@metamask/providers';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport {\n  assert,\n  assertStruct,\n  getJsonSize,\n  getSafeJson,\n  isObject,\n  JsonStruct,\n} from '@metamask/utils';\n\nimport { log } from '../logging';\n\n// 64 MB - we chose this number because it is the size limit for postMessage\n// between the extension and the dapp enforced by Chrome.\nconst MAX_RESPONSE_JSON_SIZE = 64_000_000;\n\n/**\n * Make proxy for Promise and handle the teardown process properly.\n * If the teardown is called in the meanwhile, Promise result will not be\n * exposed to the snap anymore and warning will be logged to the console.\n *\n * @param originalPromise - Original promise.\n * @param teardownRef - Reference containing teardown count.\n * @param teardownRef.lastTeardown - Number of the last teardown.\n * @returns New proxy promise.\n */\nexport async function withTeardown<Type>(\n  originalPromise: Promise<Type>,\n  teardownRef: { lastTeardown: number },\n): Promise<Type> {\n  const myTeardown = teardownRef.lastTeardown;\n  return new Promise<Type>((resolve, reject) => {\n    originalPromise\n      .then((value) => {\n        if (teardownRef.lastTeardown === myTeardown) {\n          resolve(value);\n        } else {\n          log(\n            'Late promise received after Snap finished execution. Promise will be dropped.',\n          );\n        }\n      })\n      .catch((reason) => {\n        if (teardownRef.lastTeardown === myTeardown) {\n          reject(reason);\n        } else {\n          log(\n            'Late promise received after Snap finished execution. Promise will be dropped.',\n          );\n        }\n      });\n  });\n}\n\n/**\n * Returns a Proxy that only allows access to a `request` function.\n * This is useful for replacing StreamProvider with an attenuated version.\n *\n * @param request - Custom attenuated request function.\n * @returns Proxy that mimics a StreamProvider instance.\n */\nexport function proxyStreamProvider(request: unknown): StreamProvider {\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 proxy = 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  );\n\n  return proxy as StreamProvider;\n}\n\n// We're blocking these RPC methods for v1, will revisit later.\nexport const BLOCKED_RPC_METHODS = Object.freeze([\n  'wallet_requestPermissions',\n  'wallet_revokePermissions',\n  // We disallow all of these confirmations for now, since the screens are not ready for Snaps.\n  'eth_sendTransaction',\n  'eth_sign',\n  'eth_signTypedData',\n  'eth_signTypedData_v1',\n  'eth_signTypedData_v3',\n  'eth_signTypedData_v4',\n  'eth_decrypt',\n  'eth_getEncryptionPublicKey',\n  'wallet_addEthereumChain',\n  'wallet_switchEthereumChain',\n  'wallet_watchAsset',\n  'wallet_registerOnboarding',\n  'wallet_scanQRCode',\n]);\n\n/**\n * Asserts the validity of request arguments for a snap outbound request using the `snap.request` API.\n *\n * @param args - The arguments to validate.\n */\nexport function assertSnapOutboundRequest(args: RequestArguments) {\n  // Disallow any non `wallet_` or `snap_` methods for separation of concerns.\n  assert(\n    String.prototype.startsWith.call(args.method, 'wallet_') ||\n      String.prototype.startsWith.call(args.method, 'snap_'),\n    'The global Snap API only allows RPC methods starting with `wallet_*` and `snap_*`.',\n    rpcErrors.methodNotSupported,\n  );\n  assert(\n    !BLOCKED_RPC_METHODS.includes(args.method),\n    rpcErrors.methodNotFound({\n      data: {\n        method: args.method,\n      },\n    }),\n  );\n  assertStruct(\n    args,\n    JsonStruct,\n    'Provided value is not JSON-RPC compatible',\n    rpcErrors.invalidParams,\n  );\n}\n\n/**\n * Asserts the validity of request arguments for an ethereum outbound request using the `ethereum.request` API.\n *\n * @param args - The arguments to validate.\n */\nexport function assertEthereumOutboundRequest(args: RequestArguments) {\n  // Disallow snaps methods for separation of concerns.\n  assert(\n    !String.prototype.startsWith.call(args.method, 'snap_'),\n    rpcErrors.methodNotFound({\n      data: {\n        method: args.method,\n      },\n    }),\n  );\n  assert(\n    !BLOCKED_RPC_METHODS.includes(args.method),\n    rpcErrors.methodNotFound({\n      data: {\n        method: args.method,\n      },\n    }),\n  );\n  assertStruct(\n    args,\n    JsonStruct,\n    'Provided value is not JSON-RPC compatible',\n    rpcErrors.invalidParams,\n  );\n}\n\n/**\n * Gets a sanitized value to be used for passing to the underlying MetaMask provider.\n *\n * @param value - An unsanitized value from a snap.\n * @returns A sanitized value ready to be passed to a MetaMask provider.\n */\nexport function sanitizeRequestArguments(value: unknown): RequestArguments {\n  // Before passing to getSafeJson we run the value through JSON serialization.\n  // This lets request arguments contain undefined which is normally disallowed.\n  const json = JSON.parse(JSON.stringify(value));\n  return getSafeJson(json) as RequestArguments;\n}\n\n/**\n * Check if the input is a valid response.\n *\n * @param response - The response.\n * @returns True if the response is valid, otherwise false.\n */\nexport function isValidResponse(response: Record<string, unknown>) {\n  if (!isObject(response)) {\n    return false;\n  }\n\n  try {\n    // If the JSON is invalid this will throw and we should return false.\n    const size = getJsonSize(response);\n    return size < MAX_RESPONSE_JSON_SIZE;\n  } catch {\n    return false;\n  }\n}\n"]}

package/dist/common/validation.cjs

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertIsOnUserInputRequestArguments = exports.OnUserInputArgumentsStruct = exports.assertIsOnNameLookupRequestArguments = exports.OnNameLookupRequestArgumentsStruct = exports.assertIsOnSignatureRequestArguments = exports.OnSignatureRequestArgumentsStruct = exports.assertIsOnTransactionRequestArguments = exports.OnTransactionRequestArgumentsStruct = exports.SnapRpcRequestArgumentsStruct = exports.ExecuteSnapRequestArgumentsStruct = exports.TerminateRequestArgumentsStruct = exports.PingRequestArgumentsStruct = exports.isEndowmentsArray = exports.isEndowment = exports.EndowmentStruct = exports.JsonRpcRequestWithoutIdStruct = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+exports.JsonRpcRequestWithoutIdStruct = (0, superstruct_1.object)({
+    jsonrpc: (0, superstruct_1.optional)(utils_1.JsonRpcVersionStruct),
+    id: (0, superstruct_1.optional)(utils_1.JsonRpcIdStruct),
+    method: (0, superstruct_1.string)(),
+    params: (0, superstruct_1.optional)(utils_1.JsonRpcParamsStruct),
+});
+exports.EndowmentStruct = (0, superstruct_1.string)();
+/**
+ * Check if the given value is an endowment.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is an endowment.
+ */
+function isEndowment(value) {
+    return (0, superstruct_1.is)(value, exports.EndowmentStruct);
+}
+exports.isEndowment = isEndowment;
+/**
+ * Check if the given value is an array of endowments.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is an array of endowments.
+ */
+function isEndowmentsArray(value) {
+    return Array.isArray(value) && value.every(isEndowment);
+}
+exports.isEndowmentsArray = isEndowmentsArray;
+const OkStruct = (0, superstruct_1.literal)('OK');
+exports.PingRequestArgumentsStruct = (0, superstruct_1.optional)((0, superstruct_1.union)([(0, superstruct_1.literal)(undefined), (0, superstruct_1.array)()]));
+exports.TerminateRequestArgumentsStruct = (0, superstruct_1.union)([
+    (0, superstruct_1.literal)(undefined),
+    (0, superstruct_1.array)(),
+]);
+exports.ExecuteSnapRequestArgumentsStruct = (0, superstruct_1.tuple)([
+    (0, superstruct_1.string)(),
+    (0, superstruct_1.string)(),
+    (0, superstruct_1.array)(exports.EndowmentStruct),
+]);
+exports.SnapRpcRequestArgumentsStruct = (0, superstruct_1.tuple)([
+    (0, superstruct_1.string)(),
+    (0, superstruct_1.enums)(Object.values(snaps_utils_1.HandlerType)),
+    (0, superstruct_1.string)(),
+    (0, superstruct_1.assign)(exports.JsonRpcRequestWithoutIdStruct, (0, superstruct_1.object)({
+        params: (0, superstruct_1.optional)((0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct)),
+    })),
+]);
+exports.OnTransactionRequestArgumentsStruct = (0, superstruct_1.object)({
+    // TODO: Improve `transaction` type.
+    transaction: (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct),
+    chainId: snaps_utils_1.ChainIdStruct,
+    transactionOrigin: (0, superstruct_1.nullable)((0, superstruct_1.string)()),
+});
+/**
+ * Asserts that the given value is a valid {@link OnTransactionRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnTransactionRequestArguments}
+ * object.
+ */
+function assertIsOnTransactionRequestArguments(value) {
+    (0, utils_1.assertStruct)(value, exports.OnTransactionRequestArgumentsStruct, 'Invalid request params', rpc_errors_1.rpcErrors.invalidParams);
+}
+exports.assertIsOnTransactionRequestArguments = assertIsOnTransactionRequestArguments;
+exports.OnSignatureRequestArgumentsStruct = (0, superstruct_1.object)({
+    signature: (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct),
+    signatureOrigin: (0, superstruct_1.nullable)((0, superstruct_1.string)()),
+});
+/**
+ * Asserts that the given value is a valid {@link OnSignatureRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnSignatureRequestArguments}
+ * object.
+ */
+function assertIsOnSignatureRequestArguments(value) {
+    (0, utils_1.assertStruct)(value, exports.OnSignatureRequestArgumentsStruct, 'Invalid request params', rpc_errors_1.rpcErrors.invalidParams);
+}
+exports.assertIsOnSignatureRequestArguments = assertIsOnSignatureRequestArguments;
+const baseNameLookupArgs = { chainId: snaps_utils_1.ChainIdStruct };
+const domainRequestStruct = (0, superstruct_1.object)({
+    ...baseNameLookupArgs,
+    address: (0, superstruct_1.string)(),
+});
+const addressRequestStruct = (0, superstruct_1.object)({
+    ...baseNameLookupArgs,
+    domain: (0, superstruct_1.string)(),
+});
+exports.OnNameLookupRequestArgumentsStruct = (0, superstruct_1.union)([
+    domainRequestStruct,
+    addressRequestStruct,
+]);
+/**
+ * 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.
+ */
+function assertIsOnNameLookupRequestArguments(value) {
+    (0, utils_1.assertStruct)(value, exports.OnNameLookupRequestArgumentsStruct, 'Invalid request params', rpc_errors_1.rpcErrors.invalidParams);
+}
+exports.assertIsOnNameLookupRequestArguments = assertIsOnNameLookupRequestArguments;
+exports.OnUserInputArgumentsStruct = (0, superstruct_1.object)({
+    id: (0, superstruct_1.string)(),
+    event: snaps_sdk_1.UserInputEventStruct,
+    context: (0, superstruct_1.optional)((0, superstruct_1.nullable)(snaps_sdk_1.InterfaceContextStruct)),
+});
+/**
+ * Asserts that the given value is a valid {@link OnUserInputArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnUserInputArguments}
+ * object.
+ */
+function assertIsOnUserInputRequestArguments(value) {
+    (0, utils_1.assertStruct)(value, exports.OnUserInputArgumentsStruct, 'Invalid request params', rpc_errors_1.rpcErrors.invalidParams);
+}
+exports.assertIsOnUserInputRequestArguments = assertIsOnUserInputRequestArguments;
+const OkResponseStruct = (0, superstruct_1.object)({
+    id: utils_1.JsonRpcIdStruct,
+    jsonrpc: utils_1.JsonRpcVersionStruct,
+    result: OkStruct,
+});
+const SnapRpcResponse = utils_1.JsonRpcSuccessStruct;
+//# sourceMappingURL=validation.cjs.map

package/dist/common/validation.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.cjs","sourceRoot":"","sources":["../../src/common/validation.ts"],"names":[],"mappings":";;;AAAA,qDAAiD;AACjD,mDAG6B;AAC7B,uDAAmE;AAEnE,uDAa+B;AAE/B,2CAOyB;AAEZ,QAAA,6BAA6B,GAAG,IAAA,oBAAM,EAAC;IAClD,OAAO,EAAE,IAAA,sBAAQ,EAAC,4BAAoB,CAAC;IACvC,EAAE,EAAE,IAAA,sBAAQ,EAAC,uBAAe,CAAC;IAC7B,MAAM,EAAE,IAAA,oBAAM,GAAE;IAChB,MAAM,EAAE,IAAA,sBAAQ,EAAC,2BAAmB,CAAC;CACtC,CAAC,CAAC;AAMU,QAAA,eAAe,GAAG,IAAA,oBAAM,GAAE,CAAC;AAGxC;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,uBAAe,CAAC,CAAC;AACpC,CAAC;AAFD,kCAEC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,KAAc;IAC9C,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AAC1D,CAAC;AAFD,8CAEC;AAED,MAAM,QAAQ,GAAG,IAAA,qBAAO,EAAC,IAAI,CAAC,CAAC;AAElB,QAAA,0BAA0B,GAAG,IAAA,sBAAQ,EAChD,IAAA,mBAAK,EAAC,CAAC,IAAA,qBAAO,EAAC,SAAS,CAAC,EAAE,IAAA,mBAAK,GAAE,CAAC,CAAC,CACrC,CAAC;AAEW,QAAA,+BAA+B,GAAG,IAAA,mBAAK,EAAC;IACnD,IAAA,qBAAO,EAAC,SAAS,CAAC;IAClB,IAAA,mBAAK,GAAE;CACR,CAAC,CAAC;AAEU,QAAA,iCAAiC,GAAG,IAAA,mBAAK,EAAC;IACrD,IAAA,oBAAM,GAAE;IACR,IAAA,oBAAM,GAAE;IACR,IAAA,mBAAK,EAAC,uBAAe,CAAC;CACvB,CAAC,CAAC;AAEU,QAAA,6BAA6B,GAAG,IAAA,mBAAK,EAAC;IACjD,IAAA,oBAAM,GAAE;IACR,IAAA,mBAAK,EAAC,MAAM,CAAC,MAAM,CAAC,yBAAW,CAAC,CAAC;IACjC,IAAA,oBAAM,GAAE;IACR,IAAA,oBAAM,EACJ,qCAA6B,EAC7B,IAAA,oBAAM,EAAC;QACL,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC;KAC/C,CAAC,CACH;CACF,CAAC,CAAC;AAqBU,QAAA,mCAAmC,GAAG,IAAA,oBAAM,EAAC;IACxD,oCAAoC;IACpC,WAAW,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC;IACzC,OAAO,EAAE,2BAAa;IACtB,iBAAiB,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CACtC,CAAC,CAAC;AAMH;;;;;;;GAOG;AACH,SAAgB,qCAAqC,CACnD,KAAc;IAEd,IAAA,oBAAY,EACV,KAAK,EACL,2CAAmC,EACnC,wBAAwB,EACxB,sBAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AATD,sFASC;AAEY,QAAA,iCAAiC,GAAG,IAAA,oBAAM,EAAC;IACtD,SAAS,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC;IACvC,eAAe,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CACpC,CAAC,CAAC;AAMH;;;;;;;GAOG;AACH,SAAgB,mCAAmC,CACjD,KAAc;IAEd,IAAA,oBAAY,EACV,KAAK,EACL,yCAAiC,EACjC,wBAAwB,EACxB,sBAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AATD,kFASC;AAED,MAAM,kBAAkB,GAAG,EAAE,OAAO,EAAE,2BAAa,EAAE,CAAC;AACtD,MAAM,mBAAmB,GAAG,IAAA,oBAAM,EAAC;IACjC,GAAG,kBAAkB;IACrB,OAAO,EAAE,IAAA,oBAAM,GAAE;CAClB,CAAC,CAAC;AACH,MAAM,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IAClC,GAAG,kBAAkB;IACrB,MAAM,EAAE,IAAA,oBAAM,GAAE;CACjB,CAAC,CAAC;AAEU,QAAA,kCAAkC,GAAG,IAAA,mBAAK,EAAC;IACtD,mBAAmB;IACnB,oBAAoB;CACrB,CAAC,CAAC;AAWH;;;;;;;GAOG;AACH,SAAgB,oCAAoC,CAClD,KAAc;IAEd,IAAA,oBAAY,EACV,KAAK,EACL,0CAAkC,EAClC,wBAAwB,EACxB,sBAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AATD,oFASC;AAEY,QAAA,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IAC/C,EAAE,EAAE,IAAA,oBAAM,GAAE;IACZ,KAAK,EAAE,gCAAoB;IAC3B,OAAO,EAAE,IAAA,sBAAQ,EAAC,IAAA,sBAAQ,EAAC,kCAAsB,CAAC,CAAC;CACpD,CAAC,CAAC;AAIH;;;;;;;GAOG;AACH,SAAgB,mCAAmC,CACjD,KAAc;IAEd,IAAA,oBAAY,EACV,KAAK,EACL,kCAA0B,EAC1B,wBAAwB,EACxB,sBAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AATD,kFASC;AAED,MAAM,gBAAgB,GAAG,IAAA,oBAAM,EAAC;IAC9B,EAAE,EAAE,uBAAe;IACnB,OAAO,EAAE,4BAAoB;IAC7B,MAAM,EAAE,QAAQ;CACjB,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,4BAAoB,CAAC","sourcesContent":["import { rpcErrors } from '@metamask/rpc-errors';\nimport {\n  InterfaceContextStruct,\n  UserInputEventStruct,\n} from '@metamask/snaps-sdk';\nimport { ChainIdStruct, HandlerType } from '@metamask/snaps-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport {\n  array,\n  assign,\n  enums,\n  is,\n  literal,\n  nullable,\n  object,\n  optional,\n  record,\n  string,\n  tuple,\n  union,\n} from '@metamask/superstruct';\nimport type { Json, JsonRpcSuccess } from '@metamask/utils';\nimport {\n  assertStruct,\n  JsonRpcIdStruct,\n  JsonRpcParamsStruct,\n  JsonRpcSuccessStruct,\n  JsonRpcVersionStruct,\n  JsonStruct,\n} from '@metamask/utils';\n\nexport const JsonRpcRequestWithoutIdStruct = object({\n  jsonrpc: optional(JsonRpcVersionStruct),\n  id: optional(JsonRpcIdStruct),\n  method: string(),\n  params: optional(JsonRpcParamsStruct),\n});\n\nexport type JsonRpcRequestWithoutId = Infer<\n  typeof JsonRpcRequestWithoutIdStruct\n>;\n\nexport const EndowmentStruct = string();\nexport type Endowment = Infer<typeof EndowmentStruct>;\n\n/**\n * Check if the given value is an endowment.\n *\n * @param value - The value to check.\n * @returns Whether the value is an endowment.\n */\nexport function isEndowment(value: unknown): value is Endowment {\n  return is(value, EndowmentStruct);\n}\n\n/**\n * Check if the given value is an array of endowments.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of endowments.\n */\nexport function isEndowmentsArray(value: unknown): value is Endowment[] {\n  return Array.isArray(value) && value.every(isEndowment);\n}\n\nconst OkStruct = literal('OK');\n\nexport const PingRequestArgumentsStruct = optional(\n  union([literal(undefined), array()]),\n);\n\nexport const TerminateRequestArgumentsStruct = union([\n  literal(undefined),\n  array(),\n]);\n\nexport const ExecuteSnapRequestArgumentsStruct = tuple([\n  string(),\n  string(),\n  array(EndowmentStruct),\n]);\n\nexport const SnapRpcRequestArgumentsStruct = tuple([\n  string(),\n  enums(Object.values(HandlerType)),\n  string(),\n  assign(\n    JsonRpcRequestWithoutIdStruct,\n    object({\n      params: optional(record(string(), JsonStruct)),\n    }),\n  ),\n]);\n\nexport type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;\nexport type TerminateRequestArguments = Infer<\n  typeof TerminateRequestArgumentsStruct\n>;\n\nexport type ExecuteSnapRequestArguments = Infer<\n  typeof ExecuteSnapRequestArgumentsStruct\n>;\n\nexport type SnapRpcRequestArguments = Infer<\n  typeof SnapRpcRequestArgumentsStruct\n>;\n\nexport type RequestArguments =\n  | PingRequestArguments\n  | TerminateRequestArguments\n  | ExecuteSnapRequestArguments\n  | SnapRpcRequestArguments;\n\nexport const OnTransactionRequestArgumentsStruct = object({\n  // TODO: Improve `transaction` type.\n  transaction: record(string(), JsonStruct),\n  chainId: ChainIdStruct,\n  transactionOrigin: nullable(string()),\n});\n\nexport type OnTransactionRequestArguments = Infer<\n  typeof OnTransactionRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnTransactionRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnTransactionRequestArguments}\n * object.\n */\nexport function assertIsOnTransactionRequestArguments(\n  value: unknown,\n): asserts value is OnTransactionRequestArguments {\n  assertStruct(\n    value,\n    OnTransactionRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nexport const OnSignatureRequestArgumentsStruct = object({\n  signature: record(string(), JsonStruct),\n  signatureOrigin: nullable(string()),\n});\n\nexport type OnSignatureRequestArguments = Infer<\n  typeof OnSignatureRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnSignatureRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnSignatureRequestArguments}\n * object.\n */\nexport function assertIsOnSignatureRequestArguments(\n  value: unknown,\n): asserts value is OnSignatureRequestArguments {\n  assertStruct(\n    value,\n    OnSignatureRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst baseNameLookupArgs = { chainId: ChainIdStruct };\nconst domainRequestStruct = object({\n  ...baseNameLookupArgs,\n  address: string(),\n});\nconst addressRequestStruct = object({\n  ...baseNameLookupArgs,\n  domain: string(),\n});\n\nexport const OnNameLookupRequestArgumentsStruct = union([\n  domainRequestStruct,\n  addressRequestStruct,\n]);\n\nexport type OnNameLookupRequestArguments = Infer<\n  typeof OnNameLookupRequestArgumentsStruct\n>;\n\nexport type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {\n  address?: string;\n  domain?: string;\n};\n\n/**\n * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnNameLookupRequestArguments}\n * object.\n */\nexport function assertIsOnNameLookupRequestArguments(\n  value: unknown,\n): asserts value is OnNameLookupRequestArguments {\n  assertStruct(\n    value,\n    OnNameLookupRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nexport const OnUserInputArgumentsStruct = object({\n  id: string(),\n  event: UserInputEventStruct,\n  context: optional(nullable(InterfaceContextStruct)),\n});\n\nexport type OnUserInputArguments = Infer<typeof OnUserInputArgumentsStruct>;\n\n/**\n * Asserts that the given value is a valid {@link OnUserInputArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnUserInputArguments}\n * object.\n */\nexport function assertIsOnUserInputRequestArguments(\n  value: unknown,\n): asserts value is OnUserInputArguments {\n  assertStruct(\n    value,\n    OnUserInputArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst OkResponseStruct = object({\n  id: JsonRpcIdStruct,\n  jsonrpc: JsonRpcVersionStruct,\n  result: OkStruct,\n});\n\nconst SnapRpcResponse = JsonRpcSuccessStruct;\n\nexport type OkResponse = Infer<typeof OkResponseStruct>;\nexport type SnapRpcResponse = Infer<typeof SnapRpcResponse>;\n\nexport type Response = OkResponse | SnapRpcResponse;\n\ntype RequestParams<Params extends unknown[] | undefined> =\n  Params extends undefined ? [] : Params;\n\ntype RequestFunction<\n  Args extends RequestArguments,\n  ResponseType extends JsonRpcSuccess<Json>,\n> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;\n\nexport type Ping = RequestFunction<PingRequestArguments, OkResponse>;\nexport type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;\nexport type ExecuteSnap = RequestFunction<\n  ExecuteSnapRequestArguments,\n  OkResponse\n>;\nexport type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;\n"]}