@metamask/snaps-rpc-methods 11.0.0 → 11.1.0

package/dist/restricted/index.d.mts

@@ -0,0 +1,169 @@
+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 { GetLocaleMethodHooks } from "./getLocale.mjs";
+import type { GetPreferencesMethodHooks } from "./getPreferences.mjs";
+import type { InvokeSnapMethodHooks } from "./invokeSnap.mjs";
+import type { ManageAccountsMethodHooks } from "./manageAccounts.mjs";
+import type { ManageStateMethodHooks } from "./manageState.mjs";
+import type { NotifyMethodHooks } from "./notify.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").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").Bip32Entropy>) => Promise<import("@metamask/key-tree").JsonSLIP10Node>;
+            allowedCaveats: readonly [string, ...string[]] | null;
+            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
+        }>;
+        readonly methodHooks: import("../utils").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").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").Bip44Entropy>) => Promise<import("@metamask/key-tree").JsonBIP44CoinTypeNode>;
+            allowedCaveats: readonly [string, ...string[]] | null;
+            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
+        }>;
+        readonly methodHooks: import("../utils").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").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("./invokeSnap").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").InstallSnaps | import("./invokeSnap").GetPermittedSnaps, never>;
+            };
+        }>;
+        readonly methodHooks: import("../utils").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").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").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 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").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").MethodHooksObject<GetPreferencesMethodHooks>;
+    }>;
+};
+export * from "./caveats/index.mjs";
+export type { DialogApprovalTypes } from "./dialog.mjs";
+export { DIALOG_APPROVAL_TYPES } from "./dialog.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +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"}

package/dist/restricted/index.mjs

