@metamask/snaps-utils 7.2.0 → 7.4.0

package/dist/types/handlers.d.ts

@@ -55,7 +55,7 @@ export declare const SNAP_EXPORTS: {
     };
     readonly onUserInput: {
         readonly type: HandlerType.OnUserInput;
-        readonly required: true;
+        readonly required: false;
         readonly validator: (snapExport: unknown) => snapExport is OnUserInputHandler;
     };
 };
@@ -72,39 +72,7 @@ export declare const OnTransactionResponseWithIdStruct: import("superstruct").St
     severity: import("superstruct").Struct<SeverityLevel | undefined, SeverityLevel>;
 }>;
 export declare const OnTransactionResponseWithContentStruct: import("superstruct").Struct<{
-    content: import("@metamask/snaps-sdk").Panel | {
-        type: import("@metamask/snaps-sdk").NodeType.Input;
-        name: string;
-        value?: string | undefined;
-        error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
-        placeholder?: string | undefined;
-        label?: string | undefined;
-    } | {
-        value: string;
-        type: import("@metamask/snaps-sdk").NodeType.Button;
-        name?: string | undefined;
-        variant?: "primary" | "secondary" | undefined;
-        buttonType?: "button" | "submit" | undefined;
-    } | {
-        type: import("@metamask/snaps-sdk").NodeType.Form;
-        name: string;
-        children: ({
-            type: import("@metamask/snaps-sdk").NodeType.Input;
-            name: string;
-            value?: string | undefined;
-            error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
-            placeholder?: string | undefined;
-            label?: string | undefined;
-        } | {
-            value: string;
-            type: import("@metamask/snaps-sdk").NodeType.Button;
-            name?: string | undefined;
-            variant?: "primary" | "secondary" | undefined;
-            buttonType?: "button" | "submit" | undefined;
-        })[];
-    } | {
+    content: import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -140,17 +108,14 @@ export declare const OnTransactionResponseWithContentStruct: import("superstruct
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    };
-    severity?: SeverityLevel | undefined;
-}, {
-    content: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
+    } | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -165,9 +130,9 @@ export declare const OnTransactionResponseWithContentStruct: import("superstruct
             name: string;
             value?: string | undefined;
             error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
             placeholder?: string | undefined;
             label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
         } | {
             value: string;
             type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -175,7 +140,10 @@ export declare const OnTransactionResponseWithContentStruct: import("superstruct
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | {
+    };
+    severity?: SeverityLevel | undefined;
+}, {
+    content: import("superstruct").Struct<import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -211,21 +179,14 @@ export declare const OnTransactionResponseWithContentStruct: import("superstruct
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    }, null>;
-    severity: import("superstruct").Struct<SeverityLevel | undefined, SeverityLevel>;
-}>;
-export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
-    id: string;
-    severity?: SeverityLevel | undefined;
-} | {
-    content: import("@metamask/snaps-sdk").Panel | {
+    } | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -240,9 +201,9 @@ export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
             name: string;
             value?: string | undefined;
             error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
             placeholder?: string | undefined;
             label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
         } | {
             value: string;
             type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -250,7 +211,14 @@ export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | {
+    }, null>;
+    severity: import("superstruct").Struct<SeverityLevel | undefined, SeverityLevel>;
+}>;
+export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
+    id: string;
+    severity?: SeverityLevel | undefined;
+} | {
+    content: import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -286,21 +254,14 @@ export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    };
-    severity?: SeverityLevel | undefined;
-} | null, null>;
-export declare const OnSignatureResponseStruct: import("superstruct").Struct<{
-    id: string;
-    severity?: SeverityLevel | undefined;
-} | {
-    content: import("@metamask/snaps-sdk").Panel | {
+    } | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -315,9 +276,9 @@ export declare const OnSignatureResponseStruct: import("superstruct").Struct<{
             name: string;
             value?: string | undefined;
             error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
             placeholder?: string | undefined;
             label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
         } | {
             value: string;
             type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -325,7 +286,14 @@ export declare const OnSignatureResponseStruct: import("superstruct").Struct<{
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | {
+    };
+    severity?: SeverityLevel | undefined;
+} | null, null>;
+export declare const OnSignatureResponseStruct: import("superstruct").Struct<{
+    id: string;
+    severity?: SeverityLevel | undefined;
+} | {
+    content: import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -361,18 +329,14 @@ export declare const OnSignatureResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    };
-    severity?: SeverityLevel | undefined;
-} | null, null>;
-export declare const OnHomePageResponseWithContentStruct: import("superstruct").Struct<{
-    content: import("@metamask/snaps-sdk").Panel | {
+    } | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -387,9 +351,9 @@ export declare const OnHomePageResponseWithContentStruct: import("superstruct").
             name: string;
             value?: string | undefined;
             error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
             placeholder?: string | undefined;
             label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
         } | {
             value: string;
             type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -397,7 +361,11 @@ export declare const OnHomePageResponseWithContentStruct: import("superstruct").
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | {
+    };
+    severity?: SeverityLevel | undefined;
+} | null, null>;
+export declare const OnHomePageResponseWithContentStruct: import("superstruct").Struct<{
+    content: import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -433,16 +401,14 @@ export declare const OnHomePageResponseWithContentStruct: import("superstruct").
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    };
-}, {
-    content: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
+    } | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -457,9 +423,9 @@ export declare const OnHomePageResponseWithContentStruct: import("superstruct").
             name: string;
             value?: string | undefined;
             error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
             placeholder?: string | undefined;
             label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
         } | {
             value: string;
             type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -467,7 +433,9 @@ export declare const OnHomePageResponseWithContentStruct: import("superstruct").
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | {
+    };
+}, {
+    content: import("superstruct").Struct<import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -503,22 +471,14 @@ export declare const OnHomePageResponseWithContentStruct: import("superstruct").
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    }, null>;
-}>;
-export declare const OnHomePageResponseWithIdStruct: import("superstruct").Struct<{
-    id: string;
-}, {
-    id: import("superstruct").Struct<string, null>;
-}>;
-export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
-    content: import("@metamask/snaps-sdk").Panel | {
+    } | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -533,9 +493,9 @@ export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
             name: string;
             value?: string | undefined;
             error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
             placeholder?: string | undefined;
             label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
         } | {
             value: string;
             type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -543,7 +503,15 @@ export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | {
+    }, null>;
+}>;
+export declare const OnHomePageResponseWithIdStruct: import("superstruct").Struct<{
+    id: string;
+}, {
+    id: import("superstruct").Struct<string, null>;
+}>;
+export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
+    content: import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -579,6 +547,38 @@ export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        error?: string | undefined;
+        placeholder?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            error?: string | undefined;
+            placeholder?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     };
 } | {
     id: string;

package/dist/types/manifest/validation.d.ts

@@ -1,3 +1,4 @@
+import type { SupportedCurve } from '@metamask/key-tree';
 import type { EmptyObject, InitialPermissions } from '@metamask/snaps-sdk';
 import type { Describe, Infer, Struct } from 'superstruct';
 import type { InferMatching } from '../structs';
@@ -7,29 +8,24 @@ export declare const bip32entropy: <Type extends {
     path: string[];
     curve: string;
 }, Schema>(struct: Struct<Type, Schema>) => Struct<Type, Schema>;
+export declare const CurveStruct: Describe<SupportedCurve>;
 export declare const Bip32EntropyStruct: Struct<{
     path: string[];
-    curve: "ed25519" | "secp256k1";
+    curve: "ed25519" | "ed25519Bip32" | "secp256k1";
 }, {
     path: Struct<string[], Struct<string, null>>;
-    curve: Struct<"ed25519" | "secp256k1", {
-        ed25519: "ed25519";
-        secp256k1: "secp256k1";
-    }>;
+    curve: Describe<"ed25519" | "ed25519Bip32" | "secp256k1">;
 }>;
 export declare type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;
 export declare const SnapGetBip32EntropyPermissionsStruct: Struct<{
     path: string[];
-    curve: "ed25519" | "secp256k1";
+    curve: "ed25519" | "ed25519Bip32" | "secp256k1";
 }[], Struct<{
     path: string[];
-    curve: "ed25519" | "secp256k1";
+    curve: "ed25519" | "ed25519Bip32" | "secp256k1";
 }, {
     path: Struct<string[], Struct<string, null>>;
-    curve: Struct<"ed25519" | "secp256k1", {
-        ed25519: "ed25519";
-        secp256k1: "secp256k1";
-    }>;
+    curve: Describe<"ed25519" | "ed25519Bip32" | "secp256k1">;
 }>>;
 export declare const SemVerRangeStruct: Struct<string, null>;
 export declare const SnapIdsStruct: Struct<Record<string, {

package/dist/types/ui.d.ts

@@ -1,6 +1,27 @@
-import type { Component, NodeWithChildren } from '@metamask/snaps-sdk';
+import type { Component } from '@metamask/snaps-sdk';
+import type { JSXElement, LinkElement, MaybeArray, StandardFormattingElement } from '@metamask/snaps-sdk/jsx';
 /**
- * Searches for markdown links in a string and checks them against the phishing list.
+ * Get all text children from a markdown string.
+ *
+ * @param value - The markdown string.
+ * @returns The text children.
+ */
+export declare function getTextChildren(value: string): (string | StandardFormattingElement | LinkElement)[];
+/**
+ * Get a JSX element from a legacy UI component. This supports all legacy UI
+ * components, and maps them to their JSX equivalents where possible.
+ *
+ * This function validates the text size of the component, but does not validate
+ * the total size. The total size of the component should be validated before
+ * calling this function.
+ *
+ * @param legacyComponent - The legacy UI component.
+ * @returns The JSX element.
+ */
+export declare function getJsxElementFromComponent(legacyComponent: Component): JSXElement;
+/**
+ * Search for Markdown links in a string and checks them against the phishing
+ * list.
  *
  * @param text - The text to verify.
  * @param isOnPhishingList - The function that checks the link against the
@@ -9,15 +30,14 @@ import type { Component, NodeWithChildren } from '@metamask/snaps-sdk';
  */
 export declare function validateTextLinks(text: string, isOnPhishingList: (url: string) => boolean): void;
 /**
- * Search for links in UI components and check that the URL they are trying to
- * pass in is not in the phishing list.
+ * Walk a JSX tree and validate each {@link LinkElement} node against the
+ * phishing list.
  *
- * @param component - The custom UI component.
+ * @param node - The JSX node to walk.
  * @param isOnPhishingList - The function that checks the link against the
  * phishing list.
- * @throws If the component contains a link that is not allowed.
  */
-export declare function validateComponentLinks(component: Component, isOnPhishingList: (url: string) => boolean): void;
+export declare function validateJsxLinks(node: JSXElement, isOnPhishingList: (url: string) => boolean): void;
 /**
  * Calculate the total length of all text in the component.
  *
@@ -26,9 +46,29 @@ export declare function validateComponentLinks(component: Component, isOnPhishin
  */
 export declare function getTotalTextLength(component: Component): number;
 /**
- * Check if a component has children.
+ * Check if a JSX element has children.
  *
- * @param component - A custom UI component.
- * @returns `true` if the component has children, `false` otherwise.
+ * @param element - A JSX element.
+ * @returns `true` if the element has children, `false` otherwise.
+ */
+export declare function hasChildren<Element extends JSXElement>(element: Element): element is Element & {
+    props: {
+        children: MaybeArray<JSXElement | string>;
+    };
+};
+/**
+ * Get the children of a JSX element as an array. If the element has only one
+ * child, the child is returned as an array.
+ *
+ * @param element - A JSX element.
+ * @returns The children of the element.
+ */
+export declare function getJsxChildren(element: JSXElement): (JSXElement | string)[];
+/**
+ * Walk a JSX tree and call a callback on each node.
+ *
+ * @param node - The JSX node to walk.
+ * @param callback - The callback to call on each node.
+ * @returns The result of the callback, if any.
  */
-export declare function hasChildren(component: Component): component is NodeWithChildren;
+export declare function walkJsx<Value>(node: JSXElement | JSXElement[], callback: (node: JSXElement) => Value | undefined): Value | undefined;

package/dist/ui.js

@@ -3,12 +3,20 @@
 
 
 
-var _chunkNDIITWO4js = require('./chunk-NDIITWO4.js');
+
+
+
+
+var _chunk4YAWNZXMjs = require('./chunk-4YAWNZXM.js');
 require('./chunk-PHUTP7NB.js');
 
 
 
 
 
-exports.getTotalTextLength = _chunkNDIITWO4js.getTotalTextLength; exports.hasChildren = _chunkNDIITWO4js.hasChildren; exports.validateComponentLinks = _chunkNDIITWO4js.validateComponentLinks; exports.validateTextLinks = _chunkNDIITWO4js.validateTextLinks;
+
+
+
+
+exports.getJsxChildren = _chunk4YAWNZXMjs.getJsxChildren; exports.getJsxElementFromComponent = _chunk4YAWNZXMjs.getJsxElementFromComponent; exports.getTextChildren = _chunk4YAWNZXMjs.getTextChildren; exports.getTotalTextLength = _chunk4YAWNZXMjs.getTotalTextLength; exports.hasChildren = _chunk4YAWNZXMjs.hasChildren; exports.validateJsxLinks = _chunk4YAWNZXMjs.validateJsxLinks; exports.validateTextLinks = _chunk4YAWNZXMjs.validateTextLinks; exports.walkJsx = _chunk4YAWNZXMjs.walkJsx;
 //# sourceMappingURL=ui.js.map

package/dist/ui.mjs

@@ -1,14 +1,22 @@
 import {
+  getJsxChildren,
+  getJsxElementFromComponent,
+  getTextChildren,
   getTotalTextLength,
   hasChildren,
-  validateComponentLinks,
-  validateTextLinks
-} from "./chunk-KP4ZAWMP.mjs";
+  validateJsxLinks,
+  validateTextLinks,
+  walkJsx
+} from "./chunk-MJGSG5N2.mjs";
 import "./chunk-JMDSN227.mjs";
 export {
+  getJsxChildren,
+  getJsxElementFromComponent,
+  getTextChildren,
   getTotalTextLength,
   hasChildren,
-  validateComponentLinks,
-  validateTextLinks
+  validateJsxLinks,
+  validateTextLinks,
+  walkJsx
 };
 //# sourceMappingURL=ui.mjs.map

package/dist/validation.js

@@ -1,7 +1,7 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunk4LELSKWGjs = require('./chunk-4LELSKWG.js');
-require('./chunk-E5WSD47S.js');
+var _chunk3ZSYZX3Ijs = require('./chunk-3ZSYZX3I.js');
+require('./chunk-IAHW6IFC.js');
 require('./chunk-HVTYDKBO.js');
 require('./chunk-M3KAAQFK.js');
 require('./chunk-6LOYTBS3.js');
@@ -20,5 +20,5 @@ require('./chunk-NUCLSR2G.js');
 require('./chunk-PHUTP7NB.js');
 
 
-exports.validateFetchedSnap = _chunk4LELSKWGjs.validateFetchedSnap;
+exports.validateFetchedSnap = _chunk3ZSYZX3Ijs.validateFetchedSnap;
 //# sourceMappingURL=validation.js.map

package/dist/validation.mjs

@@ -1,7 +1,7 @@
 import {
   validateFetchedSnap
-} from "./chunk-PBSBESZZ.mjs";
-import "./chunk-HTS6HGUU.mjs";
+} from "./chunk-RLA43SHY.mjs";
+import "./chunk-QNPXK3B3.mjs";
 import "./chunk-2M6G46W6.mjs";
 import "./chunk-MNCFAD4E.mjs";
 import "./chunk-EXUEHPZ4.mjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-utils",
