@n1xyz/nord-ts 0.0.1 → 0.0.4

package/src/websocket/NordWebSocketClient.ts

@@ -0,0 +1,432 @@
+import WebSocket from 'ws';
+import { EventEmitter } from 'events';
+import {
+  WebSocketMessage,
+  WebSocketMessageType,
+  WebSocketSubscription,
+  WebSocketTradeUpdate,
+  WebSocketDeltaUpdate,
+  WebSocketUserUpdate,
+} from '../types';
+import { NordWebSocketClientEvents } from './events';
+
+// Define a type that works for both Node.js ws and browser WebSocket
+type BrowserWebSocket = {
+  OPEN: number;
+  CONNECTING: number;
+  CLOSING: number;
+  CLOSED: number;
+  readyState: number;
+  send: (data: string) => void;
+  close: () => void;
+  onopen: ((this: any, ev: any) => any) | null;
+  onmessage: ((this: any, ev: { data: any }) => any) | null;
+  onclose: ((this: any, ev: any) => any) | null;
+  onerror: ((this: any, ev: any) => any) | null;
+};
+
+type WebSocketInstance = WebSocket | BrowserWebSocket;
+
+const VALID_STREAM_TYPES = ['trades', 'deltas', 'user'];
+
+// Constants for WebSocket readyState
+const WS_OPEN = 1;
+
+/**
+ * WebSocket client for Nord exchange
+ *
+ * This client connects to one of the specific Nord WebSocket endpoints:
+ * - /ws/trades - For trade updates
+ * - /ws/deltas - For orderbook delta updates
+ * - /ws/user - For user-specific updates
+ *
+ * Each endpoint handles a specific type of data and subscriptions must match
+ * the endpoint type (e.g., only 'trades@BTCUSDC' subscriptions are valid on
+ * the /ws/trades endpoint).
+ */
+export class NordWebSocketClient
+  extends EventEmitter
+  implements NordWebSocketClientEvents
+{
+  private ws: WebSocketInstance | null = null;
+  private url: string;
+  private subscriptions: Set<string> = new Set();
+  private reconnectAttempts: number = 0;
+  private maxReconnectAttempts: number = 5;
+  private reconnectDelay: number = 1000;
+  private pingInterval: NodeJS.Timeout | null = null;
+  private pingTimeout: NodeJS.Timeout | null = null;
+  private isBrowser: boolean;
+
+  /**
+   * Create a new NordWebSocketClient
+   * @param url WebSocket server URL
+   */
+  constructor(url: string) {
+    super();
+    this.url = url;
+    // Check if we're in a browser environment
+    // The most reliable way is to check for Node.js process
+    this.isBrowser =
+      typeof process === 'undefined' ||
+      !process.versions ||
+      !process.versions.node;
+  }
+
+  /**
+   * Validate stream format
+   * @param stream Stream identifier to validate
+   * @throws Error if stream format is invalid
+   */
+  private validateStream(stream: string): void {
+    const [type, params] = stream.split('@');
+
+    if (!type || !params) {
+      throw new Error(
+        `Invalid stream format: ${stream}. Expected format: <type>@<params>`,
+      );
+    }
+
+    // Extract the endpoint from the URL
+    const urlPath = new URL(this.url).pathname;
+    const endpoint = urlPath.split('/').pop();
+
+    // Ensure the stream type matches the endpoint we're connected to
+    if (endpoint && type !== endpoint) {
+      throw new Error(
+        `Stream type '${type}' doesn't match the connected endpoint '${endpoint}'`,
+      );
+    }
+
+    if (!VALID_STREAM_TYPES.includes(type)) {
+      throw new Error(
+        `Invalid stream type: ${type}. Valid types are: ${VALID_STREAM_TYPES.join(', ')}`,
+      );
+    }
+
+    if (type === 'user' && !/^\d+$/.test(params)) {
+      throw new Error(
+        `Invalid user ID in stream: ${params}. Expected numeric ID`,
+      );
+    }
+  }
+
+  /**
+   * Setup WebSocket ping/pong heartbeat
+   */
+  private setupHeartbeat(): void {
+    if (this.pingInterval) {
+      clearInterval(this.pingInterval);
+    }
+    if (this.pingTimeout) {
+      clearTimeout(this.pingTimeout);
+    }
+
+    // In browser, we rely on the browser's WebSocket implementation to handle ping/pong
+    if (this.isBrowser) {
+      return;
+    }
+
+    this.pingInterval = setInterval(() => {
+      if (this.ws && !this.isBrowser) {
+        // Only use ping() method in Node.js environment
+        (this.ws as WebSocket).ping();
+
+        // Set timeout for pong response
+        this.pingTimeout = setTimeout(() => {
+          this.emit('error', new Error('WebSocket ping timeout'));
+          this.close();
+          this.reconnect();
+        }, 5000); // 5 second timeout
+      }
+    }, 30000); // Send ping every 30 seconds
+  }
+
+  /**
+   * Get the appropriate WebSocket class based on environment
+   */
+  private getWebSocketClass(): any {
+    if (this.isBrowser) {
+      // In browser environments
+      // @ts-ignore - Check for WebSocket in globalThis
+      if (typeof globalThis !== 'undefined' && globalThis.WebSocket) {
+        // @ts-ignore - Return WebSocket from globalThis
+        return globalThis.WebSocket;
+      }
+      throw new Error('WebSocket is not available in this environment');
+    } else {
+      // In Node.js
+      return WebSocket;
+    }
+  }
+
+  /**
+   * Connect to the Nord WebSocket server
+   */
+  public connect(): void {
+    if (this.ws) {
+      return;
+    }
+
+    try {
+      const WebSocketClass = this.getWebSocketClass();
+
+      if (this.isBrowser) {
+        // Browser WebSocket setup
+        this.ws = new WebSocketClass(this.url) as BrowserWebSocket;
+
+        (this.ws as BrowserWebSocket).onopen = () => {
+          this.emit('connected');
+          this.reconnectAttempts = 0;
+          this.reconnectDelay = 1000;
+
+          // Resubscribe to previous subscriptions
+          if (this.subscriptions.size > 0) {
+            this.subscribe([...this.subscriptions]);
+          }
+        };
+
+        (this.ws as BrowserWebSocket).onmessage = (event: { data: any }) => {
+          try {
+            const message = JSON.parse(
+              event.data as string,
+            ) as WebSocketMessage;
+            this.handleMessage(message);
+          } catch (error) {
+            this.emit(
+              'error',
+              new Error(
+                `Failed to parse message: ${error instanceof Error ? error.message : String(error)}`,
+              ),
+            );
+          }
+        };
+
+        (this.ws as BrowserWebSocket).onclose = (event: any) => {
+          const reason =
+            event && event.reason ? ` Reason: ${event.reason}` : '';
+          const code = event && event.code ? ` Code: ${event.code}` : '';
+          this.emit('disconnected');
+          console.log(`WebSocket closed.${code}${reason}`);
+          this.reconnect();
+        };
+
+        (this.ws as BrowserWebSocket).onerror = (event: any) => {
+          const errorMsg = `WebSocket error: ${event && event.type ? event.type : 'unknown'}`;
+          console.error(errorMsg, event);
+          this.emit('error', new Error(errorMsg));
+        };
+      } else {
+        // Node.js WebSocket setup
+        const nodeWs = new WebSocketClass(this.url) as WebSocket;
+        this.ws = nodeWs;
+
+        nodeWs.on('open', () => {
+          this.emit('connected');
+          this.reconnectAttempts = 0;
+          this.reconnectDelay = 1000;
+          this.setupHeartbeat();
+
+          // Resubscribe to previous subscriptions
+          if (this.subscriptions.size > 0) {
+            this.subscribe([...this.subscriptions]);
+          }
+        });
+
+        nodeWs.on('message', (data: WebSocket.Data) => {
+          try {
+            const message = JSON.parse(data.toString()) as WebSocketMessage;
+            this.handleMessage(message);
+          } catch (error) {
+            this.emit(
+              'error',
+              new Error(
+                `Failed to parse message: ${error instanceof Error ? error.message : String(error)}`,
+              ),
+            );
+          }
+        });
+
+        nodeWs.on('close', (code: number, reason: string) => {
+          this.emit('disconnected');
+          console.log(`WebSocket closed. Code: ${code} Reason: ${reason}`);
+          if (this.pingInterval) {
+            clearInterval(this.pingInterval);
+          }
+          if (this.pingTimeout) {
+            clearTimeout(this.pingTimeout);
+          }
+          this.reconnect();
+        });
+
+        nodeWs.on('error', (error: Error) => {
+          console.error('WebSocket error:', error);
+          this.emit('error', error);
+        });
+
+        nodeWs.on('pong', () => {
+          if (this.pingTimeout) {
+            clearTimeout(this.pingTimeout);
+          }
+        });
+      }
+    } catch (error) {
+      const errorMsg = `Failed to initialize WebSocket: ${error instanceof Error ? error.message : String(error)}`;
+      console.error(errorMsg);
+      this.emit('error', new Error(errorMsg));
+    }
+  }
+
+  /**
+   * Subscribe to one or more streams
+   * @param streams Array of streams to subscribe to (e.g. ["trades@BTCUSDC", "deltas@BTCUSDC"])
+   */
+  public subscribe(streams: string[]): void {
+    // Validate all streams first
+    try {
+      streams.forEach((stream) => this.validateStream(stream));
+    } catch (error) {
+      this.emit(
+        'error',
+        error instanceof Error ? error : new Error(String(error)),
+      );
+      return;
+    }
+
+    if (
+      !this.ws ||
+      (this.isBrowser
+        ? (this.ws as BrowserWebSocket).readyState !== WS_OPEN
+        : (this.ws as WebSocket).readyState !== WebSocket.OPEN)
+    ) {
+      streams.forEach((stream) => this.subscriptions.add(stream));
+      return;
+    }
+
+    const message: WebSocketSubscription = {
+      type: WebSocketMessageType.Subscribe,
+      streams,
+    };
+
+    try {
+      const messageStr = JSON.stringify(message);
+      if (this.isBrowser) {
+        (this.ws as BrowserWebSocket).send(messageStr);
+      } else {
+        (this.ws as WebSocket).send(messageStr);
+      }
+      streams.forEach((stream) => this.subscriptions.add(stream));
+    } catch (error) {
+      this.emit(
+        'error',
+        error instanceof Error ? error : new Error(String(error)),
+      );
+    }
+  }
+
+  /**
+   * Unsubscribe from one or more streams
+   * @param streams Array of streams to unsubscribe from
+   */
+  public unsubscribe(streams: string[]): void {
+    // Validate all streams first
+    try {
+      streams.forEach((stream) => this.validateStream(stream));
+    } catch (error) {
+      this.emit(
+        'error',
+        error instanceof Error ? error : new Error(String(error)),
+      );
+      return;
+    }
+
+    if (
+      !this.ws ||
+      (this.isBrowser
+        ? (this.ws as BrowserWebSocket).readyState !== WS_OPEN
+        : (this.ws as WebSocket).readyState !== WebSocket.OPEN)
+    ) {
+      streams.forEach((stream) => this.subscriptions.delete(stream));
+      return;
+    }
+
+    const message: WebSocketSubscription = {
+      type: WebSocketMessageType.Unsubscribe,
+      streams,
+    };
+
+    try {
+      const messageStr = JSON.stringify(message);
+      if (this.isBrowser) {
+        (this.ws as BrowserWebSocket).send(messageStr);
+      } else {
+        (this.ws as WebSocket).send(messageStr);
+      }
+      streams.forEach((stream) => this.subscriptions.delete(stream));
+    } catch (error) {
+      this.emit(
+        'error',
+        error instanceof Error ? error : new Error(String(error)),
+      );
+    }
+  }
+
+  /**
+   * Close the WebSocket connection
+   */
+  public close(): void {
+    if (this.ws) {
+      if (this.isBrowser) {
+        (this.ws as BrowserWebSocket).close();
+      } else {
+        (this.ws as WebSocket).close();
+      }
+      this.ws = null;
+    }
+    if (this.pingInterval) {
+      clearInterval(this.pingInterval);
+      this.pingInterval = null;
+    }
+    if (this.pingTimeout) {
+      clearTimeout(this.pingTimeout);
+      this.pingTimeout = null;
+    }
+    this.subscriptions.clear();
+  }
+
+  /**
+   * Handle incoming WebSocket messages
+   * @param message WebSocket message
+   */
+  private handleMessage(message: WebSocketMessage): void {
+    switch (message.type) {
+      case WebSocketMessageType.TradeUpdate:
+        this.emit('trade', message as WebSocketTradeUpdate);
+        break;
+      case WebSocketMessageType.DeltaUpdate:
+        this.emit('delta', message as WebSocketDeltaUpdate);
+        break;
+      case WebSocketMessageType.UserUpdate:
+        this.emit('user', message as WebSocketUserUpdate);
+        break;
+      default:
+        this.emit('error', new Error(`Unknown message type: ${message.type}`));
+    }
+  }
+
+  /**
+   * Attempt to reconnect to the WebSocket server
+   */
+  private reconnect(): void {
+    if (this.reconnectAttempts >= this.maxReconnectAttempts) {
+      this.emit('error', new Error('Max reconnection attempts reached'));
+      return;
+    }
+
+    setTimeout(() => {
+      this.reconnectAttempts++;
+      this.reconnectDelay *= 2; // Exponential backoff
+      this.connect();
+    }, this.reconnectDelay);
+  }
+}

