@metamask/snaps-rpc-methods 15.1.1 → 16.0.0

package/dist/permitted/getClientStatus.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"getClientStatus.cjs","sourceRoot":"","sources":["../../src/permitted/getClientStatus.ts"],"names":[],"mappings":";;;AAGA,uDAA2D;AAS3D,MAAM,UAAU,GAAG,sBAAsB,CAAC;AAE1C,MAAM,SAAS,GAA4C;IACzD,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,sBAAsB,GAAG;IACpC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,6BAA6B;IAC7C,SAAS;CAKV,CAAC;AAmBF;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,6BAA6B,CAC1C,QAAwB,EACxB,QAAuD,EACvD,KAAc,EACd,GAA6B,EAC7B,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAwB;IAE9D,QAAQ,CAAC,MAAM,GAAG;QAChB,MAAM,EAAE,WAAW,EAAE;QACrB,MAAM,EAAE,WAAW,EAAE;QACrB,aAAa,EAAE,UAAU,EAAE;QAC3B,eAAe,EAAE,IAAA,gCAAkB,GAAE;KACtC,CAAC;IACF,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport type { GetClientStatusResult } from '@metamask/snaps-sdk';\nimport { getPlatformVersion } from '@metamask/snaps-utils';\nimport type {\n  JsonRpcParams,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_getClientStatus';\n\nconst hookNames: MethodHooksObject<GetClientStatusHooks> = {\n  getIsLocked: true,\n  getIsActive: true,\n  getVersion: true,\n};\n\n/**\n * Get the status of the client running the Snap.\n *\n * @example\n * ```ts\n * import type { OnCronjobHandler } from '@metamask/snaps-sdk'\n * import { MethodNotFoundError } from '@metamask/snaps-sdk'\n *\n * export const onCronjob: OnCronjobHandler = async ({ request }) => {\n *   switch (request.method) {\n *     case 'execute':\n *       // Find out if MetaMask is locked.\n *       const { locked } = await snap.request({\n *         method: 'snap_getClientStatus',\n *       })\n *\n *       if (!locked) {\n *         // Do something that requires MetaMask to be unlocked, such as\n *         // accessing the encrypted state.\n *       }\n *\n *     default:\n *       throw new MethodNotFoundError()\n *   }\n * }\n * ```\n */\nexport const getClientStatusHandler = {\n  methodNames: [methodName] as const,\n  implementation: getClientStatusImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetClientStatusHooks,\n  JsonRpcParams,\n  GetClientStatusResult\n>;\n\nexport type GetClientStatusHooks = {\n  /**\n   * @returns Whether the client is locked or not.\n   */\n  getIsLocked: () => boolean;\n\n  /**\n   * @returns Whether the client is active or not.\n   */\n  getIsActive: () => boolean;\n\n  /**\n   * @returns The version string for the client.\n   */\n  getVersion: () => string;\n};\n\n/**\n * The `snap_getClientStatus` method implementation.\n * Returns useful information about the client running the snap.\n *\n * @param _request - The JSON-RPC request object. Not used by this function.\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.getIsLocked - A function that returns whether the client is locked or not.\n * @param hooks.getIsActive - A function that returns whether the client is opened or not.\n * @param hooks.getVersion - A function that returns the client version.\n * @returns Nothing.\n */\nasync function getClientStatusImplementation(\n  _request: JsonRpcRequest,\n  response: PendingJsonRpcResponse<GetClientStatusResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getIsLocked, getIsActive, getVersion }: GetClientStatusHooks,\n): Promise<void> {\n  response.result = {\n    locked: getIsLocked(),\n    active: getIsActive(),\n    clientVersion: getVersion(),\n    platformVersion: getPlatformVersion(),\n  };\n  return end();\n}\n"]}
+{"version":3,"file":"getClientStatus.cjs","sourceRoot":"","sources":["../../src/permitted/getClientStatus.ts"],"names":[],"mappings":";;;AAMA,uDAA2D;AAU3D,MAAM,SAAS,GAAkD;IAC/D,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;CACjB,CAAC;AAgBF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,sBAAsB,GAAG;IACpC,cAAc,EAAE,6BAA6B;IAC7C,SAAS;IACT,WAAW,EAAE,CAAC,4BAA4B,CAAC;CAM5C,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,6BAA6B,CAC1C,QAAwB,EACxB,QAAuD,EACvD,KAAc,EACd,GAA6B,EAC7B,EAAE,WAAW,EAAE,UAAU,EAA8B,EACvD,SAA0D;IAE1D,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAEpE,QAAQ,CAAC,MAAM,GAAG;QAChB,MAAM,EAAE,CAAC,UAAU;QACnB,MAAM,EAAE,WAAW,EAAE;QACrB,aAAa,EAAE,UAAU,EAAE;QAC3B,eAAe,EAAE,IAAA,gCAAkB,GAAE;KACtC,CAAC;IACF,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 { GetClientStatusResult } from '@metamask/snaps-sdk';\nimport { getPlatformVersion } from '@metamask/snaps-utils';\nimport type {\n  JsonRpcParams,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { KeyringControllerGetStateAction } from '../types';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<GetClientStatusMethodHooks> = {\n  getIsActive: true,\n  getVersion: true,\n};\n\nexport type GetClientStatusMethodHooks = {\n  /**\n   * @returns Whether the client is active or not.\n   */\n  getIsActive: () => boolean;\n\n  /**\n   * @returns The version string for the client.\n   */\n  getVersion: () => string;\n};\n\nexport type GetClientStatusMethodActions = KeyringControllerGetStateAction;\n\n/**\n * Get the status of the client running the Snap.\n *\n * @example\n * ```ts\n * import type { OnCronjobHandler } from '@metamask/snaps-sdk'\n * import { MethodNotFoundError } from '@metamask/snaps-sdk'\n *\n * export const onCronjob: OnCronjobHandler = async ({ request }) => {\n *   switch (request.method) {\n *     case 'execute':\n *       // Find out if MetaMask is locked.\n *       const { locked } = await snap.request({\n *         method: 'snap_getClientStatus',\n *       })\n *\n *       if (!locked) {\n *         // Do something that requires MetaMask to be unlocked, such as\n *         // accessing the encrypted state.\n *       }\n *\n *     default:\n *       throw new MethodNotFoundError()\n *   }\n * }\n * ```\n */\nexport const getClientStatusHandler = {\n  implementation: getClientStatusImplementation,\n  hookNames,\n  actionNames: ['KeyringController:getState'],\n} satisfies MethodHandler<\n  GetClientStatusMethodHooks,\n  GetClientStatusMethodActions,\n  JsonRpcParams,\n  GetClientStatusResult\n>;\n\n/**\n * The `snap_getClientStatus` method implementation.\n * Returns useful information about the client running the snap.\n *\n * @param _request - The JSON-RPC request object. Not used by this function.\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.getIsActive - A function that returns whether the client is opened or not.\n * @param hooks.getVersion - A function that returns the client version.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nasync function getClientStatusImplementation(\n  _request: JsonRpcRequest,\n  response: PendingJsonRpcResponse<GetClientStatusResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getIsActive, getVersion }: GetClientStatusMethodHooks,\n  messenger: Messenger<string, GetClientStatusMethodActions>,\n): Promise<void> {\n  const { isUnlocked } = messenger.call('KeyringController:getState');\n\n  response.result = {\n    locked: !isUnlocked,\n    active: getIsActive(),\n    clientVersion: getVersion(),\n    platformVersion: getPlatformVersion(),\n  };\n  return end();\n}\n"]}

