@metamask/snaps-utils 0.24.0

package/dist/manifest/validation.d.ts

@@ -0,0 +1,483 @@
+import { Infer, Struct } from 'superstruct';
+export declare const SIP_6_MAGIC_VALUE: `${number}'`;
+export declare type Base64Opts = {
+    /**
+     * Is the `=` padding at the end required or not.
+     *
+     * @default false
+     */
+    paddingRequired?: boolean;
+    /**
+     * Which character set should be used.
+     * The sets are based on {@link https://datatracker.ietf.org/doc/html/rfc4648 RFC 4648}.
+     *
+     * @default 'base64'
+     */
+    characterSet?: 'base64' | 'base64url';
+};
+/**
+ * Ensure that a provided string-based struct is valid base64.
+ *
+ * @param struct - The string based struct.
+ * @param opts - Optional options to specialize base64 validation. See {@link Base64Opts} documentation.
+ * @returns A superstruct validating base64.
+ */
+export declare const base64: <T extends string, S>(struct: Struct<T, S>, opts?: Base64Opts) => Struct<T, S>;
+export declare const Bip32PathStruct: Struct<string[], Struct<string, null>>;
+export declare const Bip32EntropyStruct: Struct<{
+    path: string[];
+    curve: "ed25519" | "secp256k1";
+}, {
+    path: Struct<string[], Struct<string, null>>;
+    curve: Struct<"ed25519" | "secp256k1", {
+        ed25519: "ed25519";
+        secp256k1: "secp256k1";
+    }>;
+}>;
+export declare type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;
+export declare const Bip32PublicKeyStruct: Struct<{
+    path: string[];
+    curve: "secp256k1" | "ed225519";
+    compressed?: boolean | undefined;
+}, {
+    path: Struct<string[], Struct<string, null>>;
+    curve: Struct<"secp256k1" | "ed225519", {
+        secp256k1: "secp256k1";
+        ed225519: "ed225519";
+    }>;
+    compressed: Struct<boolean | undefined, null>;
+}>;
+export declare type Bip32PublicKey = Infer<typeof Bip32PublicKeyStruct>;
+declare const PermissionsStruct: Struct<{
+    'endowment:long-running'?: {} | undefined;
+    'endowment:network-access'?: {} | undefined;
+    'endowment:transaction-insight'?: {
+        allowTransactionOrigin?: boolean | undefined;
+    } | undefined;
+    'endowment:cronjob'?: {
+        jobs: {
+            expression: string;
+            request: {
+                method: string;
+                params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                id?: string | number | null | undefined;
+                jsonrpc?: "2.0" | undefined;
+            };
+        }[];
+    } | undefined;
+    snap_confirm?: {} | undefined;
+    snap_manageState?: {} | undefined;
+    snap_notify?: {} | undefined;
+    snap_getBip32Entropy?: {
+        path: string[];
+        curve: "ed25519" | "secp256k1";
+    }[] | undefined;
+    snap_getBip32PublicKey?: {
+        path: string[];
+        curve: "secp256k1" | "ed225519";
+        compressed?: boolean | undefined;
+    }[] | undefined;
+    snap_getBip44Entropy?: {
+        coinType: number;
+    }[] | undefined;
+    snap_getEntropy?: {} | undefined;
+    'endowment:keyring'?: {
+        namespaces: Record<string, {
+            chains: {
+                name: string;
+                id: string;
+            }[];
+            methods?: string[] | undefined;
+            events?: string[] | undefined;
+        }>;
+    } | undefined;
+}, {
+    'endowment:long-running': Struct<{} | undefined, {}>;
+    'endowment:network-access': Struct<{} | undefined, {}>;
+    'endowment:transaction-insight': Struct<{
+        allowTransactionOrigin?: boolean | undefined;
+    } | undefined, {
+        allowTransactionOrigin: Struct<boolean | undefined, null>;
+    }>;
+    'endowment:cronjob': Struct<{
+        jobs: {
+            expression: string;
+            request: {
+                method: string;
+                params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                id?: string | number | null | undefined;
+                jsonrpc?: "2.0" | undefined;
+            };
+        }[];
+    } | undefined, {
+        jobs: Struct<{
+            expression: string;
+            request: {
+                method: string;
+                params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                id?: string | number | null | undefined;
+                jsonrpc?: "2.0" | undefined;
+            };
+        }[], Struct<{
+            expression: string;
+            request: {
+                method: string;
+                params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                id?: string | number | null | undefined;
+                jsonrpc?: "2.0" | undefined;
+            };
+        }, {
+            expression: Struct<string, null>;
+            request: 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: Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
+                method: Struct<string, null>;
+                id: Struct<string | number | null | undefined, unknown>;
+                jsonrpc: Struct<"2.0" | undefined, unknown>;
+            }>;
+        }>>;
+    }>;
+    snap_confirm: Struct<{} | undefined, {}>;
+    snap_manageState: Struct<{} | undefined, {}>;
+    snap_notify: Struct<{} | undefined, {}>;
+    snap_getBip32Entropy: Struct<{
+        path: string[];
+        curve: "ed25519" | "secp256k1";
+    }[] | undefined, Struct<{
+        path: string[];
+        curve: "ed25519" | "secp256k1";
+    }, {
+        path: Struct<string[], Struct<string, null>>;
+        curve: Struct<"ed25519" | "secp256k1", {
+            ed25519: "ed25519";
+            secp256k1: "secp256k1";
+        }>;
+    }>>;
+    snap_getBip32PublicKey: Struct<{
+        path: string[];
+        curve: "secp256k1" | "ed225519";
+        compressed?: boolean | undefined;
+    }[] | undefined, Struct<{
+        path: string[];
+        curve: "secp256k1" | "ed225519";
+        compressed?: boolean | undefined;
+    }, {
+        path: Struct<string[], Struct<string, null>>;
+        curve: Struct<"secp256k1" | "ed225519", {
+            secp256k1: "secp256k1";
+            ed225519: "ed225519";
+        }>;
+        compressed: Struct<boolean | undefined, null>;
+    }>>;
+    snap_getBip44Entropy: Struct<{
+        coinType: number;
+    }[] | undefined, Struct<{
+        coinType: number;
+    }, {
+        coinType: Struct<number, null>;
+    }>>;
+    snap_getEntropy: Struct<{} | undefined, {}>;
+    'endowment:keyring': Struct<{
+        namespaces: Record<string, {
+            chains: {
+                name: string;
+                id: string;
+            }[];
+            methods?: string[] | undefined;
+            events?: string[] | undefined;
+        }>;
+    } | undefined, {
+        namespaces: Struct<Record<string, {
+            chains: {
+                name: string;
+                id: string;
+            }[];
+            methods?: string[] | undefined;
+            events?: string[] | undefined;
+        }>, null>;
+    }>;
+}>;
+export declare type SnapPermissions = Infer<typeof PermissionsStruct>;
+export declare const SnapManifestStruct: Struct<{
+    version: string;
+    description: string;
+    proposedName: string;
+    source: {
+        location: {
+            npm: {
+                filePath: string;
+                packageName: string;
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
+                iconPath?: string | undefined;
+            };
+        };
+        shasum: string;
+    };
+    initialPermissions: {
+        'endowment:long-running'?: {} | undefined;
+        'endowment:network-access'?: {} | undefined;
+        'endowment:transaction-insight'?: {
+            allowTransactionOrigin?: boolean | undefined;
+        } | undefined;
+        'endowment:cronjob'?: {
+            jobs: {
+                expression: string;
+                request: {
+                    method: string;
+                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    id?: string | number | null | undefined;
+                    jsonrpc?: "2.0" | undefined;
+                };
+            }[];
+        } | undefined;
+        snap_confirm?: {} | undefined;
+        snap_manageState?: {} | undefined;
+        snap_notify?: {} | undefined;
+        snap_getBip32Entropy?: {
+            path: string[];
+            curve: "ed25519" | "secp256k1";
+        }[] | undefined;
+        snap_getBip32PublicKey?: {
+            path: string[];
+            curve: "secp256k1" | "ed225519";
+            compressed?: boolean | undefined;
+        }[] | undefined;
+        snap_getBip44Entropy?: {
+            coinType: number;
+        }[] | undefined;
+        snap_getEntropy?: {} | undefined;
+        'endowment:keyring'?: {
+            namespaces: Record<string, {
+                chains: {
+                    name: string;
+                    id: string;
+                }[];
+                methods?: string[] | undefined;
+                events?: string[] | undefined;
+            }>;
+        } | undefined;
+    };
+    manifestVersion: "0.1";
+    repository?: {
+        type: string;
+        url: string;
+    } | undefined;
+}, {
+    version: Struct<string, null>;
+    description: Struct<string, null>;
+    proposedName: Struct<string, null>;
+    repository: Struct<{
+        type: string;
+        url: string;
+    } | undefined, {
+        type: Struct<string, null>;
+        url: Struct<string, null>;
+    }>;
+    source: Struct<{
+        location: {
+            npm: {
+                filePath: string;
+                packageName: string;
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
+                iconPath?: string | undefined;
+            };
+        };
+        shasum: string;
+    }, {
+        shasum: Struct<string, null>;
+        location: Struct<{
+            npm: {
+                filePath: string;
+                packageName: string;
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
+                iconPath?: string | undefined;
+            };
+        }, {
+            npm: Struct<{
+                filePath: string;
+                packageName: string;
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
+                iconPath?: string | undefined;
+            }, {
+                filePath: Struct<string, null>;
+                iconPath: Struct<string | undefined, null>;
+                packageName: Struct<string, null>;
+                registry: Struct<"https://registry.npmjs.org" | "https://registry.npmjs.org/", null>;
+            }>;
+        }>;
+    }>;
+    initialPermissions: Struct<{
+        'endowment:long-running'?: {} | undefined;
+        'endowment:network-access'?: {} | undefined;
+        'endowment:transaction-insight'?: {
+            allowTransactionOrigin?: boolean | undefined;
+        } | undefined;
+        'endowment:cronjob'?: {
+            jobs: {
+                expression: string;
+                request: {
+                    method: string;
+                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    id?: string | number | null | undefined;
+                    jsonrpc?: "2.0" | undefined;
+                };
+            }[];
+        } | undefined;
+        snap_confirm?: {} | undefined;
+        snap_manageState?: {} | undefined;
+        snap_notify?: {} | undefined;
+        snap_getBip32Entropy?: {
+            path: string[];
+            curve: "ed25519" | "secp256k1";
+        }[] | undefined;
+        snap_getBip32PublicKey?: {
+            path: string[];
+            curve: "secp256k1" | "ed225519";
+            compressed?: boolean | undefined;
+        }[] | undefined;
+        snap_getBip44Entropy?: {
+            coinType: number;
+        }[] | undefined;
+        snap_getEntropy?: {} | undefined;
+        'endowment:keyring'?: {
+            namespaces: Record<string, {
+                chains: {
+                    name: string;
+                    id: string;
+                }[];
+                methods?: string[] | undefined;
+                events?: string[] | undefined;
+            }>;
+        } | undefined;
+    }, {
+        'endowment:long-running': Struct<{} | undefined, {}>;
+        'endowment:network-access': Struct<{} | undefined, {}>;
+        'endowment:transaction-insight': Struct<{
+            allowTransactionOrigin?: boolean | undefined;
+        } | undefined, {
+            allowTransactionOrigin: Struct<boolean | undefined, null>;
+        }>;
+        'endowment:cronjob': Struct<{
+            jobs: {
+                expression: string;
+                request: {
+                    method: string;
+                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    id?: string | number | null | undefined;
+                    jsonrpc?: "2.0" | undefined;
+                };
+            }[];
+        } | undefined, {
+            jobs: Struct<{
+                expression: string;
+                request: {
+                    method: string;
+                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    id?: string | number | null | undefined;
+                    jsonrpc?: "2.0" | undefined;
+                };
+            }[], Struct<{
+                expression: string;
+                request: {
+                    method: string;
+                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    id?: string | number | null | undefined;
+                    jsonrpc?: "2.0" | undefined;
+                };
+            }, {
+                expression: Struct<string, null>;
+                request: 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: Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
+                    method: Struct<string, null>;
+                    id: Struct<string | number | null | undefined, unknown>;
+                    jsonrpc: Struct<"2.0" | undefined, unknown>;
+                }>;
+            }>>;
+        }>;
+        snap_confirm: Struct<{} | undefined, {}>;
+        snap_manageState: Struct<{} | undefined, {}>;
+        snap_notify: Struct<{} | undefined, {}>;
+        snap_getBip32Entropy: Struct<{
+            path: string[];
+            curve: "ed25519" | "secp256k1";
+        }[] | undefined, Struct<{
+            path: string[];
+            curve: "ed25519" | "secp256k1";
+        }, {
+            path: Struct<string[], Struct<string, null>>;
+            curve: Struct<"ed25519" | "secp256k1", {
+                ed25519: "ed25519";
+                secp256k1: "secp256k1";
+            }>;
+        }>>;
+        snap_getBip32PublicKey: Struct<{
+            path: string[];
+            curve: "secp256k1" | "ed225519";
+            compressed?: boolean | undefined;
+        }[] | undefined, Struct<{
+            path: string[];
+            curve: "secp256k1" | "ed225519";
+            compressed?: boolean | undefined;
+        }, {
+            path: Struct<string[], Struct<string, null>>;
+            curve: Struct<"secp256k1" | "ed225519", {
+                secp256k1: "secp256k1";
+                ed225519: "ed225519";
+            }>;
+            compressed: Struct<boolean | undefined, null>;
+        }>>;
+        snap_getBip44Entropy: Struct<{
+            coinType: number;
+        }[] | undefined, Struct<{
+            coinType: number;
+        }, {
+            coinType: Struct<number, null>;
+        }>>;
+        snap_getEntropy: Struct<{} | undefined, {}>;
+        'endowment:keyring': Struct<{
+            namespaces: Record<string, {
+                chains: {
+                    name: string;
+                    id: string;
+                }[];
+                methods?: string[] | undefined;
+                events?: string[] | undefined;
+            }>;
+        } | undefined, {
+            namespaces: Struct<Record<string, {
+                chains: {
+                    name: string;
+                    id: string;
+                }[];
+                methods?: string[] | undefined;
+                events?: string[] | undefined;
+            }>, null>;
+        }>;
+    }>;
+    manifestVersion: Struct<"0.1", "0.1">;
+}>;
+export declare type SnapManifest = Infer<typeof SnapManifestStruct>;
+/**
+ * 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.
+ */
+export declare function isSnapManifest(value: unknown): value is SnapManifest;
+/**
+ * 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.
+ */
+export declare function assertIsSnapManifest(value: unknown): asserts value is SnapManifest;
+export {};

