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

package/CHANGELOG.md

@@ -6,52 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.35.1-flask.1]
-### Changed
-- No changes this release.
-
-## [0.35.0-flask.1]
+## [1.0.0-prerelease.1]
 ### Added
-- Add `snap_manageAccounts` RPC method ([#1290](https://github.com/MetaMask/snaps/pull/1290))
+- Add subject type restrictions to snap-specific permissions ([#1366](https://github.com/MetaMask/snaps/pull/1366))
 
 ### Changed
-- **BREAKING:** Build packages as both CJS and ESM ([#1519](https://github.com/MetaMask/snaps/pull/1519), ([#1532](https://github.com/MetaMask/snaps/pull/1532)))
-  - This is breaking in the sense that imports to `dist/` will now require you to import either `dist/cjs` or `dist/esm`.
 - **BREAKING:** Disallow deriving Ethereum keys ([#1217](https://github.com/MetaMask/snaps/pull/1217))
-  - Coin type `60` is now blocked for derivation.
-- Add `sideEffects: false` ([#1486](https://github.com/MetaMask/snaps/pull/1486))
-
-### Removed
-- **BREAKING:** Remove utility functions used for multichain/keyring effort ([#1527](https://github.com/MetaMask/snaps/pull/1527))
+  - Coin type `60` is now blocked for derivation. 
 
 ### Fixed
 - Improve JSON parsing safety ([#1499](https://github.com/MetaMask/snaps/pull/1499))
-- Fix false positives when post processing code with HTML comment tokens ([#1522](https://github.com/MetaMask/snaps/pull/1522))
-- Fix BIP-32 path validation ([#1506](https://github.com/MetaMask/snaps/pull/1506))
-
-## [0.34.1-flask.1]
-### Changed
-- No changes this release.
-
-## [0.34.0-flask.1]
-### Changed
-- Add SVG validation ([#1401](https://github.com/MetaMask/snaps/pull/1401))
-- Make handler types generic, allowing them to be changed ([#1409](https://github.com/MetaMask/snaps/pull/1409))
-- Allow use of `$schema` in manifest files ([#1389](https://github.com/MetaMask/snaps/pull/1389))
-
-## [0.33.1-flask.1]
-### Changed
-- No changes this release.
-
-## [0.33.0-flask.1]
-### Changed
-- **BREAKING:** Added `snapIds` caveat mapper ([#1360](https://github.com/MetaMask/snaps-monorepo/pull/1360))
-  - Snap dependencies must be specified in a simplified manner. See the PR for an example.
-- Add subject type restrictions to snap-specific permissions ([#1366](https://github.com/MetaMask/snaps-monorepo/pull/1366))
-- Add Web Worker support for snap execution ([#1320](https://github.com/MetaMask/snaps-monorepo/pull/1320))
-
-### Fixed
-- Add `WebAssembly` to eval mock ([#1359](https://github.com/MetaMask/snaps-monorepo/pull/1359))
 
 ## [0.32.2]
 ### Changed
@@ -230,13 +194,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release ([#410](https://github.com/MetaMask/snaps-monorepo/pull/410), [#421](https://github.com/MetaMask/snaps-monorepo/pull/421))
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/v0.35.1-flask.1...HEAD
-[0.35.1-flask.1]: https://github.com/MetaMask/snaps/compare/v0.35.0-flask.1...v0.35.1-flask.1
-[0.35.0-flask.1]: https://github.com/MetaMask/snaps/compare/v0.34.1-flask.1...v0.35.0-flask.1
-[0.34.1-flask.1]: https://github.com/MetaMask/snaps/compare/v0.34.0-flask.1...v0.34.1-flask.1
-[0.34.0-flask.1]: https://github.com/MetaMask/snaps/compare/v0.33.1-flask.1...v0.34.0-flask.1
-[0.33.1-flask.1]: https://github.com/MetaMask/snaps/compare/v0.33.0-flask.1...v0.33.1-flask.1
-[0.33.0-flask.1]: https://github.com/MetaMask/snaps/compare/v0.32.2...v0.33.0-flask.1
+[Unreleased]: https://github.com/MetaMask/snaps/compare/v1.0.0-prerelease.1...HEAD
+[1.0.0-prerelease.1]: https://github.com/MetaMask/snaps/compare/v0.32.2...v1.0.0-prerelease.1
 [0.32.2]: https://github.com/MetaMask/snaps/compare/v0.32.1...v0.32.2
 [0.32.1]: https://github.com/MetaMask/snaps/compare/v0.32.0...v0.32.1
 [0.32.0]: https://github.com/MetaMask/snaps/compare/v0.31.0...v0.32.0

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

@@ -1,3 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEqual = void 0;
 /**
  * Checks if array `a` is equal to array `b`. Note that this does not do a deep
  * equality check. It only checks if the arrays are the same length and if each
@@ -6,8 +9,9 @@
  * @param a - The first array to compare.
  * @param b - The second array to compare.
  * @returns `true` if the arrays are equal, `false` otherwise.
- */ export function isEqual(a, b) {
-    return a.length === b.length && a.every((value, index)=>value === b[index]);
+ */
+function isEqual(a, b) {
+    return a.length === b.length && a.every((value, index) => value === b[index]);
 }
-
+exports.isEqual = isEqual;
 //# sourceMappingURL=array.js.map

package/dist/array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../src/array.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;GAQG;AACH,SAAgB,OAAO,CAAC,CAAY,EAAE,CAAY;IAChD,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAChF,CAAC;AAFD,0BAEC","sourcesContent":["/**\n * Checks if array `a` is equal to array `b`. Note that this does not do a deep\n * equality check. It only checks if the arrays are the same length and if each\n * element in `a` is equal to (`===`) the corresponding element in `b`.\n *\n * @param a - The first array to compare.\n * @param b - The second array to compare.\n * @returns `true` if the arrays are equal, `false` otherwise.\n */\nexport function isEqual(a: unknown[], b: unknown[]): boolean {\n  return a.length === b.length && a.every((value, index) => value === b[index]);\n}\n"]}

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

@@ -7,6 +7,10 @@ export declare enum SnapCaveatType {
      * Permitted coin types, used by `snap_getBip44Entropy`.
      */
     PermittedCoinTypes = "permittedCoinTypes",
+    /**
+     * Permission to use the Snap keyring API.
+     */
+    SnapKeyring = "snapKeyring",
     /**
      * Caveat specifying a snap cronjob.
      */

package/dist/caveats.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnapCaveatType = void 0;
+var SnapCaveatType;
+(function (SnapCaveatType) {
+    /**
+     * Permitted derivation paths, used by `snap_getBip32Entropy`.
+     */
+    SnapCaveatType["PermittedDerivationPaths"] = "permittedDerivationPaths";
+    /**
+     * Permitted coin types, used by `snap_getBip44Entropy`.
+     */
+    SnapCaveatType["PermittedCoinTypes"] = "permittedCoinTypes";
+    /**
+     * Permission to use the Snap keyring API.
+     */
+    SnapCaveatType["SnapKeyring"] = "snapKeyring";
+    /**
+     * Caveat specifying a snap cronjob.
+     */
+    SnapCaveatType["SnapCronjob"] = "snapCronjob";
+    /**
+     * Caveat specifying access to the transaction origin, used by `endowment:transaction-insight`.
+     */
+    SnapCaveatType["TransactionOrigin"] = "transactionOrigin";
+    /**
+     * The origins that a Snap can receive JSON-RPC messages from.
+     */
+    SnapCaveatType["RpcOrigin"] = "rpcOrigin";
+    /**
+     * Caveat specifying the snap IDs that can be interacted with.
+     */
+    SnapCaveatType["SnapIds"] = "snapIds";
+})(SnapCaveatType = exports.SnapCaveatType || (exports.SnapCaveatType = {}));
+//# sourceMappingURL=caveats.js.map

package/dist/caveats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"caveats.js","sourceRoot":"","sources":["../src/caveats.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAmCX;AAnCD,WAAY,cAAc;IACxB;;OAEG;IACH,uEAAqD,CAAA;IAErD;;OAEG;IACH,2DAAyC,CAAA;IAEzC;;OAEG;IACH,6CAA2B,CAAA;IAE3B;;OAEG;IACH,6CAA2B,CAAA;IAE3B;;OAEG;IACH,yDAAuC,CAAA;IAEvC;;OAEG;IACH,yCAAuB,CAAA;IAEvB;;OAEG;IACH,qCAAmB,CAAA;AACrB,CAAC,EAnCW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAmCzB","sourcesContent":["export enum SnapCaveatType {\n  /**\n   * Permitted derivation paths, used by `snap_getBip32Entropy`.\n   */\n  PermittedDerivationPaths = 'permittedDerivationPaths',\n\n  /**\n   * Permitted coin types, used by `snap_getBip44Entropy`.\n   */\n  PermittedCoinTypes = 'permittedCoinTypes',\n\n  /**\n   * Permission to use the Snap keyring API.\n   */\n  SnapKeyring = 'snapKeyring',\n\n  /**\n   * Caveat specifying a snap cronjob.\n   */\n  SnapCronjob = 'snapCronjob',\n\n  /**\n   * Caveat specifying access to the transaction origin, used by `endowment:transaction-insight`.\n   */\n  TransactionOrigin = 'transactionOrigin',\n\n  /**\n   * The origins that a Snap can receive JSON-RPC messages from.\n   */\n  RpcOrigin = 'rpcOrigin',\n\n  /**\n   * Caveat specifying the snap IDs that can be interacted with.\n   */\n  SnapIds = 'snapIds',\n}\n"]}

package/dist/checksum.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checksumFiles = exports.checksum = void 0;
+const utils_1 = require("@metamask/utils");
+const sha256_1 = require("@noble/hashes/sha256");
+const VirtualFile_1 = require("./virtual-file/VirtualFile");
+/**
+ * Calculates checksum for a single byte array.
+ *
+ * @param bytes - The byte array to calculate the checksum for.
+ * @returns A single sha-256 checksum.
+ */
+function checksum(bytes) {
+    const value = bytes instanceof VirtualFile_1.VirtualFile ? bytes.value : bytes;
+    return (0, sha256_1.sha256)(value);
+}
+exports.checksum = checksum;
+/**
+ * Calculates checksum over multiple files in a reproducible way.
+ *
+ * 1. Sort all the files by their paths.
+ * 2. Calculate sha-256 checksum of each file separately.
+ * 3. Concatenate all the checksums into one buffer and sha-256 that buffer.
+ *
+ * The sorting of paths is done using {@link https://tc39.es/ecma262/#sec-islessthan UTF-16 Code Units}.
+ *
+ * @param files - The files over which to calculate the checksum.
+ * @returns A single sha-256 checksum.
+ */
+function checksumFiles(files) {
+    return checksum((0, utils_1.concatBytes)([...files]
+        .sort((a, b) => {
+        (0, utils_1.assert)(a.path !== b.path, 'Tried to sort files with non-unique paths.');
+        if (a.path < b.path) {
+            return -1;
+        }
+        return 1;
+    })
+        .map((file) => checksum(file))));
+}
+exports.checksumFiles = checksumFiles;
+//# sourceMappingURL=checksum.js.map

package/dist/checksum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checksum.js","sourceRoot":"","sources":["../src/checksum.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AACtD,iDAA8C;AAE9C,4DAAyD;AAEzD;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,KAAwC;IAC/D,MAAM,KAAK,GAAG,KAAK,YAAY,yBAAW,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACjE,OAAO,IAAA,eAAM,EAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAHD,4BAGC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,aAAa,CAAC,KAAoB;IAChD,OAAO,QAAQ,CACb,IAAA,mBAAW,EACT,CAAC,GAAG,KAAK,CAAC;SACP,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACb,IAAA,cAAM,EACJ,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,EACjB,4CAA4C,CAC7C,CAAC;QACF,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE;YACnB,OAAO,CAAC,CAAC,CAAC;SACX;QACD,OAAO,CAAC,CAAC;IACX,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CACjC,CACF,CAAC;AACJ,CAAC;AAjBD,sCAiBC","sourcesContent":["import { assert, concatBytes } from '@metamask/utils';\nimport { sha256 } from '@noble/hashes/sha256';\n\nimport { VirtualFile } from './virtual-file/VirtualFile';\n\n/**\n * Calculates checksum for a single byte array.\n *\n * @param bytes - The byte array to calculate the checksum for.\n * @returns A single sha-256 checksum.\n */\nexport function checksum(bytes: VirtualFile | Uint8Array | string): Uint8Array {\n  const value = bytes instanceof VirtualFile ? bytes.value : bytes;\n  return sha256(value);\n}\n\n/**\n * Calculates checksum over multiple files in a reproducible way.\n *\n * 1. Sort all the files by their paths.\n * 2. Calculate sha-256 checksum of each file separately.\n * 3. Concatenate all the checksums into one buffer and sha-256 that buffer.\n *\n * The sorting of paths is done using {@link https://tc39.es/ecma262/#sec-islessthan UTF-16 Code Units}.\n *\n * @param files - The files over which to calculate the checksum.\n * @returns A single sha-256 checksum.\n */\nexport function checksumFiles(files: VirtualFile[]) {\n  return checksum(\n    concatBytes(\n      [...files]\n        .sort((a, b) => {\n          assert(\n            a.path !== b.path,\n            'Tried to sort files with non-unique paths.',\n          );\n          if (a.path < b.path) {\n            return -1;\n          }\n          return 1;\n        })\n        .map((file) => checksum(file)),\n    ),\n  );\n}\n"]}

package/dist/cronjob.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCronjobSpecificationArray = exports.CronjobSpecificationArrayStruct = exports.isCronjobSpecification = exports.CronjobSpecificationStruct = exports.parseCronExpression = exports.CronExpressionStruct = exports.CronjobRpcRequestStruct = void 0;
+const utils_1 = require("@metamask/utils");
+const cron_parser_1 = require("cron-parser");
+const superstruct_1 = require("superstruct");
+exports.CronjobRpcRequestStruct = (0, superstruct_1.assign)((0, superstruct_1.partial)((0, superstruct_1.pick)(utils_1.JsonRpcRequestStruct, ['id', 'jsonrpc'])), (0, superstruct_1.omit)(utils_1.JsonRpcRequestStruct, ['id', 'jsonrpc']));
+exports.CronExpressionStruct = (0, superstruct_1.refine)((0, superstruct_1.coerce)((0, superstruct_1.string)(), (0, superstruct_1.object)({
+    minute: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    hour: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    dayOfMonth: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    month: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    dayOfWeek: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+}), (value) => `${value.minute ?? '*'} ${value.hour ?? '*'} ${value.dayOfMonth ?? '*'} ${value.month ?? '*'} ${value.dayOfWeek ?? '*'}`), 'CronExpression', (value) => {
+    try {
+        (0, cron_parser_1.parseExpression)(value);
+        return true;
+    }
+    catch {
+        return false;
+    }
+});
+/**
+ * Parses a cron expression.
+ *
+ * @param expression - Expression to parse.
+ * @returns A CronExpression class instance.
+ */
+function parseCronExpression(expression) {
+    const ensureStringExpression = (0, superstruct_1.create)(expression, exports.CronExpressionStruct);
+    return (0, cron_parser_1.parseExpression)(ensureStringExpression);
+}
+exports.parseCronExpression = parseCronExpression;
+exports.CronjobSpecificationStruct = (0, superstruct_1.object)({
+    expression: exports.CronExpressionStruct,
+    request: exports.CronjobRpcRequestStruct,
+});
+/**
+ * Check if the given value is a {@link CronjobSpecification} object.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a valid {@link CronjobSpecification} object.
+ */
+function isCronjobSpecification(value) {
+    try {
+        (0, superstruct_1.create)(value, exports.CronjobSpecificationStruct);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+exports.isCronjobSpecification = isCronjobSpecification;
+exports.CronjobSpecificationArrayStruct = (0, superstruct_1.array)(exports.CronjobSpecificationStruct);
+/**
+ * Check if the given value is an array of {@link CronjobSpecification} objects.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a valid array of {@link CronjobSpecification} objects.
+ */
+function isCronjobSpecificationArray(value) {
+    try {
+        (0, superstruct_1.create)(value, exports.CronjobSpecificationArrayStruct);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+exports.isCronjobSpecificationArray = isCronjobSpecificationArray;
+//# sourceMappingURL=cronjob.js.map

package/dist/cronjob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cronjob.js","sourceRoot":"","sources":["../src/cronjob.ts"],"names":[],"mappings":";;;AAAA,2CAAuD;AACvD,6CAA8C;AAC9C,6CAaqB;AAER,QAAA,uBAAuB,GAAG,IAAA,oBAAM,EAC3C,IAAA,qBAAO,EAAC,IAAA,kBAAI,EAAC,4BAAoB,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EACtD,IAAA,kBAAI,EAAC,4BAAoB,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAC9C,CAAC;AAGW,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EACxC,IAAA,oBAAM,EACJ,IAAA,oBAAM,GAAE,EACR,IAAA,oBAAM,EAAC;IACL,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC1B,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IACxB,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC9B,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IACzB,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CAC9B,CAAC,EACF,CAAC,KAAK,EAAE,EAAE,CACR,GAAG,KAAK,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,IAAI,GAAG,IAAI,KAAK,CAAC,UAAU,IAAI,GAAG,IACpE,KAAK,CAAC,KAAK,IAAI,GACjB,IAAI,KAAK,CAAC,SAAS,IAAI,GAAG,EAAE,CAC/B,EACD,gBAAgB,EAChB,CAAC,KAAK,EAAE,EAAE;IACR,IAAI;QACF,IAAA,6BAAe,EAAC,KAAK,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;KACb;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC,CACF,CAAC;AAIF;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,UAA2B;IAC7D,MAAM,sBAAsB,GAAG,IAAA,oBAAM,EAAC,UAAU,EAAE,4BAAoB,CAAC,CAAC;IACxE,OAAO,IAAA,6BAAe,EAAC,sBAAsB,CAAC,CAAC;AACjD,CAAC;AAHD,kDAGC;AAEY,QAAA,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IAC/C,UAAU,EAAE,4BAAoB;IAChC,OAAO,EAAE,+BAAuB;CACjC,CAAC,CAAC;AAGH;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,KAAc;IACnD,IAAI;QACF,IAAA,oBAAM,EAAC,KAAK,EAAE,kCAA0B,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;KACb;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,wDAOC;AAEY,QAAA,+BAA+B,GAAG,IAAA,mBAAK,EAClD,kCAA0B,CAC3B,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,2BAA2B,CAAC,KAAc;IACxD,IAAI;QACF,IAAA,oBAAM,EAAC,KAAK,EAAE,uCAA+B,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;KACb;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,kEAOC","sourcesContent":["import { JsonRpcRequestStruct } from '@metamask/utils';\nimport { parseExpression } from 'cron-parser';\nimport {\n  array,\n  assign,\n  coerce,\n  create,\n  Infer,\n  object,\n  omit,\n  optional,\n  partial,\n  pick,\n  refine,\n  string,\n} from 'superstruct';\n\nexport const CronjobRpcRequestStruct = assign(\n  partial(pick(JsonRpcRequestStruct, ['id', 'jsonrpc'])),\n  omit(JsonRpcRequestStruct, ['id', 'jsonrpc']),\n);\nexport type CronjobRpcRequest = Infer<typeof CronjobRpcRequestStruct>;\n\nexport const CronExpressionStruct = refine(\n  coerce(\n    string(),\n    object({\n      minute: optional(string()),\n      hour: optional(string()),\n      dayOfMonth: optional(string()),\n      month: optional(string()),\n      dayOfWeek: optional(string()),\n    }),\n    (value) =>\n      `${value.minute ?? '*'} ${value.hour ?? '*'} ${value.dayOfMonth ?? '*'} ${\n        value.month ?? '*'\n      } ${value.dayOfWeek ?? '*'}`,\n  ),\n  'CronExpression',\n  (value) => {\n    try {\n      parseExpression(value);\n      return true;\n    } catch {\n      return false;\n    }\n  },\n);\n\nexport type CronExpression = Infer<typeof CronExpressionStruct>;\n\n/**\n * Parses a cron expression.\n *\n * @param expression - Expression to parse.\n * @returns A CronExpression class instance.\n */\nexport function parseCronExpression(expression: string | object) {\n  const ensureStringExpression = create(expression, CronExpressionStruct);\n  return parseExpression(ensureStringExpression);\n}\n\nexport const CronjobSpecificationStruct = object({\n  expression: CronExpressionStruct,\n  request: CronjobRpcRequestStruct,\n});\nexport type CronjobSpecification = Infer<typeof CronjobSpecificationStruct>;\n\n/**\n * Check if the given value is a {@link CronjobSpecification} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link CronjobSpecification} object.\n */\nexport function isCronjobSpecification(value: unknown): boolean {\n  try {\n    create(value, CronjobSpecificationStruct);\n    return true;\n  } catch {\n    return false;\n  }\n}\n\nexport const CronjobSpecificationArrayStruct = array(\n  CronjobSpecificationStruct,\n);\n\n/**\n * Check if the given value is an array of {@link CronjobSpecification} objects.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid array of {@link CronjobSpecification} objects.\n */\nexport function isCronjobSpecificationArray(value: unknown): boolean {\n  try {\n    create(value, CronjobSpecificationArrayStruct);\n    return true;\n  } catch {\n    return false;\n  }\n}\n"]}

package/dist/deep-clone.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepClone = void 0;
+const rfdc_1 = __importDefault(require("rfdc"));
+exports.deepClone = (0, rfdc_1.default)({ proto: false, circles: false });
+//# sourceMappingURL=deep-clone.js.map

package/dist/deep-clone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deep-clone.js","sourceRoot":"","sources":["../src/deep-clone.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAEX,QAAA,SAAS,GAAG,IAAA,cAAI,EAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC","sourcesContent":["import rfdc from 'rfdc';\n\nexport const deepClone = rfdc({ proto: false, circles: false });\n"]}

package/dist/{esm/default-endowments.js → default-endowments.js}

@@ -1,6 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_ENDOWMENTS = void 0;
 /**
  * Global JavaScript APIs exposed by default to all snaps.
- */ export const DEFAULT_ENDOWMENTS = Object.freeze([
+ */
+exports.DEFAULT_ENDOWMENTS = Object.freeze([
     'atob',
     'btoa',
     'BigInt',
@@ -33,7 +37,6 @@
     // https://github.com/MetaMask/snaps-monorepo/issues/662
     // https://github.com/MetaMask/snaps-monorepo/discussions/678
     'AbortController',
-    'AbortSignal'
+    'AbortSignal',
 ]);
-
 //# sourceMappingURL=default-endowments.js.map

package/dist/default-endowments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-endowments.js","sourceRoot":"","sources":["../src/default-endowments.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,kBAAkB,GAAsB,MAAM,CAAC,MAAM,CAAC;IACjE,MAAM;IACN,MAAM;IACN,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,MAAM;IACN,MAAM;IACN,YAAY;IACZ,cAAc;IACd,cAAc;IACd,aAAa;IACb,aAAa;IACb,KAAK;IACL,aAAa;IACb,eAAe;IACf,WAAW;IACX,YAAY;IACZ,mBAAmB;IACnB,YAAY;IACZ,aAAa;IACb,YAAY;IACZ,aAAa;IACb,cAAc;IACd,cAAc;IACd,eAAe;IACf,gBAAgB;IAChB,UAAU;IACV,aAAa;IACb,qFAAqF;IACrF,wDAAwD;IACxD,6DAA6D;IAC7D,iBAAiB;IACjB,aAAa;CACd,CAAC,CAAC","sourcesContent":["/**\n * Global JavaScript APIs exposed by default to all snaps.\n */\nexport const DEFAULT_ENDOWMENTS: readonly string[] = Object.freeze([\n  'atob',\n  'btoa',\n  'BigInt',\n  'console',\n  'crypto',\n  'Date',\n  'Math',\n  'setTimeout',\n  'clearTimeout',\n  'SubtleCrypto',\n  'TextDecoder',\n  'TextEncoder',\n  'URL',\n  'setInterval',\n  'clearInterval',\n  'Int8Array',\n  'Uint8Array',\n  'Uint8ClampedArray',\n  'Int16Array',\n  'Uint16Array',\n  'Int32Array',\n  'Uint32Array',\n  'Float32Array',\n  'Float64Array',\n  'BigInt64Array',\n  'BigUint64Array',\n  'DataView',\n  'ArrayBuffer',\n  // Used by fetch, but also as API for some packages that don't do network connections\n  // https://github.com/MetaMask/snaps-monorepo/issues/662\n  // https://github.com/MetaMask/snaps-monorepo/discussions/678\n  'AbortController',\n  'AbortSignal',\n]);\n"]}

package/dist/entropy.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STATE_ENCRYPTION_MAGIC_VALUE = exports.SIP_6_MAGIC_VALUE = void 0;
+// 0xd36e6170 - 0x80000000
+exports.SIP_6_MAGIC_VALUE = `1399742832'`;
+// `${bytesToNumber(keccak256('Snaps state encryption').slice(0, 4))}'`
+exports.STATE_ENCRYPTION_MAGIC_VALUE = `572232532'`;
+//# sourceMappingURL=entropy.js.map

package/dist/entropy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.js","sourceRoot":"","sources":["../src/entropy.ts"],"names":[],"mappings":";;;AAAA,0BAA0B;AACb,QAAA,iBAAiB,GAAG,aAA6B,CAAC;AAE/D,uEAAuE;AAC1D,QAAA,4BAA4B,GAAG,YAA4B,CAAC","sourcesContent":["// 0xd36e6170 - 0x80000000\nexport const SIP_6_MAGIC_VALUE = `1399742832'` as `${number}'`;\n\n// `${bytesToNumber(keccak256('Snaps state encryption').slice(0, 4))}'`\nexport const STATE_ENCRYPTION_MAGIC_VALUE = `572232532'` as `${number}'`;\n\nexport type MagicValue =\n  | typeof SIP_6_MAGIC_VALUE\n  | typeof STATE_ENCRYPTION_MAGIC_VALUE;\n"]}

package/dist/{cjs/eval-worker.js → eval-worker.js}

@@ -1,22 +1,23 @@
-// eslint-disable-next-line import/no-unassigned-import
 "use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
+// eslint-disable-next-line import/no-unassigned-import
 require("ses/lockdown");
-const _fs = require("fs");
-const _mock = require("./mock");
-const _types = require("./types");
+const fs_1 = require("fs");
+const mock_1 = require("./mock");
+const types_1 = require("./types");
 lockdown({
     consoleTaming: 'unsafe',
     errorTaming: 'unsafe',
     mathTaming: 'unsafe',
     dateTaming: 'unsafe',
     overrideTaming: 'severe',
-    // We disable domain taming, because it does not work in certain cases when
-    // running tests. This is unlikely to be a problem in production, because
-    // Node.js domains are deprecated.
-    domainTaming: 'unsafe'
+    // TODO: See if there's an easier way to do this. This file is ran in a
+    // separate process, so we can't mock SES with Jest.
+    ...(process.env.NODE_ENV === 'test'
+        ? {
+            domainTaming: 'unsafe',
+        }
+        : {}),
 });
 /**
  * Get mock endowments that don't do anything. This is useful for running the
@@ -24,28 +25,26 @@ lockdown({
  * for example.
  *
  * @returns The mock endowments.
- */ function getMockEndowments() {
-    const endowments = (0, _mock.generateMockEndowments)();
+ */
+function getMockEndowments() {
+    const endowments = (0, mock_1.generateMockEndowments)();
     return {
         ...endowments,
         window: endowments,
-        self: endowments
+        self: endowments,
     };
 }
 const snapFilePath = process.argv[2];
-const snapModule = {
-    exports: {}
-};
+const snapModule = { exports: {} };
 new Compartment({
     ...getMockEndowments(),
     module: snapModule,
-    exports: snapModule.exports
-}).evaluate((0, _fs.readFileSync)(snapFilePath, 'utf8'));
-const invalidExports = Object.keys(snapModule.exports).filter((snapExport)=>!_types.SNAP_EXPORT_NAMES.includes(snapExport));
+    exports: snapModule.exports,
+}).evaluate((0, fs_1.readFileSync)(snapFilePath, 'utf8'));
+const invalidExports = Object.keys(snapModule.exports).filter((snapExport) => !types_1.SNAP_EXPORT_NAMES.includes(snapExport));
 if (invalidExports.length > 0) {
     // eslint-disable-next-line no-console
     console.warn(`Invalid snap exports detected:\n${invalidExports.join('\n')}`);
 }
-setTimeout(()=>process.exit(0), 1000); // Hack to ensure worker exits
-
+setTimeout(() => process.exit(0), 1000); // Hack to ensure worker exits
 //# sourceMappingURL=eval-worker.js.map

package/dist/eval-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eval-worker.js","sourceRoot":"","sources":["../src/eval-worker.ts"],"names":[],"mappings":";;AAAA,uDAAuD;AACvD,wBAAsB;AAEtB,2BAAkC;AAElC,iCAAgD;AAChD,mCAAyD;AAIzD,QAAQ,CAAC;IACP,aAAa,EAAE,QAAQ;IACvB,WAAW,EAAE,QAAQ;IACrB,UAAU,EAAE,QAAQ;IACpB,UAAU,EAAE,QAAQ;IACpB,cAAc,EAAE,QAAQ;IAExB,uEAAuE;IACvE,oDAAoD;IACpD,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM;QACjC,CAAC,CAAC;YACE,YAAY,EAAE,QAAQ;SACvB;QACH,CAAC,CAAC,EAAE,CAAC;CACR,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,SAAS,iBAAiB;IACxB,MAAM,UAAU,GAAG,IAAA,6BAAsB,GAAE,CAAC;IAC5C,OAAO;QACL,GAAG,UAAU;QACb,MAAM,EAAE,UAAU;QAClB,IAAI,EAAE,UAAU;KACjB,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAErC,MAAM,UAAU,GAAsB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AAEtD,IAAI,WAAW,CAAC;IACd,GAAG,iBAAiB,EAAE;IACtB,MAAM,EAAE,UAAU;IAClB,OAAO,EAAE,UAAU,CAAC,OAAO;CAC5B,CAAC,CAAC,QAAQ,CAAC,IAAA,iBAAY,EAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;AAEhD,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,CAC3D,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,yBAAiB,CAAC,QAAQ,CAAC,UAAyB,CAAC,CACvE,CAAC;AAEF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;IAC7B,sCAAsC;IACtC,OAAO,CAAC,IAAI,CAAC,mCAAmC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;CAC9E;AAED,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,8BAA8B","sourcesContent":["// eslint-disable-next-line import/no-unassigned-import\nimport 'ses/lockdown';\n\nimport { readFileSync } from 'fs';\n\nimport { generateMockEndowments } from './mock';\nimport { HandlerType, SNAP_EXPORT_NAMES } from './types';\n\ndeclare let lockdown: any, Compartment: any;\n\nlockdown({\n  consoleTaming: 'unsafe',\n  errorTaming: 'unsafe',\n  mathTaming: 'unsafe',\n  dateTaming: 'unsafe',\n  overrideTaming: 'severe',\n\n  // TODO: See if there's an easier way to do this. This file is ran in a\n  // separate process, so we can't mock SES with Jest.\n  ...(process.env.NODE_ENV === 'test'\n    ? {\n        domainTaming: 'unsafe',\n      }\n    : {}),\n});\n\n/**\n * Get mock endowments that don't do anything. This is useful for running the\n * eval, for snaps that try to communicate with the extension on initialisation,\n * for example.\n *\n * @returns The mock endowments.\n */\nfunction getMockEndowments() {\n  const endowments = generateMockEndowments();\n  return {\n    ...endowments,\n    window: endowments,\n    self: endowments,\n  };\n}\n\nconst snapFilePath = process.argv[2];\n\nconst snapModule: { exports?: any } = { exports: {} };\n\nnew Compartment({\n  ...getMockEndowments(),\n  module: snapModule,\n  exports: snapModule.exports,\n}).evaluate(readFileSync(snapFilePath, 'utf8'));\n\nconst invalidExports = Object.keys(snapModule.exports).filter(\n  (snapExport) => !SNAP_EXPORT_NAMES.includes(snapExport as HandlerType),\n);\n\nif (invalidExports.length > 0) {\n  // eslint-disable-next-line no-console\n  console.warn(`Invalid snap exports detected:\\n${invalidExports.join('\\n')}`);\n}\n\nsetTimeout(() => process.exit(0), 1000); // Hack to ensure worker exits\n"]}

package/dist/eval.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evalBundle = void 0;
+const child_process_1 = require("child_process");
+const path_1 = require("path");
+const fs_1 = require("./fs");
+/**
+ * Spawn a new process to run the provided bundle in.
+ *
+ * @param bundlePath - The path to the bundle to run.
+ * @returns `null` if the worker ran successfully.
+ * @throws If the worker failed to run successfully.
+ */
+async function evalBundle(bundlePath) {
+    await (0, fs_1.validateFilePath)(bundlePath);
+    return new Promise((resolve, reject) => {
+        const worker = (0, child_process_1.fork)((0, path_1.join)(__dirname, 'eval-worker.js'), [bundlePath]);
+        worker.on('exit', (exitCode) => {
+            if (exitCode === 0) {
+                return resolve(null);
+            }
+            return reject(new Error(`Process exited with non-zero exit code: ${exitCode}`));
+        });
+    });
+}
+exports.evalBundle = evalBundle;
+//# sourceMappingURL=eval.js.map

package/dist/eval.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eval.js","sourceRoot":"","sources":["../src/eval.ts"],"names":[],"mappings":";;;AAAA,iDAAqC;AACrC,+BAA4B;AAE5B,6BAAwC;AAExC;;;;;;GAMG;AACI,KAAK,UAAU,UAAU,CAAC,UAAkB;IACjD,MAAM,IAAA,qBAAgB,EAAC,UAAU,CAAC,CAAC;IAEnC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAG,IAAA,oBAAI,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,gBAAgB,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;QAErE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAgB,EAAE,EAAE;YACrC,IAAI,QAAQ,KAAK,CAAC,EAAE;gBAClB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;aACtB;YAED,OAAO,MAAM,CACX,IAAI,KAAK,CAAC,2CAA2C,QAAQ,EAAE,CAAC,CACjE,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAhBD,gCAgBC","sourcesContent":["import { fork } from 'child_process';\nimport { join } from 'path';\n\nimport { validateFilePath } from './fs';\n\n/**\n * Spawn a new process to run the provided bundle in.\n *\n * @param bundlePath - The path to the bundle to run.\n * @returns `null` if the worker ran successfully.\n * @throws If the worker failed to run successfully.\n */\nexport async function evalBundle(bundlePath: string): Promise<null> {\n  await validateFilePath(bundlePath);\n\n  return new Promise((resolve, reject) => {\n    const worker = fork(join(__dirname, 'eval-worker.js'), [bundlePath]);\n\n    worker.on('exit', (exitCode: number) => {\n      if (exitCode === 0) {\n        return resolve(null);\n      }\n\n      return reject(\n        new Error(`Process exited with non-zero exit code: ${exitCode}`),\n      );\n    });\n  });\n}\n"]}