@metamask/snaps-controllers 12.3.1 → 13.1.0

package/dist/websocket/WebSocketService.cjs

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketService = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const nanoid_1 = require("nanoid");
+const snaps_1 = require("../snaps/index.cjs");
+const serviceName = 'WebSocketService';
+class WebSocketService {
+    #messenger;
+    #sockets;
+    constructor({ messenger }) {
+        this.#messenger = messenger;
+        this.#sockets = new Map();
+        this.#messenger.registerActionHandler(`${serviceName}:open`, async (...args) => this.#open(...args));
+        this.#messenger.registerActionHandler(`${serviceName}:close`, (...args) => this.#close(...args));
+        this.#messenger.registerActionHandler(`${serviceName}:sendMessage`, async (...args) => this.#sendMessage(...args));
+        this.#messenger.registerActionHandler(`${serviceName}:getAll`, (...args) => this.#getAll(...args));
+        this.#messenger.subscribe('SnapController:snapUpdated', (snap) => {
+            this.#closeAll(snap.id);
+        });
+        this.#messenger.subscribe('SnapController:snapUninstalled', (snap) => {
+            this.#closeAll(snap.id);
+        });
+        // Due to local Snaps not currently emitting snapUninstalled we also have to
+        // listen to snapInstalled.
+        this.#messenger.subscribe('SnapController:snapInstalled', (snap) => {
+            this.#closeAll(snap.id);
+        });
+    }
+    /**
+     * Get information about a given WebSocket connection with an ID.
+     *
+     * @param snapId - The Snap ID.
+     * @param id - The identifier for the WebSocket connection.
+     * @returns Information abou the WebSocket connection.
+     * @throws If the WebSocket connection cannot be found.
+     */
+    #get(snapId, id) {
+        const socket = this.#sockets.get(id);
+        (0, utils_1.assert)(socket && socket.snapId === snapId, `Socket with ID "${id}" not found.`);
+        return socket;
+    }
+    /**
+     * Check whether a given Snap ID already has an open connection for a URL and protocol.
+     *
+     * @param snapId - The Snap ID.
+     * @param url - The URL.
+     * @param protocols - A protocols parameter.
+     * @returns True if a matching connection already exists, otherwise false.
+     */
+    #exists(snapId, url, protocols) {
+        return this.#getAll(snapId).some((socket) => socket.url === url && (0, snaps_utils_1.isEqual)(socket.protocols, protocols));
+    }
+    /**
+     * Handle sending a specific WebSocketEvent to a Snap.
+     *
+     * @param snapId - The Snap ID.
+     * @param event - The WebSocketEvent.
+     */
+    #handleEvent(snapId, event) {
+        this.#messenger
+            .call('SnapController:handleRequest', {
+            origin: snaps_1.METAMASK_ORIGIN,
+            snapId,
+            handler: snaps_utils_1.HandlerType.OnWebSocketEvent,
+            request: { method: '', params: { event } },
+        })
+            .catch((error) => {
+            (0, snaps_utils_1.logError)(`An error occurred while handling a WebSocket message for Snap "${snapId}":`, error);
+        });
+    }
+    /**
+     * Open a WebSocket connection.
+     *
+     * @param snapId - The Snap ID.
+     * @param url - The URL for the WebSocket connection.
+     * @param protocols - An optional parameter for protocols.
+     * @returns The identifier for the opened connection.
+     * @throws If the connection fails.
+     */
+    async #open(snapId, url, protocols = []) {
+        (0, utils_1.assert)(!this.#exists(snapId, url, protocols), `An open WebSocket connection to ${url} already exists.`);
+        const parsedUrl = new URL(url);
+        const { origin } = parsedUrl;
+        const id = (0, nanoid_1.nanoid)();
+        // eslint-disable-next-line no-restricted-globals
+        const socket = new WebSocket(url, protocols);
+        socket.binaryType = 'arraybuffer';
+        const { promise, resolve, reject } = (0, utils_1.createDeferredPromise)();
+        socket.addEventListener('open', () => {
+            resolve();
+            this.#handleEvent(snapId, {
+                type: 'open',
+                id,
+                origin,
+            });
+        });
+        socket.addEventListener('close', (event) => {
+            this.#handleEvent(snapId, {
+                type: 'close',
+                id,
+                origin,
+                code: event.code,
+                reason: event.reason,
+                // wasClean is not available on mobile.
+                wasClean: event.wasClean ?? null,
+            });
+        });
+        const errorListener = () => {
+            reject(rpc_errors_1.rpcErrors.resourceUnavailable('An error occurred while opening the WebSocket.'));
+        };
+        socket.addEventListener('error', errorListener);
+        socket.addEventListener('message', (event) => {
+            const isText = typeof event.data === 'string';
+            const data = isText
+                ? { type: 'text', message: event.data }
+                : {
+                    type: 'binary',
+                    // We request that the WebSocket gives us an array buffer.
+                    message: Array.from(new Uint8Array(event.data)),
+                };
+            this.#handleEvent(snapId, {
+                type: 'message',
+                id,
+                origin,
+                data,
+            });
+        });
+        this.#sockets.set(id, {
+            id,
+            snapId,
+            url,
+            protocols,
+            socket,
+            openPromise: promise,
+        });
+        await promise;
+        socket.removeEventListener('error', errorListener);
+        return id;
+    }
+    /**
+     * Close a given WebSocket connection.
+     *
+     * @param snapId - The Snap ID.
+     * @param id - The identifier for the WebSocket connection.
+     */
+    #close(snapId, id) {
+        const { socket } = this.#get(snapId, id);
+        socket.close();
+        this.#sockets.delete(id);
+    }
+    /**
+     * Close all open connections for a given Snap ID.
+     *
+     * @param snapId - The Snap ID.
+     */
+    #closeAll(snapId) {
+        for (const socket of this.#getAll(snapId)) {
+            this.#close(snapId, socket.id);
+        }
+    }
+    /**
+     * Send a message from a given Snap ID to a WebSocket connection.
+     *
+     * @param snapId - The Snap ID.
+     * @param id - The identifier for the WebSocket connection.
+     * @param data - The message to send.
+     */
+    async #sendMessage(snapId, id, data) {
+        const { socket, openPromise } = this.#get(snapId, id);
+        await openPromise;
+        const wrappedData = Array.isArray(data) ? new Uint8Array(data) : data;
+        socket.send(wrappedData);
+    }
+    /**
+     * Get a list of all open WebSocket connections for a Snap ID.
+     *
+     * @param snapId - The Snap ID.
+     * @returns A list of WebSocket connections.
+     */
+    #getAll(snapId) {
+        return [...this.#sockets.values()]
+            .filter((socket) => socket.snapId === snapId)
+            .map((socket) => ({
+            id: socket.id,
+            url: socket.url,
+            protocols: socket.protocols,
+        }));
+    }
+}
+exports.WebSocketService = WebSocketService;
+//# sourceMappingURL=WebSocketService.cjs.map