package/src/websocket/events.ts

@@ -0,0 +1,31 @@
+import {
+  WebSocketTradeUpdate,
+  WebSocketDeltaUpdate,
+  WebSocketUserUpdate,
+} from '../types';
+
+/**
+ * Event type definitions for the NordWebSocketClient
+ */
+export interface NordWebSocketEvents {
+  connected: () => void;
+  disconnected: () => void;
+  error: (error: Error) => void;
+  trade: (update: WebSocketTradeUpdate) => void;
+  delta: (update: WebSocketDeltaUpdate) => void;
+  user: (update: WebSocketUserUpdate) => void;
+}
+
+/**
+ * Type declaration for NordWebSocketClient event methods
+ */
+export declare interface NordWebSocketClientEvents {
+  on<E extends keyof NordWebSocketEvents>(
+    event: E,
+    listener: NordWebSocketEvents[E],
+  ): this;
+  emit<E extends keyof NordWebSocketEvents>(
+    event: E,
+    ...args: Parameters<NordWebSocketEvents[E]>
+  ): boolean;
+}

package/src/websocket/index.ts

@@ -0,0 +1,2 @@
+export { NordWebSocketClient } from './NordWebSocketClient';
+export { NordWebSocketEvents, NordWebSocketClientEvents } from './events';

