@metamask/snaps-rpc-methods 14.3.0 → 15.0.0

package/dist/permitted/getWebSockets.cjs

@@ -3,15 +3,42 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getWebSocketsHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const endowments_1 = require("../endowments/index.cjs");
+const methodName = 'snap_getWebSockets';
 const hookNames = {
     hasPermission: true,
     getWebSockets: true,
 };
 /**
- * Handler for the `snap_getWebSockets` method.
+ * Get the connected WebSockets for the Snap.
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "initialPermissions": {
+ *     "endowment:network-access": {}
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * const webSockets = await snap.request({ method: 'snap_getWebSockets' });
+ * console.log(webSockets);
+ * // Example output:
+ * // [
+ * //   {
+ * //     id: 'websocket-1',
+ * //     url: 'wss://example.com/socket',
+ * //     protocols: ['protocol1', 'protocol2'],
+ * //   },
+ * //   {
+ * //     id: 'websocket-2',
+ * //     url: 'ws://example.org/endpoint',
+ * //     protocols: [],
+ * //   },
+ * // ]
+ * ```
  */
 exports.getWebSocketsHandler = {
-    methodNames: ['snap_getWebSockets'],
+    methodNames: [methodName],
     implementation: getWebSocketsImplementation,
     hookNames,
 };