package/dist/websocket/WebSocketService.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketService.cjs","sourceRoot":"","sources":["../../src/websocket/WebSocketService.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAMjD,uDAAuE;AACvE,2CAAgE;AAChE,mCAAgC;AAQhC,8CAA2C;AAE3C,MAAM,WAAW,GAAG,kBAAkB,CAAC;AAiEvC,MAAa,gBAAgB;IAClB,UAAU,CAA4B;IAEtC,QAAQ,CAA8B;IAE/C,YAAY,EAAE,SAAS,EAAwB;QAC7C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAE1B,IAAI,CAAC,UAAU,CAAC,qBAAqB,CACnC,GAAG,WAAW,OAAO,EACrB,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CACvC,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,GAAG,WAAW,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CACxE,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CACrB,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,qBAAqB,CACnC,GAAG,WAAW,cAAc,EAC5B,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAC9C,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,GAAG,WAAW,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CACzE,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CACtB,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAA4B,EAAE,CAAC,IAAI,EAAE,EAAE;YAC/D,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,gCAAgC,EAAE,CAAC,IAAI,EAAE,EAAE;YACnE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,4EAA4E;QAC5E,2BAA2B;QAC3B,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,8BAA8B,EAAE,CAAC,IAAI,EAAE,EAAE;YACjE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,MAAc,EAAE,EAAU;QAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAErC,IAAA,cAAM,EACJ,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAClC,mBAAmB,EAAE,cAAc,CACpC,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,MAAc,EAAE,GAAW,EAAE,SAAmB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAC9B,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,IAAI,IAAA,qBAAO,EAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,MAAc,EAAE,KAAqB;QAChD,IAAI,CAAC,UAAU;aACZ,IAAI,CAAC,8BAA8B,EAAE;YACpC,MAAM,EAAE,uBAAe;YACvB,MAAM;YACN,OAAO,EAAE,yBAAW,CAAC,gBAAgB;YACrC,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE;SAC3C,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAA,sBAAQ,EACN,kEAAkE,MAAM,IAAI,EAC5E,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CAAC,MAAc,EAAE,GAAW,EAAE,YAAsB,EAAE;QAC/D,IAAA,cAAM,EACJ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,CAAC,EACrC,mCAAmC,GAAG,kBAAkB,CACzD,CAAC;QAEF,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;QAE7B,MAAM,EAAE,GAAG,IAAA,eAAM,GAAE,CAAC;QAEpB,iDAAiD;QACjD,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC7C,MAAM,CAAC,UAAU,GAAG,aAAa,CAAC;QAElC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAA,6BAAqB,GAAE,CAAC;QAE7D,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE;YACnC,OAAO,EAAE,CAAC;YACV,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;gBACxB,IAAI,EAAE,MAAM;gBACZ,EAAE;gBACF,MAAM;aACP,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACzC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;gBACxB,IAAI,EAAE,OAAO;gBACb,EAAE;gBACF,MAAM;gBACN,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,uCAAuC;gBACvC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI;aACjC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,GAAG,EAAE;YACzB,MAAM,CACJ,sBAAS,CAAC,mBAAmB,CAC3B,gDAAgD,CACjD,CACF,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEhD,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3C,MAAM,MAAM,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM;gBACjB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE;gBAChD,CAAC,CAAC;oBACE,IAAI,EAAE,QAAiB;oBACvB,0DAA0D;oBAC1D,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;iBAChD,CAAC;YAEN,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;gBACxB,IAAI,EAAE,SAAS;gBACf,EAAE;gBACF,MAAM;gBACN,IAAI;aACL,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE;YACpB,EAAE;YACF,MAAM;YACN,GAAG;YACH,SAAS;YACT,MAAM;YACN,WAAW,EAAE,OAAO;SACrB,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC;QAEd,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEnD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAc,EAAE,EAAU;QAC/B,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEzC,MAAM,CAAC,KAAK,EAAE,CAAC;QAEf,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAc;QACtB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,MAAc,EAAE,EAAU,EAAE,IAAuB;QACpE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEtD,MAAM,WAAW,CAAC;QAElB,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAEtE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,MAAc;QACpB,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;aAC/B,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC;aAC5C,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAChB,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC,CAAC,CAAC;IACR,CAAC;CACF;AArPD,4CAqPC","sourcesContent":["import type { RestrictedMessenger } from '@metamask/base-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetWebSocketsResult,\n  SnapId,\n  WebSocketEvent,\n} from '@metamask/snaps-sdk';\nimport { HandlerType, isEqual, logError } from '@metamask/snaps-utils';\nimport { assert, createDeferredPromise } from '@metamask/utils';\nimport { nanoid } from 'nanoid';\n\nimport type {\n  HandleSnapRequest,\n  SnapInstalled,\n  SnapUninstalled,\n  SnapUpdated,\n} from '../snaps';\nimport { METAMASK_ORIGIN } from '../snaps';\n\nconst serviceName = 'WebSocketService';\n\nexport type WebSocketServiceOpenAction = {\n  type: `${typeof serviceName}:open`;\n  handler: (\n    snapId: SnapId,\n    url: string,\n    protocols?: string[],\n  ) => Promise<string>;\n};\n\nexport type WebSocketServiceCloseAction = {\n  type: `${typeof serviceName}:close`;\n  handler: (snapId: SnapId, id: string) => void;\n};\n\nexport type WebSocketServiceSendMessageAction = {\n  type: `${typeof serviceName}:sendMessage`;\n  handler: (\n    snapId: SnapId,\n    id: string,\n    data: string | number[],\n  ) => Promise<void>;\n};\n\nexport type WebSocketServiceGetAllAction = {\n  type: `${typeof serviceName}:getAll`;\n  handler: (snapId: SnapId) => GetWebSocketsResult;\n};\n\nexport type WebSocketServiceActions =\n  | WebSocketServiceOpenAction\n  | WebSocketServiceCloseAction\n  | WebSocketServiceSendMessageAction\n  | WebSocketServiceGetAllAction;\n\nexport type WebSocketServiceAllowedActions = HandleSnapRequest;\n\nexport type WebSocketServiceEvents =\n  | SnapUninstalled\n  | SnapUpdated\n  | SnapInstalled;\n\nexport type WebSocketServiceMessenger = RestrictedMessenger<\n  'WebSocketService',\n  WebSocketServiceActions | WebSocketServiceAllowedActions,\n  WebSocketServiceEvents,\n  WebSocketServiceAllowedActions['type'],\n  WebSocketServiceEvents['type']\n>;\n\ntype WebSocketServiceArgs = {\n  messenger: WebSocketServiceMessenger;\n};\n\ntype InternalSocket = {\n  id: string;\n  snapId: SnapId;\n  url: string;\n  protocols: string[];\n  openPromise: Promise<void>;\n  // eslint-disable-next-line no-restricted-globals\n  socket: WebSocket;\n};\n\nexport class WebSocketService {\n  readonly #messenger: WebSocketServiceMessenger;\n\n  readonly #sockets: Map<string, InternalSocket>;\n\n  constructor({ messenger }: WebSocketServiceArgs) {\n    this.#messenger = messenger;\n    this.#sockets = new Map();\n\n    this.#messenger.registerActionHandler(\n      `${serviceName}:open`,\n      async (...args) => this.#open(...args),\n    );\n\n    this.#messenger.registerActionHandler(`${serviceName}:close`, (...args) =>\n      this.#close(...args),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${serviceName}:sendMessage`,\n      async (...args) => this.#sendMessage(...args),\n    );\n\n    this.#messenger.registerActionHandler(`${serviceName}:getAll`, (...args) =>\n      this.#getAll(...args),\n    );\n\n    this.#messenger.subscribe('SnapController:snapUpdated', (snap) => {\n      this.#closeAll(snap.id);\n    });\n\n    this.#messenger.subscribe('SnapController:snapUninstalled', (snap) => {\n      this.#closeAll(snap.id);\n    });\n\n    // Due to local Snaps not currently emitting snapUninstalled we also have to\n    // listen to snapInstalled.\n    this.#messenger.subscribe('SnapController:snapInstalled', (snap) => {\n      this.#closeAll(snap.id);\n    });\n  }\n\n  /**\n   * Get information about a given WebSocket connection with an ID.\n   *\n   * @param snapId - The Snap ID.\n   * @param id - The identifier for the WebSocket connection.\n   * @returns Information abou the WebSocket connection.\n   * @throws If the WebSocket connection cannot be found.\n   */\n  #get(snapId: SnapId, id: string) {\n    const socket = this.#sockets.get(id);\n\n    assert(\n      socket && socket.snapId === snapId,\n      `Socket with ID \"${id}\" not found.`,\n    );\n\n    return socket;\n  }\n\n  /**\n   * Check whether a given Snap ID already has an open connection for a URL and protocol.\n   *\n   * @param snapId - The Snap ID.\n   * @param url - The URL.\n   * @param protocols - A protocols parameter.\n   * @returns True if a matching connection already exists, otherwise false.\n   */\n  #exists(snapId: SnapId, url: string, protocols: string[]) {\n    return this.#getAll(snapId).some(\n      (socket) => socket.url === url && isEqual(socket.protocols, protocols),\n    );\n  }\n\n  /**\n   * Handle sending a specific WebSocketEvent to a Snap.\n   *\n   * @param snapId - The Snap ID.\n   * @param event - The WebSocketEvent.\n   */\n  #handleEvent(snapId: SnapId, event: WebSocketEvent) {\n    this.#messenger\n      .call('SnapController:handleRequest', {\n        origin: METAMASK_ORIGIN,\n        snapId,\n        handler: HandlerType.OnWebSocketEvent,\n        request: { method: '', params: { event } },\n      })\n      .catch((error) => {\n        logError(\n          `An error occurred while handling a WebSocket message for Snap \"${snapId}\":`,\n          error,\n        );\n      });\n  }\n\n  /**\n   * Open a WebSocket connection.\n   *\n   * @param snapId - The Snap ID.\n   * @param url - The URL for the WebSocket connection.\n   * @param protocols - An optional parameter for protocols.\n   * @returns The identifier for the opened connection.\n   * @throws If the connection fails.\n   */\n  async #open(snapId: SnapId, url: string, protocols: string[] = []) {\n    assert(\n      !this.#exists(snapId, url, protocols),\n      `An open WebSocket connection to ${url} already exists.`,\n    );\n\n    const parsedUrl = new URL(url);\n    const { origin } = parsedUrl;\n\n    const id = nanoid();\n\n    // eslint-disable-next-line no-restricted-globals\n    const socket = new WebSocket(url, protocols);\n    socket.binaryType = 'arraybuffer';\n\n    const { promise, resolve, reject } = createDeferredPromise();\n\n    socket.addEventListener('open', () => {\n      resolve();\n      this.#handleEvent(snapId, {\n        type: 'open',\n        id,\n        origin,\n      });\n    });\n\n    socket.addEventListener('close', (event) => {\n      this.#handleEvent(snapId, {\n        type: 'close',\n        id,\n        origin,\n        code: event.code,\n        reason: event.reason,\n        // wasClean is not available on mobile.\n        wasClean: event.wasClean ?? null,\n      });\n    });\n\n    const errorListener = () => {\n      reject(\n        rpcErrors.resourceUnavailable(\n          'An error occurred while opening the WebSocket.',\n        ),\n      );\n    };\n\n    socket.addEventListener('error', errorListener);\n\n    socket.addEventListener('message', (event) => {\n      const isText = typeof event.data === 'string';\n      const data = isText\n        ? { type: 'text' as const, message: event.data }\n        : {\n            type: 'binary' as const,\n            // We request that the WebSocket gives us an array buffer.\n            message: Array.from(new Uint8Array(event.data)),\n          };\n\n      this.#handleEvent(snapId, {\n        type: 'message',\n        id,\n        origin,\n        data,\n      });\n    });\n\n    this.#sockets.set(id, {\n      id,\n      snapId,\n      url,\n      protocols,\n      socket,\n      openPromise: promise,\n    });\n\n    await promise;\n\n    socket.removeEventListener('error', errorListener);\n\n    return id;\n  }\n\n  /**\n   * Close a given WebSocket connection.\n   *\n   * @param snapId - The Snap ID.\n   * @param id - The identifier for the WebSocket connection.\n   */\n  #close(snapId: SnapId, id: string) {\n    const { socket } = this.#get(snapId, id);\n\n    socket.close();\n\n    this.#sockets.delete(id);\n  }\n\n  /**\n   * Close all open connections for a given Snap ID.\n   *\n   * @param snapId - The Snap ID.\n   */\n  #closeAll(snapId: SnapId) {\n    for (const socket of this.#getAll(snapId)) {\n      this.#close(snapId, socket.id);\n    }\n  }\n\n  /**\n   * Send a message from a given Snap ID to a WebSocket connection.\n   *\n   * @param snapId - The Snap ID.\n   * @param id - The identifier for the WebSocket connection.\n   * @param data - The message to send.\n   */\n  async #sendMessage(snapId: SnapId, id: string, data: string | number[]) {\n    const { socket, openPromise } = this.#get(snapId, id);\n\n    await openPromise;\n\n    const wrappedData = Array.isArray(data) ? new Uint8Array(data) : data;\n\n    socket.send(wrappedData);\n  }\n\n  /**\n   * Get a list of all open WebSocket connections for a Snap ID.\n   *\n   * @param snapId - The Snap ID.\n   * @returns A list of WebSocket connections.\n   */\n  #getAll(snapId: SnapId) {\n    return [...this.#sockets.values()]\n      .filter((socket) => socket.snapId === snapId)\n      .map((socket) => ({\n        id: socket.id,\n        url: socket.url,\n        protocols: socket.protocols,\n      }));\n  }\n}\n"]}

