@n1xyz/nord-ts 0.0.18-8121ed05.0 → 0.0.19

package/src/nord/index.ts

@@ -8,8 +8,6 @@ export { NordError } from "./utils/NordError";
 // Export API modules
 export * from "./api/core";
 export * from "./api/metrics";
-export * from "./api/queries";
-export * from "./api/market";
 export * from "./api/actions";
 
 // Export models

package/src/nord/models/Subscriber.ts

@@ -4,7 +4,7 @@ import {
   DeltaEvent,
   OrderbookResponse,
   SubscriberConfig,
-  Trade,
+  StreamTrade,
   Trades,
 } from "../../types";
 import { MAX_BUFFER_LEN } from "../../utils";
@@ -49,7 +49,7 @@ export interface OrderbookSubscription extends EventEmitter {
  * Interface for trade subscription
  */
 export interface TradeSubscription extends EventEmitter {
-  on(event: "message", listener: (data: Trade[]) => void): this;
+  on(event: "message", listener: (data: StreamTrade[]) => void): this;
   on(event: "error", listener: (error: Error) => void): this;
   close(): void;
   removeAllListeners(event?: string): this;

package/src/types.ts

@@ -1,4 +1,5 @@
 import * as proto from "./gen/nord";
+import type { components } from "./gen/openapi.ts";
 
 /**
  * The peak TPS rate is queried over the specified period.
@@ -46,6 +47,46 @@ export interface NordConfig {
   initWebSockets?: boolean;
 }
 
+export type Info = components["schemas"]["Info2"];
+export type Market = Info["markets"][number];
+export type Token = Info["tokens"][number];
+export type Account = components["schemas"]["Account"];
+export type TradesResponse =
+  components["schemas"]["PageResult_for_String_and_Trade"];
+export type User = components["schemas"]["User"];
+export type OrderbookResponse = components["schemas"]["OrderbookInfo"];
+export type MarketStats = components["schemas"]["MarketStats"];
+export type OrderbookInfo = components["schemas"]["OrderbookInfo"];
+export type MarketStatsFromApi = components["schemas"]["MarketStats"];
+export type TradeFromApi = components["schemas"]["Trade"];
+// Generic PageResult type - note that K and V must match existing schema keys
+export type PageResult<K extends string, V extends string> = K extends "String"
+  ? V extends "OrderInfo"
+    ? components["schemas"]["PageResult_for_String_and_OrderInfo"]
+    : V extends "Trade"
+      ? components["schemas"]["PageResult_for_String_and_Trade"]
+      : never
+  : never;
+export type PageResultStringOrderInfo =
+  components["schemas"]["PageResult_for_String_and_OrderInfo"];
+export type PageResultStringTrade =
+  components["schemas"]["PageResult_for_String_and_Trade"];
+export type OrderInfoFromApi = components["schemas"]["OrderInfo"];
+export type OpenOrder = components["schemas"]["OpenOrder"];
+export type Balance = components["schemas"]["Balance"];
+export type PositionSummary = components["schemas"]["PositionSummary"];
+export type PerpPosition = components["schemas"]["PerpPosition"];
+export type AccountMarginsView = components["schemas"]["AccountMarginsView"];
+export type SideSummary = components["schemas"]["SideSummary"];
+export type UserSession = components["schemas"]["UserSession"];
+export type ActionsItem = components["schemas"]["ActionsItem"];
+export type FillRole = components["schemas"]["FillRole"];
+export type PerpMarketStatsFromApi = components["schemas"]["PerpMarketStats"];
+export type SideFromApi = components["schemas"]["Side"];
+export type FillModeFromApi = components["schemas"]["FillMode"];
+export type PlacementOrigin = components["schemas"]["PlacementOrigin"];
+export type FinalizationReason = components["schemas"]["FinalizationReason"];
+
 /**
  * Configuration options for the Nord client
  */
@@ -87,28 +128,6 @@ export interface SubscriberConfig {
   maxBufferLen?: number;
 }
 
-export interface Market {
-  marketId: number;
-  symbol: string;
-  priceDecimals: number;
-  sizeDecimals: number;
-  baseTokenId: number;
-  quoteTokenId: number;
-  frozen: boolean;
-}
-
-export interface Token {
-  tokenId: number;
-  symbol: string;
-  decimals: number;
-  mintAddr: string;
-}
-
-export interface Info {
-  markets: Market[];
-  tokens: Token[];
-}
-
 export interface DeltaEvent {
   last_update_id: number;
   update_id: number;
@@ -117,7 +136,7 @@ export interface DeltaEvent {
   bids: OrderbookEntry[];
 }
 
-export interface Trade {
+export interface StreamTrade {
   side: Side;
   price: number;
   size: number;
@@ -128,95 +147,26 @@ export interface Trades {
   last_update_id: number;
   update_id: number;
   market_symbol: string;
-  trades: Trade[];
+  trades: StreamTrade[];
 }
 
-export interface OrderInfo {
+export interface LocalOrderInfo {
   id: number;
   reduce_only: boolean;
   limit_price: number;
   size: number;
   account_id: number;
+  sender_tracking_id?: number;
 }
 
 export interface HashMap<T> {
   [key: number]: T;
 }
 
-export interface Account {
-  last_update_id: number;
-  update_id: number;
-  account_id: number;
-  fills: HashMap<number>;
-  places: HashMap<OrderInfo>;
-  cancels: HashMap<OrderInfo>;
-  balances: HashMap<number>;
-}
-
-/**
- * Query the transactions in the specified L2 block.
- * block_number specifies the block number to query.
- * If not specified, transactions from latest block are returned.
- */
-export interface BlockQuery {
-  block_number?: number;
-}
-
-/**
- * Response for BlockQuery.
- * block_number specifies the block number being returned.
- * actions are the list of transactions from the block.
- */
-export interface BlockResponse {
-  block_number: number;
-  actions: ActionInfo[];
-}
-
-/**
- * Response for BlockSummaryQuery.
- * block_summary is the summary of upto the last N blocks.
- * The server can return fewer than last_n block summary if
- * fewer blocks are available or if it exceeds a max cap.
- */
-export interface BlockSummaryResponse {
-  block_summary: BlockSummary[];
-}
-
-/**
- * Query the action for the specified action id.
- * action_id specifies the action to query.
- */
-export interface ActionQuery {
-  action_id: number;
-}
-
-/**
- * Response for ActionQuery.
- * block_number the block the action is part of.
- * If the action is not yet included in any block, null is returned.
- * action the transaction.
- */
 export interface ActionResponse {
-  block_number?: number;
+  actionId: number;
   action: proto.Action;
-}
-
-/**
- * Query the recent actions
- * last_n requests last N actions.
- */
-export interface ActionsQuery {
-  last_n: number;
-}
-
-/**
- * Response for ActionsQuery.
- * actions returns upto the last N actions.
- * The server can return fewer than last_n actions if
- * fewer actions are available or if it exceeds a max cap.
- */
-export interface ActionsResponse {
-  actions: ActionsExtendedInfo[];
+  physicalExecTime: Date;
 }
 
 /**
@@ -231,31 +181,6 @@ export interface BlockSummary {
   to_action_id: number;
 }
 
-/**
- * Info about the block transaction.
- * action_id is the action identifier.
- * action in protobuf format.
- * exec_timestamp is the execution timestamp.
- */
-export interface ActionInfo {
-  action_id: number;
-  action: proto.Action;
-  exec_timestamp: number;
-}
-
-/**
- * Extended info about the block transaction.
- * block_number the block the action is part of.
- * If the action is not yet included in any block, null is returned.
- * action_id of the action.
- * action the transaction.
- */
-export interface ActionsExtendedInfo {
-  block_number?: number;
-  action_id: number;
-  action: proto.Action;
-}
-
 /**
  * Aggregate metrics
  * blocks_total: Total number of L2 blocks.
@@ -272,54 +197,6 @@ export interface AggregateMetrics {
   request_latency_average: number;
 }
 
-// The JSON types returned by rollman, that need to be translated to TS format.
-export interface RollmanBlockResponse {
-  block_number: number;
-  actions: RollmanActionInfo[];
-}
-
-export interface RollmanActionResponse {
-  block_number?: number;
-  action_pb: Uint8Array;
-  exec_timestamp: number;
-}
-
-export interface RollmanActionsResponse {
-  actions: RollmanActionExtendedInfo[];
-}
-
-export interface RollmanActionInfo {
-  action_id: number;
-  action_pb: Uint8Array;
-  exec_timestamp: number;
-}
-
-export interface RollmanActionExtendedInfo {
-  block_number?: number;
-  action_id: number;
-  action_pb: Uint8Array;
-}
-
-export interface MarketsStatsResponse {
-  markets: MarketStats[];
-}
-
-export interface MarketStats {
-  market_id: number;
-  index_price: [number, number];
-  volume_24h: number;
-  high_24h: number;
-  low_24h: number;
-  perp_stats?: PerpMarketStats;
-}
-
-export interface PerpMarketStats {
-  mark_price?: number;
-  funding_rate?: number;
-  next_funding_time?: Date;
-  open_interest?: number;
-}
-
 /**
  * Converts a `FillMode` enum to its corresponding protobuf representation.
  *
@@ -337,41 +214,6 @@ export function fillModeToProtoFillMode(x: FillMode): proto.FillMode {
   throw new Error("Invalid fill mode");
 }
 
-/**
- * Response for trades query with pagination support
- */
-export interface TradesResponse {
-  trades: Trade[];
-  accountId: number;
-  since?: string; // RFC3339 timestamp
-  until?: string; // RFC3339 timestamp
-  nextPageId?: string;
-}
-
-/**
- * Query parameters for trades endpoint
- */
-export interface TradesQuery {
-  accountId: number;
-  since?: string; // RFC3339 timestamp
-  until?: string; // RFC3339 timestamp
-  pageId?: string;
-}
-
-/**
- * Response for user account IDs query
- */
-export interface UserAccountIdsResponse {
-  accountIds: number[];
-}
-
-/**
- * Query parameters for user account IDs
- */
-export interface UserAccountIdsQuery {
-  pubkey: string; // secp256k1 public key in hex format
-}
-
 /**
  * Orderbook entry representing price and size
  */
@@ -380,16 +222,6 @@ export interface OrderbookEntry {
   size: number;
 }
 
-/**
- * Response for orderbook query
- */
-export interface OrderbookResponse {
-  symbol: string;
-  asks: OrderbookEntry[];
-  bids: OrderbookEntry[];
-  timestamp: number;
-}
-
 /**
  * Query parameters for orderbook
  *
@@ -440,7 +272,7 @@ export interface WebSocketSubscription {
 export interface WebSocketTradeUpdate {
   e: WebSocketMessageType.TradeUpdate;
   symbol: string;
-  trades: Trade[];
+  trades: StreamTrade[];
   timestamp: number;
 }
 
@@ -472,3 +304,10 @@ export type WebSocketMessage =
   | WebSocketTradeUpdate
   | WebSocketDeltaUpdate
   | WebSocketAccountUpdate;
+
+export interface SPLTokenInfo {
+  mint: string;
+  precision: number;
+  tokenId: number;
+  name: string;
+}

package/src/utils.ts

@@ -25,6 +25,12 @@ export function panic(message: string): never {
   throw new Error(message);
 }
 
+export function isRfc3339(s: string): boolean {
+  const REGEX =
+    /^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[\+-]\d{2}:\d{2})?)$/;
+  return REGEX.test(s);
+}
+
 export function assert(predicate: boolean, message?: string): void {
   if (!predicate) panic(message ?? "Assertion violated");
 }
@@ -38,26 +44,6 @@ export function optExpect<T>(value: T | undefined, message: string): T {
   if (value === undefined) throw new Error(message);
   return value as T;
 }
-/**
- * Unwraps optional value with default error message
- * @param value
- * @returns
- */
-export function optUnwrap<T>(value: T | undefined): T {
-  return optExpect(value, "Optional contains no value");
-}
-/**
- * Applies function to value if it's defined, or passes `undefined` through
- * @param value Optional value to map
- * @param mapFn Mapper function
- * @returns     Either mapped value or undefined
- */
-export function optMap<T, U>(
-  value: T | undefined,
-  mapFn: (arg: T) => U,
-): U | undefined {
-  return value !== undefined ? mapFn(value) : undefined;
-}
 /** Behaves same as `node-fetch/fetch` but throws if response is a failure
  *
  * @param url   Request HTTP URL
@@ -190,28 +176,6 @@ export const toScaledU128 = makeToScaledBigUint({
   exponent: 56,
 });
 
-const U64_MAX = (1n << 64n) - 1n;
-const U128_MAX = (1n << 128n) - 1n;
-/**
- * Converts U128 into pair of U64 numbers, to pass it through protobuf
- * @param value integer, must fit U128 limits
- * @returns     Pair of U64 integers which represent original number split in two
- */
-export function bigIntToProtoU128(value: bigint): proto.U128 {
-  if (value < 0n) {
-    throw new Error(`Negative number (${value})`);
-  }
-
-  if (value > U128_MAX) {
-    throw new Error(`U128 overflow (${value})`);
-  }
-
-  return {
-    lo: value & U64_MAX,
-    hi: (value >> 64n) & U64_MAX,
-  };
-}
-
 /**
  * Encodes any protobuf message into a length-delimited format,
  * i.e. prefixed with its length encoded as varint

package/src/websocket/NordWebSocketClient.ts

@@ -1,12 +1,12 @@
-import WebSocket from "ws";
 import { EventEmitter } from "events";
+import WebSocket from "ws";
 import {
+  WebSocketAccountUpdate,
+  WebSocketDeltaUpdate,
   WebSocketMessage,
   WebSocketMessageType,
   WebSocketSubscription,
   WebSocketTradeUpdate,
-  WebSocketDeltaUpdate,
-  WebSocketAccountUpdate,
 } from "../types";
 import { NordWebSocketClientEvents } from "./events";
 
@@ -394,19 +394,27 @@ export class NordWebSocketClient
    * @param message WebSocket message
    */
   private handleMessage(message: WebSocketMessage): void {
-    switch (message.e) {
-      case WebSocketMessageType.TradeUpdate:
-        this.emit("trades", message as WebSocketTradeUpdate);
-        break;
-      case WebSocketMessageType.DeltaUpdate:
-        this.emit("delta", message as WebSocketDeltaUpdate);
-        break;
-      case WebSocketMessageType.AccountUpdate:
-        this.emit("account", message as WebSocketAccountUpdate);
-        break;
-      default:
-        this.emit("error", new Error(`Unknown message type: ${message.e}`));
+    if (!message || typeof message !== "object") {
+      this.emit("error", new Error(`Unexpected message type: ${message}`));
+      return;
     }
+
+    const hasOwn = (k: string) =>
+      Object.prototype.hasOwnProperty.call(message, k);
+    if (hasOwn("trades")) {
+      this.emit("trades", message as WebSocketTradeUpdate);
+      return;
+    }
+    if (hasOwn("delta")) {
+      this.emit("delta", message as WebSocketDeltaUpdate);
+      return;
+    }
+    if (hasOwn("account")) {
+      this.emit("account", message as WebSocketAccountUpdate);
+      return;
+    }
+
+    this.emit("error", new Error(`Unexpected message type: ${message}`));
   }
 
   /**

package/src/websocket/index.ts

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

package/tests/utils.spec.ts

@@ -1,6 +1,5 @@
 import { describe, it, expect } from "@jest/globals";
 import {
-  bigIntToProtoU128,
   toScaledU64,
   toScaledU128,
   encodeLengthDelimited,
@@ -91,38 +90,6 @@ describe("toScaledU128", () => {
   });
 });
 
-const U64_MAX = (1n << 64n) - 1n;
-const U128_MAX = (1n << 128n) - 1n;
-
-describe("bigIntToProtoU128", () => {
-  const success: Array<[bigint, { lo: bigint; hi: bigint }]> = [
-    [0n, { lo: 0n, hi: 0n }],
-    [1n, { lo: 1n, hi: 0n }],
-    [U64_MAX - 1n, { lo: U64_MAX - 1n, hi: 0n }],
-    [U64_MAX, { lo: U64_MAX, hi: 0n }],
-    [U64_MAX + 1n, { lo: 0n, hi: 1n }],
-    [U128_MAX - 1n, { lo: U64_MAX - 1n, hi: U64_MAX }],
-    [U128_MAX, { lo: U64_MAX, hi: U64_MAX }],
-  ];
-
-  success.forEach((sample, index) => {
-    it(`Conversion to Protobuf's U128 should succeed: case ${index}`, () => {
-      expect(bigIntToProtoU128(sample[0])).toEqual(sample[1]);
-    });
-  });
-
-  const failure: Array<[bigint, string]> = [
-    [-1n, "Negative number"],
-    [U128_MAX + 1n, "U128 overflow"],
-  ];
-
-  failure.forEach((sample, index) => {
-    it(`Conversion to Protobuf's U128 should fail: case ${index}`, () => {
-      expect(() => bigIntToProtoU128(sample[0])).toThrow(sample[1]);
-    });
-  });
-});
-
 describe("proto.Action encode-decode loop", () => {
   const action: proto.Action = {
     currentTimestamp: 0n,
@@ -137,7 +104,7 @@ describe("proto.Action encode-decode loop", () => {
         isReduceOnly: false,
         price: 12n,
         size: 39n,
-        quoteSize: { lo: 54n, hi: 55n },
+        quoteSize: { size: 54n, price: 55n },
         senderAccountId: undefined,
         delegatorAccountId: undefined,
         clientOrderId: 350n,