@n1xyz/nord-ts 0.0.1 → 0.0.5

package/dist/nord/index.d.ts

@@ -1,2 +1,9 @@
-export { NordUser } from "./NordUser";
-export { Nord, createWebSocketSubscription, Subscriber } from "./Nord";
+export { Nord } from "./client/Nord";
+export { NordUser } from "./client/NordUser";
+export { NordError } from "./utils/NordError";
+export * from "./api/core";
+export * from "./api/metrics";
+export * from "./api/queries";
+export * from "./api/market";
+export * from "./api/actions";
+export * from "./models/Subscriber";

package/dist/nord/index.js

@@ -1,9 +1,33 @@
 "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 });
-exports.Subscriber = exports.createWebSocketSubscription = exports.Nord = exports.NordUser = void 0;
-var NordUser_1 = require("./NordUser");
-Object.defineProperty(exports, "NordUser", { enumerable: true, get: function () { return NordUser_1.NordUser; } });
-var Nord_1 = require("./Nord");
+exports.NordError = exports.NordUser = exports.Nord = void 0;
+// Export main client classes
+var Nord_1 = require("./client/Nord");
 Object.defineProperty(exports, "Nord", { enumerable: true, get: function () { return Nord_1.Nord; } });
-Object.defineProperty(exports, "createWebSocketSubscription", { enumerable: true, get: function () { return Nord_1.createWebSocketSubscription; } });
-Object.defineProperty(exports, "Subscriber", { enumerable: true, get: function () { return Nord_1.Subscriber; } });
+var NordUser_1 = require("./client/NordUser");
+Object.defineProperty(exports, "NordUser", { enumerable: true, get: function () { return NordUser_1.NordUser; } });
+// Export utility classes
+var NordError_1 = require("./utils/NordError");
+Object.defineProperty(exports, "NordError", { enumerable: true, get: function () { return NordError_1.NordError; } });
+// Export API modules
+__exportStar(require("./api/core"), exports);
+__exportStar(require("./api/metrics"), exports);
+__exportStar(require("./api/queries"), exports);
+__exportStar(require("./api/market"), exports);
+__exportStar(require("./api/actions"), exports);
+// Export models
+__exportStar(require("./models/Subscriber"), exports);

package/dist/nord/models/Subscriber.d.ts

@@ -0,0 +1,37 @@
+import { EventEmitter } from "events";
+import { Account, DeltaEvent, OrderbookResponse, SubscriberConfig, Trade, Trades } from "../../types";
+/**
+ * Subscriber class for handling WebSocket subscriptions
+ */
+export declare class Subscriber {
+    streamURL: string;
+    buffer: (DeltaEvent | Trades | Account)[];
+    maxBufferLen: number;
+    /**
+     * Create a new Subscriber instance
+     * @param config Subscriber configuration
+     */
+    constructor(config: SubscriberConfig);
+    /**
+     * Subscribe to WebSocket events
+     */
+    subscribe(): void;
+}
+/**
+ * Interface for orderbook subscription
+ */
+export interface OrderbookSubscription extends EventEmitter {
+    on(event: "message", listener: (data: OrderbookResponse) => void): this;
+    on(event: "error", listener: (error: Error) => void): this;
+    close(): void;
+    removeAllListeners(event?: string): this;
+}
+/**
+ * Interface for trade subscription
+ */
+export interface TradeSubscription extends EventEmitter {
+    on(event: "message", listener: (data: Trade[]) => void): this;
+    on(event: "error", listener: (error: Error) => void): this;
+    close(): void;
+    removeAllListeners(event?: string): this;
+}

package/dist/nord/models/Subscriber.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscriber = void 0;
+const utils_1 = require("../../utils");
+/**
+ * Subscriber class for handling WebSocket subscriptions
+ */
+class Subscriber {
+    /**
+     * Create a new Subscriber instance
+     * @param config Subscriber configuration
+     */
+    constructor(config) {
+        this.streamURL = config.streamURL;
+        this.buffer = [];
+        this.maxBufferLen = config.maxBufferLen ?? utils_1.MAX_BUFFER_LEN;
+    }
+    /**
+     * Subscribe to WebSocket events
+     */
+    subscribe() {
+        // TODO: Implement subscription logic
+    }
+}
+exports.Subscriber = Subscriber;

