@metamask/snaps-simulation 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0]
+### Added
+- Initial release of `@metamask/snaps-simulation` package ([#2727](https://github.com/MetaMask/snaps/pull/2727))
+
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-simulation@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/snaps/releases/tag/@metamask/snaps-simulation@1.0.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024 MetaMask
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,14 @@
+# @metamask/snaps-simulation
+
+A simulation framework for MetaMask Snaps, which runs in Node.js, and can be
+used to test Snaps in a headless environment.
+
+## Installation
+
+Use Node.js `18.0.0` or later. We recommend using [nvm](https://github.com/nvm-sh/nvm)
+for managing Node.js versions.
+
+Install a dependency in your snap project using `yarn` or `npm`:
+
+- `npm install @metamask/snaps-simulation`
+- `yarn add @metamask/snaps-simulation`

package/dist/constants.cjs

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_JSON_RPC_ENDPOINT = exports.DEFAULT_CURRENCY = exports.DEFAULT_LOCALE = exports.DEFAULT_SRP = void 0;
+/**
+ * A secret recovery phrase that is used for testing purposes. Do not use this
+ * to store any real funds!
+ */
+exports.DEFAULT_SRP = 'test test test test test test test test test test test ball';
+/**
+ * The default locale.
+ */
+exports.DEFAULT_LOCALE = 'en';
+/**
+ * The default currency.
+ */
+exports.DEFAULT_CURRENCY = 'usd';
+/**
+ * The default JSON-RPC endpoint for Ethereum requests.
+ */
+exports.DEFAULT_JSON_RPC_ENDPOINT = 'https://cloudflare-eth.com/';
+//# sourceMappingURL=constants.cjs.map

package/dist/constants.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACU,QAAA,WAAW,GACtB,6DAA6D,CAAC;AAEhE;;GAEG;AACU,QAAA,cAAc,GAAG,IAAI,CAAC;AAEnC;;GAEG;AACU,QAAA,gBAAgB,GAAG,KAAK,CAAC;AAEtC;;GAEG;AACU,QAAA,yBAAyB,GAAG,6BAA6B,CAAC","sourcesContent":["/**\n * A secret recovery phrase that is used for testing purposes. Do not use this\n * to store any real funds!\n */\nexport const DEFAULT_SRP =\n  'test test test test test test test test test test test ball';\n\n/**\n * The default locale.\n */\nexport const DEFAULT_LOCALE = 'en';\n\n/**\n * The default currency.\n */\nexport const DEFAULT_CURRENCY = 'usd';\n\n/**\n * The default JSON-RPC endpoint for Ethereum requests.\n */\nexport const DEFAULT_JSON_RPC_ENDPOINT = 'https://cloudflare-eth.com/';\n"]}

package/dist/constants.d.cts

@@ -0,0 +1,18 @@
+/**
+ * A secret recovery phrase that is used for testing purposes. Do not use this
+ * to store any real funds!
+ */
+export declare const DEFAULT_SRP = "test test test test test test test test test test test ball";
+/**
+ * The default locale.
+ */
+export declare const DEFAULT_LOCALE = "en";
+/**
+ * The default currency.
+ */
+export declare const DEFAULT_CURRENCY = "usd";
+/**
+ * The default JSON-RPC endpoint for Ethereum requests.
+ */
+export declare const DEFAULT_JSON_RPC_ENDPOINT = "https://cloudflare-eth.com/";
+//# sourceMappingURL=constants.d.cts.map

package/dist/constants.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.cts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,WAAW,gEACuC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,gBAAgB,QAAQ,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,yBAAyB,gCAAgC,CAAC"}

package/dist/constants.d.mts

@@ -0,0 +1,18 @@
+/**
+ * A secret recovery phrase that is used for testing purposes. Do not use this
+ * to store any real funds!
+ */
+export declare const DEFAULT_SRP = "test test test test test test test test test test test ball";
+/**
+ * The default locale.
+ */
+export declare const DEFAULT_LOCALE = "en";
+/**
+ * The default currency.
+ */
+export declare const DEFAULT_CURRENCY = "usd";
+/**
+ * The default JSON-RPC endpoint for Ethereum requests.
+ */
+export declare const DEFAULT_JSON_RPC_ENDPOINT = "https://cloudflare-eth.com/";
+//# sourceMappingURL=constants.d.mts.map

package/dist/constants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,WAAW,gEACuC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,gBAAgB,QAAQ,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,yBAAyB,gCAAgC,CAAC"}

package/dist/constants.mjs

@@ -0,0 +1,18 @@
+/**
+ * A secret recovery phrase that is used for testing purposes. Do not use this
+ * to store any real funds!
+ */
+export const DEFAULT_SRP = 'test test test test test test test test test test test ball';
+/**
+ * The default locale.
+ */
+export const DEFAULT_LOCALE = 'en';
+/**
+ * The default currency.
+ */
+export const DEFAULT_CURRENCY = 'usd';
+/**
+ * The default JSON-RPC endpoint for Ethereum requests.
+ */
+export const DEFAULT_JSON_RPC_ENDPOINT = 'https://cloudflare-eth.com/';
+//# sourceMappingURL=constants.mjs.map

package/dist/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GACtB,6DAA6D,CAAC;AAEhE;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,CAAC;AAEnC;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAC;AAEtC;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,6BAA6B,CAAC","sourcesContent":["/**\n * A secret recovery phrase that is used for testing purposes. Do not use this\n * to store any real funds!\n */\nexport const DEFAULT_SRP =\n  'test test test test test test test test test test test ball';\n\n/**\n * The default locale.\n */\nexport const DEFAULT_LOCALE = 'en';\n\n/**\n * The default currency.\n */\nexport const DEFAULT_CURRENCY = 'usd';\n\n/**\n * The default JSON-RPC endpoint for Ethereum requests.\n */\nexport const DEFAULT_JSON_RPC_ENDPOINT = 'https://cloudflare-eth.com/';\n"]}

package/dist/controllers.cjs

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSnap = exports.getControllers = void 0;
+const permission_controller_1 = require("@metamask/permission-controller");
+const snaps_controllers_1 = require("@metamask/snaps-controllers");
+const snaps_rpc_methods_1 = require("@metamask/snaps-rpc-methods");
+const utils_1 = require("@metamask/utils");
+const methods_1 = require("./methods/index.cjs");
+const constants_1 = require("./methods/constants.cjs");
+/**
+ * Get the controllers for the Snap.
+ *
+ * @param options - The options.
+ * @returns The controllers for the Snap.
+ */
+function getControllers(options) {
+    const { controllerMessenger } = options;
+    const subjectMetadataController = new permission_controller_1.SubjectMetadataController({
+        messenger: controllerMessenger.getRestricted({
+            name: 'SubjectMetadataController',
+            allowedActions: [],
+            allowedEvents: [],
+        }),
+        subjectCacheLimit: 100,
+    });
+    const interfaceController = new snaps_controllers_1.SnapInterfaceController({
+        messenger: controllerMessenger.getRestricted({
+            name: 'SnapInterfaceController',
+            allowedActions: [
+                'PhishingController:maybeUpdateState',
+                'PhishingController:testOrigin',
+                'ApprovalController:hasRequest',
+                'ApprovalController:acceptRequest',
+            ],
+            allowedEvents: [],
+        }),
+    });
+    const permissionController = getPermissionController(options);
+    return {
+        permissionController,
+        subjectMetadataController,
+        interfaceController,
+    };
+}
+exports.getControllers = getControllers;
+/**
+ * Get the permission controller for the Snap.
+ *
+ * @param options - The options.
+ * @param options.controllerMessenger - The controller messenger.
+ * @param options.options - Miscellaneous options.
+ * @returns The permission controller for the Snap.
+ */
+function getPermissionController(options) {
+    const { controllerMessenger } = options;
+    const permissionSpecifications = (0, methods_1.getPermissionSpecifications)(options);
+    return new permission_controller_1.PermissionController({
+        messenger: controllerMessenger.getRestricted({
+            name: 'PermissionController',
+            allowedActions: [
+                `ApprovalController:addRequest`,
+                `ApprovalController:hasRequest`,
+                `ApprovalController:acceptRequest`,
+                `ApprovalController:rejectRequest`,
+                `SnapController:getPermitted`,
+                `SnapController:install`,
+                `SubjectMetadataController:getSubjectMetadata`,
+            ],
+            allowedEvents: [],
+        }),
+        caveatSpecifications: {
+            ...snaps_rpc_methods_1.caveatSpecifications,
+            ...snaps_rpc_methods_1.endowmentCaveatSpecifications,
+        },
+        permissionSpecifications,
+        unrestrictedMethods: constants_1.UNRESTRICTED_METHODS,
+    });
+}
+/**
+ * Register the Snap. This sets up the Snap's permissions and subject metadata.
+ *
+ * @param snapId - The ID of the Snap to install.
+ * @param manifest - The parsed manifest.
+ * @param controllers - The controllers for the Snap.
+ * @param controllers.permissionController - The permission controller.
+ * @param controllers.subjectMetadataController - The subject metadata controller.
+ */
+async function registerSnap(snapId, manifest, { permissionController, subjectMetadataController, }) {
+    subjectMetadataController.addSubjectMetadata({
+        origin: snapId,
+        subjectType: permission_controller_1.SubjectType.Snap,
+    });
+    const approvedPermissions = (0, snaps_rpc_methods_1.processSnapPermissions)((0, utils_1.getSafeJson)(manifest.initialPermissions));
+    permissionController.grantPermissions({
+        approvedPermissions,
+        subject: { origin: snapId },
+        preserveExistingPermissions: false,
+    });
+}
+exports.registerSnap = registerSnap;
+//# sourceMappingURL=controllers.cjs.map

package/dist/controllers.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"controllers.cjs","sourceRoot":"","sources":["../src/controllers.ts"],"names":[],"mappings":";;;AAOA,2EAIyC;AACzC,mEAAsE;AAMtE,mEAIqC;AAGrC,2CAA8C;AAE9C,iDAAwD;AACxD,uDAA2D;AAiC3D;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,OAA8B;IAC3D,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC;IACxC,MAAM,yBAAyB,GAAG,IAAI,iDAAyB,CAAC;QAC9D,SAAS,EAAE,mBAAmB,CAAC,aAAa,CAAC;YAC3C,IAAI,EAAE,2BAA2B;YACjC,cAAc,EAAE,EAAE;YAClB,aAAa,EAAE,EAAE;SAClB,CAAC;QACF,iBAAiB,EAAE,GAAG;KACvB,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,IAAI,2CAAuB,CAAC;QACtD,SAAS,EAAE,mBAAmB,CAAC,aAAa,CAAC;YAC3C,IAAI,EAAE,yBAAyB;YAC/B,cAAc,EAAE;gBACd,qCAAqC;gBACrC,+BAA+B;gBAC/B,+BAA+B;gBAC/B,kCAAkC;aACnC;YACD,aAAa,EAAE,EAAE;SAClB,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE9D,OAAO;QACL,oBAAoB;QACpB,yBAAyB;QACzB,mBAAmB;KACpB,CAAC;AACJ,CAAC;AA/BD,wCA+BC;AAED;;;;;;;GAOG;AACH,SAAS,uBAAuB,CAAC,OAA8B;IAC7D,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC;IACxC,MAAM,wBAAwB,GAAG,IAAA,qCAA2B,EAAC,OAAO,CAAC,CAAC;IACtE,OAAO,IAAI,4CAAoB,CAAC;QAC9B,SAAS,EAAE,mBAAmB,CAAC,aAAa,CAAC;YAC3C,IAAI,EAAE,sBAAsB;YAC5B,cAAc,EAAE;gBACd,+BAA+B;gBAC/B,+BAA+B;gBAC/B,kCAAkC;gBAClC,kCAAkC;gBAClC,6BAA6B;gBAC7B,wBAAwB;gBACxB,8CAA8C;aAC/C;YACD,aAAa,EAAE,EAAE;SAClB,CAAC;QACF,oBAAoB,EAAE;YACpB,GAAG,wCAA0B;YAC7B,GAAG,iDAAkC;SACtC;QACD,wBAAwB;QACxB,mBAAmB,EAAE,gCAAoB;KAC1C,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,YAAY,CAChC,MAAc,EACd,QAAsB,EACtB,EACE,oBAAoB,EACpB,yBAAyB,GACgB;IAE3C,yBAAyB,CAAC,kBAAkB,CAAC;QAC3C,MAAM,EAAE,MAAM;QACd,WAAW,EAAE,mCAAW,CAAC,IAAI;KAC9B,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,IAAA,0CAAsB,EAChD,IAAA,mBAAW,EAAC,QAAQ,CAAC,kBAAkB,CAAC,CACzC,CAAC;IAEF,oBAAoB,CAAC,gBAAgB,CAAC;QACpC,mBAAmB;QACnB,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;QAC3B,2BAA2B,EAAE,KAAK;KACnC,CAAC,CAAC;AACL,CAAC;AAtBD,oCAsBC","sourcesContent":["import type { ControllerMessenger } from '@metamask/base-controller';\nimport type {\n  CaveatSpecificationConstraint,\n  PermissionSpecificationConstraint,\n  PermissionControllerActions,\n  SubjectMetadataControllerActions,\n} from '@metamask/permission-controller';\nimport {\n  PermissionController,\n  SubjectMetadataController,\n  SubjectType,\n} from '@metamask/permission-controller';\nimport { SnapInterfaceController } from '@metamask/snaps-controllers';\nimport type {\n  ExecutionServiceActions,\n  SnapInterfaceControllerActions,\n  SnapInterfaceControllerAllowedActions,\n} from '@metamask/snaps-controllers';\nimport {\n  caveatSpecifications as snapsCaveatsSpecifications,\n  endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,\n  processSnapPermissions,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport type { SnapManifest } from '@metamask/snaps-utils';\nimport { getSafeJson } from '@metamask/utils';\n\nimport { getPermissionSpecifications } from './methods';\nimport { UNRESTRICTED_METHODS } from './methods/constants';\nimport type { SimulationOptions } from './options';\nimport type { MiddlewareHooks } from './simulation';\nimport type { RunSagaFunction } from './store';\n\nexport type RootControllerAllowedActions =\n  | SnapInterfaceControllerActions\n  | SnapInterfaceControllerAllowedActions\n  | PermissionControllerActions\n  | ExecutionServiceActions\n  | SubjectMetadataControllerActions;\n\nexport type RootControllerMessenger = ControllerMessenger<\n  RootControllerAllowedActions,\n  any\n>;\n\nexport type GetControllersOptions = {\n  controllerMessenger: ControllerMessenger<any, any>;\n  hooks: MiddlewareHooks;\n  runSaga: RunSagaFunction;\n  options: SimulationOptions;\n};\n\nexport type Controllers = {\n  permissionController: PermissionController<\n    PermissionSpecificationConstraint,\n    CaveatSpecificationConstraint\n  >;\n  subjectMetadataController: SubjectMetadataController;\n  interfaceController: SnapInterfaceController;\n};\n\n/**\n * Get the controllers for the Snap.\n *\n * @param options - The options.\n * @returns The controllers for the Snap.\n */\nexport function getControllers(options: GetControllersOptions): Controllers {\n  const { controllerMessenger } = options;\n  const subjectMetadataController = new SubjectMetadataController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'SubjectMetadataController',\n      allowedActions: [],\n      allowedEvents: [],\n    }),\n    subjectCacheLimit: 100,\n  });\n\n  const interfaceController = new SnapInterfaceController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'SnapInterfaceController',\n      allowedActions: [\n        'PhishingController:maybeUpdateState',\n        'PhishingController:testOrigin',\n        'ApprovalController:hasRequest',\n        'ApprovalController:acceptRequest',\n      ],\n      allowedEvents: [],\n    }),\n  });\n\n  const permissionController = getPermissionController(options);\n\n  return {\n    permissionController,\n    subjectMetadataController,\n    interfaceController,\n  };\n}\n\n/**\n * Get the permission controller for the Snap.\n *\n * @param options - The options.\n * @param options.controllerMessenger - The controller messenger.\n * @param options.options - Miscellaneous options.\n * @returns The permission controller for the Snap.\n */\nfunction getPermissionController(options: GetControllersOptions) {\n  const { controllerMessenger } = options;\n  const permissionSpecifications = getPermissionSpecifications(options);\n  return new PermissionController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'PermissionController',\n      allowedActions: [\n        `ApprovalController:addRequest`,\n        `ApprovalController:hasRequest`,\n        `ApprovalController:acceptRequest`,\n        `ApprovalController:rejectRequest`,\n        `SnapController:getPermitted`,\n        `SnapController:install`,\n        `SubjectMetadataController:getSubjectMetadata`,\n      ],\n      allowedEvents: [],\n    }),\n    caveatSpecifications: {\n      ...snapsCaveatsSpecifications,\n      ...snapsEndowmentCaveatSpecifications,\n    },\n    permissionSpecifications,\n    unrestrictedMethods: UNRESTRICTED_METHODS,\n  });\n}\n\n/**\n * Register the Snap. This sets up the Snap's permissions and subject metadata.\n *\n * @param snapId - The ID of the Snap to install.\n * @param manifest - The parsed manifest.\n * @param controllers - The controllers for the Snap.\n * @param controllers.permissionController - The permission controller.\n * @param controllers.subjectMetadataController - The subject metadata controller.\n */\nexport async function registerSnap(\n  snapId: SnapId,\n  manifest: SnapManifest,\n  {\n    permissionController,\n    subjectMetadataController,\n  }: Omit<Controllers, 'interfaceController'>,\n) {\n  subjectMetadataController.addSubjectMetadata({\n    origin: snapId,\n    subjectType: SubjectType.Snap,\n  });\n\n  const approvedPermissions = processSnapPermissions(\n    getSafeJson(manifest.initialPermissions),\n  );\n\n  permissionController.grantPermissions({\n    approvedPermissions,\n    subject: { origin: snapId },\n    preserveExistingPermissions: false,\n  });\n}\n"]}

package/dist/controllers.d.cts

@@ -0,0 +1,41 @@
+import type { ControllerMessenger } from "@metamask/base-controller";
+import type { CaveatSpecificationConstraint, PermissionSpecificationConstraint, PermissionControllerActions, SubjectMetadataControllerActions } from "@metamask/permission-controller";
+import { PermissionController, SubjectMetadataController } from "@metamask/permission-controller";
+import { SnapInterfaceController } from "@metamask/snaps-controllers";
+import type { ExecutionServiceActions, SnapInterfaceControllerActions, SnapInterfaceControllerAllowedActions } from "@metamask/snaps-controllers";
+import type { SnapId } from "@metamask/snaps-sdk";
+import type { SnapManifest } from "@metamask/snaps-utils";
+import type { SimulationOptions } from "./options.cjs";
+import type { MiddlewareHooks } from "./simulation.cjs";
+import type { RunSagaFunction } from "./store/index.cjs";
+export type RootControllerAllowedActions = SnapInterfaceControllerActions | SnapInterfaceControllerAllowedActions | PermissionControllerActions | ExecutionServiceActions | SubjectMetadataControllerActions;
+export type RootControllerMessenger = ControllerMessenger<RootControllerAllowedActions, any>;
+export type GetControllersOptions = {
+    controllerMessenger: ControllerMessenger<any, any>;
+    hooks: MiddlewareHooks;
+    runSaga: RunSagaFunction;
+    options: SimulationOptions;
+};
+export type Controllers = {
+    permissionController: PermissionController<PermissionSpecificationConstraint, CaveatSpecificationConstraint>;
+    subjectMetadataController: SubjectMetadataController;
+    interfaceController: SnapInterfaceController;
+};
+/**
+ * Get the controllers for the Snap.
+ *
+ * @param options - The options.
+ * @returns The controllers for the Snap.
+ */
+export declare function getControllers(options: GetControllersOptions): Controllers;
+/**
+ * Register the Snap. This sets up the Snap's permissions and subject metadata.
+ *
+ * @param snapId - The ID of the Snap to install.
+ * @param manifest - The parsed manifest.
+ * @param controllers - The controllers for the Snap.
+ * @param controllers.permissionController - The permission controller.
+ * @param controllers.subjectMetadataController - The subject metadata controller.
+ */
+export declare function registerSnap(snapId: SnapId, manifest: SnapManifest, { permissionController, subjectMetadataController, }: Omit<Controllers, 'interfaceController'>): Promise<void>;
+//# sourceMappingURL=controllers.d.cts.map

package/dist/controllers.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controllers.d.cts","sourceRoot":"","sources":["../src/controllers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAAkC;AACrE,OAAO,KAAK,EACV,6BAA6B,EAC7B,iCAAiC,EACjC,2BAA2B,EAC3B,gCAAgC,EACjC,wCAAwC;AACzC,OAAO,EACL,oBAAoB,EACpB,yBAAyB,EAE1B,wCAAwC;AACzC,OAAO,EAAE,uBAAuB,EAAE,oCAAoC;AACtE,OAAO,KAAK,EACV,uBAAuB,EACvB,8BAA8B,EAC9B,qCAAqC,EACtC,oCAAoC;AAMrC,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,8BAA8B;AAK1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,sBAAkB;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,yBAAqB;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,0BAAgB;AAE/C,MAAM,MAAM,4BAA4B,GACpC,8BAA8B,GAC9B,qCAAqC,GACrC,2BAA2B,GAC3B,uBAAuB,GACvB,gCAAgC,CAAC;AAErC,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,CACvD,4BAA4B,EAC5B,GAAG,CACJ,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,mBAAmB,EAAE,mBAAmB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACnD,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,oBAAoB,EAAE,oBAAoB,CACxC,iCAAiC,EACjC,6BAA6B,CAC9B,CAAC;IACF,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,mBAAmB,EAAE,uBAAuB,CAAC;CAC9C,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,WAAW,CA+B1E;AAoCD;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,YAAY,EACtB,EACE,oBAAoB,EACpB,yBAAyB,GAC1B,EAAE,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,iBAgB5C"}

package/dist/controllers.d.mts

@@ -0,0 +1,41 @@
+import type { ControllerMessenger } from "@metamask/base-controller";
+import type { CaveatSpecificationConstraint, PermissionSpecificationConstraint, PermissionControllerActions, SubjectMetadataControllerActions } from "@metamask/permission-controller";
+import { PermissionController, SubjectMetadataController } from "@metamask/permission-controller";
+import { SnapInterfaceController } from "@metamask/snaps-controllers";
+import type { ExecutionServiceActions, SnapInterfaceControllerActions, SnapInterfaceControllerAllowedActions } from "@metamask/snaps-controllers";
+import type { SnapId } from "@metamask/snaps-sdk";
+import type { SnapManifest } from "@metamask/snaps-utils";
+import type { SimulationOptions } from "./options.mjs";
+import type { MiddlewareHooks } from "./simulation.mjs";
+import type { RunSagaFunction } from "./store/index.mjs";
+export type RootControllerAllowedActions = SnapInterfaceControllerActions | SnapInterfaceControllerAllowedActions | PermissionControllerActions | ExecutionServiceActions | SubjectMetadataControllerActions;
+export type RootControllerMessenger = ControllerMessenger<RootControllerAllowedActions, any>;
+export type GetControllersOptions = {
+    controllerMessenger: ControllerMessenger<any, any>;
+    hooks: MiddlewareHooks;
+    runSaga: RunSagaFunction;
+    options: SimulationOptions;
+};
+export type Controllers = {
+    permissionController: PermissionController<PermissionSpecificationConstraint, CaveatSpecificationConstraint>;
+    subjectMetadataController: SubjectMetadataController;
+    interfaceController: SnapInterfaceController;
+};
+/**
+ * Get the controllers for the Snap.
+ *
+ * @param options - The options.
+ * @returns The controllers for the Snap.
+ */
+export declare function getControllers(options: GetControllersOptions): Controllers;
+/**
+ * Register the Snap. This sets up the Snap's permissions and subject metadata.
+ *
+ * @param snapId - The ID of the Snap to install.
+ * @param manifest - The parsed manifest.
+ * @param controllers - The controllers for the Snap.
+ * @param controllers.permissionController - The permission controller.
+ * @param controllers.subjectMetadataController - The subject metadata controller.
+ */
+export declare function registerSnap(snapId: SnapId, manifest: SnapManifest, { permissionController, subjectMetadataController, }: Omit<Controllers, 'interfaceController'>): Promise<void>;
+//# sourceMappingURL=controllers.d.mts.map

package/dist/controllers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controllers.d.mts","sourceRoot":"","sources":["../src/controllers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAAkC;AACrE,OAAO,KAAK,EACV,6BAA6B,EAC7B,iCAAiC,EACjC,2BAA2B,EAC3B,gCAAgC,EACjC,wCAAwC;AACzC,OAAO,EACL,oBAAoB,EACpB,yBAAyB,EAE1B,wCAAwC;AACzC,OAAO,EAAE,uBAAuB,EAAE,oCAAoC;AACtE,OAAO,KAAK,EACV,uBAAuB,EACvB,8BAA8B,EAC9B,qCAAqC,EACtC,oCAAoC;AAMrC,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,8BAA8B;AAK1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,sBAAkB;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,yBAAqB;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,0BAAgB;AAE/C,MAAM,MAAM,4BAA4B,GACpC,8BAA8B,GAC9B,qCAAqC,GACrC,2BAA2B,GAC3B,uBAAuB,GACvB,gCAAgC,CAAC;AAErC,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,CACvD,4BAA4B,EAC5B,GAAG,CACJ,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,mBAAmB,EAAE,mBAAmB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACnD,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,oBAAoB,EAAE,oBAAoB,CACxC,iCAAiC,EACjC,6BAA6B,CAC9B,CAAC;IACF,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,mBAAmB,EAAE,uBAAuB,CAAC;CAC9C,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,WAAW,CA+B1E;AAoCD;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,YAAY,EACtB,EACE,oBAAoB,EACpB,yBAAyB,GAC1B,EAAE,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,iBAgB5C"}

package/dist/controllers.mjs

@@ -0,0 +1,96 @@
+import { PermissionController, SubjectMetadataController, SubjectType } from "@metamask/permission-controller";
+import { SnapInterfaceController } from "@metamask/snaps-controllers";
+import { caveatSpecifications as snapsCaveatsSpecifications, endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications, processSnapPermissions } from "@metamask/snaps-rpc-methods";
+import { getSafeJson } from "@metamask/utils";
+import { getPermissionSpecifications } from "./methods/index.mjs";
+import { UNRESTRICTED_METHODS } from "./methods/constants.mjs";
+/**
+ * Get the controllers for the Snap.
+ *
+ * @param options - The options.
+ * @returns The controllers for the Snap.
+ */
+export function getControllers(options) {
+    const { controllerMessenger } = options;
+    const subjectMetadataController = new SubjectMetadataController({
+        messenger: controllerMessenger.getRestricted({
+            name: 'SubjectMetadataController',
+            allowedActions: [],
+            allowedEvents: [],
+        }),
+        subjectCacheLimit: 100,
+    });
+    const interfaceController = new SnapInterfaceController({
+        messenger: controllerMessenger.getRestricted({
+            name: 'SnapInterfaceController',
+            allowedActions: [
+                'PhishingController:maybeUpdateState',
+                'PhishingController:testOrigin',
+                'ApprovalController:hasRequest',
+                'ApprovalController:acceptRequest',
+            ],
+            allowedEvents: [],
+        }),
+    });
+    const permissionController = getPermissionController(options);
+    return {
+        permissionController,
+        subjectMetadataController,
+        interfaceController,
+    };
+}
+/**
+ * Get the permission controller for the Snap.
+ *
+ * @param options - The options.
+ * @param options.controllerMessenger - The controller messenger.
+ * @param options.options - Miscellaneous options.
+ * @returns The permission controller for the Snap.
+ */
+function getPermissionController(options) {
+    const { controllerMessenger } = options;
+    const permissionSpecifications = getPermissionSpecifications(options);
+    return new PermissionController({
+        messenger: controllerMessenger.getRestricted({
+            name: 'PermissionController',
+            allowedActions: [
+                `ApprovalController:addRequest`,
+                `ApprovalController:hasRequest`,
+                `ApprovalController:acceptRequest`,
+                `ApprovalController:rejectRequest`,
+                `SnapController:getPermitted`,
+                `SnapController:install`,
+                `SubjectMetadataController:getSubjectMetadata`,
+            ],
+            allowedEvents: [],
+        }),
+        caveatSpecifications: {
+            ...snapsCaveatsSpecifications,
+            ...snapsEndowmentCaveatSpecifications,
+        },
+        permissionSpecifications,
+        unrestrictedMethods: UNRESTRICTED_METHODS,
+    });
+}
+/**
+ * Register the Snap. This sets up the Snap's permissions and subject metadata.
+ *
+ * @param snapId - The ID of the Snap to install.
+ * @param manifest - The parsed manifest.
+ * @param controllers - The controllers for the Snap.
+ * @param controllers.permissionController - The permission controller.
+ * @param controllers.subjectMetadataController - The subject metadata controller.
+ */
+export async function registerSnap(snapId, manifest, { permissionController, subjectMetadataController, }) {
+    subjectMetadataController.addSubjectMetadata({
+        origin: snapId,
+        subjectType: SubjectType.Snap,
+    });
+    const approvedPermissions = processSnapPermissions(getSafeJson(manifest.initialPermissions));
+    permissionController.grantPermissions({
+        approvedPermissions,
+        subject: { origin: snapId },
+        preserveExistingPermissions: false,
+    });
+}
+//# sourceMappingURL=controllers.mjs.map

package/dist/controllers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"controllers.mjs","sourceRoot":"","sources":["../src/controllers.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,oBAAoB,EACpB,yBAAyB,EACzB,WAAW,EACZ,wCAAwC;AACzC,OAAO,EAAE,uBAAuB,EAAE,oCAAoC;AAMtE,OAAO,EACL,oBAAoB,IAAI,0BAA0B,EAClD,6BAA6B,IAAI,kCAAkC,EACnE,sBAAsB,EACvB,oCAAoC;AAGrC,OAAO,EAAE,WAAW,EAAE,wBAAwB;AAE9C,OAAO,EAAE,2BAA2B,EAAE,4BAAkB;AACxD,OAAO,EAAE,oBAAoB,EAAE,gCAA4B;AAiC3D;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,OAA8B;IAC3D,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC;IACxC,MAAM,yBAAyB,GAAG,IAAI,yBAAyB,CAAC;QAC9D,SAAS,EAAE,mBAAmB,CAAC,aAAa,CAAC;YAC3C,IAAI,EAAE,2BAA2B;YACjC,cAAc,EAAE,EAAE;YAClB,aAAa,EAAE,EAAE;SAClB,CAAC;QACF,iBAAiB,EAAE,GAAG;KACvB,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,IAAI,uBAAuB,CAAC;QACtD,SAAS,EAAE,mBAAmB,CAAC,aAAa,CAAC;YAC3C,IAAI,EAAE,yBAAyB;YAC/B,cAAc,EAAE;gBACd,qCAAqC;gBACrC,+BAA+B;gBAC/B,+BAA+B;gBAC/B,kCAAkC;aACnC;YACD,aAAa,EAAE,EAAE;SAClB,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE9D,OAAO;QACL,oBAAoB;QACpB,yBAAyB;QACzB,mBAAmB;KACpB,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,uBAAuB,CAAC,OAA8B;IAC7D,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC;IACxC,MAAM,wBAAwB,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC;IACtE,OAAO,IAAI,oBAAoB,CAAC;QAC9B,SAAS,EAAE,mBAAmB,CAAC,aAAa,CAAC;YAC3C,IAAI,EAAE,sBAAsB;YAC5B,cAAc,EAAE;gBACd,+BAA+B;gBAC/B,+BAA+B;gBAC/B,kCAAkC;gBAClC,kCAAkC;gBAClC,6BAA6B;gBAC7B,wBAAwB;gBACxB,8CAA8C;aAC/C;YACD,aAAa,EAAE,EAAE;SAClB,CAAC;QACF,oBAAoB,EAAE;YACpB,GAAG,0BAA0B;YAC7B,GAAG,kCAAkC;SACtC;QACD,wBAAwB;QACxB,mBAAmB,EAAE,oBAAoB;KAC1C,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAc,EACd,QAAsB,EACtB,EACE,oBAAoB,EACpB,yBAAyB,GACgB;IAE3C,yBAAyB,CAAC,kBAAkB,CAAC;QAC3C,MAAM,EAAE,MAAM;QACd,WAAW,EAAE,WAAW,CAAC,IAAI;KAC9B,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,sBAAsB,CAChD,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CACzC,CAAC;IAEF,oBAAoB,CAAC,gBAAgB,CAAC;QACpC,mBAAmB;QACnB,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;QAC3B,2BAA2B,EAAE,KAAK;KACnC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { ControllerMessenger } from '@metamask/base-controller';\nimport type {\n  CaveatSpecificationConstraint,\n  PermissionSpecificationConstraint,\n  PermissionControllerActions,\n  SubjectMetadataControllerActions,\n} from '@metamask/permission-controller';\nimport {\n  PermissionController,\n  SubjectMetadataController,\n  SubjectType,\n} from '@metamask/permission-controller';\nimport { SnapInterfaceController } from '@metamask/snaps-controllers';\nimport type {\n  ExecutionServiceActions,\n  SnapInterfaceControllerActions,\n  SnapInterfaceControllerAllowedActions,\n} from '@metamask/snaps-controllers';\nimport {\n  caveatSpecifications as snapsCaveatsSpecifications,\n  endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,\n  processSnapPermissions,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport type { SnapManifest } from '@metamask/snaps-utils';\nimport { getSafeJson } from '@metamask/utils';\n\nimport { getPermissionSpecifications } from './methods';\nimport { UNRESTRICTED_METHODS } from './methods/constants';\nimport type { SimulationOptions } from './options';\nimport type { MiddlewareHooks } from './simulation';\nimport type { RunSagaFunction } from './store';\n\nexport type RootControllerAllowedActions =\n  | SnapInterfaceControllerActions\n  | SnapInterfaceControllerAllowedActions\n  | PermissionControllerActions\n  | ExecutionServiceActions\n  | SubjectMetadataControllerActions;\n\nexport type RootControllerMessenger = ControllerMessenger<\n  RootControllerAllowedActions,\n  any\n>;\n\nexport type GetControllersOptions = {\n  controllerMessenger: ControllerMessenger<any, any>;\n  hooks: MiddlewareHooks;\n  runSaga: RunSagaFunction;\n  options: SimulationOptions;\n};\n\nexport type Controllers = {\n  permissionController: PermissionController<\n    PermissionSpecificationConstraint,\n    CaveatSpecificationConstraint\n  >;\n  subjectMetadataController: SubjectMetadataController;\n  interfaceController: SnapInterfaceController;\n};\n\n/**\n * Get the controllers for the Snap.\n *\n * @param options - The options.\n * @returns The controllers for the Snap.\n */\nexport function getControllers(options: GetControllersOptions): Controllers {\n  const { controllerMessenger } = options;\n  const subjectMetadataController = new SubjectMetadataController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'SubjectMetadataController',\n      allowedActions: [],\n      allowedEvents: [],\n    }),\n    subjectCacheLimit: 100,\n  });\n\n  const interfaceController = new SnapInterfaceController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'SnapInterfaceController',\n      allowedActions: [\n        'PhishingController:maybeUpdateState',\n        'PhishingController:testOrigin',\n        'ApprovalController:hasRequest',\n        'ApprovalController:acceptRequest',\n      ],\n      allowedEvents: [],\n    }),\n  });\n\n  const permissionController = getPermissionController(options);\n\n  return {\n    permissionController,\n    subjectMetadataController,\n    interfaceController,\n  };\n}\n\n/**\n * Get the permission controller for the Snap.\n *\n * @param options - The options.\n * @param options.controllerMessenger - The controller messenger.\n * @param options.options - Miscellaneous options.\n * @returns The permission controller for the Snap.\n */\nfunction getPermissionController(options: GetControllersOptions) {\n  const { controllerMessenger } = options;\n  const permissionSpecifications = getPermissionSpecifications(options);\n  return new PermissionController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'PermissionController',\n      allowedActions: [\n        `ApprovalController:addRequest`,\n        `ApprovalController:hasRequest`,\n        `ApprovalController:acceptRequest`,\n        `ApprovalController:rejectRequest`,\n        `SnapController:getPermitted`,\n        `SnapController:install`,\n        `SubjectMetadataController:getSubjectMetadata`,\n      ],\n      allowedEvents: [],\n    }),\n    caveatSpecifications: {\n      ...snapsCaveatsSpecifications,\n      ...snapsEndowmentCaveatSpecifications,\n    },\n    permissionSpecifications,\n    unrestrictedMethods: UNRESTRICTED_METHODS,\n  });\n}\n\n/**\n * Register the Snap. This sets up the Snap's permissions and subject metadata.\n *\n * @param snapId - The ID of the Snap to install.\n * @param manifest - The parsed manifest.\n * @param controllers - The controllers for the Snap.\n * @param controllers.permissionController - The permission controller.\n * @param controllers.subjectMetadataController - The subject metadata controller.\n */\nexport async function registerSnap(\n  snapId: SnapId,\n  manifest: SnapManifest,\n  {\n    permissionController,\n    subjectMetadataController,\n  }: Omit<Controllers, 'interfaceController'>,\n) {\n  subjectMetadataController.addSubjectMetadata({\n    origin: snapId,\n    subjectType: SubjectType.Snap,\n  });\n\n  const approvedPermissions = processSnapPermissions(\n    getSafeJson(manifest.initialPermissions),\n  );\n\n  permissionController.grantPermissions({\n    approvedPermissions,\n    subject: { origin: snapId },\n    preserveExistingPermissions: false,\n  });\n}\n"]}

package/dist/files.cjs

@@ -0,0 +1,94 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFileToUpload = exports.getFileSize = exports.getContentType = exports.getSnapFile = void 0;
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const promises_1 = require("fs/promises");
+const mime_1 = __importDefault(require("mime/index.js"));
+const path_1 = require("path");
+/**
+ * Get a statically defined Snap file from an array of files.
+ *
+ * @param files - The Snap files.
+ * @param path - The file path.
+ * @param encoding - The requested file encoding.
+ * @returns The file in the requested encoding if found, otherwise null.
+ */
+async function getSnapFile(files, path, encoding = snaps_sdk_1.AuxiliaryFileEncoding.Base64) {
+    const normalizedPath = (0, snaps_utils_1.normalizeRelative)(path);
+    const base64 = files
+        .find((file) => file.path === normalizedPath)
+        ?.toString('base64');
+    if (!base64) {
+        return null;
+    }
+    return await (0, snaps_utils_1.encodeAuxiliaryFile)(base64, encoding);
+}
+exports.getSnapFile = getSnapFile;
+/**
+ * Get the content type of a file based on its extension.
+ *
+ * @param extension - The file extension.
+ * @returns The content type of the file. If the content type cannot be inferred
+ * from the extension, `application/octet-stream` is returned.
+ */
+function getContentType(extension) {
+    return mime_1.default.getType(extension) ?? 'application/octet-stream';
+}
+exports.getContentType = getContentType;
+/**
+ * Get the size of a file, from a file path or a `Uint8Array`.
+ *
+ * @param file - The file to get the size of. This can be a path to a file or a
+ * `Uint8Array` containing the file contents. If this is a path, the file is
+ * resolved relative to the current working directory.
+ * @returns The size of the file in bytes.
+ */
+async function getFileSize(file) {
+    if (typeof file === 'string') {
+        const { size } = await (0, promises_1.stat)((0, path_1.resolve)(process.cwd(), file));
+        return size;
+    }
+    return file.length;
+}
+exports.getFileSize = getFileSize;
+/**
+ * Get a file object to upload, from a file path or a `Uint8Array`, with an
+ * optional file name and content type.
+ *
+ * @param file - The file to upload. This can be a path to a file or a
+ * `Uint8Array` containing the file contents. If this is a path, the file is
+ * resolved relative to the current working directory.
+ * @param options - The file options.
+ * @param options.fileName - The name of the file. By default, this is
+ * inferred from the file path if it's a path, and defaults to an empty string
+ * if it's a `Uint8Array`.
+ * @param options.contentType - The content type of the file. By default, this
+ * is inferred from the file name if it's a path, and defaults to
+ * `application/octet-stream` if it's a `Uint8Array` or the content type
+ * cannot be inferred from the file name.
+ * @returns The file object to upload.
+ */
+async function getFileToUpload(file, { fileName, contentType } = {}) {
+    if (typeof file === 'string') {
+        const buffer = await (0, promises_1.readFile)((0, path_1.resolve)(process.cwd(), file));
+        return {
+            name: fileName ?? (0, path_1.basename)(file),
+            size: buffer.byteLength,
+            contentType: contentType ?? getContentType((0, path_1.extname)(file)),
+            contents: (0, utils_1.bytesToBase64)(buffer),
+        };
+    }
+    return {
+        name: fileName ?? '',
+        size: file.length,
+        contentType: contentType ?? 'application/octet-stream',
+        contents: (0, utils_1.bytesToBase64)(file),
+    };
+}
+exports.getFileToUpload = getFileToUpload;
+//# sourceMappingURL=files.cjs.map

package/dist/files.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.cjs","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":";;;;;;AACA,mDAA4D;AAE5D,uDAA+E;AAC/E,2CAAgD;AAChD,0CAA6C;AAC7C,yDAAwB;AACxB,+BAAkD;AAIlD;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,KAAoB,EACpB,IAAY,EACZ,WAAkC,iCAAqB,CAAC,MAAM;IAE9D,MAAM,cAAc,GAAG,IAAA,+BAAiB,EAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,KAAK;SACjB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC;QAC7C,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEvB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,IAAA,iCAAmB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACrD,CAAC;AAfD,kCAeC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,SAAiB;IAC9C,OAAO,cAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,0BAA0B,CAAC;AAC/D,CAAC;AAFD,wCAEC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAAC,IAAyB;IACzD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAA,eAAI,EAAC,IAAA,cAAO,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,IAAI,CAAC,MAAM,CAAC;AACrB,CAAC;AAPD,kCAOC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,eAAe,CACnC,IAAyB,EACzB,EAAE,QAAQ,EAAE,WAAW,KAAkB,EAAE;IAE3C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAQ,EAAC,IAAA,cAAO,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;QAE5D,OAAO;YACL,IAAI,EAAE,QAAQ,IAAI,IAAA,eAAQ,EAAC,IAAI,CAAC;YAChC,IAAI,EAAE,MAAM,CAAC,UAAU;YACvB,WAAW,EAAE,WAAW,IAAI,cAAc,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;YACzD,QAAQ,EAAE,IAAA,qBAAa,EAAC,MAAM,CAAC;SAChC,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI,EAAE,QAAQ,IAAI,EAAE;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM;QACjB,WAAW,EAAE,WAAW,IAAI,0BAA0B;QACtD,QAAQ,EAAE,IAAA,qBAAa,EAAC,IAAI,CAAC;KAC9B,CAAC;AACJ,CAAC;AArBD,0CAqBC","sourcesContent":["import type { File } from '@metamask/snaps-sdk';\nimport { AuxiliaryFileEncoding } from '@metamask/snaps-sdk';\nimport type { VirtualFile } from '@metamask/snaps-utils';\nimport { encodeAuxiliaryFile, normalizeRelative } from '@metamask/snaps-utils';\nimport { bytesToBase64 } from '@metamask/utils';\nimport { readFile, stat } from 'fs/promises';\nimport mime from 'mime';\nimport { basename, extname, resolve } from 'path';\n\nimport type { FileOptions } from './types';\n\n/**\n * Get a statically defined Snap file from an array of files.\n *\n * @param files - The Snap files.\n * @param path - The file path.\n * @param encoding - The requested file encoding.\n * @returns The file in the requested encoding if found, otherwise null.\n */\nexport async function getSnapFile(\n  files: VirtualFile[],\n  path: string,\n  encoding: AuxiliaryFileEncoding = AuxiliaryFileEncoding.Base64,\n) {\n  const normalizedPath = normalizeRelative(path);\n  const base64 = files\n    .find((file) => file.path === normalizedPath)\n    ?.toString('base64');\n\n  if (!base64) {\n    return null;\n  }\n\n  return await encodeAuxiliaryFile(base64, encoding);\n}\n\n/**\n * Get the content type of a file based on its extension.\n *\n * @param extension - The file extension.\n * @returns The content type of the file. If the content type cannot be inferred\n * from the extension, `application/octet-stream` is returned.\n */\nexport function getContentType(extension: string) {\n  return mime.getType(extension) ?? 'application/octet-stream';\n}\n\n/**\n * Get the size of a file, from a file path or a `Uint8Array`.\n *\n * @param file - The file to get the size of. This can be a path to a file or a\n * `Uint8Array` containing the file contents. If this is a path, the file is\n * resolved relative to the current working directory.\n * @returns The size of the file in bytes.\n */\nexport async function getFileSize(file: string | Uint8Array) {\n  if (typeof file === 'string') {\n    const { size } = await stat(resolve(process.cwd(), file));\n    return size;\n  }\n\n  return file.length;\n}\n\n/**\n * Get a file object to upload, from a file path or a `Uint8Array`, with an\n * optional file name and content type.\n *\n * @param file - The file to upload. This can be a path to a file or a\n * `Uint8Array` containing the file contents. If this is a path, the file is\n * resolved relative to the current working directory.\n * @param options - The file options.\n * @param options.fileName - The name of the file. By default, this is\n * inferred from the file path if it's a path, and defaults to an empty string\n * if it's a `Uint8Array`.\n * @param options.contentType - The content type of the file. By default, this\n * is inferred from the file name if it's a path, and defaults to\n * `application/octet-stream` if it's a `Uint8Array` or the content type\n * cannot be inferred from the file name.\n * @returns The file object to upload.\n */\nexport async function getFileToUpload(\n  file: string | Uint8Array,\n  { fileName, contentType }: FileOptions = {},\n): Promise<File> {\n  if (typeof file === 'string') {\n    const buffer = await readFile(resolve(process.cwd(), file));\n\n    return {\n      name: fileName ?? basename(file),\n      size: buffer.byteLength,\n      contentType: contentType ?? getContentType(extname(file)),\n      contents: bytesToBase64(buffer),\n    };\n  }\n\n  return {\n    name: fileName ?? '',\n    size: file.length,\n    contentType: contentType ?? 'application/octet-stream',\n    contents: bytesToBase64(file),\n  };\n}\n"]}

package/dist/files.d.cts

@@ -0,0 +1,49 @@
+import type { File } from "@metamask/snaps-sdk";
+import { AuxiliaryFileEncoding } from "@metamask/snaps-sdk";
+import type { VirtualFile } from "@metamask/snaps-utils";
+import type { FileOptions } from "./types.cjs";
+/**
+ * Get a statically defined Snap file from an array of files.
+ *
+ * @param files - The Snap files.
+ * @param path - The file path.
+ * @param encoding - The requested file encoding.
+ * @returns The file in the requested encoding if found, otherwise null.
+ */
+export declare function getSnapFile(files: VirtualFile[], path: string, encoding?: AuxiliaryFileEncoding): Promise<string | null>;
+/**
+ * Get the content type of a file based on its extension.
+ *
+ * @param extension - The file extension.
+ * @returns The content type of the file. If the content type cannot be inferred
+ * from the extension, `application/octet-stream` is returned.
+ */
+export declare function getContentType(extension: string): string;
+/**
+ * Get the size of a file, from a file path or a `Uint8Array`.
+ *
+ * @param file - The file to get the size of. This can be a path to a file or a
+ * `Uint8Array` containing the file contents. If this is a path, the file is
+ * resolved relative to the current working directory.
+ * @returns The size of the file in bytes.
+ */
+export declare function getFileSize(file: string | Uint8Array): Promise<number>;
+/**
+ * Get a file object to upload, from a file path or a `Uint8Array`, with an
+ * optional file name and content type.
+ *
+ * @param file - The file to upload. This can be a path to a file or a
+ * `Uint8Array` containing the file contents. If this is a path, the file is
+ * resolved relative to the current working directory.
+ * @param options - The file options.
+ * @param options.fileName - The name of the file. By default, this is
+ * inferred from the file path if it's a path, and defaults to an empty string
+ * if it's a `Uint8Array`.
+ * @param options.contentType - The content type of the file. By default, this
+ * is inferred from the file name if it's a path, and defaults to
+ * `application/octet-stream` if it's a `Uint8Array` or the content type
+ * cannot be inferred from the file name.
+ * @returns The file object to upload.
+ */
+export declare function getFileToUpload(file: string | Uint8Array, { fileName, contentType }?: FileOptions): Promise<File>;
+//# sourceMappingURL=files.d.cts.map

package/dist/files.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.cts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,4BAA4B;AAChD,OAAO,EAAE,qBAAqB,EAAE,4BAA4B;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AAOzD,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAgB;AAE3C;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAC/B,KAAK,EAAE,WAAW,EAAE,EACpB,IAAI,EAAE,MAAM,EACZ,QAAQ,GAAE,qBAAoD,0BAY/D;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,UAE/C;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,mBAO1D;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,eAAe,CACnC,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAE,WAAgB,GAC1C,OAAO,CAAC,IAAI,CAAC,CAkBf"}