package/dist/manifest/validation.js

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertIsSnapManifest = exports.isSnapManifest = exports.SnapManifestStruct = exports.Bip32PublicKeyStruct = exports.Bip32EntropyStruct = exports.Bip32PathStruct = exports.base64 = exports.SIP_6_MAGIC_VALUE = void 0;
+const utils_1 = require("@metamask/utils");
+const superstruct_1 = require("superstruct");
+const cronjob_1 = require("../cronjob");
+const namespace_1 = require("../namespace");
+const types_1 = require("../types");
+// 0xd36e6170 - 0x80000000
+exports.SIP_6_MAGIC_VALUE = `1399742832'`;
+// BIP-43 purposes that cannot be used for entropy derivation. These are in the
+// string form, ending with `'`.
+const FORBIDDEN_PURPOSES = [exports.SIP_6_MAGIC_VALUE];
+/**
+ * Ensure that a provided string-based struct is valid base64.
+ *
+ * @param struct - The string based struct.
+ * @param opts - Optional options to specialize base64 validation. See {@link Base64Opts} documentation.
+ * @returns A superstruct validating base64.
+ */
+const base64 = (struct, opts = {}) => {
+    var _a, _b;
+    const paddingRequired = (_a = opts.paddingRequired) !== null && _a !== void 0 ? _a : false;
+    const characterSet = (_b = opts.characterSet) !== null && _b !== void 0 ? _b : 'base64';
+    let letters;
+    if (characterSet === 'base64') {
+        letters = String.raw `[A-Za-z0-9+\/]`;
+    }
+    else {
+        (0, utils_1.assert)(characterSet === 'base64url');
+        letters = String.raw `[-_A-Za-z0-9]`;
+    }
+    let re;
+    if (paddingRequired) {
+        re = new RegExp(`^(?:${letters}{4})*(?:${letters}{3}=|${letters}{2}==)?$`, 'u');
+    }
+    else {
+        re = new RegExp(`^(?:${letters}{4})*(?:${letters}{2,3}|${letters}{3}=|${letters}{2}==)?$`, 'u');
+    }
+    return (0, superstruct_1.pattern)(struct, re);
+};
+exports.base64 = base64;
+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((e) => !BIP32_INDEX_REGEX.test(e))) {
+        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((e) => !e.endsWith("'"))) {
+        return 'Ed25519 does not support unhardened paths.';
+    }
+    return true;
+});
+// Used outside @metamask/snap-utils
+exports.Bip32EntropyStruct = bip32entropy((0, superstruct_1.object)({
+    path: exports.Bip32PathStruct,
+    curve: (0, superstruct_1.enums)(['ed25519', 'secp256k1']),
+}));
+exports.Bip32PublicKeyStruct = bip32entropy((0, superstruct_1.object)({
+    path: exports.Bip32PathStruct,
+    curve: (0, superstruct_1.enums)(['ed225519', 'secp256k1']),
+    compressed: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+}));
+const 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: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 })),
+    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)((0, superstruct_1.size)((0, superstruct_1.array)(exports.Bip32EntropyStruct), 1, Infinity)),
+    snap_getBip32PublicKey: (0, superstruct_1.optional)((0, superstruct_1.size)((0, superstruct_1.array)(exports.Bip32PublicKeyStruct), 1, Infinity)),
+    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,
+    })),
+});
+exports.SnapManifestStruct = (0, superstruct_1.object)({
+    version: types_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: (0, superstruct_1.size)((0, exports.base64)((0, superstruct_1.string)(), { paddingRequired: true }), 44, 44),
+        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: PermissionsStruct,
+    manifestVersion: (0, superstruct_1.literal)('0.1'),
+});
+/**
+ * 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;
+//# sourceMappingURL=validation.js.map

package/dist/manifest/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/manifest/validation.ts"],"names":[],"mappings":";;;AAAA,2CAAuD;AACvD,6CAiBqB;AACrB,wCAA6D;AAC7D,4CAAgD;AAChD,oCAAuE;AAEvE,0BAA0B;AACb,QAAA,iBAAiB,GAAG,aAA6B,CAAC;AAE/D,+EAA+E;AAC/E,gCAAgC;AAChC,MAAM,kBAAkB,GAAa,CAAC,yBAAiB,CAAC,CAAC;AAmBzD;;;;;;GAMG;AACI,MAAM,MAAM,GAAG,CACpB,MAAoB,EACpB,OAAmB,EAAE,EACrB,EAAE;;IACF,MAAM,eAAe,GAAG,MAAA,IAAI,CAAC,eAAe,mCAAI,KAAK,CAAC;IACtD,MAAM,YAAY,GAAG,MAAA,IAAI,CAAC,YAAY,mCAAI,QAAQ,CAAC;IAEnD,IAAI,OAAe,CAAC;IACpB,IAAI,YAAY,KAAK,QAAQ,EAAE;QAC7B,OAAO,GAAG,MAAM,CAAC,GAAG,CAAA,gBAAgB,CAAC;KACtC;SAAM;QACL,IAAA,cAAM,EAAC,YAAY,KAAK,WAAW,CAAC,CAAC;QACrC,OAAO,GAAG,MAAM,CAAC,GAAG,CAAA,eAAe,CAAC;KACrC;IAED,IAAI,EAAU,CAAC;IACf,IAAI,eAAe,EAAE;QACnB,EAAE,GAAG,IAAI,MAAM,CACb,OAAO,OAAO,WAAW,OAAO,QAAQ,OAAO,UAAU,EACzD,GAAG,CACJ,CAAC;KACH;SAAM;QACL,EAAE,GAAG,IAAI,MAAM,CACb,OAAO,OAAO,WAAW,OAAO,SAAS,OAAO,QAAQ,OAAO,UAAU,EACzE,GAAG,CACJ,CAAC;KACH;IAED,OAAO,IAAA,qBAAO,EAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAC7B,CAAC,CAAC;AA7BW,QAAA,MAAM,UA6BjB;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,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;QACzD,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;AAEF,MAAM,YAAY,GAAG,CACnB,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,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EACjD;QACA,OAAO,4CAA4C,CAAC;KACrD;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAEL,oCAAoC;AACvB,QAAA,kBAAkB,GAAG,YAAY,CAC5C,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,uBAAe;IACrB,KAAK,EAAE,IAAA,mBAAK,EAAC,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;CACvC,CAAC,CACH,CAAC;AAIW,QAAA,oBAAoB,GAAG,YAAY,CAC9C,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,uBAAe;IACrB,KAAK,EAAE,IAAA,mBAAK,EAAC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IACvC,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAChC,CAAC,CACH,CAAC;AAIF,MAAM,iBAAiB,GAAG,IAAA,kBAAI,EAAC;IAC7B,wBAAwB,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAC9C,0BAA0B,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,EAAE,CAAC,CAAC;IAChD,+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,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,IAAA,kBAAI,EAAC,IAAA,mBAAK,EAAC,0BAAkB,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC5E,sBAAsB,EAAE,IAAA,sBAAQ,EAC9B,IAAA,kBAAI,EAAC,IAAA,mBAAK,EAAC,4BAAoB,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAC/C;IACD,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;CACF,CAAC,CAAC;AAIU,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,IAAA,kBAAI,EAAC,IAAA,cAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;QACjE,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,iBAAiB;IACrC,eAAe,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;CAChC,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","sourcesContent":["import { assert, assertStruct } from '@metamask/utils';\nimport {\n  array,\n  boolean,\n  enums,\n  Infer,\n  integer,\n  is,\n  literal,\n  object,\n  optional,\n  pattern,\n  refine,\n  size,\n  string,\n  Struct,\n  type,\n  union,\n} from 'superstruct';\nimport { CronjobSpecificationArrayStruct } from '../cronjob';\nimport { NamespacesStruct } from '../namespace';\nimport { NameStruct, NpmSnapFileNames, VersionStruct } from '../types';\n\n// 0xd36e6170 - 0x80000000\nexport const SIP_6_MAGIC_VALUE = `1399742832'` as `${number}'`;\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[] = [SIP_6_MAGIC_VALUE];\n\nexport type Base64Opts = {\n  /**\n   * Is the `=` padding at the end required or not.\n   *\n   * @default false\n   */\n  // Padding is optional in RFC 4648, that's why the default value is false\n  paddingRequired?: boolean;\n  /**\n   * Which character set should be used.\n   * The sets are based on {@link https://datatracker.ietf.org/doc/html/rfc4648 RFC 4648}.\n   *\n   * @default 'base64'\n   */\n  characterSet?: 'base64' | 'base64url';\n};\n\n/**\n * Ensure that a provided string-based struct is valid base64.\n *\n * @param struct - The string based struct.\n * @param opts - Optional options to specialize base64 validation. See {@link Base64Opts} documentation.\n * @returns A superstruct validating base64.\n */\nexport const base64 = <T extends string, S>(\n  struct: Struct<T, S>,\n  opts: Base64Opts = {},\n) => {\n  const paddingRequired = opts.paddingRequired ?? false;\n  const characterSet = opts.characterSet ?? 'base64';\n\n  let letters: string;\n  if (characterSet === 'base64') {\n    letters = String.raw`[A-Za-z0-9+\\/]`;\n  } else {\n    assert(characterSet === 'base64url');\n    letters = String.raw`[-_A-Za-z0-9]`;\n  }\n\n  let re: RegExp;\n  if (paddingRequired) {\n    re = new RegExp(\n      `^(?:${letters}{4})*(?:${letters}{3}=|${letters}{2}==)?$`,\n      'u',\n    );\n  } else {\n    re = new RegExp(\n      `^(?:${letters}{4})*(?:${letters}{2,3}|${letters}{3}=|${letters}{2}==)?$`,\n      'u',\n    );\n  }\n\n  return pattern(struct, re);\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((e) => !BIP32_INDEX_REGEX.test(e))) {\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\nconst 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((e) => !e.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  object({\n    path: Bip32PathStruct,\n    curve: enums(['ed25519', 'secp256k1']),\n  }),\n);\n\nexport type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;\n\nexport const Bip32PublicKeyStruct = bip32entropy(\n  object({\n    path: Bip32PathStruct,\n    curve: enums(['ed225519', 'secp256k1']),\n    compressed: optional(boolean()),\n  }),\n);\n\nexport type Bip32PublicKey = Infer<typeof Bip32PublicKeyStruct>;\n\nconst PermissionsStruct = type({\n  'endowment:long-running': optional(object({})),\n  'endowment:network-access': 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  snap_confirm: optional(object({})),\n  snap_manageState: optional(object({})),\n  snap_notify: optional(object({})),\n  snap_getBip32Entropy: optional(size(array(Bip32EntropyStruct), 1, Infinity)),\n  snap_getBip32PublicKey: optional(\n    size(array(Bip32PublicKeyStruct), 1, Infinity),\n  ),\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});\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: size(base64(string(), { paddingRequired: true }), 44, 44),\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});\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"]}

package/dist/mock.d.ts

@@ -0,0 +1,14 @@
+export declare const ALL_APIS: string[];
+/**
+ * Check if a value is a constructor.
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is a constructor, or `false` otherwise.
+ */
+export declare const isConstructor: (value: any) => boolean;
+/**
+ * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.
+ *
+ * @returns A map of endowments.
+ */
+export declare const generateMockEndowments: () => Record<string, any>;