@metamask/snaps-rpc-methods 14.3.0 → 15.0.0

package/dist/permitted/getBackgroundEvents.mjs

@@ -5,6 +5,30 @@ const hookNames = {
     getBackgroundEvents: true,
     hasPermission: true,
 };
+/**
+ * Get the scheduled background events for the Snap.
+ *
+ * @example
+ * ```ts
+ * const events = await snap.request({
+ *   method: 'snap_getBackgroundEvents',
+ * });
+ * console.log(events);
+ * // [
+ * //   {
+ * //     id: 'event-1',
+ * //     scheduledAt: 1672531200000,
+ * //     snapId: 'npm:example-snap',
+ * //     date: 1672531200000,
+ * //     request: {
+ * //       method: 'example_method',
+ * //       params: { example: 'data' },
+ * //     },
+ * //   },
+ * //   ...,
+ * // ]
+ * ```
+ */
 export const getBackgroundEventsHandler = {
     methodNames: [methodName],
     implementation: getGetBackgroundEventsImplementation,

package/dist/permitted/getBackgroundEvents.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getBackgroundEvents.mjs","sourceRoot":"","sources":["../../src/permitted/getBackgroundEvents.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,6BAA6B;AAStD,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAE9C,MAAM,SAAS,GAAsD;IACnE,mBAAmB,EAAE,IAAI;IACzB,aAAa,EAAE,IAAI;CACpB,CAAC;AAOF,MAAM,CAAC,MAAM,0BAA0B,GAInC;IACF,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,cAAc,EAAE,oCAAoC;IACpD,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,oCAAoC,CACjD,IAA+C,EAC/C,GAAsD,EACtD,KAAc,EACd,GAA6B,EAC7B,EAAE,mBAAmB,EAAE,aAAa,EAAkC;IAEtE,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3C,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,mBAAmB,EAAE,CAAC;QACrC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,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 { providerErrors } from '@metamask/rpc-errors';\nimport type {\n  BackgroundEvent,\n  GetBackgroundEventsParams,\n  GetBackgroundEventsResult,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { type PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_getBackgroundEvents';\n\nconst hookNames: MethodHooksObject<GetBackgroundEventsMethodHooks> = {\n  getBackgroundEvents: true,\n  hasPermission: true,\n};\n\nexport type GetBackgroundEventsMethodHooks = {\n  getBackgroundEvents: () => BackgroundEvent[];\n  hasPermission: (permissionName: string) => boolean;\n};\n\nexport const getBackgroundEventsHandler: PermittedHandlerExport<\n  GetBackgroundEventsMethodHooks,\n  GetBackgroundEventsParams,\n  GetBackgroundEventsResult\n> = {\n  methodNames: [methodName],\n  implementation: getGetBackgroundEventsImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_getBackgroundEvents` method implementation.\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.\n * Not used by this function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getBackgroundEvents - The function to get the background events.\n * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.\n * @returns An array of background events.\n */\nasync function getGetBackgroundEventsImplementation(\n  _req: JsonRpcRequest<GetBackgroundEventsParams>,\n  res: PendingJsonRpcResponse<GetBackgroundEventsResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getBackgroundEvents, hasPermission }: GetBackgroundEventsMethodHooks,\n): Promise<void> {\n  if (!hasPermission(SnapEndowments.Cronjob)) {\n    return end(providerErrors.unauthorized());\n  }\n  try {\n    const events = getBackgroundEvents();\n    res.result = events;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}
+{"version":3,"file":"getBackgroundEvents.mjs","sourceRoot":"","sources":["../../src/permitted/getBackgroundEvents.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,6BAA6B;AAStD,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAE9C,MAAM,SAAS,GAAsD;IACnE,mBAAmB,EAAE,IAAI;IACzB,aAAa,EAAE,IAAI;CACpB,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,oCAAoC;IACpD,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,oCAAoC,CACjD,IAA+C,EAC/C,GAAsD,EACtD,KAAc,EACd,GAA6B,EAC7B,EAAE,mBAAmB,EAAE,aAAa,EAAkC;IAEtE,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3C,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,mBAAmB,EAAE,CAAC;QACrC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,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 { providerErrors } from '@metamask/rpc-errors';\nimport type {\n  BackgroundEvent,\n  GetBackgroundEventsParams,\n  GetBackgroundEventsResult,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { type PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_getBackgroundEvents';\n\nconst hookNames: MethodHooksObject<GetBackgroundEventsMethodHooks> = {\n  getBackgroundEvents: true,\n  hasPermission: true,\n};\n\nexport type GetBackgroundEventsMethodHooks = {\n  getBackgroundEvents: () => BackgroundEvent[];\n  hasPermission: (permissionName: string) => boolean;\n};\n\n/**\n * Get the scheduled background events for the Snap.\n *\n * @example\n * ```ts\n * const events = await snap.request({\n *   method: 'snap_getBackgroundEvents',\n * });\n * console.log(events);\n * // [\n * //   {\n * //     id: 'event-1',\n * //     scheduledAt: 1672531200000,\n * //     snapId: 'npm:example-snap',\n * //     date: 1672531200000,\n * //     request: {\n * //       method: 'example_method',\n * //       params: { example: 'data' },\n * //     },\n * //   },\n * //   ...,\n * // ]\n * ```\n */\nexport const getBackgroundEventsHandler = {\n  methodNames: [methodName] as const,\n  implementation: getGetBackgroundEventsImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetBackgroundEventsMethodHooks,\n  GetBackgroundEventsParams,\n  GetBackgroundEventsResult\n>;\n\n/**\n * The `snap_getBackgroundEvents` method implementation.\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.\n * Not used by this function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getBackgroundEvents - The function to get the background events.\n * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.\n * @returns An array of background events.\n */\nasync function getGetBackgroundEventsImplementation(\n  _req: JsonRpcRequest<GetBackgroundEventsParams>,\n  res: PendingJsonRpcResponse<GetBackgroundEventsResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getBackgroundEvents, hasPermission }: GetBackgroundEventsMethodHooks,\n): Promise<void> {\n  if (!hasPermission(SnapEndowments.Cronjob)) {\n    return end(providerErrors.unauthorized());\n  }\n  try {\n    const events = getBackgroundEvents();\n    res.result = events;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}

package/dist/permitted/getClientStatus.cjs

@@ -2,16 +2,41 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getClientStatusHandler = void 0;
 const snaps_utils_1 = require("@metamask/snaps-utils");
+const methodName = 'snap_getClientStatus';
 const hookNames = {
     getIsLocked: true,
     getIsActive: true,
     getVersion: true,
 };
 /**
- * `snap_getClientStatus` returns useful information about the client running the snap.
+ * Get the status of the client running the Snap.
+ *
+ * @example
+ * ```ts
+ * import type { OnCronjobHandler } from '@metamask/snaps-sdk'
+ * import { MethodNotFoundError } from '@metamask/snaps-sdk'
+ *
+ * export const onCronjob: OnCronjobHandler = async ({ request }) => {
+ *   switch (request.method) {
+ *     case 'execute':
+ *       // Find out if MetaMask is locked.
+ *       const { locked } = await snap.request({
+ *         method: 'snap_getClientStatus',
+ *       })
+ *
+ *       if (!locked) {
+ *         // Do something that requires MetaMask to be unlocked, such as
+ *         // accessing the encrypted state.
+ *       }
+ *
+ *     default:
+ *       throw new MethodNotFoundError()
+ *   }
+ * }
+ * ```
  */
 exports.getClientStatusHandler = {
-    methodNames: ['snap_getClientStatus'],
+    methodNames: [methodName],
     implementation: getClientStatusImplementation,
     hookNames,
 };

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,SAAS,GAA4C;IACzD,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;CACjB,CAAC;AAEF;;GAEG;AACU,QAAA,sBAAsB,GAI/B;IACF,WAAW,EAAE,CAAC,sBAAsB,CAAC;IACrC,cAAc,EAAE,6BAA6B;IAC7C,SAAS;CACV,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 hookNames: MethodHooksObject<GetClientStatusHooks> = {\n  getIsLocked: true,\n  getIsActive: true,\n  getVersion: true,\n};\n\n/**\n * `snap_getClientStatus` returns useful information about the client running the snap.\n */\nexport const getClientStatusHandler: PermittedHandlerExport<\n  GetClientStatusHooks,\n  JsonRpcParams,\n  GetClientStatusResult\n> = {\n  methodNames: ['snap_getClientStatus'],\n  implementation: getClientStatusImplementation,\n  hookNames,\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":";;;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"]}

package/dist/permitted/getClientStatus.d.cts

@@ -1,10 +1,39 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
 import type { GetClientStatusResult } from "@metamask/snaps-sdk";
-import type { JsonRpcParams } from "@metamask/utils";
+import type { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.cjs";
 /**
- * `snap_getClientStatus` returns useful information about the client running the snap.
+ * Get the status of the client running the Snap.
+ *
+ * @example
+ * ```ts
+ * import type { OnCronjobHandler } from '@metamask/snaps-sdk'
+ * import { MethodNotFoundError } from '@metamask/snaps-sdk'
+ *
+ * export const onCronjob: OnCronjobHandler = async ({ request }) => {
+ *   switch (request.method) {
+ *     case 'execute':
+ *       // Find out if MetaMask is locked.
+ *       const { locked } = await snap.request({
+ *         method: 'snap_getClientStatus',
+ *       })
+ *
+ *       if (!locked) {
+ *         // Do something that requires MetaMask to be unlocked, such as
+ *         // accessing the encrypted state.
+ *       }
+ *
+ *     default:
+ *       throw new MethodNotFoundError()
+ *   }
+ * }
+ * ```
  */
-export declare const getClientStatusHandler: PermittedHandlerExport<GetClientStatusHooks, JsonRpcParams, GetClientStatusResult>;
+export declare const getClientStatusHandler: {
+    methodNames: ["snap_getClientStatus"];
+    implementation: typeof getClientStatusImplementation;
+    hookNames: MethodHooksObject<GetClientStatusHooks>;
+};
 export type GetClientStatusHooks = {
     /**
      * @returns Whether the client is locked or not.
@@ -19,4 +48,21 @@ export type GetClientStatusHooks = {
      */
     getVersion: () => string;
 };
+/**
+ * The `snap_getClientStatus` method implementation.
+ * Returns useful information about the client running the snap.
+ *
+ * @param _request - The JSON-RPC request object. Not used by this function.
+ * @param response - 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.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.
+ * @returns Nothing.
+ */
+declare function getClientStatusImplementation(_request: JsonRpcRequest, response: PendingJsonRpcResponse<GetClientStatusResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getIsLocked, getIsActive, getVersion }: GetClientStatusHooks): 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":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAC9E,OAAO,KAAK,EAAE,qBAAqB,EAAE,4BAA4B;AAEjE,OAAO,KAAK,EACV,aAAa,EAGd,wBAAwB;AAUzB;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,oBAAoB,EACpB,aAAa,EACb,qBAAqB,CAKtB,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"}
+{"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"}

package/dist/permitted/getClientStatus.d.mts

@@ -1,10 +1,39 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
 import type { GetClientStatusResult } from "@metamask/snaps-sdk";
-import type { JsonRpcParams } from "@metamask/utils";
+import type { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
 /**
- * `snap_getClientStatus` returns useful information about the client running the snap.
+ * Get the status of the client running the Snap.
+ *
+ * @example
+ * ```ts
+ * import type { OnCronjobHandler } from '@metamask/snaps-sdk'
+ * import { MethodNotFoundError } from '@metamask/snaps-sdk'
+ *
+ * export const onCronjob: OnCronjobHandler = async ({ request }) => {
+ *   switch (request.method) {
+ *     case 'execute':
+ *       // Find out if MetaMask is locked.
+ *       const { locked } = await snap.request({
+ *         method: 'snap_getClientStatus',
+ *       })
+ *
+ *       if (!locked) {
+ *         // Do something that requires MetaMask to be unlocked, such as
+ *         // accessing the encrypted state.
+ *       }
+ *
+ *     default:
+ *       throw new MethodNotFoundError()
+ *   }
+ * }
+ * ```
  */
-export declare const getClientStatusHandler: PermittedHandlerExport<GetClientStatusHooks, JsonRpcParams, GetClientStatusResult>;
+export declare const getClientStatusHandler: {
+    methodNames: ["snap_getClientStatus"];
+    implementation: typeof getClientStatusImplementation;
+    hookNames: MethodHooksObject<GetClientStatusHooks>;
+};
 export type GetClientStatusHooks = {
     /**
      * @returns Whether the client is locked or not.
@@ -19,4 +48,21 @@ export type GetClientStatusHooks = {
      */
     getVersion: () => string;
 };
+/**
+ * The `snap_getClientStatus` method implementation.
+ * Returns useful information about the client running the snap.
+ *
+ * @param _request - The JSON-RPC request object. Not used by this function.
+ * @param response - 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.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.
+ * @returns Nothing.
+ */
+declare function getClientStatusImplementation(_request: JsonRpcRequest, response: PendingJsonRpcResponse<GetClientStatusResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getIsLocked, getIsActive, getVersion }: GetClientStatusHooks): 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":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAC9E,OAAO,KAAK,EAAE,qBAAqB,EAAE,4BAA4B;AAEjE,OAAO,KAAK,EACV,aAAa,EAGd,wBAAwB;AAUzB;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,oBAAoB,EACpB,aAAa,EACb,qBAAqB,CAKtB,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"}
+{"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"}

package/dist/permitted/getClientStatus.mjs

@@ -1,14 +1,39 @@
 import { getPlatformVersion } from "@metamask/snaps-utils";
+const methodName = 'snap_getClientStatus';
 const hookNames = {
     getIsLocked: true,
     getIsActive: true,
     getVersion: true,
 };
 /**
- * `snap_getClientStatus` returns useful information about the client running the snap.
+ * Get the status of the client running the Snap.
+ *
+ * @example
+ * ```ts
+ * import type { OnCronjobHandler } from '@metamask/snaps-sdk'
+ * import { MethodNotFoundError } from '@metamask/snaps-sdk'
+ *
+ * export const onCronjob: OnCronjobHandler = async ({ request }) => {
+ *   switch (request.method) {
+ *     case 'execute':
+ *       // Find out if MetaMask is locked.
+ *       const { locked } = await snap.request({
+ *         method: 'snap_getClientStatus',
+ *       })
+ *
+ *       if (!locked) {
+ *         // Do something that requires MetaMask to be unlocked, such as
+ *         // accessing the encrypted state.
+ *       }
+ *
+ *     default:
+ *       throw new MethodNotFoundError()
+ *   }
+ * }
+ * ```
  */
 export const getClientStatusHandler = {
-    methodNames: ['snap_getClientStatus'],
+    methodNames: [methodName],
     implementation: getClientStatusImplementation,
     hookNames,
 };

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,SAAS,GAA4C;IACzD,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAI/B;IACF,WAAW,EAAE,CAAC,sBAAsB,CAAC;IACrC,cAAc,EAAE,6BAA6B;IAC7C,SAAS;CACV,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 hookNames: MethodHooksObject<GetClientStatusHooks> = {\n  getIsLocked: true,\n  getIsActive: true,\n  getVersion: true,\n};\n\n/**\n * `snap_getClientStatus` returns useful information about the client running the snap.\n */\nexport const getClientStatusHandler: PermittedHandlerExport<\n  GetClientStatusHooks,\n  JsonRpcParams,\n  GetClientStatusResult\n> = {\n  methodNames: ['snap_getClientStatus'],\n  implementation: getClientStatusImplementation,\n  hookNames,\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":"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"]}

package/dist/permitted/getFile.cjs

@@ -13,11 +13,38 @@ 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.
+ *
+ * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "source": {
+ *     "files": ["./files/my-file.bin"]
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * const contents = await snap.request({
+ *   method: 'snap_getFile',
+ *   params: {
+ *     path: './files/myfile.bin',
+ *     encoding: 'hex',
+ *   },
+ * })
+ *
+ * // '0x...'
+ * console.log(contents)
+ * ```
+ */
 exports.getFileHandler = {
-    methodNames: ['snap_getFile'],
+    methodNames: [methodName],
     implementation,
     hookNames,
 };

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,SAAS,GAAoC;IACjD,WAAW,EAAE,IAAI;CAClB,CAAC;AAEW,QAAA,cAAc,GAIvB;IACF,WAAW,EAAE,CAAC,cAAc,CAAC;IAC7B,cAAc;IACd,SAAS;CACV,CAAC;AASF;;;;;;;;;;;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 hookNames: MethodHooksObject<GetFileHooks> = {\n  getSnapFile: true,\n};\n\nexport const getFileHandler: PermittedHandlerExport<\n  GetFileHooks,\n  InferredGetFileParams,\n  string\n> = {\n  methodNames: ['snap_getFile'],\n  implementation,\n  hookNames,\n};\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":";;;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"]}

package/dist/permitted/getFile.d.cts

@@ -1,6 +1,8 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { GetFileParams } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+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";
 export declare const GetFileArgsStruct: import("@metamask/superstruct").Struct<{
     path: string;
     encoding?: "base64" | "hex" | "utf8" | undefined;
@@ -9,8 +11,52 @@ 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 declare const getFileHandler: PermittedHandlerExport<GetFileHooks, InferredGetFileParams, string>;
+/**
+ * Gets a static file's content in UTF-8, Base64, or hexadecimal.
+ *
+ * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "source": {
+ *     "files": ["./files/my-file.bin"]
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * const contents = await snap.request({
+ *   method: 'snap_getFile',
+ *   params: {
+ *     path: './files/myfile.bin',
+ *     encoding: 'hex',
+ *   },
+ * })
+ *
+ * // '0x...'
+ * console.log(contents)
+ * ```
+ */
+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>;
 };
+/**
+ * The `snap_getFile` method implementation.
+ *
+ * @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.getSnapFile - The function to load a static snap file.
+ * @returns Nothing.
+ */
+declare function implementation(req: JsonRpcRequest<InferredGetFileParams>, res: PendingJsonRpcResponse<GetFileResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getSnapFile }: GetFileHooks): 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":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,aAAa,EAAiB,4BAA4B;AAExE,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAO3D,eAAO,MAAM,iBAAiB;;;;;;EAS5B,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,OAAO,iBAAiB,EACxB,aAAa,CACd,CAAC;AAMF,eAAO,MAAM,cAAc,EAAE,sBAAsB,CACjD,YAAY,EACZ,qBAAqB,EACrB,MAAM,CAKP,CAAC;AAEF,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"}
+{"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"}

package/dist/permitted/getFile.d.mts

@@ -1,6 +1,8 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { GetFileParams } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+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";
 export declare const GetFileArgsStruct: import("@metamask/superstruct").Struct<{
     path: string;
     encoding?: "base64" | "hex" | "utf8" | undefined;
@@ -9,8 +11,52 @@ 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 declare const getFileHandler: PermittedHandlerExport<GetFileHooks, InferredGetFileParams, string>;
+/**
+ * Gets a static file's content in UTF-8, Base64, or hexadecimal.
+ *
+ * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "source": {
+ *     "files": ["./files/my-file.bin"]
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * const contents = await snap.request({
+ *   method: 'snap_getFile',
+ *   params: {
+ *     path: './files/myfile.bin',
+ *     encoding: 'hex',
+ *   },
+ * })
+ *
+ * // '0x...'
+ * console.log(contents)
+ * ```
+ */
+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>;
 };
+/**
+ * The `snap_getFile` method implementation.
+ *
+ * @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.getSnapFile - The function to load a static snap file.
+ * @returns Nothing.
+ */
+declare function implementation(req: JsonRpcRequest<InferredGetFileParams>, res: PendingJsonRpcResponse<GetFileResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getSnapFile }: GetFileHooks): 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":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,aAAa,EAAiB,4BAA4B;AAExE,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAO3D,eAAO,MAAM,iBAAiB;;;;;;EAS5B,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,OAAO,iBAAiB,EACxB,aAAa,CACd,CAAC;AAMF,eAAO,MAAM,cAAc,EAAE,sBAAsB,CACjD,YAAY,EACZ,qBAAqB,EACrB,MAAM,CAKP,CAAC;AAEF,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"}
+{"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"}

package/dist/permitted/getFile.mjs

@@ -10,11 +10,38 @@ 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.
+ *
+ * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "source": {
+ *     "files": ["./files/my-file.bin"]
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * const contents = await snap.request({
+ *   method: 'snap_getFile',
+ *   params: {
+ *     path: './files/myfile.bin',
+ *     encoding: 'hex',
+ *   },
+ * })
+ *
+ * // '0x...'
+ * console.log(contents)
+ * ```
+ */
 export const getFileHandler = {
-    methodNames: ['snap_getFile'],
+    methodNames: [methodName],
     implementation,
     hookNames,
 };

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,SAAS,GAAoC;IACjD,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAIvB;IACF,WAAW,EAAE,CAAC,cAAc,CAAC;IAC7B,cAAc;IACd,SAAS;CACV,CAAC;AASF;;;;;;;;;;;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 hookNames: MethodHooksObject<GetFileHooks> = {\n  getSnapFile: true,\n};\n\nexport const getFileHandler: PermittedHandlerExport<\n  GetFileHooks,\n  InferredGetFileParams,\n  string\n> = {\n  methodNames: ['snap_getFile'],\n  implementation,\n  hookNames,\n};\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":"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"]}