@xapy/orderbook 0.1.0

package/README.md

@@ -0,0 +1,134 @@
+# @xapy/orderbook
+
+Lightweight multi-exchange orderbook SDK — REST snapshot + WebSocket maintained stream.
+
+## Install
+
+```bash
+npm i @xapy/orderbook
+# Optional, only needed on Node < 22:
+npm i ws
+```
+
+## Usage
+
+```ts
+import { BybitClient } from "@xapy/orderbook/bybit";
+
+const bybit = new BybitClient({ market: "perpetual" });
+
+// One-shot REST snapshot
+const snapshot = await bybit.fetchOrderbook("BTC/USDT", { depth: 50 });
+console.log(snapshot.bids[0], snapshot.asks[0]);
+
+// Maintained live stream (snapshot + deltas → always the latest book)
+const stream = bybit.streamOrderbook("BTC/USDT", { depth: 50 });
+stream.on("update", (book) => {
+  console.log(book.exchange, book.symbol, book.bids[0], book.asks[0]);
+});
+stream.on("reconnecting", (attempt, waitMs) => {
+  console.log(`reconnect attempt ${attempt} in ${waitMs}ms`);
+});
+
+// Or async-iterator
+for await (const book of stream.iter()) {
+  console.log(book.sequence, book.bids[0]);
+}
+
+stream.close();
+```
+
+### Browser + CORS
+
+Several exchanges block direct browser requests. Use `transformUrl` to route through your proxy:
+
+```ts
+const bybit = new BybitClient({
+  market: "perpetual",
+  transformUrl: (url) =>
+    `https://my-proxy.example/${url.replace(/^https?:\/\//, "")}`,
+});
+```
+
+WebSocket connections are not subject to CORS and work directly in the browser.
+
+## What you get
+
+- **Maintained orderbook** — the lib applies WS deltas internally; consumers always see a sorted, latest snapshot.
+- **Gap recovery** — sequence numbers are verified; on a gap the lib re-fetches a REST snapshot and resumes without you noticing.
+- **Auto-reconnect** — exponential backoff with jitter; the subscription replays on each reconnect.
+- **Cross-runtime** — Node ≥ 18 (with `ws` peer for < 22) and modern browsers.
+- **Tree-shakeable** — `import "@xapy/orderbook/bybit"` doesn't pull in other adapters.
+
+## Supported exchanges
+
+| Exchange | Spot | Perpetual | Status |
+| --- | --- | --- | --- |
+| Bybit | ✅ | ✅ | available (0.1) |
+| OKX | | | planned (0.2) |
+| Bitget | | | planned (0.2) |
+| Gate | | | planned (0.3) |
+| CoinEx | | | planned (0.3) |
+| BingX | | | planned (0.4) |
+| Huobi | | | planned (0.4) |
+| KuCoin | | | planned (0.5) |
+
+## API
+
+### `new BybitClient(options)`
+
+```ts
+interface ClientOptions {
+  market: "spot" | "perpetual";
+  transformUrl?: (url: string) => string;
+  timeoutMs?: number; // default 10_000
+}
+```
+
+### `client.fetchOrderbook(symbol, opts?)`
+
+REST snapshot. Returns a `Promise<Orderbook>`.
+
+### `client.streamOrderbook(symbol, opts?)`
+
+WebSocket stream. Returns an `OrderbookStream` exposing:
+
+```ts
+stream.on("update",       (book: Orderbook) => {});
+stream.on("connected",    () => {});
+stream.on("disconnected", (reason?: string) => {});
+stream.on("reconnecting", (attempt: number, waitMs: number) => {});
+stream.on("error",        (err: Error) => {});
+
+for await (const book of stream.iter()) { /* … */ }
+
+stream.close();
+```
+
+### `Orderbook` shape
+
+```ts
+interface Orderbook {
+  exchange: ExchangeName;
+  symbol: string;          // "BTC/USDT"
+  market: "spot" | "perpetual";
+  bids: { price: number; size: number }[]; // descending
+  asks: { price: number; size: number }[]; // ascending
+  timestamp: number;       // ms epoch
+  sequence: number;        // last applied seq
+}
+```
+
+Sizes are in **base coin** (e.g. BTC). Conversion to quote (USDT) is left to the caller.
+
+## Development
+
+```bash
+npm install
+npm run build
+npm test
+```
+
+## License
+
+MIT

package/dist/exchanges/bingx/index.cjs

@@ -0,0 +1,559 @@
+'use strict';
+
+// src/core/symbol.ts
+function parseSymbol(symbol) {
+  const [pair, settle] = symbol.split(":");
+  const parts = (pair ?? "").split("/");
+  const base = parts[0]?.toUpperCase();
+  const quote = parts[1]?.toUpperCase();
+  if (!base || !quote) {
+    throw new Error(
+      `invalid symbol "${symbol}" \u2014 expected "BASE/QUOTE" or "BASE/QUOTE:SETTLE"`
+    );
+  }
+  if (settle && settle.toUpperCase() !== quote) {
+    throw new Error(
+      `unsupported settlement currency in "${symbol}" \u2014 only linear (settle === quote) is supported`
+    );
+  }
+  return {
+    base,
+    quote,
+    market: settle ? "perpetual" : "spot",
+    pair: `${base}/${quote}`
+  };
+}
+
+// src/transport/http.ts
+async function httpJson(req) {
+  const url = req.transformUrl ? req.transformUrl(req.url) : req.url;
+  const controller = new AbortController();
+  const timer = setTimeout(() => controller.abort(), req.timeoutMs ?? 1e4);
+  try {
+    const res = await fetch(url, {
+      method: req.method ?? "GET",
+      headers: req.headers,
+      body: req.body,
+      signal: controller.signal
+    });
+    if (!res.ok) {
+      const text = await res.text().catch(() => "");
+      throw new Error(`HTTP ${res.status} ${res.statusText}: ${text.slice(0, 200)}`);
+    }
+    return await res.json();
+  } finally {
+    clearTimeout(timer);
+  }
+}
+
+// src/core/errors.ts
+var ExchangeError = class extends Error {
+  constructor(exchange, message, cause) {
+    super(
+      `[${exchange}] ${message}`,
+      cause === void 0 ? void 0 : { cause }
+    );
+    this.exchange = exchange;
+    this.name = "ExchangeError";
+  }
+  exchange;
+};
+
+// src/exchanges/bingx/symbols.ts
+function toBingxSymbol(symbol) {
+  const [base, quote] = symbol.split("/");
+  if (!base || !quote) {
+    throw new Error(`invalid symbol "${symbol}" \u2014 expected "BASE/QUOTE"`);
+  }
+  return `${base}-${quote}`.toUpperCase();
+}
+function fromBingxSymbol(s) {
+  return s.toUpperCase().replace("-", "/");
+}
+
+// src/exchanges/bingx/rest.ts
+var BASE = "https://open-api.bingx.com";
+async function fetchBingxOrderbook(opts) {
+  const symbol = toBingxSymbol(opts.symbol);
+  const limit = opts.depth ?? 50;
+  const url = opts.market === "spot" ? `${BASE}/openApi/spot/v1/market/depth?symbol=${symbol}&limit=${limit}` : `${BASE}/openApi/swap/v2/quote/depth?symbol=${symbol}&limit=${limit}`;
+  const res = await httpJson({
+    url,
+    timeoutMs: opts.timeoutMs,
+    transformUrl: opts.transformUrl
+  });
+  if (res.code !== 0) {
+    throw new ExchangeError("bingx", `${res.code}: ${res.msg}`);
+  }
+  const ts = res.data.T ?? res.data.ts ?? Date.now();
+  return {
+    exchange: "bingx",
+    symbol: fromBingxSymbol(symbol),
+    market: opts.market,
+    bids: res.data.bids.map(([p, s]) => ({ price: Number(p), size: Number(s) })),
+    asks: res.data.asks.map(([p, s]) => ({ price: Number(p), size: Number(s) })),
+    timestamp: ts,
+    sequence: ts
+  };
+}
+
+// src/core/book-merger.ts
+var BookMerger = class {
+  bids = /* @__PURE__ */ new Map();
+  // price -> size
+  asks = /* @__PURE__ */ new Map();
+  sequence = -1;
+  timestamp = 0;
+  hasSnapshot = false;
+  apply(event) {
+    if (event.kind === "snapshot") {
+      this.bids.clear();
+      this.asks.clear();
+      for (const { price, size } of event.bids) {
+        if (size > 0) this.bids.set(price, size);
+      }
+      for (const { price, size } of event.asks) {
+        if (size > 0) this.asks.set(price, size);
+      }
+      this.sequence = event.sequence;
+      this.timestamp = event.timestamp;
+      this.hasSnapshot = true;
+      return this.emit();
+    }
+    if (!this.hasSnapshot) {
+      return { ok: false, reason: "no-snapshot" };
+    }
+    if (event.sequence <= this.sequence) {
+      return this.emit();
+    }
+    if (event.prevSequence !== void 0) {
+      if (event.prevSequence !== this.sequence) {
+        return {
+          ok: false,
+          reason: "gap",
+          expected: this.sequence,
+          received: event.prevSequence
+        };
+      }
+    } else if (event.sequence !== this.sequence + 1) {
+      return {
+        ok: false,
+        reason: "gap",
+        expected: this.sequence + 1,
+        received: event.sequence
+      };
+    }
+    for (const { price, size } of event.bids) {
+      if (size === 0) this.bids.delete(price);
+      else this.bids.set(price, size);
+    }
+    for (const { price, size } of event.asks) {
+      if (size === 0) this.asks.delete(price);
+      else this.asks.set(price, size);
+    }
+    this.sequence = event.sequence;
+    this.timestamp = event.timestamp;
+    return this.emit();
+  }
+  reset() {
+    this.bids.clear();
+    this.asks.clear();
+    this.sequence = -1;
+    this.timestamp = 0;
+    this.hasSnapshot = false;
+  }
+  /** Returns true once the merger has a usable book. */
+  isReady() {
+    return this.hasSnapshot;
+  }
+  emit() {
+    const bids = [];
+    for (const [price, size] of this.bids) bids.push({ price, size });
+    bids.sort((a, b) => b.price - a.price);
+    const asks = [];
+    for (const [price, size] of this.asks) asks.push({ price, size });
+    asks.sort((a, b) => a.price - b.price);
+    return {
+      ok: true,
+      bids,
+      asks,
+      sequence: this.sequence,
+      timestamp: this.timestamp
+    };
+  }
+};
+
+// src/core/event-emitter.ts
+var TypedEmitter = class {
+  listeners = /* @__PURE__ */ new Map();
+  on(event, fn) {
+    let set = this.listeners.get(event);
+    if (!set) {
+      set = /* @__PURE__ */ new Set();
+      this.listeners.set(event, set);
+    }
+    set.add(fn);
+    return this;
+  }
+  off(event, fn) {
+    this.listeners.get(event)?.delete(fn);
+    return this;
+  }
+  emit(event, ...args) {
+    const set = this.listeners.get(event);
+    if (!set || set.size === 0) return false;
+    for (const fn of set) fn(...args);
+    return true;
+  }
+  removeAllListeners() {
+    this.listeners.clear();
+  }
+};
+
+// src/core/stream.ts
+var OrderbookStream = class extends TypedEmitter {
+  constructor(onClose) {
+    super();
+    this.onClose = onClose;
+  }
+  onClose;
+  closed = false;
+  close() {
+    if (this.closed) return;
+    this.closed = true;
+    this.onClose();
+    this.removeAllListeners();
+  }
+  /** Yields each maintained book as it becomes available. */
+  async *iter() {
+    const queue = [];
+    let resolveNext = null;
+    let pendingError = null;
+    let ended = false;
+    const onUpdate = (b) => {
+      queue.push(b);
+      resolveNext?.();
+    };
+    const onError = (e) => {
+      pendingError = e;
+      resolveNext?.();
+    };
+    const onClose = () => {
+      ended = true;
+      resolveNext?.();
+    };
+    this.on("update", onUpdate);
+    this.on("error", onError);
+    this.on("disconnected", onClose);
+    try {
+      while (true) {
+        if (pendingError) throw pendingError;
+        const next = queue.shift();
+        if (next) {
+          yield next;
+          continue;
+        }
+        if (ended || this.closed) return;
+        await new Promise((r) => {
+          resolveNext = r;
+        });
+        resolveNext = null;
+      }
+    } finally {
+      this.off("update", onUpdate);
+      this.off("error", onError);
+      this.off("disconnected", onClose);
+    }
+  }
+};
+
+// src/core/reconnect.ts
+var Backoff = class _Backoff {
+  attempt = 0;
+  opts;
+  constructor(opts) {
+    this.opts = opts;
+  }
+  static withDefaults(opts = {}) {
+    return new _Backoff({
+      initialMs: opts.initialMs ?? 500,
+      maxMs: opts.maxMs ?? 3e4,
+      factor: opts.factor ?? 2,
+      jitter: opts.jitter ?? 0.3,
+      maxAttempts: opts.maxAttempts ?? 0
+    });
+  }
+  next() {
+    if (this.opts.maxAttempts > 0 && this.attempt >= this.opts.maxAttempts) {
+      return null;
+    }
+    this.attempt += 1;
+    const base = Math.min(
+      this.opts.initialMs * Math.pow(this.opts.factor, this.attempt - 1),
+      this.opts.maxMs
+    );
+    const jitterRange = base * this.opts.jitter;
+    const wait = Math.max(0, base + (Math.random() * 2 - 1) * jitterRange);
+    return { wait, attempt: this.attempt };
+  }
+  reset() {
+    this.attempt = 0;
+  }
+};
+var hasNativeWebSocket = typeof globalThis.WebSocket !== "undefined";
+
+// src/transport/ws.ts
+var cachedCtor = null;
+async function getWebSocketCtor() {
+  if (cachedCtor) return cachedCtor;
+  if (hasNativeWebSocket) {
+    cachedCtor = globalThis.WebSocket;
+    return cachedCtor;
+  }
+  try {
+    const mod = await import('ws');
+    const ctor = mod.default ?? mod.WebSocket;
+    if (!ctor) throw new Error("missing default export");
+    cachedCtor = ctor;
+    return cachedCtor;
+  } catch (err) {
+    throw new Error(
+      "WebSocket unavailable; install peer dep `ws` for Node <22. " + (err instanceof Error ? err.message : String(err))
+    );
+  }
+}
+var WSClient = class extends TypedEmitter {
+  constructor(cfg) {
+    super();
+    this.cfg = cfg;
+    this.backoff = Backoff.withDefaults(cfg.reconnect);
+  }
+  cfg;
+  ws = null;
+  backoff;
+  closed = false;
+  pingTimer = null;
+  async connect() {
+    if (this.closed) return;
+    const WS = await getWebSocketCtor();
+    const ws = new WS(this.cfg.url);
+    ws.binaryType = "arraybuffer";
+    this.ws = ws;
+    ws.onopen = async () => {
+      this.backoff.reset();
+      this.startPing();
+      this.emit("open");
+      try {
+        await this.cfg.onOpen?.({
+          send: (d) => ws.send(d),
+          close: () => this.close()
+        });
+      } catch (err) {
+        this.emit("error", err);
+      }
+    };
+    ws.onmessage = (e) => {
+      let result;
+      try {
+        result = this.cfg.onMessage(e.data);
+      } catch (err) {
+        this.emit("error", err);
+        return;
+      }
+      if (result && typeof result.catch === "function") {
+        result.catch(
+          (err) => this.emit("error", err)
+        );
+      }
+    };
+    ws.onerror = (e) => {
+      this.emit("error", new Error(e?.message ?? "WebSocket error"));
+    };
+    ws.onclose = (e) => {
+      this.stopPing();
+      const reason = e?.reason ?? "closed";
+      this.emit("close", reason);
+      if (!this.closed) this.scheduleReconnect();
+    };
+  }
+  send(data) {
+    this.ws?.send(data);
+  }
+  close() {
+    this.closed = true;
+    this.stopPing();
+    try {
+      this.ws?.close();
+    } catch {
+    }
+  }
+  startPing() {
+    if (!this.cfg.pingIntervalMs || !this.cfg.pingPayload) return;
+    this.stopPing();
+    this.pingTimer = setInterval(() => {
+      try {
+        this.ws?.send(this.cfg.pingPayload());
+      } catch {
+      }
+    }, this.cfg.pingIntervalMs);
+  }
+  stopPing() {
+    if (this.pingTimer) {
+      clearInterval(this.pingTimer);
+      this.pingTimer = null;
+    }
+  }
+  scheduleReconnect() {
+    const next = this.backoff.next();
+    if (!next) {
+      this.emit("error", new Error("max reconnect attempts exceeded"));
+      return;
+    }
+    this.emit("reconnecting", next.attempt, next.wait);
+    setTimeout(() => {
+      this.connect().catch((e) => this.emit("error", e));
+    }, next.wait);
+  }
+};
+
+// src/utils/gzip.ts
+var cached = null;
+var pending = null;
+function getGzipInflate() {
+  if (cached) return Promise.resolve(cached);
+  if (pending) return pending;
+  pending = (async () => {
+    let pako;
+    try {
+      pako = await import('pako');
+    } catch (err) {
+      throw new Error(
+        "gzip decompression requires the `pako` peer dependency. " + (err instanceof Error ? err.message : String(err))
+      );
+    }
+    const inflate = (data) => {
+      const buf = data instanceof ArrayBuffer ? new Uint8Array(data) : data;
+      try {
+        return pako.ungzip(buf, { to: "string" });
+      } catch {
+        return pako.inflate(buf, { to: "string" });
+      }
+    };
+    cached = inflate;
+    return inflate;
+  })();
+  return pending;
+}
+
+// src/exchanges/bingx/ws.ts
+var WS_SPOT = "wss://open-api-ws.bingx.com/market";
+var WS_SWAP = "wss://open-api-swap.bingx.com/swap-market";
+function streamBingxOrderbook(opts) {
+  const isSpot = opts.market === "spot";
+  const bingxSymbol = toBingxSymbol(opts.symbol);
+  const depth = opts.depth ?? 20;
+  const dataType = `${bingxSymbol}@depth${depth}`;
+  const merger = new BookMerger();
+  let ws = null;
+  const stream = new OrderbookStream(() => ws?.close());
+  const subscribePayload = JSON.stringify({
+    id: `sub-${Date.now()}`,
+    reqType: "sub",
+    dataType
+  });
+  const handlePayload = (text) => {
+    if (text === "Ping" || text === "ping") {
+      ws?.send(text === "Ping" ? "Pong" : "pong");
+      return;
+    }
+    let msg;
+    try {
+      msg = JSON.parse(text);
+    } catch {
+      return;
+    }
+    if (msg.id && !msg.data) return;
+    if (msg.dataType !== dataType || !msg.data) return;
+    const d = msg.data;
+    const ts = d.T ?? d.ts ?? Date.now();
+    const event = {
+      kind: "snapshot",
+      bids: d.bids.map(([p, s]) => ({ price: Number(p), size: Number(s) })),
+      asks: d.asks.map(([p, s]) => ({ price: Number(p), size: Number(s) })),
+      sequence: ts,
+      timestamp: ts
+    };
+    const r = merger.apply(event);
+    if (!r.ok) return;
+    const book = {
+      exchange: "bingx",
+      symbol: fromBingxSymbol(bingxSymbol),
+      market: opts.market,
+      bids: r.bids,
+      asks: r.asks,
+      timestamp: r.timestamp,
+      sequence: r.sequence
+    };
+    stream.emit("update", book);
+  };
+  const onMessage = async (raw) => {
+    if (typeof raw === "string") {
+      handlePayload(raw);
+      return;
+    }
+    const inflate = await getGzipInflate();
+    handlePayload(inflate(raw));
+  };
+  ws = new WSClient({
+    url: isSpot ? WS_SPOT : WS_SWAP,
+    onOpen: (sock) => {
+      merger.reset();
+      sock.send(subscribePayload);
+    },
+    onMessage
+    // bingx server is the one that sends Ping frames; we don't need client pings.
+  });
+  ws.on("open", () => stream.emit("connected"));
+  ws.on("close", (r) => stream.emit("disconnected", r));
+  ws.on("reconnecting", (a, w) => stream.emit("reconnecting", a, w));
+  ws.on("error", (e) => stream.emit("error", e));
+  ws.connect().catch((e) => stream.emit("error", e));
+  return stream;
+}
+
+// src/exchanges/bingx/index.ts
+var BingxClient = class {
+  exchange = "bingx";
+  transformUrl;
+  timeoutMs;
+  constructor(opts = {}) {
+    this.transformUrl = opts.transformUrl;
+    this.timeoutMs = opts.timeoutMs;
+  }
+  fetchOrderbook(symbol, opts = {}) {
+    const { pair, market } = parseSymbol(symbol);
+    return fetchBingxOrderbook({
+      symbol: pair,
+      market,
+      depth: opts.depth,
+      timeoutMs: this.timeoutMs,
+      transformUrl: this.transformUrl
+    });
+  }
+  streamOrderbook(symbol, opts = {}) {
+    const { pair, market } = parseSymbol(symbol);
+    return streamBingxOrderbook({
+      symbol: pair,
+      market,
+      depth: opts.depth,
+      transformUrl: this.transformUrl,
+      timeoutMs: this.timeoutMs
+    });
+  }
+};
+
+exports.BingxClient = BingxClient;
+exports.fetchBingxOrderbook = fetchBingxOrderbook;
+exports.streamBingxOrderbook = streamBingxOrderbook;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map