@metamask/snaps-rpc-methods 11.0.0 → 11.1.1

package/dist/restricted/dialog.mjs

@@ -1,11 +1,218 @@
-import {
-  DIALOG_APPROVAL_TYPES,
-  dialogBuilder,
-  getDialogImplementation
-} from "../chunk-TQCUJQHY.mjs";
-export {
-  DIALOG_APPROVAL_TYPES,
-  dialogBuilder,
-  getDialogImplementation
+import { PermissionType, SubjectType } from "@metamask/permission-controller";
+import { rpcErrors } from "@metamask/rpc-errors";
+import { DialogType, enumValue, ComponentOrElementStruct, selectiveUnion } from "@metamask/snaps-sdk";
+import { create, object, optional, size, string } from "@metamask/superstruct";
+import { hasProperty, isObject, isPlainObject } from "@metamask/utils";
+const methodName = 'snap_dialog';
+export const DIALOG_APPROVAL_TYPES = {
+    [DialogType.Alert]: `${methodName}:alert`,
+    [DialogType.Confirmation]: `${methodName}:confirmation`,
+    [DialogType.Prompt]: `${methodName}:prompt`,
+    default: methodName,
 };
+const PlaceholderStruct = optional(size(string(), 1, 40));
+/**
+ * The specification builder for the `snap_dialog` permission. `snap_dialog`
+ * lets the Snap display one of the following dialogs to the user:
+ * - An alert, for displaying information.
+ * - A confirmation, for accepting or rejecting some action.
+ * - A prompt, for inputting some information.
+ *
+ * @param options - The specification builder options.
+ * @param options.allowedCaveats - The optional allowed caveats for the
+ * permission.
+ * @param options.methodHooks - The RPC method hooks needed by the method
+ * implementation.
+ * @returns The specification for the `snap_dialog` permission.
+ */
+const specificationBuilder = ({ allowedCaveats = null, methodHooks, }) => {
+    return {
+        permissionType: PermissionType.RestrictedMethod,
+        targetName: methodName,
+        allowedCaveats,
+        methodImplementation: getDialogImplementation(methodHooks),
+        subjectTypes: [SubjectType.Snap],
+    };
+};
+const methodHooks = {
+    requestUserApproval: true,
+    createInterface: true,
+    getInterface: true,
+};
+export const dialogBuilder = Object.freeze({
+    targetName: methodName,
+    specificationBuilder,
+    methodHooks,
+});
+const AlertParametersWithContentStruct = object({
+    type: enumValue(DialogType.Alert),
+    content: ComponentOrElementStruct,
+});
+const AlertParametersWithIdStruct = object({
+    type: enumValue(DialogType.Alert),
+    id: string(),
+});
+const AlertParametersStruct = selectiveUnion((value) => {
+    if (isPlainObject(value) && hasProperty(value, 'id')) {
+        return AlertParametersWithIdStruct;
+    }
+    return AlertParametersWithContentStruct;
+});
+const ConfirmationParametersWithContentStruct = object({
+    type: enumValue(DialogType.Confirmation),
+    content: ComponentOrElementStruct,
+});
+const ConfirmationParametersWithIdStruct = object({
+    type: enumValue(DialogType.Confirmation),
+    id: string(),
+});
+const ConfirmationParametersStruct = selectiveUnion((value) => {
+    if (isPlainObject(value) && hasProperty(value, 'id')) {
+        return ConfirmationParametersWithIdStruct;
+    }
+    return ConfirmationParametersWithContentStruct;
+});
+const PromptParametersWithContentStruct = object({
+    type: enumValue(DialogType.Prompt),
+    content: ComponentOrElementStruct,
+    placeholder: PlaceholderStruct,
+});
+const PromptParametersWithIdStruct = object({
+    type: enumValue(DialogType.Prompt),
+    id: string(),
+    placeholder: PlaceholderStruct,
+});
+const PromptParametersStruct = selectiveUnion((value) => {
+    if (isPlainObject(value) && hasProperty(value, 'id')) {
+        return PromptParametersWithIdStruct;
+    }
+    return PromptParametersWithContentStruct;
+});
+const DefaultParametersWithContentStruct = object({
+    content: ComponentOrElementStruct,
+});
+const DefaultParametersWithIdStruct = object({
+    id: string(),
+});
+const DefaultParametersStruct = selectiveUnion((value) => {
+    if (isPlainObject(value) && hasProperty(value, 'id')) {
+        return DefaultParametersWithIdStruct;
+    }
+    return DefaultParametersWithContentStruct;
+});
+const DialogParametersStruct = selectiveUnion((value) => {
+    if (isPlainObject(value) && hasProperty(value, 'type')) {
+        switch (value.type) {
+            // We cannot use typedUnion here unfortunately.
+            case DialogType.Alert:
+                return AlertParametersStruct;
+            case DialogType.Confirmation:
+                return ConfirmationParametersStruct;
+            case DialogType.Prompt:
+                return PromptParametersStruct;
+            default:
+                throw new Error(`The "type" property must be one of: ${Object.values(DialogType).join(', ')}.`);
+        }
+    }
+    return DefaultParametersStruct;
+});
+/**
+ * Builds the method implementation for `snap_dialog`.
+ *
+ * @param hooks - The RPC method hooks.
+ * @param hooks.requestUserApproval - A function that creates a new Approval in the ApprovalController.
+ * This function should return a Promise that resolves with the appropriate value when the user has approved or rejected the request.
+ * @param hooks.createInterface - A function that creates the interface in SnapInterfaceController.
+ * @param hooks.getInterface - A function that gets an interface from SnapInterfaceController.
+ * @returns The method implementation which return value depends on the dialog
+ * type, valid return types are: string, boolean, null.
+ */
+export function getDialogImplementation({ requestUserApproval, createInterface, getInterface, }) {
+    return async function dialogImplementation(args) {
+        const { params, context: { origin }, } = args;
+        if (!isObject(params)) {
+            throw rpcErrors.invalidParams({
+                message: 'Invalid params: Expected params to be a single object.',
+            });
+        }
+        const validatedParams = getValidatedParams(params);
+        const placeholder = isPromptDialog(validatedParams)
+            ? validatedParams.placeholder
+            : undefined;
+        const validatedType = hasProperty(validatedParams, 'type')
+            ? validatedParams.type
+            : 'default';
+        const approvalType = DIALOG_APPROVAL_TYPES[validatedType];
+        if (hasProperty(validatedParams, 'content')) {
+            const id = await createInterface(origin, validatedParams.content);
+            return requestUserApproval({
+                id: approvalType === DIALOG_APPROVAL_TYPES.default ? id : undefined,
+                origin,
+                type: approvalType,
+                requestData: { id, placeholder },
+            });
+        }
+        validateInterface(origin, validatedParams.id, getInterface);
+        return requestUserApproval({
+            id: approvalType === DIALOG_APPROVAL_TYPES.default
+                ? validatedParams.id
+                : undefined,
+            origin,
+            type: approvalType,
+            requestData: { id: validatedParams.id, placeholder },
+        });
+    };
+}
+/**
+ * Validate that the interface ID is valid.
+ *
+ * @param origin - The origin of the request.
+ * @param id - The interface ID.
+ * @param getInterface - The function to get the interface.
+ */
+function validateInterface(origin, id, getInterface) {
+    try {
+        getInterface(origin, id);
+    }
+    catch (error) {
+        throw rpcErrors.invalidParams({
+            message: `Invalid params: ${error.message}`,
+        });
+    }
+}
+/**
+ * Gets the dialog type from the dialog parameters.
+ *
+ * @param params - The dialog parameters.
+ * @returns The dialog type.
+ */
+function getDialogType(params) {
+    return hasProperty(params, 'type') ? params.type : undefined;
+}
+/**
+ * Checks if the dialog parameters are for a prompt dialog.
+ *
+ * @param params - The dialog parameters.
+ * @returns `true` if the dialog parameters are for a prompt dialog, `false` otherwise.
+ */
+function isPromptDialog(params) {
+    return getDialogType(params) === DialogType.Prompt;
+}
+/**
+ * Validates the confirm method `params` and returns them cast to the correct
+ * type. Throws if validation fails.
+ *
+ * @param params - The unvalidated params object from the method request.
+ * @returns The validated confirm method parameter object.
+ */
+function getValidatedParams(params) {
+    try {
+        return create(params, DialogParametersStruct);
+    }
+    catch (error) {
+        throw rpcErrors.invalidParams({
+            message: `Invalid params: ${error.message}`,
+        });
+    }
+}
 //# sourceMappingURL=dialog.mjs.map

package/dist/restricted/dialog.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"dialog.mjs","sourceRoot":"","sources":["../../src/restricted/dialog.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAC9E,OAAO,EAAE,SAAS,EAAE,6BAA6B;AACjD,OAAO,EACL,UAAU,EACV,SAAS,EACT,wBAAwB,EACxB,cAAc,EACf,4BAA4B;AAW7B,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,8BAA8B;AAE/E,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,wBAAwB;AAIvE,MAAM,UAAU,GAAG,aAAa,CAAC;AAMjC,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,GAAG,UAAU,QAAQ;IACzC,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,GAAG,UAAU,eAAe;IACvD,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,SAAS;IAC3C,OAAO,EAAE,UAAU;CACpB,CAAC;AAEF,MAAM,iBAAiB,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAgE1D;;;;;;;;;;;;;GAaG;AACH,MAAM,oBAAoB,GAItB,CAAC,EACH,cAAc,GAAG,IAAI,EACrB,WAAW,GACuB,EAAE,EAAE;IACtC,OAAO;QACL,cAAc,EAAE,cAAc,CAAC,gBAAgB;QAC/C,UAAU,EAAE,UAAU;QACtB,cAAc;QACd,oBAAoB,EAAE,uBAAuB,CAAC,WAAW,CAAC;QAC1D,YAAY,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAyC;IACxD,mBAAmB,EAAE,IAAI;IACzB,eAAe,EAAE,IAAI;IACrB,YAAY,EAAE,IAAI;CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;IACzC,UAAU,EAAE,UAAU;IACtB,oBAAoB;IACpB,WAAW;CACH,CAAC,CAAC;AAEZ,MAAM,gCAAgC,GAAG,MAAM,CAAC;IAC9C,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC;IACjC,OAAO,EAAE,wBAAwB;CAClC,CAAC,CAAC;AAEH,MAAM,2BAA2B,GAAG,MAAM,CAAC;IACzC,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC;IACjC,EAAE,EAAE,MAAM,EAAE;CACb,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE;IACrD,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrD,OAAO,2BAA2B,CAAC;IACrC,CAAC;IACD,OAAO,gCAAgC,CAAC;AAC1C,CAAC,CAAC,CAAC;AAEH,MAAM,uCAAuC,GAAG,MAAM,CAAC;IACrD,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC;IACxC,OAAO,EAAE,wBAAwB;CAClC,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,MAAM,CAAC;IAChD,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC;IACxC,EAAE,EAAE,MAAM,EAAE;CACb,CAAC,CAAC;AAEH,MAAM,4BAA4B,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE;IAC5D,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrD,OAAO,kCAAkC,CAAC;IAC5C,CAAC;IACD,OAAO,uCAAuC,CAAC;AACjD,CAAC,CAAC,CAAC;AAEH,MAAM,iCAAiC,GAAG,MAAM,CAAC;IAC/C,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC;IAClC,OAAO,EAAE,wBAAwB;IACjC,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CAAC;AAEH,MAAM,4BAA4B,GAAG,MAAM,CAAC;IAC1C,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC;IAClC,EAAE,EAAE,MAAM,EAAE;IACZ,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE;IACtD,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrD,OAAO,4BAA4B,CAAC;IACtC,CAAC;IACD,OAAO,iCAAiC,CAAC;AAC3C,CAAC,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,MAAM,CAAC;IAChD,OAAO,EAAE,wBAAwB;CAClC,CAAC,CAAC;AAEH,MAAM,6BAA6B,GAAG,MAAM,CAAC;IAC3C,EAAE,EAAE,MAAM,EAAE;CACb,CAAC,CAAC;AAEH,MAAM,uBAAuB,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE;IACvD,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrD,OAAO,6BAA6B,CAAC;IACvC,CAAC;IACD,OAAO,kCAAkC,CAAC;AAC5C,CAAC,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE;IACtD,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;QACvD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,+CAA+C;YAC/C,KAAK,UAAU,CAAC,KAAK;gBACnB,OAAO,qBAAqB,CAAC;YAC/B,KAAK,UAAU,CAAC,YAAY;gBAC1B,OAAO,4BAA4B,CAAC;YACtC,KAAK,UAAU,CAAC,MAAM;gBACpB,OAAO,sBAAsB,CAAC;YAChC;gBACE,MAAM,IAAI,KAAK,CACb,uCAAuC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CACnE,IAAI,CACL,GAAG,CACL,CAAC;QACN,CAAC;IACH,CAAC;IACD,OAAO,uBAAuB,CAAC;AACjC,CAAC,CAAC,CAAC;AAOH;;;;;;;;;;GAUG;AACH,MAAM,UAAU,uBAAuB,CAAC,EACtC,mBAAmB,EACnB,eAAe,EACf,YAAY,GACM;IAClB,OAAO,KAAK,UAAU,oBAAoB,CACxC,IAA+C;QAE/C,MAAM,EACJ,MAAM,EACN,OAAO,EAAE,EAAE,MAAM,EAAE,GACpB,GAAG,IAAI,CAAC;QAET,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACtB,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,wDAAwD;aAClE,CAAC,CAAC;QACL,CAAC;QAED,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC;YACjD,CAAC,CAAC,eAAe,CAAC,WAAW;YAC7B,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,aAAa,GAAG,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC;YACxD,CAAC,CAAC,eAAe,CAAC,IAAI;YACtB,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,YAAY,GAChB,qBAAqB,CACnB,aAAmD,CACpD,CAAC;QAEJ,IAAI,WAAW,CAAC,eAAe,EAAE,SAAS,CAAC,EAAE,CAAC;YAC5C,MAAM,EAAE,GAAG,MAAM,eAAe,CAC9B,MAAM,EACN,eAAe,CAAC,OAAoB,CACrC,CAAC;YAEF,OAAO,mBAAmB,CAAC;gBACzB,EAAE,EAAE,YAAY,KAAK,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;gBACnE,MAAM;gBACN,IAAI,EAAE,YAAY;gBAClB,WAAW,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;aACjC,CAAC,CAAC;QACL,CAAC;QAED,iBAAiB,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;QAE5D,OAAO,mBAAmB,CAAC;YACzB,EAAE,EACA,YAAY,KAAK,qBAAqB,CAAC,OAAO;gBAC5C,CAAC,CAAC,eAAe,CAAC,EAAE;gBACpB,CAAC,CAAC,SAAS;YACf,MAAM;YACN,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,EAAE,EAAE,EAAE,eAAe,CAAC,EAAE,EAAE,WAAW,EAAE;SACrD,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AACD;;;;;;GAMG;AACH,SAAS,iBAAiB,CACxB,MAAc,EACd,EAAU,EACV,YAA0B;IAE1B,IAAI,CAAC;QACH,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,MAAwB;IAC7C,OAAO,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAE,MAAM,CAAC,IAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/E,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CAAC,MAAwB;IAC9C,OAAO,aAAa,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC,MAAM,CAAC;AACrD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport {\n  DialogType,\n  enumValue,\n  ComponentOrElementStruct,\n  selectiveUnion,\n} from '@metamask/snaps-sdk';\nimport type {\n  DialogParams,\n  Component,\n  InterfaceState,\n  SnapId,\n  PromptDialog,\n  ComponentOrElement,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { create, object, optional, size, string } from '@metamask/superstruct';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { hasProperty, isObject, isPlainObject } from '@metamask/utils';\n\nimport { type MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_dialog';\n\nexport type DialogApprovalTypes = Record<DialogType, string> & {\n  default: string;\n};\n\nexport const DIALOG_APPROVAL_TYPES = {\n  [DialogType.Alert]: `${methodName}:alert`,\n  [DialogType.Confirmation]: `${methodName}:confirmation`,\n  [DialogType.Prompt]: `${methodName}:prompt`,\n  default: methodName,\n};\n\nconst PlaceholderStruct = optional(size(string(), 1, 40));\n\nexport type Placeholder = Infer<typeof PlaceholderStruct>;\n\ntype RequestUserApprovalOptions = {\n  id?: string;\n  origin: string;\n  type: string;\n  requestData: {\n    id: string;\n    placeholder?: string;\n  };\n};\n\ntype RequestUserApproval = (\n  opts: RequestUserApprovalOptions,\n) => Promise<boolean | null | string | Json>;\n\ntype CreateInterface = (\n  snapId: string,\n  content: ComponentOrElement,\n) => Promise<string>;\n\ntype GetInterface = (\n  snapId: string,\n  id: string,\n) => { content: ComponentOrElement; snapId: SnapId; state: InterfaceState };\n\nexport type DialogMethodHooks = {\n  /**\n   * @param opts - The `requestUserApproval` options.\n   * @param opts.id - The approval ID. If not provided, a new approval ID will be generated.\n   * @param opts.origin - The origin of the request. In this case, the Snap ID.\n   * @param opts.type - The type of the approval request.\n   * @param opts.requestData - The data of the approval request.\n   * @param opts.requestData.id - The ID of the interface.\n   * @param opts.requestData.placeholder - The placeholder of the `Prompt` dialog.\n   */\n  requestUserApproval: RequestUserApproval;\n\n  /**\n   * @param snapId - The Snap ID creating the interface.\n   * @param content - The content of the interface.\n   */\n  createInterface: CreateInterface;\n  /**\n   * @param snapId - The SnapId requesting the interface.\n   * @param id - The interface ID.\n   */\n  getInterface: GetInterface;\n};\n\ntype DialogSpecificationBuilderOptions = {\n  allowedCaveats?: Readonly<NonEmptyArray<string>> | null;\n  methodHooks: DialogMethodHooks;\n};\n\ntype DialogSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof methodName;\n  methodImplementation: ReturnType<typeof getDialogImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * The specification builder for the `snap_dialog` permission. `snap_dialog`\n * lets the Snap display one of the following dialogs to the user:\n * - An alert, for displaying information.\n * - A confirmation, for accepting or rejecting some action.\n * - A prompt, for inputting some information.\n *\n * @param options - The specification builder options.\n * @param options.allowedCaveats - The optional allowed caveats for the\n * permission.\n * @param options.methodHooks - The RPC method hooks needed by the method\n * implementation.\n * @returns The specification for the `snap_dialog` permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  DialogSpecificationBuilderOptions,\n  DialogSpecification\n> = ({\n  allowedCaveats = null,\n  methodHooks,\n}: DialogSpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName: methodName,\n    allowedCaveats,\n    methodImplementation: getDialogImplementation(methodHooks),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<DialogMethodHooks> = {\n  requestUserApproval: true,\n  createInterface: true,\n  getInterface: true,\n};\n\nexport const dialogBuilder = Object.freeze({\n  targetName: methodName,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\nconst AlertParametersWithContentStruct = object({\n  type: enumValue(DialogType.Alert),\n  content: ComponentOrElementStruct,\n});\n\nconst AlertParametersWithIdStruct = object({\n  type: enumValue(DialogType.Alert),\n  id: string(),\n});\n\nconst AlertParametersStruct = selectiveUnion((value) => {\n  if (isPlainObject(value) && hasProperty(value, 'id')) {\n    return AlertParametersWithIdStruct;\n  }\n  return AlertParametersWithContentStruct;\n});\n\nconst ConfirmationParametersWithContentStruct = object({\n  type: enumValue(DialogType.Confirmation),\n  content: ComponentOrElementStruct,\n});\n\nconst ConfirmationParametersWithIdStruct = object({\n  type: enumValue(DialogType.Confirmation),\n  id: string(),\n});\n\nconst ConfirmationParametersStruct = selectiveUnion((value) => {\n  if (isPlainObject(value) && hasProperty(value, 'id')) {\n    return ConfirmationParametersWithIdStruct;\n  }\n  return ConfirmationParametersWithContentStruct;\n});\n\nconst PromptParametersWithContentStruct = object({\n  type: enumValue(DialogType.Prompt),\n  content: ComponentOrElementStruct,\n  placeholder: PlaceholderStruct,\n});\n\nconst PromptParametersWithIdStruct = object({\n  type: enumValue(DialogType.Prompt),\n  id: string(),\n  placeholder: PlaceholderStruct,\n});\n\nconst PromptParametersStruct = selectiveUnion((value) => {\n  if (isPlainObject(value) && hasProperty(value, 'id')) {\n    return PromptParametersWithIdStruct;\n  }\n  return PromptParametersWithContentStruct;\n});\n\nconst DefaultParametersWithContentStruct = object({\n  content: ComponentOrElementStruct,\n});\n\nconst DefaultParametersWithIdStruct = object({\n  id: string(),\n});\n\nconst DefaultParametersStruct = selectiveUnion((value) => {\n  if (isPlainObject(value) && hasProperty(value, 'id')) {\n    return DefaultParametersWithIdStruct;\n  }\n  return DefaultParametersWithContentStruct;\n});\n\nconst DialogParametersStruct = selectiveUnion((value) => {\n  if (isPlainObject(value) && hasProperty(value, 'type')) {\n    switch (value.type) {\n      // We cannot use typedUnion here unfortunately.\n      case DialogType.Alert:\n        return AlertParametersStruct;\n      case DialogType.Confirmation:\n        return ConfirmationParametersStruct;\n      case DialogType.Prompt:\n        return PromptParametersStruct;\n      default:\n        throw new Error(\n          `The \"type\" property must be one of: ${Object.values(DialogType).join(\n            ', ',\n          )}.`,\n        );\n    }\n  }\n  return DefaultParametersStruct;\n});\n\nexport type DialogParameters = InferMatching<\n  typeof DialogParametersStruct,\n  DialogParams\n>;\n\n/**\n * Builds the method implementation for `snap_dialog`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.requestUserApproval - A function that creates a new Approval in the ApprovalController.\n * This function should return a Promise that resolves with the appropriate value when the user has approved or rejected the request.\n * @param hooks.createInterface - A function that creates the interface in SnapInterfaceController.\n * @param hooks.getInterface - A function that gets an interface from SnapInterfaceController.\n * @returns The method implementation which return value depends on the dialog\n * type, valid return types are: string, boolean, null.\n */\nexport function getDialogImplementation({\n  requestUserApproval,\n  createInterface,\n  getInterface,\n}: DialogMethodHooks) {\n  return async function dialogImplementation(\n    args: RestrictedMethodOptions<DialogParameters>,\n  ): Promise<boolean | null | string | Json> {\n    const {\n      params,\n      context: { origin },\n    } = args;\n\n    if (!isObject(params)) {\n      throw rpcErrors.invalidParams({\n        message: 'Invalid params: Expected params to be a single object.',\n      });\n    }\n\n    const validatedParams = getValidatedParams(params);\n    const placeholder = isPromptDialog(validatedParams)\n      ? validatedParams.placeholder\n      : undefined;\n\n    const validatedType = hasProperty(validatedParams, 'type')\n      ? validatedParams.type\n      : 'default';\n\n    const approvalType =\n      DIALOG_APPROVAL_TYPES[\n        validatedType as keyof typeof DIALOG_APPROVAL_TYPES\n      ];\n\n    if (hasProperty(validatedParams, 'content')) {\n      const id = await createInterface(\n        origin,\n        validatedParams.content as Component,\n      );\n\n      return requestUserApproval({\n        id: approvalType === DIALOG_APPROVAL_TYPES.default ? id : undefined,\n        origin,\n        type: approvalType,\n        requestData: { id, placeholder },\n      });\n    }\n\n    validateInterface(origin, validatedParams.id, getInterface);\n\n    return requestUserApproval({\n      id:\n        approvalType === DIALOG_APPROVAL_TYPES.default\n          ? validatedParams.id\n          : undefined,\n      origin,\n      type: approvalType,\n      requestData: { id: validatedParams.id, placeholder },\n    });\n  };\n}\n/**\n * Validate that the interface ID is valid.\n *\n * @param origin - The origin of the request.\n * @param id - The interface ID.\n * @param getInterface - The function to get the interface.\n */\nfunction validateInterface(\n  origin: string,\n  id: string,\n  getInterface: GetInterface,\n) {\n  try {\n    getInterface(origin, id);\n  } catch (error) {\n    throw rpcErrors.invalidParams({\n      message: `Invalid params: ${error.message}`,\n    });\n  }\n}\n\n/**\n * Gets the dialog type from the dialog parameters.\n *\n * @param params - The dialog parameters.\n * @returns The dialog type.\n */\nfunction getDialogType(params: DialogParameters): DialogType | undefined {\n  return hasProperty(params, 'type') ? (params.type as DialogType) : undefined;\n}\n\n/**\n * Checks if the dialog parameters are for a prompt dialog.\n *\n * @param params - The dialog parameters.\n * @returns `true` if the dialog parameters are for a prompt dialog, `false` otherwise.\n */\nfunction isPromptDialog(params: DialogParameters): params is PromptDialog {\n  return getDialogType(params) === DialogType.Prompt;\n}\n\n/**\n * Validates the confirm method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated confirm method parameter object.\n */\nfunction getValidatedParams(params: unknown): DialogParameters {\n  try {\n    return create(params, DialogParametersStruct);\n  } catch (error) {\n    throw rpcErrors.invalidParams({\n      message: `Invalid params: ${error.message}`,\n    });\n  }\n}\n"]}