package/dist/websocket/WebSocketService.d.cts

@@ -0,0 +1,33 @@
+import type { RestrictedMessenger } from "@metamask/base-controller";
+import type { GetWebSocketsResult, SnapId } from "@metamask/snaps-sdk";
+import type { HandleSnapRequest, SnapInstalled, SnapUninstalled, SnapUpdated } from "../snaps/index.cjs";
+declare const serviceName = "WebSocketService";
+export type WebSocketServiceOpenAction = {
+    type: `${typeof serviceName}:open`;
+    handler: (snapId: SnapId, url: string, protocols?: string[]) => Promise<string>;
+};
+export type WebSocketServiceCloseAction = {
+    type: `${typeof serviceName}:close`;
+    handler: (snapId: SnapId, id: string) => void;
+};
+export type WebSocketServiceSendMessageAction = {
+    type: `${typeof serviceName}:sendMessage`;
+    handler: (snapId: SnapId, id: string, data: string | number[]) => Promise<void>;
+};
+export type WebSocketServiceGetAllAction = {
+    type: `${typeof serviceName}:getAll`;
+    handler: (snapId: SnapId) => GetWebSocketsResult;
+};
+export type WebSocketServiceActions = WebSocketServiceOpenAction | WebSocketServiceCloseAction | WebSocketServiceSendMessageAction | WebSocketServiceGetAllAction;
+export type WebSocketServiceAllowedActions = HandleSnapRequest;
+export type WebSocketServiceEvents = SnapUninstalled | SnapUpdated | SnapInstalled;
+export type WebSocketServiceMessenger = RestrictedMessenger<'WebSocketService', WebSocketServiceActions | WebSocketServiceAllowedActions, WebSocketServiceEvents, WebSocketServiceAllowedActions['type'], WebSocketServiceEvents['type']>;
+type WebSocketServiceArgs = {
+    messenger: WebSocketServiceMessenger;
+};
+export declare class WebSocketService {
+    #private;
+    constructor({ messenger }: WebSocketServiceArgs);
+}
+export {};
+//# sourceMappingURL=WebSocketService.d.cts.map

