@metamask/snaps-rpc-methods 15.1.0 → 16.0.0

package/dist/restricted/index.d.cts

@@ -1,169 +1,29 @@
-import type { DialogMethodHooks } from "./dialog.cjs";
-import type { GetBip32EntropyMethodHooks } from "./getBip32Entropy.cjs";
-import type { GetBip32PublicKeyMethodHooks } from "./getBip32PublicKey.cjs";
-import type { GetBip44EntropyMethodHooks } from "./getBip44Entropy.cjs";
-import type { GetEntropyHooks } from "./getEntropy.cjs";
+import type { Messenger } from "@metamask/messenger";
+import type { PermissionSpecificationBuilder, PermissionType, RestrictedMethodSpecificationConstraint } from "@metamask/permission-controller";
+import type { DialogMessengerActions } from "./dialog.cjs";
+import type { GetBip32EntropyMessengerActions, GetBip32EntropyMethodHooks } from "./getBip32Entropy.cjs";
+import type { GetBip32PublicKeyMessengerActions, GetBip32PublicKeyMethodHooks } from "./getBip32PublicKey.cjs";
+import type { GetBip44EntropyMessengerActions, GetBip44EntropyMethodHooks } from "./getBip44Entropy.cjs";
+import type { GetEntropyHooks, GetEntropyMessengerActions } from "./getEntropy.cjs";
 import type { GetLocaleMethodHooks } from "./getLocale.cjs";
 import type { GetPreferencesMethodHooks } from "./getPreferences.cjs";
-import type { InvokeSnapMethodHooks } from "./invokeSnap.cjs";
+import type { InvokeSnapMessengerActions } from "./invokeSnap.cjs";
 import type { ManageAccountsMethodHooks } from "./manageAccounts.cjs";
-import type { ManageStateMethodHooks } from "./manageState.cjs";
-import type { NotifyMethodHooks } from "./notify.cjs";
+import type { ManageStateMessengerActions, ManageStateMethodHooks } from "./manageState.cjs";
+import type { NotifyMessengerActions, NotifyMethodHooks } from "./notify.cjs";
+import type { MethodHooksObject } from "../utils.cjs";
 export { WALLET_SNAP_PERMISSION_KEY } from "./invokeSnap.cjs";
 export { getEncryptionEntropy } from "./manageState.cjs";
-export type RestrictedMethodHooks = DialogMethodHooks & GetBip32EntropyMethodHooks & GetBip32PublicKeyMethodHooks & GetBip44EntropyMethodHooks & GetEntropyHooks & InvokeSnapMethodHooks & ManageStateMethodHooks & NotifyMethodHooks & ManageAccountsMethodHooks & GetLocaleMethodHooks & GetPreferencesMethodHooks;
-export declare const restrictedMethodPermissionBuilders: {
-    readonly snap_dialog: Readonly<{
-        readonly targetName: "snap_dialog";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: DialogMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_dialog";
-            methodImplementation: (args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").DialogParams>) => Promise<import("@metamask/utils").Json>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.cjs").MethodHooksObject<DialogMethodHooks>;
-    }>;
-    readonly snap_getBip32Entropy: Readonly<{
-        readonly targetName: "snap_getBip32Entropy";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            methodHooks: GetBip32EntropyMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getBip32Entropy";
-            methodImplementation: (args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").GetBip32EntropyParams>) => Promise<import("@metamask/key-tree").JsonSLIP10Node>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
-        }>;
-        readonly methodHooks: import("../utils.cjs").MethodHooksObject<GetBip32EntropyMethodHooks>;
-    }>;
-    readonly snap_getBip32PublicKey: Readonly<{
-        readonly targetName: "snap_getBip32PublicKey";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            methodHooks: GetBip32PublicKeyMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getBip32PublicKey";
-            methodImplementation: (args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").GetBip32PublicKeyParams>) => Promise<string>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
-        }>;
-        readonly methodHooks: import("../utils.cjs").MethodHooksObject<GetBip32PublicKeyMethodHooks>;
-    }>;
-    readonly snap_getBip44Entropy: Readonly<{
-        readonly targetName: "snap_getBip44Entropy";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            methodHooks: GetBip44EntropyMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getBip44Entropy";
-            methodImplementation: (args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").GetBip44EntropyParams>) => Promise<import("@metamask/key-tree").JsonBIP44CoinTypeNode>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
-        }>;
-        readonly methodHooks: import("../utils.cjs").MethodHooksObject<GetBip44EntropyMethodHooks>;
-    }>;
-    readonly snap_getEntropy: Readonly<{
-        readonly targetName: "snap_getEntropy";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: GetEntropyHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getEntropy";
-            methodImplementation: (options: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").GetEntropyParams>) => Promise<`0x${string}`>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.cjs").MethodHooksObject<GetEntropyHooks>;
-    }>;
-    readonly wallet_snap: Readonly<{
-        readonly targetName: "wallet_snap";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: InvokeSnapMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "wallet_snap";
-            methodImplementation: (options: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").InvokeSnapParams>) => Promise<import("@metamask/utils").Json>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
-            sideEffect: {
-                onPermitted: import("@metamask/permission-controller").SideEffectHandler<import("./invokeSnap.cjs").SnapControllerInstallSnapsAction | import("./invokeSnap.cjs").SnapControllerGetPermittedSnapsAction, never>;
-            };
-        }>;
-        readonly methodHooks: import("../utils.cjs").MethodHooksObject<InvokeSnapMethodHooks>;
-    }>;
-    readonly snap_manageState: Readonly<{
-        readonly targetName: "snap_manageState";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: ManageStateMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_manageState";
-            methodImplementation: (options: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").ManageStateParams>) => Promise<import("@metamask/snaps-sdk").ManageStateResult>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.cjs").MethodHooksObject<ManageStateMethodHooks>;
-    }>;
-    readonly snap_notify: Readonly<{
-        readonly targetName: "snap_notify";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: NotifyMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_notify";
-            methodImplementation: (args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").NotifyParams>) => Promise<null>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.cjs").MethodHooksObject<NotifyMethodHooks>;
-    }>;
-    readonly snap_manageAccounts: Readonly<{
-        readonly targetName: "snap_manageAccounts";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: ManageAccountsMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_manageAccounts";
-            methodImplementation: (options: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").ManageAccountsParams>) => Promise<import("@metamask/utils").Json>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: {
-            readonly getSnapKeyring: true;
-            readonly getUnlockPromise: true;
-        };
-    }>;
-    readonly snap_getLocale: Readonly<{
-        readonly targetName: "snap_getLocale";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: GetLocaleMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getLocale";
-            methodImplementation: (_args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/permission-controller").RestrictedMethodParameters>) => Promise<string>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.cjs").MethodHooksObject<GetLocaleMethodHooks>;
-    }>;
-    readonly snap_getPreferences: Readonly<{
-        readonly targetName: "snap_getPreferences";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: GetPreferencesMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getPreferences";
-            methodImplementation: (_args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/permission-controller").RestrictedMethodParameters>) => Promise<import("@metamask/snaps-sdk").GetPreferencesResult>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.cjs").MethodHooksObject<GetPreferencesMethodHooks>;
-    }>;
+export type RestrictedMethodActions = DialogMessengerActions | GetBip32EntropyMessengerActions | GetBip32PublicKeyMessengerActions | GetBip44EntropyMessengerActions | GetEntropyMessengerActions | InvokeSnapMessengerActions | ManageStateMessengerActions | NotifyMessengerActions;
+export type RestrictedMethodMessenger = Messenger<string, RestrictedMethodActions>;
+export type RestrictedMethodHooks = GetBip32EntropyMethodHooks & GetBip32PublicKeyMethodHooks & GetBip44EntropyMethodHooks & GetEntropyHooks & ManageStateMethodHooks & NotifyMethodHooks & ManageAccountsMethodHooks & GetLocaleMethodHooks & GetPreferencesMethodHooks;
+type RestrictedMethodPermissionBuilder = {
+    targetName: string;
+    specificationBuilder: PermissionSpecificationBuilder<PermissionType.RestrictedMethod, any, RestrictedMethodSpecificationConstraint>;
+    actionNames?: readonly RestrictedMethodActions['type'][];
+    methodHooks?: MethodHooksObject<Record<string, unknown>>;
 };
+export declare const restrictedMethodPermissionBuilders: Record<string, RestrictedMethodPermissionBuilder>;
 export * from "./caveats/index.cjs";
 export type { DialogApprovalTypes } from "./dialog.cjs";
 export { DIALOG_APPROVAL_TYPES } from "./dialog.cjs";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/restricted/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AAEpE,OAAO,KAAK,EAAE,4BAA4B,EAAE,gCAA4B;AAExE,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AAEpE,OAAO,KAAK,EAAE,eAAe,EAAE,yBAAqB;AAEpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAoB;AAExD,OAAO,KAAK,EAAE,yBAAyB,EAAE,6BAAyB;AAElE,OAAO,KAAK,EAAE,qBAAqB,EAAE,yBAAqB;AAE1D,OAAO,KAAK,EAAE,yBAAyB,EAAE,6BAAyB;AAElE,OAAO,KAAK,EAAE,sBAAsB,EAAE,0BAAsB;AAE5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAGlD,OAAO,EAAE,0BAA0B,EAAE,yBAAqB;AAC1D,OAAO,EAAE,oBAAoB,EAAE,0BAAsB;AAErD,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GACnD,0BAA0B,GAC1B,4BAA4B,GAC5B,0BAA0B,GAC1B,eAAe,GACf,qBAAqB,GACrB,sBAAsB,GACtB,iBAAiB,GACjB,yBAAyB,GACzB,oBAAoB,GACpB,yBAAyB,CAAC;AAE5B,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAYrC,CAAC;AAEX,oCAA0B;AAC1B,YAAY,EAAE,mBAAmB,EAAE,qBAAiB;AACpD,OAAO,EAAE,qBAAqB,EAAE,qBAAiB"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/restricted/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EACV,8BAA8B,EAC9B,cAAc,EACd,uCAAuC,EACxC,wCAAwC;AAEzC,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAiB;AAEvD,OAAO,KAAK,EACV,+BAA+B,EAC/B,0BAA0B,EAC3B,8BAA0B;AAE3B,OAAO,KAAK,EACV,iCAAiC,EACjC,4BAA4B,EAC7B,gCAA4B;AAE7B,OAAO,KAAK,EACV,+BAA+B,EAC/B,0BAA0B,EAC3B,8BAA0B;AAE3B,OAAO,KAAK,EAAE,eAAe,EAAE,0BAA0B,EAAE,yBAAqB;AAEhF,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAoB;AAExD,OAAO,KAAK,EAAE,yBAAyB,EAAE,6BAAyB;AAElE,OAAO,KAAK,EAAE,0BAA0B,EAAE,yBAAqB;AAE/D,OAAO,KAAK,EAAE,yBAAyB,EAAE,6BAAyB;AAElE,OAAO,KAAK,EACV,2BAA2B,EAC3B,sBAAsB,EACvB,0BAAsB;AAEvB,OAAO,KAAK,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,qBAAiB;AAE1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,OAAO,EAAE,0BAA0B,EAAE,yBAAqB;AAC1D,OAAO,EAAE,oBAAoB,EAAE,0BAAsB;AAErD,MAAM,MAAM,uBAAuB,GAC/B,sBAAsB,GACtB,+BAA+B,GAC/B,iCAAiC,GACjC,+BAA+B,GAC/B,0BAA0B,GAC1B,0BAA0B,GAC1B,2BAA2B,GAC3B,sBAAsB,CAAC;AAE3B,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,MAAM,EACN,uBAAuB,CACxB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,0BAA0B,GAC5D,4BAA4B,GAC5B,0BAA0B,GAC1B,eAAe,GACf,sBAAsB,GACtB,iBAAiB,GACjB,yBAAyB,GACzB,oBAAoB,GACpB,yBAAyB,CAAC;AAE5B,KAAK,iCAAiC,GAAG;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB,EAAE,8BAA8B,CAClD,cAAc,CAAC,gBAAgB,EAC/B,GAAG,EACH,uCAAuC,CACxC,CAAC;IACF,WAAW,CAAC,EAAE,SAAS,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC;IACzD,WAAW,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC1D,CAAC;AAEF,eAAO,MAAM,kCAAkC,EAAE,MAAM,CACrD,MAAM,EACN,iCAAiC,CAazB,CAAC;AAEX,oCAA0B;AAC1B,YAAY,EAAE,mBAAmB,EAAE,qBAAiB;AACpD,OAAO,EAAE,qBAAqB,EAAE,qBAAiB"}