@@ -1,37 +1,29 @@
-import {
-  restrictedMethodPermissionBuilders
-} from "../chunk-V3KRSCUK.mjs";
-import {
-  getEncryptionEntropy
-} from "../chunk-TE4W25CA.mjs";
-import "../chunk-JWDQUKKU.mjs";
-import {
-  caveatMappers,
-  caveatSpecifications
-} from "../chunk-K3UL5RVN.mjs";
-import "../chunk-FJ7COFRJ.mjs";
-import "../chunk-PIAWDTWO.mjs";
-import "../chunk-I2P65KBQ.mjs";
-import "../chunk-VYII7C3J.mjs";
-import "../chunk-LR7UR4YU.mjs";
-import "../chunk-2RDYC42U.mjs";
-import "../chunk-AMMJ744B.mjs";
-import "../chunk-FM4LNQR7.mjs";
-import "../chunk-Z6YFGWHN.mjs";
-import {
-  DIALOG_APPROVAL_TYPES
-} from "../chunk-TQCUJQHY.mjs";
-import "../chunk-LXJBBRQ4.mjs";
-import {
-  WALLET_SNAP_PERMISSION_KEY
-} from "../chunk-VVBTXSID.mjs";
-import "../chunk-W33UWNA2.mjs";
-export {
-  DIALOG_APPROVAL_TYPES,
-  WALLET_SNAP_PERMISSION_KEY,
-  caveatMappers,
-  caveatSpecifications,
-  getEncryptionEntropy,
-  restrictedMethodPermissionBuilders
+import { dialogBuilder } from "./dialog.mjs";
+import { getBip32EntropyBuilder } from "./getBip32Entropy.mjs";
+import { getBip32PublicKeyBuilder } from "./getBip32PublicKey.mjs";
+import { getBip44EntropyBuilder } from "./getBip44Entropy.mjs";
+import { getEntropyBuilder } from "./getEntropy.mjs";
+import { getLocaleBuilder } from "./getLocale.mjs";
+import { getPreferencesBuilder } from "./getPreferences.mjs";
+import { invokeSnapBuilder } from "./invokeSnap.mjs";
+import { manageAccountsBuilder } from "./manageAccounts.mjs";
+import { manageStateBuilder } from "./manageState.mjs";
+import { notifyBuilder } from "./notify.mjs";
+export { WALLET_SNAP_PERMISSION_KEY } from "./invokeSnap.mjs";
+export { getEncryptionEntropy } from "./manageState.mjs";
+export const restrictedMethodPermissionBuilders = {
+    [dialogBuilder.targetName]: dialogBuilder,
+    [getBip32EntropyBuilder.targetName]: getBip32EntropyBuilder,
+    [getBip32PublicKeyBuilder.targetName]: getBip32PublicKeyBuilder,
+    [getBip44EntropyBuilder.targetName]: getBip44EntropyBuilder,
+    [getEntropyBuilder.targetName]: getEntropyBuilder,
+    [invokeSnapBuilder.targetName]: invokeSnapBuilder,
+    [manageStateBuilder.targetName]: manageStateBuilder,
+    [notifyBuilder.targetName]: notifyBuilder,
+    [manageAccountsBuilder.targetName]: manageAccountsBuilder,
+    [getLocaleBuilder.targetName]: getLocaleBuilder,
+    [getPreferencesBuilder.targetName]: getPreferencesBuilder,
 };
+export * from "./caveats/index.mjs";
+export { DIALOG_APPROVAL_TYPES } from "./dialog.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/restricted/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"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"]}

package/dist/restricted/invokeSnap.cjs

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvokeSnapImplementation = exports.invokeSnapBuilder = exports.handleSnapInstall = exports.WALLET_SNAP_PERMISSION_KEY = 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");
+exports.WALLET_SNAP_PERMISSION_KEY = 'wallet_snap';
+/**
+ * The side-effect method to handle the snap install.
+ *
+ * @param params - The side-effect params.
+ * @param params.requestData - The request data associated to the requested permission.
+ * @param params.messagingSystem - The messenger to call an action.
+ * @returns The result of the Snap installation.
+ */
+const handleSnapInstall = async ({ requestData, messagingSystem }) => {
+    const snaps = requestData.permissions[exports.WALLET_SNAP_PERMISSION_KEY].caveats?.[0]
+        .value;
+    const permittedSnaps = messagingSystem.call(`SnapController:getPermitted`, requestData.metadata.origin);
+    const dedupedSnaps = Object.keys(snaps).reduce((filteredSnaps, snap) => {
+        if (!permittedSnaps[snap]) {
+            filteredSnaps[snap] = snaps[snap];
+        }
+        return filteredSnaps;
+    }, {});
+    return messagingSystem.call(`SnapController:install`, requestData.metadata.origin, dedupedSnaps);
+};
+exports.handleSnapInstall = handleSnapInstall;
+/**
+ * The specification builder for the `wallet_snap_*` permission.
+ *
+ * `wallet_snap_*` attempts to invoke an RPC method of the specified Snap.
+ *
+ * Requesting its corresponding permission will attempt to connect to the Snap,
+ * 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.
+ * @returns The specification for the `wallet_snap_*` permission.
+ */
+const specificationBuilder = ({ methodHooks }) => {
+    return {
+        permissionType: permission_controller_1.PermissionType.RestrictedMethod,
+        targetName: exports.WALLET_SNAP_PERMISSION_KEY,
+        allowedCaveats: [snaps_utils_1.SnapCaveatType.SnapIds],
+        methodImplementation: getInvokeSnapImplementation(methodHooks),
+        validator: ({ caveats }) => {
+            if (caveats?.length !== 1 || caveats[0].type !== snaps_utils_1.SnapCaveatType.SnapIds) {
+                throw rpc_errors_1.rpcErrors.invalidParams({
+                    message: `Expected a single "${snaps_utils_1.SnapCaveatType.SnapIds}" caveat.`,
+                });
+            }
+        },
+        sideEffect: {
+            onPermitted: exports.handleSnapInstall,
+        },
+    };
+};
+const methodHooks = {
+    getSnap: true,
+    handleSnapRpcRequest: true,
+};
+exports.invokeSnapBuilder = Object.freeze({
+    targetName: exports.WALLET_SNAP_PERMISSION_KEY,
+    specificationBuilder,
+    methodHooks,
+});
+/**
+ * Builds the method implementation for `wallet_snap_*`.
+ *
+ * @param hooks - The RPC method hooks.
+ * @param hooks.getSnap - A function that retrieves all information stored about a snap.
+ * @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`.
+ * @throws If the params are invalid.
+ */
+function getInvokeSnapImplementation({ getSnap, handleSnapRpcRequest, }) {
+    return async function invokeSnap(options) {
+        const { params = {}, context } = options;
+        const { snapId, request } = params;
+        if (!getSnap(snapId)) {
+            throw rpc_errors_1.rpcErrors.invalidRequest({
+                message: `The snap "${snapId}" is not installed. Please install it first, before invoking the snap.`,
+            });
+        }
+        const { origin } = context;
+        return (await handleSnapRpcRequest({
+            snapId,
+            origin,
+            request,
+            handler: snaps_utils_1.HandlerType.OnRpcRequest,
+        }));
+    };
+}
+exports.getInvokeSnapImplementation = getInvokeSnapImplementation;
+//# sourceMappingURL=invokeSnap.cjs.map

package/dist/restricted/invokeSnap.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"invokeSnap.cjs","sourceRoot":"","sources":["../../src/restricted/invokeSnap.ts"],"names":[],"mappings":";;;AAOA,2EAAiE;AACjE,qDAAiD;AAOjD,uDAAoE;AAKvD,QAAA,0BAA0B,GAAG,aAAa,CAAC;AAiDxD;;;;;;;GAOG;AACI,MAAM,iBAAiB,GAGX,KAAK,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,EAAE,EAAE;IAC5D,MAAM,KAAK,GAAG,WAAW,CAAC,WAAW,CAAC,kCAA0B,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;SAC3E,KAA2B,CAAC;IAE/B,MAAM,cAAc,GAAG,eAAe,CAAC,IAAI,CACzC,6BAA6B,EAC7B,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,eAAe,CAAC,IAAI,CACzB,wBAAwB,EACxB,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,OAAO,EAAE,IAAI;IACb,oBAAoB,EAAE,IAAI;CAC3B,CAAC;AAEW,QAAA,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7C,UAAU,EAAE,kCAA0B;IACtC,oBAAoB;IACpB,WAAW;CACH,CAAC,CAAC;AAEZ;;;;;;;;GAQG;AACH,SAAgB,2BAA2B,CAAC,EAC1C,OAAO,EACP,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,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACrB,MAAM,sBAAS,CAAC,cAAc,CAAC;gBAC7B,OAAO,EAAE,aAAa,MAAM,wEAAwE;aACrG,CAAC,CAAC;QACL,CAAC;QAED,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;AA1BD,kEA0BC","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  InvokeSnapResult,\n  RequestSnapsParams,\n  RequestSnapsResult,\n} from '@metamask/snaps-sdk';\nimport type { Snap, 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 InstallSnaps = {\n  type: `SnapController:install`;\n  handler: (\n    origin: string,\n    requestedSnaps: RequestSnapsParams,\n  ) => Promise<RequestSnapsResult>;\n};\n\nexport type GetPermittedSnaps = {\n  type: `SnapController:getPermitted`;\n  handler: (origin: string) => RequestSnapsResult;\n};\n\ntype AllowedActions = InstallSnaps | GetPermittedSnaps;\n\nexport type InvokeSnapMethodHooks = {\n  getSnap: (snapId: string) => Snap | undefined;\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\nexport type InvokeSnapParams = {\n  snapId: string;\n  request: Record<string, Json>;\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.messagingSystem - 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, messagingSystem }) => {\n  const snaps = requestData.permissions[WALLET_SNAP_PERMISSION_KEY].caveats?.[0]\n    .value as RequestSnapsParams;\n\n  const permittedSnaps = messagingSystem.call(\n    `SnapController:getPermitted`,\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 messagingSystem.call(\n    `SnapController:install`,\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  getSnap: true,\n  handleSnapRpcRequest: true,\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.getSnap - A function that retrieves all information stored about a snap.\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  getSnap,\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    if (!getSnap(snapId)) {\n      throw rpcErrors.invalidRequest({\n        message: `The snap \"${snapId}\" is not installed. Please install it first, before invoking the snap.`,\n      });\n    }\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"]}

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

