@metamask/snaps-rpc-methods 13.0.0 → 13.2.0

package/dist/permitted/openWebSocket.mjs

@@ -0,0 +1,69 @@
+import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
+import { literal, union } from "@metamask/snaps-sdk";
+import { uri } from "@metamask/snaps-utils";
+import { create, object, array, string, optional, StructError } from "@metamask/superstruct";
+import { SnapEndowments } from "../endowments/index.mjs";
+const hookNames = {
+    hasPermission: true,
+    openWebSocket: true,
+};
+const OpenWebSocketParametersStruct = object({
+    url: uri({ protocol: union([literal('wss:'), literal('ws:')]) }),
+    protocols: optional(array(string())),
+});
+/**
+ * Handler for the `snap_openWebSocket` method.
+ */
+export const openWebSocketHandler = {
+    methodNames: ['snap_openWebSocket'],
+    implementation: openWebSocketImplementation,
+    hookNames,
+};
+/**
+ * The `snap_openWebSocket` 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.hasPermission - The function to check if a snap has the `endowment:network-access` permission.
+ * @param hooks.openWebSocket - The function to open a WebSocket.
+ * @returns Nothing.
+ */
+async function openWebSocketImplementation(req, res, _next, end, { hasPermission, openWebSocket }) {
+    if (!hasPermission(SnapEndowments.NetworkAccess)) {
+        return end(providerErrors.unauthorized());
+    }
+    const { params } = req;
+    try {
+        const { url, protocols } = getValidatedParams(params);
+        res.result = await openWebSocket(url, protocols);
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validates the parameters for the snap_openWebSocket method.
+ *
+ * @param params - Parameters to validate.
+ * @returns Validated parameters.
+ * @throws Throws RPC error if validation fails.
+ */
+function getValidatedParams(params) {
+    try {
+        return create(params, OpenWebSocketParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof StructError) {
+            throw rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpcErrors.internal();
+    }
+}
+//# sourceMappingURL=openWebSocket.mjs.map

package/dist/permitted/openWebSocket.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"openWebSocket.mjs","sourceRoot":"","sources":["../../src/permitted/openWebSocket.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AACjE,OAAO,EACL,OAAO,EACP,KAAK,EAIN,4BAA4B;AAC7B,OAAO,EAAE,GAAG,EAAsB,8BAA8B;AAChE,OAAO,EACL,MAAM,EACN,MAAM,EACN,KAAK,EACL,MAAM,EACN,QAAQ,EACR,WAAW,EACZ,8BAA8B;AAG/B,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,SAAS,GAAgD;IAC7D,aAAa,EAAE,IAAI;IACnB,aAAa,EAAE,IAAI;CACpB,CAAC;AAOF,MAAM,6BAA6B,GAAG,MAAM,CAAC;IAC3C,GAAG,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAChE,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;CACrC,CAAC,CAAC;AAOH;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAI7B;IACF,WAAW,EAAE,CAAC,oBAAoB,CAAC;IACnC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,2BAA2B,CACxC,GAA4C,EAC5C,GAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,aAAa,EAA4B;IAE1D,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACtD,GAAG,CAAC,MAAM,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACnD,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,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;IACvD,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 {\n  literal,\n  union,\n  type JsonRpcRequest,\n  type OpenWebSocketParams,\n  type OpenWebSocketResult,\n} from '@metamask/snaps-sdk';\nimport { uri, type InferMatching } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  array,\n  string,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<OpenWebSocketMethodHooks> = {\n  hasPermission: true,\n  openWebSocket: true,\n};\n\nexport type OpenWebSocketMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  openWebSocket: (url: string, protocols?: string[]) => Promise<string>;\n};\n\nconst OpenWebSocketParametersStruct = object({\n  url: uri({ protocol: union([literal('wss:'), literal('ws:')]) }),\n  protocols: optional(array(string())),\n});\n\nexport type OpenWebSocketParameters = InferMatching<\n  typeof OpenWebSocketParametersStruct,\n  OpenWebSocketParams\n>;\n\n/**\n * Handler for the `snap_openWebSocket` method.\n */\nexport const openWebSocketHandler: PermittedHandlerExport<\n  OpenWebSocketMethodHooks,\n  OpenWebSocketParams,\n  OpenWebSocketResult\n> = {\n  methodNames: ['snap_openWebSocket'],\n  implementation: openWebSocketImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_openWebSocket` 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.openWebSocket - The function to open a WebSocket.\n * @returns Nothing.\n */\nasync function openWebSocketImplementation(\n  req: JsonRpcRequest<OpenWebSocketParameters>,\n  res: PendingJsonRpcResponse<OpenWebSocketResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, openWebSocket }: OpenWebSocketMethodHooks,\n): Promise<void> {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { params } = req;\n\n  try {\n    const { url, protocols } = getValidatedParams(params);\n    res.result = await openWebSocket(url, protocols);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_openWebSocket 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): OpenWebSocketParameters {\n  try {\n    return create(params, OpenWebSocketParametersStruct);\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/sendWebSocketMessage.cjs

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendWebSocketMessageHandler = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const superstruct_1 = require("@metamask/superstruct");
+const endowments_1 = require("../endowments/index.cjs");
+const hookNames = {
+    hasPermission: true,
+    sendWebSocketMessage: true,
+};
+const SendWebSocketMessageParametersStruct = (0, superstruct_1.object)({
+    id: (0, superstruct_1.string)(),
+    message: (0, snaps_sdk_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.array)((0, superstruct_1.number)())]),
+});
+/**
+ * Handler for the `snap_sendWebSocketMessage` method.
+ */
+exports.sendWebSocketMessageHandler = {
+    methodNames: ['snap_sendWebSocketMessage'],
+    implementation: sendWebSocketMessageImplementation,
+    hookNames,
+};
+/**
+ * The `snap_sendWebSocketMessage` 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.hasPermission - The function to check if a snap has the `endowment:network-access` permission.
+ * @param hooks.sendWebSocketMessage - The function to send a WebSocket message.
+ * @returns Nothing.
+ */
+function sendWebSocketMessageImplementation(req, res, _next, end, { hasPermission, sendWebSocketMessage }) {
+    if (!hasPermission(endowments_1.SnapEndowments.NetworkAccess)) {
+        return end(rpc_errors_1.providerErrors.unauthorized());
+    }
+    const { params } = req;
+    try {
+        const { id, message } = getValidatedParams(params);
+        sendWebSocketMessage(id, message);
+        res.result = null;
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validates the parameters for the snap_sendWebSocketMessage method.
+ *
+ * @param params - Parameters to validate.
+ * @returns Validated parameters.
+ * @throws Throws RPC error if validation fails.
+ */
+function getValidatedParams(params) {
+    try {
+        return (0, superstruct_1.create)(params, SendWebSocketMessageParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof superstruct_1.StructError) {
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpc_errors_1.rpcErrors.internal();
+    }
+}
+//# sourceMappingURL=sendWebSocketMessage.cjs.map

package/dist/permitted/sendWebSocketMessage.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendWebSocketMessage.cjs","sourceRoot":"","sources":["../../src/permitted/sendWebSocketMessage.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAMjE,mDAA4C;AAE5C,uDAO+B;AAG/B,wDAA+C;AAG/C,MAAM,SAAS,GAAuD;IACpE,aAAa,EAAE,IAAI;IACnB,oBAAoB,EAAE,IAAI;CAC3B,CAAC;AAOF,MAAM,oCAAoC,GAAG,IAAA,oBAAM,EAAC;IAClD,EAAE,EAAE,IAAA,oBAAM,GAAE;IACZ,OAAO,EAAE,IAAA,iBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC,CAAC,CAAC;CAC5C,CAAC,CAAC;AAOH;;GAEG;AACU,QAAA,2BAA2B,GAIpC;IACF,WAAW,EAAE,CAAC,2BAA2B,CAAC;IAC1C,cAAc,EAAE,kCAAkC;IAClD,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,kCAAkC,CACzC,GAAmD,EACnD,GAAuD,EACvD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,oBAAoB,EAAmC;IAExE,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,OAAO,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,oBAAoB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAClC,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,oCAAoC,CAAC,CAAC;IAC9D,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  SendWebSocketMessageParams,\n  SendWebSocketMessageResult,\n} from '@metamask/snaps-sdk';\nimport { union } from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  number,\n  string,\n  array,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<SendWebSocketMessageMethodHooks> = {\n  hasPermission: true,\n  sendWebSocketMessage: true,\n};\n\nexport type SendWebSocketMessageMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  sendWebSocketMessage: (id: string, data: string | number[]) => void;\n};\n\nconst SendWebSocketMessageParametersStruct = object({\n  id: string(),\n  message: union([string(), array(number())]),\n});\n\nexport type SendWebSocketMessageParameters = InferMatching<\n  typeof SendWebSocketMessageParametersStruct,\n  SendWebSocketMessageParams\n>;\n\n/**\n * Handler for the `snap_sendWebSocketMessage` method.\n */\nexport const sendWebSocketMessageHandler: PermittedHandlerExport<\n  SendWebSocketMessageMethodHooks,\n  SendWebSocketMessageParams,\n  SendWebSocketMessageResult\n> = {\n  methodNames: ['snap_sendWebSocketMessage'],\n  implementation: sendWebSocketMessageImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_sendWebSocketMessage` 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.sendWebSocketMessage - The function to send a WebSocket message.\n * @returns Nothing.\n */\nfunction sendWebSocketMessageImplementation(\n  req: JsonRpcRequest<SendWebSocketMessageParameters>,\n  res: PendingJsonRpcResponse<SendWebSocketMessageResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, sendWebSocketMessage }: SendWebSocketMessageMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { params } = req;\n\n  try {\n    const { id, message } = getValidatedParams(params);\n    sendWebSocketMessage(id, message);\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_sendWebSocketMessage 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): SendWebSocketMessageParameters {\n  try {\n    return create(params, SendWebSocketMessageParametersStruct);\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/sendWebSocketMessage.d.cts

@@ -0,0 +1,21 @@
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { SendWebSocketMessageParams, SendWebSocketMessageResult } from "@metamask/snaps-sdk";
+import type { InferMatching } from "@metamask/snaps-utils";
+export type SendWebSocketMessageMethodHooks = {
+    hasPermission: (permissionName: string) => boolean;
+    sendWebSocketMessage: (id: string, data: string | number[]) => void;
+};
+declare const SendWebSocketMessageParametersStruct: import("@metamask/superstruct").Struct<{
+    id: string;
+    message: string | number[];
+}, {
+    id: import("@metamask/superstruct").Struct<string, null>;
+    message: import("@metamask/superstruct").Struct<string | number[], [head: import("@metamask/superstruct").Struct<string, null>, import("@metamask/superstruct").Struct<number[], import("@metamask/superstruct").Struct<number, null>>]>;
+}>;
+export type SendWebSocketMessageParameters = InferMatching<typeof SendWebSocketMessageParametersStruct, SendWebSocketMessageParams>;
+/**
+ * Handler for the `snap_sendWebSocketMessage` method.
+ */
+export declare const sendWebSocketMessageHandler: PermittedHandlerExport<SendWebSocketMessageMethodHooks, SendWebSocketMessageParams, SendWebSocketMessageResult>;
+export {};
+//# sourceMappingURL=sendWebSocketMessage.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sendWebSocketMessage.d.cts","sourceRoot":"","sources":["../../src/permitted/sendWebSocketMessage.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,0BAA0B,EAC1B,0BAA0B,EAC3B,4BAA4B;AAE7B,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAmB3D,MAAM,MAAM,+BAA+B,GAAG;IAC5C,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,oBAAoB,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,IAAI,CAAC;CACrE,CAAC;AAEF,QAAA,MAAM,oCAAoC;;;;;;EAGxC,CAAC;AAEH,MAAM,MAAM,8BAA8B,GAAG,aAAa,CACxD,OAAO,oCAAoC,EAC3C,0BAA0B,CAC3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,sBAAsB,CAC9D,+BAA+B,EAC/B,0BAA0B,EAC1B,0BAA0B,CAK3B,CAAC"}

package/dist/permitted/sendWebSocketMessage.d.mts

@@ -0,0 +1,21 @@
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { SendWebSocketMessageParams, SendWebSocketMessageResult } from "@metamask/snaps-sdk";
+import type { InferMatching } from "@metamask/snaps-utils";
+export type SendWebSocketMessageMethodHooks = {
+    hasPermission: (permissionName: string) => boolean;
+    sendWebSocketMessage: (id: string, data: string | number[]) => void;
+};
+declare const SendWebSocketMessageParametersStruct: import("@metamask/superstruct").Struct<{
+    id: string;
+    message: string | number[];
+}, {
+    id: import("@metamask/superstruct").Struct<string, null>;
+    message: import("@metamask/superstruct").Struct<string | number[], [head: import("@metamask/superstruct").Struct<string, null>, import("@metamask/superstruct").Struct<number[], import("@metamask/superstruct").Struct<number, null>>]>;
+}>;
+export type SendWebSocketMessageParameters = InferMatching<typeof SendWebSocketMessageParametersStruct, SendWebSocketMessageParams>;
+/**
+ * Handler for the `snap_sendWebSocketMessage` method.
+ */
+export declare const sendWebSocketMessageHandler: PermittedHandlerExport<SendWebSocketMessageMethodHooks, SendWebSocketMessageParams, SendWebSocketMessageResult>;
+export {};
+//# sourceMappingURL=sendWebSocketMessage.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sendWebSocketMessage.d.mts","sourceRoot":"","sources":["../../src/permitted/sendWebSocketMessage.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,0BAA0B,EAC1B,0BAA0B,EAC3B,4BAA4B;AAE7B,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAmB3D,MAAM,MAAM,+BAA+B,GAAG;IAC5C,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,oBAAoB,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,IAAI,CAAC;CACrE,CAAC;AAEF,QAAA,MAAM,oCAAoC;;;;;;EAGxC,CAAC;AAEH,MAAM,MAAM,8BAA8B,GAAG,aAAa,CACxD,OAAO,oCAAoC,EAC3C,0BAA0B,CAC3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,sBAAsB,CAC9D,+BAA+B,EAC/B,0BAA0B,EAC1B,0BAA0B,CAK3B,CAAC"}

package/dist/permitted/sendWebSocketMessage.mjs

@@ -0,0 +1,69 @@
+import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
+import { union } from "@metamask/snaps-sdk";
+import { create, object, number, string, array, StructError } from "@metamask/superstruct";
+import { SnapEndowments } from "../endowments/index.mjs";
+const hookNames = {
+    hasPermission: true,
+    sendWebSocketMessage: true,
+};
+const SendWebSocketMessageParametersStruct = object({
+    id: string(),
+    message: union([string(), array(number())]),
+});
+/**
+ * Handler for the `snap_sendWebSocketMessage` method.
+ */
+export const sendWebSocketMessageHandler = {
+    methodNames: ['snap_sendWebSocketMessage'],
+    implementation: sendWebSocketMessageImplementation,
+    hookNames,
+};
+/**
+ * The `snap_sendWebSocketMessage` 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.hasPermission - The function to check if a snap has the `endowment:network-access` permission.
+ * @param hooks.sendWebSocketMessage - The function to send a WebSocket message.
+ * @returns Nothing.
+ */
+function sendWebSocketMessageImplementation(req, res, _next, end, { hasPermission, sendWebSocketMessage }) {
+    if (!hasPermission(SnapEndowments.NetworkAccess)) {
+        return end(providerErrors.unauthorized());
+    }
+    const { params } = req;
+    try {
+        const { id, message } = getValidatedParams(params);
+        sendWebSocketMessage(id, message);
+        res.result = null;
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validates the parameters for the snap_sendWebSocketMessage method.
+ *
+ * @param params - Parameters to validate.
+ * @returns Validated parameters.
+ * @throws Throws RPC error if validation fails.
+ */
+function getValidatedParams(params) {
+    try {
+        return create(params, SendWebSocketMessageParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof StructError) {
+            throw rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpcErrors.internal();
+    }
+}
+//# sourceMappingURL=sendWebSocketMessage.mjs.map

package/dist/permitted/sendWebSocketMessage.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendWebSocketMessage.mjs","sourceRoot":"","sources":["../../src/permitted/sendWebSocketMessage.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAMjE,OAAO,EAAE,KAAK,EAAE,4BAA4B;AAE5C,OAAO,EACL,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,KAAK,EACL,WAAW,EACZ,8BAA8B;AAG/B,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,SAAS,GAAuD;IACpE,aAAa,EAAE,IAAI;IACnB,oBAAoB,EAAE,IAAI;CAC3B,CAAC;AAOF,MAAM,oCAAoC,GAAG,MAAM,CAAC;IAClD,EAAE,EAAE,MAAM,EAAE;IACZ,OAAO,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;CAC5C,CAAC,CAAC;AAOH;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAIpC;IACF,WAAW,EAAE,CAAC,2BAA2B,CAAC;IAC1C,cAAc,EAAE,kCAAkC;IAClD,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,kCAAkC,CACzC,GAAmD,EACnD,GAAuD,EACvD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,oBAAoB,EAAmC;IAExE,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,oBAAoB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAClC,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,MAAM,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAC;IAC9D,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  SendWebSocketMessageParams,\n  SendWebSocketMessageResult,\n} from '@metamask/snaps-sdk';\nimport { union } from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  number,\n  string,\n  array,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<SendWebSocketMessageMethodHooks> = {\n  hasPermission: true,\n  sendWebSocketMessage: true,\n};\n\nexport type SendWebSocketMessageMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  sendWebSocketMessage: (id: string, data: string | number[]) => void;\n};\n\nconst SendWebSocketMessageParametersStruct = object({\n  id: string(),\n  message: union([string(), array(number())]),\n});\n\nexport type SendWebSocketMessageParameters = InferMatching<\n  typeof SendWebSocketMessageParametersStruct,\n  SendWebSocketMessageParams\n>;\n\n/**\n * Handler for the `snap_sendWebSocketMessage` method.\n */\nexport const sendWebSocketMessageHandler: PermittedHandlerExport<\n  SendWebSocketMessageMethodHooks,\n  SendWebSocketMessageParams,\n  SendWebSocketMessageResult\n> = {\n  methodNames: ['snap_sendWebSocketMessage'],\n  implementation: sendWebSocketMessageImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_sendWebSocketMessage` 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.sendWebSocketMessage - The function to send a WebSocket message.\n * @returns Nothing.\n */\nfunction sendWebSocketMessageImplementation(\n  req: JsonRpcRequest<SendWebSocketMessageParameters>,\n  res: PendingJsonRpcResponse<SendWebSocketMessageResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, sendWebSocketMessage }: SendWebSocketMessageMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { params } = req;\n\n  try {\n    const { id, message } = getValidatedParams(params);\n    sendWebSocketMessage(id, message);\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_sendWebSocketMessage 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): SendWebSocketMessageParameters {\n  try {\n    return create(params, SendWebSocketMessageParametersStruct);\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/trackError.cjs

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.trackErrorHandler = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const superstruct_1 = require("@metamask/superstruct");
+const hookNames = {
+    trackError: true,
+    getSnap: true,
+};
+const TrackableErrorStruct = (0, superstruct_1.object)({
+    name: (0, superstruct_1.string)(),
+    message: (0, superstruct_1.string)(),
+    stack: (0, superstruct_1.nullable)((0, superstruct_1.string)()),
+    cause: (0, superstruct_1.nullable)((0, superstruct_1.lazy)(() => TrackableErrorStruct)),
+});
+const TrackErrorParametersStruct = (0, superstruct_1.object)({
+    error: TrackableErrorStruct,
+});
+/**
+ * Handler for the `snap_trackError` method.
+ */
+exports.trackErrorHandler = {
+    methodNames: ['snap_trackError'],
+    implementation: getTrackErrorImplementation,
+    hookNames,
+};
+/**
+ * The `snap_trackError` method implementation. This method allows preinstalled
+ * Snaps to send errors to the Sentry instance in the client for tracking.
+ *
+ * @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.trackError - The hook function to track an error.
+ * @param hooks.getSnap - The hook function to get Snap metadata.
+ * @returns Nothing.
+ */
+function getTrackErrorImplementation(request, response, _next, end, { trackError, getSnap }) {
+    const snap = getSnap(request.origin);
+    if (!snap?.preinstalled) {
+        return end(rpc_errors_1.rpcErrors.methodNotFound());
+    }
+    const { params } = request;
+    try {
+        const validatedParams = getValidatedParams(params);
+        const error = deserializeError(validatedParams.error);
+        response.result = trackError(error);
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validates the parameters for the snap_trackEvent method.
+ *
+ * @param params - Parameters to validate.
+ * @returns Validated parameters.
+ * @throws Throws RPC error if validation fails.
+ */
+function getValidatedParams(params) {
+    try {
+        return (0, superstruct_1.create)(params, TrackErrorParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof superstruct_1.StructError) {
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpc_errors_1.rpcErrors.internal();
+    }
+}
+/**
+ * Deserialize a {@link TrackableError} into a standard {@link Error} object.
+ *
+ * @param error - The error to deserialize.
+ * @returns A standard {@link Error} object with the same properties as the
+ * original {@link TrackableError}.
+ */
+function deserializeError(error) {
+    const deserializedError = new Error(error.message);
+    deserializedError.name = error.name;
+    deserializedError.stack = error.stack ?? undefined;
+    deserializedError.cause = error.cause
+        ? deserializeError(error.cause)
+        : undefined;
+    return deserializedError;
+}
+//# sourceMappingURL=trackError.cjs.map

package/dist/permitted/trackError.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"trackError.cjs","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AASjD,uDAO+B;AAK/B,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAoBF,MAAM,oBAAoB,GAA2B,IAAA,oBAAM,EAAC;IAC1D,IAAI,EAAE,IAAA,oBAAM,GAAE;IACd,OAAO,EAAE,IAAA,oBAAM,GAAE;IACjB,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IACzB,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,kBAAI,EAAiB,GAAG,EAAE,CAAC,oBAAoB,CAAC,CAAC;CAClE,CAAC,CAAC;AAEH,MAAM,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IACxC,KAAK,EAAE,oBAAoB;CAC5B,CAAC,CAAC;AAOH;;GAEG;AACU,QAAA,iBAAiB,GAI1B;IACF,WAAW,EAAE,CAAC,iBAAiB,CAAC;IAChC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAS,2BAA2B,CAClC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,OAAiE,CAAC,MAAM,CAC1E,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,KAAK,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAEtD,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACtC,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,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;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,MAAM,iBAAiB,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnD,iBAAiB,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACpC,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,SAAS,CAAC;IACnD,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK;QACnC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC;QAC/B,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,iBAAiB,CAAC;AAC3B,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 {\n  JsonRpcRequest,\n  TrackableError,\n  TrackErrorParams,\n  TrackErrorResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport type { Struct } from '@metamask/superstruct';\nimport {\n  create,\n  lazy,\n  nullable,\n  object,\n  string,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<TrackErrorMethodHooks> = {\n  trackError: true,\n  getSnap: true,\n};\n\nexport type TrackErrorMethodHooks = {\n  /**\n   * Track an error.\n   *\n   * @param error - The error object to track.\n   * @returns The ID of the tracked error, as returned by the Sentry instance\n   * in the client.\n   */\n  trackError: (error: Error) => string;\n\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nconst TrackableErrorStruct: Struct<TrackableError> = object({\n  name: string(),\n  message: string(),\n  stack: nullable(string()),\n  cause: nullable(lazy<TrackableError>(() => TrackableErrorStruct)),\n});\n\nconst TrackErrorParametersStruct = object({\n  error: TrackableErrorStruct,\n});\n\nexport type TrackErrorParameters = InferMatching<\n  typeof TrackErrorParametersStruct,\n  TrackErrorParams\n>;\n\n/**\n * Handler for the `snap_trackError` method.\n */\nexport const trackErrorHandler: PermittedHandlerExport<\n  TrackErrorMethodHooks,\n  TrackErrorParameters,\n  TrackErrorResult\n> = {\n  methodNames: ['snap_trackError'],\n  implementation: getTrackErrorImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_trackError` method implementation. This method allows preinstalled\n * Snaps to send errors to the Sentry instance in the client for tracking.\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.trackError - The hook function to track an error.\n * @param hooks.getSnap - The hook function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackErrorImplementation(\n  request: JsonRpcRequest<TrackErrorParameters>,\n  response: PendingJsonRpcResponse<TrackErrorResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackError, getSnap }: TrackErrorMethodHooks,\n): void {\n  const snap = getSnap(\n    (request as JsonRpcRequest<TrackErrorParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = request;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const error = deserializeError(validatedParams.error);\n\n    response.result = trackError(error);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_trackEvent 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): TrackErrorParameters {\n  try {\n    return create(params, TrackErrorParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n\n/**\n * Deserialize a {@link TrackableError} into a standard {@link Error} object.\n *\n * @param error - The error to deserialize.\n * @returns A standard {@link Error} object with the same properties as the\n * original {@link TrackableError}.\n */\nfunction deserializeError(error: TrackableError): Error {\n  const deserializedError = new Error(error.message);\n  deserializedError.name = error.name;\n  deserializedError.stack = error.stack ?? undefined;\n  deserializedError.cause = error.cause\n    ? deserializeError(error.cause)\n    : undefined;\n\n  return deserializedError;\n}\n"]}

package/dist/permitted/trackError.d.cts

@@ -0,0 +1,32 @@
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { TrackableError, TrackErrorParams, TrackErrorResult } from "@metamask/snaps-sdk";
+import type { InferMatching, Snap } from "@metamask/snaps-utils";
+import type { Struct } from "@metamask/superstruct";
+export type TrackErrorMethodHooks = {
+    /**
+     * Track an error.
+     *
+     * @param error - The error object to track.
+     * @returns The ID of the tracked error, as returned by the Sentry instance
+     * in the client.
+     */
+    trackError: (error: Error) => string;
+    /**
+     * Get Snap metadata.
+     *
+     * @param snapId - The ID of a Snap.
+     */
+    getSnap: (snapId: string) => Snap | undefined;
+};
+declare const TrackErrorParametersStruct: Struct<{
+    error: TrackableError;
+}, {
+    error: Struct<TrackableError, unknown>;
+}>;
+export type TrackErrorParameters = InferMatching<typeof TrackErrorParametersStruct, TrackErrorParams>;
+/**
+ * Handler for the `snap_trackError` method.
+ */
+export declare const trackErrorHandler: PermittedHandlerExport<TrackErrorMethodHooks, TrackErrorParameters, TrackErrorResult>;
+export {};
+//# sourceMappingURL=trackError.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trackError.d.cts","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,8BAA8B;AAkBpD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC;IAErC;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AASF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,sBAAsB,CACpD,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,CAKjB,CAAC"}

package/dist/permitted/trackError.d.mts

@@ -0,0 +1,32 @@
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { TrackableError, TrackErrorParams, TrackErrorResult } from "@metamask/snaps-sdk";
+import type { InferMatching, Snap } from "@metamask/snaps-utils";
+import type { Struct } from "@metamask/superstruct";
+export type TrackErrorMethodHooks = {
+    /**
+     * Track an error.
+     *
+     * @param error - The error object to track.
+     * @returns The ID of the tracked error, as returned by the Sentry instance
+     * in the client.
+     */
+    trackError: (error: Error) => string;
+    /**
+     * Get Snap metadata.
+     *
+     * @param snapId - The ID of a Snap.
+     */
+    getSnap: (snapId: string) => Snap | undefined;
+};
+declare const TrackErrorParametersStruct: Struct<{
+    error: TrackableError;
+}, {
+    error: Struct<TrackableError, unknown>;
+}>;
+export type TrackErrorParameters = InferMatching<typeof TrackErrorParametersStruct, TrackErrorParams>;
+/**
+ * Handler for the `snap_trackError` method.
+ */
+export declare const trackErrorHandler: PermittedHandlerExport<TrackErrorMethodHooks, TrackErrorParameters, TrackErrorResult>;
+export {};
+//# sourceMappingURL=trackError.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trackError.d.mts","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,8BAA8B;AAkBpD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC;IAErC;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AASF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,sBAAsB,CACpD,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,CAKjB,CAAC"}

package/dist/permitted/trackError.mjs

@@ -0,0 +1,91 @@
+import { rpcErrors } from "@metamask/rpc-errors";
+import { create, lazy, nullable, object, string, StructError } from "@metamask/superstruct";
+const hookNames = {
+    trackError: true,
+    getSnap: true,
+};
+const TrackableErrorStruct = object({
+    name: string(),
+    message: string(),
+    stack: nullable(string()),
+    cause: nullable(lazy(() => TrackableErrorStruct)),
+});
+const TrackErrorParametersStruct = object({
+    error: TrackableErrorStruct,
+});
+/**
+ * Handler for the `snap_trackError` method.
+ */
+export const trackErrorHandler = {
+    methodNames: ['snap_trackError'],
+    implementation: getTrackErrorImplementation,
+    hookNames,
+};
+/**
+ * The `snap_trackError` method implementation. This method allows preinstalled
+ * Snaps to send errors to the Sentry instance in the client for tracking.
+ *
+ * @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.trackError - The hook function to track an error.
+ * @param hooks.getSnap - The hook function to get Snap metadata.
+ * @returns Nothing.
+ */
+function getTrackErrorImplementation(request, response, _next, end, { trackError, getSnap }) {
+    const snap = getSnap(request.origin);
+    if (!snap?.preinstalled) {
+        return end(rpcErrors.methodNotFound());
+    }
+    const { params } = request;
+    try {
+        const validatedParams = getValidatedParams(params);
+        const error = deserializeError(validatedParams.error);
+        response.result = trackError(error);
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validates the parameters for the snap_trackEvent method.
+ *
+ * @param params - Parameters to validate.
+ * @returns Validated parameters.
+ * @throws Throws RPC error if validation fails.
+ */
+function getValidatedParams(params) {
+    try {
+        return create(params, TrackErrorParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof StructError) {
+            throw rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpcErrors.internal();
+    }
+}
+/**
+ * Deserialize a {@link TrackableError} into a standard {@link Error} object.
+ *
+ * @param error - The error to deserialize.
+ * @returns A standard {@link Error} object with the same properties as the
+ * original {@link TrackableError}.
+ */
+function deserializeError(error) {
+    const deserializedError = new Error(error.message);
+    deserializedError.name = error.name;
+    deserializedError.stack = error.stack ?? undefined;
+    deserializedError.cause = error.cause
+        ? deserializeError(error.cause)
+        : undefined;
+    return deserializedError;
+}
+//# sourceMappingURL=trackError.mjs.map

package/dist/permitted/trackError.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"trackError.mjs","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AASjD,OAAO,EACL,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,MAAM,EACN,WAAW,EACZ,8BAA8B;AAK/B,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAoBF,MAAM,oBAAoB,GAA2B,MAAM,CAAC;IAC1D,IAAI,EAAE,MAAM,EAAE;IACd,OAAO,EAAE,MAAM,EAAE;IACjB,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAiB,GAAG,EAAE,CAAC,oBAAoB,CAAC,CAAC;CAClE,CAAC,CAAC;AAEH,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,KAAK,EAAE,oBAAoB;CAC5B,CAAC,CAAC;AAOH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAI1B;IACF,WAAW,EAAE,CAAC,iBAAiB,CAAC;IAChC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAS,2BAA2B,CAClC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,OAAiE,CAAC,MAAM,CAC1E,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,KAAK,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAEtD,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACtC,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,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;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,MAAM,iBAAiB,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnD,iBAAiB,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACpC,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,SAAS,CAAC;IACnD,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK;QACnC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC;QAC/B,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,iBAAiB,CAAC;AAC3B,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 {\n  JsonRpcRequest,\n  TrackableError,\n  TrackErrorParams,\n  TrackErrorResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport type { Struct } from '@metamask/superstruct';\nimport {\n  create,\n  lazy,\n  nullable,\n  object,\n  string,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<TrackErrorMethodHooks> = {\n  trackError: true,\n  getSnap: true,\n};\n\nexport type TrackErrorMethodHooks = {\n  /**\n   * Track an error.\n   *\n   * @param error - The error object to track.\n   * @returns The ID of the tracked error, as returned by the Sentry instance\n   * in the client.\n   */\n  trackError: (error: Error) => string;\n\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nconst TrackableErrorStruct: Struct<TrackableError> = object({\n  name: string(),\n  message: string(),\n  stack: nullable(string()),\n  cause: nullable(lazy<TrackableError>(() => TrackableErrorStruct)),\n});\n\nconst TrackErrorParametersStruct = object({\n  error: TrackableErrorStruct,\n});\n\nexport type TrackErrorParameters = InferMatching<\n  typeof TrackErrorParametersStruct,\n  TrackErrorParams\n>;\n\n/**\n * Handler for the `snap_trackError` method.\n */\nexport const trackErrorHandler: PermittedHandlerExport<\n  TrackErrorMethodHooks,\n  TrackErrorParameters,\n  TrackErrorResult\n> = {\n  methodNames: ['snap_trackError'],\n  implementation: getTrackErrorImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_trackError` method implementation. This method allows preinstalled\n * Snaps to send errors to the Sentry instance in the client for tracking.\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.trackError - The hook function to track an error.\n * @param hooks.getSnap - The hook function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackErrorImplementation(\n  request: JsonRpcRequest<TrackErrorParameters>,\n  response: PendingJsonRpcResponse<TrackErrorResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackError, getSnap }: TrackErrorMethodHooks,\n): void {\n  const snap = getSnap(\n    (request as JsonRpcRequest<TrackErrorParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = request;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const error = deserializeError(validatedParams.error);\n\n    response.result = trackError(error);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_trackEvent 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): TrackErrorParameters {\n  try {\n    return create(params, TrackErrorParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n\n/**\n * Deserialize a {@link TrackableError} into a standard {@link Error} object.\n *\n * @param error - The error to deserialize.\n * @returns A standard {@link Error} object with the same properties as the\n * original {@link TrackableError}.\n */\nfunction deserializeError(error: TrackableError): Error {\n  const deserializedError = new Error(error.message);\n  deserializedError.name = error.name;\n  deserializedError.stack = error.stack ?? undefined;\n  deserializedError.cause = error.cause\n    ? deserializeError(error.cause)\n    : undefined;\n\n  return deserializedError;\n}\n"]}