package/dist/restricted/getBip32Entropy.cjs

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBip32EntropyImplementation = exports.getBip32EntropyBuilder = void 0;
+const permission_controller_1 = require("@metamask/permission-controller");
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const utils_2 = require("../utils.cjs");
+const targetName = 'snap_getBip32Entropy';
+/**
+ * The specification builder for the `snap_getBip32Entropy` permission.
+ * `snap_getBip32Entropy` lets the Snap control private keys for a particular
+ * BIP-32 node.
+ *
+ * @param options - The specification builder options.
+ * @param options.methodHooks - The RPC method hooks needed by the method implementation.
+ * @returns The specification for the `snap_getBip32Entropy` permission.
+ */
+const specificationBuilder = ({ methodHooks }) => {
+    return {
+        permissionType: permission_controller_1.PermissionType.RestrictedMethod,
+        targetName,
+        allowedCaveats: [snaps_utils_1.SnapCaveatType.PermittedDerivationPaths],
+        methodImplementation: getBip32EntropyImplementation(methodHooks),
+        validator: ({ caveats }) => {
+            if (caveats?.length !== 1 ||
+                caveats[0].type !== snaps_utils_1.SnapCaveatType.PermittedDerivationPaths) {
+                throw rpc_errors_1.rpcErrors.invalidParams({
+                    message: `Expected a single "${snaps_utils_1.SnapCaveatType.PermittedDerivationPaths}" caveat.`,
+                });
+            }
+        },
+        subjectTypes: [permission_controller_1.SubjectType.Snap],
+    };
+};
+const methodHooks = {
+    getMnemonic: true,
+    getUnlockPromise: true,
+};
+exports.getBip32EntropyBuilder = Object.freeze({
+    targetName,
+    specificationBuilder,
+    methodHooks,
+});
+/**
+ * Builds the method implementation for `snap_getBip32Entropy`.
+ *
+ * @param hooks - The RPC method hooks.
+ * @param hooks.getMnemonic - A function to retrieve the Secret Recovery Phrase of the user.
+ * @param hooks.getUnlockPromise - A function that resolves once the MetaMask extension is unlocked
+ * and prompts the user to unlock their MetaMask if it is locked.
+ * @returns The method implementation which returns a `JsonSLIP10Node`.
+ * @throws If the params are invalid.
+ */
+function getBip32EntropyImplementation({ getMnemonic, getUnlockPromise, }) {
+    return async function getBip32Entropy(args) {
+        await getUnlockPromise(true);
+        const { params } = args;
+        (0, utils_1.assert)(params);
+        const node = await (0, utils_2.getNode)({
+            curve: params.curve,
+            path: params.path,
+            secretRecoveryPhrase: await getMnemonic(),
+        });
+        return node.toJSON();
+    };
+}
+exports.getBip32EntropyImplementation = getBip32EntropyImplementation;
+//# sourceMappingURL=getBip32Entropy.cjs.map

