@metamask/snaps-rpc-methods 14.3.0 → 15.0.0

package/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [15.0.0]
+
+### Changed
+
+- Track whether interface has been displayed before allowing `snap_getInterfaceState` ([#3888](https://github.com/MetaMask/snaps/pull/3888))
+
+### Removed
+
+- **BREAKING:** Remove `snap_getCurrencyRate` ([#3866](https://github.com/MetaMask/snaps/pull/3866))
+- **BREAKING:** Remove `snap_experimentalProviderRequest` ([#3858](https://github.com/MetaMask/snaps/pull/3858))
+
+### Fixed
+
+- Require any interface permission to use RPC methods ([#3864](https://github.com/MetaMask/snaps/pull/3864))
+
 ## [14.3.0]
 
 ### Added
@@ -567,7 +582,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@14.3.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@15.0.0...HEAD
+[15.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@14.3.0...@metamask/snaps-rpc-methods@15.0.0
 [14.3.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@14.2.0...@metamask/snaps-rpc-methods@14.3.0
 [14.2.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@14.1.1...@metamask/snaps-rpc-methods@14.2.0
 [14.1.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@14.1.0...@metamask/snaps-rpc-methods@14.1.1

package/dist/permitted/cancelBackgroundEvent.cjs

@@ -9,6 +9,26 @@ const hookNames = {
     cancelBackgroundEvent: true,
     hasPermission: true,
 };
+/**
+ * Cancel a background event created by
+ * [`snap_scheduleBackgroundEvent`](https://docs.metamask.io/snaps/reference/snaps-api/snap_schedulebackgroundevent).
+ *
+ * @example
+ * ```ts
+ * const id = await snap.request({
+ *   method: 'snap_scheduleBackgroundEvent',
+ *   params: {
+ *     // ...
+ *   },
+ * });
+ *
+ * // Later, when you want to cancel the background event:
+ * snap.request({
+ *   method: 'snap_cancelBackgroundEvent',
+ *   params: { id },
+ * });
+ * ```
+ */
 exports.cancelBackgroundEventHandler = {
     methodNames: [methodName],
     implementation: getCancelBackgroundEventImplementation,

package/dist/permitted/cancelBackgroundEvent.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"cancelBackgroundEvent.cjs","sourceRoot":"","sources":["../../src/permitted/cancelBackgroundEvent.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAOjE,uDAA4E;AAG5E,wDAA+C;AAG/C,MAAM,UAAU,GAAG,4BAA4B,CAAC;AAEhD,MAAM,SAAS,GAAwD;IACrE,qBAAqB,EAAE,IAAI;IAC3B,aAAa,EAAE,IAAI;CACpB,CAAC;AAOW,QAAA,4BAA4B,GAIrC;IACF,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,cAAc,EAAE,sCAAsC;IACtD,SAAS;CACV,CAAC;AAEF,MAAM,sCAAsC,GAAG,IAAA,oBAAM,EAAC;IACpD,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,sCAAsC,CACnD,GAAoD,EACpD,GAAwD,EACxD,KAAc,EACd,GAA6B,EAC7B,EAAE,qBAAqB,EAAE,aAAa,EAAoC;IAE1E,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC,aAAa,CAAC,2BAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3C,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,qBAAqB,CAAC,EAAE,CAAC,CAAC;QAC1B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;IAChE,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  JsonRpcRequest,\n  CancelBackgroundEventParams,\n  CancelBackgroundEventResult,\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 { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_cancelBackgroundEvent';\n\nconst hookNames: MethodHooksObject<CancelBackgroundEventMethodHooks> = {\n  cancelBackgroundEvent: true,\n  hasPermission: true,\n};\n\nexport type CancelBackgroundEventMethodHooks = {\n  cancelBackgroundEvent: (id: string) => void;\n  hasPermission: (permissionName: string) => boolean;\n};\n\nexport const cancelBackgroundEventHandler: PermittedHandlerExport<\n  CancelBackgroundEventMethodHooks,\n  CancelBackgroundEventParameters,\n  CancelBackgroundEventResult\n> = {\n  methodNames: [methodName],\n  implementation: getCancelBackgroundEventImplementation,\n  hookNames,\n};\n\nconst CancelBackgroundEventsParametersStruct = object({\n  id: string(),\n});\n\nexport type CancelBackgroundEventParameters = InferMatching<\n  typeof CancelBackgroundEventsParametersStruct,\n  CancelBackgroundEventParams\n>;\n\n/**\n * The `snap_cancelBackgroundEvent` 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.cancelBackgroundEvent - The function to cancel a background event.\n * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.\n * @returns Nothing.\n */\nasync function getCancelBackgroundEventImplementation(\n  req: JsonRpcRequest<CancelBackgroundEventParameters>,\n  res: PendingJsonRpcResponse<CancelBackgroundEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { cancelBackgroundEvent, hasPermission }: CancelBackgroundEventMethodHooks,\n): Promise<void> {\n  const { params } = req;\n\n  if (!hasPermission(SnapEndowments.Cronjob)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    cancelBackgroundEvent(id);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the cancelBackgroundEvent method `params` and returns them cast to the correct type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated resolveInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): CancelBackgroundEventParameters {\n  try {\n    return create(params, CancelBackgroundEventsParametersStruct);\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":"cancelBackgroundEvent.cjs","sourceRoot":"","sources":["../../src/permitted/cancelBackgroundEvent.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAOjE,uDAA4E;AAG5E,wDAA+C;AAG/C,MAAM,UAAU,GAAG,4BAA4B,CAAC;AAEhD,MAAM,SAAS,GAAwD;IACrE,qBAAqB,EAAE,IAAI;IAC3B,aAAa,EAAE,IAAI;CACpB,CAAC;AAOF;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,4BAA4B,GAAG;IAC1C,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,sCAAsC;IACtD,SAAS;CAKV,CAAC;AAEF,MAAM,sCAAsC,GAAG,IAAA,oBAAM,EAAC;IACpD,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,sCAAsC,CACnD,GAAoD,EACpD,GAAwD,EACxD,KAAc,EACd,GAA6B,EAC7B,EAAE,qBAAqB,EAAE,aAAa,EAAoC;IAE1E,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC,aAAa,CAAC,2BAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3C,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,qBAAqB,CAAC,EAAE,CAAC,CAAC;QAC1B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;IAChE,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  JsonRpcRequest,\n  CancelBackgroundEventParams,\n  CancelBackgroundEventResult,\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 { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_cancelBackgroundEvent';\n\nconst hookNames: MethodHooksObject<CancelBackgroundEventMethodHooks> = {\n  cancelBackgroundEvent: true,\n  hasPermission: true,\n};\n\nexport type CancelBackgroundEventMethodHooks = {\n  cancelBackgroundEvent: (id: string) => void;\n  hasPermission: (permissionName: string) => boolean;\n};\n\n/**\n * Cancel a background event created by\n * [`snap_scheduleBackgroundEvent`](https://docs.metamask.io/snaps/reference/snaps-api/snap_schedulebackgroundevent).\n *\n * @example\n * ```ts\n * const id = await snap.request({\n *   method: 'snap_scheduleBackgroundEvent',\n *   params: {\n *     // ...\n *   },\n * });\n *\n * // Later, when you want to cancel the background event:\n * snap.request({\n *   method: 'snap_cancelBackgroundEvent',\n *   params: { id },\n * });\n * ```\n */\nexport const cancelBackgroundEventHandler = {\n  methodNames: [methodName] as const,\n  implementation: getCancelBackgroundEventImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  CancelBackgroundEventMethodHooks,\n  CancelBackgroundEventParameters,\n  CancelBackgroundEventResult\n>;\n\nconst CancelBackgroundEventsParametersStruct = object({\n  id: string(),\n});\n\nexport type CancelBackgroundEventParameters = InferMatching<\n  typeof CancelBackgroundEventsParametersStruct,\n  CancelBackgroundEventParams\n>;\n\n/**\n * The `snap_cancelBackgroundEvent` 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.cancelBackgroundEvent - The function to cancel a background event.\n * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.\n * @returns Nothing.\n */\nasync function getCancelBackgroundEventImplementation(\n  req: JsonRpcRequest<CancelBackgroundEventParameters>,\n  res: PendingJsonRpcResponse<CancelBackgroundEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { cancelBackgroundEvent, hasPermission }: CancelBackgroundEventMethodHooks,\n): Promise<void> {\n  const { params } = req;\n\n  if (!hasPermission(SnapEndowments.Cronjob)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    cancelBackgroundEvent(id);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the cancelBackgroundEvent method `params` and returns them cast to the correct type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated resolveInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): CancelBackgroundEventParameters {\n  try {\n    return create(params, CancelBackgroundEventsParametersStruct);\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"]}

package/dist/permitted/cancelBackgroundEvent.d.cts

@@ -1,16 +1,56 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { CancelBackgroundEventParams, CancelBackgroundEventResult } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcRequest, CancelBackgroundEventParams, CancelBackgroundEventResult } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
+import { type PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.cjs";
 export type CancelBackgroundEventMethodHooks = {
     cancelBackgroundEvent: (id: string) => void;
     hasPermission: (permissionName: string) => boolean;
 };
-export declare const cancelBackgroundEventHandler: PermittedHandlerExport<CancelBackgroundEventMethodHooks, CancelBackgroundEventParameters, CancelBackgroundEventResult>;
+/**
+ * Cancel a background event created by
+ * [`snap_scheduleBackgroundEvent`](https://docs.metamask.io/snaps/reference/snaps-api/snap_schedulebackgroundevent).
+ *
+ * @example
+ * ```ts
+ * const id = await snap.request({
+ *   method: 'snap_scheduleBackgroundEvent',
+ *   params: {
+ *     // ...
+ *   },
+ * });
+ *
+ * // Later, when you want to cancel the background event:
+ * snap.request({
+ *   method: 'snap_cancelBackgroundEvent',
+ *   params: { id },
+ * });
+ * ```
+ */
+export declare const cancelBackgroundEventHandler: {
+    methodNames: ["snap_cancelBackgroundEvent"];
+    implementation: typeof getCancelBackgroundEventImplementation;
+    hookNames: MethodHooksObject<CancelBackgroundEventMethodHooks>;
+};
 declare const CancelBackgroundEventsParametersStruct: import("@metamask/superstruct").Struct<{
     id: string;
 }, {
     id: import("@metamask/superstruct").Struct<string, null>;
 }>;
 export type CancelBackgroundEventParameters = InferMatching<typeof CancelBackgroundEventsParametersStruct, CancelBackgroundEventParams>;
+/**
+ * The `snap_cancelBackgroundEvent` 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.cancelBackgroundEvent - The function to cancel a background event.
+ * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.
+ * @returns Nothing.
+ */
+declare function getCancelBackgroundEventImplementation(req: JsonRpcRequest<CancelBackgroundEventParameters>, res: PendingJsonRpcResponse<CancelBackgroundEventResult>, _next: unknown, end: JsonRpcEngineEndCallback, { cancelBackgroundEvent, hasPermission }: CancelBackgroundEventMethodHooks): Promise<void>;
 export {};
 //# sourceMappingURL=cancelBackgroundEvent.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"cancelBackgroundEvent.d.cts","sourceRoot":"","sources":["../../src/permitted/cancelBackgroundEvent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,2BAA2B,EAC3B,2BAA2B,EAC5B,4BAA4B;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAc3D,MAAM,MAAM,gCAAgC,GAAG;IAC7C,qBAAqB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5C,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF,eAAO,MAAM,4BAA4B,EAAE,sBAAsB,CAC/D,gCAAgC,EAChC,+BAA+B,EAC/B,2BAA2B,CAK5B,CAAC;AAEF,QAAA,MAAM,sCAAsC;;;;EAE1C,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,aAAa,CACzD,OAAO,sCAAsC,EAC7C,2BAA2B,CAC5B,CAAC"}
+{"version":3,"file":"cancelBackgroundEvent.d.cts","sourceRoot":"","sources":["../../src/permitted/cancelBackgroundEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,EAC5B,4BAA4B;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAE3D,OAAO,EAAE,KAAK,sBAAsB,EAAE,wBAAwB;AAG9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD,MAAM,MAAM,gCAAgC,GAAG;IAC7C,qBAAqB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5C,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,4BAA4B;;;;CAQxC,CAAC;AAEF,QAAA,MAAM,sCAAsC;;;;EAE1C,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,aAAa,CACzD,OAAO,sCAAsC,EAC7C,2BAA2B,CAC5B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAe,sCAAsC,CACnD,GAAG,EAAE,cAAc,CAAC,+BAA+B,CAAC,EACpD,GAAG,EAAE,sBAAsB,CAAC,2BAA2B,CAAC,EACxD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,qBAAqB,EAAE,aAAa,EAAE,EAAE,gCAAgC,GACzE,OAAO,CAAC,IAAI,CAAC,CAmBf"}

package/dist/permitted/cancelBackgroundEvent.d.mts

@@ -1,16 +1,56 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { CancelBackgroundEventParams, CancelBackgroundEventResult } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcRequest, CancelBackgroundEventParams, CancelBackgroundEventResult } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
+import { type PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
 export type CancelBackgroundEventMethodHooks = {
     cancelBackgroundEvent: (id: string) => void;
     hasPermission: (permissionName: string) => boolean;
 };
-export declare const cancelBackgroundEventHandler: PermittedHandlerExport<CancelBackgroundEventMethodHooks, CancelBackgroundEventParameters, CancelBackgroundEventResult>;
+/**
+ * Cancel a background event created by
+ * [`snap_scheduleBackgroundEvent`](https://docs.metamask.io/snaps/reference/snaps-api/snap_schedulebackgroundevent).
+ *
+ * @example
+ * ```ts
+ * const id = await snap.request({
+ *   method: 'snap_scheduleBackgroundEvent',
+ *   params: {
+ *     // ...
+ *   },
+ * });
+ *
+ * // Later, when you want to cancel the background event:
+ * snap.request({
+ *   method: 'snap_cancelBackgroundEvent',
+ *   params: { id },
+ * });
+ * ```
+ */
+export declare const cancelBackgroundEventHandler: {
+    methodNames: ["snap_cancelBackgroundEvent"];
+    implementation: typeof getCancelBackgroundEventImplementation;
+    hookNames: MethodHooksObject<CancelBackgroundEventMethodHooks>;
+};
 declare const CancelBackgroundEventsParametersStruct: import("@metamask/superstruct").Struct<{
     id: string;
 }, {
     id: import("@metamask/superstruct").Struct<string, null>;
 }>;
 export type CancelBackgroundEventParameters = InferMatching<typeof CancelBackgroundEventsParametersStruct, CancelBackgroundEventParams>;
+/**
+ * The `snap_cancelBackgroundEvent` 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.cancelBackgroundEvent - The function to cancel a background event.
+ * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.
+ * @returns Nothing.
+ */
+declare function getCancelBackgroundEventImplementation(req: JsonRpcRequest<CancelBackgroundEventParameters>, res: PendingJsonRpcResponse<CancelBackgroundEventResult>, _next: unknown, end: JsonRpcEngineEndCallback, { cancelBackgroundEvent, hasPermission }: CancelBackgroundEventMethodHooks): Promise<void>;
 export {};
 //# sourceMappingURL=cancelBackgroundEvent.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"cancelBackgroundEvent.d.mts","sourceRoot":"","sources":["../../src/permitted/cancelBackgroundEvent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,2BAA2B,EAC3B,2BAA2B,EAC5B,4BAA4B;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAc3D,MAAM,MAAM,gCAAgC,GAAG;IAC7C,qBAAqB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5C,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF,eAAO,MAAM,4BAA4B,EAAE,sBAAsB,CAC/D,gCAAgC,EAChC,+BAA+B,EAC/B,2BAA2B,CAK5B,CAAC;AAEF,QAAA,MAAM,sCAAsC;;;;EAE1C,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,aAAa,CACzD,OAAO,sCAAsC,EAC7C,2BAA2B,CAC5B,CAAC"}
+{"version":3,"file":"cancelBackgroundEvent.d.mts","sourceRoot":"","sources":["../../src/permitted/cancelBackgroundEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,EAC5B,4BAA4B;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAE3D,OAAO,EAAE,KAAK,sBAAsB,EAAE,wBAAwB;AAG9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD,MAAM,MAAM,gCAAgC,GAAG;IAC7C,qBAAqB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5C,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,4BAA4B;;;;CAQxC,CAAC;AAEF,QAAA,MAAM,sCAAsC;;;;EAE1C,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,aAAa,CACzD,OAAO,sCAAsC,EAC7C,2BAA2B,CAC5B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAe,sCAAsC,CACnD,GAAG,EAAE,cAAc,CAAC,+BAA+B,CAAC,EACpD,GAAG,EAAE,sBAAsB,CAAC,2BAA2B,CAAC,EACxD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,qBAAqB,EAAE,aAAa,EAAE,EAAE,gCAAgC,GACzE,OAAO,CAAC,IAAI,CAAC,CAmBf"}

package/dist/permitted/cancelBackgroundEvent.mjs

@@ -6,6 +6,26 @@ const hookNames = {
     cancelBackgroundEvent: true,
     hasPermission: true,
 };
+/**
+ * Cancel a background event created by
+ * [`snap_scheduleBackgroundEvent`](https://docs.metamask.io/snaps/reference/snaps-api/snap_schedulebackgroundevent).
+ *
+ * @example
+ * ```ts
+ * const id = await snap.request({
+ *   method: 'snap_scheduleBackgroundEvent',
+ *   params: {
+ *     // ...
+ *   },
+ * });
+ *
+ * // Later, when you want to cancel the background event:
+ * snap.request({
+ *   method: 'snap_cancelBackgroundEvent',
+ *   params: { id },
+ * });
+ * ```
+ */
 export const cancelBackgroundEventHandler = {
     methodNames: [methodName],
     implementation: getCancelBackgroundEventImplementation,

package/dist/permitted/cancelBackgroundEvent.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"cancelBackgroundEvent.mjs","sourceRoot":"","sources":["../../src/permitted/cancelBackgroundEvent.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAOjE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,8BAA8B;AAG5E,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,UAAU,GAAG,4BAA4B,CAAC;AAEhD,MAAM,SAAS,GAAwD;IACrE,qBAAqB,EAAE,IAAI;IAC3B,aAAa,EAAE,IAAI;CACpB,CAAC;AAOF,MAAM,CAAC,MAAM,4BAA4B,GAIrC;IACF,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,cAAc,EAAE,sCAAsC;IACtD,SAAS;CACV,CAAC;AAEF,MAAM,sCAAsC,GAAG,MAAM,CAAC;IACpD,EAAE,EAAE,MAAM,EAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,sCAAsC,CACnD,GAAoD,EACpD,GAAwD,EACxD,KAAc,EACd,GAA6B,EAC7B,EAAE,qBAAqB,EAAE,aAAa,EAAoC;IAE1E,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3C,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,qBAAqB,CAAC,EAAE,CAAC,CAAC;QAC1B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,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  JsonRpcRequest,\n  CancelBackgroundEventParams,\n  CancelBackgroundEventResult,\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 { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_cancelBackgroundEvent';\n\nconst hookNames: MethodHooksObject<CancelBackgroundEventMethodHooks> = {\n  cancelBackgroundEvent: true,\n  hasPermission: true,\n};\n\nexport type CancelBackgroundEventMethodHooks = {\n  cancelBackgroundEvent: (id: string) => void;\n  hasPermission: (permissionName: string) => boolean;\n};\n\nexport const cancelBackgroundEventHandler: PermittedHandlerExport<\n  CancelBackgroundEventMethodHooks,\n  CancelBackgroundEventParameters,\n  CancelBackgroundEventResult\n> = {\n  methodNames: [methodName],\n  implementation: getCancelBackgroundEventImplementation,\n  hookNames,\n};\n\nconst CancelBackgroundEventsParametersStruct = object({\n  id: string(),\n});\n\nexport type CancelBackgroundEventParameters = InferMatching<\n  typeof CancelBackgroundEventsParametersStruct,\n  CancelBackgroundEventParams\n>;\n\n/**\n * The `snap_cancelBackgroundEvent` 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.cancelBackgroundEvent - The function to cancel a background event.\n * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.\n * @returns Nothing.\n */\nasync function getCancelBackgroundEventImplementation(\n  req: JsonRpcRequest<CancelBackgroundEventParameters>,\n  res: PendingJsonRpcResponse<CancelBackgroundEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { cancelBackgroundEvent, hasPermission }: CancelBackgroundEventMethodHooks,\n): Promise<void> {\n  const { params } = req;\n\n  if (!hasPermission(SnapEndowments.Cronjob)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    cancelBackgroundEvent(id);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the cancelBackgroundEvent method `params` and returns them cast to the correct type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated resolveInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): CancelBackgroundEventParameters {\n  try {\n    return create(params, CancelBackgroundEventsParametersStruct);\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":"cancelBackgroundEvent.mjs","sourceRoot":"","sources":["../../src/permitted/cancelBackgroundEvent.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAOjE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,8BAA8B;AAG5E,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,UAAU,GAAG,4BAA4B,CAAC;AAEhD,MAAM,SAAS,GAAwD;IACrE,qBAAqB,EAAE,IAAI;IAC3B,aAAa,EAAE,IAAI;CACpB,CAAC;AAOF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,sCAAsC;IACtD,SAAS;CAKV,CAAC;AAEF,MAAM,sCAAsC,GAAG,MAAM,CAAC;IACpD,EAAE,EAAE,MAAM,EAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,sCAAsC,CACnD,GAAoD,EACpD,GAAwD,EACxD,KAAc,EACd,GAA6B,EAC7B,EAAE,qBAAqB,EAAE,aAAa,EAAoC;IAE1E,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3C,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,qBAAqB,CAAC,EAAE,CAAC,CAAC;QAC1B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,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  JsonRpcRequest,\n  CancelBackgroundEventParams,\n  CancelBackgroundEventResult,\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 { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_cancelBackgroundEvent';\n\nconst hookNames: MethodHooksObject<CancelBackgroundEventMethodHooks> = {\n  cancelBackgroundEvent: true,\n  hasPermission: true,\n};\n\nexport type CancelBackgroundEventMethodHooks = {\n  cancelBackgroundEvent: (id: string) => void;\n  hasPermission: (permissionName: string) => boolean;\n};\n\n/**\n * Cancel a background event created by\n * [`snap_scheduleBackgroundEvent`](https://docs.metamask.io/snaps/reference/snaps-api/snap_schedulebackgroundevent).\n *\n * @example\n * ```ts\n * const id = await snap.request({\n *   method: 'snap_scheduleBackgroundEvent',\n *   params: {\n *     // ...\n *   },\n * });\n *\n * // Later, when you want to cancel the background event:\n * snap.request({\n *   method: 'snap_cancelBackgroundEvent',\n *   params: { id },\n * });\n * ```\n */\nexport const cancelBackgroundEventHandler = {\n  methodNames: [methodName] as const,\n  implementation: getCancelBackgroundEventImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  CancelBackgroundEventMethodHooks,\n  CancelBackgroundEventParameters,\n  CancelBackgroundEventResult\n>;\n\nconst CancelBackgroundEventsParametersStruct = object({\n  id: string(),\n});\n\nexport type CancelBackgroundEventParameters = InferMatching<\n  typeof CancelBackgroundEventsParametersStruct,\n  CancelBackgroundEventParams\n>;\n\n/**\n * The `snap_cancelBackgroundEvent` 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.cancelBackgroundEvent - The function to cancel a background event.\n * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.\n * @returns Nothing.\n */\nasync function getCancelBackgroundEventImplementation(\n  req: JsonRpcRequest<CancelBackgroundEventParameters>,\n  res: PendingJsonRpcResponse<CancelBackgroundEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { cancelBackgroundEvent, hasPermission }: CancelBackgroundEventMethodHooks,\n): Promise<void> {\n  const { params } = req;\n\n  if (!hasPermission(SnapEndowments.Cronjob)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    cancelBackgroundEvent(id);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the cancelBackgroundEvent method `params` and returns them cast to the correct type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated resolveInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): CancelBackgroundEventParameters {\n  try {\n    return create(params, CancelBackgroundEventsParametersStruct);\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"]}

package/dist/permitted/clearState.cjs

@@ -4,15 +4,26 @@ exports.clearStateHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const superstruct_1 = require("@metamask/superstruct");
 const manageState_1 = require("../restricted/manageState.cjs");
+const methodName = 'snap_clearState';
 const hookNames = {
     clearSnapState: true,
     hasPermission: true,
 };
 /**
- * `snap_clearState` clears the state of the Snap.
+ * Clear the entire state of the Snap.
+ *
+ * @example
+ * ```ts
+ * await snap.request({
+ *   method: 'snap_clearState',
+ *   params: {
+ *     encrypted: true, // Optional, defaults to true
+ *   },
+ * });
+ * ```
  */
 exports.clearStateHandler = {
-    methodNames: ['snap_clearState'],
+    methodNames: [methodName],
     implementation: clearStateImplementation,
     hookNames,
 };

package/dist/permitted/clearState.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"clearState.cjs","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAGjE,uDAM+B;AAG/B,+DAA+D;AAG/D,MAAM,SAAS,GAAuC;IACpD,cAAc,EAAE,IAAI;IACpB,aAAa,EAAE,IAAI;CACpB,CAAC;AAEF;;GAEG;AACU,QAAA,iBAAiB,GAI1B;IACF,WAAW,EAAE,CAAC,iBAAiB,CAAC;IAChC,cAAc,EAAE,wBAAwB;IACxC,SAAS;CACV,CAAC;AAiBF,MAAM,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IACxC,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,wBAAwB,CACrC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,cAAc,EAAE,aAAa,EAAmB;IAElD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC,aAAa,CAAC,gCAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClD,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC;QAE7C,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAgB;IAC1C,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QAED,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","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 { ClearStateParams, ClearStateResult } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  create,\n  object,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, JsonRpcRequest } from '@metamask/utils';\n\nimport { manageStateBuilder } from '../restricted/manageState';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<ClearStateHooks> = {\n  clearSnapState: true,\n  hasPermission: true,\n};\n\n/**\n * `snap_clearState` clears the state of the Snap.\n */\nexport const clearStateHandler: PermittedHandlerExport<\n  ClearStateHooks,\n  ClearStateParameters,\n  ClearStateResult\n> = {\n  methodNames: ['snap_clearState'],\n  implementation: clearStateImplementation,\n  hookNames,\n};\n\nexport type ClearStateHooks = {\n  /**\n   * A function that clears the state of the requesting Snap.\n   */\n  clearSnapState: (encrypted: boolean) => void;\n\n  /**\n   * Check if the requesting origin has a given permission.\n   *\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the origin has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n};\n\nconst ClearStateParametersStruct = object({\n  encrypted: optional(boolean()),\n});\n\nexport type ClearStateParameters = InferMatching<\n  typeof ClearStateParametersStruct,\n  ClearStateParams\n>;\n\n/**\n * The `snap_clearState` method implementation.\n *\n * @param request - The JSON-RPC request object.\n * @param response - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.clearSnapState - A function that clears the state of the\n * requesting Snap.\n * @param hooks.hasPermission - Check whether a given origin has a given\n * permission.\n * @returns Nothing.\n */\nasync function clearStateImplementation(\n  request: JsonRpcRequest<ClearStateParameters>,\n  response: PendingJsonRpcResponse<ClearStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { clearSnapState, hasPermission }: ClearStateHooks,\n): Promise<void> {\n  const { params } = request;\n\n  if (!hasPermission(manageStateBuilder.targetName)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const { encrypted = true } = validatedParams;\n\n    clearSnapState(encrypted);\n    response.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters of the `snap_clearState` method.\n *\n * @param params - The parameters to validate.\n * @returns The validated parameters.\n */\nfunction getValidatedParams(params?: unknown) {\n  try {\n    return create(params, ClearStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"clearState.cjs","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAGjE,uDAM+B;AAG/B,+DAA+D;AAG/D,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,SAAS,GAAuC;IACpD,cAAc,EAAE,IAAI;IACpB,aAAa,EAAE,IAAI;CACpB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACU,QAAA,iBAAiB,GAAG;IAC/B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,wBAAwB;IACxC,SAAS;CAKV,CAAC;AAiBF,MAAM,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IACxC,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,wBAAwB,CACrC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,cAAc,EAAE,aAAa,EAAmB;IAElD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC,aAAa,CAAC,gCAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClD,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC;QAE7C,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAgB;IAC1C,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QAED,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","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 { ClearStateParams, ClearStateResult } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  create,\n  object,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, JsonRpcRequest } from '@metamask/utils';\n\nimport { manageStateBuilder } from '../restricted/manageState';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_clearState';\n\nconst hookNames: MethodHooksObject<ClearStateHooks> = {\n  clearSnapState: true,\n  hasPermission: true,\n};\n\n/**\n * Clear the entire state of the Snap.\n *\n * @example\n * ```ts\n * await snap.request({\n *   method: 'snap_clearState',\n *   params: {\n *     encrypted: true, // Optional, defaults to true\n *   },\n * });\n * ```\n */\nexport const clearStateHandler = {\n  methodNames: [methodName] as const,\n  implementation: clearStateImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  ClearStateHooks,\n  ClearStateParameters,\n  ClearStateResult\n>;\n\nexport type ClearStateHooks = {\n  /**\n   * A function that clears the state of the requesting Snap.\n   */\n  clearSnapState: (encrypted: boolean) => void;\n\n  /**\n   * Check if the requesting origin has a given permission.\n   *\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the origin has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n};\n\nconst ClearStateParametersStruct = object({\n  encrypted: optional(boolean()),\n});\n\nexport type ClearStateParameters = InferMatching<\n  typeof ClearStateParametersStruct,\n  ClearStateParams\n>;\n\n/**\n * The `snap_clearState` method implementation.\n *\n * @param request - The JSON-RPC request object.\n * @param response - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.clearSnapState - A function that clears the state of the\n * requesting Snap.\n * @param hooks.hasPermission - Check whether a given origin has a given\n * permission.\n * @returns Nothing.\n */\nasync function clearStateImplementation(\n  request: JsonRpcRequest<ClearStateParameters>,\n  response: PendingJsonRpcResponse<ClearStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { clearSnapState, hasPermission }: ClearStateHooks,\n): Promise<void> {\n  const { params } = request;\n\n  if (!hasPermission(manageStateBuilder.targetName)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const { encrypted = true } = validatedParams;\n\n    clearSnapState(encrypted);\n    response.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters of the `snap_clearState` method.\n *\n * @param params - The parameters to validate.\n * @returns The validated parameters.\n */\nfunction getValidatedParams(params?: unknown) {\n  try {\n    return create(params, ClearStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/clearState.d.cts

@@ -1,10 +1,26 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
 import type { ClearStateParams, ClearStateResult } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
+import type { PendingJsonRpcResponse, JsonRpcRequest } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.cjs";
 /**
- * `snap_clearState` clears the state of the Snap.
+ * Clear the entire state of the Snap.
+ *
+ * @example
+ * ```ts
+ * await snap.request({
+ *   method: 'snap_clearState',
+ *   params: {
+ *     encrypted: true, // Optional, defaults to true
+ *   },
+ * });
+ * ```
  */
-export declare const clearStateHandler: PermittedHandlerExport<ClearStateHooks, ClearStateParameters, ClearStateResult>;
+export declare const clearStateHandler: {
+    methodNames: ["snap_clearState"];
+    implementation: typeof clearStateImplementation;
+    hookNames: MethodHooksObject<ClearStateHooks>;
+};
 export type ClearStateHooks = {
     /**
      * A function that clears the state of the requesting Snap.
@@ -24,5 +40,21 @@ declare const ClearStateParametersStruct: import("@metamask/superstruct").Struct
     encrypted: import("@metamask/superstruct").Struct<boolean | undefined, null>;
 }>;
 export type ClearStateParameters = InferMatching<typeof ClearStateParametersStruct, ClearStateParams>;
+/**
+ * The `snap_clearState` method implementation.
+ *
+ * @param request - The JSON-RPC request object.
+ * @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.clearSnapState - A function that clears the state of the
+ * requesting Snap.
+ * @param hooks.hasPermission - Check whether a given origin has a given
+ * permission.
+ * @returns Nothing.
+ */
+declare function clearStateImplementation(request: JsonRpcRequest<ClearStateParameters>, response: PendingJsonRpcResponse<ClearStateResult>, _next: unknown, end: JsonRpcEngineEndCallback, { clearSnapState, hasPermission }: ClearStateHooks): Promise<void>;
 export {};
 //# sourceMappingURL=clearState.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"clearState.d.cts","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,4BAA4B;AAC9E,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAkB3D;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,sBAAsB,CACpD,eAAe,EACf,oBAAoB,EACpB,gBAAgB,CAKjB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,cAAc,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC"}
+{"version":3,"file":"clearState.d.cts","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,4BAA4B;AAC9E,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,wBAAwB;AAG9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB;;;;CAQ7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,cAAc,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,wBAAwB,CACrC,OAAO,EAAE,cAAc,CAAC,oBAAoB,CAAC,EAC7C,QAAQ,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,cAAc,EAAE,aAAa,EAAE,EAAE,eAAe,GACjD,OAAO,CAAC,IAAI,CAAC,CAkBf"}

package/dist/permitted/clearState.d.mts

@@ -1,10 +1,26 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
 import type { ClearStateParams, ClearStateResult } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
+import type { PendingJsonRpcResponse, JsonRpcRequest } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
 /**
- * `snap_clearState` clears the state of the Snap.
+ * Clear the entire state of the Snap.
+ *
+ * @example
+ * ```ts
+ * await snap.request({
+ *   method: 'snap_clearState',
+ *   params: {
+ *     encrypted: true, // Optional, defaults to true
+ *   },
+ * });
+ * ```
  */
-export declare const clearStateHandler: PermittedHandlerExport<ClearStateHooks, ClearStateParameters, ClearStateResult>;
+export declare const clearStateHandler: {
+    methodNames: ["snap_clearState"];
+    implementation: typeof clearStateImplementation;
+    hookNames: MethodHooksObject<ClearStateHooks>;
+};
 export type ClearStateHooks = {
     /**
      * A function that clears the state of the requesting Snap.
@@ -24,5 +40,21 @@ declare const ClearStateParametersStruct: import("@metamask/superstruct").Struct
     encrypted: import("@metamask/superstruct").Struct<boolean | undefined, null>;
 }>;
 export type ClearStateParameters = InferMatching<typeof ClearStateParametersStruct, ClearStateParams>;
+/**
+ * The `snap_clearState` method implementation.
+ *
+ * @param request - The JSON-RPC request object.
+ * @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.clearSnapState - A function that clears the state of the
+ * requesting Snap.
+ * @param hooks.hasPermission - Check whether a given origin has a given
+ * permission.
+ * @returns Nothing.
+ */
+declare function clearStateImplementation(request: JsonRpcRequest<ClearStateParameters>, response: PendingJsonRpcResponse<ClearStateResult>, _next: unknown, end: JsonRpcEngineEndCallback, { clearSnapState, hasPermission }: ClearStateHooks): Promise<void>;
 export {};
 //# sourceMappingURL=clearState.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"clearState.d.mts","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,4BAA4B;AAC9E,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAkB3D;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,sBAAsB,CACpD,eAAe,EACf,oBAAoB,EACpB,gBAAgB,CAKjB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,cAAc,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC"}
+{"version":3,"file":"clearState.d.mts","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,4BAA4B;AAC9E,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,wBAAwB;AAG9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB;;;;CAQ7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,cAAc,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,wBAAwB,CACrC,OAAO,EAAE,cAAc,CAAC,oBAAoB,CAAC,EAC7C,QAAQ,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,cAAc,EAAE,aAAa,EAAE,EAAE,eAAe,GACjD,OAAO,CAAC,IAAI,CAAC,CAkBf"}

package/dist/permitted/clearState.mjs

@@ -1,15 +1,26 @@
 import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
 import { boolean, create, object, optional, StructError } from "@metamask/superstruct";
 import { manageStateBuilder } from "../restricted/manageState.mjs";
+const methodName = 'snap_clearState';
 const hookNames = {
     clearSnapState: true,
     hasPermission: true,
 };
 /**
- * `snap_clearState` clears the state of the Snap.
+ * Clear the entire state of the Snap.
+ *
+ * @example
+ * ```ts
+ * await snap.request({
+ *   method: 'snap_clearState',
+ *   params: {
+ *     encrypted: true, // Optional, defaults to true
+ *   },
+ * });
+ * ```
  */
 export const clearStateHandler = {
-    methodNames: ['snap_clearState'],
+    methodNames: [methodName],
     implementation: clearStateImplementation,
     hookNames,
 };

package/dist/permitted/clearState.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"clearState.mjs","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAGjE,OAAO,EACL,OAAO,EACP,MAAM,EACN,MAAM,EACN,QAAQ,EACR,WAAW,EACZ,8BAA8B;AAG/B,OAAO,EAAE,kBAAkB,EAAE,sCAAkC;AAG/D,MAAM,SAAS,GAAuC;IACpD,cAAc,EAAE,IAAI;IACpB,aAAa,EAAE,IAAI;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAI1B;IACF,WAAW,EAAE,CAAC,iBAAiB,CAAC;IAChC,cAAc,EAAE,wBAAwB;IACxC,SAAS;CACV,CAAC;AAiBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,SAAS,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,wBAAwB,CACrC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,cAAc,EAAE,aAAa,EAAmB;IAElD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC;QAE7C,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAgB;IAC1C,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QAED,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","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 { ClearStateParams, ClearStateResult } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  create,\n  object,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, JsonRpcRequest } from '@metamask/utils';\n\nimport { manageStateBuilder } from '../restricted/manageState';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<ClearStateHooks> = {\n  clearSnapState: true,\n  hasPermission: true,\n};\n\n/**\n * `snap_clearState` clears the state of the Snap.\n */\nexport const clearStateHandler: PermittedHandlerExport<\n  ClearStateHooks,\n  ClearStateParameters,\n  ClearStateResult\n> = {\n  methodNames: ['snap_clearState'],\n  implementation: clearStateImplementation,\n  hookNames,\n};\n\nexport type ClearStateHooks = {\n  /**\n   * A function that clears the state of the requesting Snap.\n   */\n  clearSnapState: (encrypted: boolean) => void;\n\n  /**\n   * Check if the requesting origin has a given permission.\n   *\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the origin has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n};\n\nconst ClearStateParametersStruct = object({\n  encrypted: optional(boolean()),\n});\n\nexport type ClearStateParameters = InferMatching<\n  typeof ClearStateParametersStruct,\n  ClearStateParams\n>;\n\n/**\n * The `snap_clearState` method implementation.\n *\n * @param request - The JSON-RPC request object.\n * @param response - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.clearSnapState - A function that clears the state of the\n * requesting Snap.\n * @param hooks.hasPermission - Check whether a given origin has a given\n * permission.\n * @returns Nothing.\n */\nasync function clearStateImplementation(\n  request: JsonRpcRequest<ClearStateParameters>,\n  response: PendingJsonRpcResponse<ClearStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { clearSnapState, hasPermission }: ClearStateHooks,\n): Promise<void> {\n  const { params } = request;\n\n  if (!hasPermission(manageStateBuilder.targetName)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const { encrypted = true } = validatedParams;\n\n    clearSnapState(encrypted);\n    response.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters of the `snap_clearState` method.\n *\n * @param params - The parameters to validate.\n * @returns The validated parameters.\n */\nfunction getValidatedParams(params?: unknown) {\n  try {\n    return create(params, ClearStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"clearState.mjs","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAGjE,OAAO,EACL,OAAO,EACP,MAAM,EACN,MAAM,EACN,QAAQ,EACR,WAAW,EACZ,8BAA8B;AAG/B,OAAO,EAAE,kBAAkB,EAAE,sCAAkC;AAG/D,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,SAAS,GAAuC;IACpD,cAAc,EAAE,IAAI;IACpB,aAAa,EAAE,IAAI;CACpB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,wBAAwB;IACxC,SAAS;CAKV,CAAC;AAiBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,SAAS,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,wBAAwB,CACrC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,cAAc,EAAE,aAAa,EAAmB;IAElD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC;QAE7C,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAgB;IAC1C,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QAED,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","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 { ClearStateParams, ClearStateResult } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  create,\n  object,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, JsonRpcRequest } from '@metamask/utils';\n\nimport { manageStateBuilder } from '../restricted/manageState';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_clearState';\n\nconst hookNames: MethodHooksObject<ClearStateHooks> = {\n  clearSnapState: true,\n  hasPermission: true,\n};\n\n/**\n * Clear the entire state of the Snap.\n *\n * @example\n * ```ts\n * await snap.request({\n *   method: 'snap_clearState',\n *   params: {\n *     encrypted: true, // Optional, defaults to true\n *   },\n * });\n * ```\n */\nexport const clearStateHandler = {\n  methodNames: [methodName] as const,\n  implementation: clearStateImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  ClearStateHooks,\n  ClearStateParameters,\n  ClearStateResult\n>;\n\nexport type ClearStateHooks = {\n  /**\n   * A function that clears the state of the requesting Snap.\n   */\n  clearSnapState: (encrypted: boolean) => void;\n\n  /**\n   * Check if the requesting origin has a given permission.\n   *\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the origin has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n};\n\nconst ClearStateParametersStruct = object({\n  encrypted: optional(boolean()),\n});\n\nexport type ClearStateParameters = InferMatching<\n  typeof ClearStateParametersStruct,\n  ClearStateParams\n>;\n\n/**\n * The `snap_clearState` method implementation.\n *\n * @param request - The JSON-RPC request object.\n * @param response - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.clearSnapState - A function that clears the state of the\n * requesting Snap.\n * @param hooks.hasPermission - Check whether a given origin has a given\n * permission.\n * @returns Nothing.\n */\nasync function clearStateImplementation(\n  request: JsonRpcRequest<ClearStateParameters>,\n  response: PendingJsonRpcResponse<ClearStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { clearSnapState, hasPermission }: ClearStateHooks,\n): Promise<void> {\n  const { params } = request;\n\n  if (!hasPermission(manageStateBuilder.targetName)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const { encrypted = true } = validatedParams;\n\n    clearSnapState(encrypted);\n    response.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters of the `snap_clearState` method.\n *\n * @param params - The parameters to validate.\n * @returns The validated parameters.\n */\nfunction getValidatedParams(params?: unknown) {\n  try {\n    return create(params, ClearStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/closeWebSocket.cjs

@@ -4,6 +4,7 @@ exports.closeWebSocketHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const superstruct_1 = require("@metamask/superstruct");
 const endowments_1 = require("../endowments/index.cjs");
+const methodName = 'snap_closeWebSocket';
 const hookNames = {
     hasPermission: true,
     closeWebSocket: true,
@@ -12,10 +13,26 @@ const CloseWebSocketParametersStruct = (0, superstruct_1.object)({
     id: (0, superstruct_1.string)(),
 });
 /**
- * Handler for the `snap_closeWebSocket` method.
+ * Closes a WebSocket connection that was previously opened with
+ * [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "initialPermissions": {
+ *     "endowment:network-access": {}
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * await snap.request({
+ *   method: 'snap_closeWebSocket',
+ *   params: { id: 'websocket-1' },
+ * });
+ * ```
  */
 exports.closeWebSocketHandler = {
-    methodNames: ['snap_closeWebSocket'],
+    methodNames: [methodName],
     implementation: closeWebSocketImplementation,
     hookNames,
 };

package/dist/permitted/closeWebSocket.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"closeWebSocket.cjs","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAOjE,uDAA4E;AAG5E,wDAA+C;AAG/C,MAAM,SAAS,GAAiD;IAC9D,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,IAAI;CACrB,CAAC;AAOF,MAAM,8BAA8B,GAAG,IAAA,oBAAM,EAAC;IAC5C,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;GAEG;AACU,QAAA,qBAAqB,GAI9B;IACF,WAAW,EAAE,CAAC,qBAAqB,CAAC;IACpC,cAAc,EAAE,4BAA4B;IAC5C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,4BAA4B,CACnC,GAA6C,EAC7C,GAAiD,EACjD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,cAAc,EAA6B;IAE5D,IAAI,CAAC,aAAa,CAAC,2BAAc,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,EAAE,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC1C,cAAc,CAAC,EAAE,CAAC,CAAC;QACnB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,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,8BAA8B,CAAC,CAAC;IACxD,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  JsonRpcRequest,\n  CloseWebSocketParams,\n  CloseWebSocketResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { create, object, string, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<CloseWebSocketMethodHooks> = {\n  hasPermission: true,\n  closeWebSocket: true,\n};\n\nexport type CloseWebSocketMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  closeWebSocket: (id: string) => void;\n};\n\nconst CloseWebSocketParametersStruct = object({\n  id: string(),\n});\n\nexport type CloseWebSocketParameters = InferMatching<\n  typeof CloseWebSocketParametersStruct,\n  CloseWebSocketParams\n>;\n\n/**\n * Handler for the `snap_closeWebSocket` method.\n */\nexport const closeWebSocketHandler: PermittedHandlerExport<\n  CloseWebSocketMethodHooks,\n  CloseWebSocketParams,\n  CloseWebSocketResult\n> = {\n  methodNames: ['snap_closeWebSocket'],\n  implementation: closeWebSocketImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_closeWebSocket` 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 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 a snap has the `endowment:network-access` permission.\n * @param hooks.closeWebSocket - The function to close a WebSocket.\n * @returns Nothing.\n */\nfunction closeWebSocketImplementation(\n  req: JsonRpcRequest<CloseWebSocketParameters>,\n  res: PendingJsonRpcResponse<CloseWebSocketResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, closeWebSocket }: CloseWebSocketMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { params } = req;\n\n  try {\n    const { id } = getValidatedParams(params);\n    closeWebSocket(id);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_closeWebSocket method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): CloseWebSocketParameters {\n  try {\n    return create(params, CloseWebSocketParametersStruct);\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":"closeWebSocket.cjs","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAOjE,uDAA4E;AAG5E,wDAA+C;AAG/C,MAAM,UAAU,GAAG,qBAAqB,CAAC;AAEzC,MAAM,SAAS,GAAiD;IAC9D,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,IAAI;CACrB,CAAC;AAOF,MAAM,8BAA8B,GAAG,IAAA,oBAAM,EAAC;IAC5C,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,qBAAqB,GAAG;IACnC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,4BAA4B;IAC5C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,4BAA4B,CACnC,GAA6C,EAC7C,GAAiD,EACjD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,cAAc,EAA6B;IAE5D,IAAI,CAAC,aAAa,CAAC,2BAAc,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,EAAE,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC1C,cAAc,CAAC,EAAE,CAAC,CAAC;QACnB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,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,8BAA8B,CAAC,CAAC;IACxD,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  JsonRpcRequest,\n  CloseWebSocketParams,\n  CloseWebSocketResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { create, object, string, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_closeWebSocket';\n\nconst hookNames: MethodHooksObject<CloseWebSocketMethodHooks> = {\n  hasPermission: true,\n  closeWebSocket: true,\n};\n\nexport type CloseWebSocketMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  closeWebSocket: (id: string) => void;\n};\n\nconst CloseWebSocketParametersStruct = object({\n  id: string(),\n});\n\nexport type CloseWebSocketParameters = InferMatching<\n  typeof CloseWebSocketParametersStruct,\n  CloseWebSocketParams\n>;\n\n/**\n * Closes a WebSocket connection that was previously opened with\n * [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"endowment:network-access\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * await snap.request({\n *   method: 'snap_closeWebSocket',\n *   params: { id: 'websocket-1' },\n * });\n * ```\n */\nexport const closeWebSocketHandler = {\n  methodNames: [methodName] as const,\n  implementation: closeWebSocketImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  CloseWebSocketMethodHooks,\n  CloseWebSocketParams,\n  CloseWebSocketResult\n>;\n\n/**\n * The `snap_closeWebSocket` 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 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 a snap has the `endowment:network-access` permission.\n * @param hooks.closeWebSocket - The function to close a WebSocket.\n * @returns Nothing.\n */\nfunction closeWebSocketImplementation(\n  req: JsonRpcRequest<CloseWebSocketParameters>,\n  res: PendingJsonRpcResponse<CloseWebSocketResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, closeWebSocket }: CloseWebSocketMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { params } = req;\n\n  try {\n    const { id } = getValidatedParams(params);\n    closeWebSocket(id);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_closeWebSocket method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): CloseWebSocketParameters {\n  try {\n    return create(params, CloseWebSocketParametersStruct);\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"]}