@reclaimprotocol/attestor-core 5.0.1-beta.2 → 5.0.1-beta.22

package/lib/utils/socket-base.js

@@ -1,96 +1,92 @@
 import { wsMessageHandler } from "../client/utils/message-handler.js";
 import { RPCMessages } from "../proto/api.js";
-import { AttestorError, makeRpcEvent, packRpcMessages } from "../utils/index.js";
-class AttestorSocket {
-  eventTarget = new EventTarget();
-  socket;
-  logger;
-  metadata;
-  isInitialised = false;
-  constructor(socket, metadata, logger) {
-    this.socket = socket;
-    this.metadata = metadata;
-    this.logger = logger;
-    socket.addEventListener("error", (event) => {
-      const witErr = AttestorError.fromError(
-        event.error || new Error(event.message),
-        "ERROR_NETWORK_ERROR"
-      );
-      this.dispatchRPCEvent("connection-terminated", witErr);
-    });
-    socket.addEventListener("close", () => this.dispatchRPCEvent(
-      "connection-terminated",
-      new AttestorError(
-        "ERROR_NO_ERROR",
-        "connection closed"
-      )
-    ));
-    socket.addEventListener("message", async (event) => {
-      try {
-        await wsMessageHandler.call(this, event.data);
-      } catch (err) {
-        this.logger.error({ err }, "error processing message");
-      }
-    });
-  }
-  get isOpen() {
-    return this.socket.readyState === this.socket.OPEN;
-  }
-  get isClosed() {
-    return this.socket.readyState === this.socket.CLOSED || this.socket.readyState === this.socket.CLOSING;
-  }
-  async sendMessage(...msgs) {
-    if (this.isClosed) {
-      throw new AttestorError(
-        "ERROR_NETWORK_ERROR",
-        "Connection closed, cannot send message"
-      );
+import { AttestorError, makeRpcEvent, packRpcMessages } from "./index.js";
+/**
+ * Common AttestorSocket class used on the client & server side as the
+ * base for their respective socket implementations.
+ */
+export class AttestorSocket {
+    eventTarget = new EventTarget();
+    socket;
+    logger;
+    metadata;
+    isInitialised = false;
+    constructor(socket, metadata, logger) {
+        this.socket = socket;
+        this.metadata = metadata;
+        this.logger = logger;
+        // @ts-expect-error - WebSocket type differs between browser and Node.js
+        socket.addEventListener('error', (event) => {
+            const witErr = AttestorError.fromError(event.error || new Error(event.message), 'ERROR_NETWORK_ERROR');
+            this.dispatchRPCEvent('connection-terminated', witErr);
+        });
+        socket.addEventListener('close', () => (this.dispatchRPCEvent('connection-terminated', new AttestorError('ERROR_NO_ERROR', 'connection closed'))));
+        // @ts-expect-error - WebSocket type differs between browser and Node.js
+        socket.addEventListener('message', async (event) => {
+            try {
+                await wsMessageHandler.call(this, event.data);
+            }
+            catch (err) {
+                this.logger.error({ err }, 'error processing message');
+            }
+        });
     }
-    if (!this.isOpen) {
-      throw new AttestorError(
-        "ERROR_NETWORK_ERROR",
-        "Wait for connection to open before sending message"
-      );
+    get isOpen() {
+        return this.socket.readyState === this.socket.OPEN;
     }
-    const msg = packRpcMessages(...msgs);
-    const bytes = RPCMessages.encode(msg).finish();
-    this.logger.trace({ msg }, "sending messages");
-    if ("sendPromise" in this.socket && this.socket.sendPromise) {
-      await this.socket.sendPromise(bytes);
-    } else {
-      this.socket.send(bytes);
+    get isClosed() {
+        return this.socket.readyState === this.socket.CLOSED
+            || this.socket.readyState === this.socket.CLOSING;
     }
-    return msg;
-  }
-  dispatchRPCEvent(type, data) {
-    const event = makeRpcEvent(type, data);
-    this.eventTarget.dispatchEvent(event);
-  }
-  addEventListener(type, listener) {
-    this.eventTarget.addEventListener(type, listener);
-  }
-  removeEventListener(type, listener) {
-    this.eventTarget.removeEventListener(type, listener);
-  }
-  async terminateConnection(err) {
-    if (this.isClosed) {
-      return;
+    async sendMessage(...msgs) {
+        if (this.isClosed) {
+            throw new AttestorError('ERROR_NETWORK_ERROR', 'Connection closed, cannot send message');
+        }
+        if (!this.isOpen) {
+            throw new AttestorError('ERROR_NETWORK_ERROR', 'Wait for connection to open before sending message');
+        }
+        const msg = packRpcMessages(...msgs);
+        const bytes = RPCMessages.encode(msg).finish();
+        this.logger.trace({ msg }, 'sending messages');
+        if ('sendPromise' in this.socket && this.socket.sendPromise) {
+            await this.socket.sendPromise(bytes);
+        }
+        else {
+            this.socket.send(bytes);
+        }
+        return msg;
     }
-    try {
-      const witErr = err ? AttestorError.fromError(err) : new AttestorError("ERROR_NO_ERROR", "");
-      this.dispatchRPCEvent("connection-terminated", witErr);
-      if (this.isOpen) {
-        await this.sendMessage({
-          connectionTerminationAlert: witErr.toProto()
-        });
-      }
-    } catch (err2) {
-      this.logger?.error({ err: err2 }, "error terminating connection");
-    } finally {
-      this.socket.close();
+    dispatchRPCEvent(type, data) {
+        const event = makeRpcEvent(type, data);
+        this.eventTarget.dispatchEvent(event);
+    }
+    addEventListener(type, listener) {
+        this.eventTarget.addEventListener(type, listener);
+    }
+    removeEventListener(type, listener) {
+        this.eventTarget.removeEventListener(type, listener);
+    }
+    async terminateConnection(err) {
+        // connection already closed
+        if (this.isClosed) {
+            return;
+        }
+        try {
+            const witErr = err
+                ? AttestorError.fromError(err)
+                : new AttestorError('ERROR_NO_ERROR', '');
+            this.dispatchRPCEvent('connection-terminated', witErr);
+            if (this.isOpen) {
+                await this.sendMessage({
+                    connectionTerminationAlert: witErr.toProto()
+                });
+            }
+        }
+        catch (err) {
+            this.logger?.error({ err }, 'error terminating connection');
+        }
+        finally {
+            this.socket.close();
+        }
     }
-  }
 }
-export {
-  AttestorSocket
-};

package/lib/utils/tls.js

@@ -1,23 +1,27 @@
-import { SUPPORTED_NAMED_CURVES } from "@reclaimprotocol/tls";
-import { detectEnvironment } from "../utils/env.js";
+import { SUPPORTED_NAMED_CURVES } from '@reclaimprotocol/tls';
+import { detectEnvironment } from "./env.js";
+// we only support the following cipher suites
+// for ZK proof generation
 const ZK_CIPHER_SUITES = [
-  // chacha-20
-  "TLS_CHACHA20_POLY1305_SHA256",
-  "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256",
-  "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256",
-  // aes-256
-  "TLS_AES_256_GCM_SHA384",
-  "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
-  "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
-  // aes-128
-  "TLS_AES_128_GCM_SHA256",
-  "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
-  "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
-  "TLS_RSA_WITH_AES_128_GCM_SHA256"
+    // chacha-20
+    'TLS_CHACHA20_POLY1305_SHA256',
+    'TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256',
+    'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256',
+    // aes-256
+    'TLS_AES_256_GCM_SHA384',
+    'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384',
+    'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384',
+    // aes-128
+    'TLS_AES_128_GCM_SHA256',
+    'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256',
+    'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256',
+    'TLS_RSA_WITH_AES_128_GCM_SHA256'
 ];
-const NAMED_CURVE_LIST = detectEnvironment() === "node" ? SUPPORTED_NAMED_CURVES : SUPPORTED_NAMED_CURVES.filter((c) => c !== "X25519");
-TLS_ADDITIONAL_ROOT_CA_LIST.push(
-  `-----BEGIN CERTIFICATE-----
+const NAMED_CURVE_LIST = detectEnvironment() === 'node'
+    ? SUPPORTED_NAMED_CURVES
+    // X25519 is not supported in the browser
+    : SUPPORTED_NAMED_CURVES.filter(c => c !== 'X25519');
+TLS_ADDITIONAL_ROOT_CA_LIST.push(`-----BEGIN CERTIFICATE-----
 MIIEszCCA5ugAwIBAgIQCyWUIs7ZgSoVoE6ZUooO+jANBgkqhkiG9w0BAQsFADBh
 MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3
 d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBH
@@ -44,15 +48,11 @@ CTq4G+zb43X1T77nJgSOI9pq/TqCwtukZ7u9VLL3JAq3Wdy2moKLvvC8tVmRzkAe
 zP3pGJ9FCbMHmMLLyuBd+uCWvVcF2ogYAawufChS/PT61D9rqzPRS5I2uqa3tmIT
 44JhJgWhBnFMb7AGQkvNq9KNS9dd3GWc17H/dXa1enoxzWjE0hBdFjxPhUb0W3wi
 8o34/m8Fxw==
------END CERTIFICATE-----`
-  //RapidSSL TLS RSA CA G1
+-----END CERTIFICATE-----` //RapidSSL TLS RSA CA G1
 );
-function getDefaultTlsOptions() {
-  return {
-    cipherSuites: ZK_CIPHER_SUITES,
-    namedCurves: NAMED_CURVE_LIST
-  };
+export function getDefaultTlsOptions() {
+    return {
+        cipherSuites: ZK_CIPHER_SUITES,
+        namedCurves: NAMED_CURVE_LIST,
+    };
 }
-export {
-  getDefaultTlsOptions
-};

package/lib/utils/ws.js

@@ -1,22 +1,22 @@
-function makeWebSocket(url) {
-  return new WebSocket(url);
+export function makeWebSocket(url) {
+    return new WebSocket(url);
 }
-function promisifySend(ws) {
-  if (ws.sendPromise) {
+/**
+ * Adds the "sendPromise" fn to the given WebSocket instance,
+ * if not already present.
+ */
+export function promisifySend(ws) {
+    if (ws.sendPromise) {
+        return ws;
+    }
+    ws.sendPromise = (data) => (new Promise((resolve, reject) => {
+        ws.send(data, err => {
+            if (err) {
+                reject(err);
+                return;
+            }
+            resolve();
+        });
+    }));
     return ws;
-  }
-  ws.sendPromise = (data) => new Promise((resolve, reject) => {
-    ws.send(data, (err) => {
-      if (err) {
-        reject(err);
-        return;
-      }
-      resolve();
-    });
-  });
-  return ws;
 }
-export {
-  makeWebSocket,
-  promisifySend
-};