package/dist/websocket/WebSocketService.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketService.d.cts","sourceRoot":"","sources":["../../src/websocket/WebSocketService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAAkC;AAErE,OAAO,KAAK,EACV,mBAAmB,EACnB,MAAM,EAEP,4BAA4B;AAK7B,OAAO,KAAK,EACV,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,WAAW,EACZ,2BAAiB;AAGlB,QAAA,MAAM,WAAW,qBAAqB,CAAC;AAEvC,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,GAAG,OAAO,WAAW,OAAO,CAAC;IACnC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,EAAE,KACjB,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,GAAG,OAAO,WAAW,QAAQ,CAAC;IACpC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,GAAG,OAAO,WAAW,cAAc,CAAC;IAC1C,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KACpB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,WAAW,SAAS,CAAC;IACrC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,mBAAmB,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,0BAA0B,GAC1B,2BAA2B,GAC3B,iCAAiC,GACjC,4BAA4B,CAAC;AAEjC,MAAM,MAAM,8BAA8B,GAAG,iBAAiB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAC9B,eAAe,GACf,WAAW,GACX,aAAa,CAAC;AAElB,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CACzD,kBAAkB,EAClB,uBAAuB,GAAG,8BAA8B,EACxD,sBAAsB,EACtB,8BAA8B,CAAC,MAAM,CAAC,EACtC,sBAAsB,CAAC,MAAM,CAAC,CAC/B,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,SAAS,EAAE,yBAAyB,CAAC;CACtC,CAAC;AAYF,qBAAa,gBAAgB;;gBAKf,EAAE,SAAS,EAAE,EAAE,oBAAoB;CAgPhD"}

package/dist/websocket/WebSocketService.d.mts

@@ -0,0 +1,33 @@
+import type { RestrictedMessenger } from "@metamask/base-controller";
+import type { GetWebSocketsResult, SnapId } from "@metamask/snaps-sdk";
+import type { HandleSnapRequest, SnapInstalled, SnapUninstalled, SnapUpdated } from "../snaps/index.mjs";
+declare const serviceName = "WebSocketService";
+export type WebSocketServiceOpenAction = {
+    type: `${typeof serviceName}:open`;
+    handler: (snapId: SnapId, url: string, protocols?: string[]) => Promise<string>;
+};
+export type WebSocketServiceCloseAction = {
+    type: `${typeof serviceName}:close`;
+    handler: (snapId: SnapId, id: string) => void;
+};
+export type WebSocketServiceSendMessageAction = {
+    type: `${typeof serviceName}:sendMessage`;
+    handler: (snapId: SnapId, id: string, data: string | number[]) => Promise<void>;
+};
+export type WebSocketServiceGetAllAction = {
+    type: `${typeof serviceName}:getAll`;
+    handler: (snapId: SnapId) => GetWebSocketsResult;
+};
+export type WebSocketServiceActions = WebSocketServiceOpenAction | WebSocketServiceCloseAction | WebSocketServiceSendMessageAction | WebSocketServiceGetAllAction;
+export type WebSocketServiceAllowedActions = HandleSnapRequest;
+export type WebSocketServiceEvents = SnapUninstalled | SnapUpdated | SnapInstalled;
+export type WebSocketServiceMessenger = RestrictedMessenger<'WebSocketService', WebSocketServiceActions | WebSocketServiceAllowedActions, WebSocketServiceEvents, WebSocketServiceAllowedActions['type'], WebSocketServiceEvents['type']>;
+type WebSocketServiceArgs = {
+    messenger: WebSocketServiceMessenger;
+};
+export declare class WebSocketService {
+    #private;
+    constructor({ messenger }: WebSocketServiceArgs);
+}
+export {};
+//# sourceMappingURL=WebSocketService.d.mts.map