package/dist/restricted/getBip32Entropy.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBip32Entropy.cjs","sourceRoot":"","sources":["../../src/restricted/getBip32Entropy.ts"],"names":[],"mappings":";;;AAMA,2EAA8E;AAC9E,qDAAiD;AAKjD,uDAAuD;AAEvD,2CAAyC;AAGzC,wCAAmC;AAEnC,MAAM,UAAU,GAAG,sBAAsB,CAAC;AA4B1C;;;;;;;;GAQG;AACH,MAAM,oBAAoB,GAItB,CAAC,EAAE,WAAW,EAA8C,EAAE,EAAE;IAClE,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,gBAAgB;QAC/C,UAAU;QACV,cAAc,EAAE,CAAC,4BAAc,CAAC,wBAAwB,CAAC;QACzD,oBAAoB,EAAE,6BAA6B,CAAC,WAAW,CAAC;QAChE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACzB,IACE,OAAO,EAAE,MAAM,KAAK,CAAC;gBACrB,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,4BAAc,CAAC,wBAAwB,EAC3D,CAAC;gBACD,MAAM,sBAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,sBAAsB,4BAAc,CAAC,wBAAwB,WAAW;iBAClF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,YAAY,EAAE,CAAC,mCAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAkD;IACjE,WAAW,EAAE,IAAI;IACjB,gBAAgB,EAAE,IAAI;CACvB,CAAC;AAEW,QAAA,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC;IAClD,UAAU;IACV,oBAAoB;IACpB,WAAW;CACH,CAAC,CAAC;AAEZ;;;;;;;;;GASG;AACH,SAAgB,6BAA6B,CAAC,EAC5C,WAAW,EACX,gBAAgB,GACW;IAC3B,OAAO,KAAK,UAAU,eAAe,CACnC,IAAoD;QAEpD,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAE7B,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,IAAA,cAAM,EAAC,MAAM,CAAC,CAAC;QAEf,MAAM,IAAI,GAAG,MAAM,IAAA,eAAO,EAAC;YACzB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,oBAAoB,EAAE,MAAM,WAAW,EAAE;SAC1C,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC;AApBD,sEAoBC","sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetBip32EntropyParams,\n  GetBip32EntropyResult,\n} from '@metamask/snaps-sdk';\nimport { SnapCaveatType } from '@metamask/snaps-utils';\nimport type { NonEmptyArray } from '@metamask/utils';\nimport { assert } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { getNode } from '../utils';\n\nconst targetName = 'snap_getBip32Entropy';\n\nexport type GetBip32EntropyMethodHooks = {\n  /**\n   * @returns The mnemonic of the user's primary keyring.\n   */\n  getMnemonic: () => Promise<Uint8Array>;\n\n  /**\n   * Waits for the extension to be unlocked.\n   *\n   * @returns A promise that resolves once the extension is unlocked.\n   */\n  getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;\n};\n\ntype GetBip32EntropySpecificationBuilderOptions = {\n  methodHooks: GetBip32EntropyMethodHooks;\n};\n\ntype GetBip32EntropySpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof targetName;\n  methodImplementation: ReturnType<typeof getBip32EntropyImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n}>;\n\n/**\n * The specification builder for the `snap_getBip32Entropy` permission.\n * `snap_getBip32Entropy` lets the Snap control private keys for a particular\n * BIP-32 node.\n *\n * @param options - The specification builder options.\n * @param options.methodHooks - The RPC method hooks needed by the method implementation.\n * @returns The specification for the `snap_getBip32Entropy` permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  GetBip32EntropySpecificationBuilderOptions,\n  GetBip32EntropySpecification\n> = ({ methodHooks }: GetBip32EntropySpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName,\n    allowedCaveats: [SnapCaveatType.PermittedDerivationPaths],\n    methodImplementation: getBip32EntropyImplementation(methodHooks),\n    validator: ({ caveats }) => {\n      if (\n        caveats?.length !== 1 ||\n        caveats[0].type !== SnapCaveatType.PermittedDerivationPaths\n      ) {\n        throw rpcErrors.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.PermittedDerivationPaths}\" caveat.`,\n        });\n      }\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<GetBip32EntropyMethodHooks> = {\n  getMnemonic: true,\n  getUnlockPromise: true,\n};\n\nexport const getBip32EntropyBuilder = Object.freeze({\n  targetName,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\n/**\n * Builds the method implementation for `snap_getBip32Entropy`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.getMnemonic - A function to retrieve the Secret Recovery Phrase of the user.\n * @param hooks.getUnlockPromise - A function that resolves once the MetaMask extension is unlocked\n * and prompts the user to unlock their MetaMask if it is locked.\n * @returns The method implementation which returns a `JsonSLIP10Node`.\n * @throws If the params are invalid.\n */\nexport function getBip32EntropyImplementation({\n  getMnemonic,\n  getUnlockPromise,\n}: GetBip32EntropyMethodHooks) {\n  return async function getBip32Entropy(\n    args: RestrictedMethodOptions<GetBip32EntropyParams>,\n  ): Promise<GetBip32EntropyResult> {\n    await getUnlockPromise(true);\n\n    const { params } = args;\n    assert(params);\n\n    const node = await getNode({\n      curve: params.curve,\n      path: params.path,\n      secretRecoveryPhrase: await getMnemonic(),\n    });\n\n    return node.toJSON();\n  };\n}\n"]}