package/dist/restricted/index.d.mts

@@ -1,169 +1,29 @@
-import type { DialogMethodHooks } from "./dialog.mjs";
-import type { GetBip32EntropyMethodHooks } from "./getBip32Entropy.mjs";
-import type { GetBip32PublicKeyMethodHooks } from "./getBip32PublicKey.mjs";
-import type { GetBip44EntropyMethodHooks } from "./getBip44Entropy.mjs";
-import type { GetEntropyHooks } from "./getEntropy.mjs";
+import type { Messenger } from "@metamask/messenger";
+import type { PermissionSpecificationBuilder, PermissionType, RestrictedMethodSpecificationConstraint } from "@metamask/permission-controller";
+import type { DialogMessengerActions } from "./dialog.mjs";
+import type { GetBip32EntropyMessengerActions, GetBip32EntropyMethodHooks } from "./getBip32Entropy.mjs";
+import type { GetBip32PublicKeyMessengerActions, GetBip32PublicKeyMethodHooks } from "./getBip32PublicKey.mjs";
+import type { GetBip44EntropyMessengerActions, GetBip44EntropyMethodHooks } from "./getBip44Entropy.mjs";
+import type { GetEntropyHooks, GetEntropyMessengerActions } from "./getEntropy.mjs";
 import type { GetLocaleMethodHooks } from "./getLocale.mjs";
 import type { GetPreferencesMethodHooks } from "./getPreferences.mjs";
-import type { InvokeSnapMethodHooks } from "./invokeSnap.mjs";
+import type { InvokeSnapMessengerActions } from "./invokeSnap.mjs";
 import type { ManageAccountsMethodHooks } from "./manageAccounts.mjs";
-import type { ManageStateMethodHooks } from "./manageState.mjs";
-import type { NotifyMethodHooks } from "./notify.mjs";
+import type { ManageStateMessengerActions, ManageStateMethodHooks } from "./manageState.mjs";
+import type { NotifyMessengerActions, NotifyMethodHooks } from "./notify.mjs";
+import type { MethodHooksObject } from "../utils.mjs";
 export { WALLET_SNAP_PERMISSION_KEY } from "./invokeSnap.mjs";
 export { getEncryptionEntropy } from "./manageState.mjs";