package/dist/nord/utils/NordError.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Options for creating a NordError
+ */
+export interface NordErrorOptions {
+    /** The original error that caused this error */
+    cause?: unknown;
+    /** HTTP status code (if applicable) */
+    statusCode?: number;
+    /** Additional error details */
+    details?: Record<string, unknown>;
+}
+/**
+ * Custom error class for Nord-related errors
+ */
+export declare class NordError extends Error {
+    /** The original error that caused this error */
+    readonly cause?: unknown;
+    /** HTTP status code (if applicable) */
+    readonly statusCode?: number;
+    /** Additional error details */
+    readonly details?: Record<string, unknown>;
+    /**
+     * Create a new NordError
+     *
+     * @param message - Error message
+     * @param options - Error options
+     */
+    constructor(message: string, options?: NordErrorOptions);
+    /**
+     * Convert the error to a string representation
+     *
+     * @returns String representation of the error
+     */
+    toString(): string;
+}

package/dist/nord/utils/NordError.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NordError = void 0;
+/**
+ * Custom error class for Nord-related errors
+ */
+class NordError extends Error {
+    /**
+     * Create a new NordError
+     *
+     * @param message - Error message
+     * @param options - Error options
+     */
+    constructor(message, options = {}) {
+        super(message);
+        this.name = "NordError";
+        this.cause = options.cause;
+        this.statusCode = options.statusCode;
+        this.details = options.details;
+        // Capture stack trace
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, NordError);
+        }
+        // Handle nested errors
+        if (this.cause instanceof Error) {
+            this.stack =
+                this.stack + "\nCaused by: " + (this.cause.stack || this.cause.message);
+        }
+    }
+    /**
+     * Convert the error to a string representation
+     *
+     * @returns String representation of the error
+     */
+    toString() {
+        let result = `${this.name}: ${this.message}`;
+        if (this.statusCode) {
+            result += ` (Status: ${this.statusCode})`;
+        }
+        if (this.details && Object.keys(this.details).length > 0) {
+            result += `\nDetails: ${JSON.stringify(this.details, null, 2)}`;
+        }
+        return result;
+    }
+}
+exports.NordError = NordError;

package/dist/types.d.ts

@@ -15,13 +15,24 @@ export declare enum PeakTpsPeriodUnit {
     Month = "m",
     Year = "y"
 }
