@metamask/snaps-utils 0.35.1-flask.1 → 1.0.0-prerelease.1

package/dist/{esm/fs.js → fs.js}

@@ -1,8 +1,14 @@
-import { promises as fs } from 'fs';
-import os from 'os';
-import pathUtils from 'path';
-import { parseJson } from './json';
-import { readVirtualFile } from './virtual-file';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTemporaryFile = exports.validateDirPath = exports.validateFilePath = exports.validateOutfileName = exports.getOutfilePath = exports.readJsonFile = exports.isFile = exports.isDirectory = void 0;
+const fs_1 = require("fs");
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const json_1 = require("./json");
+const virtual_file_1 = require("./virtual-file");
 /**
  * Checks whether the given path string resolves to an existing directory, and
  * optionally creates the directory if it doesn't exist.
@@ -10,57 +16,64 @@ import { readVirtualFile } from './virtual-file';
  * @param pathString - The path string to check.
  * @param createDir - Whether to create the directory if it doesn't exist.
  * @returns Whether the given path is an existing directory.
- */ export async function isDirectory(pathString, createDir) {
+ */
+async function isDirectory(pathString, createDir) {
     try {
-        const stats = await fs.stat(pathString);
+        const stats = await fs_1.promises.stat(pathString);
         return stats.isDirectory();
-    } catch (error) {
+    }
+    catch (error) {
         if (error.code === 'ENOENT') {
             if (!createDir) {
                 return false;
             }
-            await fs.mkdir(pathString, {
-                recursive: true
-            });
+            await fs_1.promises.mkdir(pathString, { recursive: true });
             return true;
         }
         return false;
     }
 }
+exports.isDirectory = isDirectory;
 /**
  * Checks whether the given path string resolves to an existing file.
  *
  * @param pathString - The path string to check.
  * @returns Whether the given path is an existing file.
- */ export async function isFile(pathString) {
+ */
+async function isFile(pathString) {
     try {
-        const stats = await fs.stat(pathString);
+        const stats = await fs_1.promises.stat(pathString);
         return stats.isFile();
-    } catch (error) {
+    }
+    catch (error) {
         return false;
     }
 }
+exports.isFile = isFile;
 /**
  * Reads a `.json` file, parses its contents, and returns them.
  *
  * @param pathString - The path to the JSON file.
  * @returns The parsed contents of the JSON file.
- */ export async function readJsonFile(pathString) {
+ */
+async function readJsonFile(pathString) {
     if (!pathString.endsWith('.json')) {
         throw new Error('The specified file must be a ".json" file.');
     }
     let file;
     try {
-        file = await readVirtualFile(pathString, 'utf8');
-    } catch (error) {
+        file = await (0, virtual_file_1.readVirtualFile)(pathString, 'utf8');
+    }
+    catch (error) {
         if (error.code === 'ENOENT') {
             throw new Error(`Could not find '${pathString}'. Please ensure that the file exists.`);
         }
         throw error;
     }
-    file.result = parseJson(file.toString());
+    file.result = (0, json_1.parseJson)(file.toString());
     return file;
 }
+exports.readJsonFile = readJsonFile;
 /**
  * Gets the complete out file path from an output file name and parent
  * directory path.
@@ -68,9 +81,11 @@ import { readVirtualFile } from './virtual-file';
  * @param outDir - The path to the out file's parent directory.
  * @param outFileName - The out file's name.
  * @returns The complete path to the out file.
- */ export function getOutfilePath(outDir, outFileName) {
-    return pathUtils.join(outDir, outFileName || 'bundle.js');
+ */
+function getOutfilePath(outDir, outFileName) {
+    return path_1.default.join(outDir, outFileName || 'bundle.js');
 }
+exports.getOutfilePath = getOutfilePath;
 /**
  * Ensures that the outfile name is just a `.js` file name.
  * Throws on validation failure.
@@ -78,25 +93,31 @@ import { readVirtualFile } from './virtual-file';
  * @param filename - The file name to validate.
  * @returns `true` if validation succeeded.
  * @throws If the file name is invalid.
- */ export function validateOutfileName(filename) {
-    if (!filename.endsWith('.js') || filename === '.js' || pathUtils.basename(filename) !== filename) {
+ */
+function validateOutfileName(filename) {
+    if (!filename.endsWith('.js') ||
+        filename === '.js' ||
+        path_1.default.basename(filename) !== filename) {
         throw new Error(`Invalid outfile name: ${filename}. Must be a .js file`);
     }
     return true;
 }
+exports.validateOutfileName = validateOutfileName;
 /**
  * Validates a file path. Throws on validation failure.
  *
  * @param filePath - The file path to validate.
  * @returns `true` if validation succeeded.
  * @throws If the path does not resolve to a file.
- */ export async function validateFilePath(filePath) {
+ */
+async function validateFilePath(filePath) {
     const exists = await isFile(filePath);
     if (!exists) {
         throw new Error(`Invalid params: '${filePath}' is not a file or does not exist.`);
     }
     return true;
 }
+exports.validateFilePath = validateFilePath;
 /**
  * Validates a directory path. Throws on validation failure.
  *
@@ -104,13 +125,15 @@ import { readVirtualFile } from './virtual-file';
  * @param createDir - Whether to create the directory if it doesn't exist.
  * @returns `true` if validation succeeded or the directory was created.
  * @throws If the directory does not exist or could not be created.
- */ export async function validateDirPath(dirPath, createDir) {
+ */
+async function validateDirPath(dirPath, createDir) {
     const exists = await isDirectory(dirPath, createDir);
     if (!exists) {
         throw new Error(`Invalid params: '${dirPath}' is not a directory or could not be created.`);
     }
     return true;
 }
+exports.validateDirPath = validateDirPath;
 /**
  * Creates a temporary file with a given name and content, writes it to disk and calls the provided function.
  * This function handles deletion of the temporary file after usage.
@@ -118,19 +141,19 @@ import { readVirtualFile } from './virtual-file';
  * @param fileName - The name of the temporary file.
  * @param fileContents - The content of the temporary file.
  * @param fn - The callback function to call when the temporary file has been created.
- */ export async function useTemporaryFile(fileName, fileContents, fn) {
-    const filePath = pathUtils.join(os.tmpdir(), fileName);
-    await fs.mkdir(pathUtils.dirname(filePath), {
-        recursive: true
-    });
-    await fs.writeFile(filePath, fileContents);
+ */
+async function useTemporaryFile(fileName, fileContents, fn) {
+    const filePath = path_1.default.join(os_1.default.tmpdir(), fileName);
+    await fs_1.promises.mkdir(path_1.default.dirname(filePath), { recursive: true });
+    await fs_1.promises.writeFile(filePath, fileContents);
     try {
         await fn(filePath);
-    } finally{
+    }
+    finally {
         if (await isFile(filePath)) {
-            await fs.unlink(filePath);
+            await fs_1.promises.unlink(filePath);
         }
     }
 }
-
+exports.useTemporaryFile = useTemporaryFile;
 //# sourceMappingURL=fs.js.map

package/dist/fs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":";;;;;;AACA,2BAAoC;AACpC,4CAAoB;AACpB,gDAA6B;AAE7B,iCAAmC;AACnC,iDAA8D;AAE9D;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,UAAkB,EAClB,SAAkB;IAElB,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;KAC5B;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO,KAAK,CAAC;aACd;YAED,MAAM,aAAE,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAnBD,kCAmBC;AAED;;;;;GAKG;AACI,KAAK,UAAU,MAAM,CAAC,UAAkB;IAC7C,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;KACvB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,wBAOC;AAED;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAChC,UAAkB;IAElB,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;KAC/D;IAED,IAAI,IAAI,CAAC;IACT,IAAI;QACF,IAAI,GAAG,MAAM,IAAA,8BAAe,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;KAClD;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,MAAM,IAAI,KAAK,CACb,mBAAmB,UAAU,wCAAwC,CACtE,CAAC;SACH;QAED,MAAM,KAAK,CAAC;KACb;IACD,IAAI,CAAC,MAAM,GAAG,IAAA,gBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzC,OAAO,IAAyB,CAAC;AACnC,CAAC;AArBD,oCAqBC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,MAAc,EAAE,WAAmB;IAChE,OAAO,cAAS,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,WAAW,CAAC,CAAC;AAC5D,CAAC;AAFD,wCAEC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,QAAgB;IAClD,IACE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;QACzB,QAAQ,KAAK,KAAK;QAClB,cAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,QAAQ,EACzC;QACA,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,sBAAsB,CAAC,CAAC;KAC1E;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AATD,kDASC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IACrD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,oCAAoC,CACjE,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AARD,4CAQC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CACnC,OAAe,EACf,SAAkB;IAElB,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CACb,oBAAoB,OAAO,+CAA+C,CAC3E,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,0CAWC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,gBAAgB,CACpC,QAAgB,EAChB,YAAoB,EACpB,EAAsC;IAEtC,MAAM,QAAQ,GAAG,cAAS,CAAC,IAAI,CAAC,YAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,CAAC,CAAC;IACvD,MAAM,aAAE,CAAC,KAAK,CAAC,cAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,MAAM,aAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAC3C,IAAI;QACF,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC;KACpB;YAAS;QACR,IAAI,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE;YAC1B,MAAM,aAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;SAC3B;KACF;AACH,CAAC;AAfD,4CAeC","sourcesContent":["import { Json } from '@metamask/utils';\nimport { promises as fs } from 'fs';\nimport os from 'os';\nimport pathUtils from 'path';\n\nimport { parseJson } from './json';\nimport { readVirtualFile, VirtualFile } from './virtual-file';\n\n/**\n * Checks whether the given path string resolves to an existing directory, and\n * optionally creates the directory if it doesn't exist.\n *\n * @param pathString - The path string to check.\n * @param createDir - Whether to create the directory if it doesn't exist.\n * @returns Whether the given path is an existing directory.\n */\nexport async function isDirectory(\n  pathString: string,\n  createDir: boolean,\n): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isDirectory();\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      if (!createDir) {\n        return false;\n      }\n\n      await fs.mkdir(pathString, { recursive: true });\n      return true;\n    }\n\n    return false;\n  }\n}\n\n/**\n * Checks whether the given path string resolves to an existing file.\n *\n * @param pathString - The path string to check.\n * @returns Whether the given path is an existing file.\n */\nexport async function isFile(pathString: string): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isFile();\n  } catch (error) {\n    return false;\n  }\n}\n\n/**\n * Reads a `.json` file, parses its contents, and returns them.\n *\n * @param pathString - The path to the JSON file.\n * @returns The parsed contents of the JSON file.\n */\nexport async function readJsonFile<Type extends Json = Json>(\n  pathString: string,\n): Promise<VirtualFile<Type>> {\n  if (!pathString.endsWith('.json')) {\n    throw new Error('The specified file must be a \".json\" file.');\n  }\n\n  let file;\n  try {\n    file = await readVirtualFile(pathString, 'utf8');\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      throw new Error(\n        `Could not find '${pathString}'. Please ensure that the file exists.`,\n      );\n    }\n\n    throw error;\n  }\n  file.result = parseJson(file.toString());\n  return file as VirtualFile<Type>;\n}\n\n/**\n * Gets the complete out file path from an output file name and parent\n * directory path.\n *\n * @param outDir - The path to the out file's parent directory.\n * @param outFileName - The out file's name.\n * @returns The complete path to the out file.\n */\nexport function getOutfilePath(outDir: string, outFileName: string): string {\n  return pathUtils.join(outDir, outFileName || 'bundle.js');\n}\n\n/**\n * Ensures that the outfile name is just a `.js` file name.\n * Throws on validation failure.\n *\n * @param filename - The file name to validate.\n * @returns `true` if validation succeeded.\n * @throws If the file name is invalid.\n */\nexport function validateOutfileName(filename: string): boolean {\n  if (\n    !filename.endsWith('.js') ||\n    filename === '.js' ||\n    pathUtils.basename(filename) !== filename\n  ) {\n    throw new Error(`Invalid outfile name: ${filename}. Must be a .js file`);\n  }\n  return true;\n}\n\n/**\n * Validates a file path. Throws on validation failure.\n *\n * @param filePath - The file path to validate.\n * @returns `true` if validation succeeded.\n * @throws If the path does not resolve to a file.\n */\nexport async function validateFilePath(filePath: string): Promise<boolean> {\n  const exists = await isFile(filePath);\n  if (!exists) {\n    throw new Error(\n      `Invalid params: '${filePath}' is not a file or does not exist.`,\n    );\n  }\n  return true;\n}\n\n/**\n * Validates a directory path. Throws on validation failure.\n *\n * @param dirPath - The directory path to validate.\n * @param createDir - Whether to create the directory if it doesn't exist.\n * @returns `true` if validation succeeded or the directory was created.\n * @throws If the directory does not exist or could not be created.\n */\nexport async function validateDirPath(\n  dirPath: string,\n  createDir: boolean,\n): Promise<boolean> {\n  const exists = await isDirectory(dirPath, createDir);\n  if (!exists) {\n    throw new Error(\n      `Invalid params: '${dirPath}' is not a directory or could not be created.`,\n    );\n  }\n  return true;\n}\n\n/**\n * Creates a temporary file with a given name and content, writes it to disk and calls the provided function.\n * This function handles deletion of the temporary file after usage.\n *\n * @param fileName - The name of the temporary file.\n * @param fileContents - The content of the temporary file.\n * @param fn - The callback function to call when the temporary file has been created.\n */\nexport async function useTemporaryFile(\n  fileName: string,\n  fileContents: string,\n  fn: (path: string) => Promise<unknown>,\n): Promise<void> {\n  const filePath = pathUtils.join(os.tmpdir(), fileName);\n  await fs.mkdir(pathUtils.dirname(filePath), { recursive: true });\n  await fs.writeFile(filePath, fileContents);\n  try {\n    await fn(filePath);\n  } finally {\n    if (await isFile(filePath)) {\n      await fs.unlink(filePath);\n    }\n  }\n}\n"]}

package/dist/{types/handlers.d.ts → handlers.d.ts}

@@ -1,5 +1,6 @@
 import { Component } from '@metamask/snaps-ui';
 import { Json, JsonRpcRequest } from '@metamask/utils';
+import { AccountId, ChainId, RequestArguments } from './namespace';
 /**
  * The `onRpcRequest` handler. This is called whenever a JSON-RPC request is
  * made to the snap.
@@ -10,9 +11,9 @@ import { Json, JsonRpcRequest } from '@metamask/utils';
  * @param args.request - The JSON-RPC request sent to the snap.
  * @returns The JSON-RPC response. This must be a JSON-serializable value.
  */
-export declare type OnRpcRequestHandler<Params extends Json[] | Record<string, Json> | undefined = Json[] | Record<string, Json> | undefined> = (args: {
+export declare type OnRpcRequestHandler = (args: {
     origin: string;
-    request: JsonRpcRequest<Params>;
+    request: JsonRpcRequest<Json[] | Record<string, Json>>;
 }) => Promise<unknown>;
 /**
  * The response from a snap's `onTransaction` handler.
@@ -51,9 +52,43 @@ export declare type OnTransactionHandler = (args: {
  * @param args - The request arguments.
  * @param args.request - The JSON-RPC request sent to the snap.
  */
-export declare type OnCronjobHandler<Params extends Json[] | Record<string, Json> | undefined = Json[] | Record<string, Json> | undefined> = (args: {
-    request: JsonRpcRequest<Params>;
+export declare type OnCronjobHandler = (args: {
+    request: JsonRpcRequest<Json[] | Record<string, Json>>;
 }) => Promise<unknown>;
+/**
+ * A request sent to the `handleRequest` handler of a snap keyring.
+ *
+ * @property chainId - The CAIP-2 chain ID of the network the request is being
+ * made to.
+ * @property origin - The origin of the request. This can be the ID of another
+ * snap, or the URL of a dapp.
+ */
+export declare type KeyringRequest = {
+    chainId: ChainId;
+    origin: string;
+};
+/**
+ * A keyring event, which consists of a {@link KeyringRequest}, combined with
+ * the name of the event.
+ */
+export declare type KeyringEvent = KeyringRequest & {
+    eventName: string;
+};
+/**
+ * A snap keyring object, which can be exported as `keyring` in a snap.
+ */
+export interface SnapKeyring {
+    getAccounts(): Promise<AccountId[]>;
+    handleRequest(data: KeyringRequest & {
+        request: RequestArguments;
+    }): Promise<Json>;
+    on(data: KeyringEvent, listener: (...args: Json[]) => void): void;
+    off(data: KeyringEvent): void;
+    addAccount?(chainId: ChainId): Promise<AccountId>;
+    removeAccount?(accountId: AccountId): Promise<void>;
+    importAccount?(chainId: ChainId, data: Json): Promise<AccountId>;
+    exportAccount?(accountId: AccountId): Promise<Json>;
+}
 /**
  * All the function-based handlers that a snap can implement.
  */
@@ -65,4 +100,6 @@ export declare type SnapFunctionExports = {
 /**
  * All handlers that a snap can implement.
  */
-export declare type SnapExports = SnapFunctionExports;
+export declare type SnapExports = SnapFunctionExports & {
+    keyring?: SnapKeyring;
+};

package/dist/handlers.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=handlers.js.map

package/dist/handlers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handlers.js","sourceRoot":"","sources":["../src/handlers.ts"],"names":[],"mappings":"","sourcesContent":["import { Component } from '@metamask/snaps-ui';\nimport { Json, JsonRpcRequest } from '@metamask/utils';\n\nimport { AccountId, ChainId, RequestArguments } from './namespace';\n\n/**\n * The `onRpcRequest` handler. This is called whenever a JSON-RPC request is\n * made to the snap.\n *\n * @param args - The request arguments.\n * @param args.origin - The origin of the request. This can be the ID of another\n * snap, or the URL of a dapp.\n * @param args.request - The JSON-RPC request sent to the snap.\n * @returns The JSON-RPC response. This must be a JSON-serializable value.\n */\nexport type OnRpcRequestHandler = (args: {\n  origin: string;\n  request: JsonRpcRequest<Json[] | Record<string, Json>>;\n}) => Promise<unknown>;\n\n/**\n * The response from a snap's `onTransaction` handler.\n *\n * @property content - A custom UI component, that will be shown in MetaMask. Can be created using `@metamask/snaps-ui`.\n *\n * If the snap has no insights about the transaction, this should be `null`.\n */\nexport type OnTransactionResponse = {\n  content: Component | null;\n};\n\n/**\n * The `onTransaction` handler. This is called whenever a transaction is\n * submitted to the snap. It can return insights about the transaction, which\n * will be displayed to the user.\n *\n * @param args - The request arguments.\n * @param args.transaction - The transaction object.\n * @param args.chainId - The CAIP-2 chain ID of the network the transaction is\n * being submitted to.\n * @param args.transactionOrigin - The origin of the transaction. This is the\n * URL of the dapp that submitted the transaction.\n * @returns Insights about the transaction. See {@link OnTransactionResponse}.\n */\n// TODO: Improve type.\nexport type OnTransactionHandler = (args: {\n  transaction: { [key: string]: Json };\n  chainId: string;\n  transactionOrigin?: string;\n}) => Promise<OnTransactionResponse>;\n\n/**\n * The `onCronjob` handler. This is called on a regular interval, as defined by\n * the snap's manifest.\n *\n * @param args - The request arguments.\n * @param args.request - The JSON-RPC request sent to the snap.\n */\nexport type OnCronjobHandler = (args: {\n  request: JsonRpcRequest<Json[] | Record<string, Json>>;\n}) => Promise<unknown>;\n\n/**\n * A request sent to the `handleRequest` handler of a snap keyring.\n *\n * @property chainId - The CAIP-2 chain ID of the network the request is being\n * made to.\n * @property origin - The origin of the request. This can be the ID of another\n * snap, or the URL of a dapp.\n */\nexport type KeyringRequest = {\n  chainId: ChainId;\n  origin: string;\n};\n\n/**\n * A keyring event, which consists of a {@link KeyringRequest}, combined with\n * the name of the event.\n */\nexport type KeyringEvent = KeyringRequest & { eventName: string };\n\n/**\n * A snap keyring object, which can be exported as `keyring` in a snap.\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface SnapKeyring {\n  getAccounts(): Promise<AccountId[]>;\n  handleRequest(\n    data: KeyringRequest & {\n      request: RequestArguments;\n    },\n  ): Promise<Json>;\n  on(data: KeyringEvent, listener: (...args: Json[]) => void): void;\n  off(data: KeyringEvent): void;\n\n  addAccount?(chainId: ChainId): Promise<AccountId>;\n  removeAccount?(accountId: AccountId): Promise<void>;\n\n  importAccount?(chainId: ChainId, data: Json): Promise<AccountId>;\n  exportAccount?(accountId: AccountId): Promise<Json>;\n}\n\n/**\n * All the function-based handlers that a snap can implement.\n */\nexport type SnapFunctionExports = {\n  onRpcRequest?: OnRpcRequestHandler;\n  onTransaction?: OnTransactionHandler;\n  onCronjob?: OnCronjobHandler;\n};\n\n/**\n * All handlers that a snap can implement.\n */\nexport type SnapExports = SnapFunctionExports & {\n  keyring?: SnapKeyring;\n};\n"]}

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

@@ -4,8 +4,7 @@
  * an initialization timeout in the SnapController.
  *
  * @param uri - The iframe URI.
- * @param id - The ID to assign to the iframe.
- * @param sandbox - Whether to enable the sandbox attribute.
+ * @param jobId - The job id.
  * @returns A promise that resolves to the contentWindow of the iframe.
  */
-export declare function createWindow(uri: string, id: string, sandbox?: boolean): Promise<Window>;
+export declare function createWindow(uri: string, jobId: string): Promise<Window>;

package/dist/{esm/iframe.js → iframe.js}

@@ -1,26 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWindow = void 0;
 /**
  * Creates the iframe to be used as the execution environment. This may run
  * forever if the iframe never loads, but the promise should be wrapped in
  * an initialization timeout in the SnapController.
  *
  * @param uri - The iframe URI.
- * @param id - The ID to assign to the iframe.
- * @param sandbox - Whether to enable the sandbox attribute.
+ * @param jobId - The job id.
  * @returns A promise that resolves to the contentWindow of the iframe.
- */ export async function createWindow(uri, id, sandbox = true) {
-    return await new Promise((resolve, reject)=>{
+ */
+async function createWindow(uri, jobId) {
+    return await new Promise((resolve, reject) => {
         const iframe = document.createElement('iframe');
         // The order of operations appears to matter for everything except this
         // attribute. We may as well set it here.
-        iframe.setAttribute('id', id);
+        iframe.setAttribute('id', jobId);
         iframe.setAttribute('data-testid', 'snaps-iframe');
-        if (sandbox) {
-            // For the sandbox property to have any effect it needs to be set before the iframe is appended.
-            // We apply this property as a principle of least authority (POLA)
-            // measure.
-            // Ref: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox
-            iframe.setAttribute('sandbox', 'allow-scripts');
-        }
+        // For the sandbox property to have any effect it needs to be set before the iframe is appended.
+        // We apply this property as a principle of least authority (POLA)
+        // measure.
+        // Ref: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox
+        iframe.setAttribute('sandbox', 'allow-scripts');
         // In the past, we've had problems that appear to be symptomatic of the
         // iframe firing the `load` event before its scripts are actually loaded,
         // which has prevented snaps from executing properly. Therefore, we set
@@ -34,16 +35,17 @@
         // Re: `load` firing twice: https://stackoverflow.com/questions/10781880/dynamically-created-iframe-triggers-onload-event-twice/15880489#15880489
         iframe.setAttribute('src', uri);
         document.body.appendChild(iframe);
-        iframe.addEventListener('load', ()=>{
+        iframe.addEventListener('load', () => {
             if (iframe.contentWindow) {
                 resolve(iframe.contentWindow);
-            } else {
+            }
+            else {
                 // We don't know of a case when this would happen, but better to fail
                 // fast if it does.
-                reject(new Error(`iframe.contentWindow not present on load for job "${id}".`));
+                reject(new Error(`iframe.contentWindow not present on load for job "${jobId}".`));
             }
         });
     });
 }
-
+exports.createWindow = createWindow;
 //# sourceMappingURL=iframe.js.map

package/dist/iframe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iframe.js","sourceRoot":"","sources":["../src/iframe.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;GAQG;AACI,KAAK,UAAU,YAAY,CAChC,GAAW,EACX,KAAa;IAEb,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChD,uEAAuE;QACvE,yCAAyC;QACzC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,YAAY,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAEnD,gGAAgG;QAChG,kEAAkE;QAClE,WAAW;QACX,qFAAqF;QACrF,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAEhD,uEAAuE;QACvE,yEAAyE;QACzE,uEAAuE;QACvE,wEAAwE;QACxE,uBAAuB;QACvB,EAAE;QACF,mEAAmE;QACnE,kCAAkC;QAClC,EAAE;QACF,mGAAmG;QACnG,iJAAiJ;QACjJ,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAChC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAElC,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE;YACnC,IAAI,MAAM,CAAC,aAAa,EAAE;gBACxB,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;aAC/B;iBAAM;gBACL,qEAAqE;gBACrE,mBAAmB;gBACnB,MAAM,CACJ,IAAI,KAAK,CACP,qDAAqD,KAAK,IAAI,CAC/D,CACF,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AA7CD,oCA6CC","sourcesContent":["/**\n * Creates the iframe to be used as the execution environment. This may run\n * forever if the iframe never loads, but the promise should be wrapped in\n * an initialization timeout in the SnapController.\n *\n * @param uri - The iframe URI.\n * @param jobId - The job id.\n * @returns A promise that resolves to the contentWindow of the iframe.\n */\nexport async function createWindow(\n  uri: string,\n  jobId: string,\n): Promise<Window> {\n  return await new Promise((resolve, reject) => {\n    const iframe = document.createElement('iframe');\n    // The order of operations appears to matter for everything except this\n    // attribute. We may as well set it here.\n    iframe.setAttribute('id', jobId);\n    iframe.setAttribute('data-testid', 'snaps-iframe');\n\n    // For the sandbox property to have any effect it needs to be set before the iframe is appended.\n    // We apply this property as a principle of least authority (POLA)\n    // measure.\n    // Ref: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox\n    iframe.setAttribute('sandbox', 'allow-scripts');\n\n    // In the past, we've had problems that appear to be symptomatic of the\n    // iframe firing the `load` event before its scripts are actually loaded,\n    // which has prevented snaps from executing properly. Therefore, we set\n    // the `src` attribute and append the iframe to the DOM before attaching\n    // the `load` listener.\n    //\n    // `load` should only fire when \"all dependent resources\" have been\n    // loaded, which includes scripts.\n    //\n    // MDN article for `load` event: https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event\n    // Re: `load` firing twice: https://stackoverflow.com/questions/10781880/dynamically-created-iframe-triggers-onload-event-twice/15880489#15880489\n    iframe.setAttribute('src', uri);\n    document.body.appendChild(iframe);\n\n    iframe.addEventListener('load', () => {\n      if (iframe.contentWindow) {\n        resolve(iframe.contentWindow);\n      } else {\n        // We don't know of a case when this would happen, but better to fail\n        // fast if it does.\n        reject(\n          new Error(\n            `iframe.contentWindow not present on load for job \"${jobId}\".`,\n          ),\n        );\n      }\n    });\n  });\n}\n"]}

package/dist/iframe.test.browser.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const iframe_1 = require("./iframe");
+const IFRAME_URL = `http://localhost:4569`;
+const MOCK_JOB_ID = 'job-id';
+describe('createWindow', () => {
+    it('creates an iframe window with the provided job ID as the iframe ID', async () => {
+        const window = await (0, iframe_1.createWindow)(IFRAME_URL, MOCK_JOB_ID);
+        const iframe = document.getElementById(MOCK_JOB_ID);
+        expect(iframe).toBeDefined();
+        expect(iframe.contentWindow).toBe(window);
+        expect(iframe.id).toBe(MOCK_JOB_ID);
+    });
+});
+//# sourceMappingURL=iframe.test.browser.js.map

package/dist/iframe.test.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iframe.test.browser.js","sourceRoot":"","sources":["../src/iframe.test.browser.ts"],"names":[],"mappings":";;AAAA,qCAAwC;AAExC,MAAM,UAAU,GAAG,uBAAuB,CAAC;AAE3C,MAAM,WAAW,GAAG,QAAQ,CAAC;AAE7B,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAY,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAC3D,MAAM,MAAM,GAAG,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAsB,CAAC;QAEzE,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { createWindow } from './iframe';\n\nconst IFRAME_URL = `http://localhost:4569`;\n\nconst MOCK_JOB_ID = 'job-id';\n\ndescribe('createWindow', () => {\n  it('creates an iframe window with the provided job ID as the iframe ID', async () => {\n    const window = await createWindow(IFRAME_URL, MOCK_JOB_ID);\n    const iframe = document.getElementById(MOCK_JOB_ID) as HTMLIFrameElement;\n\n    expect(iframe).toBeDefined();\n    expect(iframe.contentWindow).toBe(window);\n    expect(iframe.id).toBe(MOCK_JOB_ID);\n  });\n});\n"]}

package/dist/{types/index.browser.d.ts → index.browser.d.ts}

@@ -5,7 +5,6 @@ export * from './cronjob';
 export * from './deep-clone';
 export * from './default-endowments';
 export * from './entropy';
-export * from './enum';
 export * from './handlers';
 export * from './iframe';
 export * from './json';
@@ -13,9 +12,9 @@ export * from './json-rpc';
 export * from './logging';
 export * from './manifest/index.browser';
 export * from './namespace';
+export * from './notification';
 export * from './path';
 export * from './snaps';
 export * from './types';
-export * from './validation';
 export * from './versions';
 export * from './virtual-file/index.browser';

package/dist/index.browser.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./array"), exports);
+__exportStar(require("./caveats"), exports);
+__exportStar(require("./checksum"), exports);
+__exportStar(require("./cronjob"), exports);
+__exportStar(require("./deep-clone"), exports);
+__exportStar(require("./default-endowments"), exports);
+__exportStar(require("./entropy"), exports);
+__exportStar(require("./handlers"), exports);
+__exportStar(require("./iframe"), exports);
+__exportStar(require("./json"), exports);
+__exportStar(require("./json-rpc"), exports);
+__exportStar(require("./logging"), exports);
+__exportStar(require("./manifest/index.browser"), exports);
+__exportStar(require("./namespace"), exports);
+__exportStar(require("./notification"), exports);
+__exportStar(require("./path"), exports);
+__exportStar(require("./snaps"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./versions"), exports);
+__exportStar(require("./virtual-file/index.browser"), exports);
+//# sourceMappingURL=index.browser.js.map

package/dist/index.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.js","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,4CAA0B;AAC1B,6CAA2B;AAC3B,4CAA0B;AAC1B,+CAA6B;AAC7B,uDAAqC;AACrC,4CAA0B;AAC1B,6CAA2B;AAC3B,2CAAyB;AACzB,yCAAuB;AACvB,6CAA2B;AAC3B,4CAA0B;AAC1B,2DAAyC;AACzC,8CAA4B;AAC5B,iDAA+B;AAC/B,yCAAuB;AACvB,0CAAwB;AACxB,0CAAwB;AACxB,6CAA2B;AAC3B,+DAA6C","sourcesContent":["export * from './array';\nexport * from './caveats';\nexport * from './checksum';\nexport * from './cronjob';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './entropy';\nexport * from './handlers';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './logging';\nexport * from './manifest/index.browser';\nexport * from './namespace';\nexport * from './notification';\nexport * from './path';\nexport * from './snaps';\nexport * from './types';\nexport * from './versions';\nexport * from './virtual-file/index.browser';\n"]}

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

@@ -5,7 +5,6 @@ export * from './checksum';
 export * from './deep-clone';
 export * from './default-endowments';
 export * from './entropy';
-export * from './enum';
 export * from './eval';
 export * from './fs';
 export * from './handlers';
@@ -16,11 +15,11 @@ export * from './logging';
 export * from './manifest';
 export * from './mock';
 export * from './namespace';
+export * from './notification';
 export * from './npm';
 export * from './path';
 export * from './post-process';
 export * from './snaps';
 export * from './types';
-export * from './validation';
 export * from './versions';
 export * from './virtual-file';

package/dist/index.executionenv.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Special entrypoint for execution environments for bundle sizing reasons
+__exportStar(require("./handlers"), exports);
+__exportStar(require("./logging"), exports);
+__exportStar(require("./namespace"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.executionenv.js.map

package/dist/index.executionenv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.executionenv.js","sourceRoot":"","sources":["../src/index.executionenv.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0EAA0E;AAC1E,6CAA2B;AAC3B,4CAA0B;AAC1B,8CAA4B;AAC5B,0CAAwB","sourcesContent":["// Special entrypoint for execution environments for bundle sizing reasons\nexport * from './handlers';\nexport * from './logging';\nexport * from './namespace';\nexport * from './types';\n"]}

package/dist/index.js

@@ -0,0 +1,42 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./array"), exports);
+__exportStar(require("./caveats"), exports);
+__exportStar(require("./cronjob"), exports);
+__exportStar(require("./checksum"), exports);
+__exportStar(require("./deep-clone"), exports);
+__exportStar(require("./default-endowments"), exports);
+__exportStar(require("./entropy"), exports);
+__exportStar(require("./eval"), exports);
+__exportStar(require("./fs"), exports);
+__exportStar(require("./handlers"), exports);
+__exportStar(require("./iframe"), exports);
+__exportStar(require("./json"), exports);
+__exportStar(require("./json-rpc"), exports);
+__exportStar(require("./logging"), exports);
+__exportStar(require("./manifest"), exports);
+__exportStar(require("./mock"), exports);
+__exportStar(require("./namespace"), exports);
+__exportStar(require("./notification"), exports);
+__exportStar(require("./npm"), exports);
+__exportStar(require("./path"), exports);
+__exportStar(require("./post-process"), exports);
+__exportStar(require("./snaps"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./versions"), exports);
+__exportStar(require("./virtual-file"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,4CAA0B;AAC1B,4CAA0B;AAC1B,6CAA2B;AAC3B,+CAA6B;AAC7B,uDAAqC;AACrC,4CAA0B;AAC1B,yCAAuB;AACvB,uCAAqB;AACrB,6CAA2B;AAC3B,2CAAyB;AACzB,yCAAuB;AACvB,6CAA2B;AAC3B,4CAA0B;AAC1B,6CAA2B;AAC3B,yCAAuB;AACvB,8CAA4B;AAC5B,iDAA+B;AAC/B,wCAAsB;AACtB,yCAAuB;AACvB,iDAA+B;AAC/B,0CAAwB;AACxB,0CAAwB;AACxB,6CAA2B;AAC3B,iDAA+B","sourcesContent":["export * from './array';\nexport * from './caveats';\nexport * from './cronjob';\nexport * from './checksum';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './entropy';\nexport * from './eval';\nexport * from './fs';\nexport * from './handlers';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './logging';\nexport * from './manifest';\nexport * from './mock';\nexport * from './namespace';\nexport * from './notification';\nexport * from './npm';\nexport * from './path';\nexport * from './post-process';\nexport * from './snaps';\nexport * from './types';\nexport * from './versions';\nexport * from './virtual-file';\n"]}

package/dist/json-rpc.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertIsJsonRpcSuccess = exports.assertIsRpcOrigins = exports.RpcOriginsStruct = void 0;
+const utils_1 = require("@metamask/utils");
+const superstruct_1 = require("superstruct");
+exports.RpcOriginsStruct = (0, superstruct_1.refine)((0, superstruct_1.object)({
+    dapps: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+    snaps: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+}), 'RPC origins', (value) => {
+    if (!Object.values(value).some(Boolean)) {
+        throw new Error('Must specify at least one JSON-RPC origin');
+    }
+    return true;
+});
+/**
+ * Asserts that the given value is a valid {@link RpcOrigins} object.
+ *
+ * @param value - The value to assert.
+ * @param ErrorWrapper - An optional error wrapper to use. Defaults to
+ * {@link AssertionError}.
+ * @throws If the value is not a valid {@link RpcOrigins} object.
+ */
+function assertIsRpcOrigins(value, 
+// eslint-disable-next-line @typescript-eslint/naming-convention
+ErrorWrapper) {
+    (0, utils_1.assertStruct)(value, exports.RpcOriginsStruct, 'Invalid JSON-RPC origins', ErrorWrapper);
+}
+exports.assertIsRpcOrigins = assertIsRpcOrigins;
+/**
+ * Assert that the given value is a successful JSON-RPC response. If the value
+ * is not a success response, an error is thrown. If the value is an JSON-RPC
+ * error, the error message is included in the thrown error.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a JSON-RPC success response.
+ */
+function assertIsJsonRpcSuccess(value) {
+    if (!(0, utils_1.isJsonRpcSuccess)(value)) {
+        if ((0, utils_1.isJsonRpcFailure)(value)) {
+            throw new Error(`JSON-RPC request failed: ${value.error.message}`);
+        }
+        throw new Error('Invalid JSON-RPC response.');
+    }
+}
+exports.assertIsJsonRpcSuccess = assertIsJsonRpcSuccess;
+//# sourceMappingURL=json-rpc.js.map

package/dist/json-rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-rpc.js","sourceRoot":"","sources":["../src/json-rpc.ts"],"names":[],"mappings":";;;AAAA,2CAOyB;AACzB,6CAAuE;AAE1D,QAAA,gBAAgB,GAAG,IAAA,oBAAM,EACpC,IAAA,oBAAM,EAAC;IACL,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;IAC1B,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC3B,CAAC,EACF,aAAa,EACb,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;KAC9D;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CACF,CAAC;AAIF;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAChC,KAAc;AACd,gEAAgE;AAChE,YAAwC;IAExC,IAAA,oBAAY,EACV,KAAK,EACL,wBAAgB,EAChB,0BAA0B,EAC1B,YAAY,CACb,CAAC;AACJ,CAAC;AAXD,gDAWC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,KAAc;IAEd,IAAI,CAAC,IAAA,wBAAgB,EAAC,KAAK,CAAC,EAAE;QAC5B,IAAI,IAAA,wBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,4BAA4B,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;SACpE;QAED,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;AACH,CAAC;AAVD,wDAUC","sourcesContent":["import {\n  isJsonRpcFailure,\n  isJsonRpcSuccess,\n  Json,\n  JsonRpcSuccess,\n  AssertionErrorConstructor,\n  assertStruct,\n} from '@metamask/utils';\nimport { boolean, Infer, object, optional, refine } from 'superstruct';\n\nexport const RpcOriginsStruct = refine(\n  object({\n    dapps: optional(boolean()),\n    snaps: optional(boolean()),\n  }),\n  'RPC origins',\n  (value) => {\n    if (!Object.values(value).some(Boolean)) {\n      throw new Error('Must specify at least one JSON-RPC origin');\n    }\n\n    return true;\n  },\n);\n\nexport type RpcOrigins = Infer<typeof RpcOriginsStruct>;\n\n/**\n * Asserts that the given value is a valid {@link RpcOrigins} object.\n *\n * @param value - The value to assert.\n * @param ErrorWrapper - An optional error wrapper to use. Defaults to\n * {@link AssertionError}.\n * @throws If the value is not a valid {@link RpcOrigins} object.\n */\nexport function assertIsRpcOrigins(\n  value: unknown,\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is RpcOrigins {\n  assertStruct(\n    value,\n    RpcOriginsStruct,\n    'Invalid JSON-RPC origins',\n    ErrorWrapper,\n  );\n}\n\n/**\n * Assert that the given value is a successful JSON-RPC response. If the value\n * is not a success response, an error is thrown. If the value is an JSON-RPC\n * error, the error message is included in the thrown error.\n *\n * @param value - The value to check.\n * @throws If the value is not a JSON-RPC success response.\n */\nexport function assertIsJsonRpcSuccess(\n  value: unknown,\n): asserts value is JsonRpcSuccess<Json> {\n  if (!isJsonRpcSuccess(value)) {\n    if (isJsonRpcFailure(value)) {\n      throw new Error(`JSON-RPC request failed: ${value.error.message}`);\n    }\n\n    throw new Error('Invalid JSON-RPC response.');\n  }\n}\n"]}

package/dist/json.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parses JSON safely.
+ *
+ * Does multiple kinds of validation and strips unwanted properties like __proto__.
+ *
+ * @param json - A JSON string to be parsed.
+ * @returns The parsed JSON object.
+ */
+export declare function parseJson(json: string): import("@metamask/utils").Json;