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

package/dist/nord/client/Nord.d.ts

@@ -1,284 +0,0 @@
-import { EventEmitter } from "events";
-import { Account, ActionQuery, ActionResponse, ActionsResponse, AggregateMetrics, Info, Market, MarketsStatsResponse, NordConfig, OrderbookQuery, OrderbookResponse, PeakTpsPeriodUnit, RollmanActionResponse, RollmanActionsResponse, Token, TradesQuery, TradesResponse, UserAccountIdsQuery, UserAccountIdsResponse } from "../../types";
-import { ProtonClient } from "@n1xyz/proton";
-import { NordWebSocketClient } from "../../websocket/index";
-import { OrderbookSubscription, TradeSubscription } from "../models/Subscriber";
-import { PublicKey } from "@solana/web3.js";
-/**
- * User subscription interface
- */
-export interface UserSubscription extends EventEmitter {
-    close: () => void;
-}
-/**
- * WebSocket subscription options interface
- */
-export interface WebSocketSubscriptionOptions {
-    /** Market symbols to subscribe to for trade updates */
-    trades?: string[];
-    /** Market symbols to subscribe to for orderbook delta updates */
-    deltas?: string[];
-    /** Account IDs to subscribe to for account updates */
-    accounts?: number[];
-}
-/**
- * Main Nord client class for interacting with the Nord API
- */
-export declare class Nord {
-    /** Base URL for the Nord web server */
-    readonly webServerUrl: string;
-    /** Bridge verification key */
-    readonly bridgeVk: PublicKey;
-    /** Solana RPC URL */
-    readonly solanaUrl: string;
-    /** Available markets */
-    markets: Market[];
-    /** Available tokens */
-    tokens: Token[];
-    /** Map of symbol to market_id */
-    private symbolToMarketId;
-    /** Proton client for bridge and indexd operations */
-    protonClient: ProtonClient;
-    /**
-     * Create a new Nord client
-     *
-     * @param config - Configuration options for the Nord client
-     * @param config.webServerUrl - Base URL for the Nord web server
-     * @param config.bridgeVk - Bridge verification key
-     * @param config.solanaUrl - Solana cluster URL
-     * @throws {Error} If required configuration is missing
-     */
-    private constructor();
-    /**
-     * Create a WebSocket client with specific subscriptions
-     *
-     * @param options - Subscription options that specify which data streams to subscribe to
-     * @returns A new WebSocket client with the requested subscriptions
-     * @throws {NordError} If invalid subscription options are provided
-     *
-     * @example
-     * // Create a client for trades and deltas from one market and an account
-     * const wsClient = nord.createWebSocketClient({
-     *   trades: ["BTCUSDC"],
-     *   deltas: ["BTCUSDC"],
-     *   accounts: [123]
-     * });
-     *
-     * @example
-     * // Create a client for trades from multiple markets
-     * const tradesClient = nord.createWebSocketClient({
-     *   trades: ["BTCUSDC", "ETHUSDC"]
-     * });
-     */
-    createWebSocketClient(options: WebSocketSubscriptionOptions): NordWebSocketClient;
-    /**
-     * 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 last event 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
-     * @param nordConfig.webServerUrl - Base URL for the Nord web server
-     * @param nordConfig.bridgeVk - Bridge verification key
-     * @param nordConfig.solanaUrl - Solana cluster URL
-     * @returns Initialized Nord client
-     * @throws {NordError} If initialization fails
-     */
-    static initNord({ bridgeVk: bridgeVk_, solanaUrl, webServerUrl, }: Readonly<NordConfig>): Promise<Nord>;
-    /**
-     * Initialize the Nord client
-     * @private
-     */
-    private init;
-    /**
-     * Get market statistics
-     *
-     * @returns Market statistics response
-     * @throws {NordError} If the request fails
-     */
-    marketsStats(): Promise<MarketsStatsResponse>;
-    /**
-     * 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 from - Starting action index
-     * @param to - Ending action index
-     * @returns Actions response
-     * @throws {NordError} If the request fails
-     */
-    queryRecentActions(from: number, to: number): Promise<ActionsResponse>;
-    /**
-     * Get the last action ID
-     *
-     * @returns Last action ID
-     * @throws {NordError} If the request fails
-     */
-    getLastActionId(): Promise<number>;
-    /**
-     * 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>;
-    /**
-     * 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<number>;
-    /**
-     * 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<number>;
-    /**
-     * 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<number>;
-    /**
-     * Get total transaction count
-     *
-     * @returns Total transaction count
-     * @throws {NordError} If the request fails
-     */
-    getTotalTransactions(): Promise<number>;
-    /**
-     * 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>;
-    /**
-     * Subscribe to orderbook updates for a market
-     *
-     * @param symbol - Market symbol
-     * @returns Orderbook subscription
-     * @throws {NordError} If symbol is invalid
-     */
-    subscribeOrderbook(symbol: string): OrderbookSubscription;
-    /**
-     * Subscribe to trade updates for a market
-     *
-     * @param symbol - Market symbol
-     * @returns Trade subscription
-     * @throws {NordError} If symbol is invalid
-     */
-    subscribeTrades(symbol: string): TradeSubscription;
-    /**
-     * Subscribe to account updates
-     *
-     * @param accountId - Account ID to subscribe to
-     * @returns User subscription
-     * @throws {NordError} If accountId is invalid
-     */
-    subscribeAccount(accountId: number): UserSubscription;
-    /**
-     * 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 (either market_id or symbol must be provided)
-     * @returns Orderbook response
-     * @throws {NordError} If the request fails or if the market symbol is unknown
-     * @remarks It's recommended to initialize the Nord client using the static `initNord` method
-     * to ensure market information is properly loaded before calling this method.
-     */
-    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>;
-    /**
-     * Check if an account exists for the given address
-     *
-     * @param address - The public key address to check
-     * @returns True if the account exists, false otherwise
-     */
-    accountExists(address: string): Promise<boolean>;
-}