@metamask/snaps-utils 0.34.1-flask.1 → 0.35.0-flask.1

package/dist/manifest/validation.js

@@ -1,146 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSnapManifest = exports.assertIsSnapManifest = exports.isSnapManifest = exports.SnapManifestStruct = exports.PermissionsStruct = exports.SnapIdsStruct = exports.SemVerRangeStruct = exports.SnapGetBip32EntropyPermissionsStruct = exports.Bip32EntropyStruct = exports.bip32entropy = exports.Bip32PathStruct = void 0;
-const utils_1 = require("@metamask/utils");
-const superstruct_1 = require("superstruct");
-const cronjob_1 = require("../cronjob");
-const entropy_1 = require("../entropy");
-const json_rpc_1 = require("../json-rpc");
-const namespace_1 = require("../namespace");
-const snaps_1 = require("../snaps");
-const types_1 = require("../types");
-// BIP-43 purposes that cannot be used for entropy derivation. These are in the
-// string form, ending with `'`.
-const FORBIDDEN_PURPOSES = [
-    entropy_1.SIP_6_MAGIC_VALUE,
-    entropy_1.STATE_ENCRYPTION_MAGIC_VALUE,
-];
-const BIP32_INDEX_REGEX = /^\d+'?$/u;
-exports.Bip32PathStruct = (0, superstruct_1.refine)((0, superstruct_1.array)((0, superstruct_1.string)()), 'BIP-32 path', (path) => {
-    if (path.length === 0) {
-        return 'Path must be a non-empty BIP-32 derivation path array';
-    }
-    if (path[0] !== 'm') {
-        return 'Path must start with "m".';
-    }
-    if (path.length < 3) {
-        return 'Paths must have a length of at least three.';
-    }
-    if (path.slice(1).some((part) => !BIP32_INDEX_REGEX.test(part))) {
-        return 'Path must be a valid BIP-32 derivation path array.';
-    }
-    if (FORBIDDEN_PURPOSES.includes(path[1])) {
-        return `The purpose "${path[1]}" is not allowed for entropy derivation.`;
-    }
-    return true;
-});
-const bip32entropy = (struct) => (0, superstruct_1.refine)(struct, 'BIP-32 entropy', (value) => {
-    if (value.curve === 'ed25519' &&
-        value.path.slice(1).some((part) => !part.endsWith("'"))) {
-        return 'Ed25519 does not support unhardened paths.';
-    }
-    return true;
-});
-exports.bip32entropy = bip32entropy;
-// Used outside @metamask/snap-utils
-exports.Bip32EntropyStruct = (0, exports.bip32entropy)((0, superstruct_1.type)({
-    path: exports.Bip32PathStruct,
-    curve: (0, superstruct_1.enums)(['ed25519', 'secp256k1']),
-}));
-exports.SnapGetBip32EntropyPermissionsStruct = (0, superstruct_1.size)((0, superstruct_1.array)(exports.Bip32EntropyStruct), 1, Infinity);
-exports.SemVerRangeStruct = (0, superstruct_1.refine)((0, superstruct_1.string)(), 'SemVer range', (value) => {
-    if ((0, utils_1.isValidSemVerRange)(value)) {
-        return true;
-    }
-    return 'Expected a valid SemVer range.';
-});
-exports.SnapIdsStruct = (0, superstruct_1.refine)((0, superstruct_1.record)(snaps_1.SnapIdStruct, (0, superstruct_1.object)({ version: (0, superstruct_1.optional)(exports.SemVerRangeStruct) })), 'SnapIds', (value) => {
-    if (Object.keys(value).length === 0) {
-        return false;
-    }
-    return true;
-});
-/* eslint-disable @typescript-eslint/naming-convention */
-exports.PermissionsStruct = (0, superstruct_1.type)({
-    'endowment:long-running': (0, superstruct_1.optional)((0, superstruct_1.object)({})),
-    'endowment:network-access': (0, superstruct_1.optional)((0, superstruct_1.object)({})),
-    'endowment:webassembly': (0, superstruct_1.optional)((0, superstruct_1.object)({})),
-    'endowment:transaction-insight': (0, superstruct_1.optional)((0, superstruct_1.object)({
-        allowTransactionOrigin: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
-    })),
-    'endowment:cronjob': (0, superstruct_1.optional)((0, superstruct_1.object)({ jobs: cronjob_1.CronjobSpecificationArrayStruct })),
-    'endowment:rpc': (0, superstruct_1.optional)(json_rpc_1.RpcOriginsStruct),
-    snap_dialog: (0, superstruct_1.optional)((0, superstruct_1.object)({})),
-    // TODO: Remove
-    snap_confirm: (0, superstruct_1.optional)((0, superstruct_1.object)({})),
-    snap_manageState: (0, superstruct_1.optional)((0, superstruct_1.object)({})),
-    snap_notify: (0, superstruct_1.optional)((0, superstruct_1.object)({})),
-    snap_getBip32Entropy: (0, superstruct_1.optional)(exports.SnapGetBip32EntropyPermissionsStruct),
-    snap_getBip32PublicKey: (0, superstruct_1.optional)(exports.SnapGetBip32EntropyPermissionsStruct),
-    snap_getBip44Entropy: (0, superstruct_1.optional)((0, superstruct_1.size)((0, superstruct_1.array)((0, superstruct_1.object)({ coinType: (0, superstruct_1.size)((0, superstruct_1.integer)(), 0, 2 ** 32 - 1) })), 1, Infinity)),
-    snap_getEntropy: (0, superstruct_1.optional)((0, superstruct_1.object)({})),
-    'endowment:keyring': (0, superstruct_1.optional)((0, superstruct_1.object)({
-        namespaces: namespace_1.NamespacesStruct,
-    })),
-    wallet_snap: (0, superstruct_1.optional)(exports.SnapIdsStruct),
-});
-exports.SnapManifestStruct = (0, superstruct_1.object)({
-    version: utils_1.VersionStruct,
-    description: (0, superstruct_1.size)((0, superstruct_1.string)(), 1, 280),
-    proposedName: (0, superstruct_1.size)((0, superstruct_1.pattern)((0, superstruct_1.string)(), /^(?:[A-Za-z0-9-_]+( [A-Za-z0-9-_]+)*)|(?:(?:@[A-Za-z0-9-*~][A-Za-z0-9-*._~]*\/)?[A-Za-z0-9-~][A-Za-z0-9-._~]*)$/u), 1, 214),
-    repository: (0, superstruct_1.optional)((0, superstruct_1.object)({
-        type: (0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity),
-        url: (0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity),
-    })),
-    source: (0, superstruct_1.object)({
-        shasum: utils_1.ChecksumStruct,
-        location: (0, superstruct_1.object)({
-            npm: (0, superstruct_1.object)({
-                filePath: (0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity),
-                iconPath: (0, superstruct_1.optional)((0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity)),
-                packageName: types_1.NameStruct,
-                registry: (0, superstruct_1.union)([
-                    (0, superstruct_1.literal)('https://registry.npmjs.org'),
-                    (0, superstruct_1.literal)('https://registry.npmjs.org/'),
-                ]),
-            }),
-        }),
-    }),
-    initialPermissions: exports.PermissionsStruct,
-    manifestVersion: (0, superstruct_1.literal)('0.1'),
-    $schema: (0, superstruct_1.optional)((0, superstruct_1.string)()), // enables JSON-Schema linting in VSC and other IDEs
-});
-/**
- * Check if the given value is a valid {@link SnapManifest} object.
- *
- * @param value - The value to check.
- * @returns Whether the value is a valid {@link SnapManifest} object.
- */
-function isSnapManifest(value) {
-    return (0, superstruct_1.is)(value, exports.SnapManifestStruct);
-}
-exports.isSnapManifest = isSnapManifest;
-/**
- * Assert that the given value is a valid {@link SnapManifest} object.
- *
- * @param value - The value to check.
- * @throws If the value is not a valid {@link SnapManifest} object.
- */
-function assertIsSnapManifest(value) {
-    (0, utils_1.assertStruct)(value, exports.SnapManifestStruct, `"${types_1.NpmSnapFileNames.Manifest}" is invalid`);
-}
-exports.assertIsSnapManifest = assertIsSnapManifest;
-/**
- * Creates a {@link SnapManifest} object from JSON.
- *
- *
- * @param value - The value to check.
- * @throws If the value cannot be coerced to a {@link SnapManifest} object.
- * @returns The created {@link SnapManifest} object.
- */
-function createSnapManifest(value) {
-    // TODO: Add a utility to prefix these errors similar to assertStruct
-    return (0, superstruct_1.create)(value, exports.SnapManifestStruct);
-}
-exports.createSnapManifest = createSnapManifest;
-//# sourceMappingURL=validation.js.map