-export type RestrictedMethodHooks = DialogMethodHooks & GetBip32EntropyMethodHooks & GetBip32PublicKeyMethodHooks & GetBip44EntropyMethodHooks & GetEntropyHooks & InvokeSnapMethodHooks & ManageStateMethodHooks & NotifyMethodHooks & ManageAccountsMethodHooks & GetLocaleMethodHooks & GetPreferencesMethodHooks;
-export declare const restrictedMethodPermissionBuilders: {
-    readonly snap_dialog: Readonly<{
-        readonly targetName: "snap_dialog";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: DialogMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_dialog";
-            methodImplementation: (args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").DialogParams>) => Promise<import("@metamask/utils").Json>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.mjs").MethodHooksObject<DialogMethodHooks>;
-    }>;
-    readonly snap_getBip32Entropy: Readonly<{
-        readonly targetName: "snap_getBip32Entropy";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            methodHooks: GetBip32EntropyMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getBip32Entropy";
-            methodImplementation: (args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").GetBip32EntropyParams>) => Promise<import("@metamask/key-tree").JsonSLIP10Node>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
-        }>;
-        readonly methodHooks: import("../utils.mjs").MethodHooksObject<GetBip32EntropyMethodHooks>;
-    }>;
-    readonly snap_getBip32PublicKey: Readonly<{
-        readonly targetName: "snap_getBip32PublicKey";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            methodHooks: GetBip32PublicKeyMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getBip32PublicKey";
-            methodImplementation: (args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").GetBip32PublicKeyParams>) => Promise<string>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
-        }>;
-        readonly methodHooks: import("../utils.mjs").MethodHooksObject<GetBip32PublicKeyMethodHooks>;
-    }>;
-    readonly snap_getBip44Entropy: Readonly<{
-        readonly targetName: "snap_getBip44Entropy";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            methodHooks: GetBip44EntropyMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getBip44Entropy";
-            methodImplementation: (args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").GetBip44EntropyParams>) => Promise<import("@metamask/key-tree").JsonBIP44CoinTypeNode>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
-        }>;
-        readonly methodHooks: import("../utils.mjs").MethodHooksObject<GetBip44EntropyMethodHooks>;
-    }>;
-    readonly snap_getEntropy: Readonly<{
-        readonly targetName: "snap_getEntropy";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: GetEntropyHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getEntropy";
-            methodImplementation: (options: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").GetEntropyParams>) => Promise<`0x${string}`>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.mjs").MethodHooksObject<GetEntropyHooks>;
-    }>;
-    readonly wallet_snap: Readonly<{
-        readonly targetName: "wallet_snap";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: InvokeSnapMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "wallet_snap";
-            methodImplementation: (options: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").InvokeSnapParams>) => Promise<import("@metamask/utils").Json>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
-            sideEffect: {
-                onPermitted: import("@metamask/permission-controller").SideEffectHandler<import("./invokeSnap.mjs").SnapControllerInstallSnapsAction | import("./invokeSnap.mjs").SnapControllerGetPermittedSnapsAction, never>;
-            };
-        }>;
-        readonly methodHooks: import("../utils.mjs").MethodHooksObject<InvokeSnapMethodHooks>;
-    }>;
-    readonly snap_manageState: Readonly<{
-        readonly targetName: "snap_manageState";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: ManageStateMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_manageState";
-            methodImplementation: (options: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").ManageStateParams>) => Promise<import("@metamask/snaps-sdk").ManageStateResult>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.mjs").MethodHooksObject<ManageStateMethodHooks>;
-    }>;
-    readonly snap_notify: Readonly<{
-        readonly targetName: "snap_notify";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: NotifyMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_notify";
-            methodImplementation: (args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").NotifyParams>) => Promise<null>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.mjs").MethodHooksObject<NotifyMethodHooks>;
-    }>;
-    readonly snap_manageAccounts: Readonly<{
-        readonly targetName: "snap_manageAccounts";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: ManageAccountsMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_manageAccounts";
-            methodImplementation: (options: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/snaps-sdk").ManageAccountsParams>) => Promise<import("@metamask/utils").Json>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: {
-            readonly getSnapKeyring: true;
-            readonly getUnlockPromise: true;
-        };
-    }>;
-    readonly snap_getLocale: Readonly<{
-        readonly targetName: "snap_getLocale";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: GetLocaleMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getLocale";
-            methodImplementation: (_args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/permission-controller").RestrictedMethodParameters>) => Promise<string>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.mjs").MethodHooksObject<GetLocaleMethodHooks>;
-    }>;
-    readonly snap_getPreferences: Readonly<{
-        readonly targetName: "snap_getPreferences";
-        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.RestrictedMethod, {
-            allowedCaveats?: readonly [string, ...string[]] | null | undefined;
-            methodHooks: GetPreferencesMethodHooks;
-        }, {
-            permissionType: import("@metamask/permission-controller").PermissionType.RestrictedMethod;
-            targetName: "snap_getPreferences";
-            methodImplementation: (_args: import("@metamask/permission-controller").RestrictedMethodOptions<import("@metamask/permission-controller").RestrictedMethodParameters>) => Promise<import("@metamask/snaps-sdk").GetPreferencesResult>;
-            allowedCaveats: readonly [string, ...string[]] | null;
-        }>;
-        readonly methodHooks: import("../utils.mjs").MethodHooksObject<GetPreferencesMethodHooks>;
-    }>;
+export type RestrictedMethodActions = DialogMessengerActions | GetBip32EntropyMessengerActions | GetBip32PublicKeyMessengerActions | GetBip44EntropyMessengerActions | GetEntropyMessengerActions | InvokeSnapMessengerActions | ManageStateMessengerActions | NotifyMessengerActions;
+export type RestrictedMethodMessenger = Messenger<string, RestrictedMethodActions>;
+export type RestrictedMethodHooks = GetBip32EntropyMethodHooks & GetBip32PublicKeyMethodHooks & GetBip44EntropyMethodHooks & GetEntropyHooks & ManageStateMethodHooks & NotifyMethodHooks & ManageAccountsMethodHooks & GetLocaleMethodHooks & GetPreferencesMethodHooks;
+type RestrictedMethodPermissionBuilder = {
+    targetName: string;
+    specificationBuilder: PermissionSpecificationBuilder<PermissionType.RestrictedMethod, any, RestrictedMethodSpecificationConstraint>;
+    actionNames?: readonly RestrictedMethodActions['type'][];
+    methodHooks?: MethodHooksObject<Record<string, unknown>>;
 };
+export declare const restrictedMethodPermissionBuilders: Record<string, RestrictedMethodPermissionBuilder>;
 export * from "./caveats/index.mjs";
 export type { DialogApprovalTypes } from "./dialog.mjs";
 export { DIALOG_APPROVAL_TYPES } from "./dialog.mjs";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/restricted/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AAEpE,OAAO,KAAK,EAAE,4BAA4B,EAAE,gCAA4B;AAExE,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AAEpE,OAAO,KAAK,EAAE,eAAe,EAAE,yBAAqB;AAEpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAoB;AAExD,OAAO,KAAK,EAAE,yBAAyB,EAAE,6BAAyB;AAElE,OAAO,KAAK,EAAE,qBAAqB,EAAE,yBAAqB;AAE1D,OAAO,KAAK,EAAE,yBAAyB,EAAE,6BAAyB;AAElE,OAAO,KAAK,EAAE,sBAAsB,EAAE,0BAAsB;AAE5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAGlD,OAAO,EAAE,0BAA0B,EAAE,yBAAqB;AAC1D,OAAO,EAAE,oBAAoB,EAAE,0BAAsB;AAErD,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GACnD,0BAA0B,GAC1B,4BAA4B,GAC5B,0BAA0B,GAC1B,eAAe,GACf,qBAAqB,GACrB,sBAAsB,GACtB,iBAAiB,GACjB,yBAAyB,GACzB,oBAAoB,GACpB,yBAAyB,CAAC;AAE5B,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAYrC,CAAC;AAEX,oCAA0B;AAC1B,YAAY,EAAE,mBAAmB,EAAE,qBAAiB;AACpD,OAAO,EAAE,qBAAqB,EAAE,qBAAiB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/restricted/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EACV,8BAA8B,EAC9B,cAAc,EACd,uCAAuC,EACxC,wCAAwC;AAEzC,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAiB;AAEvD,OAAO,KAAK,EACV,+BAA+B,EAC/B,0BAA0B,EAC3B,8BAA0B;AAE3B,OAAO,KAAK,EACV,iCAAiC,EACjC,4BAA4B,EAC7B,gCAA4B;AAE7B,OAAO,KAAK,EACV,+BAA+B,EAC/B,0BAA0B,EAC3B,8BAA0B;AAE3B,OAAO,KAAK,EAAE,eAAe,EAAE,0BAA0B,EAAE,yBAAqB;AAEhF,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAoB;AAExD,OAAO,KAAK,EAAE,yBAAyB,EAAE,6BAAyB;AAElE,OAAO,KAAK,EAAE,0BAA0B,EAAE,yBAAqB;AAE/D,OAAO,KAAK,EAAE,yBAAyB,EAAE,6BAAyB;AAElE,OAAO,KAAK,EACV,2BAA2B,EAC3B,sBAAsB,EACvB,0BAAsB;AAEvB,OAAO,KAAK,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,qBAAiB;AAE1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,OAAO,EAAE,0BAA0B,EAAE,yBAAqB;AAC1D,OAAO,EAAE,oBAAoB,EAAE,0BAAsB;AAErD,MAAM,MAAM,uBAAuB,GAC/B,sBAAsB,GACtB,+BAA+B,GAC/B,iCAAiC,GACjC,+BAA+B,GAC/B,0BAA0B,GAC1B,0BAA0B,GAC1B,2BAA2B,GAC3B,sBAAsB,CAAC;AAE3B,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,MAAM,EACN,uBAAuB,CACxB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,0BAA0B,GAC5D,4BAA4B,GAC5B,0BAA0B,GAC1B,eAAe,GACf,sBAAsB,GACtB,iBAAiB,GACjB,yBAAyB,GACzB,oBAAoB,GACpB,yBAAyB,CAAC;AAE5B,KAAK,iCAAiC,GAAG;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB,EAAE,8BAA8B,CAClD,cAAc,CAAC,gBAAgB,EAC/B,GAAG,EACH,uCAAuC,CACxC,CAAC;IACF,WAAW,CAAC,EAAE,SAAS,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC;IACzD,WAAW,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC1D,CAAC;AAEF,eAAO,MAAM,kCAAkC,EAAE,MAAM,CACrD,MAAM,EACN,iCAAiC,CAazB,CAAC;AAEX,oCAA0B;AAC1B,YAAY,EAAE,mBAAmB,EAAE,qBAAiB;AACpD,OAAO,EAAE,qBAAqB,EAAE,qBAAiB"}

package/dist/restricted/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/restricted/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,qBAAiB;AAEzC,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAE3D,OAAO,EAAE,wBAAwB,EAAE,gCAA4B;AAE/D,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAE3D,OAAO,EAAE,iBAAiB,EAAE,yBAAqB;AAEjD,OAAO,EAAE,gBAAgB,EAAE,wBAAoB;AAE/C,OAAO,EAAE,qBAAqB,EAAE,6BAAyB;AAEzD,OAAO,EAAE,iBAAiB,EAAE,yBAAqB;AAEjD,OAAO,EAAE,qBAAqB,EAAE,6BAAyB;AAEzD,OAAO,EAAE,kBAAkB,EAAE,0BAAsB;AAEnD,OAAO,EAAE,aAAa,EAAE,qBAAiB;AAEzC,OAAO,EAAE,0BAA0B,EAAE,yBAAqB;AAC1D,OAAO,EAAE,oBAAoB,EAAE,0BAAsB;AAcrD,MAAM,CAAC,MAAM,kCAAkC,GAAG;IAChD,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,aAAa;IACzC,CAAC,sBAAsB,CAAC,UAAU,CAAC,EAAE,sBAAsB;IAC3D,CAAC,wBAAwB,CAAC,UAAU,CAAC,EAAE,wBAAwB;IAC/D,CAAC,sBAAsB,CAAC,UAAU,CAAC,EAAE,sBAAsB;IAC3D,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,iBAAiB;IACjD,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,iBAAiB;IACjD,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,kBAAkB;IACnD,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,aAAa;IACzC,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,qBAAqB;IACzD,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,gBAAgB;IAC/C,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,qBAAqB;CACjD,CAAC;AAEX,oCAA0B;AAE1B,OAAO,EAAE,qBAAqB,EAAE,qBAAiB","sourcesContent":["import type { DialogMethodHooks } from './dialog';\nimport { dialogBuilder } from './dialog';\nimport type { GetBip32EntropyMethodHooks } from './getBip32Entropy';\nimport { getBip32EntropyBuilder } from './getBip32Entropy';\nimport type { GetBip32PublicKeyMethodHooks } from './getBip32PublicKey';\nimport { getBip32PublicKeyBuilder } from './getBip32PublicKey';\nimport type { GetBip44EntropyMethodHooks } from './getBip44Entropy';\nimport { getBip44EntropyBuilder } from './getBip44Entropy';\nimport type { GetEntropyHooks } from './getEntropy';\nimport { getEntropyBuilder } from './getEntropy';\nimport type { GetLocaleMethodHooks } from './getLocale';\nimport { getLocaleBuilder } from './getLocale';\nimport type { GetPreferencesMethodHooks } from './getPreferences';\nimport { getPreferencesBuilder } from './getPreferences';\nimport type { InvokeSnapMethodHooks } from './invokeSnap';\nimport { invokeSnapBuilder } from './invokeSnap';\nimport type { ManageAccountsMethodHooks } from './manageAccounts';\nimport { manageAccountsBuilder } from './manageAccounts';\nimport type { ManageStateMethodHooks } from './manageState';\nimport { manageStateBuilder } from './manageState';\nimport type { NotifyMethodHooks } from './notify';\nimport { notifyBuilder } from './notify';\n\nexport { WALLET_SNAP_PERMISSION_KEY } from './invokeSnap';\nexport { getEncryptionEntropy } from './manageState';\n\nexport type RestrictedMethodHooks = DialogMethodHooks &\n  GetBip32EntropyMethodHooks &\n  GetBip32PublicKeyMethodHooks &\n  GetBip44EntropyMethodHooks &\n  GetEntropyHooks &\n  InvokeSnapMethodHooks &\n  ManageStateMethodHooks &\n  NotifyMethodHooks &\n  ManageAccountsMethodHooks &\n  GetLocaleMethodHooks &\n  GetPreferencesMethodHooks;\n\nexport const restrictedMethodPermissionBuilders = {\n  [dialogBuilder.targetName]: dialogBuilder,\n  [getBip32EntropyBuilder.targetName]: getBip32EntropyBuilder,\n  [getBip32PublicKeyBuilder.targetName]: getBip32PublicKeyBuilder,\n  [getBip44EntropyBuilder.targetName]: getBip44EntropyBuilder,\n  [getEntropyBuilder.targetName]: getEntropyBuilder,\n  [invokeSnapBuilder.targetName]: invokeSnapBuilder,\n  [manageStateBuilder.targetName]: manageStateBuilder,\n  [notifyBuilder.targetName]: notifyBuilder,\n  [manageAccountsBuilder.targetName]: manageAccountsBuilder,\n  [getLocaleBuilder.targetName]: getLocaleBuilder,\n  [getPreferencesBuilder.targetName]: getPreferencesBuilder,\n} as const;\n\nexport * from './caveats';\nexport type { DialogApprovalTypes } from './dialog';\nexport { DIALOG_APPROVAL_TYPES } from './dialog';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/restricted/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,aAAa,EAAE,qBAAiB;AAKzC,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAK3D,OAAO,EAAE,wBAAwB,EAAE,gCAA4B;AAK/D,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAE3D,OAAO,EAAE,iBAAiB,EAAE,yBAAqB;AAEjD,OAAO,EAAE,gBAAgB,EAAE,wBAAoB;AAE/C,OAAO,EAAE,qBAAqB,EAAE,6BAAyB;AAEzD,OAAO,EAAE,iBAAiB,EAAE,yBAAqB;AAEjD,OAAO,EAAE,qBAAqB,EAAE,6BAAyB;AAKzD,OAAO,EAAE,kBAAkB,EAAE,0BAAsB;AAEnD,OAAO,EAAE,aAAa,EAAE,qBAAiB;AAGzC,OAAO,EAAE,0BAA0B,EAAE,yBAAqB;AAC1D,OAAO,EAAE,oBAAoB,EAAE,0BAAsB;AAsCrD,MAAM,CAAC,MAAM,kCAAkC,GAG3C;IACF,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,aAAa;IACzC,CAAC,sBAAsB,CAAC,UAAU,CAAC,EAAE,sBAAsB;IAC3D,CAAC,wBAAwB,CAAC,UAAU,CAAC,EAAE,wBAAwB;IAC/D,CAAC,sBAAsB,CAAC,UAAU,CAAC,EAAE,sBAAsB;IAC3D,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,iBAAiB;IACjD,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,iBAAiB;IACjD,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,kBAAkB;IACnD,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,aAAa;IACzC,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,qBAAqB;IACzD,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,gBAAgB;IAC/C,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,qBAAqB;CACjD,CAAC;AAEX,oCAA0B;AAE1B,OAAO,EAAE,qBAAqB,EAAE,qBAAiB","sourcesContent":["import type { Messenger } from '@metamask/messenger';\nimport type {\n  PermissionSpecificationBuilder,\n  PermissionType,\n  RestrictedMethodSpecificationConstraint,\n} from '@metamask/permission-controller';\n\nimport type { DialogMessengerActions } from './dialog';\nimport { dialogBuilder } from './dialog';\nimport type {\n  GetBip32EntropyMessengerActions,\n  GetBip32EntropyMethodHooks,\n} from './getBip32Entropy';\nimport { getBip32EntropyBuilder } from './getBip32Entropy';\nimport type {\n  GetBip32PublicKeyMessengerActions,\n  GetBip32PublicKeyMethodHooks,\n} from './getBip32PublicKey';\nimport { getBip32PublicKeyBuilder } from './getBip32PublicKey';\nimport type {\n  GetBip44EntropyMessengerActions,\n  GetBip44EntropyMethodHooks,\n} from './getBip44Entropy';\nimport { getBip44EntropyBuilder } from './getBip44Entropy';\nimport type { GetEntropyHooks, GetEntropyMessengerActions } from './getEntropy';\nimport { getEntropyBuilder } from './getEntropy';\nimport type { GetLocaleMethodHooks } from './getLocale';\nimport { getLocaleBuilder } from './getLocale';\nimport type { GetPreferencesMethodHooks } from './getPreferences';\nimport { getPreferencesBuilder } from './getPreferences';\nimport type { InvokeSnapMessengerActions } from './invokeSnap';\nimport { invokeSnapBuilder } from './invokeSnap';\nimport type { ManageAccountsMethodHooks } from './manageAccounts';\nimport { manageAccountsBuilder } from './manageAccounts';\nimport type {\n  ManageStateMessengerActions,\n  ManageStateMethodHooks,\n} from './manageState';\nimport { manageStateBuilder } from './manageState';\nimport type { NotifyMessengerActions, NotifyMethodHooks } from './notify';\nimport { notifyBuilder } from './notify';\nimport type { MethodHooksObject } from '../utils';\n\nexport { WALLET_SNAP_PERMISSION_KEY } from './invokeSnap';\nexport { getEncryptionEntropy } from './manageState';\n\nexport type RestrictedMethodActions =\n  | DialogMessengerActions\n  | GetBip32EntropyMessengerActions\n  | GetBip32PublicKeyMessengerActions\n  | GetBip44EntropyMessengerActions\n  | GetEntropyMessengerActions\n  | InvokeSnapMessengerActions\n  | ManageStateMessengerActions\n  | NotifyMessengerActions;\n\nexport type RestrictedMethodMessenger = Messenger<\n  string,\n  RestrictedMethodActions\n>;\n\nexport type RestrictedMethodHooks = GetBip32EntropyMethodHooks &\n  GetBip32PublicKeyMethodHooks &\n  GetBip44EntropyMethodHooks &\n  GetEntropyHooks &\n  ManageStateMethodHooks &\n  NotifyMethodHooks &\n  ManageAccountsMethodHooks &\n  GetLocaleMethodHooks &\n  GetPreferencesMethodHooks;\n\ntype RestrictedMethodPermissionBuilder = {\n  targetName: string;\n  specificationBuilder: PermissionSpecificationBuilder<\n    PermissionType.RestrictedMethod,\n    any,\n    RestrictedMethodSpecificationConstraint\n  >;\n  actionNames?: readonly RestrictedMethodActions['type'][];\n  methodHooks?: MethodHooksObject<Record<string, unknown>>;\n};\n\nexport const restrictedMethodPermissionBuilders: Record<\n  string,\n  RestrictedMethodPermissionBuilder\n> = {\n  [dialogBuilder.targetName]: dialogBuilder,\n  [getBip32EntropyBuilder.targetName]: getBip32EntropyBuilder,\n  [getBip32PublicKeyBuilder.targetName]: getBip32PublicKeyBuilder,\n  [getBip44EntropyBuilder.targetName]: getBip44EntropyBuilder,\n  [getEntropyBuilder.targetName]: getEntropyBuilder,\n  [invokeSnapBuilder.targetName]: invokeSnapBuilder,\n  [manageStateBuilder.targetName]: manageStateBuilder,\n  [notifyBuilder.targetName]: notifyBuilder,\n  [manageAccountsBuilder.targetName]: manageAccountsBuilder,\n  [getLocaleBuilder.targetName]: getLocaleBuilder,\n  [getPreferencesBuilder.targetName]: getPreferencesBuilder,\n} as const;\n\nexport * from './caveats';\nexport type { DialogApprovalTypes } from './dialog';\nexport { DIALOG_APPROVAL_TYPES } from './dialog';\n"]}

package/dist/restricted/invokeSnap.cjs

@@ -35,15 +35,17 @@ exports.handleSnapInstall = handleSnapInstall;
  * and install it if it's not available yet.
  *
  * @param options - The specification builder options.
- * @param options.methodHooks - The RPC method hooks needed by the method implementation.
+ * @param options.messenger - The messenger.
  * @returns The specification for the `wallet_snap_*` permission.
  */
-const specificationBuilder = ({ methodHooks }) => {
+const specificationBuilder = ({ messenger }) => {
     return {
         permissionType: permission_controller_1.PermissionType.RestrictedMethod,
         targetName: exports.WALLET_SNAP_PERMISSION_KEY,
         allowedCaveats: [snaps_utils_1.SnapCaveatType.SnapIds],
-        methodImplementation: getInvokeSnapImplementation(methodHooks),
+        methodImplementation: getInvokeSnapImplementation({
+            messenger,
+        }),
         validator: ({ caveats }) => {
             if (caveats?.length !== 1 || caveats[0].type !== snaps_utils_1.SnapCaveatType.SnapIds) {
                 throw rpc_errors_1.rpcErrors.invalidParams({
@@ -56,9 +58,6 @@ const specificationBuilder = ({ methodHooks }) => {
         },
     };
 };
-const methodHooks = {
-    handleSnapRpcRequest: true,
-};
 /**
  * Calls the specified JSON-RPC API method of the specified Snap. The Snap
  * must be installed and the dapp must have permission to communicate with the
@@ -84,22 +83,22 @@ const methodHooks = {
 exports.invokeSnapBuilder = Object.freeze({
     targetName: exports.WALLET_SNAP_PERMISSION_KEY,
     specificationBuilder,
-    methodHooks,
+    actionNames: ['SnapController:handleRequest'],
 });
 /**
  * Builds the method implementation for `wallet_snap_*`.
  *
- * @param hooks - The RPC method hooks.
- * @param hooks.handleSnapRpcRequest - A function that sends an RPC request to a snap's RPC handler or throws if that fails.
- * @returns The method implementation which returns the result of `handleSnapRpcRequest`.
+ * @param options - The options.
+ * @param options.messenger - The messenger.
+ * @returns The method implementation which returns the result of `SnapController:handleRequest`.
  * @throws If the params are invalid.
  */
-function getInvokeSnapImplementation({ handleSnapRpcRequest, }) {
+function getInvokeSnapImplementation({ messenger, }) {
     return async function invokeSnap(options) {
         const { params = {}, context } = options;
         const { snapId, request } = params;
         const { origin } = context;
-        return (await handleSnapRpcRequest({
+        return (await messenger.call('SnapController:handleRequest', {
             snapId,
             origin,
             request,

package/dist/restricted/invokeSnap.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"invokeSnap.cjs","sourceRoot":"","sources":["../../src/restricted/invokeSnap.ts"],"names":[],"mappings":";;;AAOA,2EAAiE;AACjE,qDAAiD;AAQjD,uDAAoE;AAKvD,QAAA,0BAA0B,GAAG,aAAa,CAAC;AA6CxD;;;;;;;GAOG;AACI,MAAM,iBAAiB,GAGX,KAAK,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,EAAE;IACtD,MAAM,KAAK,GAAG,WAAW,CAAC,WAAW,CAAC,kCAA0B,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;SAC3E,KAA2B,CAAC;IAE/B,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CACnC,kCAAkC,EAClC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAC5B,CAAC;IAEF,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAC5C,CAAC,aAAa,EAAE,IAAI,EAAE,EAAE;QACtB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,aAAa,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC,EACD,EAAE,CACH,CAAC;IAEF,OAAO,SAAS,CAAC,IAAI,CACnB,6BAA6B,EAC7B,WAAW,CAAC,QAAQ,CAAC,MAAM,EAC3B,YAAY,CACb,CAAC;AACJ,CAAC,CAAC;AA3BW,QAAA,iBAAiB,qBA2B5B;AACF;;;;;;;;;;;GAWG;AACH,MAAM,oBAAoB,GAItB,CAAC,EAAE,WAAW,EAAyC,EAAE,EAAE;IAC7D,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,gBAAgB;QAC/C,UAAU,EAAE,kCAA0B;QACtC,cAAc,EAAE,CAAC,4BAAc,CAAC,OAAO,CAAC;QACxC,oBAAoB,EAAE,2BAA2B,CAAC,WAAW,CAAC;QAC9D,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACzB,IAAI,OAAO,EAAE,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,4BAAc,CAAC,OAAO,EAAE,CAAC;gBACxE,MAAM,sBAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,sBAAsB,4BAAc,CAAC,OAAO,WAAW;iBACjE,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,UAAU,EAAE;YACV,WAAW,EAAE,yBAAiB;SAC/B;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAA6C;IAC5D,oBAAoB,EAAE,IAAI;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACU,QAAA,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7C,UAAU,EAAE,kCAA0B;IACtC,oBAAoB;IACpB,WAAW;CACH,CAAC,CAAC;AAEZ;;;;;;;GAOG;AACH,SAAgB,2BAA2B,CAAC,EAC1C,oBAAoB,GACE;IACtB,OAAO,KAAK,UAAU,UAAU,CAC9B,OAAkD;QAElD,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAEzC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAA0B,CAAC;QAEvD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAE3B,OAAO,CAAC,MAAM,oBAAoB,CAAC;YACjC,MAAM;YACN,MAAM;YACN,OAAO;YACP,OAAO,EAAE,yBAAW,CAAC,YAAY;SAClC,CAAC,CAAS,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAnBD,kEAmBC","sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n  PermissionValidatorConstraint,\n  PermissionSideEffect,\n} from '@metamask/permission-controller';\nimport { PermissionType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  InvokeSnapParams,\n  InvokeSnapResult,\n  RequestSnapsParams,\n  RequestSnapsResult,\n} from '@metamask/snaps-sdk';\nimport type { SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport { HandlerType, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nexport const WALLET_SNAP_PERMISSION_KEY = 'wallet_snap';\n\n// Redeclare installSnaps action type to avoid circular dependencies\nexport type SnapControllerInstallSnapsAction = {\n  type: `SnapController:installSnaps`;\n  handler: (\n    origin: string,\n    requestedSnaps: RequestSnapsParams,\n  ) => Promise<RequestSnapsResult>;\n};\n\nexport type SnapControllerGetPermittedSnapsAction = {\n  type: `SnapController:getPermittedSnaps`;\n  handler: (origin: string) => RequestSnapsResult;\n};\n\ntype AllowedActions =\n  | SnapControllerInstallSnapsAction\n  | SnapControllerGetPermittedSnapsAction;\n\nexport type InvokeSnapMethodHooks = {\n  handleSnapRpcRequest: ({\n    snapId,\n    origin,\n    handler,\n    request,\n  }: SnapRpcHookArgs & { snapId: string }) => Promise<unknown>;\n};\n\ntype InvokeSnapSpecificationBuilderOptions = {\n  allowedCaveats?: Readonly<NonEmptyArray<string>> | null;\n  methodHooks: InvokeSnapMethodHooks;\n};\n\ntype InvokeSnapSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof WALLET_SNAP_PERMISSION_KEY;\n  methodImplementation: ReturnType<typeof getInvokeSnapImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n  sideEffect: {\n    onPermitted: PermissionSideEffect<AllowedActions, never>['onPermitted'];\n  };\n}>;\n\n/**\n * The side-effect method to handle the snap install.\n *\n * @param params - The side-effect params.\n * @param params.requestData - The request data associated to the requested permission.\n * @param params.messenger - The messenger to call an action.\n * @returns The result of the Snap installation.\n */\nexport const handleSnapInstall: PermissionSideEffect<\n  AllowedActions,\n  never\n>['onPermitted'] = async ({ requestData, messenger }) => {\n  const snaps = requestData.permissions[WALLET_SNAP_PERMISSION_KEY].caveats?.[0]\n    .value as RequestSnapsParams;\n\n  const permittedSnaps = messenger.call(\n    `SnapController:getPermittedSnaps`,\n    requestData.metadata.origin,\n  );\n\n  const dedupedSnaps = Object.keys(snaps).reduce<RequestSnapsParams>(\n    (filteredSnaps, snap) => {\n      if (!permittedSnaps[snap]) {\n        filteredSnaps[snap] = snaps[snap];\n      }\n      return filteredSnaps;\n    },\n    {},\n  );\n\n  return messenger.call(\n    `SnapController:installSnaps`,\n    requestData.metadata.origin,\n    dedupedSnaps,\n  );\n};\n/**\n * The specification builder for the `wallet_snap_*` permission.\n *\n * `wallet_snap_*` attempts to invoke an RPC method of the specified Snap.\n *\n * Requesting its corresponding permission will attempt to connect to the Snap,\n * and install it if it's not available yet.\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 `wallet_snap_*` permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  InvokeSnapSpecificationBuilderOptions,\n  InvokeSnapSpecification\n> = ({ methodHooks }: InvokeSnapSpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName: WALLET_SNAP_PERMISSION_KEY,\n    allowedCaveats: [SnapCaveatType.SnapIds],\n    methodImplementation: getInvokeSnapImplementation(methodHooks),\n    validator: ({ caveats }) => {\n      if (caveats?.length !== 1 || caveats[0].type !== SnapCaveatType.SnapIds) {\n        throw rpcErrors.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.SnapIds}\" caveat.`,\n        });\n      }\n    },\n    sideEffect: {\n      onPermitted: handleSnapInstall,\n    },\n  };\n};\n\nconst methodHooks: MethodHooksObject<InvokeSnapMethodHooks> = {\n  handleSnapRpcRequest: true,\n};\n\n/**\n * Calls the specified JSON-RPC API method of the specified Snap. The Snap\n * must be installed and the dapp must have permission to communicate with the\n * Snap, or the request is rejected. The dapp can install the Snap and request\n * permission to communicate with it using\n * [`wallet_requestSnaps`](http://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).\n *\n * @example\n * ```ts\n * const result = await ethereum.request({\n *   method: 'wallet_snap',\n *   params: {\n *     snapId: 'npm:my-snap',\n *     request: {\n *       method: 'hello',\n *       params: { name: 'world' },\n *     },\n *   },\n * });\n * console.log(result); // \"Hello, world!\"\n * ```\n */\nexport const invokeSnapBuilder = Object.freeze({\n  targetName: WALLET_SNAP_PERMISSION_KEY,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\n/**\n * Builds the method implementation for `wallet_snap_*`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.handleSnapRpcRequest - A function that sends an RPC request to a snap's RPC handler or throws if that fails.\n * @returns The method implementation which returns the result of `handleSnapRpcRequest`.\n * @throws If the params are invalid.\n */\nexport function getInvokeSnapImplementation({\n  handleSnapRpcRequest,\n}: InvokeSnapMethodHooks) {\n  return async function invokeSnap(\n    options: RestrictedMethodOptions<InvokeSnapParams>,\n  ): Promise<InvokeSnapResult> {\n    const { params = {}, context } = options;\n\n    const { snapId, request } = params as InvokeSnapParams;\n\n    const { origin } = context;\n\n    return (await handleSnapRpcRequest({\n      snapId,\n      origin,\n      request,\n      handler: HandlerType.OnRpcRequest,\n    })) as Json;\n  };\n}\n"]}
+{"version":3,"file":"invokeSnap.cjs","sourceRoot":"","sources":["../../src/restricted/invokeSnap.ts"],"names":[],"mappings":";;;AAQA,2EAAiE;AACjE,qDAAiD;AAOjD,uDAAoE;AAKvD,QAAA,0BAA0B,GAAG,aAAa,CAAC;AAsCxD;;;;;;;GAOG;AACI,MAAM,iBAAiB,GAGX,KAAK,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,EAAE;IACtD,MAAM,KAAK,GAAG,WAAW,CAAC,WAAW,CAAC,kCAA0B,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;SAC3E,KAA2B,CAAC;IAE/B,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CACnC,kCAAkC,EAClC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAC5B,CAAC;IAEF,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAC5C,CAAC,aAAa,EAAE,IAAI,EAAE,EAAE;QACtB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,aAAa,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC,EACD,EAAE,CACH,CAAC;IAEF,OAAO,SAAS,CAAC,IAAI,CACnB,6BAA6B,EAC7B,WAAW,CAAC,QAAQ,CAAC,MAAM,EAC3B,YAAY,CACb,CAAC;AACJ,CAAC,CAAC;AA3BW,QAAA,iBAAiB,qBA2B5B;AACF;;;;;;;;;;;GAWG;AACH,MAAM,oBAAoB,GAItB,CAAC,EAAE,SAAS,EAAyC,EAAE,EAAE;IAC3D,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,gBAAgB;QAC/C,UAAU,EAAE,kCAA0B;QACtC,cAAc,EAAE,CAAC,4BAAc,CAAC,OAAO,CAAC;QACxC,oBAAoB,EAAE,2BAA2B,CAAC;YAChD,SAAS;SACV,CAAC;QACF,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACzB,IAAI,OAAO,EAAE,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,4BAAc,CAAC,OAAO,EAAE,CAAC;gBACxE,MAAM,sBAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,sBAAsB,4BAAc,CAAC,OAAO,WAAW;iBACjE,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,UAAU,EAAE;YACV,WAAW,EAAE,yBAAiB;SAC/B;KACF,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACU,QAAA,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7C,UAAU,EAAE,kCAA0B;IACtC,oBAAoB;IACpB,WAAW,EAAE,CAAC,8BAA8B,CAAC;CACrC,CAAC,CAAC;AAEZ;;;;;;;GAOG;AACH,SAAgB,2BAA2B,CAAC,EAC1C,SAAS,GAC6B;IACtC,OAAO,KAAK,UAAU,UAAU,CAC9B,OAAkD;QAElD,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAEzC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAA0B,CAAC;QAEvD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAE3B,OAAO,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,8BAA8B,EAAE;YAC3D,MAAM;YACN,MAAM;YACN,OAAO;YACP,OAAO,EAAE,yBAAW,CAAC,YAAY;SAClC,CAAC,CAAS,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAnBD,kEAmBC","sourcesContent":["import type { Messenger } from '@metamask/messenger';\nimport type {\n  PermissionSpecificationBuilder,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n  PermissionValidatorConstraint,\n  PermissionSideEffect,\n} from '@metamask/permission-controller';\nimport { PermissionType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  InvokeSnapParams,\n  InvokeSnapResult,\n  RequestSnapsParams,\n  RequestSnapsResult,\n} from '@metamask/snaps-sdk';\nimport { HandlerType, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\n\nimport type { SnapControllerHandleRequestAction } from '../types';\n\nexport const WALLET_SNAP_PERMISSION_KEY = 'wallet_snap';\n\n// Redeclare installSnaps action type to avoid circular dependencies\nexport type SnapControllerInstallSnapsAction = {\n  type: `SnapController:installSnaps`;\n  handler: (\n    origin: string,\n    requestedSnaps: RequestSnapsParams,\n  ) => Promise<RequestSnapsResult>;\n};\n\nexport type SnapControllerGetPermittedSnapsAction = {\n  type: `SnapController:getPermittedSnaps`;\n  handler: (origin: string) => RequestSnapsResult;\n};\n\ntype AllowedActions =\n  | SnapControllerInstallSnapsAction\n  | SnapControllerGetPermittedSnapsAction;\n\nexport type InvokeSnapMessengerActions = SnapControllerHandleRequestAction;\n\ntype InvokeSnapSpecificationBuilderOptions = {\n  allowedCaveats?: Readonly<NonEmptyArray<string>> | null;\n  messenger: Messenger<string, InvokeSnapMessengerActions>;\n};\n\ntype InvokeSnapSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof WALLET_SNAP_PERMISSION_KEY;\n  methodImplementation: ReturnType<typeof getInvokeSnapImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n  sideEffect: {\n    onPermitted: PermissionSideEffect<AllowedActions, never>['onPermitted'];\n  };\n}>;\n\n/**\n * The side-effect method to handle the snap install.\n *\n * @param params - The side-effect params.\n * @param params.requestData - The request data associated to the requested permission.\n * @param params.messenger - The messenger to call an action.\n * @returns The result of the Snap installation.\n */\nexport const handleSnapInstall: PermissionSideEffect<\n  AllowedActions,\n  never\n>['onPermitted'] = async ({ requestData, messenger }) => {\n  const snaps = requestData.permissions[WALLET_SNAP_PERMISSION_KEY].caveats?.[0]\n    .value as RequestSnapsParams;\n\n  const permittedSnaps = messenger.call(\n    `SnapController:getPermittedSnaps`,\n    requestData.metadata.origin,\n  );\n\n  const dedupedSnaps = Object.keys(snaps).reduce<RequestSnapsParams>(\n    (filteredSnaps, snap) => {\n      if (!permittedSnaps[snap]) {\n        filteredSnaps[snap] = snaps[snap];\n      }\n      return filteredSnaps;\n    },\n    {},\n  );\n\n  return messenger.call(\n    `SnapController:installSnaps`,\n    requestData.metadata.origin,\n    dedupedSnaps,\n  );\n};\n/**\n * The specification builder for the `wallet_snap_*` permission.\n *\n * `wallet_snap_*` attempts to invoke an RPC method of the specified Snap.\n *\n * Requesting its corresponding permission will attempt to connect to the Snap,\n * and install it if it's not available yet.\n *\n * @param options - The specification builder options.\n * @param options.messenger - The messenger.\n * @returns The specification for the `wallet_snap_*` permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  InvokeSnapSpecificationBuilderOptions,\n  InvokeSnapSpecification\n> = ({ messenger }: InvokeSnapSpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName: WALLET_SNAP_PERMISSION_KEY,\n    allowedCaveats: [SnapCaveatType.SnapIds],\n    methodImplementation: getInvokeSnapImplementation({\n      messenger,\n    }),\n    validator: ({ caveats }) => {\n      if (caveats?.length !== 1 || caveats[0].type !== SnapCaveatType.SnapIds) {\n        throw rpcErrors.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.SnapIds}\" caveat.`,\n        });\n      }\n    },\n    sideEffect: {\n      onPermitted: handleSnapInstall,\n    },\n  };\n};\n\n/**\n * Calls the specified JSON-RPC API method of the specified Snap. The Snap\n * must be installed and the dapp must have permission to communicate with the\n * Snap, or the request is rejected. The dapp can install the Snap and request\n * permission to communicate with it using\n * [`wallet_requestSnaps`](http://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).\n *\n * @example\n * ```ts\n * const result = await ethereum.request({\n *   method: 'wallet_snap',\n *   params: {\n *     snapId: 'npm:my-snap',\n *     request: {\n *       method: 'hello',\n *       params: { name: 'world' },\n *     },\n *   },\n * });\n * console.log(result); // \"Hello, world!\"\n * ```\n */\nexport const invokeSnapBuilder = Object.freeze({\n  targetName: WALLET_SNAP_PERMISSION_KEY,\n  specificationBuilder,\n  actionNames: ['SnapController:handleRequest'],\n} as const);\n\n/**\n * Builds the method implementation for `wallet_snap_*`.\n *\n * @param options - The options.\n * @param options.messenger - The messenger.\n * @returns The method implementation which returns the result of `SnapController:handleRequest`.\n * @throws If the params are invalid.\n */\nexport function getInvokeSnapImplementation({\n  messenger,\n}: InvokeSnapSpecificationBuilderOptions) {\n  return async function invokeSnap(\n    options: RestrictedMethodOptions<InvokeSnapParams>,\n  ): Promise<InvokeSnapResult> {\n    const { params = {}, context } = options;\n\n    const { snapId, request } = params as InvokeSnapParams;\n\n    const { origin } = context;\n\n    return (await messenger.call('SnapController:handleRequest', {\n      snapId,\n      origin,\n      request,\n      handler: HandlerType.OnRpcRequest,\n    })) as Json;\n  };\n}\n"]}

package/dist/restricted/invokeSnap.d.cts

@@ -1,9 +1,9 @@
+import type { Messenger } from "@metamask/messenger";
 import type { PermissionSpecificationBuilder, RestrictedMethodOptions, PermissionValidatorConstraint, PermissionSideEffect } from "@metamask/permission-controller";
 import { PermissionType } from "@metamask/permission-controller";
 import type { InvokeSnapParams, InvokeSnapResult, RequestSnapsParams, RequestSnapsResult } from "@metamask/snaps-sdk";
-import type { SnapRpcHookArgs } from "@metamask/snaps-utils";
 import type { NonEmptyArray } from "@metamask/utils";
-import type { MethodHooksObject } from "../utils.cjs";
+import type { SnapControllerHandleRequestAction } from "../types.cjs";
 export declare const WALLET_SNAP_PERMISSION_KEY = "wallet_snap";
 export type SnapControllerInstallSnapsAction = {
     type: `SnapController:installSnaps`;
@@ -14,14 +14,10 @@ export type SnapControllerGetPermittedSnapsAction = {
     handler: (origin: string) => RequestSnapsResult;
 };
 type AllowedActions = SnapControllerInstallSnapsAction | SnapControllerGetPermittedSnapsAction;
-export type InvokeSnapMethodHooks = {
-    handleSnapRpcRequest: ({ snapId, origin, handler, request, }: SnapRpcHookArgs & {
-        snapId: string;
-    }) => Promise<unknown>;
-};
+export type InvokeSnapMessengerActions = SnapControllerHandleRequestAction;
 type InvokeSnapSpecificationBuilderOptions = {
     allowedCaveats?: Readonly<NonEmptyArray<string>> | null;
-    methodHooks: InvokeSnapMethodHooks;
+    messenger: Messenger<string, InvokeSnapMessengerActions>;
 };
 /**
  * The side-effect method to handle the snap install.
@@ -66,16 +62,16 @@ export declare const invokeSnapBuilder: Readonly<{
             onPermitted: PermissionSideEffect<AllowedActions, never>['onPermitted'];
         };
     }>;
-    readonly methodHooks: MethodHooksObject<InvokeSnapMethodHooks>;
+    readonly actionNames: readonly ["SnapController:handleRequest"];
 }>;
 /**
  * Builds the method implementation for `wallet_snap_*`.
  *
- * @param hooks - The RPC method hooks.
- * @param hooks.handleSnapRpcRequest - A function that sends an RPC request to a snap's RPC handler or throws if that fails.
- * @returns The method implementation which returns the result of `handleSnapRpcRequest`.
+ * @param options - The options.
+ * @param options.messenger - The messenger.
+ * @returns The method implementation which returns the result of `SnapController:handleRequest`.
  * @throws If the params are invalid.
  */
-export declare function getInvokeSnapImplementation({ handleSnapRpcRequest, }: InvokeSnapMethodHooks): (options: RestrictedMethodOptions<InvokeSnapParams>) => Promise<InvokeSnapResult>;
+export declare function getInvokeSnapImplementation({ messenger, }: InvokeSnapSpecificationBuilderOptions): (options: RestrictedMethodOptions<InvokeSnapParams>) => Promise<InvokeSnapResult>;
 export {};
 //# sourceMappingURL=invokeSnap.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"invokeSnap.d.cts","sourceRoot":"","sources":["../../src/restricted/invokeSnap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8BAA8B,EAC9B,uBAAuB,EAEvB,6BAA6B,EAC7B,oBAAoB,EACrB,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAE,wCAAwC;AAEjE,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EACnB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,eAAe,EAAE,8BAA8B;AAE7D,OAAO,KAAK,EAAQ,aAAa,EAAE,wBAAwB;AAE3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,eAAO,MAAM,0BAA0B,gBAAgB,CAAC;AAGxD,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,kBAAkB,KAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,kBAAkB,CAAC;CACjD,CAAC;AAEF,KAAK,cAAc,GACf,gCAAgC,GAChC,qCAAqC,CAAC;AAE1C,MAAM,MAAM,qBAAqB,GAAG;IAClC,oBAAoB,EAAE,CAAC,EACrB,MAAM,EACN,MAAM,EACN,OAAO,EACP,OAAO,GACR,EAAE,eAAe,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC9D,CAAC;AAEF,KAAK,qCAAqC,GAAG;IAC3C,cAAc,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC;IACxD,WAAW,EAAE,qBAAqB,CAAC;CACpC,CAAC;AAaF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,EAAE,oBAAoB,CAClD,cAAc,EACd,KAAK,CACN,CAAC,aAAa,CAwBd,CAAC;AAwCF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,iBAAiB;;;wBA3GZ,eAAe,gBAAgB;oBACnC,iCAAiC;8BACvB,WAAW,kCAAkC,CAAC;wBACpD,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;mBAC3C,6BAA6B;oBAC5B;YACV,WAAW,EAAE,qBAAqB,cAAc,EAAE,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC;SACzE;;;EAwGQ,CAAC;AAEZ;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,oBAAoB,GACrB,EAAE,qBAAqB,aAEX,wBAAwB,gBAAgB,CAAC,KACjD,QAAQ,gBAAgB,CAAC,CAc7B"}
+{"version":3,"file":"invokeSnap.d.cts","sourceRoot":"","sources":["../../src/restricted/invokeSnap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EACV,8BAA8B,EAC9B,uBAAuB,EAEvB,6BAA6B,EAC7B,oBAAoB,EACrB,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAE,wCAAwC;AAEjE,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EACnB,4BAA4B;AAE7B,OAAO,KAAK,EAAQ,aAAa,EAAE,wBAAwB;AAE3D,OAAO,KAAK,EAAE,iCAAiC,EAAE,qBAAiB;AAElE,eAAO,MAAM,0BAA0B,gBAAgB,CAAC;AAGxD,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,kBAAkB,KAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,kBAAkB,CAAC;CACjD,CAAC;AAEF,KAAK,cAAc,GACf,gCAAgC,GAChC,qCAAqC,CAAC;AAE1C,MAAM,MAAM,0BAA0B,GAAG,iCAAiC,CAAC;AAE3E,KAAK,qCAAqC,GAAG;IAC3C,cAAc,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC;IACxD,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;CAC1D,CAAC;AAaF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,EAAE,oBAAoB,CAClD,cAAc,EACd,KAAK,CACN,CAAC,aAAa,CAwBd,CAAC;AAsCF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,iBAAiB;;;wBAzGZ,eAAe,gBAAgB;oBACnC,iCAAiC;8BACvB,WAAW,kCAAkC,CAAC;wBACpD,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;mBAC3C,6BAA6B;oBAC5B;YACV,WAAW,EAAE,qBAAqB,cAAc,EAAE,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC;SACzE;;;EAsGQ,CAAC;AAEZ;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,SAAS,GACV,EAAE,qCAAqC,aAE3B,wBAAwB,gBAAgB,CAAC,KACjD,QAAQ,gBAAgB,CAAC,CAc7B"}