package/dist/websocket/WebSocketService.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketService.d.mts","sourceRoot":"","sources":["../../src/websocket/WebSocketService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAAkC;AAErE,OAAO,KAAK,EACV,mBAAmB,EACnB,MAAM,EAEP,4BAA4B;AAK7B,OAAO,KAAK,EACV,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,WAAW,EACZ,2BAAiB;AAGlB,QAAA,MAAM,WAAW,qBAAqB,CAAC;AAEvC,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,GAAG,OAAO,WAAW,OAAO,CAAC;IACnC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,EAAE,KACjB,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,GAAG,OAAO,WAAW,QAAQ,CAAC;IACpC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,GAAG,OAAO,WAAW,cAAc,CAAC;IAC1C,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KACpB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,WAAW,SAAS,CAAC;IACrC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,mBAAmB,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,0BAA0B,GAC1B,2BAA2B,GAC3B,iCAAiC,GACjC,4BAA4B,CAAC;AAEjC,MAAM,MAAM,8BAA8B,GAAG,iBAAiB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAC9B,eAAe,GACf,WAAW,GACX,aAAa,CAAC;AAElB,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CACzD,kBAAkB,EAClB,uBAAuB,GAAG,8BAA8B,EACxD,sBAAsB,EACtB,8BAA8B,CAAC,MAAM,CAAC,EACtC,sBAAsB,CAAC,MAAM,CAAC,CAC/B,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,SAAS,EAAE,yBAAyB,CAAC;CACtC,CAAC;AAYF,qBAAa,gBAAgB;;gBAKf,EAAE,SAAS,EAAE,EAAE,oBAAoB;CAgPhD"}

package/dist/websocket/WebSocketService.mjs

@@ -0,0 +1,190 @@
+import { rpcErrors } from "@metamask/rpc-errors";
+import { HandlerType, isEqual, logError } from "@metamask/snaps-utils";
+import { assert, createDeferredPromise } from "@metamask/utils";
+import { nanoid } from "nanoid";
+import { METAMASK_ORIGIN } from "../snaps/index.mjs";
+const serviceName = 'WebSocketService';
+export class WebSocketService {
+    #messenger;
+    #sockets;
+    constructor({ messenger }) {
+        this.#messenger = messenger;
+        this.#sockets = new Map();
+        this.#messenger.registerActionHandler(`${serviceName}:open`, async (...args) => this.#open(...args));
+        this.#messenger.registerActionHandler(`${serviceName}:close`, (...args) => this.#close(...args));
+        this.#messenger.registerActionHandler(`${serviceName}:sendMessage`, async (...args) => this.#sendMessage(...args));
+        this.#messenger.registerActionHandler(`${serviceName}:getAll`, (...args) => this.#getAll(...args));
+        this.#messenger.subscribe('SnapController:snapUpdated', (snap) => {
+            this.#closeAll(snap.id);
+        });
+        this.#messenger.subscribe('SnapController:snapUninstalled', (snap) => {
+            this.#closeAll(snap.id);
+        });
+        // Due to local Snaps not currently emitting snapUninstalled we also have to
+        // listen to snapInstalled.
+        this.#messenger.subscribe('SnapController:snapInstalled', (snap) => {
+            this.#closeAll(snap.id);
+        });
+    }
+    /**
+     * Get information about a given WebSocket connection with an ID.
+     *
+     * @param snapId - The Snap ID.
+     * @param id - The identifier for the WebSocket connection.
+     * @returns Information abou the WebSocket connection.
+     * @throws If the WebSocket connection cannot be found.
+     */
+    #get(snapId, id) {
+        const socket = this.#sockets.get(id);
+        assert(socket && socket.snapId === snapId, `Socket with ID "${id}" not found.`);
+        return socket;
+    }
+    /**
+     * Check whether a given Snap ID already has an open connection for a URL and protocol.
+     *
+     * @param snapId - The Snap ID.
+     * @param url - The URL.
+     * @param protocols - A protocols parameter.
+     * @returns True if a matching connection already exists, otherwise false.
+     */
+    #exists(snapId, url, protocols) {
+        return this.#getAll(snapId).some((socket) => socket.url === url && isEqual(socket.protocols, protocols));
+    }
+    /**
+     * Handle sending a specific WebSocketEvent to a Snap.
+     *
+     * @param snapId - The Snap ID.
+     * @param event - The WebSocketEvent.
+     */
+    #handleEvent(snapId, event) {
+        this.#messenger
+            .call('SnapController:handleRequest', {
+            origin: METAMASK_ORIGIN,
+            snapId,
+            handler: HandlerType.OnWebSocketEvent,
+            request: { method: '', params: { event } },
+        })
+            .catch((error) => {
+            logError(`An error occurred while handling a WebSocket message for Snap "${snapId}":`, error);
+        });
+    }
+    /**
+     * Open a WebSocket connection.
+     *
+     * @param snapId - The Snap ID.
+     * @param url - The URL for the WebSocket connection.
+     * @param protocols - An optional parameter for protocols.
+     * @returns The identifier for the opened connection.
+     * @throws If the connection fails.
+     */
+    async #open(snapId, url, protocols = []) {
+        assert(!this.#exists(snapId, url, protocols), `An open WebSocket connection to ${url} already exists.`);
+        const parsedUrl = new URL(url);
+        const { origin } = parsedUrl;
+        const id = nanoid();
+        // eslint-disable-next-line no-restricted-globals
+        const socket = new WebSocket(url, protocols);
+        socket.binaryType = 'arraybuffer';
+        const { promise, resolve, reject } = createDeferredPromise();
+        socket.addEventListener('open', () => {
+            resolve();
+            this.#handleEvent(snapId, {
+                type: 'open',
+                id,
+                origin,
+            });
+        });
+        socket.addEventListener('close', (event) => {
+            this.#handleEvent(snapId, {
+                type: 'close',
+                id,
+                origin,
+                code: event.code,
+                reason: event.reason,
+                // wasClean is not available on mobile.
+                wasClean: event.wasClean ?? null,
+            });
+        });
+        const errorListener = () => {
+            reject(rpcErrors.resourceUnavailable('An error occurred while opening the WebSocket.'));
+        };
+        socket.addEventListener('error', errorListener);
+        socket.addEventListener('message', (event) => {
+            const isText = typeof event.data === 'string';
+            const data = isText
+                ? { type: 'text', message: event.data }
+                : {
+                    type: 'binary',
+                    // We request that the WebSocket gives us an array buffer.
+                    message: Array.from(new Uint8Array(event.data)),
+                };
+            this.#handleEvent(snapId, {
+                type: 'message',
+                id,
+                origin,
+                data,
+            });
+        });
+        this.#sockets.set(id, {
+            id,
+            snapId,
+            url,
+            protocols,
+            socket,
+            openPromise: promise,
+        });
+        await promise;
+        socket.removeEventListener('error', errorListener);
+        return id;
+    }
+    /**
+     * Close a given WebSocket connection.
+     *
+     * @param snapId - The Snap ID.
+     * @param id - The identifier for the WebSocket connection.
+     */
+    #close(snapId, id) {
+        const { socket } = this.#get(snapId, id);
+        socket.close();
+        this.#sockets.delete(id);
+    }
+    /**
+     * Close all open connections for a given Snap ID.
+     *
+     * @param snapId - The Snap ID.
+     */
+    #closeAll(snapId) {
+        for (const socket of this.#getAll(snapId)) {
+            this.#close(snapId, socket.id);
+        }
+    }
+    /**
+     * Send a message from a given Snap ID to a WebSocket connection.
+     *
+     * @param snapId - The Snap ID.
+     * @param id - The identifier for the WebSocket connection.
+     * @param data - The message to send.
+     */
+    async #sendMessage(snapId, id, data) {
+        const { socket, openPromise } = this.#get(snapId, id);
+        await openPromise;
+        const wrappedData = Array.isArray(data) ? new Uint8Array(data) : data;
+        socket.send(wrappedData);
+    }
+    /**
+     * Get a list of all open WebSocket connections for a Snap ID.
+     *
+     * @param snapId - The Snap ID.
+     * @returns A list of WebSocket connections.
+     */
+    #getAll(snapId) {
+        return [...this.#sockets.values()]
+            .filter((socket) => socket.snapId === snapId)
+            .map((socket) => ({
+            id: socket.id,
+            url: socket.url,
+            protocols: socket.protocols,
+        }));
+    }
+}
+//# sourceMappingURL=WebSocketService.mjs.map

