@n1xyz/nord-ts 0.0.1 → 0.0.4

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import * as proto from "./gen/nord";
+import * as proto from './gen/nord';
 /**
  * The peak TPS rate is queried over the specified period.
  * The period is specified in units of: {hour, day, week, month, year}.
@@ -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"));
 /**
@@ -88,5 +88,16 @@ function fillModeToProtoFillMode(x) {
     }
     if (x === FillMode.FillOrKill)
         return proto.FillMode.FILL_OR_KILL;
-    throw new Error("Invalid fill mode");
+    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/errors.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Error handling utilities
+ * @module utils/errors
+ */
+/**
+ * Base error class for Nord SDK
+ */
+export declare class NordError extends Error {
+    /**
+     * Original error that caused this error
+     */
+    readonly cause?: Error;
+    /**
+     * Error code
+     */
+    readonly code?: string;
+    /**
+     * Create a new Nord error
+     *
+     * @param message - Error message
+     * @param options - Error options
+     */
+    constructor(message: string, options?: {
+        cause?: Error;
+        code?: string;
+    });
+}
+/**
+ * Error class for API errors
+ */
+export declare class NordApiError extends NordError {
+    /**
+     * HTTP status code
+     */
+    readonly statusCode: number;
+    /**
+     * API endpoint
+     */
+    readonly endpoint: string;
+    /**
+     * Create a new API error
+     *
+     * @param message - Error message
+     * @param statusCode - HTTP status code
+     * @param endpoint - API endpoint
+     * @param cause - Original error
+     */
+    constructor(message: string, statusCode: number, endpoint: string, cause?: Error);
+}
+/**
+ * Error class for validation errors
+ */
+export declare class NordValidationError extends NordError {
+    /**
+     * Field that failed validation
+     */
+    readonly field: string;
+    /**
+     * Create a new validation error
+     *
+     * @param message - Error message
+     * @param field - Field that failed validation
+     */
+    constructor(message: string, field: string);
+}
+/**
+ * Error class for WebSocket errors
+ */
+export declare class NordWebSocketError extends NordError {
+    /**
+     * Create a new WebSocket error
+     *
+     * @param message - Error message
+     * @param cause - Original error
+     */
+    constructor(message: string, cause?: Error);
+}
+/**
+ * Error class for authentication errors
+ */
+export declare class NordAuthError extends NordError {
+    /**
+     * Create a new authentication error
+     *
+     * @param message - Error message
+     * @param cause - Original error
+     */
+    constructor(message: string, cause?: Error);
+}
+/**
+ * Format an error for logging
+ *
+ * @param error - Error to format
+ * @returns Formatted error string
+ */
+export declare function formatError(error: unknown): string;

package/dist/utils/errors.js

@@ -0,0 +1,132 @@
+"use strict";
+/**
+ * Error handling utilities
+ * @module utils/errors
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NordAuthError = exports.NordWebSocketError = exports.NordValidationError = exports.NordApiError = exports.NordError = void 0;
+exports.formatError = formatError;
+/**
+ * Base error class for Nord SDK
+ */
+class NordError extends Error {
+    /**
+     * Create a new Nord error
+     *
+     * @param message - Error message
+     * @param options - Error options
+     */
+    constructor(message, options) {
+        super(message);
+        this.name = 'NordError';
+        if (options?.cause) {
+            this.cause = options.cause;
+        }
+        if (options?.code) {
+            this.code = options.code;
+        }
+        // Ensure prototype chain is properly set up
+        Object.setPrototypeOf(this, NordError.prototype);
+    }
+}
+exports.NordError = NordError;
+/**
+ * Error class for API errors
+ */
+class NordApiError extends NordError {
+    /**
+     * Create a new API error
+     *
+     * @param message - Error message
+     * @param statusCode - HTTP status code
+     * @param endpoint - API endpoint
+     * @param cause - Original error
+     */
+    constructor(message, statusCode, endpoint, cause) {
+        super(message, { cause });
+        this.name = 'NordApiError';
+        this.statusCode = statusCode;
+        this.endpoint = endpoint;
+        // Ensure prototype chain is properly set up
+        Object.setPrototypeOf(this, NordApiError.prototype);
+    }
+}
+exports.NordApiError = NordApiError;
+/**
+ * Error class for validation errors
+ */
+class NordValidationError extends NordError {
+    /**
+     * Create a new validation error
+     *
+     * @param message - Error message
+     * @param field - Field that failed validation
+     */
+    constructor(message, field) {
+        super(message);
+        this.name = 'NordValidationError';
+        this.field = field;
+        // Ensure prototype chain is properly set up
+        Object.setPrototypeOf(this, NordValidationError.prototype);
+    }
+}
+exports.NordValidationError = NordValidationError;
+/**
+ * Error class for WebSocket errors
+ */
+class NordWebSocketError extends NordError {
+    /**
+     * Create a new WebSocket error
+     *
+     * @param message - Error message
+     * @param cause - Original error
+     */
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = 'NordWebSocketError';
+        // Ensure prototype chain is properly set up
+        Object.setPrototypeOf(this, NordWebSocketError.prototype);
+    }
+}
+exports.NordWebSocketError = NordWebSocketError;
+/**
+ * Error class for authentication errors
+ */
+class NordAuthError extends NordError {
+    /**
+     * Create a new authentication error
+     *
+     * @param message - Error message
+     * @param cause - Original error
+     */
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = 'NordAuthError';
+        // Ensure prototype chain is properly set up
+        Object.setPrototypeOf(this, NordAuthError.prototype);
+    }
+}
+exports.NordAuthError = NordAuthError;
+/**
+ * Format an error for logging
+ *
+ * @param error - Error to format
+ * @returns Formatted error string
+ */
+function formatError(error) {
+    if (error instanceof NordApiError) {
+        return `API Error (${error.statusCode}) for ${error.endpoint}: ${error.message}`;
+    }
+    else if (error instanceof NordValidationError) {
+        return `Validation Error for field '${error.field}': ${error.message}`;
+    }
+    else if (error instanceof NordError) {
+        return `Nord Error: ${error.message}`;
+    }
+    else if (error instanceof Error) {
+        return `Error: ${error.message}`;
+    }
+    else {
+        return `Unknown error: ${String(error)}`;
+    }
+}