package/dist/permitted/getClientStatus.d.cts

@@ -1,7 +1,20 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
 import type { GetClientStatusResult } from "@metamask/snaps-sdk";
 import type { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+import type { KeyringControllerGetStateAction } from "../types.cjs";
 import type { MethodHooksObject } from "../utils.cjs";
+export type GetClientStatusMethodHooks = {
+    /**
+     * @returns Whether the client is active or not.
+     */
+    getIsActive: () => boolean;
+    /**
+     * @returns The version string for the client.
+     */
+    getVersion: () => string;
+};
+export type GetClientStatusMethodActions = KeyringControllerGetStateAction;
 /**
  * Get the status of the client running the Snap.
  *
@@ -30,23 +43,9 @@ import type { MethodHooksObject } from "../utils.cjs";
  * ```
  */
 export declare const getClientStatusHandler: {
-    methodNames: ["snap_getClientStatus"];
     implementation: typeof getClientStatusImplementation;
-    hookNames: MethodHooksObject<GetClientStatusHooks>;
-};
-export type GetClientStatusHooks = {
-    /**
-     * @returns Whether the client is locked or not.
-     */
-    getIsLocked: () => boolean;
-    /**
-     * @returns Whether the client is active or not.
-     */
-    getIsActive: () => boolean;
-    /**
-     * @returns The version string for the client.
-     */
-    getVersion: () => string;
+    hookNames: MethodHooksObject<GetClientStatusMethodHooks>;
+    actionNames: "KeyringController:getState"[];
 };
 /**
  * The `snap_getClientStatus` method implementation.
@@ -58,11 +57,11 @@ export type GetClientStatusHooks = {
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.getIsLocked - A function that returns whether the client is locked or not.
  * @param hooks.getIsActive - A function that returns whether the client is opened or not.
  * @param hooks.getVersion - A function that returns the client version.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function getClientStatusImplementation(_request: JsonRpcRequest, response: PendingJsonRpcResponse<GetClientStatusResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getIsLocked, getIsActive, getVersion }: GetClientStatusHooks): Promise<void>;
+declare function getClientStatusImplementation(_request: JsonRpcRequest, response: PendingJsonRpcResponse<GetClientStatusResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getIsActive, getVersion }: GetClientStatusMethodHooks, messenger: Messenger<string, GetClientStatusMethodActions>): Promise<void>;
 export {};
 //# sourceMappingURL=getClientStatus.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getClientStatus.d.cts","sourceRoot":"","sources":["../../src/permitted/getClientStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAE1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,4BAA4B;AAEjE,OAAO,KAAK,EAEV,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAEzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAUlD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;CAQlC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,6BAA6B,CAC1C,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EACvD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,oBAAoB,GAC7D,OAAO,CAAC,IAAI,CAAC,CAQf"}
+{"version":3,"file":"getClientStatus.d.cts","sourceRoot":"","sources":["../../src/permitted/getClientStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,qBAAqB,EAAE,4BAA4B;AAEjE,OAAO,KAAK,EAEV,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAEzB,OAAO,KAAK,EAAE,+BAA+B,EAAE,qBAAiB;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAOlD,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,+BAA+B,CAAC;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;CASlC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,6BAA6B,CAC1C,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EACvD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,0BAA0B,EACvD,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,4BAA4B,CAAC,GACzD,OAAO,CAAC,IAAI,CAAC,CAUf"}

package/dist/permitted/getClientStatus.d.mts

@@ -1,7 +1,20 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
 import type { GetClientStatusResult } from "@metamask/snaps-sdk";
 import type { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+import type { KeyringControllerGetStateAction } from "../types.mjs";
 import type { MethodHooksObject } from "../utils.mjs";
+export type GetClientStatusMethodHooks = {
+    /**
+     * @returns Whether the client is active or not.
+     */
+    getIsActive: () => boolean;
+    /**
+     * @returns The version string for the client.
+     */
+    getVersion: () => string;
+};
+export type GetClientStatusMethodActions = KeyringControllerGetStateAction;
 /**
  * Get the status of the client running the Snap.
  *
@@ -30,23 +43,9 @@ import type { MethodHooksObject } from "../utils.mjs";
  * ```
  */
 export declare const getClientStatusHandler: {
-    methodNames: ["snap_getClientStatus"];
     implementation: typeof getClientStatusImplementation;
-    hookNames: MethodHooksObject<GetClientStatusHooks>;
-};
-export type GetClientStatusHooks = {
-    /**
-     * @returns Whether the client is locked or not.
-     */
-    getIsLocked: () => boolean;
-    /**
-     * @returns Whether the client is active or not.
-     */
-    getIsActive: () => boolean;
-    /**
-     * @returns The version string for the client.
-     */
-    getVersion: () => string;
+    hookNames: MethodHooksObject<GetClientStatusMethodHooks>;
+    actionNames: "KeyringController:getState"[];
 };
 /**
  * The `snap_getClientStatus` method implementation.
@@ -58,11 +57,11 @@ export type GetClientStatusHooks = {
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.getIsLocked - A function that returns whether the client is locked or not.
  * @param hooks.getIsActive - A function that returns whether the client is opened or not.
  * @param hooks.getVersion - A function that returns the client version.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function getClientStatusImplementation(_request: JsonRpcRequest, response: PendingJsonRpcResponse<GetClientStatusResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getIsLocked, getIsActive, getVersion }: GetClientStatusHooks): Promise<void>;
+declare function getClientStatusImplementation(_request: JsonRpcRequest, response: PendingJsonRpcResponse<GetClientStatusResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getIsActive, getVersion }: GetClientStatusMethodHooks, messenger: Messenger<string, GetClientStatusMethodActions>): Promise<void>;
 export {};
 //# sourceMappingURL=getClientStatus.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getClientStatus.d.mts","sourceRoot":"","sources":["../../src/permitted/getClientStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAE1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,4BAA4B;AAEjE,OAAO,KAAK,EAEV,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAEzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAUlD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;CAQlC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,6BAA6B,CAC1C,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EACvD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,oBAAoB,GAC7D,OAAO,CAAC,IAAI,CAAC,CAQf"}
+{"version":3,"file":"getClientStatus.d.mts","sourceRoot":"","sources":["../../src/permitted/getClientStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,qBAAqB,EAAE,4BAA4B;AAEjE,OAAO,KAAK,EAEV,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAEzB,OAAO,KAAK,EAAE,+BAA+B,EAAE,qBAAiB;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAOlD,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,+BAA+B,CAAC;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;CASlC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,6BAA6B,CAC1C,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EACvD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,0BAA0B,EACvD,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,4BAA4B,CAAC,GACzD,OAAO,CAAC,IAAI,CAAC,CAUf"}

package/dist/permitted/getClientStatus.mjs

@@ -1,7 +1,5 @@
 import { getPlatformVersion } from "@metamask/snaps-utils";
-const methodName = 'snap_getClientStatus';
 const hookNames = {
-    getIsLocked: true,
     getIsActive: true,
     getVersion: true,
 };
@@ -33,9 +31,9 @@ const hookNames = {
  * ```
  */
 export const getClientStatusHandler = {
-    methodNames: [methodName],
     implementation: getClientStatusImplementation,
     hookNames,
+    actionNames: ['KeyringController:getState'],
 };
 /**
  * The `snap_getClientStatus` method implementation.
@@ -47,14 +45,15 @@ export const getClientStatusHandler = {
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.getIsLocked - A function that returns whether the client is locked or not.
  * @param hooks.getIsActive - A function that returns whether the client is opened or not.
  * @param hooks.getVersion - A function that returns the client version.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-async function getClientStatusImplementation(_request, response, _next, end, { getIsLocked, getIsActive, getVersion }) {
+async function getClientStatusImplementation(_request, response, _next, end, { getIsActive, getVersion }, messenger) {
+    const { isUnlocked } = messenger.call('KeyringController:getState');
     response.result = {
-        locked: getIsLocked(),
+        locked: !isUnlocked,
         active: getIsActive(),
         clientVersion: getVersion(),
         platformVersion: getPlatformVersion(),

package/dist/permitted/getClientStatus.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getClientStatus.mjs","sourceRoot":"","sources":["../../src/permitted/getClientStatus.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,8BAA8B;AAS3D,MAAM,UAAU,GAAG,sBAAsB,CAAC;AAE1C,MAAM,SAAS,GAA4C;IACzD,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,6BAA6B;IAC7C,SAAS;CAKV,CAAC;AAmBF;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,6BAA6B,CAC1C,QAAwB,EACxB,QAAuD,EACvD,KAAc,EACd,GAA6B,EAC7B,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAwB;IAE9D,QAAQ,CAAC,MAAM,GAAG;QAChB,MAAM,EAAE,WAAW,EAAE;QACrB,MAAM,EAAE,WAAW,EAAE;QACrB,aAAa,EAAE,UAAU,EAAE;QAC3B,eAAe,EAAE,kBAAkB,EAAE;KACtC,CAAC;IACF,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport type { GetClientStatusResult } from '@metamask/snaps-sdk';\nimport { getPlatformVersion } from '@metamask/snaps-utils';\nimport type {\n  JsonRpcParams,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_getClientStatus';\n\nconst hookNames: MethodHooksObject<GetClientStatusHooks> = {\n  getIsLocked: true,\n  getIsActive: true,\n  getVersion: true,\n};\n\n/**\n * Get the status of the client running the Snap.\n *\n * @example\n * ```ts\n * import type { OnCronjobHandler } from '@metamask/snaps-sdk'\n * import { MethodNotFoundError } from '@metamask/snaps-sdk'\n *\n * export const onCronjob: OnCronjobHandler = async ({ request }) => {\n *   switch (request.method) {\n *     case 'execute':\n *       // Find out if MetaMask is locked.\n *       const { locked } = await snap.request({\n *         method: 'snap_getClientStatus',\n *       })\n *\n *       if (!locked) {\n *         // Do something that requires MetaMask to be unlocked, such as\n *         // accessing the encrypted state.\n *       }\n *\n *     default:\n *       throw new MethodNotFoundError()\n *   }\n * }\n * ```\n */\nexport const getClientStatusHandler = {\n  methodNames: [methodName] as const,\n  implementation: getClientStatusImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetClientStatusHooks,\n  JsonRpcParams,\n  GetClientStatusResult\n>;\n\nexport type GetClientStatusHooks = {\n  /**\n   * @returns Whether the client is locked or not.\n   */\n  getIsLocked: () => boolean;\n\n  /**\n   * @returns Whether the client is active or not.\n   */\n  getIsActive: () => boolean;\n\n  /**\n   * @returns The version string for the client.\n   */\n  getVersion: () => string;\n};\n\n/**\n * The `snap_getClientStatus` method implementation.\n * Returns useful information about the client running the snap.\n *\n * @param _request - The JSON-RPC request object. Not used by this function.\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.getIsLocked - A function that returns whether the client is locked or not.\n * @param hooks.getIsActive - A function that returns whether the client is opened or not.\n * @param hooks.getVersion - A function that returns the client version.\n * @returns Nothing.\n */\nasync function getClientStatusImplementation(\n  _request: JsonRpcRequest,\n  response: PendingJsonRpcResponse<GetClientStatusResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getIsLocked, getIsActive, getVersion }: GetClientStatusHooks,\n): Promise<void> {\n  response.result = {\n    locked: getIsLocked(),\n    active: getIsActive(),\n    clientVersion: getVersion(),\n    platformVersion: getPlatformVersion(),\n  };\n  return end();\n}\n"]}
+{"version":3,"file":"getClientStatus.mjs","sourceRoot":"","sources":["../../src/permitted/getClientStatus.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,kBAAkB,EAAE,8BAA8B;AAU3D,MAAM,SAAS,GAAkD;IAC/D,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;CACjB,CAAC;AAgBF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,cAAc,EAAE,6BAA6B;IAC7C,SAAS;IACT,WAAW,EAAE,CAAC,4BAA4B,CAAC;CAM5C,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,6BAA6B,CAC1C,QAAwB,EACxB,QAAuD,EACvD,KAAc,EACd,GAA6B,EAC7B,EAAE,WAAW,EAAE,UAAU,EAA8B,EACvD,SAA0D;IAE1D,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAEpE,QAAQ,CAAC,MAAM,GAAG;QAChB,MAAM,EAAE,CAAC,UAAU;QACnB,MAAM,EAAE,WAAW,EAAE;QACrB,aAAa,EAAE,UAAU,EAAE;QAC3B,eAAe,EAAE,kBAAkB,EAAE;KACtC,CAAC;IACF,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 { GetClientStatusResult } from '@metamask/snaps-sdk';\nimport { getPlatformVersion } from '@metamask/snaps-utils';\nimport type {\n  JsonRpcParams,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { KeyringControllerGetStateAction } from '../types';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<GetClientStatusMethodHooks> = {\n  getIsActive: true,\n  getVersion: true,\n};\n\nexport type GetClientStatusMethodHooks = {\n  /**\n   * @returns Whether the client is active or not.\n   */\n  getIsActive: () => boolean;\n\n  /**\n   * @returns The version string for the client.\n   */\n  getVersion: () => string;\n};\n\nexport type GetClientStatusMethodActions = KeyringControllerGetStateAction;\n\n/**\n * Get the status of the client running the Snap.\n *\n * @example\n * ```ts\n * import type { OnCronjobHandler } from '@metamask/snaps-sdk'\n * import { MethodNotFoundError } from '@metamask/snaps-sdk'\n *\n * export const onCronjob: OnCronjobHandler = async ({ request }) => {\n *   switch (request.method) {\n *     case 'execute':\n *       // Find out if MetaMask is locked.\n *       const { locked } = await snap.request({\n *         method: 'snap_getClientStatus',\n *       })\n *\n *       if (!locked) {\n *         // Do something that requires MetaMask to be unlocked, such as\n *         // accessing the encrypted state.\n *       }\n *\n *     default:\n *       throw new MethodNotFoundError()\n *   }\n * }\n * ```\n */\nexport const getClientStatusHandler = {\n  implementation: getClientStatusImplementation,\n  hookNames,\n  actionNames: ['KeyringController:getState'],\n} satisfies MethodHandler<\n  GetClientStatusMethodHooks,\n  GetClientStatusMethodActions,\n  JsonRpcParams,\n  GetClientStatusResult\n>;\n\n/**\n * The `snap_getClientStatus` method implementation.\n * Returns useful information about the client running the snap.\n *\n * @param _request - The JSON-RPC request object. Not used by this function.\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.getIsActive - A function that returns whether the client is opened or not.\n * @param hooks.getVersion - A function that returns the client version.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nasync function getClientStatusImplementation(\n  _request: JsonRpcRequest,\n  response: PendingJsonRpcResponse<GetClientStatusResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getIsActive, getVersion }: GetClientStatusMethodHooks,\n  messenger: Messenger<string, GetClientStatusMethodActions>,\n): Promise<void> {\n  const { isUnlocked } = messenger.call('KeyringController:getState');\n\n  response.result = {\n    locked: !isUnlocked,\n    active: getIsActive(),\n    clientVersion: getVersion(),\n    platformVersion: getPlatformVersion(),\n  };\n  return end();\n}\n"]}