package/dist/websocket/WebSocketService.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketService.mjs","sourceRoot":"","sources":["../../src/websocket/WebSocketService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAMjD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,8BAA8B;AACvE,OAAO,EAAE,MAAM,EAAE,qBAAqB,EAAE,wBAAwB;AAChE,OAAO,EAAE,MAAM,EAAE,eAAe;AAQhC,OAAO,EAAE,eAAe,EAAE,2BAAiB;AAE3C,MAAM,WAAW,GAAG,kBAAkB,CAAC;AAiEvC,MAAM,OAAO,gBAAgB;IAClB,UAAU,CAA4B;IAEtC,QAAQ,CAA8B;IAE/C,YAAY,EAAE,SAAS,EAAwB;QAC7C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAE1B,IAAI,CAAC,UAAU,CAAC,qBAAqB,CACnC,GAAG,WAAW,OAAO,EACrB,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CACvC,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,GAAG,WAAW,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CACxE,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CACrB,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,qBAAqB,CACnC,GAAG,WAAW,cAAc,EAC5B,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAC9C,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,GAAG,WAAW,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CACzE,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CACtB,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAA4B,EAAE,CAAC,IAAI,EAAE,EAAE;YAC/D,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,gCAAgC,EAAE,CAAC,IAAI,EAAE,EAAE;YACnE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,4EAA4E;QAC5E,2BAA2B;QAC3B,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,8BAA8B,EAAE,CAAC,IAAI,EAAE,EAAE;YACjE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,MAAc,EAAE,EAAU;QAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAErC,MAAM,CACJ,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAClC,mBAAmB,EAAE,cAAc,CACpC,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,MAAc,EAAE,GAAW,EAAE,SAAmB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAC9B,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,MAAc,EAAE,KAAqB;QAChD,IAAI,CAAC,UAAU;aACZ,IAAI,CAAC,8BAA8B,EAAE;YACpC,MAAM,EAAE,eAAe;YACvB,MAAM;YACN,OAAO,EAAE,WAAW,CAAC,gBAAgB;YACrC,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE;SAC3C,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,QAAQ,CACN,kEAAkE,MAAM,IAAI,EAC5E,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CAAC,MAAc,EAAE,GAAW,EAAE,YAAsB,EAAE;QAC/D,MAAM,CACJ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,CAAC,EACrC,mCAAmC,GAAG,kBAAkB,CACzD,CAAC;QAEF,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;QAE7B,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;QAEpB,iDAAiD;QACjD,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC7C,MAAM,CAAC,UAAU,GAAG,aAAa,CAAC;QAElC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAE7D,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE;YACnC,OAAO,EAAE,CAAC;YACV,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;gBACxB,IAAI,EAAE,MAAM;gBACZ,EAAE;gBACF,MAAM;aACP,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACzC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;gBACxB,IAAI,EAAE,OAAO;gBACb,EAAE;gBACF,MAAM;gBACN,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,uCAAuC;gBACvC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI;aACjC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,GAAG,EAAE;YACzB,MAAM,CACJ,SAAS,CAAC,mBAAmB,CAC3B,gDAAgD,CACjD,CACF,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEhD,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3C,MAAM,MAAM,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM;gBACjB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE;gBAChD,CAAC,CAAC;oBACE,IAAI,EAAE,QAAiB;oBACvB,0DAA0D;oBAC1D,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;iBAChD,CAAC;YAEN,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;gBACxB,IAAI,EAAE,SAAS;gBACf,EAAE;gBACF,MAAM;gBACN,IAAI;aACL,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE;YACpB,EAAE;YACF,MAAM;YACN,GAAG;YACH,SAAS;YACT,MAAM;YACN,WAAW,EAAE,OAAO;SACrB,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC;QAEd,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEnD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAc,EAAE,EAAU;QAC/B,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEzC,MAAM,CAAC,KAAK,EAAE,CAAC;QAEf,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAc;QACtB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,MAAc,EAAE,EAAU,EAAE,IAAuB;QACpE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEtD,MAAM,WAAW,CAAC;QAElB,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAEtE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,MAAc;QACpB,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;aAC/B,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC;aAC5C,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAChB,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC,CAAC,CAAC;IACR,CAAC;CACF","sourcesContent":["import type { RestrictedMessenger } from '@metamask/base-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetWebSocketsResult,\n  SnapId,\n  WebSocketEvent,\n} from '@metamask/snaps-sdk';\nimport { HandlerType, isEqual, logError } from '@metamask/snaps-utils';\nimport { assert, createDeferredPromise } from '@metamask/utils';\nimport { nanoid } from 'nanoid';\n\nimport type {\n  HandleSnapRequest,\n  SnapInstalled,\n  SnapUninstalled,\n  SnapUpdated,\n} from '../snaps';\nimport { METAMASK_ORIGIN } from '../snaps';\n\nconst serviceName = 'WebSocketService';\n\nexport type WebSocketServiceOpenAction = {\n  type: `${typeof serviceName}:open`;\n  handler: (\n    snapId: SnapId,\n    url: string,\n    protocols?: string[],\n  ) => Promise<string>;\n};\n\nexport type WebSocketServiceCloseAction = {\n  type: `${typeof serviceName}:close`;\n  handler: (snapId: SnapId, id: string) => void;\n};\n\nexport type WebSocketServiceSendMessageAction = {\n  type: `${typeof serviceName}:sendMessage`;\n  handler: (\n    snapId: SnapId,\n    id: string,\n    data: string | number[],\n  ) => Promise<void>;\n};\n\nexport type WebSocketServiceGetAllAction = {\n  type: `${typeof serviceName}:getAll`;\n  handler: (snapId: SnapId) => GetWebSocketsResult;\n};\n\nexport type WebSocketServiceActions =\n  | WebSocketServiceOpenAction\n  | WebSocketServiceCloseAction\n  | WebSocketServiceSendMessageAction\n  | WebSocketServiceGetAllAction;\n\nexport type WebSocketServiceAllowedActions = HandleSnapRequest;\n\nexport type WebSocketServiceEvents =\n  | SnapUninstalled\n  | SnapUpdated\n  | SnapInstalled;\n\nexport type WebSocketServiceMessenger = RestrictedMessenger<\n  'WebSocketService',\n  WebSocketServiceActions | WebSocketServiceAllowedActions,\n  WebSocketServiceEvents,\n  WebSocketServiceAllowedActions['type'],\n  WebSocketServiceEvents['type']\n>;\n\ntype WebSocketServiceArgs = {\n  messenger: WebSocketServiceMessenger;\n};\n\ntype InternalSocket = {\n  id: string;\n  snapId: SnapId;\n  url: string;\n  protocols: string[];\n  openPromise: Promise<void>;\n  // eslint-disable-next-line no-restricted-globals\n  socket: WebSocket;\n};\n\nexport class WebSocketService {\n  readonly #messenger: WebSocketServiceMessenger;\n\n  readonly #sockets: Map<string, InternalSocket>;\n\n  constructor({ messenger }: WebSocketServiceArgs) {\n    this.#messenger = messenger;\n    this.#sockets = new Map();\n\n    this.#messenger.registerActionHandler(\n      `${serviceName}:open`,\n      async (...args) => this.#open(...args),\n    );\n\n    this.#messenger.registerActionHandler(`${serviceName}:close`, (...args) =>\n      this.#close(...args),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${serviceName}:sendMessage`,\n      async (...args) => this.#sendMessage(...args),\n    );\n\n    this.#messenger.registerActionHandler(`${serviceName}:getAll`, (...args) =>\n      this.#getAll(...args),\n    );\n\n    this.#messenger.subscribe('SnapController:snapUpdated', (snap) => {\n      this.#closeAll(snap.id);\n    });\n\n    this.#messenger.subscribe('SnapController:snapUninstalled', (snap) => {\n      this.#closeAll(snap.id);\n    });\n\n    // Due to local Snaps not currently emitting snapUninstalled we also have to\n    // listen to snapInstalled.\n    this.#messenger.subscribe('SnapController:snapInstalled', (snap) => {\n      this.#closeAll(snap.id);\n    });\n  }\n\n  /**\n   * Get information about a given WebSocket connection with an ID.\n   *\n   * @param snapId - The Snap ID.\n   * @param id - The identifier for the WebSocket connection.\n   * @returns Information abou the WebSocket connection.\n   * @throws If the WebSocket connection cannot be found.\n   */\n  #get(snapId: SnapId, id: string) {\n    const socket = this.#sockets.get(id);\n\n    assert(\n      socket && socket.snapId === snapId,\n      `Socket with ID \"${id}\" not found.`,\n    );\n\n    return socket;\n  }\n\n  /**\n   * Check whether a given Snap ID already has an open connection for a URL and protocol.\n   *\n   * @param snapId - The Snap ID.\n   * @param url - The URL.\n   * @param protocols - A protocols parameter.\n   * @returns True if a matching connection already exists, otherwise false.\n   */\n  #exists(snapId: SnapId, url: string, protocols: string[]) {\n    return this.#getAll(snapId).some(\n      (socket) => socket.url === url && isEqual(socket.protocols, protocols),\n    );\n  }\n\n  /**\n   * Handle sending a specific WebSocketEvent to a Snap.\n   *\n   * @param snapId - The Snap ID.\n   * @param event - The WebSocketEvent.\n   */\n  #handleEvent(snapId: SnapId, event: WebSocketEvent) {\n    this.#messenger\n      .call('SnapController:handleRequest', {\n        origin: METAMASK_ORIGIN,\n        snapId,\n        handler: HandlerType.OnWebSocketEvent,\n        request: { method: '', params: { event } },\n      })\n      .catch((error) => {\n        logError(\n          `An error occurred while handling a WebSocket message for Snap \"${snapId}\":`,\n          error,\n        );\n      });\n  }\n\n  /**\n   * Open a WebSocket connection.\n   *\n   * @param snapId - The Snap ID.\n   * @param url - The URL for the WebSocket connection.\n   * @param protocols - An optional parameter for protocols.\n   * @returns The identifier for the opened connection.\n   * @throws If the connection fails.\n   */\n  async #open(snapId: SnapId, url: string, protocols: string[] = []) {\n    assert(\n      !this.#exists(snapId, url, protocols),\n      `An open WebSocket connection to ${url} already exists.`,\n    );\n\n    const parsedUrl = new URL(url);\n    const { origin } = parsedUrl;\n\n    const id = nanoid();\n\n    // eslint-disable-next-line no-restricted-globals\n    const socket = new WebSocket(url, protocols);\n    socket.binaryType = 'arraybuffer';\n\n    const { promise, resolve, reject } = createDeferredPromise();\n\n    socket.addEventListener('open', () => {\n      resolve();\n      this.#handleEvent(snapId, {\n        type: 'open',\n        id,\n        origin,\n      });\n    });\n\n    socket.addEventListener('close', (event) => {\n      this.#handleEvent(snapId, {\n        type: 'close',\n        id,\n        origin,\n        code: event.code,\n        reason: event.reason,\n        // wasClean is not available on mobile.\n        wasClean: event.wasClean ?? null,\n      });\n    });\n\n    const errorListener = () => {\n      reject(\n        rpcErrors.resourceUnavailable(\n          'An error occurred while opening the WebSocket.',\n        ),\n      );\n    };\n\n    socket.addEventListener('error', errorListener);\n\n    socket.addEventListener('message', (event) => {\n      const isText = typeof event.data === 'string';\n      const data = isText\n        ? { type: 'text' as const, message: event.data }\n        : {\n            type: 'binary' as const,\n            // We request that the WebSocket gives us an array buffer.\n            message: Array.from(new Uint8Array(event.data)),\n          };\n\n      this.#handleEvent(snapId, {\n        type: 'message',\n        id,\n        origin,\n        data,\n      });\n    });\n\n    this.#sockets.set(id, {\n      id,\n      snapId,\n      url,\n      protocols,\n      socket,\n      openPromise: promise,\n    });\n\n    await promise;\n\n    socket.removeEventListener('error', errorListener);\n\n    return id;\n  }\n\n  /**\n   * Close a given WebSocket connection.\n   *\n   * @param snapId - The Snap ID.\n   * @param id - The identifier for the WebSocket connection.\n   */\n  #close(snapId: SnapId, id: string) {\n    const { socket } = this.#get(snapId, id);\n\n    socket.close();\n\n    this.#sockets.delete(id);\n  }\n\n  /**\n   * Close all open connections for a given Snap ID.\n   *\n   * @param snapId - The Snap ID.\n   */\n  #closeAll(snapId: SnapId) {\n    for (const socket of this.#getAll(snapId)) {\n      this.#close(snapId, socket.id);\n    }\n  }\n\n  /**\n   * Send a message from a given Snap ID to a WebSocket connection.\n   *\n   * @param snapId - The Snap ID.\n   * @param id - The identifier for the WebSocket connection.\n   * @param data - The message to send.\n   */\n  async #sendMessage(snapId: SnapId, id: string, data: string | number[]) {\n    const { socket, openPromise } = this.#get(snapId, id);\n\n    await openPromise;\n\n    const wrappedData = Array.isArray(data) ? new Uint8Array(data) : data;\n\n    socket.send(wrappedData);\n  }\n\n  /**\n   * Get a list of all open WebSocket connections for a Snap ID.\n   *\n   * @param snapId - The Snap ID.\n   * @returns A list of WebSocket connections.\n   */\n  #getAll(snapId: SnapId) {\n    return [...this.#sockets.values()]\n      .filter((socket) => socket.snapId === snapId)\n      .map((socket) => ({\n        id: socket.id,\n        url: socket.url,\n        protocols: socket.protocols,\n      }));\n  }\n}\n"]}