@@ -1,9 +1,9 @@
-import type { PermissionSpecificationBuilder, RestrictedMethodOptions, PermissionValidatorConstraint, PermissionSideEffect } from '@metamask/permission-controller';
-import { PermissionType } from '@metamask/permission-controller';
-import type { InvokeSnapResult, RequestSnapsParams, RequestSnapsResult } from '@metamask/snaps-sdk';
-import type { Snap, SnapRpcHookArgs } from '@metamask/snaps-utils';
-import type { Json, NonEmptyArray } from '@metamask/utils';
-import type { MethodHooksObject } from '../utils';
+import type { PermissionSpecificationBuilder, RestrictedMethodOptions, PermissionValidatorConstraint, PermissionSideEffect } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import type { InvokeSnapResult, RequestSnapsParams, RequestSnapsResult } from "@metamask/snaps-sdk";
+import type { Snap, SnapRpcHookArgs } from "@metamask/snaps-utils";
+import type { Json, NonEmptyArray } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.cjs";
 export declare const WALLET_SNAP_PERMISSION_KEY = "wallet_snap";
 export type InstallSnaps = {
     type: `SnapController:install`;
@@ -34,6 +34,7 @@ export type InvokeSnapParams = {
  * @param params - The side-effect params.
  * @param params.requestData - The request data associated to the requested permission.
  * @param params.messagingSystem - The messenger to call an action.
+ * @returns The result of the Snap installation.
  */
 export declare const handleSnapInstall: PermissionSideEffect<AllowedActions, never>['onPermitted'];
 export declare const invokeSnapBuilder: Readonly<{
@@ -61,3 +62,4 @@ export declare const invokeSnapBuilder: Readonly<{
  */
 export declare function getInvokeSnapImplementation({ getSnap, handleSnapRpcRequest, }: InvokeSnapMethodHooks): (options: RestrictedMethodOptions<InvokeSnapParams>) => Promise<InvokeSnapResult>;
 export {};
+//# sourceMappingURL=invokeSnap.d.cts.map

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

@@ -0,0 +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,kBAAkB,EAClB,kBAAkB,EACnB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,8BAA8B;AAEnE,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAE3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,eAAO,MAAM,0BAA0B,gBAAgB,CAAC;AAGxD,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,kBAAkB,KAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,kBAAkB,CAAC;CACjD,CAAC;AAEF,KAAK,cAAc,GAAG,YAAY,GAAG,iBAAiB,CAAC;AAEvD,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;IAC9C,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,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC/B,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,EAAE,oBAAoB,CAClD,cAAc,EACd,KAAK,CACN,CAAC,aAAa,CAwBd,CAAC;AAyCF,eAAO,MAAM,iBAAiB;;;wBA3FZ,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;;;EAwFQ,CAAC;AAEZ;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,OAAO,EACP,oBAAoB,GACrB,EAAE,qBAAqB,aAEX,wBAAwB,gBAAgB,CAAC,KACjD,QAAQ,gBAAgB,CAAC,CAoB7B"}

package/dist/restricted/invokeSnap.d.mts

@@ -0,0 +1,65 @@
+import type { PermissionSpecificationBuilder, RestrictedMethodOptions, PermissionValidatorConstraint, PermissionSideEffect } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import type { InvokeSnapResult, RequestSnapsParams, RequestSnapsResult } from "@metamask/snaps-sdk";
+import type { Snap, SnapRpcHookArgs } from "@metamask/snaps-utils";
+import type { Json, NonEmptyArray } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
+export declare const WALLET_SNAP_PERMISSION_KEY = "wallet_snap";
+export type InstallSnaps = {
+    type: `SnapController:install`;
+    handler: (origin: string, requestedSnaps: RequestSnapsParams) => Promise<RequestSnapsResult>;
+};
+export type GetPermittedSnaps = {
+    type: `SnapController:getPermitted`;
+    handler: (origin: string) => RequestSnapsResult;
+};
+type AllowedActions = InstallSnaps | GetPermittedSnaps;
+export type InvokeSnapMethodHooks = {
+    getSnap: (snapId: string) => Snap | undefined;
+    handleSnapRpcRequest: ({ snapId, origin, handler, request, }: SnapRpcHookArgs & {
+        snapId: string;
+    }) => Promise<unknown>;
+};
+type InvokeSnapSpecificationBuilderOptions = {
+    allowedCaveats?: Readonly<NonEmptyArray<string>> | null;
+    methodHooks: InvokeSnapMethodHooks;
+};
+export type InvokeSnapParams = {
+    snapId: string;
+    request: Record<string, Json>;
+};
+/**
+ * The side-effect method to handle the snap install.
+ *
+ * @param params - The side-effect params.
+ * @param params.requestData - The request data associated to the requested permission.
+ * @param params.messagingSystem - The messenger to call an action.
+ * @returns The result of the Snap installation.
+ */
+export declare const handleSnapInstall: PermissionSideEffect<AllowedActions, never>['onPermitted'];
+export declare const invokeSnapBuilder: Readonly<{
+    readonly targetName: "wallet_snap";
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.RestrictedMethod, InvokeSnapSpecificationBuilderOptions, {
+        permissionType: PermissionType.RestrictedMethod;
+        targetName: typeof WALLET_SNAP_PERMISSION_KEY;
+        methodImplementation: ReturnType<typeof getInvokeSnapImplementation>;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+        validator: PermissionValidatorConstraint;
+        sideEffect: {
+            onPermitted: PermissionSideEffect<AllowedActions, never>['onPermitted'];
+        };
+    }>;
+    readonly methodHooks: MethodHooksObject<InvokeSnapMethodHooks>;
+}>;
+/**
+ * Builds the method implementation for `wallet_snap_*`.
+ *
+ * @param hooks - The RPC method hooks.
+ * @param hooks.getSnap - A function that retrieves all information stored about a snap.
+ * @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`.
+ * @throws If the params are invalid.
+ */
+export declare function getInvokeSnapImplementation({ getSnap, handleSnapRpcRequest, }: InvokeSnapMethodHooks): (options: RestrictedMethodOptions<InvokeSnapParams>) => Promise<InvokeSnapResult>;
+export {};
+//# sourceMappingURL=invokeSnap.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"invokeSnap.d.mts","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,kBAAkB,EAClB,kBAAkB,EACnB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,8BAA8B;AAEnE,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAE3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,eAAO,MAAM,0BAA0B,gBAAgB,CAAC;AAGxD,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,kBAAkB,KAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,kBAAkB,CAAC;CACjD,CAAC;AAEF,KAAK,cAAc,GAAG,YAAY,GAAG,iBAAiB,CAAC;AAEvD,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;IAC9C,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,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC/B,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,EAAE,oBAAoB,CAClD,cAAc,EACd,KAAK,CACN,CAAC,aAAa,CAwBd,CAAC;AAyCF,eAAO,MAAM,iBAAiB;;;wBA3FZ,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;;;EAwFQ,CAAC;AAEZ;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,OAAO,EACP,oBAAoB,GACrB,EAAE,qBAAqB,aAEX,wBAAwB,gBAAgB,CAAC,KACjD,QAAQ,gBAAgB,CAAC,CAoB7B"}

package/dist/restricted/invokeSnap.mjs

@@ -1,13 +1,91 @@
-import {
-  WALLET_SNAP_PERMISSION_KEY,
-  getInvokeSnapImplementation,
-  handleSnapInstall,
-  invokeSnapBuilder
-} from "../chunk-VVBTXSID.mjs";
-export {
-  WALLET_SNAP_PERMISSION_KEY,
-  getInvokeSnapImplementation,
-  handleSnapInstall,
-  invokeSnapBuilder
+import { PermissionType } from "@metamask/permission-controller";
+import { rpcErrors } from "@metamask/rpc-errors";
+import { HandlerType, SnapCaveatType } from "@metamask/snaps-utils";
+export const WALLET_SNAP_PERMISSION_KEY = 'wallet_snap';
+/**
+ * The side-effect method to handle the snap install.
+ *
+ * @param params - The side-effect params.
+ * @param params.requestData - The request data associated to the requested permission.
+ * @param params.messagingSystem - The messenger to call an action.
+ * @returns The result of the Snap installation.
+ */
+export const handleSnapInstall = async ({ requestData, messagingSystem }) => {
+    const snaps = requestData.permissions[WALLET_SNAP_PERMISSION_KEY].caveats?.[0]
+        .value;
+    const permittedSnaps = messagingSystem.call(`SnapController:getPermitted`, requestData.metadata.origin);
+    const dedupedSnaps = Object.keys(snaps).reduce((filteredSnaps, snap) => {
+        if (!permittedSnaps[snap]) {
+            filteredSnaps[snap] = snaps[snap];
+        }
+        return filteredSnaps;
+    }, {});
+    return messagingSystem.call(`SnapController:install`, requestData.metadata.origin, dedupedSnaps);
 };
+/**
+ * The specification builder for the `wallet_snap_*` permission.
+ *
+ * `wallet_snap_*` attempts to invoke an RPC method of the specified Snap.
+ *
+ * Requesting its corresponding permission will attempt to connect to the Snap,
+ * 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.
+ * @returns The specification for the `wallet_snap_*` permission.
+ */
+const specificationBuilder = ({ methodHooks }) => {
+    return {
+        permissionType: PermissionType.RestrictedMethod,
+        targetName: WALLET_SNAP_PERMISSION_KEY,
+        allowedCaveats: [SnapCaveatType.SnapIds],
+        methodImplementation: getInvokeSnapImplementation(methodHooks),
+        validator: ({ caveats }) => {
+            if (caveats?.length !== 1 || caveats[0].type !== SnapCaveatType.SnapIds) {
+                throw rpcErrors.invalidParams({
+                    message: `Expected a single "${SnapCaveatType.SnapIds}" caveat.`,
+                });
+            }
+        },
+        sideEffect: {
+            onPermitted: handleSnapInstall,
+        },
+    };
+};
+const methodHooks = {
+    getSnap: true,
+    handleSnapRpcRequest: true,
+};
+export const invokeSnapBuilder = Object.freeze({
+    targetName: WALLET_SNAP_PERMISSION_KEY,
+    specificationBuilder,
+    methodHooks,
+});
+/**
+ * Builds the method implementation for `wallet_snap_*`.
+ *
+ * @param hooks - The RPC method hooks.
+ * @param hooks.getSnap - A function that retrieves all information stored about a snap.
+ * @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`.
+ * @throws If the params are invalid.
+ */
+export function getInvokeSnapImplementation({ getSnap, handleSnapRpcRequest, }) {
+    return async function invokeSnap(options) {
+        const { params = {}, context } = options;
+        const { snapId, request } = params;
+        if (!getSnap(snapId)) {
+            throw rpcErrors.invalidRequest({
+                message: `The snap "${snapId}" is not installed. Please install it first, before invoking the snap.`,
+            });
+        }
+        const { origin } = context;
+        return (await handleSnapRpcRequest({
+            snapId,
+            origin,
+            request,
+            handler: HandlerType.OnRpcRequest,
+        }));
+    };
+}
 //# sourceMappingURL=invokeSnap.mjs.map

package/dist/restricted/invokeSnap.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"invokeSnap.mjs","sourceRoot":"","sources":["../../src/restricted/invokeSnap.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,cAAc,EAAE,wCAAwC;AACjE,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAOjD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,8BAA8B;AAKpE,MAAM,CAAC,MAAM,0BAA0B,GAAG,aAAa,CAAC;AAiDxD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAGX,KAAK,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,EAAE,EAAE;IAC5D,MAAM,KAAK,GAAG,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;SAC3E,KAA2B,CAAC;IAE/B,MAAM,cAAc,GAAG,eAAe,CAAC,IAAI,CACzC,6BAA6B,EAC7B,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,eAAe,CAAC,IAAI,CACzB,wBAAwB,EACxB,WAAW,CAAC,QAAQ,CAAC,MAAM,EAC3B,YAAY,CACb,CAAC;AACJ,CAAC,CAAC;AACF;;;;;;;;;;;GAWG;AACH,MAAM,oBAAoB,GAItB,CAAC,EAAE,WAAW,EAAyC,EAAE,EAAE;IAC7D,OAAO;QACL,cAAc,EAAE,cAAc,CAAC,gBAAgB;QAC/C,UAAU,EAAE,0BAA0B;QACtC,cAAc,EAAE,CAAC,cAAc,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,cAAc,CAAC,OAAO,EAAE,CAAC;gBACxE,MAAM,SAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,sBAAsB,cAAc,CAAC,OAAO,WAAW;iBACjE,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,UAAU,EAAE;YACV,WAAW,EAAE,iBAAiB;SAC/B;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAA6C;IAC5D,OAAO,EAAE,IAAI;IACb,oBAAoB,EAAE,IAAI;CAC3B,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7C,UAAU,EAAE,0BAA0B;IACtC,oBAAoB;IACpB,WAAW;CACH,CAAC,CAAC;AAEZ;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CAAC,EAC1C,OAAO,EACP,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,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACrB,MAAM,SAAS,CAAC,cAAc,CAAC;gBAC7B,OAAO,EAAE,aAAa,MAAM,wEAAwE;aACrG,CAAC,CAAC;QACL,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAE3B,OAAO,CAAC,MAAM,oBAAoB,CAAC;YACjC,MAAM;YACN,MAAM;YACN,OAAO;YACP,OAAO,EAAE,WAAW,CAAC,YAAY;SAClC,CAAC,CAAS,CAAC;IACd,CAAC,CAAC;AACJ,CAAC","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  InvokeSnapResult,\n  RequestSnapsParams,\n  RequestSnapsResult,\n} from '@metamask/snaps-sdk';\nimport type { Snap, 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 InstallSnaps = {\n  type: `SnapController:install`;\n  handler: (\n    origin: string,\n    requestedSnaps: RequestSnapsParams,\n  ) => Promise<RequestSnapsResult>;\n};\n\nexport type GetPermittedSnaps = {\n  type: `SnapController:getPermitted`;\n  handler: (origin: string) => RequestSnapsResult;\n};\n\ntype AllowedActions = InstallSnaps | GetPermittedSnaps;\n\nexport type InvokeSnapMethodHooks = {\n  getSnap: (snapId: string) => Snap | undefined;\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\nexport type InvokeSnapParams = {\n  snapId: string;\n  request: Record<string, Json>;\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.messagingSystem - 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, messagingSystem }) => {\n  const snaps = requestData.permissions[WALLET_SNAP_PERMISSION_KEY].caveats?.[0]\n    .value as RequestSnapsParams;\n\n  const permittedSnaps = messagingSystem.call(\n    `SnapController:getPermitted`,\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 messagingSystem.call(\n    `SnapController:install`,\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  getSnap: true,\n  handleSnapRpcRequest: true,\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.getSnap - A function that retrieves all information stored about a snap.\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  getSnap,\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    if (!getSnap(snapId)) {\n      throw rpcErrors.invalidRequest({\n        message: `The snap \"${snapId}\" is not installed. Please install it first, before invoking the snap.`,\n      });\n    }\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"]}