package/dist/permitted/getWebSockets.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"getWebSockets.cjs","sourceRoot":"","sources":["../../src/permitted/getWebSockets.ts"],"names":[],"mappings":";;;AAEA,qDAAsD;AAQtD,wDAA+C;AAG/C,MAAM,SAAS,GAAgD;IAC7D,aAAa,EAAE,IAAI;IACnB,aAAa,EAAE,IAAI;CACpB,CAAC;AAOF;;GAEG;AACU,QAAA,oBAAoB,GAI7B;IACF,WAAW,EAAE,CAAC,oBAAoB,CAAC;IACnC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,2BAA2B,CAClC,IAAyC,EACzC,GAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,aAAa,EAA4B;IAE1D,IAAI,CAAC,aAAa,CAAC,2BAAc,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors } from '@metamask/rpc-errors';\nimport type {\n  GetWebSocketsParams,\n  GetWebSocketsResult,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<GetWebSocketsMethodHooks> = {\n  hasPermission: true,\n  getWebSockets: true,\n};\n\nexport type GetWebSocketsMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  getWebSockets: () => GetWebSocketsResult;\n};\n\n/**\n * Handler for the `snap_getWebSockets` method.\n */\nexport const getWebSocketsHandler: PermittedHandlerExport<\n  GetWebSocketsMethodHooks,\n  GetWebSocketsParams,\n  GetWebSocketsResult\n> = {\n  methodNames: ['snap_getWebSockets'],\n  implementation: getWebSocketsImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_getWebSockets` method implementation.\n *\n * @param _req - The JSON-RPC request object. Not used by this function.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. 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.getWebSockets - The function to get the connected WebSockets for the origin.\n * @returns Nothing.\n */\nfunction getWebSocketsImplementation(\n  _req: JsonRpcRequest<GetWebSocketsParams>,\n  res: PendingJsonRpcResponse<GetWebSocketsResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, getWebSockets }: GetWebSocketsMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    res.result = getWebSockets();\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}
+{"version":3,"file":"getWebSockets.cjs","sourceRoot":"","sources":["../../src/permitted/getWebSockets.ts"],"names":[],"mappings":";;;AAEA,qDAAsD;AAQtD,wDAA+C;AAG/C,MAAM,UAAU,GAAG,oBAAoB,CAAC;AAExC,MAAM,SAAS,GAAgD;IAC7D,aAAa,EAAE,IAAI;IACnB,aAAa,EAAE,IAAI;CACpB,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACU,QAAA,oBAAoB,GAAG;IAClC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,2BAA2B,CAClC,IAAyC,EACzC,GAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,aAAa,EAA4B;IAE1D,IAAI,CAAC,aAAa,CAAC,2BAAc,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors } from '@metamask/rpc-errors';\nimport type {\n  GetWebSocketsParams,\n  GetWebSocketsResult,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_getWebSockets';\n\nconst hookNames: MethodHooksObject<GetWebSocketsMethodHooks> = {\n  hasPermission: true,\n  getWebSockets: true,\n};\n\nexport type GetWebSocketsMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  getWebSockets: () => GetWebSocketsResult;\n};\n\n/**\n * Get the connected WebSockets for the Snap.\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"endowment:network-access\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const webSockets = await snap.request({ method: 'snap_getWebSockets' });\n * console.log(webSockets);\n * // Example output:\n * // [\n * //   {\n * //     id: 'websocket-1',\n * //     url: 'wss://example.com/socket',\n * //     protocols: ['protocol1', 'protocol2'],\n * //   },\n * //   {\n * //     id: 'websocket-2',\n * //     url: 'ws://example.org/endpoint',\n * //     protocols: [],\n * //   },\n * // ]\n * ```\n */\nexport const getWebSocketsHandler = {\n  methodNames: [methodName] as const,\n  implementation: getWebSocketsImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetWebSocketsMethodHooks,\n  GetWebSocketsParams,\n  GetWebSocketsResult\n>;\n\n/**\n * The `snap_getWebSockets` method implementation.\n *\n * @param _req - The JSON-RPC request object. Not used by this function.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. 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.getWebSockets - The function to get the connected WebSockets for the origin.\n * @returns Nothing.\n */\nfunction getWebSocketsImplementation(\n  _req: JsonRpcRequest<GetWebSocketsParams>,\n  res: PendingJsonRpcResponse<GetWebSocketsResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, getWebSockets }: GetWebSocketsMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    res.result = getWebSockets();\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}

package/dist/permitted/getWebSockets.d.cts

@@ -1,11 +1,57 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { GetWebSocketsParams, GetWebSocketsResult } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { GetWebSocketsParams, GetWebSocketsResult, JsonRpcRequest } from "@metamask/snaps-sdk";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.cjs";
 export type GetWebSocketsMethodHooks = {
     hasPermission: (permissionName: string) => boolean;
     getWebSockets: () => GetWebSocketsResult;
 };
 /**
- * Handler for the `snap_getWebSockets` method.
+ * Get the connected WebSockets for the Snap.
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "initialPermissions": {
+ *     "endowment:network-access": {}
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * const webSockets = await snap.request({ method: 'snap_getWebSockets' });
+ * console.log(webSockets);
+ * // Example output:
+ * // [
+ * //   {
+ * //     id: 'websocket-1',
+ * //     url: 'wss://example.com/socket',
+ * //     protocols: ['protocol1', 'protocol2'],
+ * //   },
+ * //   {
+ * //     id: 'websocket-2',
+ * //     url: 'ws://example.org/endpoint',
+ * //     protocols: [],
+ * //   },
+ * // ]
+ * ```
  */
-export declare const getWebSocketsHandler: PermittedHandlerExport<GetWebSocketsMethodHooks, GetWebSocketsParams, GetWebSocketsResult>;
+export declare const getWebSocketsHandler: {
+    methodNames: ["snap_getWebSockets"];
+    implementation: typeof getWebSocketsImplementation;
+    hookNames: MethodHooksObject<GetWebSocketsMethodHooks>;
+};
+/**
+ * The `snap_getWebSockets` method implementation.
+ *
+ * @param _req - The JSON-RPC request object. Not used by this function.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.hasPermission - The function to check if a snap has the `endowment:network-access` permission.
+ * @param hooks.getWebSockets - The function to get the connected WebSockets for the origin.
+ * @returns Nothing.
+ */
+declare function getWebSocketsImplementation(_req: JsonRpcRequest<GetWebSocketsParams>, res: PendingJsonRpcResponse<GetWebSocketsResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, getWebSockets }: GetWebSocketsMethodHooks): void;
+export {};
 //# sourceMappingURL=getWebSockets.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getWebSockets.d.cts","sourceRoot":"","sources":["../../src/permitted/getWebSockets.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EAEpB,4BAA4B;AAW7B,MAAM,MAAM,wBAAwB,GAAG;IACrC,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,aAAa,EAAE,MAAM,mBAAmB,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,sBAAsB,CACvD,wBAAwB,EACxB,mBAAmB,EACnB,mBAAmB,CAKpB,CAAC"}
