@metamask/snaps-rpc-methods 15.1.1 → 16.0.0

package/dist/permitted/getSnaps.d.cts

@@ -1,7 +1,9 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
 import type { GetSnapsResult } from "@metamask/snaps-sdk";
-import type { PendingJsonRpcResponse } from "@metamask/utils";
-import type { MethodHooksObject } from "../utils.cjs";
+import type { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+import type { SnapControllerGetPermittedSnapsAction } from "../types.cjs";
+export type GetSnapsMethodActions = SnapControllerGetPermittedSnapsAction;
 /**
  * Get permitted and installed Snaps for the requesting origin.
  *
@@ -24,29 +26,24 @@ import type { MethodHooksObject } from "../utils.cjs";
  * ```
  */
 export declare const getSnapsHandler: {
-    methodNames: ["wallet_getSnaps"];
     implementation: typeof getSnapsImplementation;
-    hookNames: MethodHooksObject<GetSnapsHooks>;
-};
-export type GetSnapsHooks = {
-    /**
-     * @returns The permitted and installed snaps for the requesting origin.
-     */
-    getSnaps: () => Promise<GetSnapsResult>;
+    actionNames: "SnapController:getPermittedSnaps"[];
 };
 /**
  * The `wallet_getSnaps` method implementation.
  * Fetches available snaps for the requesting origin and adds them to the JSON-RPC response.
  *
- * @param _req - The JSON-RPC request object. Not used by this function.
+ * @param req - The JSON-RPC request object.
  * @param res - The JSON-RPC response object.
  * @param _next - The `json-rpc-engine` "next" callback. Not used by this
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
- * @param hooks - The RPC method hooks.
- * @param hooks.getSnaps - A function that returns the snaps available for the requesting origin.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function getSnapsImplementation(_req: unknown, res: PendingJsonRpcResponse<GetSnapsResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getSnaps }: GetSnapsHooks): Promise<void>;
+declare function getSnapsImplementation(req: JsonRpcRequest & {
+    origin: string;
+}, res: PendingJsonRpcResponse<GetSnapsResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, GetSnapsMethodActions>): Promise<void>;
 export {};
 //# sourceMappingURL=getSnaps.d.cts.map

package/dist/permitted/getSnaps.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"getSnaps.d.cts","sourceRoot":"","sources":["../../src/permitted/getSnaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAE1E,OAAO,KAAK,EAAE,cAAc,EAAE,4BAA4B;AAC1D,OAAO,KAAK,EAAiB,sBAAsB,EAAE,wBAAwB;AAE7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAQlD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,eAAe;;;;CAQ3B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;CACzC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAe,sBAAsB,CACnC,IAAI,EAAE,OAAO,EACb,GAAG,EAAE,sBAAsB,CAAC,cAAc,CAAC,EAC3C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,QAAQ,EAAE,EAAE,aAAa,GAC1B,OAAO,CAAC,IAAI,CAAC,CAIf"}
+{"version":3,"file":"getSnaps.d.cts","sourceRoot":"","sources":["../../src/permitted/getSnaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,4BAA4B;AAC1D,OAAO,KAAK,EAEV,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAEzB,OAAO,KAAK,EAAE,qCAAqC,EAAE,qBAAiB;AAEtE,MAAM,MAAM,qBAAqB,GAAG,qCAAqC,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,eAAe;;;CAS3B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAe,sBAAsB,CACnC,GAAG,EAAE,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,EACxC,GAAG,EAAE,sBAAsB,CAAC,cAAc,CAAC,EAC3C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAClD,OAAO,CAAC,IAAI,CAAC,CAGf"}

package/dist/permitted/getSnaps.d.mts

@@ -1,7 +1,9 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
 import type { GetSnapsResult } from "@metamask/snaps-sdk";
-import type { PendingJsonRpcResponse } from "@metamask/utils";
-import type { MethodHooksObject } from "../utils.mjs";
+import type { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+import type { SnapControllerGetPermittedSnapsAction } from "../types.mjs";
+export type GetSnapsMethodActions = SnapControllerGetPermittedSnapsAction;
 /**
  * Get permitted and installed Snaps for the requesting origin.
  *
@@ -24,29 +26,24 @@ import type { MethodHooksObject } from "../utils.mjs";
  * ```
  */
 export declare const getSnapsHandler: {
-    methodNames: ["wallet_getSnaps"];
     implementation: typeof getSnapsImplementation;
-    hookNames: MethodHooksObject<GetSnapsHooks>;
-};
-export type GetSnapsHooks = {
-    /**
-     * @returns The permitted and installed snaps for the requesting origin.
-     */
-    getSnaps: () => Promise<GetSnapsResult>;
+    actionNames: "SnapController:getPermittedSnaps"[];
 };
 /**
  * The `wallet_getSnaps` method implementation.
  * Fetches available snaps for the requesting origin and adds them to the JSON-RPC response.
  *
- * @param _req - The JSON-RPC request object. Not used by this function.
+ * @param req - The JSON-RPC request object.
  * @param res - The JSON-RPC response object.
  * @param _next - The `json-rpc-engine` "next" callback. Not used by this
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
- * @param hooks - The RPC method hooks.
- * @param hooks.getSnaps - A function that returns the snaps available for the requesting origin.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function getSnapsImplementation(_req: unknown, res: PendingJsonRpcResponse<GetSnapsResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getSnaps }: GetSnapsHooks): Promise<void>;
+declare function getSnapsImplementation(req: JsonRpcRequest & {
+    origin: string;
+}, res: PendingJsonRpcResponse<GetSnapsResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, GetSnapsMethodActions>): Promise<void>;
 export {};
 //# sourceMappingURL=getSnaps.d.mts.map

package/dist/permitted/getSnaps.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"getSnaps.d.mts","sourceRoot":"","sources":["../../src/permitted/getSnaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAE1E,OAAO,KAAK,EAAE,cAAc,EAAE,4BAA4B;AAC1D,OAAO,KAAK,EAAiB,sBAAsB,EAAE,wBAAwB;AAE7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAQlD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,eAAe;;;;CAQ3B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;CACzC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAe,sBAAsB,CACnC,IAAI,EAAE,OAAO,EACb,GAAG,EAAE,sBAAsB,CAAC,cAAc,CAAC,EAC3C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,QAAQ,EAAE,EAAE,aAAa,GAC1B,OAAO,CAAC,IAAI,CAAC,CAIf"}
+{"version":3,"file":"getSnaps.d.mts","sourceRoot":"","sources":["../../src/permitted/getSnaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,4BAA4B;AAC1D,OAAO,KAAK,EAEV,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAEzB,OAAO,KAAK,EAAE,qCAAqC,EAAE,qBAAiB;AAEtE,MAAM,MAAM,qBAAqB,GAAG,qCAAqC,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,eAAe;;;CAS3B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAe,sBAAsB,CACnC,GAAG,EAAE,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,EACxC,GAAG,EAAE,sBAAsB,CAAC,cAAc,CAAC,EAC3C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAClD,OAAO,CAAC,IAAI,CAAC,CAGf"}

package/dist/permitted/getSnaps.mjs

@@ -1,7 +1,3 @@
-const methodName = 'wallet_getSnaps';
-const hookNames = {
-    getSnaps: true,
-};
 /**
  * Get permitted and installed Snaps for the requesting origin.
  *
@@ -24,26 +20,24 @@ const hookNames = {
  * ```
  */
 export const getSnapsHandler = {
-    methodNames: [methodName],
     implementation: getSnapsImplementation,
-    hookNames,
+    actionNames: ['SnapController:getPermittedSnaps'],
 };
 /**
  * The `wallet_getSnaps` method implementation.
  * Fetches available snaps for the requesting origin and adds them to the JSON-RPC response.
  *
- * @param _req - The JSON-RPC request object. Not used by this function.
+ * @param req - The JSON-RPC request object.
  * @param res - The JSON-RPC response object.
  * @param _next - The `json-rpc-engine` "next" callback. Not used by this
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
- * @param hooks - The RPC method hooks.
- * @param hooks.getSnaps - A function that returns the snaps available for the requesting origin.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-async function getSnapsImplementation(_req, res, _next, end, { getSnaps }) {
-    // getSnaps is already bound to the origin
-    res.result = await getSnaps();
+async function getSnapsImplementation(req, res, _next, end, _hooks, messenger) {
+    res.result = messenger.call('SnapController:getPermittedSnaps', req.origin);
     return end();
 }
 //# sourceMappingURL=getSnaps.mjs.map

package/dist/permitted/getSnaps.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getSnaps.mjs","sourceRoot":"","sources":["../../src/permitted/getSnaps.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,SAAS,GAAqC;IAClD,QAAQ,EAAE,IAAI;CACf,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,sBAAsB;IACtC,SAAS;CAKV,CAAC;AASF;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,sBAAsB,CACnC,IAAa,EACb,GAA2C,EAC3C,KAAc,EACd,GAA6B,EAC7B,EAAE,QAAQ,EAAiB;IAE3B,0CAA0C;IAC1C,GAAG,CAAC,MAAM,GAAG,MAAM,QAAQ,EAAE,CAAC;IAC9B,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport type { GetSnapsResult } from '@metamask/snaps-sdk';\nimport type { JsonRpcParams, PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'wallet_getSnaps';\n\nconst hookNames: MethodHooksObject<GetSnapsHooks> = {\n  getSnaps: true,\n};\n\n/**\n * Get permitted and installed Snaps for the requesting origin.\n *\n * @example\n * ```ts\n * const snaps = await snap.request({\n *   method: 'wallet_getSnaps',\n * });\n * console.log(snaps);\n * // {\n * //   'npm:example-snap': {\n * //     id: 'npm:example-snap',\n * //     version: '1.0.0',\n * //     initialPermissions: { ... },\n * //     blocked: false,\n * //     enabled: true,\n * //   },\n * //   ...,\n * // }\n * ```\n */\nexport const getSnapsHandler = {\n  methodNames: [methodName] as const,\n  implementation: getSnapsImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetSnapsHooks,\n  JsonRpcParams,\n  GetSnapsResult\n>;\n\nexport type GetSnapsHooks = {\n  /**\n   * @returns The permitted and installed snaps for the requesting origin.\n   */\n  getSnaps: () => Promise<GetSnapsResult>;\n};\n\n/**\n * The `wallet_getSnaps` method implementation.\n * Fetches available snaps for the requesting origin and adds them to the JSON-RPC response.\n *\n * @param _req - The JSON-RPC request object. Not used by this function.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getSnaps - A function that returns the snaps available for the requesting origin.\n * @returns Nothing.\n */\nasync function getSnapsImplementation(\n  _req: unknown,\n  res: PendingJsonRpcResponse<GetSnapsResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getSnaps }: GetSnapsHooks,\n): Promise<void> {\n  // getSnaps is already bound to the origin\n  res.result = await getSnaps();\n  return end();\n}\n"]}
+{"version":3,"file":"getSnaps.mjs","sourceRoot":"","sources":["../../src/permitted/getSnaps.ts"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,cAAc,EAAE,sBAAsB;IACtC,WAAW,EAAE,CAAC,kCAAkC,CAAC;CAOlD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,sBAAsB,CACnC,GAAwC,EACxC,GAA2C,EAC3C,KAAc,EACd,GAA6B,EAC7B,MAAa,EACb,SAAmD;IAEnD,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,kCAAkC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5E,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport type { GetSnapsResult } from '@metamask/snaps-sdk';\nimport type {\n  JsonRpcParams,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { SnapControllerGetPermittedSnapsAction } from '../types';\n\nexport type GetSnapsMethodActions = SnapControllerGetPermittedSnapsAction;\n\n/**\n * Get permitted and installed Snaps for the requesting origin.\n *\n * @example\n * ```ts\n * const snaps = await snap.request({\n *   method: 'wallet_getSnaps',\n * });\n * console.log(snaps);\n * // {\n * //   'npm:example-snap': {\n * //     id: 'npm:example-snap',\n * //     version: '1.0.0',\n * //     initialPermissions: { ... },\n * //     blocked: false,\n * //     enabled: true,\n * //   },\n * //   ...,\n * // }\n * ```\n */\nexport const getSnapsHandler = {\n  implementation: getSnapsImplementation,\n  actionNames: ['SnapController:getPermittedSnaps'],\n} satisfies MethodHandler<\n  never,\n  GetSnapsMethodActions,\n  JsonRpcParams,\n  GetSnapsResult,\n  { origin: string }\n>;\n\n/**\n * The `wallet_getSnaps` method implementation.\n * Fetches available snaps for the requesting origin and adds them to the JSON-RPC response.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param _hooks - The RPC method hooks. Not used by this function.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nasync function getSnapsImplementation(\n  req: JsonRpcRequest & { origin: string },\n  res: PendingJsonRpcResponse<GetSnapsResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  _hooks: never,\n  messenger: Messenger<string, GetSnapsMethodActions>,\n): Promise<void> {\n  res.result = messenger.call('SnapController:getPermittedSnaps', req.origin);\n  return end();\n}\n"]}

package/dist/permitted/getState.cjs

@@ -6,10 +6,7 @@ const superstruct_1 = require("@metamask/superstruct");
 const utils_1 = require("@metamask/utils");
 const manageState_1 = require("../restricted/manageState.cjs");
 const utils_2 = require("../utils.cjs");
-const methodName = 'snap_getState';
 const hookNames = {
-    hasPermission: true,
-    getSnapState: true,
     getUnlockPromise: true,
 };
 /**
@@ -37,9 +34,12 @@ const hookNames = {
  * ```
  */
 exports.getStateHandler = {
-    methodNames: [methodName],
     implementation: getStateImplementation,
     hookNames,
+    actionNames: [
+        'PermissionController:hasPermission',
+        'SnapController:getSnapState',
+    ],
 };
 const GetStateParametersStruct = (0, superstruct_1.object)({
     key: (0, superstruct_1.optional)(utils_2.StateKeyStruct),
@@ -54,10 +54,8 @@ const GetStateParametersStruct = (0, superstruct_1.object)({
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.hasPermission - Check whether a given origin has a given
- * permission.
- * @param hooks.getSnapState - Get the state of the requesting Snap.
  * @param hooks.getUnlockPromise - Wait for the extension to be unlocked.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
 async function getStateImplementation(request, 
@@ -66,9 +64,9 @@ async function getStateImplementation(request,
 // We use `GetStateResult` here to make it clear that this is the expected
 // type of the result.
 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments
-response, _next, end, { hasPermission, getSnapState, getUnlockPromise }) {
-    const { params } = request;
-    if (!hasPermission(manageState_1.manageStateBuilder.targetName)) {
+response, _next, end, { getUnlockPromise }, messenger) {
+    const { params, origin } = request;
+    if (!messenger.call('PermissionController:hasPermission', origin, manageState_1.manageStateBuilder.targetName)) {
         return end(rpc_errors_1.providerErrors.unauthorized());
     }
     try {
@@ -77,7 +75,7 @@ response, _next, end, { hasPermission, getSnapState, getUnlockPromise }) {
         if (encrypted) {
             await getUnlockPromise(true);
         }
-        const state = await getSnapState(encrypted);
+        const state = await messenger.call('SnapController:getSnapState', origin, encrypted);
         response.result = get(state, key);
     }
     catch (error) {

package/dist/permitted/getState.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"getState.cjs","sourceRoot":"","sources":["../../src/permitted/getState.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAGjE,uDAM+B;AAM/B,2CAAwD;AAExD,+DAA+D;AAE/D,wCAA0D;AAE1D,MAAM,UAAU,GAAG,eAAe,CAAC;AAEnC,MAAM,SAAS,GAAqC;IAClD,aAAa,EAAE,IAAI;IACnB,YAAY,EAAE,IAAI;IAClB,gBAAgB,EAAE,IAAI;CACvB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACU,QAAA,eAAe,GAAG;IAC7B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,sBAAsB;IACtC,SAAS;CAKV,CAAC;AA0BF,MAAM,wBAAwB,GAAG,IAAA,oBAAM,EAAC;IACtC,GAAG,EAAE,IAAA,sBAAQ,EAAC,sBAAc,CAAC;IAC7B,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,sBAAsB,CACnC,OAA2C;AAC3C,8EAA8E;AAC9E,6EAA6E;AAC7E,0EAA0E;AAC1E,sBAAsB;AACtB,4EAA4E;AAC5E,QAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAiB;IAEhE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC,aAAa,CAAC,gCAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClD,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC;QAElD,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,CAAC;QAC5C,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAgB;IAC1C,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QAED,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,GAAG,CACjB,KAAkC,EAClC,GAAwB;IAExB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,MAAM,GAAS,KAAK,CAAC;IAEzB,uEAAuE;IACvE,4DAA4D;IAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,sBAAc,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,MAAM,sBAAS,CAAC,aAAa,CAC3B,oDAAoD,CACrD,CAAC;QACJ,CAAC;QAED,IAAI,IAAA,gBAAQ,EAAC,MAAM,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,IAAA,mBAAW,EAAC,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC;gBACrC,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAlCD,kBAkCC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type { GetStateParams, GetStateResult } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  create,\n  object,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type {\n  PendingJsonRpcResponse,\n  Json,\n  JsonRpcRequest,\n} from '@metamask/utils';\nimport { hasProperty, isObject } from '@metamask/utils';\n\nimport { manageStateBuilder } from '../restricted/manageState';\nimport type { MethodHooksObject } from '../utils';\nimport { FORBIDDEN_KEYS, StateKeyStruct } from '../utils';\n\nconst methodName = 'snap_getState';\n\nconst hookNames: MethodHooksObject<GetStateHooks> = {\n  hasPermission: true,\n  getSnapState: true,\n  getUnlockPromise: true,\n};\n\n/**\n * Get the state of the Snap, or a specific value within the state. By default,\n * the data is automatically encrypted using a Snap-specific key and\n * automatically decrypted when retrieved. You can set `encrypted` to `false` to\n * use unencrypted storage (available when the client is locked).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"snap_manageState\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const state = await snap.request({\n *   method: 'snap_getState',\n *   params: {\n *     key: 'some.nested.value', // Optional, defaults to entire state\n *     encrypted: true, // Optional, defaults to `true`\n *   },\n * });\n * ```\n */\nexport const getStateHandler = {\n  methodNames: [methodName] as const,\n  implementation: getStateImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetStateHooks,\n  GetStateParameters,\n  GetStateResult\n>;\n\nexport type GetStateHooks = {\n  /**\n   * Check if the requesting origin has a given permission.\n   *\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the origin has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n\n  /**\n   * Get the state of the requesting Snap.\n   *\n   * @returns The current state of the Snap.\n   */\n  getSnapState: (encrypted: boolean) => Promise<Record<string, Json>>;\n\n  /**\n   * Wait for the extension to be unlocked.\n   *\n   * @returns A promise that resolves once the extension is unlocked.\n   */\n  getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;\n};\n\nconst GetStateParametersStruct = object({\n  key: optional(StateKeyStruct),\n  encrypted: optional(boolean()),\n});\n\nexport type GetStateParameters = InferMatching<\n  typeof GetStateParametersStruct,\n  GetStateParams\n>;\n\n/**\n * The `snap_getState` method implementation.\n *\n * @param request - The JSON-RPC request object.\n * @param response - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.hasPermission - Check whether a given origin has a given\n * permission.\n * @param hooks.getSnapState - Get the state of the requesting Snap.\n * @param hooks.getUnlockPromise - Wait for the extension to be unlocked.\n * @returns Nothing.\n */\nasync function getStateImplementation(\n  request: JsonRpcRequest<GetStateParameters>,\n  // `GetStateResult` is an alias for `Json` (which is the default type argument\n  // for `PendingJsonRpcResponse`), but that may not be the case in the future.\n  // We use `GetStateResult` here to make it clear that this is the expected\n  // type of the result.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n  response: PendingJsonRpcResponse<GetStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, getSnapState, getUnlockPromise }: GetStateHooks,\n): Promise<void> {\n  const { params } = request;\n\n  if (!hasPermission(manageStateBuilder.targetName)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const { key, encrypted = true } = validatedParams;\n\n    if (encrypted) {\n      await getUnlockPromise(true);\n    }\n\n    const state = await getSnapState(encrypted);\n    response.result = get(state, key);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters of the `snap_getState` method.\n *\n * @param params - The parameters to validate.\n * @returns The validated parameters.\n */\nfunction getValidatedParams(params?: unknown) {\n  try {\n    return create(params, GetStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n\n/**\n * Get the value of a key in an object. The key may contain Lodash-style path\n * syntax, e.g., `a.b.c` (with the exception of array syntax). If the key does\n * not exist, `null` is returned.\n *\n * This is a simplified version of Lodash's `get` function, but Lodash doesn't\n * seem to be maintained anymore, so we're using our own implementation.\n *\n * @param value - The object to get the key from.\n * @param key - The key to get.\n * @returns The value of the key in the object, or `null` if the key does not\n * exist.\n */\nexport function get(\n  value: Record<string, Json> | null,\n  key?: string | undefined,\n): Json {\n  if (key === undefined) {\n    return value;\n  }\n\n  const keys = key.split('.');\n  let result: Json = value;\n\n  // Intentionally using a classic for loop here for performance reasons.\n  // eslint-disable-next-line @typescript-eslint/prefer-for-of\n  for (let i = 0; i < keys.length; i++) {\n    const currentKey = keys[i];\n    if (FORBIDDEN_KEYS.includes(currentKey)) {\n      throw rpcErrors.invalidParams(\n        'Invalid params: Key contains forbidden characters.',\n      );\n    }\n\n    if (isObject(result)) {\n      if (!hasProperty(result, currentKey)) {\n        return null;\n      }\n\n      result = result[currentKey];\n      continue;\n    }\n\n    return null;\n  }\n\n  return result;\n}\n"]}
+{"version":3,"file":"getState.cjs","sourceRoot":"","sources":["../../src/permitted/getState.ts"],"names":[],"mappings":";;;AAMA,qDAAiE;AAGjE,uDAM+B;AAE/B,2CAAwD;AAExD,+DAA+D;AAM/D,wCAA0D;AAE1D,MAAM,SAAS,GAA2C;IACxD,gBAAgB,EAAE,IAAI;CACvB,CAAC;AAeF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACU,QAAA,eAAe,GAAG;IAC7B,cAAc,EAAE,sBAAsB;IACtC,SAAS;IACT,WAAW,EAAE;QACX,oCAAoC;QACpC,6BAA6B;KAC9B;CAOF,CAAC;AAEF,MAAM,wBAAwB,GAAG,IAAA,oBAAM,EAAC;IACtC,GAAG,EAAE,IAAA,sBAAQ,EAAC,sBAAc,CAAC;IAC7B,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,sBAAsB,CACnC,OAAqD;AACrD,8EAA8E;AAC9E,6EAA6E;AAC7E,0EAA0E;AAC1E,sBAAsB;AACtB,4EAA4E;AAC5E,QAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EAAE,gBAAgB,EAAuB,EACzC,SAAmD;IAEnD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAEnC,IACE,CAAC,SAAS,CAAC,IAAI,CACb,oCAAoC,EACpC,MAAM,EACN,gCAAkB,CAAC,UAAU,CAC9B,EACD,CAAC;QACD,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC;QAElD,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,IAAI,CAChC,6BAA6B,EAC7B,MAAM,EACN,SAAS,CACV,CAAC;QACF,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAgB;IAC1C,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QAED,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,GAAG,CACjB,KAAkC,EAClC,GAAwB;IAExB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,MAAM,GAAS,KAAK,CAAC;IAEzB,uEAAuE;IACvE,4DAA4D;IAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,sBAAc,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,MAAM,sBAAS,CAAC,aAAa,CAC3B,oDAAoD,CACrD,CAAC;QACJ,CAAC;QAED,IAAI,IAAA,gBAAQ,EAAC,MAAM,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,IAAA,mBAAW,EAAC,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC;gBACrC,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAlCD,kBAkCC","sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport type { PermissionControllerHasPermissionAction } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type { GetStateParams, GetStateResult } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  create,\n  object,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, Json } from '@metamask/utils';\nimport { hasProperty, isObject } from '@metamask/utils';\n\nimport { manageStateBuilder } from '../restricted/manageState';\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapControllerGetSnapStateAction,\n} from '../types';\nimport type { MethodHooksObject } from '../utils';\nimport { FORBIDDEN_KEYS, StateKeyStruct } from '../utils';\n\nconst hookNames: MethodHooksObject<GetStateMethodHooks> = {\n  getUnlockPromise: true,\n};\n\nexport type GetStateMethodHooks = {\n  /**\n   * Wait for the extension to be unlocked.\n   *\n   * @returns A promise that resolves once the extension is unlocked.\n   */\n  getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;\n};\n\nexport type GetStateMethodActions =\n  | PermissionControllerHasPermissionAction\n  | SnapControllerGetSnapStateAction;\n\n/**\n * Get the state of the Snap, or a specific value within the state. By default,\n * the data is automatically encrypted using a Snap-specific key and\n * automatically decrypted when retrieved. You can set `encrypted` to `false` to\n * use unencrypted storage (available when the client is locked).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"snap_manageState\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const state = await snap.request({\n *   method: 'snap_getState',\n *   params: {\n *     key: 'some.nested.value', // Optional, defaults to entire state\n *     encrypted: true, // Optional, defaults to `true`\n *   },\n * });\n * ```\n */\nexport const getStateHandler = {\n  implementation: getStateImplementation,\n  hookNames,\n  actionNames: [\n    'PermissionController:hasPermission',\n    'SnapController:getSnapState',\n  ],\n} satisfies MethodHandler<\n  GetStateMethodHooks,\n  GetStateMethodActions,\n  GetStateParameters,\n  GetStateResult,\n  { origin: string }\n>;\n\nconst GetStateParametersStruct = object({\n  key: optional(StateKeyStruct),\n  encrypted: optional(boolean()),\n});\n\nexport type GetStateParameters = InferMatching<\n  typeof GetStateParametersStruct,\n  GetStateParams\n>;\n\n/**\n * The `snap_getState` method implementation.\n *\n * @param request - The JSON-RPC request object.\n * @param response - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getUnlockPromise - Wait for the extension to be unlocked.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nasync function getStateImplementation(\n  request: JsonRpcRequestWithOrigin<GetStateParameters>,\n  // `GetStateResult` is an alias for `Json` (which is the default type argument\n  // for `PendingJsonRpcResponse`), but that may not be the case in the future.\n  // We use `GetStateResult` here to make it clear that this is the expected\n  // type of the result.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n  response: PendingJsonRpcResponse<GetStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getUnlockPromise }: GetStateMethodHooks,\n  messenger: Messenger<string, GetStateMethodActions>,\n): Promise<void> {\n  const { params, origin } = request;\n\n  if (\n    !messenger.call(\n      'PermissionController:hasPermission',\n      origin,\n      manageStateBuilder.targetName,\n    )\n  ) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const { key, encrypted = true } = validatedParams;\n\n    if (encrypted) {\n      await getUnlockPromise(true);\n    }\n\n    const state = await messenger.call(\n      'SnapController:getSnapState',\n      origin,\n      encrypted,\n    );\n    response.result = get(state, key);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters of the `snap_getState` method.\n *\n * @param params - The parameters to validate.\n * @returns The validated parameters.\n */\nfunction getValidatedParams(params?: unknown) {\n  try {\n    return create(params, GetStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n\n/**\n * Get the value of a key in an object. The key may contain Lodash-style path\n * syntax, e.g., `a.b.c` (with the exception of array syntax). If the key does\n * not exist, `null` is returned.\n *\n * This is a simplified version of Lodash's `get` function, but Lodash doesn't\n * seem to be maintained anymore, so we're using our own implementation.\n *\n * @param value - The object to get the key from.\n * @param key - The key to get.\n * @returns The value of the key in the object, or `null` if the key does not\n * exist.\n */\nexport function get(\n  value: Record<string, Json> | null,\n  key?: string | undefined,\n): Json {\n  if (key === undefined) {\n    return value;\n  }\n\n  const keys = key.split('.');\n  let result: Json = value;\n\n  // Intentionally using a classic for loop here for performance reasons.\n  // eslint-disable-next-line @typescript-eslint/prefer-for-of\n  for (let i = 0; i < keys.length; i++) {\n    const currentKey = keys[i];\n    if (FORBIDDEN_KEYS.includes(currentKey)) {\n      throw rpcErrors.invalidParams(\n        'Invalid params: Key contains forbidden characters.',\n      );\n    }\n\n    if (isObject(result)) {\n      if (!hasProperty(result, currentKey)) {\n        return null;\n      }\n\n      result = result[currentKey];\n      continue;\n    }\n\n    return null;\n  }\n\n  return result;\n}\n"]}

package/dist/permitted/getState.d.cts

@@ -1,8 +1,20 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
+import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
 import type { GetStateParams, GetStateResult } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
-import type { PendingJsonRpcResponse, Json, JsonRpcRequest } from "@metamask/utils";
+import type { PendingJsonRpcResponse, Json } from "@metamask/utils";
+import type { JsonRpcRequestWithOrigin, SnapControllerGetSnapStateAction } from "../types.cjs";
 import type { MethodHooksObject } from "../utils.cjs";
+export type GetStateMethodHooks = {
+    /**
+     * Wait for the extension to be unlocked.
+     *
+     * @returns A promise that resolves once the extension is unlocked.
+     */
+    getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;
+};
+export type GetStateMethodActions = PermissionControllerHasPermissionAction | SnapControllerGetSnapStateAction;
 /**
  * Get the state of the Snap, or a specific value within the state. By default,
  * the data is automatically encrypted using a Snap-specific key and
@@ -28,30 +40,9 @@ import type { MethodHooksObject } from "../utils.cjs";
  * ```
  */
 export declare const getStateHandler: {
-    methodNames: ["snap_getState"];
     implementation: typeof getStateImplementation;
-    hookNames: MethodHooksObject<GetStateHooks>;
-};
-export type GetStateHooks = {
-    /**
-     * Check if the requesting origin has a given permission.
-     *
-     * @param permissionName - The name of the permission to check.
-     * @returns Whether the origin has the permission.
-     */
-    hasPermission: (permissionName: string) => boolean;
-    /**
-     * Get the state of the requesting Snap.
-     *
-     * @returns The current state of the Snap.
-     */
-    getSnapState: (encrypted: boolean) => Promise<Record<string, Json>>;
-    /**
-     * Wait for the extension to be unlocked.
-     *
-     * @returns A promise that resolves once the extension is unlocked.
-     */
-    getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;
+    hookNames: MethodHooksObject<GetStateMethodHooks>;
+    actionNames: ("SnapController:getSnapState" | "PermissionController:hasPermission")[];
 };
 declare const GetStateParametersStruct: import("@metamask/superstruct").Struct<{
     encrypted?: boolean | undefined;
@@ -70,13 +61,11 @@ export type GetStateParameters = InferMatching<typeof GetStateParametersStruct,
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.hasPermission - Check whether a given origin has a given
- * permission.
- * @param hooks.getSnapState - Get the state of the requesting Snap.
  * @param hooks.getUnlockPromise - Wait for the extension to be unlocked.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function getStateImplementation(request: JsonRpcRequest<GetStateParameters>, response: PendingJsonRpcResponse<GetStateResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, getSnapState, getUnlockPromise }: GetStateHooks): Promise<void>;
+declare function getStateImplementation(request: JsonRpcRequestWithOrigin<GetStateParameters>, response: PendingJsonRpcResponse<GetStateResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getUnlockPromise }: GetStateMethodHooks, messenger: Messenger<string, GetStateMethodActions>): Promise<void>;
 /**
  * Get the value of a key in an object. The key may contain Lodash-style path
  * syntax, e.g., `a.b.c` (with the exception of array syntax). If the key does

package/dist/permitted/getState.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"getState.d.cts","sourceRoot":"","sources":["../../src/permitted/getState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,4BAA4B;AAC1E,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EACV,sBAAsB,EACtB,IAAI,EACJ,cAAc,EACf,wBAAwB;AAIzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAWlD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,eAAe;;;;CAQ3B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;OAKG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD;;;;OAIG;IACH,YAAY,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAEpE;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,uBAAuB,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvE,CAAC;AAEF,QAAA,MAAM,wBAAwB;;;;;;EAG5B,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAC5C,OAAO,wBAAwB,EAC/B,cAAc,CACf,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,sBAAsB,CACnC,OAAO,EAAE,cAAc,CAAC,kBAAkB,CAAC,EAM3C,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,EAChD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,EAAE,aAAa,GAC/D,OAAO,CAAC,IAAI,CAAC,CAsBf;AAuBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,GAAG,CACjB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,EAClC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,GACvB,IAAI,CA+BN"}
+{"version":3,"file":"getState.d.cts","sourceRoot":"","sources":["../../src/permitted/getState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,uCAAuC,EAAE,wCAAwC;AAE/F,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,4BAA4B;AAC1E,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,IAAI,EAAE,wBAAwB;AAIpE,OAAO,KAAK,EACV,wBAAwB,EACxB,gCAAgC,EACjC,qBAAiB;AAClB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAOlD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,uBAAuB,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvE,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAC7B,uCAAuC,GACvC,gCAAgC,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,eAAe;;;;CAa3B,CAAC;AAEF,QAAA,MAAM,wBAAwB;;;;;;EAG5B,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAC5C,OAAO,wBAAwB,EAC/B,cAAc,CACf,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAe,sBAAsB,CACnC,OAAO,EAAE,wBAAwB,CAAC,kBAAkB,CAAC,EAMrD,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,EAChD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,gBAAgB,EAAE,EAAE,mBAAmB,EACzC,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAClD,OAAO,CAAC,IAAI,CAAC,CAgCf;AAuBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,GAAG,CACjB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,EAClC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,GACvB,IAAI,CA+BN"}

package/dist/permitted/getState.d.mts

@@ -1,8 +1,20 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
+import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
 import type { GetStateParams, GetStateResult } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
-import type { PendingJsonRpcResponse, Json, JsonRpcRequest } from "@metamask/utils";
+import type { PendingJsonRpcResponse, Json } from "@metamask/utils";
+import type { JsonRpcRequestWithOrigin, SnapControllerGetSnapStateAction } from "../types.mjs";
 import type { MethodHooksObject } from "../utils.mjs";
+export type GetStateMethodHooks = {
+    /**
+     * Wait for the extension to be unlocked.
+     *
+     * @returns A promise that resolves once the extension is unlocked.
+     */
+    getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;
+};
+export type GetStateMethodActions = PermissionControllerHasPermissionAction | SnapControllerGetSnapStateAction;
 /**
  * Get the state of the Snap, or a specific value within the state. By default,
  * the data is automatically encrypted using a Snap-specific key and
@@ -28,30 +40,9 @@ import type { MethodHooksObject } from "../utils.mjs";
  * ```
  */
 export declare const getStateHandler: {
-    methodNames: ["snap_getState"];
     implementation: typeof getStateImplementation;
-    hookNames: MethodHooksObject<GetStateHooks>;
-};
-export type GetStateHooks = {
-    /**
-     * Check if the requesting origin has a given permission.
-     *
-     * @param permissionName - The name of the permission to check.
-     * @returns Whether the origin has the permission.
-     */
-    hasPermission: (permissionName: string) => boolean;
-    /**
-     * Get the state of the requesting Snap.
-     *
-     * @returns The current state of the Snap.
-     */
-    getSnapState: (encrypted: boolean) => Promise<Record<string, Json>>;
-    /**
-     * Wait for the extension to be unlocked.
-     *
-     * @returns A promise that resolves once the extension is unlocked.
-     */
-    getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;
+    hookNames: MethodHooksObject<GetStateMethodHooks>;
+    actionNames: ("SnapController:getSnapState" | "PermissionController:hasPermission")[];
 };
 declare const GetStateParametersStruct: import("@metamask/superstruct").Struct<{
     encrypted?: boolean | undefined;
@@ -70,13 +61,11 @@ export type GetStateParameters = InferMatching<typeof GetStateParametersStruct,
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.hasPermission - Check whether a given origin has a given
- * permission.
- * @param hooks.getSnapState - Get the state of the requesting Snap.
  * @param hooks.getUnlockPromise - Wait for the extension to be unlocked.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function getStateImplementation(request: JsonRpcRequest<GetStateParameters>, response: PendingJsonRpcResponse<GetStateResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, getSnapState, getUnlockPromise }: GetStateHooks): Promise<void>;
+declare function getStateImplementation(request: JsonRpcRequestWithOrigin<GetStateParameters>, response: PendingJsonRpcResponse<GetStateResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getUnlockPromise }: GetStateMethodHooks, messenger: Messenger<string, GetStateMethodActions>): Promise<void>;
 /**
  * Get the value of a key in an object. The key may contain Lodash-style path
  * syntax, e.g., `a.b.c` (with the exception of array syntax). If the key does

package/dist/permitted/getState.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"getState.d.mts","sourceRoot":"","sources":["../../src/permitted/getState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,4BAA4B;AAC1E,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EACV,sBAAsB,EACtB,IAAI,EACJ,cAAc,EACf,wBAAwB;AAIzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAWlD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,eAAe;;;;CAQ3B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;OAKG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD;;;;OAIG;IACH,YAAY,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAEpE;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,uBAAuB,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvE,CAAC;AAEF,QAAA,MAAM,wBAAwB;;;;;;EAG5B,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAC5C,OAAO,wBAAwB,EAC/B,cAAc,CACf,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,sBAAsB,CACnC,OAAO,EAAE,cAAc,CAAC,kBAAkB,CAAC,EAM3C,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,EAChD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,EAAE,aAAa,GAC/D,OAAO,CAAC,IAAI,CAAC,CAsBf;AAuBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,GAAG,CACjB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,EAClC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,GACvB,IAAI,CA+BN"}
+{"version":3,"file":"getState.d.mts","sourceRoot":"","sources":["../../src/permitted/getState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,uCAAuC,EAAE,wCAAwC;AAE/F,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,4BAA4B;AAC1E,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,IAAI,EAAE,wBAAwB;AAIpE,OAAO,KAAK,EACV,wBAAwB,EACxB,gCAAgC,EACjC,qBAAiB;AAClB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAOlD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,uBAAuB,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvE,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAC7B,uCAAuC,GACvC,gCAAgC,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,eAAe;;;;CAa3B,CAAC;AAEF,QAAA,MAAM,wBAAwB;;;;;;EAG5B,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAC5C,OAAO,wBAAwB,EAC/B,cAAc,CACf,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAe,sBAAsB,CACnC,OAAO,EAAE,wBAAwB,CAAC,kBAAkB,CAAC,EAMrD,QAAQ,EAAE,sBAAsB,CAAC,cAAc,CAAC,EAChD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,gBAAgB,EAAE,EAAE,mBAAmB,EACzC,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAClD,OAAO,CAAC,IAAI,CAAC,CAgCf;AAuBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,GAAG,CACjB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,EAClC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,GACvB,IAAI,CA+BN"}

package/dist/permitted/getState.mjs

@@ -3,10 +3,7 @@ import { boolean, create, object, optional, StructError } from "@metamask/supers
 import { hasProperty, isObject } from "@metamask/utils";
 import { manageStateBuilder } from "../restricted/manageState.mjs";
 import { FORBIDDEN_KEYS, StateKeyStruct } from "../utils.mjs";
-const methodName = 'snap_getState';
 const hookNames = {
-    hasPermission: true,
-    getSnapState: true,
     getUnlockPromise: true,
 };
 /**
@@ -34,9 +31,12 @@ const hookNames = {
  * ```
  */
 export const getStateHandler = {
-    methodNames: [methodName],
     implementation: getStateImplementation,
     hookNames,
+    actionNames: [
+        'PermissionController:hasPermission',
+        'SnapController:getSnapState',
+    ],
 };
 const GetStateParametersStruct = object({
     key: optional(StateKeyStruct),
@@ -51,10 +51,8 @@ const GetStateParametersStruct = object({
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.hasPermission - Check whether a given origin has a given
- * permission.
- * @param hooks.getSnapState - Get the state of the requesting Snap.
  * @param hooks.getUnlockPromise - Wait for the extension to be unlocked.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
 async function getStateImplementation(request, 
@@ -63,9 +61,9 @@ async function getStateImplementation(request,
 // We use `GetStateResult` here to make it clear that this is the expected
 // type of the result.
 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments
-response, _next, end, { hasPermission, getSnapState, getUnlockPromise }) {
-    const { params } = request;
-    if (!hasPermission(manageStateBuilder.targetName)) {
+response, _next, end, { getUnlockPromise }, messenger) {
+    const { params, origin } = request;
+    if (!messenger.call('PermissionController:hasPermission', origin, manageStateBuilder.targetName)) {
         return end(providerErrors.unauthorized());
     }
     try {
@@ -74,7 +72,7 @@ response, _next, end, { hasPermission, getSnapState, getUnlockPromise }) {
         if (encrypted) {
             await getUnlockPromise(true);
         }
-        const state = await getSnapState(encrypted);
+        const state = await messenger.call('SnapController:getSnapState', origin, encrypted);
         response.result = get(state, key);
     }
     catch (error) {

package/dist/permitted/getState.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getState.mjs","sourceRoot":"","sources":["../../src/permitted/getState.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAGjE,OAAO,EACL,OAAO,EACP,MAAM,EACN,MAAM,EACN,QAAQ,EACR,WAAW,EACZ,8BAA8B;AAM/B,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,wBAAwB;AAExD,OAAO,EAAE,kBAAkB,EAAE,sCAAkC;AAE/D,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,qBAAiB;AAE1D,MAAM,UAAU,GAAG,eAAe,CAAC;AAEnC,MAAM,SAAS,GAAqC;IAClD,aAAa,EAAE,IAAI;IACnB,YAAY,EAAE,IAAI;IAClB,gBAAgB,EAAE,IAAI;CACvB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,sBAAsB;IACtC,SAAS;CAKV,CAAC;AA0BF,MAAM,wBAAwB,GAAG,MAAM,CAAC;IACtC,GAAG,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC7B,SAAS,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,sBAAsB,CACnC,OAA2C;AAC3C,8EAA8E;AAC9E,6EAA6E;AAC7E,0EAA0E;AAC1E,sBAAsB;AACtB,4EAA4E;AAC5E,QAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAiB;IAEhE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC;QAElD,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,CAAC;QAC5C,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAgB;IAC1C,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QAED,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,GAAG,CACjB,KAAkC,EAClC,GAAwB;IAExB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,MAAM,GAAS,KAAK,CAAC;IAEzB,uEAAuE;IACvE,4DAA4D;IAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,MAAM,SAAS,CAAC,aAAa,CAC3B,oDAAoD,CACrD,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC;gBACrC,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type { GetStateParams, GetStateResult } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  create,\n  object,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type {\n  PendingJsonRpcResponse,\n  Json,\n  JsonRpcRequest,\n} from '@metamask/utils';\nimport { hasProperty, isObject } from '@metamask/utils';\n\nimport { manageStateBuilder } from '../restricted/manageState';\nimport type { MethodHooksObject } from '../utils';\nimport { FORBIDDEN_KEYS, StateKeyStruct } from '../utils';\n\nconst methodName = 'snap_getState';\n\nconst hookNames: MethodHooksObject<GetStateHooks> = {\n  hasPermission: true,\n  getSnapState: true,\n  getUnlockPromise: true,\n};\n\n/**\n * Get the state of the Snap, or a specific value within the state. By default,\n * the data is automatically encrypted using a Snap-specific key and\n * automatically decrypted when retrieved. You can set `encrypted` to `false` to\n * use unencrypted storage (available when the client is locked).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"snap_manageState\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const state = await snap.request({\n *   method: 'snap_getState',\n *   params: {\n *     key: 'some.nested.value', // Optional, defaults to entire state\n *     encrypted: true, // Optional, defaults to `true`\n *   },\n * });\n * ```\n */\nexport const getStateHandler = {\n  methodNames: [methodName] as const,\n  implementation: getStateImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetStateHooks,\n  GetStateParameters,\n  GetStateResult\n>;\n\nexport type GetStateHooks = {\n  /**\n   * Check if the requesting origin has a given permission.\n   *\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the origin has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n\n  /**\n   * Get the state of the requesting Snap.\n   *\n   * @returns The current state of the Snap.\n   */\n  getSnapState: (encrypted: boolean) => Promise<Record<string, Json>>;\n\n  /**\n   * Wait for the extension to be unlocked.\n   *\n   * @returns A promise that resolves once the extension is unlocked.\n   */\n  getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;\n};\n\nconst GetStateParametersStruct = object({\n  key: optional(StateKeyStruct),\n  encrypted: optional(boolean()),\n});\n\nexport type GetStateParameters = InferMatching<\n  typeof GetStateParametersStruct,\n  GetStateParams\n>;\n\n/**\n * The `snap_getState` method implementation.\n *\n * @param request - The JSON-RPC request object.\n * @param response - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.hasPermission - Check whether a given origin has a given\n * permission.\n * @param hooks.getSnapState - Get the state of the requesting Snap.\n * @param hooks.getUnlockPromise - Wait for the extension to be unlocked.\n * @returns Nothing.\n */\nasync function getStateImplementation(\n  request: JsonRpcRequest<GetStateParameters>,\n  // `GetStateResult` is an alias for `Json` (which is the default type argument\n  // for `PendingJsonRpcResponse`), but that may not be the case in the future.\n  // We use `GetStateResult` here to make it clear that this is the expected\n  // type of the result.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n  response: PendingJsonRpcResponse<GetStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, getSnapState, getUnlockPromise }: GetStateHooks,\n): Promise<void> {\n  const { params } = request;\n\n  if (!hasPermission(manageStateBuilder.targetName)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const { key, encrypted = true } = validatedParams;\n\n    if (encrypted) {\n      await getUnlockPromise(true);\n    }\n\n    const state = await getSnapState(encrypted);\n    response.result = get(state, key);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters of the `snap_getState` method.\n *\n * @param params - The parameters to validate.\n * @returns The validated parameters.\n */\nfunction getValidatedParams(params?: unknown) {\n  try {\n    return create(params, GetStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n\n/**\n * Get the value of a key in an object. The key may contain Lodash-style path\n * syntax, e.g., `a.b.c` (with the exception of array syntax). If the key does\n * not exist, `null` is returned.\n *\n * This is a simplified version of Lodash's `get` function, but Lodash doesn't\n * seem to be maintained anymore, so we're using our own implementation.\n *\n * @param value - The object to get the key from.\n * @param key - The key to get.\n * @returns The value of the key in the object, or `null` if the key does not\n * exist.\n */\nexport function get(\n  value: Record<string, Json> | null,\n  key?: string | undefined,\n): Json {\n  if (key === undefined) {\n    return value;\n  }\n\n  const keys = key.split('.');\n  let result: Json = value;\n\n  // Intentionally using a classic for loop here for performance reasons.\n  // eslint-disable-next-line @typescript-eslint/prefer-for-of\n  for (let i = 0; i < keys.length; i++) {\n    const currentKey = keys[i];\n    if (FORBIDDEN_KEYS.includes(currentKey)) {\n      throw rpcErrors.invalidParams(\n        'Invalid params: Key contains forbidden characters.',\n      );\n    }\n\n    if (isObject(result)) {\n      if (!hasProperty(result, currentKey)) {\n        return null;\n      }\n\n      result = result[currentKey];\n      continue;\n    }\n\n    return null;\n  }\n\n  return result;\n}\n"]}
+{"version":3,"file":"getState.mjs","sourceRoot":"","sources":["../../src/permitted/getState.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAGjE,OAAO,EACL,OAAO,EACP,MAAM,EACN,MAAM,EACN,QAAQ,EACR,WAAW,EACZ,8BAA8B;AAE/B,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,wBAAwB;AAExD,OAAO,EAAE,kBAAkB,EAAE,sCAAkC;AAM/D,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,qBAAiB;AAE1D,MAAM,SAAS,GAA2C;IACxD,gBAAgB,EAAE,IAAI;CACvB,CAAC;AAeF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,cAAc,EAAE,sBAAsB;IACtC,SAAS;IACT,WAAW,EAAE;QACX,oCAAoC;QACpC,6BAA6B;KAC9B;CAOF,CAAC;AAEF,MAAM,wBAAwB,GAAG,MAAM,CAAC;IACtC,GAAG,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC7B,SAAS,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,sBAAsB,CACnC,OAAqD;AACrD,8EAA8E;AAC9E,6EAA6E;AAC7E,0EAA0E;AAC1E,sBAAsB;AACtB,4EAA4E;AAC5E,QAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EAAE,gBAAgB,EAAuB,EACzC,SAAmD;IAEnD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAEnC,IACE,CAAC,SAAS,CAAC,IAAI,CACb,oCAAoC,EACpC,MAAM,EACN,kBAAkB,CAAC,UAAU,CAC9B,EACD,CAAC;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC;QAElD,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,IAAI,CAChC,6BAA6B,EAC7B,MAAM,EACN,SAAS,CACV,CAAC;QACF,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAgB;IAC1C,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QAED,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,GAAG,CACjB,KAAkC,EAClC,GAAwB;IAExB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,MAAM,GAAS,KAAK,CAAC;IAEzB,uEAAuE;IACvE,4DAA4D;IAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,MAAM,SAAS,CAAC,aAAa,CAC3B,oDAAoD,CACrD,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC;gBACrC,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport type { PermissionControllerHasPermissionAction } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type { GetStateParams, GetStateResult } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  create,\n  object,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, Json } from '@metamask/utils';\nimport { hasProperty, isObject } from '@metamask/utils';\n\nimport { manageStateBuilder } from '../restricted/manageState';\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapControllerGetSnapStateAction,\n} from '../types';\nimport type { MethodHooksObject } from '../utils';\nimport { FORBIDDEN_KEYS, StateKeyStruct } from '../utils';\n\nconst hookNames: MethodHooksObject<GetStateMethodHooks> = {\n  getUnlockPromise: true,\n};\n\nexport type GetStateMethodHooks = {\n  /**\n   * Wait for the extension to be unlocked.\n   *\n   * @returns A promise that resolves once the extension is unlocked.\n   */\n  getUnlockPromise: (shouldShowUnlockRequest: boolean) => Promise<void>;\n};\n\nexport type GetStateMethodActions =\n  | PermissionControllerHasPermissionAction\n  | SnapControllerGetSnapStateAction;\n\n/**\n * Get the state of the Snap, or a specific value within the state. By default,\n * the data is automatically encrypted using a Snap-specific key and\n * automatically decrypted when retrieved. You can set `encrypted` to `false` to\n * use unencrypted storage (available when the client is locked).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"snap_manageState\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const state = await snap.request({\n *   method: 'snap_getState',\n *   params: {\n *     key: 'some.nested.value', // Optional, defaults to entire state\n *     encrypted: true, // Optional, defaults to `true`\n *   },\n * });\n * ```\n */\nexport const getStateHandler = {\n  implementation: getStateImplementation,\n  hookNames,\n  actionNames: [\n    'PermissionController:hasPermission',\n    'SnapController:getSnapState',\n  ],\n} satisfies MethodHandler<\n  GetStateMethodHooks,\n  GetStateMethodActions,\n  GetStateParameters,\n  GetStateResult,\n  { origin: string }\n>;\n\nconst GetStateParametersStruct = object({\n  key: optional(StateKeyStruct),\n  encrypted: optional(boolean()),\n});\n\nexport type GetStateParameters = InferMatching<\n  typeof GetStateParametersStruct,\n  GetStateParams\n>;\n\n/**\n * The `snap_getState` method implementation.\n *\n * @param request - The JSON-RPC request object.\n * @param response - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getUnlockPromise - Wait for the extension to be unlocked.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nasync function getStateImplementation(\n  request: JsonRpcRequestWithOrigin<GetStateParameters>,\n  // `GetStateResult` is an alias for `Json` (which is the default type argument\n  // for `PendingJsonRpcResponse`), but that may not be the case in the future.\n  // We use `GetStateResult` here to make it clear that this is the expected\n  // type of the result.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n  response: PendingJsonRpcResponse<GetStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getUnlockPromise }: GetStateMethodHooks,\n  messenger: Messenger<string, GetStateMethodActions>,\n): Promise<void> {\n  const { params, origin } = request;\n\n  if (\n    !messenger.call(\n      'PermissionController:hasPermission',\n      origin,\n      manageStateBuilder.targetName,\n    )\n  ) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const { key, encrypted = true } = validatedParams;\n\n    if (encrypted) {\n      await getUnlockPromise(true);\n    }\n\n    const state = await messenger.call(\n      'SnapController:getSnapState',\n      origin,\n      encrypted,\n    );\n    response.result = get(state, key);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters of the `snap_getState` method.\n *\n * @param params - The parameters to validate.\n * @returns The validated parameters.\n */\nfunction getValidatedParams(params?: unknown) {\n  try {\n    return create(params, GetStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n\n/**\n * Get the value of a key in an object. The key may contain Lodash-style path\n * syntax, e.g., `a.b.c` (with the exception of array syntax). If the key does\n * not exist, `null` is returned.\n *\n * This is a simplified version of Lodash's `get` function, but Lodash doesn't\n * seem to be maintained anymore, so we're using our own implementation.\n *\n * @param value - The object to get the key from.\n * @param key - The key to get.\n * @returns The value of the key in the object, or `null` if the key does not\n * exist.\n */\nexport function get(\n  value: Record<string, Json> | null,\n  key?: string | undefined,\n): Json {\n  if (key === undefined) {\n    return value;\n  }\n\n  const keys = key.split('.');\n  let result: Json = value;\n\n  // Intentionally using a classic for loop here for performance reasons.\n  // eslint-disable-next-line @typescript-eslint/prefer-for-of\n  for (let i = 0; i < keys.length; i++) {\n    const currentKey = keys[i];\n    if (FORBIDDEN_KEYS.includes(currentKey)) {\n      throw rpcErrors.invalidParams(\n        'Invalid params: Key contains forbidden characters.',\n      );\n    }\n\n    if (isObject(result)) {\n      if (!hasProperty(result, currentKey)) {\n        return null;\n      }\n\n      result = result[currentKey];\n      continue;\n    }\n\n    return null;\n  }\n\n  return result;\n}\n"]}

package/dist/permitted/getWebSockets.cjs

@@ -3,11 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getWebSocketsHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const endowments_1 = require("../endowments/index.cjs");
-const methodName = 'snap_getWebSockets';
-const hookNames = {
-    hasPermission: true,
-    getWebSockets: true,
-};
 /**
  * Get the connected WebSockets for the Snap.
  *
@@ -38,28 +33,30 @@ const hookNames = {
  * ```
  */
 exports.getWebSocketsHandler = {
-    methodNames: [methodName],
     implementation: getWebSocketsImplementation,
-    hookNames,
+    actionNames: [
+        'PermissionController:hasPermission',
+        'WebSocketService:getAll',
+    ],
 };
 /**
  * The `snap_getWebSockets` method implementation.
  *
- * @param _req - The JSON-RPC request object. Not used by this function.
+ * @param req - The JSON-RPC request object.
  * @param res - The JSON-RPC response object.
  * @param _next - The `json-rpc-engine` "next" callback. Not used by this function.
  * @param end - The `json-rpc-engine` "end" callback.
- * @param hooks - The RPC method hooks.
- * @param hooks.hasPermission - The function to check if a snap has the `endowment:network-access` permission.
- * @param hooks.getWebSockets - The function to get the connected WebSockets for the origin.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-function getWebSocketsImplementation(_req, res, _next, end, { hasPermission, getWebSockets }) {
-    if (!hasPermission(endowments_1.SnapEndowments.NetworkAccess)) {
+function getWebSocketsImplementation(req, res, _next, end, _hooks, messenger) {
+    const { origin } = req;
+    if (!messenger.call('PermissionController:hasPermission', origin, endowments_1.SnapEndowments.NetworkAccess)) {
         return end(rpc_errors_1.providerErrors.unauthorized());
     }
     try {
-        res.result = getWebSockets();
+        res.result = messenger.call('WebSocketService:getAll', origin);
     }
     catch (error) {
         return end(error);