package/dist/manifest/validation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/manifest/validation.ts"],"names":[],"mappings":";;;AAAA,2CAKyB;AACzB,6CAmBqB;AAErB,wCAA6D;AAC7D,wCAA6E;AAC7E,0CAA+C;AAC/C,4CAAgD;AAChD,oCAAwC;AACxC,oCAAwD;AAExD,+EAA+E;AAC/E,gCAAgC;AAChC,MAAM,kBAAkB,GAAa;IACnC,2BAAiB;IACjB,sCAA4B;CAC7B,CAAC;AAEF,MAAM,iBAAiB,GAAG,UAAU,CAAC;AACxB,QAAA,eAAe,GAAG,IAAA,oBAAM,EACnC,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC,EACf,aAAa,EACb,CAAC,IAAI,EAAE,EAAE;IACP,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,uDAAuD,CAAC;KAChE;IAED,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;QACnB,OAAO,2BAA2B,CAAC;KACpC;IAED,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACnB,OAAO,6CAA6C,CAAC;KACtD;IAED,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE;QAC/D,OAAO,oDAAoD,CAAC;KAC7D;IAED,IAAI,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;QACxC,OAAO,gBAAgB,IAAI,CAAC,CAAC,CAAC,0CAA0C,CAAC;KAC1E;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CACF,CAAC;AAEK,MAAM,YAAY,GAAG,CAC1B,MAAoB,EACpB,EAAE,CACF,IAAA,oBAAM,EAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,EAAE;IACzC,IACE,KAAK,CAAC,KAAK,KAAK,SAAS;QACzB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EACvD;QACA,OAAO,4CAA4C,CAAC;KACrD;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAZQ,QAAA,YAAY,gBAYpB;AAEL,oCAAoC;AACvB,QAAA,kBAAkB,GAAG,IAAA,oBAAY,EAC5C,IAAA,kBAAI,EAAC;IACH,IAAI,EAAE,uBAAe;IACrB,KAAK,EAAE,IAAA,mBAAK,EAAC,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;CACvC,CAAC,CACH,CAAC;AAIW,QAAA,oCAAoC,GAAG,IAAA,kBAAI,EACtD,IAAA,mBAAK,EAAC,0BAAkB,CAAC,EACzB,CAAC,EACD,QAAQ,CACT,CAAC;AAEW,QAAA,iBAAiB,GAAG,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE;IAC1E,IAAI,IAAA,0BAAkB,EAAC,KAAK,CAAC,EAAE;QAC7B,OAAO,IAAI,CAAC;KACb;IACD,OAAO,gCAAgC,CAAC;AAC1C,CAAC,CAAC,CAAC;AAEU,QAAA,aAAa,GAAG,IAAA,oBAAM,EACjC,IAAA,oBAAM,EAAC,oBAAY,EAAE,IAAA,oBAAM,EAAC,EAAE,OAAO,EAAE,IAAA,sBAAQ,EAAC,yBAAiB,CAAC,EAAE,CAAC,CAAC,EACtE,SAAS,EACT,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACnC,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CACF,CAAC;AAIF,yDAAyD;AAC5C,QAAA,iBAAiB,GAAG,IAAA,kBAAI,EAAC;IACpC,wBAAwB,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAC9C,0BAA0B,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAChD,uBAAuB,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAC7C,+BAA+B,EAAE,IAAA,sBAAQ,EACvC,IAAA,oBAAM,EAAC;QACL,sBAAsB,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;KAC5C,CAAC,CACH;IACD,mBAAmB,EAAE,IAAA,sBAAQ,EAC3B,IAAA,oBAAM,EAAC,EAAE,IAAI,EAAE,yCAA+B,EAAE,CAAC,CAClD;IACD,eAAe,EAAE,IAAA,sBAAQ,EAAC,2BAAgB,CAAC;IAC3C,WAAW,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IACjC,eAAe;IACf,YAAY,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAClC,gBAAgB,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IACtC,WAAW,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IACjC,oBAAoB,EAAE,IAAA,sBAAQ,EAAC,4CAAoC,CAAC;IACpE,sBAAsB,EAAE,IAAA,sBAAQ,EAAC,4CAAoC,CAAC;IACtE,oBAAoB,EAAE,IAAA,sBAAQ,EAC5B,IAAA,kBAAI,EACF,IAAA,mBAAK,EAAC,IAAA,oBAAM,EAAC,EAAE,QAAQ,EAAE,IAAA,kBAAI,EAAC,IAAA,qBAAO,GAAE,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5D,CAAC,EACD,QAAQ,CACT,CACF;IACD,eAAe,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IACrC,mBAAmB,EAAE,IAAA,sBAAQ,EAC3B,IAAA,oBAAM,EAAC;QACL,UAAU,EAAE,4BAAgB;KAC7B,CAAC,CACH;IACD,WAAW,EAAE,IAAA,sBAAQ,EAAC,qBAAa,CAAC;CACrC,CAAC,CAAC;AAKU,QAAA,kBAAkB,GAAG,IAAA,oBAAM,EAAC;IACvC,OAAO,EAAE,qBAAa;IACtB,WAAW,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,GAAG,CAAC;IACnC,YAAY,EAAE,IAAA,kBAAI,EAChB,IAAA,qBAAO,EACL,IAAA,oBAAM,GAAE,EACR,kHAAkH,CACnH,EACD,CAAC,EACD,GAAG,CACJ;IACD,UAAU,EAAE,IAAA,sBAAQ,EAClB,IAAA,oBAAM,EAAC;QACL,IAAI,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;QACjC,GAAG,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;KACjC,CAAC,CACH;IACD,MAAM,EAAE,IAAA,oBAAM,EAAC;QACb,MAAM,EAAE,sBAAc;QACtB,QAAQ,EAAE,IAAA,oBAAM,EAAC;YACf,GAAG,EAAE,IAAA,oBAAM,EAAC;gBACV,QAAQ,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;gBACrC,QAAQ,EAAE,IAAA,sBAAQ,EAAC,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC/C,WAAW,EAAE,kBAAU;gBACvB,QAAQ,EAAE,IAAA,mBAAK,EAAC;oBACd,IAAA,qBAAO,EAAC,4BAA4B,CAAC;oBACrC,IAAA,qBAAO,EAAC,6BAA6B,CAAC;iBACvC,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,kBAAkB,EAAE,yBAAiB;IACrC,eAAe,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;IAC/B,OAAO,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC,EAAE,oDAAoD;CAClF,CAAC,CAAC;AAIH;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,KAAc;IAC3C,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,0BAAkB,CAAC,CAAC;AACvC,CAAC;AAFD,wCAEC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAc;IAEd,IAAA,oBAAY,EACV,KAAK,EACL,0BAAkB,EAClB,IAAI,wBAAgB,CAAC,QAAQ,cAAc,CAC5C,CAAC;AACJ,CAAC;AARD,oDAQC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAC,KAAc;IAC/C,qEAAqE;IACrE,OAAO,IAAA,oBAAM,EAAC,KAAK,EAAE,0BAAkB,CAAC,CAAC;AAC3C,CAAC;AAHD,gDAGC","sourcesContent":["import {\n  assertStruct,\n  ChecksumStruct,\n  VersionStruct,\n  isValidSemVerRange,\n} from '@metamask/utils';\nimport {\n  array,\n  boolean,\n  create,\n  enums,\n  Infer,\n  integer,\n  is,\n  literal,\n  object,\n  optional,\n  pattern,\n  refine,\n  record,\n  size,\n  string,\n  Struct,\n  type,\n  union,\n} from 'superstruct';\n\nimport { CronjobSpecificationArrayStruct } from '../cronjob';\nimport { SIP_6_MAGIC_VALUE, STATE_ENCRYPTION_MAGIC_VALUE } from '../entropy';\nimport { RpcOriginsStruct } from '../json-rpc';\nimport { NamespacesStruct } from '../namespace';\nimport { SnapIdStruct } from '../snaps';\nimport { NameStruct, NpmSnapFileNames } from '../types';\n\n// BIP-43 purposes that cannot be used for entropy derivation. These are in the\n// string form, ending with `'`.\nconst FORBIDDEN_PURPOSES: string[] = [\n  SIP_6_MAGIC_VALUE,\n  STATE_ENCRYPTION_MAGIC_VALUE,\n];\n\nconst BIP32_INDEX_REGEX = /^\\d+'?$/u;\nexport const Bip32PathStruct = refine(\n  array(string()),\n  'BIP-32 path',\n  (path) => {\n    if (path.length === 0) {\n      return 'Path must be a non-empty BIP-32 derivation path array';\n    }\n\n    if (path[0] !== 'm') {\n      return 'Path must start with \"m\".';\n    }\n\n    if (path.length < 3) {\n      return 'Paths must have a length of at least three.';\n    }\n\n    if (path.slice(1).some((part) => !BIP32_INDEX_REGEX.test(part))) {\n      return 'Path must be a valid BIP-32 derivation path array.';\n    }\n\n    if (FORBIDDEN_PURPOSES.includes(path[1])) {\n      return `The purpose \"${path[1]}\" is not allowed for entropy derivation.`;\n    }\n\n    return true;\n  },\n);\n\nexport const bip32entropy = <T extends { path: string[]; curve: string }, S>(\n  struct: Struct<T, S>,\n) =>\n  refine(struct, 'BIP-32 entropy', (value) => {\n    if (\n      value.curve === 'ed25519' &&\n      value.path.slice(1).some((part) => !part.endsWith(\"'\"))\n    ) {\n      return 'Ed25519 does not support unhardened paths.';\n    }\n\n    return true;\n  });\n\n// Used outside @metamask/snap-utils\nexport const Bip32EntropyStruct = bip32entropy(\n  type({\n    path: Bip32PathStruct,\n    curve: enums(['ed25519', 'secp256k1']),\n  }),\n);\n\nexport type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;\n\nexport const SnapGetBip32EntropyPermissionsStruct = size(\n  array(Bip32EntropyStruct),\n  1,\n  Infinity,\n);\n\nexport const SemVerRangeStruct = refine(string(), 'SemVer range', (value) => {\n  if (isValidSemVerRange(value)) {\n    return true;\n  }\n  return 'Expected a valid SemVer range.';\n});\n\nexport const SnapIdsStruct = refine(\n  record(SnapIdStruct, object({ version: optional(SemVerRangeStruct) })),\n  'SnapIds',\n  (value) => {\n    if (Object.keys(value).length === 0) {\n      return false;\n    }\n\n    return true;\n  },\n);\n\nexport type SnapIds = Infer<typeof SnapIdsStruct>;\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const PermissionsStruct = type({\n  'endowment:long-running': optional(object({})),\n  'endowment:network-access': optional(object({})),\n  'endowment:webassembly': optional(object({})),\n  'endowment:transaction-insight': optional(\n    object({\n      allowTransactionOrigin: optional(boolean()),\n    }),\n  ),\n  'endowment:cronjob': optional(\n    object({ jobs: CronjobSpecificationArrayStruct }),\n  ),\n  'endowment:rpc': optional(RpcOriginsStruct),\n  snap_dialog: optional(object({})),\n  // TODO: Remove\n  snap_confirm: optional(object({})),\n  snap_manageState: optional(object({})),\n  snap_notify: optional(object({})),\n  snap_getBip32Entropy: optional(SnapGetBip32EntropyPermissionsStruct),\n  snap_getBip32PublicKey: optional(SnapGetBip32EntropyPermissionsStruct),\n  snap_getBip44Entropy: optional(\n    size(\n      array(object({ coinType: size(integer(), 0, 2 ** 32 - 1) })),\n      1,\n      Infinity,\n    ),\n  ),\n  snap_getEntropy: optional(object({})),\n  'endowment:keyring': optional(\n    object({\n      namespaces: NamespacesStruct,\n    }),\n  ),\n  wallet_snap: optional(SnapIdsStruct),\n});\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport type SnapPermissions = Infer<typeof PermissionsStruct>;\n\nexport const SnapManifestStruct = object({\n  version: VersionStruct,\n  description: size(string(), 1, 280),\n  proposedName: size(\n    pattern(\n      string(),\n      /^(?:[A-Za-z0-9-_]+( [A-Za-z0-9-_]+)*)|(?:(?:@[A-Za-z0-9-*~][A-Za-z0-9-*._~]*\\/)?[A-Za-z0-9-~][A-Za-z0-9-._~]*)$/u,\n    ),\n    1,\n    214,\n  ),\n  repository: optional(\n    object({\n      type: size(string(), 1, Infinity),\n      url: size(string(), 1, Infinity),\n    }),\n  ),\n  source: object({\n    shasum: ChecksumStruct,\n    location: object({\n      npm: object({\n        filePath: size(string(), 1, Infinity),\n        iconPath: optional(size(string(), 1, Infinity)),\n        packageName: NameStruct,\n        registry: union([\n          literal('https://registry.npmjs.org'),\n          literal('https://registry.npmjs.org/'),\n        ]),\n      }),\n    }),\n  }),\n  initialPermissions: PermissionsStruct,\n  manifestVersion: literal('0.1'),\n  $schema: optional(string()), // enables JSON-Schema linting in VSC and other IDEs\n});\n\nexport type SnapManifest = Infer<typeof SnapManifestStruct>;\n\n/**\n * Check if the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link SnapManifest} object.\n */\nexport function isSnapManifest(value: unknown): value is SnapManifest {\n  return is(value, SnapManifestStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid {@link SnapManifest} object.\n */\nexport function assertIsSnapManifest(\n  value: unknown,\n): asserts value is SnapManifest {\n  assertStruct(\n    value,\n    SnapManifestStruct,\n    `\"${NpmSnapFileNames.Manifest}\" is invalid`,\n  );\n}\n\n/**\n * Creates a {@link SnapManifest} object from JSON.\n *\n *\n * @param value - The value to check.\n * @throws If the value cannot be coerced to a {@link SnapManifest} object.\n * @returns The created {@link SnapManifest} object.\n */\nexport function createSnapManifest(value: unknown): SnapManifest {\n  // TODO: Add a utility to prefix these errors similar to assertStruct\n  return create(value, SnapManifestStruct);\n}\n"]}