+{"version":3,"file":"getWebSockets.d.cts","sourceRoot":"","sources":["../../src/permitted/getWebSockets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EACnB,cAAc,EACf,4BAA4B;AAC7B,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAG9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD,MAAM,MAAM,wBAAwB,GAAG;IACrC,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,aAAa,EAAE,MAAM,mBAAmB,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,oBAAoB;;;;CAQhC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAS,2BAA2B,CAClC,IAAI,EAAE,cAAc,CAAC,mBAAmB,CAAC,EACzC,GAAG,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,EAChD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,aAAa,EAAE,EAAE,wBAAwB,GACzD,IAAI,CAYN"}

package/dist/permitted/getWebSockets.d.mts

@@ -1,11 +1,57 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { GetWebSocketsParams, GetWebSocketsResult } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { GetWebSocketsParams, GetWebSocketsResult, JsonRpcRequest } from "@metamask/snaps-sdk";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
 export type GetWebSocketsMethodHooks = {
     hasPermission: (permissionName: string) => boolean;
     getWebSockets: () => GetWebSocketsResult;
 };
 /**
- * Handler for the `snap_getWebSockets` method.
+ * Get the connected WebSockets for the Snap.
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "initialPermissions": {
+ *     "endowment:network-access": {}
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * const webSockets = await snap.request({ method: 'snap_getWebSockets' });
+ * console.log(webSockets);
+ * // Example output:
+ * // [
+ * //   {
+ * //     id: 'websocket-1',
+ * //     url: 'wss://example.com/socket',
+ * //     protocols: ['protocol1', 'protocol2'],
+ * //   },
+ * //   {
+ * //     id: 'websocket-2',
+ * //     url: 'ws://example.org/endpoint',
+ * //     protocols: [],
+ * //   },
+ * // ]
+ * ```
  */
-export declare const getWebSocketsHandler: PermittedHandlerExport<GetWebSocketsMethodHooks, GetWebSocketsParams, GetWebSocketsResult>;
+export declare const getWebSocketsHandler: {
+    methodNames: ["snap_getWebSockets"];
+    implementation: typeof getWebSocketsImplementation;
+    hookNames: MethodHooksObject<GetWebSocketsMethodHooks>;
+};
+/**
+ * The `snap_getWebSockets` method implementation.
+ *
+ * @param _req - The JSON-RPC request object. Not used by this function.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.hasPermission - The function to check if a snap has the `endowment:network-access` permission.
+ * @param hooks.getWebSockets - The function to get the connected WebSockets for the origin.
+ * @returns Nothing.
+ */
+declare function getWebSocketsImplementation(_req: JsonRpcRequest<GetWebSocketsParams>, res: PendingJsonRpcResponse<GetWebSocketsResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, getWebSockets }: GetWebSocketsMethodHooks): void;
+export {};
 //# sourceMappingURL=getWebSockets.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getWebSockets.d.mts","sourceRoot":"","sources":["../../src/permitted/getWebSockets.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EAEpB,4BAA4B;AAW7B,MAAM,MAAM,wBAAwB,GAAG;IACrC,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,aAAa,EAAE,MAAM,mBAAmB,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,sBAAsB,CACvD,wBAAwB,EACxB,mBAAmB,EACnB,mBAAmB,CAKpB,CAAC"}
