@n1xyz/nord-ts 0.0.1 → 0.0.4

package/dist/nord/Nord.d.ts

@@ -1,76 +1,249 @@
-import { ActionQuery, ActionResponse, ActionsResponse, AggregateMetrics, BlockQuery, BlockResponse, BlockSummaryResponse, type DeltaEvent, ERC20TokenInfo, type Market, NordConfig, PeakTpsPeriodUnit, RollmanActionResponse, RollmanActionsResponse, RollmanBlockResponse, MarketsStatsResponse, type SubscriberConfig, type Token, type Trades, type Account, type OrderbookResponse, type TradesResponse, type TradesQueryParams } from "../types";
-import { NordImpl } from "./NordImpl";
-export declare function depositOnlyTx(privateAddress: string, publicKey: Uint8Array, amount: number, precision: number, contractAddress: string): Promise<string>;
-export declare function depositOnlyTxRaw(privateAddress: string, publicKey: Uint8Array, amount: number, precision: number, contractAddress: string): Promise<string>;
+import { Account, ActionQuery, ActionResponse, ActionsResponse, AggregateMetrics, BlockQuery, BlockResponse, BlockSummaryResponse, Info, Market, MarketsStatsResponse, NordConfig, OrderbookQuery, OrderbookResponse, PeakTpsPeriodUnit, RollmanActionResponse, RollmanActionsResponse, RollmanBlockResponse, Token, TokenInfo, TradesQuery, TradesResponse, UserAccountIdsQuery, UserAccountIdsResponse } from "../types";
+import { NordWebSocketClient } from "../websocket/index";
+import { OrderbookSubscription, TradeSubscription } from "./Subscriber";
+/**
+ * Main Nord client class for interacting with the Nord API
+ */
 export declare class Nord {
-    impl: NordImpl;
-    evmUrl: string;
-    webServerUrl: string;
-    contractAddress: string;
-    tokenInfos: ERC20TokenInfo[];
+    /** Base URL for the Nord web server */
+    readonly webServerUrl: string;
+    /** Token information */
+    readonly tokenInfos: TokenInfo[];
+    /** Solana program ID */
+    readonly solanaProgramId?: string;
+    /** Solana RPC URL */
+    readonly solanaUrl?: string;
+    /** Available markets */
     markets: Market[];
+    /** Available tokens */
     tokens: Token[];
-    constructor({ evmUrl, webServerUrl, tokenInfos, contractAddress, }: NordConfig);
+    /** WebSocket client for real-time updates */
+    private readonly ws;
+    /**
+     * Create a new Nord client instance
+     *
+     * @param config - Configuration options for the Nord client
+     * @throws {Error} If required configuration is missing
+     */
+    constructor({ webServerUrl, tokenInfos, solanaProgramId, solanaUrl, }: NordConfig);
+    /**
+     * Get the current timestamp from the Nord server
+     *
+     * @returns Current timestamp as a bigint
+     * @throws {NordError} If the request fails
+     */
     getTimestamp(): Promise<bigint>;
+    /**
+     * Get the next action nonce from the Nord server
+     *
+     * @returns Next action nonce
+     * @throws {NordError} If the request fails
+     */
     getActionNonce(): Promise<number>;
+    /**
+     * Fetch information about Nord markets and tokens
+     *
+     * @throws {NordError} If the request fails
+     */
     fetchNordInfo(): Promise<void>;
+    /**
+     * Initialize a new Nord client
+     *
+     * @param nordConfig - Configuration options for the Nord client
+     * @returns Initialized Nord client
+     * @throws {NordError} If initialization fails
+     */
     static initNord(nordConfig: NordConfig): Promise<Nord>;
-    static initDevNord(): Promise<Nord>;
+    /**
+     * Get market statistics
+     *
+     * @returns Market statistics response
+     * @throws {NordError} If the request fails
+     */
     marketsStats(): Promise<MarketsStatsResponse>;
+    /**
+     * Query a specific block
+     *
+     * @param query - Block query parameters
+     * @returns Block response
+     * @throws {NordError} If the request fails
+     */
     queryBlock(query: BlockQuery): Promise<BlockResponse>;
+    /**
+     * Query the last N blocks
+     *
+     * @returns Block response for the last N blocks
+     * @throws {NordError} If the request fails
+     */
     queryLastNBlocks(): Promise<BlockResponse>;
+    /**
+     * Query recent blocks
+     *
+     * @param last_n - Number of recent blocks to query
+     * @returns Block summary response
+     * @throws {NordError} If the request fails
+     */
     queryRecentBlocks(last_n: number): Promise<BlockSummaryResponse>;
+    /**
+     * Query a specific action
+     *
+     * @param query - Action query parameters
+     * @returns Action response
+     * @throws {NordError} If the request fails
+     */
     queryAction(query: ActionQuery): Promise<ActionResponse>;
+    /**
+     * Query recent actions
+     *
+     * @param last_n - Number of recent actions to query
+     * @returns Actions response
+     * @throws {NordError} If the request fails
+     */
     queryRecentActions(last_n: number): Promise<ActionsResponse>;
+    /**
+     * Fetch aggregate metrics from the Nord API
+     *
+     * @param txPeakTpsPeriod - Period for peak TPS calculation
+     * @param txPeakTpsPeriodUnit - Unit for peak TPS period
+     * @returns Aggregate metrics
+     * @throws {NordError} If the request fails
+     */
     aggregateMetrics(txPeakTpsPeriod?: number, txPeakTpsPeriodUnit?: PeakTpsPeriodUnit): Promise<AggregateMetrics>;
-    getCurrentTps(period?: string): Promise<number>;
-    getPeakTps(period?: string): Promise<number>;
-    getMedianLatency(period?: string): Promise<number>;
-    getTotalTransactions(): Promise<string>;
+    /**
+     * Get current transactions per second
+     *
+     * @param period - Time period for the query
+     * @returns Current TPS value
+     * @throws {NordError} If the request fails
+     */
+    getCurrentTps(period?: string): Promise<any>;
+    /**
+     * Get peak transactions per second
+     *
+     * @param period - Time period for the query
+     * @returns Peak TPS value
+     * @throws {NordError} If the request fails
+     */
+    getPeakTps(period?: string): Promise<any>;
+    /**
+     * Get median transaction latency
+     *
+     * @param period - Time period for the query
+     * @returns Median latency in milliseconds
+     * @throws {NordError} If the request fails
+     */
+    getMedianLatency(period?: string): Promise<any>;
+    /**
+     * Get total transaction count
+     *
+     * @returns Total transaction count
+     * @throws {NordError} If the request fails
+     */
+    getTotalTransactions(): Promise<any>;
+    /**
+     * Query a block from Rollman
+     *
+     * @param query - Block query parameters
+     * @returns Rollman block response
+     * @throws {NordError} If the request fails
+     */
     blockQueryRollman(query: BlockQuery): Promise<RollmanBlockResponse>;
+    /**
+     * Query block summaries from Rollman
+     *
+     * @param last_n - Number of recent blocks to query
+     * @returns Block summary response
+     * @throws {NordError} If the request fails
+     */
     blockSummaryQueryRollman(last_n: number): Promise<BlockSummaryResponse>;
+    /**
+     * Query an action from Rollman
+     *
+     * @param query - Action query parameters
+     * @returns Rollman action response
+     * @throws {NordError} If the request fails
+     */
     actionQueryRollman(query: ActionQuery): Promise<RollmanActionResponse>;
+    /**
+     * Query actions from Rollman
+     *
+     * @param last_n - Number of recent actions to query
+     * @returns Rollman actions response
+     * @throws {NordError} If the request fails
+     */
     actionsQueryRollman(last_n: number): Promise<RollmanActionsResponse>;
+    /**
+     * Query Prometheus metrics
+     *
+     * @param params - Prometheus query parameters
+     * @returns Query result as a number
+     * @throws {NordError} If the request fails
+     */
     queryPrometheus(params: string): Promise<number>;
-    static approveTx(privateAddress: string, erc20address: string, contractAddress: string): Promise<void>;
     /**
-     * Fetches a sequence of actions between specified action IDs
-     * @param fromActionId - Starting action ID
-     * @param toActionId - Ending action ID
-     * @returns A promise that resolves to an ActionsResponse
+     * Get the WebSocket client
+     *
+     * @returns WebSocket client
      */
-    getActions(fromActionId: number, toActionId: number): Promise<ActionsResponse>;
+    getWebSocketClient(): NordWebSocketClient;
     /**
-     * Fetches trades for a specified account
-     * @param params - Query parameters for fetching trades
-     * @returns A promise that resolves to a TradesResponse
+     * Subscribe to orderbook updates for a market
+     *
+     * @param symbol - Market symbol
+     * @returns Orderbook subscription
      */
-    getTrades(params: TradesQueryParams): Promise<TradesResponse>;
+    subscribeOrderbook(symbol: string): OrderbookSubscription;
     /**
-     * Fetches the orderbook for a specified market
+     * Subscribe to trade updates for a market
+     *
      * @param symbol - Market symbol
-     * @returns A promise that resolves to an OrderbookResponse
+     * @returns Trade subscription
      */
-    getOrderbook(symbol: string): Promise<OrderbookResponse>;
-}
-export declare class Subscriber {
-    streamURL: string;
-    buffer: (DeltaEvent | Trades | Account)[];
-    maxBufferLen: number;
-    constructor(config: SubscriberConfig);
-    subscribe(): void;
+    subscribeTrades(symbol: string): TradeSubscription;
+    /**
+     * Get trades for a market
+     *
+     * @param query - Trades query parameters
+     * @returns Trades response
+     * @throws {NordError} If the request fails
+     */
+    getTrades(query: TradesQuery): Promise<TradesResponse>;
+    /**
+     * Get user account IDs
+     *
+     * @param query - User account IDs query parameters
+     * @returns User account IDs response
+     * @throws {NordError} If the request fails
+     */
+    getUserAccountIds(query: UserAccountIdsQuery): Promise<UserAccountIdsResponse>;
+    /**
+     * Get orderbook for a market
+     *
+     * @param query - Orderbook query parameters
+     * @returns Orderbook response
+     * @throws {NordError} If the request fails
+     */
+    getOrderbook(query: OrderbookQuery): Promise<OrderbookResponse>;
+    /**
+     * Get information about the Nord server
+     *
+     * @returns Information about markets and tokens
+     * @throws {NordError} If the request fails
+     */
+    getInfo(): Promise<Info>;
+    /**
+     * Get account information
+     *
+     * @param accountId - Account ID to get information for
+     * @returns Account information
+     * @throws {NordError} If the request fails
+     */
+    getAccount(accountId: number): Promise<Account>;
+    /**
+     * Get market statistics (alias for marketsStats for backward compatibility)
+     *
+     * @deprecated Use marketsStats instead
+     * @returns Market statistics response
+     */
+    getMarketStats(): Promise<MarketsStatsResponse>;
 }
-/**
- * Creates a WebSocket subscription to specified streams
- * @param baseUrl - Base URL of the API
- * @param streams - Array of streams to subscribe to
- * @returns A Subscriber instance
- *
- * Syntax for streams:
- * - trades@<symbol>: Subscribe to trades for a market
- * - deltas@<symbol>: Subscribe to orderbook deltas for a market
- * - user@<user id>: Subscribe to user account updates
- *
- * Example: createWebSocketSubscription('https://alpha-api.layern.network', ['trades@BTCUSDC', 'deltas@BTCUSDC', 'user@0'])
- */
-export declare function createWebSocketSubscription(baseUrl: string, streams: string[]): Subscriber;