package/dist/{types/restricted/getBip32Entropy.d.ts → restricted/getBip32Entropy.d.cts}

@@ -1,8 +1,8 @@
-import type { PermissionSpecificationBuilder, PermissionValidatorConstraint, RestrictedMethodOptions } from '@metamask/permission-controller';
-import { PermissionType } from '@metamask/permission-controller';
-import type { GetBip32EntropyParams, GetBip32EntropyResult } from '@metamask/snaps-sdk';
-import type { NonEmptyArray } from '@metamask/utils';
-import type { MethodHooksObject } from '../utils';
+import type { PermissionSpecificationBuilder, PermissionValidatorConstraint, RestrictedMethodOptions } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import type { GetBip32EntropyParams, GetBip32EntropyResult } from "@metamask/snaps-sdk";
+import type { NonEmptyArray } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.cjs";
 declare const targetName = "snap_getBip32Entropy";
 export type GetBip32EntropyMethodHooks = {
     /**
@@ -42,3 +42,4 @@ export declare const getBip32EntropyBuilder: Readonly<{
  */
 export declare function getBip32EntropyImplementation({ getMnemonic, getUnlockPromise, }: GetBip32EntropyMethodHooks): (args: RestrictedMethodOptions<GetBip32EntropyParams>) => Promise<GetBip32EntropyResult>;
 export {};
+//# sourceMappingURL=getBip32Entropy.d.cts.map

package/dist/restricted/getBip32Entropy.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBip32Entropy.d.cts","sourceRoot":"","sources":["../../src/restricted/getBip32Entropy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8BAA8B,EAC9B,6BAA6B,EAC7B,uBAAuB,EAExB,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAe,wCAAwC;AAE9E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACtB,4BAA4B;AAE7B,OAAO,KAAK,EAAE,aAAa,EAAE,wBAAwB;AAGrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAGlD,QAAA,MAAM,UAAU,yBAAyB,CAAC;AAE1C,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvC;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,uBAAuB,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvE,CAAC;AAEF,KAAK,0CAA0C,GAAG;IAChD,WAAW,EAAE,0BAA0B,CAAC;CACzC,CAAC;AAgDF,eAAO,MAAM,sBAAsB;;;wBA7CjB,eAAe,gBAAgB;oBACnC,iBAAiB;8BACP,WAAW,oCAAoC,CAAC;wBACtD,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;mBAC3C,6BAA6B;;;EA6C/B,CAAC;AAEZ;;;;;;;;;GASG;AACH,wBAAgB,6BAA6B,CAAC,EAC5C,WAAW,EACX,gBAAgB,GACjB,EAAE,0BAA0B,UAEnB,wBAAwB,qBAAqB,CAAC,KACnD,QAAQ,qBAAqB,CAAC,CAclC"}

package/dist/restricted/getBip32Entropy.d.mts

@@ -0,0 +1,45 @@
+import type { PermissionSpecificationBuilder, PermissionValidatorConstraint, RestrictedMethodOptions } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import type { GetBip32EntropyParams, GetBip32EntropyResult } from "@metamask/snaps-sdk";
+import type { NonEmptyArray } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
+declare const targetName = "snap_getBip32Entropy";
+export type GetBip32EntropyMethodHooks = {
+    /**
+     * @returns The mnemonic of the user's primary keyring.
+     */
+    getMnemonic: () => Promise<Uint8Array>;
+    /**
+     * Waits for the extension to be unlocked.
+     *
+     * @returns A promise that resolves once the extension is unlocked.
+     */
+    getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;
+};
+type GetBip32EntropySpecificationBuilderOptions = {
+    methodHooks: GetBip32EntropyMethodHooks;
+};
+export declare const getBip32EntropyBuilder: Readonly<{
+    readonly targetName: "snap_getBip32Entropy";
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.RestrictedMethod, GetBip32EntropySpecificationBuilderOptions, {
+        permissionType: PermissionType.RestrictedMethod;
+        targetName: typeof targetName;
+        methodImplementation: ReturnType<typeof getBip32EntropyImplementation>;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+        validator: PermissionValidatorConstraint;
+    }>;
+    readonly methodHooks: MethodHooksObject<GetBip32EntropyMethodHooks>;
+}>;
+/**
+ * Builds the method implementation for `snap_getBip32Entropy`.
+ *
+ * @param hooks - The RPC method hooks.
+ * @param hooks.getMnemonic - A function to retrieve the Secret Recovery Phrase of the user.
+ * @param hooks.getUnlockPromise - A function that resolves once the MetaMask extension is unlocked
+ * and prompts the user to unlock their MetaMask if it is locked.
+ * @returns The method implementation which returns a `JsonSLIP10Node`.
+ * @throws If the params are invalid.
+ */
+export declare function getBip32EntropyImplementation({ getMnemonic, getUnlockPromise, }: GetBip32EntropyMethodHooks): (args: RestrictedMethodOptions<GetBip32EntropyParams>) => Promise<GetBip32EntropyResult>;
+export {};
+//# sourceMappingURL=getBip32Entropy.d.mts.map

package/dist/restricted/getBip32Entropy.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBip32Entropy.d.mts","sourceRoot":"","sources":["../../src/restricted/getBip32Entropy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8BAA8B,EAC9B,6BAA6B,EAC7B,uBAAuB,EAExB,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAe,wCAAwC;AAE9E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACtB,4BAA4B;AAE7B,OAAO,KAAK,EAAE,aAAa,EAAE,wBAAwB;AAGrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAGlD,QAAA,MAAM,UAAU,yBAAyB,CAAC;AAE1C,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvC;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,uBAAuB,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvE,CAAC;AAEF,KAAK,0CAA0C,GAAG;IAChD,WAAW,EAAE,0BAA0B,CAAC;CACzC,CAAC;AAgDF,eAAO,MAAM,sBAAsB;;;wBA7CjB,eAAe,gBAAgB;oBACnC,iBAAiB;8BACP,WAAW,oCAAoC,CAAC;wBACtD,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;mBAC3C,6BAA6B;;;EA6C/B,CAAC;AAEZ;;;;;;;;;GASG;AACH,wBAAgB,6BAA6B,CAAC,EAC5C,WAAW,EACX,gBAAgB,GACjB,EAAE,0BAA0B,UAEnB,wBAAwB,qBAAqB,CAAC,KACnD,QAAQ,qBAAqB,CAAC,CAclC"}

package/dist/restricted/getBip32Entropy.mjs

@@ -1,10 +1,65 @@
-import {
-  getBip32EntropyBuilder,
-  getBip32EntropyImplementation
-} from "../chunk-LXJBBRQ4.mjs";
-import "../chunk-W33UWNA2.mjs";
-export {
-  getBip32EntropyBuilder,
-  getBip32EntropyImplementation
+import { PermissionType, SubjectType } from "@metamask/permission-controller";
+import { rpcErrors } from "@metamask/rpc-errors";
+import { SnapCaveatType } from "@metamask/snaps-utils";
+import { assert } from "@metamask/utils";
+import { getNode } from "../utils.mjs";
+const targetName = 'snap_getBip32Entropy';
+/**
+ * The specification builder for the `snap_getBip32Entropy` permission.
+ * `snap_getBip32Entropy` lets the Snap control private keys for a particular
+ * BIP-32 node.
+ *
+ * @param options - The specification builder options.
+ * @param options.methodHooks - The RPC method hooks needed by the method implementation.
+ * @returns The specification for the `snap_getBip32Entropy` permission.
+ */
+const specificationBuilder = ({ methodHooks }) => {
+    return {
+        permissionType: PermissionType.RestrictedMethod,
+        targetName,
+        allowedCaveats: [SnapCaveatType.PermittedDerivationPaths],
+        methodImplementation: getBip32EntropyImplementation(methodHooks),
+        validator: ({ caveats }) => {
+            if (caveats?.length !== 1 ||
+                caveats[0].type !== SnapCaveatType.PermittedDerivationPaths) {
+                throw rpcErrors.invalidParams({
+                    message: `Expected a single "${SnapCaveatType.PermittedDerivationPaths}" caveat.`,
+                });
+            }
+        },
+        subjectTypes: [SubjectType.Snap],
+    };
 };
+const methodHooks = {
+    getMnemonic: true,
+    getUnlockPromise: true,
+};
+export const getBip32EntropyBuilder = Object.freeze({
+    targetName,
+    specificationBuilder,
+    methodHooks,
+});
+/**
+ * Builds the method implementation for `snap_getBip32Entropy`.
+ *
+ * @param hooks - The RPC method hooks.
+ * @param hooks.getMnemonic - A function to retrieve the Secret Recovery Phrase of the user.
+ * @param hooks.getUnlockPromise - A function that resolves once the MetaMask extension is unlocked
+ * and prompts the user to unlock their MetaMask if it is locked.
+ * @returns The method implementation which returns a `JsonSLIP10Node`.
+ * @throws If the params are invalid.
+ */
+export function getBip32EntropyImplementation({ getMnemonic, getUnlockPromise, }) {
+    return async function getBip32Entropy(args) {
+        await getUnlockPromise(true);
+        const { params } = args;
+        assert(params);
+        const node = await getNode({
+            curve: params.curve,
+            path: params.path,
+            secretRecoveryPhrase: await getMnemonic(),
+        });
+        return node.toJSON();
+    };
+}
 //# sourceMappingURL=getBip32Entropy.mjs.map

package/dist/restricted/getBip32Entropy.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"getBip32Entropy.mjs","sourceRoot":"","sources":["../../src/restricted/getBip32Entropy.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAC9E,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAKjD,OAAO,EAAE,cAAc,EAAE,8BAA8B;AAEvD,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAGzC,OAAO,EAAE,OAAO,EAAE,qBAAiB;AAEnC,MAAM,UAAU,GAAG,sBAAsB,CAAC;AA4B1C;;;;;;;;GAQG;AACH,MAAM,oBAAoB,GAItB,CAAC,EAAE,WAAW,EAA8C,EAAE,EAAE;IAClE,OAAO;QACL,cAAc,EAAE,cAAc,CAAC,gBAAgB;QAC/C,UAAU;QACV,cAAc,EAAE,CAAC,cAAc,CAAC,wBAAwB,CAAC;QACzD,oBAAoB,EAAE,6BAA6B,CAAC,WAAW,CAAC;QAChE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACzB,IACE,OAAO,EAAE,MAAM,KAAK,CAAC;gBACrB,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,wBAAwB,EAC3D,CAAC;gBACD,MAAM,SAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,sBAAsB,cAAc,CAAC,wBAAwB,WAAW;iBAClF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,YAAY,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAkD;IACjE,WAAW,EAAE,IAAI;IACjB,gBAAgB,EAAE,IAAI;CACvB,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC;IAClD,UAAU;IACV,oBAAoB;IACpB,WAAW;CACH,CAAC,CAAC;AAEZ;;;;;;;;;GASG;AACH,MAAM,UAAU,6BAA6B,CAAC,EAC5C,WAAW,EACX,gBAAgB,GACW;IAC3B,OAAO,KAAK,UAAU,eAAe,CACnC,IAAoD;QAEpD,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAE7B,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,MAAM,CAAC,MAAM,CAAC,CAAC;QAEf,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC;YACzB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,oBAAoB,EAAE,MAAM,WAAW,EAAE;SAC1C,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetBip32EntropyParams,\n  GetBip32EntropyResult,\n} from '@metamask/snaps-sdk';\nimport { SnapCaveatType } from '@metamask/snaps-utils';\nimport type { NonEmptyArray } from '@metamask/utils';\nimport { assert } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { getNode } from '../utils';\n\nconst targetName = 'snap_getBip32Entropy';\n\nexport type GetBip32EntropyMethodHooks = {\n  /**\n   * @returns The mnemonic of the user's primary keyring.\n   */\n  getMnemonic: () => Promise<Uint8Array>;\n\n  /**\n   * Waits for the extension to be unlocked.\n   *\n   * @returns A promise that resolves once the extension is unlocked.\n   */\n  getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;\n};\n\ntype GetBip32EntropySpecificationBuilderOptions = {\n  methodHooks: GetBip32EntropyMethodHooks;\n};\n\ntype GetBip32EntropySpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof targetName;\n  methodImplementation: ReturnType<typeof getBip32EntropyImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n}>;\n\n/**\n * The specification builder for the `snap_getBip32Entropy` permission.\n * `snap_getBip32Entropy` lets the Snap control private keys for a particular\n * BIP-32 node.\n *\n * @param options - The specification builder options.\n * @param options.methodHooks - The RPC method hooks needed by the method implementation.\n * @returns The specification for the `snap_getBip32Entropy` permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  GetBip32EntropySpecificationBuilderOptions,\n  GetBip32EntropySpecification\n> = ({ methodHooks }: GetBip32EntropySpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName,\n    allowedCaveats: [SnapCaveatType.PermittedDerivationPaths],\n    methodImplementation: getBip32EntropyImplementation(methodHooks),\n    validator: ({ caveats }) => {\n      if (\n        caveats?.length !== 1 ||\n        caveats[0].type !== SnapCaveatType.PermittedDerivationPaths\n      ) {\n        throw rpcErrors.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.PermittedDerivationPaths}\" caveat.`,\n        });\n      }\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<GetBip32EntropyMethodHooks> = {\n  getMnemonic: true,\n  getUnlockPromise: true,\n};\n\nexport const getBip32EntropyBuilder = Object.freeze({\n  targetName,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\n/**\n * Builds the method implementation for `snap_getBip32Entropy`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.getMnemonic - A function to retrieve the Secret Recovery Phrase of the user.\n * @param hooks.getUnlockPromise - A function that resolves once the MetaMask extension is unlocked\n * and prompts the user to unlock their MetaMask if it is locked.\n * @returns The method implementation which returns a `JsonSLIP10Node`.\n * @throws If the params are invalid.\n */\nexport function getBip32EntropyImplementation({\n  getMnemonic,\n  getUnlockPromise,\n}: GetBip32EntropyMethodHooks) {\n  return async function getBip32Entropy(\n    args: RestrictedMethodOptions<GetBip32EntropyParams>,\n  ): Promise<GetBip32EntropyResult> {\n    await getUnlockPromise(true);\n\n    const { params } = args;\n    assert(params);\n\n    const node = await getNode({\n      curve: params.curve,\n      path: params.path,\n      secretRecoveryPhrase: await getMnemonic(),\n    });\n\n    return node.toJSON();\n  };\n}\n"]}

package/dist/restricted/getBip32PublicKey.cjs

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBip32PublicKeyImplementation = exports.getBip32PublicKeyBuilder = exports.Bip32PublicKeyArgsStruct = void 0;
+const permission_controller_1 = require("@metamask/permission-controller");
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const utils_2 = require("../utils.cjs");
+const targetName = 'snap_getBip32PublicKey';
+exports.Bip32PublicKeyArgsStruct = (0, snaps_utils_1.bip32entropy)((0, superstruct_1.object)({
+    path: snaps_utils_1.Bip32PathStruct,
+    curve: snaps_utils_1.CurveStruct,
+    compressed: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+}));
+/**
+ * The specification builder for the `snap_getBip32PublicKey` permission.
+ * `snap_getBip32PublicKey` lets the Snap retrieve public keys for a particular
+ * BIP-32 node.
+ *
+ * @param options - The specification builder options.
+ * @param options.methodHooks - The RPC method hooks needed by the method implementation.
+ * @returns The specification for the `snap_getBip32PublicKey` permission.
+ */
+const specificationBuilder = ({ methodHooks }) => {
+    return {
+        permissionType: permission_controller_1.PermissionType.RestrictedMethod,
+        targetName,
+        allowedCaveats: [snaps_utils_1.SnapCaveatType.PermittedDerivationPaths],
+        methodImplementation: getBip32PublicKeyImplementation(methodHooks),
+        validator: ({ caveats }) => {
+            if (caveats?.length !== 1 ||
+                caveats[0].type !== snaps_utils_1.SnapCaveatType.PermittedDerivationPaths) {
+                throw rpc_errors_1.rpcErrors.invalidParams({
+                    message: `Expected a single "${snaps_utils_1.SnapCaveatType.PermittedDerivationPaths}" caveat.`,
+                });
+            }
+        },
+        subjectTypes: [permission_controller_1.SubjectType.Snap],
+    };
+};
+const methodHooks = {
+    getMnemonic: true,
+    getUnlockPromise: true,
+};
+exports.getBip32PublicKeyBuilder = Object.freeze({
+    targetName,
+    specificationBuilder,
+    methodHooks,
+});
+/**
+ * Builds the method implementation for `snap_getBip32PublicKey`.
+ *
+ * @param hooks - The RPC method hooks.
+ * @param hooks.getMnemonic - A function to retrieve the Secret Recovery Phrase of the user.
+ * @param hooks.getUnlockPromise - A function that resolves once the MetaMask extension is unlocked
+ * and prompts the user to unlock their MetaMask if it is locked.
+ * @returns The method implementation which returns a public key.
+ * @throws If the params are invalid.
+ */
+function getBip32PublicKeyImplementation({ getMnemonic, getUnlockPromise, }) {
+    return async function getBip32PublicKey(args) {
+        await getUnlockPromise(true);
+        (0, utils_1.assertStruct)(args.params, exports.Bip32PublicKeyArgsStruct, 'Invalid BIP-32 public key params', rpc_errors_1.rpcErrors.invalidParams);
+        const { params } = args;
+        const node = await (0, utils_2.getNode)({
+            curve: params.curve,
+            path: params.path,
+            secretRecoveryPhrase: await getMnemonic(),
+        });
+        if (params.compressed) {
+            return node.compressedPublicKey;
+        }
+        return node.publicKey;
+    };
+}
+exports.getBip32PublicKeyImplementation = getBip32PublicKeyImplementation;
+//# sourceMappingURL=getBip32PublicKey.cjs.map

package/dist/restricted/getBip32PublicKey.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBip32PublicKey.cjs","sourceRoot":"","sources":["../../src/restricted/getBip32PublicKey.ts"],"names":[],"mappings":";;;AAMA,2EAA8E;AAC9E,qDAAiD;AAKjD,uDAK+B;AAC/B,uDAAkE;AAElE,2CAA+C;AAG/C,wCAAmC;AAEnC,MAAM,UAAU,GAAG,wBAAwB,CAAC;AA4B/B,QAAA,wBAAwB,GAAG,IAAA,0BAAY,EAClD,IAAA,oBAAM,EAAC;IACL,IAAI,EAAE,6BAAe;IACrB,KAAK,EAAE,yBAAW;IAClB,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAChC,CAAC,CACH,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,oBAAoB,GAItB,CAAC,EAAE,WAAW,EAAgD,EAAE,EAAE;IACpE,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,gBAAgB;QAC/C,UAAU;QACV,cAAc,EAAE,CAAC,4BAAc,CAAC,wBAAwB,CAAC;QACzD,oBAAoB,EAAE,+BAA+B,CAAC,WAAW,CAAC;QAClE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACzB,IACE,OAAO,EAAE,MAAM,KAAK,CAAC;gBACrB,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,4BAAc,CAAC,wBAAwB,EAC3D,CAAC;gBACD,MAAM,sBAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,sBAAsB,4BAAc,CAAC,wBAAwB,WAAW;iBAClF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,YAAY,EAAE,CAAC,mCAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAoD;IACnE,WAAW,EAAE,IAAI;IACjB,gBAAgB,EAAE,IAAI;CACvB,CAAC;AAEW,QAAA,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,UAAU;IACV,oBAAoB;IACpB,WAAW;CACH,CAAC,CAAC;AAEZ;;;;;;;;;GASG;AACH,SAAgB,+BAA+B,CAAC,EAC9C,WAAW,EACX,gBAAgB,GACa;IAC7B,OAAO,KAAK,UAAU,iBAAiB,CACrC,IAAsD;QAEtD,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAE7B,IAAA,oBAAY,EACV,IAAI,CAAC,MAAM,EACX,gCAAwB,EACxB,kCAAkC,EAClC,sBAAS,CAAC,aAAa,CACxB,CAAC;QAEF,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,MAAM,IAAI,GAAG,MAAM,IAAA,eAAO,EAAC;YACzB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,oBAAoB,EAAE,MAAM,WAAW,EAAE;SAC1C,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,mBAAmB,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC,CAAC;AACJ,CAAC;AA7BD,0EA6BC","sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetBip32PublicKeyParams,\n  GetBip32PublicKeyResult,\n} from '@metamask/snaps-sdk';\nimport {\n  bip32entropy,\n  Bip32PathStruct,\n  CurveStruct,\n  SnapCaveatType,\n} from '@metamask/snaps-utils';\nimport { boolean, object, optional } from '@metamask/superstruct';\nimport type { NonEmptyArray } from '@metamask/utils';\nimport { assertStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { getNode } from '../utils';\n\nconst targetName = 'snap_getBip32PublicKey';\n\nexport type GetBip32PublicKeyMethodHooks = {\n  /**\n   * @returns The mnemonic of the user's primary keyring.\n   */\n  getMnemonic: () => Promise<Uint8Array>;\n\n  /**\n   * Waits for the extension to be unlocked.\n   *\n   * @returns A promise that resolves once the extension is unlocked.\n   */\n  getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;\n};\n\ntype GetBip32PublicKeySpecificationBuilderOptions = {\n  methodHooks: GetBip32PublicKeyMethodHooks;\n};\n\ntype GetBip32PublicKeySpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof targetName;\n  methodImplementation: ReturnType<typeof getBip32PublicKeyImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n}>;\n\nexport const Bip32PublicKeyArgsStruct = bip32entropy(\n  object({\n    path: Bip32PathStruct,\n    curve: CurveStruct,\n    compressed: optional(boolean()),\n  }),\n);\n\n/**\n * The specification builder for the `snap_getBip32PublicKey` permission.\n * `snap_getBip32PublicKey` lets the Snap retrieve public keys for a particular\n * BIP-32 node.\n *\n * @param options - The specification builder options.\n * @param options.methodHooks - The RPC method hooks needed by the method implementation.\n * @returns The specification for the `snap_getBip32PublicKey` permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  GetBip32PublicKeySpecificationBuilderOptions,\n  GetBip32PublicKeySpecification\n> = ({ methodHooks }: GetBip32PublicKeySpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName,\n    allowedCaveats: [SnapCaveatType.PermittedDerivationPaths],\n    methodImplementation: getBip32PublicKeyImplementation(methodHooks),\n    validator: ({ caveats }) => {\n      if (\n        caveats?.length !== 1 ||\n        caveats[0].type !== SnapCaveatType.PermittedDerivationPaths\n      ) {\n        throw rpcErrors.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.PermittedDerivationPaths}\" caveat.`,\n        });\n      }\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<GetBip32PublicKeyMethodHooks> = {\n  getMnemonic: true,\n  getUnlockPromise: true,\n};\n\nexport const getBip32PublicKeyBuilder = Object.freeze({\n  targetName,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\n/**\n * Builds the method implementation for `snap_getBip32PublicKey`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.getMnemonic - A function to retrieve the Secret Recovery Phrase of the user.\n * @param hooks.getUnlockPromise - A function that resolves once the MetaMask extension is unlocked\n * and prompts the user to unlock their MetaMask if it is locked.\n * @returns The method implementation which returns a public key.\n * @throws If the params are invalid.\n */\nexport function getBip32PublicKeyImplementation({\n  getMnemonic,\n  getUnlockPromise,\n}: GetBip32PublicKeyMethodHooks) {\n  return async function getBip32PublicKey(\n    args: RestrictedMethodOptions<GetBip32PublicKeyParams>,\n  ): Promise<GetBip32PublicKeyResult> {\n    await getUnlockPromise(true);\n\n    assertStruct(\n      args.params,\n      Bip32PublicKeyArgsStruct,\n      'Invalid BIP-32 public key params',\n      rpcErrors.invalidParams,\n    );\n\n    const { params } = args;\n    const node = await getNode({\n      curve: params.curve,\n      path: params.path,\n      secretRecoveryPhrase: await getMnemonic(),\n    });\n\n    if (params.compressed) {\n      return node.compressedPublicKey;\n    }\n\n    return node.publicKey;\n  };\n}\n"]}