package/dist/utils/http.d.ts

@@ -0,0 +1,35 @@
+/**
+ * HTTP utilities for making API requests
+ * @module utils/http
+ */
+/**
+ * Make a GET request to the API
+ *
+ * @param baseUrl - Base URL for the API
+ * @param endpoint - API endpoint
+ * @param headers - Additional headers (optional)
+ * @returns Promise resolving to the response data
+ * @throws {NordApiError} If the request fails
+ */
+export declare function httpGet<T>(baseUrl: string, endpoint: string, headers?: Record<string, string>): Promise<T>;
+/**
+ * Make a POST request to the API
+ *
+ * @param baseUrl - Base URL for the API
+ * @param endpoint - API endpoint
+ * @param data - Request data
+ * @param headers - Additional headers (optional)
+ * @returns Promise resolving to the response data
+ * @throws {NordApiError} If the request fails
+ */
+export declare function httpPost<T>(baseUrl: string, endpoint: string, data: any, headers?: Record<string, string>): Promise<T>;
+/**
+ * Make a DELETE request to the API
+ *
+ * @param baseUrl - Base URL for the API
+ * @param endpoint - API endpoint
+ * @param headers - Additional headers (optional)
+ * @returns Promise resolving to the response data
+ * @throws {NordApiError} If the request fails
+ */
+export declare function httpDelete<T>(baseUrl: string, endpoint: string, headers?: Record<string, string>): Promise<T>;

package/dist/utils/http.js

@@ -0,0 +1,105 @@
+"use strict";
+/**
+ * HTTP utilities for making API requests
+ * @module utils/http
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.httpGet = httpGet;
+exports.httpPost = httpPost;
+exports.httpDelete = httpDelete;
+const errors_1 = require("./errors");
+/**
+ * Make a GET request to the API
+ *
+ * @param baseUrl - Base URL for the API
+ * @param endpoint - API endpoint
+ * @param headers - Additional headers (optional)
+ * @returns Promise resolving to the response data
+ * @throws {NordApiError} If the request fails
+ */
+async function httpGet(baseUrl, endpoint, headers = {}) {
+    const url = `${baseUrl}${endpoint.startsWith('/') ? '' : '/'}${endpoint}`;
+    try {
+        const response = await fetch(url, {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                ...headers,
+            },
+        });
+        if (!response.ok) {
+            throw new errors_1.NordApiError(`HTTP error ${response.status}: ${response.statusText}`, response.status, endpoint);
+        }
+        return await response.json();
+    }
+    catch (error) {
+        if (error instanceof errors_1.NordApiError) {
+            throw error;
+        }
+        throw new errors_1.NordApiError(`Failed to make GET request to ${endpoint}: ${error instanceof Error ? error.message : String(error)}`, 500, endpoint, error instanceof Error ? error : undefined);
+    }
+}
+/**
+ * Make a POST request to the API
+ *
+ * @param baseUrl - Base URL for the API
+ * @param endpoint - API endpoint
+ * @param data - Request data
+ * @param headers - Additional headers (optional)
+ * @returns Promise resolving to the response data
+ * @throws {NordApiError} If the request fails
+ */
+async function httpPost(baseUrl, endpoint, data, headers = {}) {
+    const url = `${baseUrl}${endpoint.startsWith('/') ? '' : '/'}${endpoint}`;
+    try {
+        const response = await fetch(url, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...headers,
+            },
+            body: JSON.stringify(data),
+        });
+        if (!response.ok) {
+            throw new errors_1.NordApiError(`HTTP error ${response.status}: ${response.statusText}`, response.status, endpoint);
+        }
+        return await response.json();
+    }
+    catch (error) {
+        if (error instanceof errors_1.NordApiError) {
+            throw error;
+        }
+        throw new errors_1.NordApiError(`Failed to make POST request to ${endpoint}: ${error instanceof Error ? error.message : String(error)}`, 500, endpoint, error instanceof Error ? error : undefined);
+    }
+}
+/**
+ * Make a DELETE request to the API
+ *
+ * @param baseUrl - Base URL for the API
+ * @param endpoint - API endpoint
+ * @param headers - Additional headers (optional)
+ * @returns Promise resolving to the response data
+ * @throws {NordApiError} If the request fails
+ */
+async function httpDelete(baseUrl, endpoint, headers = {}) {
+    const url = `${baseUrl}${endpoint.startsWith('/') ? '' : '/'}${endpoint}`;
+    try {
+        const response = await fetch(url, {
+            method: 'DELETE',
+            headers: {
+                'Content-Type': 'application/json',
+                ...headers,
+            },
+        });
+        if (!response.ok) {
+            throw new errors_1.NordApiError(`HTTP error ${response.status}: ${response.statusText}`, response.status, endpoint);
+        }
+        return await response.json();
+    }
+    catch (error) {
+        if (error instanceof errors_1.NordApiError) {
+            throw error;
+        }
+        throw new errors_1.NordApiError(`Failed to make DELETE request to ${endpoint}: ${error instanceof Error ? error.message : String(error)}`, 500, endpoint, error instanceof Error ? error : undefined);
+    }
+}