+/**
+ * Configuration options for the Nord client
+ */
 export interface NordConfig {
-    evmUrl: string;
+    /** Base URL for the Nord web server */
     webServerUrl: string;
-    contractAddress: string;
-    tokenInfos: ERC20TokenInfo[];
-}
-export interface ERC20TokenInfo {
+    /** Solana program ID */
+    solanaProgramId: string;
+    /** Solana cluster URL */
+    solanaUrl: string;
+    /** Whether to initialize WebSockets on creation, defaults to true */
+    initWebSockets?: boolean;
+    /** Initial subscriptions for the trades WebSocket (e.g., ["trades@BTCUSDC"]) */
+    tradesSubscriptions?: string[];
+    /** Initial subscriptions for the deltas WebSocket (e.g., ["deltas@BTCUSDC"]) */
+    deltasSubscriptions?: string[];
+}
+export interface TokenInfo {
     address: string;
     precision: number;
     tokenId: number;
@@ -54,17 +65,19 @@ export interface SubscriberConfig {
     maxBufferLen?: number;
 }
 export interface Market {
+    marketId: number;
     symbol: string;
-    baseTokenId: number;
-    quoteTokenId: number;
     priceDecimals: number;
     sizeDecimals: number;
+    baseTokenId: number;
+    quoteTokenId: number;
+    frozen: boolean;
 }
 export interface Token {
+    tokenId: number;
     symbol: string;
-    ethAddr: string;
     decimals: number;
-    tokenId: number;
+    mintAddr: string;
 }
 export interface Info {
     markets: Market[];
@@ -74,8 +87,8 @@ export interface DeltaEvent {
     last_update_id: number;
     update_id: number;
     market_symbol: string;
-    asks: [number, number];
-    bids: [number, number];
+    asks: OrderbookEntry[];
+    bids: OrderbookEntry[];
 }
 export interface Trade {
     side: Side;
@@ -92,7 +105,7 @@ export interface Trades {
 export interface OrderInfo {
     id: number;
     reduce_only: boolean;
-    imit_price: number;
+    limit_price: number;
     size: number;
     account_id: number;
 }
@@ -103,7 +116,7 @@ export interface Account {
     last_update_id: number;
     update_id: number;
     account_id: number;
-    fills: HashMap<FillMode>;
+    fills: HashMap<number>;
     places: HashMap<OrderInfo>;
     cancels: HashMap<OrderInfo>;
     balances: HashMap<number>;
@@ -220,79 +233,6 @@ export interface AggregateMetrics {
     tx_tps_peak: number;
     request_latency_average: number;
 }
-/**
- * Parameters for querying trades
- * @field {number} accountId - ID of target account
- * @field {string} [since] - Start with this timestamp (RFC3339); defaults to UNIX epoch start
- * @field {string} [until] - End with this timestamp (RFC3339); defaults to current date-time
- * @field {string} [pageId] - Fetch results starting with this page
- */
-export interface TradesQueryParams {
-    accountId: number;
-    since?: string;
-    until?: string;
-    pageId?: string;
-}
-/**
- * Trade information
- * @field {string} id - Trade ID
- * @field {string} timestamp - Trade timestamp (RFC3339)
- * @field {string} symbol - Market symbol
- * @field {string} side - Trade side (buy/sell)
- * @field {number} price - Trade price
- * @field {number} size - Trade size
- * @field {number} fee - Trade fee
- * @field {string} feeCurrency - Fee currency
- * @field {number} orderId - Order ID
- */
-export interface TradeInfo {
-    id: string;
-    timestamp: string;
-    symbol: string;
-    side: string;
-    price: number;
-    size: number;
-    fee: number;
-    feeCurrency: string;
-    orderId: number;
-}
-/**
- * Response for trades query
- * @field {number} accountId - Account ID
- * @field {string} since - Start timestamp (RFC3339)
- * @field {string} until - End timestamp (RFC3339)
- * @field {string} [nextPageId] - ID for the next page of results
- * @field {TradeInfo[]} trades - Array of trades
- */
-export interface TradesResponse {
-    accountId: number;
-    since: string;
-    until: string;
-    nextPageId?: string;
-    trades: TradeInfo[];
-}
-/**
- * Order in the orderbook
- * @field {number} price - Order price
- * @field {number} size - Order size
- */
-export interface OrderbookOrder {
-    price: number;
-    size: number;
-}
-/**
- * Response for orderbook query
- * @field {string} symbol - Market symbol
- * @field {number} timestamp - Orderbook timestamp
- * @field {OrderbookOrder[]} bids - Array of bid orders
- * @field {OrderbookOrder[]} asks - Array of ask orders
- */
-export interface OrderbookResponse {
-    symbol: string;
-    timestamp: number;
-    bids: OrderbookOrder[];
-    asks: OrderbookOrder[];
-}
 export interface RollmanBlockResponse {
     block_number: number;
     actions: RollmanActionInfo[];
@@ -340,4 +280,121 @@ export interface PerpMarketStats {
  * @throws Will throw an error if provided with an invalid fill mode.
  */
 export declare function fillModeToProtoFillMode(x: FillMode): proto.FillMode;
+/**
+ * Response for trades query with pagination support
+ */
+export interface TradesResponse {
+    trades: Trade[];
+    accountId: number;
+    since?: string;
+    until?: string;
+    nextPageId?: string;
+}
+/**
+ * Query parameters for trades endpoint
+ */
+export interface TradesQuery {
+    accountId: number;
+    since?: string;
+    until?: string;
+    pageId?: string;
+}
+/**
+ * Response for user account IDs query
+ */
+export interface UserAccountIdsResponse {
+    accountIds: number[];
+}
+/**
+ * Query parameters for user account IDs
+ */
+export interface UserAccountIdsQuery {
+    pubkey: string;
+}
+/**
+ * Orderbook entry representing price and size
+ */
+export interface OrderbookEntry {
+    price: number;
+    size: number;
+}
+/**
+ * Response for orderbook query
+ */
+export interface OrderbookResponse {
+    symbol: string;
+    asks: OrderbookEntry[];
+    bids: OrderbookEntry[];
+    timestamp: number;
+}
+/**
+ * Query parameters for orderbook
+ *
+ * Note: While you can provide either symbol or market_id, the API endpoint only accepts market_id.
+ * If you provide a symbol, it will be converted to a market_id internally.
+ */
+export interface OrderbookQuery {
+    symbol?: string;
+    market_id?: number;
+}
+/**
+ * Response for timestamp query
+ */
+export interface TimestampResponse {
+    timestamp: number;
+}
+/**
+ * Response for action nonce query
+ */
+export interface ActionNonceResponse {
+    nonce: number;
+}
+/**
+ * WebSocket message types
+ */
+export declare enum WebSocketMessageType {
+    Subscribe = "subscribe",
+    Unsubscribe = "unsubscribe",
+    TradeUpdate = "trade",
+    DeltaUpdate = "delta",
+    UserUpdate = "user"
+}
+/**
+ * WebSocket subscription request
+ */
+export interface WebSocketSubscription {
+    type: WebSocketMessageType;
+    streams: string[];
+}
+/**
+ * WebSocket trade update message
+ */
+export interface WebSocketTradeUpdate {
+    type: WebSocketMessageType.TradeUpdate;
+    symbol: string;
+    trades: Trade[];
+    timestamp: number;
+}
+/**
+ * WebSocket delta update message
+ */
+export interface WebSocketDeltaUpdate {
+    type: WebSocketMessageType.DeltaUpdate;
+    last_update_id: number;
+    update_id: number;
+    market_symbol: string;
+    asks: OrderbookEntry[];
+    bids: OrderbookEntry[];
+    timestamp: number;
+}
+/**
+ * WebSocket user update message
+ */
+export interface WebSocketUserUpdate {
+    type: WebSocketMessageType.UserUpdate;
+    userId: number;
+    account: Account;
+    timestamp: number;
+}
+export type WebSocketMessage = WebSocketSubscription | WebSocketTradeUpdate | WebSocketDeltaUpdate | WebSocketUserUpdate;
 export {};

package/dist/types.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FillMode = exports.Side = exports.KeyType = exports.PeakTpsPeriodUnit = void 0;
+exports.WebSocketMessageType = exports.FillMode = exports.Side = exports.KeyType = exports.PeakTpsPeriodUnit = void 0;
 exports.fillModeToProtoFillMode = fillModeToProtoFillMode;
 const proto = __importStar(require("./gen/nord"));
 /**
@@ -90,3 +90,14 @@ function fillModeToProtoFillMode(x) {
         return proto.FillMode.FILL_OR_KILL;
     throw new Error("Invalid fill mode");
 }
+/**
+ * WebSocket message types
+ */
+var WebSocketMessageType;
+(function (WebSocketMessageType) {
+    WebSocketMessageType["Subscribe"] = "subscribe";
+    WebSocketMessageType["Unsubscribe"] = "unsubscribe";
+    WebSocketMessageType["TradeUpdate"] = "trade";
+    WebSocketMessageType["DeltaUpdate"] = "delta";
+    WebSocketMessageType["UserUpdate"] = "user";
+})(WebSocketMessageType || (exports.WebSocketMessageType = WebSocketMessageType = {}));

package/dist/utils.d.ts

@@ -3,6 +3,7 @@ import { KeyType, type Market, type Token } from "./types";
 import * as proto from "./gen/nord";
 import { ethers } from "ethers";
 import { RequestInfo, RequestInit, Response } from "node-fetch";
+import { BN } from "@coral-xyz/anchor";
 export declare const SESSION_TTL: bigint;
 export declare const ZERO_DECIMAL: Decimal;
 export declare const MAX_BUFFER_LEN = 10000;
@@ -112,3 +113,11 @@ export declare function decodeLengthDelimited<T, M extends proto.MessageFns<T>>(
 export declare function checkPubKeyLength(keyType: KeyType, len: number): void;
 export declare function findMarket(markets: Market[], marketId: number): Market;
 export declare function findToken(tokens: Token[], tokenId: number): Token;
+/**
+ * Convert a number to a BN with the specified number of decimals
+ *
+ * @param amount Amount as a number
+ * @param decimals Number of decimal places
+ * @returns Amount as a BN
+ */
+export declare function toBN(amount: number, decimals: number): BN;

package/dist/utils.js

@@ -18,6 +18,7 @@ exports.decodeLengthDelimited = decodeLengthDelimited;
 exports.checkPubKeyLength = checkPubKeyLength;
 exports.findMarket = findMarket;
 exports.findToken = findToken;
+exports.toBN = toBN;
 const decimal_js_1 = require("decimal.js");
 const ed25519_1 = require("@noble/curves/ed25519");
 const bls12_381_1 = require("@noble/curves/bls12-381");
@@ -27,7 +28,8 @@ const types_1 = require("./types");
 const wire_1 = require("@bufbuild/protobuf/wire");
 const ethers_1 = require("ethers");
 const node_fetch_1 = __importDefault(require("node-fetch"));
-exports.SESSION_TTL = 10n * 60n * 1000n * 10000n;
+const anchor_1 = require("@coral-xyz/anchor");
+exports.SESSION_TTL = 60n * 60n * 24n * 30n;
 exports.ZERO_DECIMAL = new decimal_js_1.Decimal(0);
 exports.MAX_BUFFER_LEN = 10000;
 const MAX_PAYLOAD_SIZE = 100 * 1024; // 100 kB
@@ -255,3 +257,20 @@ function findToken(tokens, tokenId) {
     }
     return tokens[tokenId];
 }
+/**
+ * Convert a number to a BN with the specified number of decimals
+ *
+ * @param amount Amount as a number
+ * @param decimals Number of decimal places
+ * @returns Amount as a BN
+ */
+function toBN(amount, decimals) {
+    const amountString = amount.toFixed(decimals);
+    const [whole, fraction] = amountString.split(".");
+    // Convert to smallest units (no decimals)
+    const wholeBN = new anchor_1.BN(whole).mul(new anchor_1.BN(10).pow(new anchor_1.BN(decimals)));
+    const fractionBN = fraction
+        ? new anchor_1.BN(fraction.padEnd(decimals, "0").slice(0, decimals))
+        : new anchor_1.BN(0);
+    return wholeBN.add(fractionBN);
+}

package/dist/websocket/NordWebSocketClient.d.ts

@@ -0,0 +1,71 @@
+import { EventEmitter } from "events";
+import { NordWebSocketClientEvents } from "./events";
+/**
+ * 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 declare class NordWebSocketClient extends EventEmitter implements NordWebSocketClientEvents {
+    private ws;
+    private url;
+    private subscriptions;
+    private reconnectAttempts;
+    private maxReconnectAttempts;
+    private reconnectDelay;
+    private pingInterval;
+    private pingTimeout;
+    private isBrowser;
+    /**
+     * Create a new NordWebSocketClient
+     * @param url WebSocket server URL
+     */
+    constructor(url: string);
+    /**
+     * Validate stream format
+     * @param stream Stream identifier to validate
+     * @throws Error if stream format is invalid
+     */
+    private validateStream;
+    /**
+     * Setup WebSocket ping/pong heartbeat
+     */
+    private setupHeartbeat;
+    /**
+     * Get the appropriate WebSocket class based on environment
+     */
+    private getWebSocketClass;
+    /**
+     * Connect to the Nord WebSocket server
+     */
+    connect(): void;
+    /**
+     * Subscribe to one or more streams
+     * @param streams Array of streams to subscribe to (e.g. ["trades@BTCUSDC", "deltas@BTCUSDC"])
+     */
+    subscribe(streams: string[]): void;
+    /**
+     * Unsubscribe from one or more streams
+     * @param streams Array of streams to unsubscribe from
+     */
+    unsubscribe(streams: string[]): void;
+    /**
+     * Close the WebSocket connection
+     */
+    close(): void;
+    /**
+     * Handle incoming WebSocket messages
+     * @param message WebSocket message
+     */
+    private handleMessage;
+    /**
+     * Attempt to reconnect to the WebSocket server
+     */
+    private reconnect;
+}