+{"version":3,"file":"getWebSockets.d.mts","sourceRoot":"","sources":["../../src/permitted/getWebSockets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EACnB,cAAc,EACf,4BAA4B;AAC7B,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAG9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD,MAAM,MAAM,wBAAwB,GAAG;IACrC,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,aAAa,EAAE,MAAM,mBAAmB,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,oBAAoB;;;;CAQhC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAS,2BAA2B,CAClC,IAAI,EAAE,cAAc,CAAC,mBAAmB,CAAC,EACzC,GAAG,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,EAChD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,aAAa,EAAE,EAAE,wBAAwB,GACzD,IAAI,CAYN"}

package/dist/permitted/getWebSockets.mjs

@@ -1,14 +1,41 @@
 import { providerErrors } from "@metamask/rpc-errors";
 import { SnapEndowments } from "../endowments/index.mjs";
+const methodName = 'snap_getWebSockets';
 const hookNames = {
     hasPermission: true,
     getWebSockets: true,
 };
 /**
- * Handler for the `snap_getWebSockets` method.
+ * Get the connected WebSockets for the Snap.
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "initialPermissions": {
+ *     "endowment:network-access": {}
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * const webSockets = await snap.request({ method: 'snap_getWebSockets' });
+ * console.log(webSockets);
+ * // Example output:
+ * // [
+ * //   {
+ * //     id: 'websocket-1',
+ * //     url: 'wss://example.com/socket',
+ * //     protocols: ['protocol1', 'protocol2'],
+ * //   },
+ * //   {
+ * //     id: 'websocket-2',
+ * //     url: 'ws://example.org/endpoint',
+ * //     protocols: [],
+ * //   },
+ * // ]
+ * ```
  */
 export const getWebSocketsHandler = {
-    methodNames: ['snap_getWebSockets'],
+    methodNames: [methodName],
     implementation: getWebSocketsImplementation,
     hookNames,
 };

package/dist/permitted/getWebSockets.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getWebSockets.mjs","sourceRoot":"","sources":["../../src/permitted/getWebSockets.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,6BAA6B;AAQtD,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,SAAS,GAAgD;IAC7D,aAAa,EAAE,IAAI;IACnB,aAAa,EAAE,IAAI;CACpB,CAAC;AAOF;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAI7B;IACF,WAAW,EAAE,CAAC,oBAAoB,CAAC;IACnC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,2BAA2B,CAClC,IAAyC,EACzC,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,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors } from '@metamask/rpc-errors';\nimport type {\n  GetWebSocketsParams,\n  GetWebSocketsResult,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<GetWebSocketsMethodHooks> = {\n  hasPermission: true,\n  getWebSockets: true,\n};\n\nexport type GetWebSocketsMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  getWebSockets: () => GetWebSocketsResult;\n};\n\n/**\n * Handler for the `snap_getWebSockets` method.\n */\nexport const getWebSocketsHandler: PermittedHandlerExport<\n  GetWebSocketsMethodHooks,\n  GetWebSocketsParams,\n  GetWebSocketsResult\n> = {\n  methodNames: ['snap_getWebSockets'],\n  implementation: getWebSocketsImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_getWebSockets` method implementation.\n *\n * @param _req - The JSON-RPC request object. Not used by this function.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. 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.getWebSockets - The function to get the connected WebSockets for the origin.\n * @returns Nothing.\n */\nfunction getWebSocketsImplementation(\n  _req: JsonRpcRequest<GetWebSocketsParams>,\n  res: PendingJsonRpcResponse<GetWebSocketsResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, getWebSockets }: GetWebSocketsMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    res.result = getWebSockets();\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}
+{"version":3,"file":"getWebSockets.mjs","sourceRoot":"","sources":["../../src/permitted/getWebSockets.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,6BAA6B;AAQtD,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,UAAU,GAAG,oBAAoB,CAAC;AAExC,MAAM,SAAS,GAAgD;IAC7D,aAAa,EAAE,IAAI;IACnB,aAAa,EAAE,IAAI;CACpB,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,2BAA2B,CAClC,IAAyC,EACzC,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,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors } from '@metamask/rpc-errors';\nimport type {\n  GetWebSocketsParams,\n  GetWebSocketsResult,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_getWebSockets';\n\nconst hookNames: MethodHooksObject<GetWebSocketsMethodHooks> = {\n  hasPermission: true,\n  getWebSockets: true,\n};\n\nexport type GetWebSocketsMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  getWebSockets: () => GetWebSocketsResult;\n};\n\n/**\n * Get the connected WebSockets for the Snap.\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"endowment:network-access\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const webSockets = await snap.request({ method: 'snap_getWebSockets' });\n * console.log(webSockets);\n * // Example output:\n * // [\n * //   {\n * //     id: 'websocket-1',\n * //     url: 'wss://example.com/socket',\n * //     protocols: ['protocol1', 'protocol2'],\n * //   },\n * //   {\n * //     id: 'websocket-2',\n * //     url: 'ws://example.org/endpoint',\n * //     protocols: [],\n * //   },\n * // ]\n * ```\n */\nexport const getWebSocketsHandler = {\n  methodNames: [methodName] as const,\n  implementation: getWebSocketsImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetWebSocketsMethodHooks,\n  GetWebSocketsParams,\n  GetWebSocketsResult\n>;\n\n/**\n * The `snap_getWebSockets` method implementation.\n *\n * @param _req - The JSON-RPC request object. Not used by this function.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. 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.getWebSockets - The function to get the connected WebSockets for the origin.\n * @returns Nothing.\n */\nfunction getWebSocketsImplementation(\n  _req: JsonRpcRequest<GetWebSocketsParams>,\n  res: PendingJsonRpcResponse<GetWebSocketsResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, getWebSockets }: GetWebSocketsMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    res.result = getWebSockets();\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}

package/dist/permitted/handlers.cjs

@@ -6,11 +6,9 @@ const clearState_1 = require("./clearState.cjs");
 const closeWebSocket_1 = require("./closeWebSocket.cjs");
 const createInterface_1 = require("./createInterface.cjs");
 const endTrace_1 = require("./endTrace.cjs");
-const experimentalProviderRequest_1 = require("./experimentalProviderRequest.cjs");
 const getAllSnaps_1 = require("./getAllSnaps.cjs");
 const getBackgroundEvents_1 = require("./getBackgroundEvents.cjs");
 const getClientStatus_1 = require("./getClientStatus.cjs");
-const getCurrencyRate_1 = require("./getCurrencyRate.cjs");
 const getFile_1 = require("./getFile.cjs");
 const getInterfaceContext_1 = require("./getInterfaceContext.cjs");
 const getInterfaceState_1 = require("./getInterfaceState.cjs");
@@ -47,8 +45,6 @@ exports.methodHandlers = {
     snap_getInterfaceContext: getInterfaceContext_1.getInterfaceContextHandler,
     snap_listEntropySources: listEntropySources_1.listEntropySourcesHandler,
     snap_resolveInterface: resolveInterface_1.resolveInterfaceHandler,
-    snap_getCurrencyRate: getCurrencyRate_1.getCurrencyRateHandler,
-    snap_experimentalProviderRequest: experimentalProviderRequest_1.providerRequestHandler,
     snap_scheduleBackgroundEvent: scheduleBackgroundEvent_1.scheduleBackgroundEventHandler,
     snap_cancelBackgroundEvent: cancelBackgroundEvent_1.cancelBackgroundEventHandler,
     snap_getBackgroundEvents: getBackgroundEvents_1.getBackgroundEventsHandler,

package/dist/permitted/handlers.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"handlers.cjs","sourceRoot":"","sources":["../../src/permitted/handlers.ts"],"names":[],"mappings":";;;AAAA,uEAAuE;AACvE,iDAAiD;AACjD,yDAAyD;AACzD,2DAA2D;AAC3D,6CAA6C;AAC7C,mFAAuE;AACvE,mDAAmD;AACnD,mEAAmE;AACnE,2DAA2D;AAC3D,2DAA2D;AAC3D,2CAA2C;AAC3C,mEAAmE;AACnE,+DAA+D;AAC/D,6CAA6C;AAC7C,6CAA6C;AAC7C,uDAAuD;AACvD,uDAAuD;AACvD,2DAA2D;AAC3D,iEAAiE;AACjE,uDAAuD;AACvD,qDAAqD;AACrD,6DAA6D;AAC7D,2EAA2E;AAC3E,qEAAqE;AACrE,6CAA6C;AAC7C,iDAAiD;AACjD,iDAAiD;AACjD,iDAAiD;AACjD,2DAA2D;AAE3D,yDAAyD;AAC5C,QAAA,cAAc,GAAG;IAC5B,kBAAkB,EAAE,gCAAkB;IACtC,eAAe,EAAE,0BAAe;IAChC,mBAAmB,EAAE,kCAAmB;IACxC,iBAAiB,EAAE,wCAAsB;IACzC,oBAAoB,EAAE,oCAAoB;IAC1C,eAAe,EAAE,8BAAiB;IAClC,oBAAoB,EAAE,wCAAsB;IAC5C,YAAY,EAAE,wBAAc;IAC5B,aAAa,EAAE,0BAAe;IAC9B,oBAAoB,EAAE,wCAAsB;IAC5C,oBAAoB,EAAE,wCAAsB;IAC5C,sBAAsB,EAAE,4CAAwB;IAChD,wBAAwB,EAAE,gDAA0B;IACpD,uBAAuB,EAAE,8CAAyB;IAClD,qBAAqB,EAAE,0CAAuB;IAC9C,oBAAoB,EAAE,wCAAsB;IAC5C,gCAAgC,EAAE,oDAAsB;IACxD,4BAA4B,EAAE,wDAA8B;IAC5D,0BAA0B,EAAE,oDAA4B;IACxD,wBAAwB,EAAE,gDAA0B;IACpD,aAAa,EAAE,0BAAe;IAC9B,eAAe,EAAE,8BAAiB;IAClC,eAAe,EAAE,8BAAiB;IAClC,kBAAkB,EAAE,oCAAoB;IACxC,mBAAmB,EAAE,sCAAqB;IAC1C,yBAAyB,EAAE,kDAA2B;IACtD,kBAAkB,EAAE,oCAAoB;IACxC,eAAe,EAAE,8BAAiB;IAClC,aAAa,EAAE,0BAAe;CAC/B,CAAC;AACF,wDAAwD;AAE3C,QAAA,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAc,CAAC,CAAC","sourcesContent":["import { cancelBackgroundEventHandler } from './cancelBackgroundEvent';\nimport { clearStateHandler } from './clearState';\nimport { closeWebSocketHandler } from './closeWebSocket';\nimport { createInterfaceHandler } from './createInterface';\nimport { endTraceHandler } from './endTrace';\nimport { providerRequestHandler } from './experimentalProviderRequest';\nimport { getAllSnapsHandler } from './getAllSnaps';\nimport { getBackgroundEventsHandler } from './getBackgroundEvents';\nimport { getClientStatusHandler } from './getClientStatus';\nimport { getCurrencyRateHandler } from './getCurrencyRate';\nimport { getFileHandler } from './getFile';\nimport { getInterfaceContextHandler } from './getInterfaceContext';\nimport { getInterfaceStateHandler } from './getInterfaceState';\nimport { getSnapsHandler } from './getSnaps';\nimport { getStateHandler } from './getState';\nimport { getWebSocketsHandler } from './getWebSockets';\nimport { invokeKeyringHandler } from './invokeKeyring';\nimport { invokeSnapSugarHandler } from './invokeSnapSugar';\nimport { listEntropySourcesHandler } from './listEntropySources';\nimport { openWebSocketHandler } from './openWebSocket';\nimport { requestSnapsHandler } from './requestSnaps';\nimport { resolveInterfaceHandler } from './resolveInterface';\nimport { scheduleBackgroundEventHandler } from './scheduleBackgroundEvent';\nimport { sendWebSocketMessageHandler } from './sendWebSocketMessage';\nimport { setStateHandler } from './setState';\nimport { startTraceHandler } from './startTrace';\nimport { trackErrorHandler } from './trackError';\nimport { trackEventHandler } from './trackEvent';\nimport { updateInterfaceHandler } from './updateInterface';\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const methodHandlers = {\n  wallet_getAllSnaps: getAllSnapsHandler,\n  wallet_getSnaps: getSnapsHandler,\n  wallet_requestSnaps: requestSnapsHandler,\n  wallet_invokeSnap: invokeSnapSugarHandler,\n  wallet_invokeKeyring: invokeKeyringHandler,\n  snap_clearState: clearStateHandler,\n  snap_getClientStatus: getClientStatusHandler,\n  snap_getFile: getFileHandler,\n  snap_getState: getStateHandler,\n  snap_createInterface: createInterfaceHandler,\n  snap_updateInterface: updateInterfaceHandler,\n  snap_getInterfaceState: getInterfaceStateHandler,\n  snap_getInterfaceContext: getInterfaceContextHandler,\n  snap_listEntropySources: listEntropySourcesHandler,\n  snap_resolveInterface: resolveInterfaceHandler,\n  snap_getCurrencyRate: getCurrencyRateHandler,\n  snap_experimentalProviderRequest: providerRequestHandler,\n  snap_scheduleBackgroundEvent: scheduleBackgroundEventHandler,\n  snap_cancelBackgroundEvent: cancelBackgroundEventHandler,\n  snap_getBackgroundEvents: getBackgroundEventsHandler,\n  snap_setState: setStateHandler,\n  snap_trackError: trackErrorHandler,\n  snap_trackEvent: trackEventHandler,\n  snap_openWebSocket: openWebSocketHandler,\n  snap_closeWebSocket: closeWebSocketHandler,\n  snap_sendWebSocketMessage: sendWebSocketMessageHandler,\n  snap_getWebSockets: getWebSocketsHandler,\n  snap_startTrace: startTraceHandler,\n  snap_endTrace: endTraceHandler,\n};\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport const handlers = Object.values(methodHandlers);\n"]}
+{"version":3,"file":"handlers.cjs","sourceRoot":"","sources":["../../src/permitted/handlers.ts"],"names":[],"mappings":";;;AAAA,uEAAuE;AACvE,iDAAiD;AACjD,yDAAyD;AACzD,2DAA2D;AAC3D,6CAA6C;AAC7C,mDAAmD;AACnD,mEAAmE;AACnE,2DAA2D;AAC3D,2CAA2C;AAC3C,mEAAmE;AACnE,+DAA+D;AAC/D,6CAA6C;AAC7C,6CAA6C;AAC7C,uDAAuD;AACvD,uDAAuD;AACvD,2DAA2D;AAC3D,iEAAiE;AACjE,uDAAuD;AACvD,qDAAqD;AACrD,6DAA6D;AAC7D,2EAA2E;AAC3E,qEAAqE;AACrE,6CAA6C;AAC7C,iDAAiD;AACjD,iDAAiD;AACjD,iDAAiD;AACjD,2DAA2D;AAE3D,yDAAyD;AAC5C,QAAA,cAAc,GAAG;IAC5B,kBAAkB,EAAE,gCAAkB;IACtC,eAAe,EAAE,0BAAe;IAChC,mBAAmB,EAAE,kCAAmB;IACxC,iBAAiB,EAAE,wCAAsB;IACzC,oBAAoB,EAAE,oCAAoB;IAC1C,eAAe,EAAE,8BAAiB;IAClC,oBAAoB,EAAE,wCAAsB;IAC5C,YAAY,EAAE,wBAAc;IAC5B,aAAa,EAAE,0BAAe;IAC9B,oBAAoB,EAAE,wCAAsB;IAC5C,oBAAoB,EAAE,wCAAsB;IAC5C,sBAAsB,EAAE,4CAAwB;IAChD,wBAAwB,EAAE,gDAA0B;IACpD,uBAAuB,EAAE,8CAAyB;IAClD,qBAAqB,EAAE,0CAAuB;IAC9C,4BAA4B,EAAE,wDAA8B;IAC5D,0BAA0B,EAAE,oDAA4B;IACxD,wBAAwB,EAAE,gDAA0B;IACpD,aAAa,EAAE,0BAAe;IAC9B,eAAe,EAAE,8BAAiB;IAClC,eAAe,EAAE,8BAAiB;IAClC,kBAAkB,EAAE,oCAAoB;IACxC,mBAAmB,EAAE,sCAAqB;IAC1C,yBAAyB,EAAE,kDAA2B;IACtD,kBAAkB,EAAE,oCAAoB;IACxC,eAAe,EAAE,8BAAiB;IAClC,aAAa,EAAE,0BAAe;CAC/B,CAAC;AACF,wDAAwD;AAE3C,QAAA,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAc,CAAC,CAAC","sourcesContent":["import { cancelBackgroundEventHandler } from './cancelBackgroundEvent';\nimport { clearStateHandler } from './clearState';\nimport { closeWebSocketHandler } from './closeWebSocket';\nimport { createInterfaceHandler } from './createInterface';\nimport { endTraceHandler } from './endTrace';\nimport { getAllSnapsHandler } from './getAllSnaps';\nimport { getBackgroundEventsHandler } from './getBackgroundEvents';\nimport { getClientStatusHandler } from './getClientStatus';\nimport { getFileHandler } from './getFile';\nimport { getInterfaceContextHandler } from './getInterfaceContext';\nimport { getInterfaceStateHandler } from './getInterfaceState';\nimport { getSnapsHandler } from './getSnaps';\nimport { getStateHandler } from './getState';\nimport { getWebSocketsHandler } from './getWebSockets';\nimport { invokeKeyringHandler } from './invokeKeyring';\nimport { invokeSnapSugarHandler } from './invokeSnapSugar';\nimport { listEntropySourcesHandler } from './listEntropySources';\nimport { openWebSocketHandler } from './openWebSocket';\nimport { requestSnapsHandler } from './requestSnaps';\nimport { resolveInterfaceHandler } from './resolveInterface';\nimport { scheduleBackgroundEventHandler } from './scheduleBackgroundEvent';\nimport { sendWebSocketMessageHandler } from './sendWebSocketMessage';\nimport { setStateHandler } from './setState';\nimport { startTraceHandler } from './startTrace';\nimport { trackErrorHandler } from './trackError';\nimport { trackEventHandler } from './trackEvent';\nimport { updateInterfaceHandler } from './updateInterface';\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const methodHandlers = {\n  wallet_getAllSnaps: getAllSnapsHandler,\n  wallet_getSnaps: getSnapsHandler,\n  wallet_requestSnaps: requestSnapsHandler,\n  wallet_invokeSnap: invokeSnapSugarHandler,\n  wallet_invokeKeyring: invokeKeyringHandler,\n  snap_clearState: clearStateHandler,\n  snap_getClientStatus: getClientStatusHandler,\n  snap_getFile: getFileHandler,\n  snap_getState: getStateHandler,\n  snap_createInterface: createInterfaceHandler,\n  snap_updateInterface: updateInterfaceHandler,\n  snap_getInterfaceState: getInterfaceStateHandler,\n  snap_getInterfaceContext: getInterfaceContextHandler,\n  snap_listEntropySources: listEntropySourcesHandler,\n  snap_resolveInterface: resolveInterfaceHandler,\n  snap_scheduleBackgroundEvent: scheduleBackgroundEventHandler,\n  snap_cancelBackgroundEvent: cancelBackgroundEventHandler,\n  snap_getBackgroundEvents: getBackgroundEventsHandler,\n  snap_setState: setStateHandler,\n  snap_trackError: trackErrorHandler,\n  snap_trackEvent: trackEventHandler,\n  snap_openWebSocket: openWebSocketHandler,\n  snap_closeWebSocket: closeWebSocketHandler,\n  snap_sendWebSocketMessage: sendWebSocketMessageHandler,\n  snap_getWebSockets: getWebSocketsHandler,\n  snap_startTrace: startTraceHandler,\n  snap_endTrace: endTraceHandler,\n};\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport const handlers = Object.values(methodHandlers);\n"]}