package/dist/{types/restricted/getBip32PublicKey.d.ts → restricted/getBip32PublicKey.d.cts}

@@ -1,8 +1,8 @@
-import type { PermissionSpecificationBuilder, PermissionValidatorConstraint, RestrictedMethodOptions } from '@metamask/permission-controller';
-import { PermissionType } from '@metamask/permission-controller';
-import type { GetBip32PublicKeyParams, GetBip32PublicKeyResult } from '@metamask/snaps-sdk';
-import type { NonEmptyArray } from '@metamask/utils';
-import type { MethodHooksObject } from '../utils';
+import type { PermissionSpecificationBuilder, PermissionValidatorConstraint, RestrictedMethodOptions } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import type { GetBip32PublicKeyParams, GetBip32PublicKeyResult } from "@metamask/snaps-sdk";
+import type { NonEmptyArray } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.cjs";
 declare const targetName = "snap_getBip32PublicKey";
 export type GetBip32PublicKeyMethodHooks = {
     /**
@@ -20,8 +20,8 @@ type GetBip32PublicKeySpecificationBuilderOptions = {
     methodHooks: GetBip32PublicKeyMethodHooks;
 };
 export declare const Bip32PublicKeyArgsStruct: import("@metamask/superstruct").Struct<{
-    path: string[];
     curve: "ed25519" | "ed25519Bip32" | "secp256k1";
+    path: string[];
     compressed?: boolean | undefined;
 }, {
     path: import("@metamask/superstruct").Struct<string[], import("@metamask/superstruct").Struct<string, null>>;
@@ -51,3 +51,4 @@ export declare const getBip32PublicKeyBuilder: Readonly<{
  */
 export declare function getBip32PublicKeyImplementation({ getMnemonic, getUnlockPromise, }: GetBip32PublicKeyMethodHooks): (args: RestrictedMethodOptions<GetBip32PublicKeyParams>) => Promise<GetBip32PublicKeyResult>;
 export {};
+//# sourceMappingURL=getBip32PublicKey.d.cts.map

package/dist/restricted/getBip32PublicKey.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBip32PublicKey.d.cts","sourceRoot":"","sources":["../../src/restricted/getBip32PublicKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8BAA8B,EAC9B,6BAA6B,EAC7B,uBAAuB,EAExB,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAe,wCAAwC;AAE9E,OAAO,KAAK,EACV,uBAAuB,EACvB,uBAAuB,EACxB,4BAA4B;AAQ7B,OAAO,KAAK,EAAE,aAAa,EAAE,wBAAwB;AAGrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAGlD,QAAA,MAAM,UAAU,2BAA2B,CAAC;AAE5C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvC;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,uBAAuB,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvE,CAAC;AAEF,KAAK,4CAA4C,GAAG;IAClD,WAAW,EAAE,4BAA4B,CAAC;CAC3C,CAAC;AAUF,eAAO,MAAM,wBAAwB;;;;;;;;EAMpC,CAAC;AAwCF,eAAO,MAAM,wBAAwB;;;wBArDnB,eAAe,gBAAgB;oBACnC,iBAAiB;8BACP,WAAW,sCAAsC,CAAC;wBACxD,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;mBAC3C,6BAA6B;;;EAqD/B,CAAC;AAEZ;;;;;;;;;GASG;AACH,wBAAgB,+BAA+B,CAAC,EAC9C,WAAW,EACX,gBAAgB,GACjB,EAAE,4BAA4B,UAErB,wBAAwB,uBAAuB,CAAC,KACrD,QAAQ,uBAAuB,CAAC,CAuBpC"}