package/dist/websocket/index.cjs

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./WebSocketService.cjs"), exports);
+//# sourceMappingURL=index.cjs.map

package/dist/websocket/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/websocket/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAmC","sourcesContent":["export * from './WebSocketService';\n"]}

package/dist/websocket/index.d.cts

@@ -0,0 +1,2 @@
+export * from "./WebSocketService.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/websocket/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/websocket/index.ts"],"names":[],"mappings":"AAAA,uCAAmC"}

package/dist/websocket/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./WebSocketService.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/websocket/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/websocket/index.ts"],"names":[],"mappings":"AAAA,uCAAmC"}

package/dist/websocket/index.mjs

@@ -0,0 +1,2 @@
+export * from "./WebSocketService.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/websocket/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/websocket/index.ts"],"names":[],"mappings":"AAAA,uCAAmC","sourcesContent":["export * from './WebSocketService';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-controllers",
-  "version": "12.3.1",
+  "version": "13.1.0",
   "description": "Controllers for MetaMask Snaps",
   "keywords": [
     "MetaMask",
@@ -87,18 +87,18 @@
     "@metamask/key-tree": "^10.1.1",
     "@metamask/object-multiplex": "^2.1.0",
     "@metamask/permission-controller": "^11.0.6",
-    "@metamask/phishing-controller": "^12.5.0",
+    "@metamask/phishing-controller": "^12.6.0",
     "@metamask/post-message-stream": "^10.0.0",
     "@metamask/rpc-errors": "^7.0.2",
     "@metamask/snaps-registry": "^3.2.3",
-    "@metamask/snaps-rpc-methods": "^12.4.0",
-    "@metamask/snaps-sdk": "^7.1.0",
-    "@metamask/snaps-utils": "^9.4.0",
+    "@metamask/snaps-rpc-methods": "^13.1.0",
+    "@metamask/snaps-sdk": "^8.1.0",
+    "@metamask/snaps-utils": "^10.1.0",
     "@metamask/utils": "^11.4.0",
     "@xstate/fsm": "^2.0.0",
     "async-mutex": "^0.5.0",
-    "browserify-zlib": "^0.2.0",
     "concat-stream": "^2.0.0",
+    "cron-parser": "^4.5.0",
     "fast-deep-equal": "^3.1.3",
     "get-npm-tarball-url": "^2.0.3",
     "immer": "^9.0.6",
@@ -115,8 +115,8 @@
     "@metamask/browser-passworder": "^6.0.0",
     "@metamask/template-snap": "^0.7.0",
     "@noble/hashes": "^1.7.1",
-    "@swc/core": "1.3.78",
-    "@swc/jest": "^0.2.26",
+    "@swc/core": "1.11.31",
+    "@swc/jest": "^0.2.38",
     "@testing-library/dom": "^10.4.0",
     "@ts-bridge/cli": "^0.6.1",
     "@types/chrome": "^0.0.237",
@@ -149,7 +149,7 @@
     "vitest": "^3.1.1"
   },
   "peerDependencies": {
-    "@metamask/snaps-execution-environments": "^8.1.0"
+    "@metamask/snaps-execution-environments": "^9.1.0"
   },
   "peerDependenciesMeta": {
     "@metamask/snaps-execution-environments": {
@@ -157,7 +157,7 @@
     }
   },
   "engines": {
-    "node": "^18.16 || >=20"
+    "node": "^20 || >=22"
   },
   "publishConfig": {
     "access": "public",