package/dist/permitted/getFile.cjs

@@ -13,10 +13,6 @@ exports.GetFileArgsStruct = (0, superstruct_1.object)({
         (0, snaps_sdk_1.enumValue)(snaps_sdk_1.AuxiliaryFileEncoding.Utf8),
     ])),
 });
-const methodName = 'snap_getFile';
-const hookNames = {
-    getSnapFile: true,
-};
 /**
  * Gets a static file's content in UTF-8, Base64, or hexadecimal.
  *
@@ -44,9 +40,8 @@ const hookNames = {
  * ```
  */
 exports.getFileHandler = {
-    methodNames: [methodName],
     implementation,
-    hookNames,
+    actionNames: ['SnapController:getSnapFile'],
 };
 /**
  * The `snap_getFile` method implementation.
@@ -56,15 +51,16 @@ exports.getFileHandler = {
  * @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.getSnapFile - The function to load a static snap file.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-async function implementation(req, res, _next, end, { getSnapFile }) {
-    const { params } = req;
+async function implementation(req, res, _next, end, _hooks, messenger) {
+    const { params, origin } = req;
     (0, utils_1.assertStruct)(params, exports.GetFileArgsStruct, 'Invalid "snap_getFile" parameters', rpc_errors_1.rpcErrors.invalidParams);
     try {
-        res.result = await getSnapFile(params.path, params.encoding ?? snaps_sdk_1.AuxiliaryFileEncoding.Base64);
+        res.result = await messenger.call('SnapController:getSnapFile', origin, params.path, params.encoding ??
+            snaps_sdk_1.AuxiliaryFileEncoding.Base64);
     }
     catch (error) {
         return end(error);

package/dist/permitted/getFile.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"getFile.cjs","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAEjD,mDAAuE;AAEvE,uDAAwE;AAExE,2CAA+C;AAIlC,QAAA,iBAAiB,GAAG,IAAA,oBAAM,EAAC;IACtC,IAAI,EAAE,IAAA,oBAAM,GAAE;IACd,QAAQ,EAAE,IAAA,sBAAQ,EAChB,IAAA,mBAAK,EAAC;QACJ,IAAA,qBAAS,EAAC,iCAAqB,CAAC,MAAM,CAAC;QACvC,IAAA,qBAAS,EAAC,iCAAqB,CAAC,GAAG,CAAC;QACpC,IAAA,qBAAS,EAAC,iCAAqB,CAAC,IAAI,CAAC;KACtC,CAAC,CACH;CACF,CAAC,CAAC;AAOH,MAAM,UAAU,GAAG,cAAc,CAAC;AAElC,MAAM,SAAS,GAAoC;IACjD,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACU,QAAA,cAAc,GAAG;IAC5B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc;IACd,SAAS;CACoE,CAAC;AAShF;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,cAAc,CAC3B,GAA0C,EAC1C,GAA0C,EAC1C,KAAc,EACd,GAA6B,EAC7B,EAAE,WAAW,EAAgB;IAE7B,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAA,oBAAY,EACV,MAAM,EACN,yBAAiB,EACjB,mCAAmC,EACnC,sBAAS,CAAC,aAAa,CACxB,CAAC;IAEF,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,MAAM,WAAW,CAC5B,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,QAAQ,IAAI,iCAAqB,CAAC,MAAM,CAChD,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { GetFileParams, GetFileResult } from '@metamask/snaps-sdk';\nimport { AuxiliaryFileEncoding, enumValue } from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { object, optional, string, union } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, JsonRpcRequest } from '@metamask/utils';\nimport { assertStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nexport const GetFileArgsStruct = object({\n  path: string(),\n  encoding: optional(\n    union([\n      enumValue(AuxiliaryFileEncoding.Base64),\n      enumValue(AuxiliaryFileEncoding.Hex),\n      enumValue(AuxiliaryFileEncoding.Utf8),\n    ]),\n  ),\n});\n\nexport type InferredGetFileParams = InferMatching<\n  typeof GetFileArgsStruct,\n  GetFileParams\n>;\n\nconst methodName = 'snap_getFile';\n\nconst hookNames: MethodHooksObject<GetFileHooks> = {\n  getSnapFile: true,\n};\n\n/**\n * Gets a static file's content in UTF-8, Base64, or hexadecimal.\n *\n * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"source\": {\n *     \"files\": [\"./files/my-file.bin\"]\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const contents = await snap.request({\n *   method: 'snap_getFile',\n *   params: {\n *     path: './files/myfile.bin',\n *     encoding: 'hex',\n *   },\n * })\n *\n * // '0x...'\n * console.log(contents)\n * ```\n */\nexport const getFileHandler = {\n  methodNames: [methodName] as const,\n  implementation,\n  hookNames,\n} satisfies PermittedHandlerExport<GetFileHooks, InferredGetFileParams, string>;\n\nexport type GetFileHooks = {\n  getSnapFile: (\n    path: InferredGetFileParams['path'],\n    encoding: InferredGetFileParams['encoding'],\n  ) => Promise<string>;\n};\n\n/**\n * The `snap_getFile` method implementation.\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.\n * @param hooks.getSnapFile - The function to load a static snap file.\n * @returns Nothing.\n */\nasync function implementation(\n  req: JsonRpcRequest<InferredGetFileParams>,\n  res: PendingJsonRpcResponse<GetFileResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getSnapFile }: GetFileHooks,\n): Promise<void> {\n  const { params } = req;\n\n  assertStruct(\n    params,\n    GetFileArgsStruct,\n    'Invalid \"snap_getFile\" parameters',\n    rpcErrors.invalidParams,\n  );\n\n  try {\n    res.result = await getSnapFile(\n      params.path,\n      params.encoding ?? AuxiliaryFileEncoding.Base64,\n    );\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}
+{"version":3,"file":"getFile.cjs","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":";;;AAKA,qDAAiD;AAEjD,mDAAuE;AAEvE,uDAAwE;AAExE,2CAA+C;AAOlC,QAAA,iBAAiB,GAAG,IAAA,oBAAM,EAAC;IACtC,IAAI,EAAE,IAAA,oBAAM,GAAE;IACd,QAAQ,EAAE,IAAA,sBAAQ,EAChB,IAAA,mBAAK,EAAC;QACJ,IAAA,qBAAS,EAAC,iCAAqB,CAAC,MAAM,CAAC;QACvC,IAAA,qBAAS,EAAC,iCAAqB,CAAC,GAAG,CAAC;QACpC,IAAA,qBAAS,EAAC,iCAAqB,CAAC,IAAI,CAAC;KACtC,CAAC,CACH;CACF,CAAC,CAAC;AASH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACU,QAAA,cAAc,GAAG;IAC5B,cAAc;IACd,WAAW,EAAE,CAAC,4BAA4B,CAAC;CAO5C,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,cAAc,CAC3B,GAAoD,EACpD,GAA0C,EAC1C,KAAc,EACd,GAA6B,EAC7B,MAAa,EACb,SAAkD;IAElD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAE/B,IAAA,oBAAY,EACV,MAAM,EACN,yBAAiB,EACjB,mCAAmC,EACnC,sBAAS,CAAC,aAAa,CACxB,CAAC;IAEF,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAC/B,4BAA4B,EAC5B,MAAM,EACN,MAAM,CAAC,IAAI,EACV,MAAM,CAAC,QAAkC;YACxC,iCAAqB,CAAC,MAAM,CAC/B,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,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 { rpcErrors } from '@metamask/rpc-errors';\nimport type { GetFileParams, GetFileResult } from '@metamask/snaps-sdk';\nimport { AuxiliaryFileEncoding, enumValue } from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { object, optional, string, union } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\nimport { assertStruct } from '@metamask/utils';\n\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapControllerGetSnapFileAction,\n} from '../types';\n\nexport const GetFileArgsStruct = object({\n  path: string(),\n  encoding: optional(\n    union([\n      enumValue(AuxiliaryFileEncoding.Base64),\n      enumValue(AuxiliaryFileEncoding.Hex),\n      enumValue(AuxiliaryFileEncoding.Utf8),\n    ]),\n  ),\n});\n\nexport type InferredGetFileParams = InferMatching<\n  typeof GetFileArgsStruct,\n  GetFileParams\n>;\n\nexport type GetFileMethodActions = SnapControllerGetSnapFileAction;\n\n/**\n * Gets a static file's content in UTF-8, Base64, or hexadecimal.\n *\n * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"source\": {\n *     \"files\": [\"./files/my-file.bin\"]\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const contents = await snap.request({\n *   method: 'snap_getFile',\n *   params: {\n *     path: './files/myfile.bin',\n *     encoding: 'hex',\n *   },\n * })\n *\n * // '0x...'\n * console.log(contents)\n * ```\n */\nexport const getFileHandler = {\n  implementation,\n  actionNames: ['SnapController:getSnapFile'],\n} satisfies MethodHandler<\n  never,\n  GetFileMethodActions,\n  InferredGetFileParams,\n  GetFileResult,\n  { origin: string }\n>;\n\n/**\n * The `snap_getFile` method implementation.\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 implementation(\n  req: JsonRpcRequestWithOrigin<InferredGetFileParams>,\n  res: PendingJsonRpcResponse<GetFileResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  _hooks: never,\n  messenger: Messenger<string, GetFileMethodActions>,\n): Promise<void> {\n  const { params, origin } = req;\n\n  assertStruct(\n    params,\n    GetFileArgsStruct,\n    'Invalid \"snap_getFile\" parameters',\n    rpcErrors.invalidParams,\n  );\n\n  try {\n    res.result = await messenger.call(\n      'SnapController:getSnapFile',\n      origin,\n      params.path,\n      (params.encoding as AuxiliaryFileEncoding) ??\n        AuxiliaryFileEncoding.Base64,\n    );\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}

package/dist/permitted/getFile.d.cts

@@ -1,8 +1,9 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
 import type { GetFileParams, GetFileResult } from "@metamask/snaps-sdk";
 import type { InferMatching } from "@metamask/snaps-utils";
-import type { PendingJsonRpcResponse, JsonRpcRequest } from "@metamask/utils";
-import type { MethodHooksObject } from "../utils.cjs";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { JsonRpcRequestWithOrigin, SnapControllerGetSnapFileAction } from "../types.cjs";
 export declare const GetFileArgsStruct: import("@metamask/superstruct").Struct<{
     path: string;
     encoding?: "base64" | "hex" | "utf8" | undefined;
@@ -11,6 +12,7 @@ export declare const GetFileArgsStruct: import("@metamask/superstruct").Struct<{
     encoding: import("@metamask/superstruct").Struct<"base64" | "hex" | "utf8" | undefined, null>;
 }>;
 export type InferredGetFileParams = InferMatching<typeof GetFileArgsStruct, GetFileParams>;
+export type GetFileMethodActions = SnapControllerGetSnapFileAction;
 /**
  * Gets a static file's content in UTF-8, Base64, or hexadecimal.
  *
@@ -38,12 +40,8 @@ export type InferredGetFileParams = InferMatching<typeof GetFileArgsStruct, GetF
  * ```
  */
 export declare const getFileHandler: {
-    methodNames: ["snap_getFile"];
     implementation: typeof implementation;
-    hookNames: MethodHooksObject<GetFileHooks>;
-};
-export type GetFileHooks = {
-    getSnapFile: (path: InferredGetFileParams['path'], encoding: InferredGetFileParams['encoding']) => Promise<string>;
+    actionNames: "SnapController:getSnapFile"[];
 };
 /**
  * The `snap_getFile` method implementation.
@@ -53,10 +51,10 @@ export type GetFileHooks = {
  * @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.getSnapFile - The function to load a static snap file.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function implementation(req: JsonRpcRequest<InferredGetFileParams>, res: PendingJsonRpcResponse<GetFileResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getSnapFile }: GetFileHooks): Promise<void>;
+declare function implementation(req: JsonRpcRequestWithOrigin<InferredGetFileParams>, res: PendingJsonRpcResponse<GetFileResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, GetFileMethodActions>): Promise<void>;
 export {};
 //# sourceMappingURL=getFile.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getFile.d.cts","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,4BAA4B;AAExE,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,wBAAwB;AAG9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,eAAO,MAAM,iBAAiB;;;;;;EAS5B,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,OAAO,iBAAiB,EACxB,aAAa,CACd,CAAC;AAQF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,cAAc;;;;CAIoD,CAAC;AAEhF,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,CACX,IAAI,EAAE,qBAAqB,CAAC,MAAM,CAAC,EACnC,QAAQ,EAAE,qBAAqB,CAAC,UAAU,CAAC,KACxC,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAe,cAAc,CAC3B,GAAG,EAAE,cAAc,CAAC,qBAAqB,CAAC,EAC1C,GAAG,EAAE,sBAAsB,CAAC,aAAa,CAAC,EAC1C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,WAAW,EAAE,EAAE,YAAY,GAC5B,OAAO,CAAC,IAAI,CAAC,CAoBf"}
+{"version":3,"file":"getFile.d.cts","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,4BAA4B;AAExE,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAG9D,OAAO,KAAK,EACV,wBAAwB,EACxB,+BAA+B,EAChC,qBAAiB;AAElB,eAAO,MAAM,iBAAiB;;;;;;EAS5B,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,OAAO,iBAAiB,EACxB,aAAa,CACd,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,+BAA+B,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,cAAc;;;CAS1B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAe,cAAc,CAC3B,GAAG,EAAE,wBAAwB,CAAC,qBAAqB,CAAC,EACpD,GAAG,EAAE,sBAAsB,CAAC,aAAa,CAAC,EAC1C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,oBAAoB,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC,CAuBf"}

package/dist/permitted/getFile.d.mts

@@ -1,8 +1,9 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
 import type { GetFileParams, GetFileResult } from "@metamask/snaps-sdk";
 import type { InferMatching } from "@metamask/snaps-utils";
-import type { PendingJsonRpcResponse, JsonRpcRequest } from "@metamask/utils";
-import type { MethodHooksObject } from "../utils.mjs";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { JsonRpcRequestWithOrigin, SnapControllerGetSnapFileAction } from "../types.mjs";
 export declare const GetFileArgsStruct: import("@metamask/superstruct").Struct<{
     path: string;
     encoding?: "base64" | "hex" | "utf8" | undefined;
@@ -11,6 +12,7 @@ export declare const GetFileArgsStruct: import("@metamask/superstruct").Struct<{
     encoding: import("@metamask/superstruct").Struct<"base64" | "hex" | "utf8" | undefined, null>;
 }>;
 export type InferredGetFileParams = InferMatching<typeof GetFileArgsStruct, GetFileParams>;
+export type GetFileMethodActions = SnapControllerGetSnapFileAction;
 /**
  * Gets a static file's content in UTF-8, Base64, or hexadecimal.
  *
@@ -38,12 +40,8 @@ export type InferredGetFileParams = InferMatching<typeof GetFileArgsStruct, GetF
  * ```
  */
 export declare const getFileHandler: {
-    methodNames: ["snap_getFile"];
     implementation: typeof implementation;
-    hookNames: MethodHooksObject<GetFileHooks>;
-};
-export type GetFileHooks = {
-    getSnapFile: (path: InferredGetFileParams['path'], encoding: InferredGetFileParams['encoding']) => Promise<string>;
+    actionNames: "SnapController:getSnapFile"[];
 };
 /**
  * The `snap_getFile` method implementation.
@@ -53,10 +51,10 @@ export type GetFileHooks = {
  * @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.getSnapFile - The function to load a static snap file.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function implementation(req: JsonRpcRequest<InferredGetFileParams>, res: PendingJsonRpcResponse<GetFileResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getSnapFile }: GetFileHooks): Promise<void>;
+declare function implementation(req: JsonRpcRequestWithOrigin<InferredGetFileParams>, res: PendingJsonRpcResponse<GetFileResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, GetFileMethodActions>): Promise<void>;
 export {};
 //# sourceMappingURL=getFile.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getFile.d.mts","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,4BAA4B;AAExE,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,wBAAwB;AAG9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,eAAO,MAAM,iBAAiB;;;;;;EAS5B,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,OAAO,iBAAiB,EACxB,aAAa,CACd,CAAC;AAQF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,cAAc;;;;CAIoD,CAAC;AAEhF,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,CACX,IAAI,EAAE,qBAAqB,CAAC,MAAM,CAAC,EACnC,QAAQ,EAAE,qBAAqB,CAAC,UAAU,CAAC,KACxC,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAe,cAAc,CAC3B,GAAG,EAAE,cAAc,CAAC,qBAAqB,CAAC,EAC1C,GAAG,EAAE,sBAAsB,CAAC,aAAa,CAAC,EAC1C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,WAAW,EAAE,EAAE,YAAY,GAC5B,OAAO,CAAC,IAAI,CAAC,CAoBf"}
+{"version":3,"file":"getFile.d.mts","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,4BAA4B;AAExE,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAG9D,OAAO,KAAK,EACV,wBAAwB,EACxB,+BAA+B,EAChC,qBAAiB;AAElB,eAAO,MAAM,iBAAiB;;;;;;EAS5B,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,OAAO,iBAAiB,EACxB,aAAa,CACd,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,+BAA+B,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,cAAc;;;CAS1B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAe,cAAc,CAC3B,GAAG,EAAE,wBAAwB,CAAC,qBAAqB,CAAC,EACpD,GAAG,EAAE,sBAAsB,CAAC,aAAa,CAAC,EAC1C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,oBAAoB,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC,CAuBf"}

package/dist/permitted/getFile.mjs

@@ -10,10 +10,6 @@ export const GetFileArgsStruct = object({
         enumValue(AuxiliaryFileEncoding.Utf8),
     ])),
 });
-const methodName = 'snap_getFile';
-const hookNames = {
-    getSnapFile: true,
-};
 /**
  * Gets a static file's content in UTF-8, Base64, or hexadecimal.
  *
@@ -41,9 +37,8 @@ const hookNames = {
  * ```
  */
 export const getFileHandler = {
-    methodNames: [methodName],
     implementation,
-    hookNames,
+    actionNames: ['SnapController:getSnapFile'],
 };
 /**
  * The `snap_getFile` method implementation.
@@ -53,15 +48,16 @@ export const getFileHandler = {
  * @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.getSnapFile - The function to load a static snap file.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-async function implementation(req, res, _next, end, { getSnapFile }) {
-    const { params } = req;
+async function implementation(req, res, _next, end, _hooks, messenger) {
+    const { params, origin } = req;
     assertStruct(params, GetFileArgsStruct, 'Invalid "snap_getFile" parameters', rpcErrors.invalidParams);
     try {
-        res.result = await getSnapFile(params.path, params.encoding ?? AuxiliaryFileEncoding.Base64);
+        res.result = await messenger.call('SnapController:getSnapFile', origin, params.path, params.encoding ??
+            AuxiliaryFileEncoding.Base64);
     }
     catch (error) {
         return end(error);

package/dist/permitted/getFile.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getFile.mjs","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAEjD,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,4BAA4B;AAEvE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,8BAA8B;AAExE,OAAO,EAAE,YAAY,EAAE,wBAAwB;AAI/C,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;IACtC,IAAI,EAAE,MAAM,EAAE;IACd,QAAQ,EAAE,QAAQ,CAChB,KAAK,CAAC;QACJ,SAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC;QACvC,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC;QACpC,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC;KACtC,CAAC,CACH;CACF,CAAC,CAAC;AAOH,MAAM,UAAU,GAAG,cAAc,CAAC;AAElC,MAAM,SAAS,GAAoC;IACjD,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc;IACd,SAAS;CACoE,CAAC;AAShF;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,cAAc,CAC3B,GAA0C,EAC1C,GAA0C,EAC1C,KAAc,EACd,GAA6B,EAC7B,EAAE,WAAW,EAAgB;IAE7B,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,YAAY,CACV,MAAM,EACN,iBAAiB,EACjB,mCAAmC,EACnC,SAAS,CAAC,aAAa,CACxB,CAAC;IAEF,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,MAAM,WAAW,CAC5B,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,QAAQ,IAAI,qBAAqB,CAAC,MAAM,CAChD,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { GetFileParams, GetFileResult } from '@metamask/snaps-sdk';\nimport { AuxiliaryFileEncoding, enumValue } from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { object, optional, string, union } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, JsonRpcRequest } from '@metamask/utils';\nimport { assertStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nexport const GetFileArgsStruct = object({\n  path: string(),\n  encoding: optional(\n    union([\n      enumValue(AuxiliaryFileEncoding.Base64),\n      enumValue(AuxiliaryFileEncoding.Hex),\n      enumValue(AuxiliaryFileEncoding.Utf8),\n    ]),\n  ),\n});\n\nexport type InferredGetFileParams = InferMatching<\n  typeof GetFileArgsStruct,\n  GetFileParams\n>;\n\nconst methodName = 'snap_getFile';\n\nconst hookNames: MethodHooksObject<GetFileHooks> = {\n  getSnapFile: true,\n};\n\n/**\n * Gets a static file's content in UTF-8, Base64, or hexadecimal.\n *\n * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"source\": {\n *     \"files\": [\"./files/my-file.bin\"]\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const contents = await snap.request({\n *   method: 'snap_getFile',\n *   params: {\n *     path: './files/myfile.bin',\n *     encoding: 'hex',\n *   },\n * })\n *\n * // '0x...'\n * console.log(contents)\n * ```\n */\nexport const getFileHandler = {\n  methodNames: [methodName] as const,\n  implementation,\n  hookNames,\n} satisfies PermittedHandlerExport<GetFileHooks, InferredGetFileParams, string>;\n\nexport type GetFileHooks = {\n  getSnapFile: (\n    path: InferredGetFileParams['path'],\n    encoding: InferredGetFileParams['encoding'],\n  ) => Promise<string>;\n};\n\n/**\n * The `snap_getFile` method implementation.\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.\n * @param hooks.getSnapFile - The function to load a static snap file.\n * @returns Nothing.\n */\nasync function implementation(\n  req: JsonRpcRequest<InferredGetFileParams>,\n  res: PendingJsonRpcResponse<GetFileResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getSnapFile }: GetFileHooks,\n): Promise<void> {\n  const { params } = req;\n\n  assertStruct(\n    params,\n    GetFileArgsStruct,\n    'Invalid \"snap_getFile\" parameters',\n    rpcErrors.invalidParams,\n  );\n\n  try {\n    res.result = await getSnapFile(\n      params.path,\n      params.encoding ?? AuxiliaryFileEncoding.Base64,\n    );\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}
+{"version":3,"file":"getFile.mjs","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAEjD,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,4BAA4B;AAEvE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,8BAA8B;AAExE,OAAO,EAAE,YAAY,EAAE,wBAAwB;AAO/C,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;IACtC,IAAI,EAAE,MAAM,EAAE;IACd,QAAQ,EAAE,QAAQ,CAChB,KAAK,CAAC;QACJ,SAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC;QACvC,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC;QACpC,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC;KACtC,CAAC,CACH;CACF,CAAC,CAAC;AASH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,cAAc;IACd,WAAW,EAAE,CAAC,4BAA4B,CAAC;CAO5C,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,cAAc,CAC3B,GAAoD,EACpD,GAA0C,EAC1C,KAAc,EACd,GAA6B,EAC7B,MAAa,EACb,SAAkD;IAElD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAE/B,YAAY,CACV,MAAM,EACN,iBAAiB,EACjB,mCAAmC,EACnC,SAAS,CAAC,aAAa,CACxB,CAAC;IAEF,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAC/B,4BAA4B,EAC5B,MAAM,EACN,MAAM,CAAC,IAAI,EACV,MAAM,CAAC,QAAkC;YACxC,qBAAqB,CAAC,MAAM,CAC/B,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,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 { rpcErrors } from '@metamask/rpc-errors';\nimport type { GetFileParams, GetFileResult } from '@metamask/snaps-sdk';\nimport { AuxiliaryFileEncoding, enumValue } from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { object, optional, string, union } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\nimport { assertStruct } from '@metamask/utils';\n\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapControllerGetSnapFileAction,\n} from '../types';\n\nexport const GetFileArgsStruct = object({\n  path: string(),\n  encoding: optional(\n    union([\n      enumValue(AuxiliaryFileEncoding.Base64),\n      enumValue(AuxiliaryFileEncoding.Hex),\n      enumValue(AuxiliaryFileEncoding.Utf8),\n    ]),\n  ),\n});\n\nexport type InferredGetFileParams = InferMatching<\n  typeof GetFileArgsStruct,\n  GetFileParams\n>;\n\nexport type GetFileMethodActions = SnapControllerGetSnapFileAction;\n\n/**\n * Gets a static file's content in UTF-8, Base64, or hexadecimal.\n *\n * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"source\": {\n *     \"files\": [\"./files/my-file.bin\"]\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const contents = await snap.request({\n *   method: 'snap_getFile',\n *   params: {\n *     path: './files/myfile.bin',\n *     encoding: 'hex',\n *   },\n * })\n *\n * // '0x...'\n * console.log(contents)\n * ```\n */\nexport const getFileHandler = {\n  implementation,\n  actionNames: ['SnapController:getSnapFile'],\n} satisfies MethodHandler<\n  never,\n  GetFileMethodActions,\n  InferredGetFileParams,\n  GetFileResult,\n  { origin: string }\n>;\n\n/**\n * The `snap_getFile` method implementation.\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 implementation(\n  req: JsonRpcRequestWithOrigin<InferredGetFileParams>,\n  res: PendingJsonRpcResponse<GetFileResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  _hooks: never,\n  messenger: Messenger<string, GetFileMethodActions>,\n): Promise<void> {\n  const { params, origin } = req;\n\n  assertStruct(\n    params,\n    GetFileArgsStruct,\n    'Invalid \"snap_getFile\" parameters',\n    rpcErrors.invalidParams,\n  );\n\n  try {\n    res.result = await messenger.call(\n      'SnapController:getSnapFile',\n      origin,\n      params.path,\n      (params.encoding as AuxiliaryFileEncoding) ??\n        AuxiliaryFileEncoding.Base64,\n    );\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}

package/dist/permitted/getInterfaceContext.cjs

@@ -4,11 +4,6 @@ exports.getInterfaceContextHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const superstruct_1 = require("@metamask/superstruct");
 const utils_1 = require("../utils.cjs");
-const methodName = 'snap_getInterfaceContext';
-const hookNames = {
-    hasPermission: true,
-    getInterfaceContext: true,
-};
 /**
  * Get the context of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)
  * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
@@ -46,9 +41,11 @@ const hookNames = {
  * ```
  */
 exports.getInterfaceContextHandler = {
-    methodNames: [methodName],
     implementation: getInterfaceContextImplementation,
-    hookNames,
+    actionNames: [
+        'PermissionController:hasPermission',
+        'SnapInterfaceController:getInterface',
+    ],
 };
 const GetInterfaceContextParametersStruct = (0, superstruct_1.object)({
     id: (0, superstruct_1.string)(),
@@ -61,23 +58,23 @@ const GetInterfaceContextParametersStruct = (0, superstruct_1.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 the Snap has a given
- * permission.
- * @param hooks.getInterfaceContext - The function to get the interface context.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-function getInterfaceContextImplementation(req, res, _next, end, { hasPermission, getInterfaceContext }) {
-    if (!utils_1.UI_PERMISSIONS.some(hasPermission)) {
+function getInterfaceContextImplementation(req, res, _next, end, _hooks, messenger) {
+    const { params, origin } = req;
+    const isPermitted = utils_1.UI_PERMISSIONS.some((permission) => messenger.call('PermissionController:hasPermission', origin, permission));
+    if (!isPermitted) {
         return end(rpc_errors_1.providerErrors.unauthorized({
             message: `This method can only be used if the Snap has one of the following permissions: ${utils_1.UI_PERMISSIONS.join(', ')}.`,
         }));
     }
-    const { params } = req;
     try {
         const validatedParams = getValidatedParams(params);
         const { id } = validatedParams;
-        res.result = getInterfaceContext(id);
+        const { context } = messenger.call('SnapInterfaceController:getInterface', origin, id);
+        res.result = context;
     }
     catch (error) {
         return end(error);

package/dist/permitted/getInterfaceContext.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"getInterfaceContext.cjs","sourceRoot":"","sources":["../../src/permitted/getInterfaceContext.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAQjE,uDAA4E;AAI5E,wCAA0C;AAE1C,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAE9C,MAAM,SAAS,GAAsD;IACnE,aAAa,EAAE,IAAI;IACnB,mBAAmB,EAAE,IAAI;CAC1B,CAAC;AAgBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACU,QAAA,0BAA0B,GAAG;IACxC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,iCAAiC;IACjD,SAAS;CAKV,CAAC;AAEF,MAAM,mCAAmC,GAAG,IAAA,oBAAM,EAAC;IACjD,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;;GAaG;AACH,SAAS,iCAAiC,CACxC,GAAkD,EAClD,GAAsD,EACtD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,mBAAmB,EAAkC;IAEtE,IAAI,CAAC,sBAAc,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;QACxC,OAAO,GAAG,CACR,2BAAc,CAAC,YAAY,CAAC;YAC1B,OAAO,EAAE,kFAAkF,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,GAAG,CAAC,MAAM,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,mCAAmC,CAAC,CAAC;IAC7D,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;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,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 {\n  GetInterfaceContextParams,\n  GetInterfaceContextResult,\n  InterfaceContext,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, string } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { UI_PERMISSIONS } from '../utils';\n\nconst methodName = 'snap_getInterfaceContext';\n\nconst hookNames: MethodHooksObject<GetInterfaceContextMethodHooks> = {\n  hasPermission: true,\n  getInterfaceContext: true,\n};\n\nexport type GetInterfaceContextMethodHooks = {\n  /**\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the Snap has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n\n  /**\n   * @param id - The interface ID.\n   * @returns The interface context.\n   */\n  getInterfaceContext: (id: string) => InterfaceContext | null;\n};\n\n/**\n * Get the context of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)\n * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n *\n * @example\n * ```ts\n * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';\n *\n * const interfaceId = await snap.request({\n *   method: 'snap_createInterface',\n *   params: {\n *     ui: (\n *       <Box>\n *         <Heading>Hello, world!</Heading>\n *         <Text>Welcome to my Snap homepage!</Text>\n *       </Box>\n *     ),\n *     context: {\n *       key: 'value'\n *     }\n *   },\n * })\n *\n * const context = await snap.request({\n *   method: 'snap_getInterfaceContext',\n *   params: {\n *     id: interfaceId,\n *   },\n * })\n *\n * console.log(context)\n * // {\n * //   key: 'value'\n * // }\n * ```\n */\nexport const getInterfaceContextHandler = {\n  methodNames: [methodName] as const,\n  implementation: getInterfaceContextImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetInterfaceContextMethodHooks,\n  GetInterfaceContextParameters,\n  GetInterfaceContextResult\n>;\n\nconst GetInterfaceContextParametersStruct = object({\n  id: string(),\n});\n\nexport type GetInterfaceContextParameters = InferMatching<\n  typeof GetInterfaceContextParametersStruct,\n  GetInterfaceContextParams\n>;\n\n/**\n * The `snap_getInterfaceContext` method implementation.\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.\n * @param hooks.hasPermission - The function to check if the Snap has a given\n * permission.\n * @param hooks.getInterfaceContext - The function to get the interface context.\n * @returns Nothing.\n */\nfunction getInterfaceContextImplementation(\n  req: JsonRpcRequest<GetInterfaceContextParameters>,\n  res: PendingJsonRpcResponse<GetInterfaceContextResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, getInterfaceContext }: GetInterfaceContextMethodHooks,\n): void {\n  if (!UI_PERMISSIONS.some(hasPermission)) {\n    return end(\n      providerErrors.unauthorized({\n        message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,\n      }),\n    );\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    res.result = getInterfaceContext(id);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the getInterfaceContext method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated getInterfaceContext method parameter object.\n */\nfunction getValidatedParams(params: unknown): GetInterfaceContextParameters {\n  try {\n    return create(params, GetInterfaceContextParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"getInterfaceContext.cjs","sourceRoot":"","sources":["../../src/permitted/getInterfaceContext.ts"],"names":[],"mappings":";;;AAMA,qDAAiE;AAMjE,uDAA4E;AAO5E,wCAA0C;AAM1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACU,QAAA,0BAA0B,GAAG;IACxC,cAAc,EAAE,iCAAiC;IACjD,WAAW,EAAE;QACX,oCAAoC;QACpC,sCAAsC;KACvC;CAOF,CAAC;AAEF,MAAM,mCAAmC,GAAG,IAAA,oBAAM,EAAC;IACjD,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,SAAS,iCAAiC,CACxC,GAA4D,EAC5D,GAAsD,EACtD,KAAc,EACd,GAA6B,EAC7B,MAAa,EACb,SAA8D;IAE9D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAE/B,MAAM,WAAW,GAAG,sBAAc,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CACrD,SAAS,CAAC,IAAI,CAAC,oCAAoC,EAAE,MAAM,EAAE,UAAU,CAAC,CACzE,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,GAAG,CACR,2BAAc,CAAC,YAAY,CAAC;YAC1B,OAAO,EAAE,kFAAkF,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,MAAM,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC,IAAI,CAChC,sCAAsC,EACtC,MAAM,EACN,EAAE,CACH,CAAC;QAEF,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,mCAAmC,CAAC,CAAC;IAC7D,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;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,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 {\n  GetInterfaceContextParams,\n  GetInterfaceContextResult,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, string } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapInterfaceControllerGetInterfaceAction,\n} from '../types';\nimport { UI_PERMISSIONS } from '../utils';\n\nexport type GetInterfaceContextMethodActions =\n  | PermissionControllerHasPermissionAction\n  | SnapInterfaceControllerGetInterfaceAction;\n\n/**\n * Get the context of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)\n * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n *\n * @example\n * ```ts\n * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';\n *\n * const interfaceId = await snap.request({\n *   method: 'snap_createInterface',\n *   params: {\n *     ui: (\n *       <Box>\n *         <Heading>Hello, world!</Heading>\n *         <Text>Welcome to my Snap homepage!</Text>\n *       </Box>\n *     ),\n *     context: {\n *       key: 'value'\n *     }\n *   },\n * })\n *\n * const context = await snap.request({\n *   method: 'snap_getInterfaceContext',\n *   params: {\n *     id: interfaceId,\n *   },\n * })\n *\n * console.log(context)\n * // {\n * //   key: 'value'\n * // }\n * ```\n */\nexport const getInterfaceContextHandler = {\n  implementation: getInterfaceContextImplementation,\n  actionNames: [\n    'PermissionController:hasPermission',\n    'SnapInterfaceController:getInterface',\n  ],\n} satisfies MethodHandler<\n  never,\n  GetInterfaceContextMethodActions,\n  GetInterfaceContextParameters,\n  GetInterfaceContextResult,\n  { origin: string }\n>;\n\nconst GetInterfaceContextParametersStruct = object({\n  id: string(),\n});\n\nexport type GetInterfaceContextParameters = InferMatching<\n  typeof GetInterfaceContextParametersStruct,\n  GetInterfaceContextParams\n>;\n\n/**\n * The `snap_getInterfaceContext` method implementation.\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 */\nfunction getInterfaceContextImplementation(\n  req: JsonRpcRequestWithOrigin<GetInterfaceContextParameters>,\n  res: PendingJsonRpcResponse<GetInterfaceContextResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  _hooks: never,\n  messenger: Messenger<string, GetInterfaceContextMethodActions>,\n): void {\n  const { params, origin } = req;\n\n  const isPermitted = UI_PERMISSIONS.some((permission) =>\n    messenger.call('PermissionController:hasPermission', origin, permission),\n  );\n\n  if (!isPermitted) {\n    return end(\n      providerErrors.unauthorized({\n        message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,\n      }),\n    );\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    const { context } = messenger.call(\n      'SnapInterfaceController:getInterface',\n      origin,\n      id,\n    );\n\n    res.result = context;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the getInterfaceContext method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated getInterfaceContext method parameter object.\n */\nfunction getValidatedParams(params: unknown): GetInterfaceContextParameters {\n  try {\n    return create(params, GetInterfaceContextParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}