package/dist/mock.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mock.js","sourceRoot":"","sources":["../src/mock.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAC5B,oDAAkC;AAElC,6DAA0D;AAE1D,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AAEpD,QAAA,QAAQ,GAAa;IAChC,GAAG,uCAAkB;IACrB,GAAG,YAAY;IACf,aAAa;CACd,CAAC;AAUF;;;;GAIG;AACH,SAAS,iBAAiB;IACxB,4DAA4D;IAC5D,OAAO,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,SAAS,uBAAuB;IAC9B,MAAM,YAAY,GAAG,IAAI,gBAAY,EAAmC,CAAC;IACzE,4DAA4D;IAC5D,YAAY,CAAC,OAAO,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC;IACxC,OAAO,YAAoC,CAAC;AAC9C,CAAC;AAED;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE,CAC1C,OAAO,CAAC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC;AADtD,QAAA,aAAa,iBACyC;AAEnE;;;;GAIG;AACH,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;AAChC,MAAM,SAAS;CAAG;AAElB,MAAM,OAAO,GAAG;IACd,gEAAgE;IAChE,SAAS,CAAC,MAAW,EAAE,IAAW;QAChC,OAAO,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,GAAG,CAAC,OAAY,EAAE,KAAU;QAC1B,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,KAAU,EAAE,EAAE;IACvC,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,6EAA6E;AAC7E,oEAAoE;AACpE,MAAM,UAAU,GAA4B;IAC1C,MAAM,EAAN,gBAAM;IACN,YAAY,EAAE,SAAS;CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IAC5C,MAAM,WAAW,GAAI,UAAkB,CAAC,GAAG,CAAC,CAAC;IAE7C,+CAA+C;IAC/C,IAAI,WAAW,IAAI,uCAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACnD,OAAO,WAAW,CAAC;KACpB;IAED,4EAA4E;IAC5E,MAAM,cAAc,GAAG,WAAW,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAEtD,MAAM,IAAI,GAAG,OAAO,cAAc,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,KAAK,UAAU,CAAC;IACvC,IAAI,UAAU,IAAI,IAAA,qBAAa,EAAC,cAAc,CAAC,EAAE;QAC/C,OAAO,iBAAiB,CAAC,cAAc,CAAC,CAAC;KAC1C;SAAM,IAAI,UAAU,IAAI,CAAC,cAAc,EAAE;QACxC,qCAAqC;QACrC,OAAO,YAAY,CAAC;KACrB;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF;;;;GAIG;AACI,MAAM,sBAAsB,GAAG,GAAG,EAAE;IACzC,OAAO,gBAAQ,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,EAC7D,EAAE,IAAI,EAAE,iBAAiB,EAAE,EAAE,QAAQ,EAAE,uBAAuB,EAAE,EAAE,CACnE,CAAC;AACJ,CAAC,CAAC;AALW,QAAA,sBAAsB,0BAKjC","sourcesContent":["import crypto from 'crypto';\nimport EventEmitter from 'events';\n\nimport { DEFAULT_ENDOWMENTS } from './default-endowments';\n\nconst NETWORK_APIS = ['fetch', 'Request', 'Headers', 'Response'];\n\nexport const ALL_APIS: string[] = [\n  ...DEFAULT_ENDOWMENTS,\n  ...NETWORK_APIS,\n  'WebAssembly',\n];\n\ntype MockSnapGlobal = {\n  request: () => Promise<any>;\n};\n\ntype MockEthereumProvider = EventEmitter & {\n  request: () => Promise<any>;\n};\n\n/**\n * Get a mock snap API, that always returns `true` for requests.\n *\n * @returns A mocked snap provider.\n */\nfunction getMockSnapGlobal(): MockSnapGlobal {\n  // eslint-disable-next-line @typescript-eslint/require-await\n  return { request: async () => true };\n}\n\n/**\n * Get a mock Ethereum provider, that always returns `true` for requests.\n *\n * @returns A mocked ethereum provider.\n */\nfunction getMockEthereumProvider(): MockEthereumProvider {\n  const mockProvider = new EventEmitter() as Partial<MockEthereumProvider>;\n  // eslint-disable-next-line @typescript-eslint/require-await\n  mockProvider.request = async () => true;\n  return mockProvider as MockEthereumProvider;\n}\n\n/**\n * Check if a value is a constructor.\n *\n * @param value - The value to check.\n * @returns `true` if the value is a constructor, or `false` otherwise.\n */\nexport const isConstructor = (value: any) =>\n  Boolean(typeof value?.prototype?.constructor?.name === 'string');\n\n/**\n * A function that always returns `true`.\n *\n * @returns `true`.\n */\nconst mockFunction = () => true;\nclass MockClass {}\n\nconst handler = {\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  construct(Target: any, args: any[]): any {\n    return new Proxy(new Target(...args), handler);\n  },\n  get(_target: any, _prop: any) {\n    return mockFunction;\n  },\n};\n\n/**\n * Generate a mock class for a given value. The value is wrapped in a Proxy, and\n * all methods are replaced with a mock function.\n *\n * @param value - The value to mock.\n * @returns A mock class.\n */\nconst generateMockClass = (value: any) => {\n  return new Proxy(value, handler);\n};\n\n// Things not currently auto-mocked because of NodeJS, by adding them here we\n// have types for them and can use that to generate mocks if needed.\nconst mockWindow: Record<string, unknown> = {\n  crypto,\n  SubtleCrypto: MockClass,\n};\n\n/**\n * Generate a mock endowment for a certain class or function on the `globalThis`\n * object.\n *\n * @param key - The key to generate the mock endowment for.\n * @returns A mocked class or function. If the key is part of the default\n * endowments, the original value is returned.\n */\nconst generateMockEndowment = (key: string) => {\n  const globalValue = (globalThis as any)[key];\n\n  // Default exposed APIs don't need to be mocked\n  if (globalValue && DEFAULT_ENDOWMENTS.includes(key)) {\n    return globalValue;\n  }\n\n  // Fall back to mockWindow for certain APIs not exposed in global in Node.JS\n  const globalOrMocked = globalValue ?? mockWindow[key];\n\n  const type = typeof globalOrMocked;\n  const isFunction = type === 'function';\n  if (isFunction && isConstructor(globalOrMocked)) {\n    return generateMockClass(globalOrMocked);\n  } else if (isFunction || !globalOrMocked) {\n    // Fall back to function mock for now\n    return mockFunction;\n  }\n  return globalOrMocked;\n};\n\n/**\n * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.\n *\n * @returns A map of endowments.\n */\nexport const generateMockEndowments = () => {\n  return ALL_APIS.reduce<Record<string, any>>(\n    (acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }),\n    { snap: getMockSnapGlobal(), ethereum: getMockEthereumProvider() },\n  );\n};\n"]}

package/dist/namespace.d.ts

@@ -1,275 +0,0 @@
-import { AssertionErrorConstructor } from '@metamask/utils';
-import { Infer } from 'superstruct';
-export declare const CHAIN_ID_REGEX: RegExp;
-export declare const ACCOUNT_ID_REGEX: RegExp;
-/**
- * Parse a chain ID string to an object containing the namespace and reference.
- * This validates the chain ID before parsing it.
- *
- * @param chainId - The chain ID to validate and parse.
- * @returns The parsed chain ID.
- */
-export declare function parseChainId(chainId: ChainId): {
-    namespace: NamespaceId;
-    reference: string;
-};
-/**
- * Parse an account ID to an object containing the chain, chain ID and address.
- * This validates the account ID before parsing it.
- *
- * @param accountId - The account ID to validate and parse.
- * @returns The parsed account ID.
- */
-export declare function parseAccountId(accountId: AccountId): {
-    chain: {
-        namespace: NamespaceId;
-        reference: string;
-    };
-    chainId: ChainId;
-    address: string;
-};
-/**
- * A helper struct for a string with a minimum length of 1 and a maximum length
- * of 40.
- */
-export declare const LimitedString: import("superstruct").Struct<string, null>;
-/**
- * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
- */
-export declare const ChainIdStruct: import("superstruct").Struct<string, null>;
-export declare type ChainId = `${string}:${string}`;
-export declare const AccountIdStruct: import("superstruct").Struct<string, null>;
-export declare type AccountId = `${ChainId}:${string}`;
-export declare const AccountIdArrayStruct: import("superstruct").Struct<string[], import("superstruct").Struct<string, null>>;
-/**
- * A chain descriptor.
- */
-export declare const ChainStruct: import("superstruct").Struct<{
-    name: string;
-    id: string;
-}, {
-    id: import("superstruct").Struct<string, null>;
-    name: import("superstruct").Struct<string, null>;
-}>;
-export declare type Chain = Infer<typeof ChainStruct>;
-export declare const NamespaceStruct: import("superstruct").Struct<{
-    chains: {
-        name: string;
-        id: string;
-    }[];
-    methods?: string[] | undefined;
-    events?: string[] | undefined;
-}, {
-    /**
-     * A list of supported chains in the namespace.
-     */
-    chains: import("superstruct").Struct<{
-        name: string;
-        id: string;
-    }[], import("superstruct").Struct<{
-        name: string;
-        id: string;
-    }, {
-        id: import("superstruct").Struct<string, null>;
-        name: import("superstruct").Struct<string, null>;
-    }>>;
-    /**
-     * A list of supported RPC methods on the namespace, that a DApp can call.
-     */
-    methods: import("superstruct").Struct<string[] | undefined, import("superstruct").Struct<string, null>>;
-    /**
-     * A list of supported RPC events on the namespace, that a DApp can listen to.
-     */
-    events: import("superstruct").Struct<string[] | undefined, import("superstruct").Struct<string, null>>;
-}>;
-export declare type Namespace = Infer<typeof NamespaceStruct>;
-export declare const RequestNamespaceStruct: import("superstruct").Struct<{
-    chains: string[];
-    methods?: string[] | undefined;
-    events?: string[] | undefined;
-}, {
-    chains: import("superstruct").Struct<string[], import("superstruct").Struct<string, null>>;
-    methods: import("superstruct").Struct<string[] | undefined, import("superstruct").Struct<string, null>>;
-    events: import("superstruct").Struct<string[] | undefined, import("superstruct").Struct<string, null>>;
-}>;
-export declare type RequestNamespace = Infer<typeof RequestNamespaceStruct>;
-export declare const SessionNamespaceStruct: import("superstruct").Struct<{
-    chains: string[];
-    accounts: string[];
-    methods?: string[] | undefined;
-    events?: string[] | undefined;
-}, {
-    accounts: import("superstruct").Struct<string[], import("superstruct").Struct<string, null>>;
-    chains: import("superstruct").Struct<string[], import("superstruct").Struct<string, null>>;
-    methods: import("superstruct").Struct<string[] | undefined, import("superstruct").Struct<string, null>>;
-    events: import("superstruct").Struct<string[] | undefined, import("superstruct").Struct<string, null>>;
-}>;
-export declare type SessionNamespace = Infer<typeof SessionNamespaceStruct>;
-/**
- * A CAIP-2 namespace, i.e., the first part of a chain ID.
- */
-export declare const NamespaceIdStruct: import("superstruct").Struct<string, null>;
-export declare type NamespaceId = Infer<typeof NamespaceIdStruct>;
-/**
- * An object mapping CAIP-2 namespaces to their values.
- */
-export declare const NamespacesStruct: import("superstruct").Struct<Record<string, {
-    chains: {
-        name: string;
-        id: string;
-    }[];
-    methods?: string[] | undefined;
-    events?: string[] | undefined;
-}>, null>;
-export declare type Namespaces = Infer<typeof NamespacesStruct>;
-export declare const SessionStruct: import("superstruct").Struct<{
-    namespaces: Record<string, {
-        chains: string[];
-        accounts: string[];
-        methods?: string[] | undefined;
-        events?: string[] | undefined;
-    }>;
-}, {
-    namespaces: import("superstruct").Struct<Record<string, {
-        chains: string[];
-        accounts: string[];
-        methods?: string[] | undefined;
-        events?: string[] | undefined;
-    }>, null>;
-}>;
-export declare type Session = Infer<typeof SessionStruct>;
-/**
- * Asserts that the given value is a valid {@link Session}.
- *
- * @param value - The value to assert.
- * @throws If the value is not a valid {@link Session}.
- */
-export declare function assertIsSession(value: unknown): asserts value is Session;
-export declare const ConnectArgumentsStruct: import("superstruct").Struct<{
-    requiredNamespaces: Record<string, {
-        chains: string[];
-        methods?: string[] | undefined;
-        events?: string[] | undefined;
-    }>;
-}, {
-    requiredNamespaces: import("superstruct").Struct<Record<string, {
-        chains: string[];
-        methods?: string[] | undefined;
-        events?: string[] | undefined;
-    }>, null>;
-}>;
-export declare type ConnectArguments = Infer<typeof ConnectArgumentsStruct>;
-export declare const RequestArgumentsStruct: import("superstruct").Struct<{
-    method: string;
-    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
-    id?: string | number | null | undefined;
-    jsonrpc?: "2.0" | undefined;
-}, {
-    params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
-    method: import("superstruct").Struct<string, null>;
-    id: import("superstruct").Struct<string | number | null | undefined, unknown>;
-    jsonrpc: import("superstruct").Struct<"2.0" | undefined, unknown>;
-}>;
-export declare type RequestArguments = Infer<typeof RequestArgumentsStruct>;
-export declare const MultiChainRequestStruct: import("superstruct").Struct<{
-    request: {
-        method: string;
-        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
-        id?: string | number | null | undefined;
-        jsonrpc?: "2.0" | undefined;
-    };
-    chainId: string;
-}, {
-    chainId: import("superstruct").Struct<string, null>;
-    request: import("superstruct").Struct<{
-        method: string;
-        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
-        id?: string | number | null | undefined;
-        jsonrpc?: "2.0" | undefined;
-    }, {
-        params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
-        method: import("superstruct").Struct<string, null>;
-        id: import("superstruct").Struct<string | number | null | undefined, unknown>;
-        jsonrpc: import("superstruct").Struct<"2.0" | undefined, unknown>;
-    }>;
-}>;
-export declare type MultiChainRequest = Infer<typeof MultiChainRequestStruct>;
-/**
- * Check if the given value is a CAIP-2 namespace ID.
- *
- * @param value - The value to check.
- * @returns Whether the value is a CAIP-2 namespace ID.
- */
-export declare function isNamespaceId(value: unknown): value is NamespaceId;
-/**
- * Check if the given value is a CAIP-2 chain ID.
- *
- * @param value - The value to check.
- * @returns Whether the value is a CAIP-2 chain ID.
- */
-export declare function isChainId(value: unknown): value is ChainId;
-/**
- * Check if the given value is a CAIP-10 account ID.
- *
- * @param value - The value to check.
- * @returns Whether the value is a CAIP-10 account ID.
- */
-export declare function isAccountId(value: unknown): value is AccountId;
-/**
- * Check if the given value is an array of CAIP-10 account IDs.
- *
- * @param value - The value to check.
- * @returns Whether the value is an array of CAIP-10 account IDs.
- */
-export declare function isAccountIdArray(value: unknown): value is AccountId[];
-/**
- * Check if the given value is a {@link ConnectArguments} object.
- *
- * @param value - The value to check.
- * @returns Whether the value is a valid {@link ConnectArguments} object.
- */
-export declare function isConnectArguments(value: unknown): value is ConnectArguments;
-/**
- * Assert that the given value is a {@link ConnectArguments} object.
- *
- * @param value - The value to check.
- * @throws If the value is not a valid {@link ConnectArguments} object.
- */
-export declare function assertIsConnectArguments(value: unknown): asserts value is ConnectArguments;
-/**
- * Check if the given value is a {@link MultiChainRequest} object.
- *
- * @param value - The value to check.
- * @returns Whether the value is a valid {@link MultiChainRequest} object.
- */
-export declare function isMultiChainRequest(value: unknown): value is MultiChainRequest;
-/**
- * Assert that the given value is a {@link MultiChainRequest} object.
- *
- * @param value - The value to check.
- * @throws If the value is not a valid {@link MultiChainRequest} object.
- */
-export declare function assertIsMultiChainRequest(value: unknown): asserts value is MultiChainRequest;
-/**
- * Check if a value is a {@link Namespace}.
- *
- * @param value - The value to validate.
- * @returns True if the value is a valid {@link Namespace}.
- */
-export declare function isNamespace(value: unknown): value is Namespace;
-/**
- * Check if a value is an object containing {@link Namespace}s.
- *
- * @param value - The value to validate.
- * @returns True if the value is a valid object containing namespaces.
- */
-export declare function isNamespacesObject(value: unknown): value is Namespaces;
-/**
- * Assert that the given value is a {@link Namespaces} object.
- *
- * @param value - The value to check.
- * @param ErrorWrapper - The error wrapper to use. Defaults to
- * {@link AssertionError}.
- * @throws If the value is not a valid {@link Namespaces} object.
- */
-export declare function assertIsNamespacesObject(value: unknown, ErrorWrapper?: AssertionErrorConstructor): asserts value is Namespaces;