package/tests/utils.spec.ts

@@ -1,15 +1,15 @@
-import { describe, it, expect } from "@jest/globals";
+import { describe, it, expect } from '@jest/globals';
 import {
   bigIntToProtoU128,
   toScaledU64,
   toScaledU128,
   encodeLengthDelimited,
   decodeLengthDelimited,
-} from "../src/utils";
-import Decimal from "decimal.js";
-import * as proto from "../src/gen/nord";
+} from '../src/utils';
+import Decimal from 'decimal.js';
+import * as proto from '../src/gen/nord';
 
-describe("toScaledU64", () => {
+describe('toScaledU64', () => {
   // Used as scaling medium
   const D64 = Decimal.clone({
     precision: 20,
@@ -35,12 +35,12 @@ describe("toScaledU64", () => {
   });
 
   const failure: Array<[Decimal.Value, number, string]> = [
-    [-1, 0, "Number is negative"],
-    [-1000, 2, "Number is negative"],
-    [0.1, 0, "Precision loss"],
-    [0.0001, 3, "Precision loss"],
-    [MaxDec.add(1), 0, "Integer is out of range"],
-    [MaxDec.add(1).div(1000), 3, "Integer is out of range"],
+    [-1, 0, 'Number is negative'],
+    [-1000, 2, 'Number is negative'],
+    [0.1, 0, 'Precision loss'],
+    [0.0001, 3, 'Precision loss'],
+    [MaxDec.add(1), 0, 'Integer is out of range'],
+    [MaxDec.add(1).div(1000), 3, 'Integer is out of range'],
   ];
 
   failure.forEach((sample) => {
@@ -50,7 +50,7 @@ describe("toScaledU64", () => {
   });
 });
 
-describe("toScaledU128", () => {
+describe('toScaledU128', () => {
   // Used as scaling medium
   const D128 = Decimal.clone({
     precision: 40,
@@ -76,12 +76,12 @@ describe("toScaledU128", () => {
   });
 
   const failure: Array<[Decimal.Value, number, string]> = [
-    [-1, 0, "Number is negative"],
-    [-1000, 2, "Number is negative"],
-    [0.1, 0, "Precision loss"],
-    [0.0001, 3, "Precision loss"],
-    [MaxDec.add(1), 0, "Integer is out of range"],
-    [MaxDec.add(1).div(1000), 3, "Integer is out of range"],
+    [-1, 0, 'Number is negative'],
+    [-1000, 2, 'Number is negative'],
+    [0.1, 0, 'Precision loss'],
+    [0.0001, 3, 'Precision loss'],
+    [MaxDec.add(1), 0, 'Integer is out of range'],
+    [MaxDec.add(1).div(1000), 3, 'Integer is out of range'],
   ];
 
   failure.forEach((sample) => {
@@ -94,7 +94,7 @@ describe("toScaledU128", () => {
 const U64_MAX = (1n << 64n) - 1n;
 const U128_MAX = (1n << 128n) - 1n;
 
-describe("bigIntToProtoU128", () => {
+describe('bigIntToProtoU128', () => {
   const success: Array<[bigint, { lo: bigint; hi: bigint }]> = [
     [0n, { lo: 0n, hi: 0n }],
     [1n, { lo: 1n, hi: 0n }],
@@ -112,8 +112,8 @@ describe("bigIntToProtoU128", () => {
   });
 
   const failure: Array<[bigint, string]> = [
-    [-1n, "Negative number"],
-    [U128_MAX + 1n, "U128 overflow"],
+    [-1n, 'Negative number'],
+    [U128_MAX + 1n, 'U128 overflow'],
   ];
 
   failure.forEach((sample, index) => {
@@ -123,12 +123,12 @@ describe("bigIntToProtoU128", () => {
   });
 });
 
-describe("proto.Action encode-decode loop", () => {
+describe('proto.Action encode-decode loop', () => {
   const action: proto.Action = {
     currentTimestamp: 0n,
     nonce: 0,
     kind: {
-      $case: "placeOrder",
+      $case: 'placeOrder',
       value: {
         sessionId: 42n,
         marketId: 9,
@@ -145,7 +145,7 @@ describe("proto.Action encode-decode loop", () => {
     },
   };
 
-  it("action encode-decode roundabout should succeed", () => {
+  it('action encode-decode roundabout should succeed', () => {
     const encoded = encodeLengthDelimited(action, proto.Action);
     const decoded: proto.Action = decodeLengthDelimited(encoded, proto.Action);
 

package/docs/classes/Subscriber.html

@@ -1,6 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Subscriber | @layer-n/nord-ts</title><meta name="description" content="Documentation for @layer-n/nord-ts"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@layer-n/nord-ts</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@layer-n/nord-ts</a></li><li><a href="Subscriber.html">Subscriber</a></li></ul><h1>Class Subscriber</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/381766a/src/nord/Nord.ts#L454">nord/Nord.ts:454</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Subscriber.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
-</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Subscriber.html#buffer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>buffer</span></a>
-<a href="Subscriber.html#maxBufferLen" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Buffer<wbr/>Len</span></a>
-<a href="Subscriber.html#streamURL" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>streamURL</span></a>
-</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Subscriber.html#subscribe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe</span></a>
-</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Subscriber" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Subscriber</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Subscriber.html" class="tsd-signature-type tsd-kind-class">Subscriber</a><a href="#constructor.new_Subscriber" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <a href="../interfaces/SubscriberConfig.html" class="tsd-signature-type tsd-kind-interface">SubscriberConfig</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Subscriber.html" class="tsd-signature-type tsd-kind-class">Subscriber</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/381766a/src/nord/Nord.ts#L459">nord/Nord.ts:459</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="buffer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>buffer</span><a href="#buffer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">buffer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><a href="../interfaces/DeltaEvent.html" class="tsd-signature-type tsd-kind-interface">DeltaEvent</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Trades.html" class="tsd-signature-type tsd-kind-interface">Trades</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Account.html" class="tsd-signature-type tsd-kind-interface">Account</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/381766a/src/nord/Nord.ts#L456">nord/Nord.ts:456</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="maxBufferLen" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>max<wbr/>Buffer<wbr/>Len</span><a href="#maxBufferLen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">max<wbr/>Buffer<wbr/>Len</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/381766a/src/nord/Nord.ts#L457">nord/Nord.ts:457</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="streamURL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>streamURL</span><a href="#streamURL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">streamURL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/381766a/src/nord/Nord.ts#L455">nord/Nord.ts:455</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe</span><a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="subscribe.subscribe-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subscribe</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#subscribe.subscribe-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/381766a/src/nord/Nord.ts#L465">nord/Nord.ts:465</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#buffer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>buffer</span></a><a href="#maxBufferLen" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Buffer<wbr/>Len</span></a><a href="#streamURL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>streamURL</span></a><a href="#subscribe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@layer-n/nord-ts</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>

package/docs/functions/createWebSocketSubscription.html

@@ -1,12 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createWebSocketSubscription | @layer-n/nord-ts</title><meta name="description" content="Documentation for @layer-n/nord-ts"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@layer-n/nord-ts</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@layer-n/nord-ts</a></li><li><a href="createWebSocketSubscription.html">createWebSocketSubscription</a></li></ul><h1>Function createWebSocketSubscription</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createWebSocketSubscription" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Web<wbr/>Socket<wbr/>Subscription</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">baseUrl</span>, <span class="tsd-kind-parameter">streams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Subscriber.html" class="tsd-signature-type tsd-kind-class">Subscriber</a><a href="#createWebSocketSubscription" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a WebSocket subscription to specified streams</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">baseUrl</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Base URL of the API</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">streams</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Array of streams to subscribe to</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/Subscriber.html" class="tsd-signature-type tsd-kind-class">Subscriber</a></h4><p>A Subscriber instance</p>
-<p>Syntax for streams:</p>
-<ul>
-<li>trades@<symbol>: Subscribe to trades for a market</li>
-<li>deltas@<symbol>: Subscribe to orderbook deltas for a market</li>
-<li>user@<user id>: Subscribe to user account updates</li>
-</ul>
-<p>Example: createWebSocketSubscription(&#39;<a href="https://alpha-api.layern.network">https://alpha-api.layern.network</a>&#39;, [&#39;trades@BTCUSDC&#39;, &#39;deltas@BTCUSDC&#39;, &#39;user@0&#39;])</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/381766a/src/nord/Nord.ts#L494">nord/Nord.ts:494</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@layer-n/nord-ts</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>