-  "version": "7.2.0",
+  "version": "7.4.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
@@ -52,13 +52,13 @@
   "dependencies": {
     "@babel/core": "^7.23.2",
     "@babel/types": "^7.23.0",
-    "@metamask/base-controller": "^5.0.1",
-    "@metamask/key-tree": "^9.0.0",
+    "@metamask/base-controller": "^5.0.2",
+    "@metamask/key-tree": "^9.1.0",
     "@metamask/permission-controller": "^9.0.2",
     "@metamask/rpc-errors": "^6.2.1",
     "@metamask/slip44": "^3.1.0",
     "@metamask/snaps-registry": "^3.1.0",
-    "@metamask/snaps-sdk": "^4.0.1",
+    "@metamask/snaps-sdk": "^4.2.0",
     "@metamask/utils": "^8.3.0",
     "@noble/hashes": "^1.3.1",
     "@scure/base": "^1.1.1",

package/dist/chunk-3SOYDY4W.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/handlers.ts"],"names":[],"mappings":";AAYA,SAAS,eAAe,uBAAuB;AAC/C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAWA,IAAM,eAAe;AAAA,EAC1B,kCAAyB,GAAG;AAAA,IAC1B;AAAA,IACA,UAAU;AAAA,IACV,WAAW,CAAC,eAA2D;AACrE,aAAO,OAAO,eAAe;AAAA,IAC/B;AAAA,EACF;AAAA,EACA,oCAA0B,GAAG;AAAA,IAC3B;AAAA,IACA,UAAU;AAAA,IACV,WAAW,CAAC,eAA4D;AACtE,aAAO,OAAO,eAAe;AAAA,IAC/B;AAAA,EACF;AAAA,EACA,4BAAsB,GAAG;AAAA,IACvB;AAAA,IACA,UAAU;AAAA,IACV,WAAW,CAAC,eAAwD;AAClE,aAAO,OAAO,eAAe;AAAA,IAC/B;AAAA,EACF;AAAA,EACA,kCAAyB,GAAG;AAAA,IAC1B;AAAA,IACA,UAAU;AAAA,IACV,WAAW,CAAC,eAA2D;AACrE,aAAO,OAAO,eAAe;AAAA,IAC/B;AAAA,EACF;AAAA,EACA,4BAAsB,GAAG;AAAA,IACvB;AAAA,IACA,UAAU;AAAA,IACV,WAAW,CAAC,eAAwD;AAClE,aAAO,OAAO,eAAe;AAAA,IAC/B;AAAA,EACF;AAAA,EACA,0BAAqB,GAAG;AAAA,IACtB;AAAA,IACA,UAAU;AAAA,IACV,WAAW,CAAC,eAAuD;AACjE,aAAO,OAAO,eAAe;AAAA,IAC/B;AAAA,EACF;AAAA,EACA,0CAA6B,GAAG;AAAA,IAC9B;AAAA,IACA,UAAU;AAAA,IACV,WAAW,CAAC,eAA+D;AACzE,aAAO,OAAO,eAAe;AAAA,IAC/B;AAAA,EACF;AAAA,EACA,8BAAuB,GAAG;AAAA,IACxB;AAAA,IACA,UAAU;AAAA,IACV,WAAW,CAAC,eAAyD;AACnE,aAAO,OAAO,eAAe;AAAA,IAC/B;AAAA,EACF;AAAA,EACA,gCAAwB,GAAG;AAAA,IACzB;AAAA,IACA,UAAU;AAAA,IACV,WAAW,CAAC,eAA0D;AACpE,aAAO,OAAO,eAAe;AAAA,IAC/B;AAAA,EACF;AAAA,EACA,gCAAwB,GAAG;AAAA,IACzB;AAAA,IACA,UAAU;AAAA,IACV,WAAW,CAAC,eAA0D;AACpE,aAAO,OAAO,eAAe;AAAA,IAC/B;AAAA,EACF;AACF;AAEO,IAAM,sCAAsC,OAAO;AAAA,EACxD,UAAU,SAAS,QAAQ,cAAc,QAAQ,CAAC;AACpD,CAAC;AAEM,IAAM,oCAAoC;AAAA,EAC/C;AAAA,EACA,OAAO;AAAA,IACL,IAAI,OAAO;AAAA,EACb,CAAC;AACH;AAEO,IAAM,yCAAyC;AAAA,EACpD;AAAA,EACA,OAAO;AAAA,IACL,SAAS;AAAA,EACX,CAAC;AACH;AAEO,IAAM,8BAA8B;AAAA,EACzC,MAAM;AAAA,IACJ;AAAA,IACA;AAAA,EACF,CAAC;AACH;AAEO,IAAM,4BAA4B;AAElC,IAAM,sCAAsC,OAAO;AAAA,EACxD,SAAS;AACX,CAAC;AAEM,IAAM,iCAAiC,OAAO;AAAA,EACnD,IAAI,OAAO;AACb,CAAC;AAEM,IAAM,2BAA2B,MAAM;AAAA,EAC5C;AAAA,EACA;AACF,CAAC;AAEM,IAAM,0BAA0B,OAAO;AAAA,EAC5C,UAAU,OAAO;AAAA,EACjB,gBAAgB,OAAO;AACzB,CAAC;AAEM,IAAM,yBAAyB,OAAO;AAAA,EAC3C,UAAU,OAAO;AAAA,EACjB,iBAAiB,OAAO;AAC1B,CAAC;AAEM,IAAM,kCAAkC,OAAO;AAAA,EACpD,iBAAiB,KAAK,MAAM,uBAAuB,GAAG,GAAG,QAAQ;AACnE,CAAC;AAEM,IAAM,iCAAiC,OAAO;AAAA,EACnD,mBAAmB,KAAK,MAAM,sBAAsB,GAAG,GAAG,QAAQ;AACpE,CAAC;AAEM,IAAM,6BAA6B;AAAA,EACxC,MAAM,CAAC,iCAAiC,8BAA8B,CAAC;AACzE","sourcesContent":["import type {\n  OnCronjobHandler,\n  OnHomePageHandler,\n  OnInstallHandler,\n  OnKeyringRequestHandler,\n  OnNameLookupHandler,\n  OnRpcRequestHandler,\n  OnSignatureHandler,\n  OnTransactionHandler,\n  OnUpdateHandler,\n  OnUserInputHandler,\n} from '@metamask/snaps-sdk';\nimport { SeverityLevel, ComponentStruct } from '@metamask/snaps-sdk';\nimport {\n  assign,\n  literal,\n  nullable,\n  object,\n  optional,\n  string,\n  array,\n  size,\n  union,\n} from 'superstruct';\n\nimport type { SnapHandler } from './handler-types';\nimport { HandlerType } from './handler-types';\n\nexport type SnapRpcHookArgs = {\n  origin: string;\n  handler: HandlerType;\n  request: Record<string, unknown>;\n};\n\nexport const SNAP_EXPORTS = {\n  [HandlerType.OnRpcRequest]: {\n    type: HandlerType.OnRpcRequest,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnRpcRequestHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnTransaction]: {\n    type: HandlerType.OnTransaction,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnTransactionHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnCronjob]: {\n    type: HandlerType.OnCronjob,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnCronjobHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnNameLookup]: {\n    type: HandlerType.OnNameLookup,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnNameLookupHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnInstall]: {\n    type: HandlerType.OnInstall,\n    required: false,\n    validator: (snapExport: unknown): snapExport is OnInstallHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnUpdate]: {\n    type: HandlerType.OnUpdate,\n    required: false,\n    validator: (snapExport: unknown): snapExport is OnUpdateHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnKeyringRequest]: {\n    type: HandlerType.OnKeyringRequest,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnKeyringRequestHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnHomePage]: {\n    type: HandlerType.OnHomePage,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnHomePageHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnSignature]: {\n    type: HandlerType.OnSignature,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnSignatureHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnUserInput]: {\n    type: HandlerType.OnUserInput,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnUserInputHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n} as const;\n\nexport const OnTransactionSeverityResponseStruct = object({\n  severity: optional(literal(SeverityLevel.Critical)),\n});\n\nexport const OnTransactionResponseWithIdStruct = assign(\n  OnTransactionSeverityResponseStruct,\n  object({\n    id: string(),\n  }),\n);\n\nexport const OnTransactionResponseWithContentStruct = assign(\n  OnTransactionSeverityResponseStruct,\n  object({\n    content: ComponentStruct,\n  }),\n);\n\nexport const OnTransactionResponseStruct = nullable(\n  union([\n    OnTransactionResponseWithContentStruct,\n    OnTransactionResponseWithIdStruct,\n  ]),\n);\n\nexport const OnSignatureResponseStruct = OnTransactionResponseStruct;\n\nexport const OnHomePageResponseWithContentStruct = object({\n  content: ComponentStruct,\n});\n\nexport const OnHomePageResponseWithIdStruct = object({\n  id: string(),\n});\n\nexport const OnHomePageResponseStruct = union([\n  OnHomePageResponseWithContentStruct,\n  OnHomePageResponseWithIdStruct,\n]);\n\nexport const AddressResolutionStruct = object({\n  protocol: string(),\n  resolvedDomain: string(),\n});\n\nexport const DomainResolutionStruct = object({\n  protocol: string(),\n  resolvedAddress: string(),\n});\n\nexport const AddressResolutionResponseStruct = object({\n  resolvedDomains: size(array(AddressResolutionStruct), 1, Infinity),\n});\n\nexport const DomainResolutionResponseStruct = object({\n  resolvedAddresses: size(array(DomainResolutionStruct), 1, Infinity),\n});\n\nexport const OnNameLookupResponseStruct = nullable(\n  union([AddressResolutionResponseStruct, DomainResolutionResponseStruct]),\n);\n\n/**\n * Utility type for getting the handler function type from a handler type.\n */\nexport type HandlerFunction<Type extends SnapHandler> =\n  Type['validator'] extends (snapExport: unknown) => snapExport is infer Handler\n    ? Handler\n    : never;\n\n/**\n * All the function-based handlers that a snap can implement.\n */\nexport type SnapFunctionExports = {\n  [Key in keyof typeof SNAP_EXPORTS]?: HandlerFunction<\n    (typeof SNAP_EXPORTS)[Key]\n  >;\n};\n\n/**\n * All handlers that a snap can implement.\n */\nexport type SnapExports = SnapFunctionExports;\n"]}

package/dist/chunk-E5WSD47S.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/manifest/validation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAAS,+BAA+B;AAExC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAaP,IAAM,qBAA+B;AAAA,EACnC;AAAA,EACA;AACF;AAEO,IAAM,uBAAiC,CAAC,EAAE;AACjD,IAAM,kBAA8B,qBAAqB,IAAI,CAAC,aAAa;AAAA,EACzE;AAAA,EACA;AAAA,EACA,GAAG,QAAQ;AACb,CAAC;AAEM,IAAM,kBAAkB;AAAA,EAC7B,MAAM,OAAO,CAAC;AAAA,EACd;AAAA,EACA,CAAC,SAAmB;AAClB,QAAI,KAAK,WAAW,GAAG;AACrB,aAAO;AAAA,IACT;AAEA,QAAI,KAAK,CAAC,MAAM,KAAK;AACnB,aAAO;AAAA,IACT;AAEA,QAAI,KAAK,SAAS,GAAG;AACnB,aAAO;AAAA,IACT;AAEA,QAAI,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,wBAAwB,IAAI,CAAC,GAAG;AAChE,aAAO;AAAA,IACT;AAEA,QAAI,mBAAmB,SAAS,KAAK,CAAC,CAAC,GAAG;AACxC,aAAO,gBAAgB,KAAK,CAAC,CAAC;AAAA,IAChC;AAEA,QACE,gBAAgB;AAAA,MAAK,CAAC,kBACpB,QAAQ,KAAK,MAAM,GAAG,cAAc,MAAM,GAAG,aAAa;AAAA,IAC5D,GACA;AACA,aAAO,aAAa,KAAK;AAAA,QACvB;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,eAAe,CAI1B,WAEA,OAAO,QAAQ,kBAAkB,CAAC,UAAU;AAC1C,MACE,MAAM,UAAU,aAChB,MAAM,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,GAAG,CAAC,GACtD;AACA,WAAO;AAAA,EACT;AAEA,SAAO;AACT,CAAC;AAGI,IAAM,qBAAqB;AAAA,EAChC,KAAK;AAAA,IACH,MAAM;AAAA,IACN,OAAO,MAAM,CAAC,WAAW,WAAW,CAAC;AAAA,EACvC,CAAC;AACH;AAIO,IAAM,uCAAuC;AAAA,EAClD,MAAM,kBAAkB;AAAA,EACxB;AAAA,EACA;AACF;AAEO,IAAM,oBAAoB,OAAO,OAAO,GAAG,gBAAgB,CAAC,UAAU;AAC3E,MAAI,mBAAmB,KAAK,GAAG;AAC7B,WAAO;AAAA,EACT;AACA,SAAO;AACT,CAAC;AAEM,IAAM,gBAAgB;AAAA,EAC3B,OAAO,cAAc,OAAO,EAAE,SAAS,SAAS,iBAAiB,EAAE,CAAC,CAAC;AAAA,EACrE;AAAA,EACA,CAAC,UAAU;AACT,QAAI,OAAO,KAAK,KAAK,EAAE,WAAW,GAAG;AACnC,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AACF;AAIO,IAAM,iBAAiB,KAAK,MAAM,aAAa,GAAG,GAAG,QAAQ;AAE7D,IAAM,uBAAuB,MAAM;AAAA,EACxC,OAAO;AAAA,IACL,MAAM,KAAK,MAAM,OAAO,CAAC,GAAG,GAAG,QAAQ;AAAA,EACzC,CAAC;AAAA,EACD,OAAO;AAAA,IACL,SAAS,KAAK,MAAM,OAAO,CAAC,GAAG,GAAG,QAAQ;AAAA,EAC5C,CAAC;AAAA,EACD,OAAO;AAAA,IACL,MAAM,KAAK,MAAM,OAAO,CAAC,GAAG,GAAG,QAAQ;AAAA,IACvC,SAAS,KAAK,MAAM,OAAO,CAAC,GAAG,GAAG,QAAQ;AAAA,EAC5C,CAAC;AACH,CAAC;AAEM,IAAM,0BAA0B,eAAe,GAAG,SAAS,MAAM;AACjE,IAAM,0BAA0B,eAAe,GAAG,SAAS,MAAM;AAEjE,IAAM,uBAAuB;AAAA,EAClC,QAAQ;AAAA,EACR;AAAA,EACA;AACF;AAGO,IAAM,uBAAuB,OAAO;AAAA,EACzC,gBAAgB,SAAS,oBAAoB;AAC/C,CAAC;AAIM,IAAM,oBAAoB,OAAoB,CAAC,CAAC;AAMhD,IAAM,oBAAkD,KAAK;AAAA,EAClE,qBAAqB;AAAA,IACnB;AAAA,MACE;AAAA,MACA,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAAA,IAClD;AAAA,EACF;AAAA,EACA,+BAA+B,SAAS,iBAAiB;AAAA,EACzD,qBAAqB;AAAA,IACnB,OAAO,sBAAsB,oBAAoB;AAAA,EACnD;AAAA,EACA,6BAA6B,SAAS,oBAAoB;AAAA,EAC1D,yBAAyB;AAAA,IACvB;AAAA,MACE;AAAA,MACA,OAAO;AAAA,QACL,QAAQ,SAAS,cAAc;AAAA,QAC/B,UAAU,SAAS,oBAAoB;AAAA,MACzC,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EACA,4BAA4B,SAAS,iBAAiB;AAAA,EACtD,uBAAuB,SAAS,oBAAoB;AAAA,EACpD,iBAAiB,SAAS,OAAO,sBAAsB,gBAAgB,CAAC;AAAA,EACxE,+BAA+B;AAAA,IAC7B;AAAA,MACE;AAAA,MACA,OAAO;AAAA,QACL,sBAAsB,SAAS,QAAQ,CAAC;AAAA,MAC1C,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EACA,iCAAiC;AAAA,IAC/B;AAAA,MACE;AAAA,MACA,OAAO;AAAA,QACL,wBAAwB,SAAS,QAAQ,CAAC;AAAA,MAC5C,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EACA,yBAAyB,SAAS,iBAAiB;AAAA,EACnD,aAAa,SAAS,iBAAiB;AAAA,EACvC,kBAAkB,SAAS,iBAAiB;AAAA,EAC5C,qBAAqB,SAAS,iBAAiB;AAAA,EAC/C,aAAa,SAAS,iBAAiB;AAAA,EACvC,sBAAsB,SAAS,oCAAoC;AAAA,EACnE,wBAAwB,SAAS,oCAAoC;AAAA,EACrE,sBAAsB;AAAA,IACpB;AAAA,MACE,MAAM,OAAO,EAAE,UAAU,KAAK,QAAQ,GAAG,GAAG,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC;AAAA,MAC3D;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EACA,iBAAiB,SAAS,iBAAiB;AAAA,EAC3C,gBAAgB,SAAS,iBAAiB;AAAA,EAC1C,aAAa,SAAS,aAAa;AACrC,CAAC;AAQM,IAAM,0BAA0B,MAAM,OAAO,CAAC;AAE9C,IAAM,2BAA2B;AAAA,EACtC,aAAa,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;AAAA,EAC9B,OAAO,CAAC,CAAC;AACX;AAIO,IAAM,qBAAqB,OAAO;AAAA,EACvC,SAAS;AAAA,EACT,aAAa,KAAK,OAAO,GAAG,GAAG,GAAG;AAAA,EAClC,cAAc,KAAK,OAAO,GAAG,GAAG,GAAG;AAAA,EACnC,YAAY;AAAA,IACV,OAAO;AAAA,MACL,MAAM,KAAK,OAAO,GAAG,GAAG,QAAQ;AAAA,MAChC,KAAK,KAAK,OAAO,GAAG,GAAG,QAAQ;AAAA,IACjC,CAAC;AAAA,EACH;AAAA,EACA,QAAQ,OAAO;AAAA,IACb,QAAQ;AAAA,IACR,UAAU,OAAO;AAAA,MACf,KAAK,OAAO;AAAA,QACV,UAAU,KAAK,OAAO,GAAG,GAAG,QAAQ;AAAA,QACpC,UAAU,SAAS,KAAK,OAAO,GAAG,GAAG,QAAQ,CAAC;AAAA,QAC9C,aAAa;AAAA,QACb,UAAU,MAAM;AAAA,UACd,QAAQ,4BAA4B;AAAA,UACpC,QAAQ,6BAA6B;AAAA,QACvC,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAAA,IACD,OAAO,SAAS,uBAAuB;AAAA,IACvC,SAAS,SAAS,uBAAuB;AAAA,EAC3C,CAAC;AAAA,EACD,oBAAoB,SAAS,wBAAwB;AAAA,EACrD,oBAAoB;AAAA,EACpB,iBAAiB,QAAQ,KAAK;AAAA,EAC9B,SAAS,SAAS,OAAO,CAAC;AAAA;AAC5B,CAAC;AAUM,SAAS,eAAe,OAAuC;AACpE,SAAO,GAAG,OAAO,kBAAkB;AACrC;AAQO,SAAS,qBACd,OAC+B;AAC/B;AAAA,IACE;AAAA,IACA;AAAA,IACA,uCAA6B;AAAA,EAC/B;AACF;AASO,SAAS,mBAAmB,OAA8B;AAE/D,SAAO,OAAO,OAAO,kBAAkB;AACzC","sourcesContent":["import { isValidBIP32PathSegment } from '@metamask/key-tree';\nimport type { EmptyObject, InitialPermissions } from '@metamask/snaps-sdk';\nimport {\n  assertStruct,\n  ChecksumStruct,\n  VersionStruct,\n  isValidSemVerRange,\n  inMilliseconds,\n  Duration,\n} from '@metamask/utils';\nimport type { Describe, Infer, Struct } from 'superstruct';\nimport {\n  array,\n  boolean,\n  create,\n  enums,\n  integer,\n  is,\n  literal,\n  object,\n  optional,\n  refine,\n  record,\n  size,\n  string,\n  type,\n  union,\n  intersection,\n  assign,\n} from 'superstruct';\n\nimport { isEqual } from '../array';\nimport { CronjobSpecificationArrayStruct } from '../cronjob';\nimport { SIP_6_MAGIC_VALUE, STATE_ENCRYPTION_MAGIC_VALUE } from '../entropy';\nimport { KeyringOriginsStruct, RpcOriginsStruct } from '../json-rpc';\nimport { ChainIdStruct } from '../namespace';\nimport { SnapIdStruct } from '../snaps';\nimport type { InferMatching } from '../structs';\nimport { NameStruct, NpmSnapFileNames, uri } 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\nexport const FORBIDDEN_COIN_TYPES: number[] = [60];\nconst FORBIDDEN_PATHS: string[][] = FORBIDDEN_COIN_TYPES.map((coinType) => [\n  'm',\n  \"44'\",\n  `${coinType}'`,\n]);\n\nexport const Bip32PathStruct = refine(\n  array(string()),\n  'BIP-32 path',\n  (path: string[]) => {\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) => !isValidBIP32PathSegment(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    if (\n      FORBIDDEN_PATHS.some((forbiddenPath) =>\n        isEqual(path.slice(0, forbiddenPath.length), forbiddenPath),\n      )\n    ) {\n      return `The path \"${path.join(\n        '/',\n      )}\" is not allowed for entropy derivation.`;\n    }\n\n    return true;\n  },\n);\n\nexport const bip32entropy = <\n  Type extends { path: string[]; curve: string },\n  Schema,\n>(\n  struct: Struct<Type, Schema>,\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\nexport const ChainIdsStruct = size(array(ChainIdStruct), 1, Infinity);\n\nexport const LookupMatchersStruct = union([\n  object({\n    tlds: size(array(string()), 1, Infinity),\n  }),\n  object({\n    schemes: size(array(string()), 1, Infinity),\n  }),\n  object({\n    tlds: size(array(string()), 1, Infinity),\n    schemes: size(array(string()), 1, Infinity),\n  }),\n]);\n\nexport const MINIMUM_REQUEST_TIMEOUT = inMilliseconds(5, Duration.Second);\nexport const MAXIMUM_REQUEST_TIMEOUT = inMilliseconds(3, Duration.Minute);\n\nexport const MaxRequestTimeStruct = size(\n  integer(),\n  MINIMUM_REQUEST_TIMEOUT,\n  MAXIMUM_REQUEST_TIMEOUT,\n);\n\n// Utility type to union with for all handler structs\nexport const HandlerCaveatsStruct = object({\n  maxRequestTime: optional(MaxRequestTimeStruct),\n});\n\nexport type HandlerCaveats = Infer<typeof HandlerCaveatsStruct>;\n\nexport const EmptyObjectStruct = object<EmptyObject>({}) as unknown as Struct<\n  EmptyObject,\n  null\n>;\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const PermissionsStruct: Describe<InitialPermissions> = type({\n  'endowment:cronjob': optional(\n    assign(\n      HandlerCaveatsStruct,\n      object({ jobs: CronjobSpecificationArrayStruct }),\n    ),\n  ),\n  'endowment:ethereum-provider': optional(EmptyObjectStruct),\n  'endowment:keyring': optional(\n    assign(HandlerCaveatsStruct, KeyringOriginsStruct),\n  ),\n  'endowment:lifecycle-hooks': optional(HandlerCaveatsStruct),\n  'endowment:name-lookup': optional(\n    assign(\n      HandlerCaveatsStruct,\n      object({\n        chains: optional(ChainIdsStruct),\n        matchers: optional(LookupMatchersStruct),\n      }),\n    ),\n  ),\n  'endowment:network-access': optional(EmptyObjectStruct),\n  'endowment:page-home': optional(HandlerCaveatsStruct),\n  'endowment:rpc': optional(assign(HandlerCaveatsStruct, RpcOriginsStruct)),\n  'endowment:signature-insight': optional(\n    assign(\n      HandlerCaveatsStruct,\n      object({\n        allowSignatureOrigin: optional(boolean()),\n      }),\n    ),\n  ),\n  'endowment:transaction-insight': optional(\n    assign(\n      HandlerCaveatsStruct,\n      object({\n        allowTransactionOrigin: optional(boolean()),\n      }),\n    ),\n  ),\n  'endowment:webassembly': optional(EmptyObjectStruct),\n  snap_dialog: optional(EmptyObjectStruct),\n  snap_manageState: optional(EmptyObjectStruct),\n  snap_manageAccounts: optional(EmptyObjectStruct),\n  snap_notify: optional(EmptyObjectStruct),\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(EmptyObjectStruct),\n  snap_getLocale: optional(EmptyObjectStruct),\n  wallet_snap: optional(SnapIdsStruct),\n});\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport type SnapPermissions = InferMatching<\n  typeof PermissionsStruct,\n  InitialPermissions\n>;\n\nexport const SnapAuxilaryFilesStruct = array(string());\n\nexport const InitialConnectionsStruct = record(\n  intersection([string(), uri()]),\n  object({}),\n);\n\nexport type InitialConnections = Infer<typeof InitialConnectionsStruct>;\n\nexport const SnapManifestStruct = object({\n  version: VersionStruct,\n  description: size(string(), 1, 280),\n  proposedName: size(string(), 1, 214),\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    files: optional(SnapAuxilaryFilesStruct),\n    locales: optional(SnapAuxilaryFilesStruct),\n  }),\n  initialConnections: optional(InitialConnectionsStruct),\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 * @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"]}