@n1xyz/nord-ts 0.3.1 → 0.3.2

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

@@ -1,387 +0,0 @@
-import { ProtonClient } from "@n1xyz/proton";
-import { PublicKey } from "@solana/web3.js";
-import { EventEmitter } from "events";
-import { Client } from "openapi-fetch";
-import type { paths } from "../../gen/openapi.ts";
-import { Account, AccountPnlPage, AccountPnlQuery, ActionResponse, AggregateMetrics, MarketsInfo, Market, MarketStats, NordConfig, OrderbookQuery, OrderbookResponse, FeeTierConfig, PeakTpsPeriodUnit, Token, TradesResponse, User, AccountTriggerInfo, HistoryTriggerQuery, TriggerHistoryPage, FeeTierId, AccountFeeTierPage, PageResultStringOrderInfo, PageResultStringTrade, OrderInfoFromApi, TokenStats, FillRole } from "../../types";
-import { NordWebSocketClient } from "../../websocket/index";
-import { OrderbookSubscription, TradeSubscription } from "../models/Subscriber";
-/**
- * Main Nord client class for interacting with the Nord API
- */
-export declare class Nord {
-    /** Base URL for the Nord web server */
-    readonly webServerUrl: string;
-    /** 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 proton related operations */
-    protonClient: ProtonClient;
-    /** Shared HTTP client */
-    readonly client: Client<paths>;
-    /**
-     * 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.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: Readonly<{
-        trades?: string[];
-        deltas?: string[];
-        accounts?: number[];
-    }>): NordWebSocketClient;
-    private GET;
-    /**
-     * 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.app - App address
-     * @param nordConfig.solanaUrl - Solana cluster URL
-     * @returns Initialized Nord client
-     * @throws {NordError} If initialization fails
-     */
-    static initNord({ app, solanaUrl, webServerUrl, protonUrl, }: Readonly<NordConfig>): Promise<Nord>;
-    /**
-     * Initialize the Nord client
-     * @private
-     */
-    private init;
-    /**
-     * Query a specific action
-     *
-     * @param query - Action query parameters
-     * @returns Action response
-     * @throws {NordError} If the request fails
-     */
-    queryAction({ action_id, }: {
-        action_id: number;
-    }): Promise<ActionResponse | null>;
-    /**
-     * Query recent actions
-     *
-     * @param from - Starting action index
-     * @param to - Ending action index
-     * @returns Actions response
-     * @throws {NordError} If the request fails
-     */
-    queryRecentActions(query: {
-        from: number;
-        to: number;
-    }): Promise<ActionResponse[]>;
-    /**
-     * 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 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): EventEmitter<[never]> & {
-        close: () => void;
-    };
-    /**
-     * Get trades for a market
-     *
-     * @param query - Trades query parameters
-     * @returns Trades response
-     * @throws {NordError} If the request fails
-     */
-    getTrades(query: Readonly<{
-        marketId?: number;
-        takerId?: number;
-        makerId?: number;
-        takerSide?: "bid" | "ask";
-        pageSize?: number;
-        sinceRcf3339?: string;
-        untilRfc3339?: string;
-        pageId?: string;
-    }>): Promise<TradesResponse>;
-    /**
-     * Get user account IDs
-     *
-     * @param query - User account IDs query parameters
-     * @returns User account IDs response
-     * @throws {NordError} If the request fails
-     */
-    getUser(query: {
-        pubkey: string | PublicKey;
-    }): Promise<User | null>;
-    /**
-     * 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<MarketsInfo>;
-    /**
-     * Fetch the current fee tier brackets configured on Nord.
-     *
-     * @returns Array of fee tier identifiers paired with their configuration
-     * @throws {NordError} If the request fails
-     */
-    getFeeBrackets(): Promise<Array<[FeeTierId, FeeTierConfig]>>;
-    /**
-     * Retrieve the fee tier assigned to a specific account.
-     *
-     * @param accountId - Account identifier to query
-     * @returns Fee tier details for the requested account
-     * @throws {NordError} If the request fails
-     */
-    getAccountFeeTier(accountId: number): Promise<FeeTierId>;
-    /**
-     * 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 the public key associated with an account id.
-     *
-     * @param accountId - Account id to query
-     * @returns Base58-encoded account public key
-     * @throws {NordError} If the request fails
-     */
-    getAccountPubkey(accountId: number): Promise<string>;
-    /**
-     * Get the withdrawal fee charged for an account.
-     *
-     * @param accountId - Account id to query
-     * @returns Withdrawal fee quoted in quote token units
-     * @throws {NordError} If the request fails
-     */
-    getAccountWithdrawalFee(accountId: number): Promise<number>;
-    /**
-     * Get open orders for an account.
-     *
-     * @param accountId - Account id to query
-     * @param query - Optional pagination parameters
-     * @returns Page of orders keyed by client order id
-     * @throws {NordError} If the request fails
-     */
-    getAccountOrders(accountId: number, query?: {
-        startInclusive?: string | null;
-        pageSize?: number | null;
-    }): Promise<PageResultStringOrderInfo>;
-    /**
-     * List account fee tiers with pagination support.
-     */
-    getAccountsFeeTiers(query?: {
-        startInclusive?: number | null;
-        pageSize?: number | null;
-    }): Promise<AccountFeeTierPage>;
-    /**
-     * Get profit and loss history for an account
-     *
-     * @param accountId - Account ID to query
-     * @param query - Optional time and pagination filters
-     * @returns Page of PnL entries ordered from latest to oldest
-     * @throws {NordError} If the request fails
-     */
-    getAccountPnl(accountId: number, query?: Partial<AccountPnlQuery>): Promise<AccountPnlPage>;
-    /**
-     * Get market statistics (alias for marketsStats for backward compatibility)
-     *
-     * @returns Market statistics response
-     */
-    getMarketStats({ marketId, }: {
-        marketId: number;
-    }): Promise<MarketStats>;
-    /**
-     * Fetch the per-market fee quote for an account.
-     *
-     * @param params - Market id, fee kind, and account id to quote
-     * @returns Fee in quote token units (negative means fee is charged)
-     * @throws {NordError} If the request fails
-     */
-    getMarketFee({ marketId, feeKind, accountId, }: {
-        marketId: number;
-        feeKind: FillRole;
-        accountId: number;
-    }): Promise<number>;
-    /**
-     * Fetch token statistics such as index price and oracle metadata.
-     *
-     * @param tokenId - Token identifier
-     * @returns Token stats
-     * @throws {NordError} If the request fails
-     */
-    getTokenStats(tokenId: number): Promise<TokenStats>;
-    /**
-     * Get order summary by order id.
-     *
-     * @param orderId - Order identifier
-     * @returns Order information
-     * @throws {NordError} If the request fails
-     */
-    getOrder(orderId: string): Promise<OrderInfoFromApi>;
-    /**
-     * Get trade history for a specific order.
-     *
-     * @param orderId - Order identifier
-     * @param query - Optional pagination parameters
-     * @returns Page of trades associated with the order
-     * @throws {NordError} If the request fails
-     */
-    getOrderTrades(orderId: string, query?: {
-        startInclusive?: string | null;
-        pageSize?: number | null;
-    }): Promise<PageResultStringTrade>;
-    /**
-     * 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
-     * @deprecated use getUser instead
-     */
-    accountExists(pubkey: string | PublicKey): Promise<boolean>;
-    /**
-     * Fetch active triggers for an account.
-     *
-     * @param params Optional parameters containing an explicit account id.
-     * @throws {NordError} If no account can be resolved or the request fails.
-     */
-    getAccountTriggers(params?: {
-        accountId?: number;
-    }): Promise<AccountTriggerInfo[]>;
-    /**
-     * Fetch trigger history for an account.
-     *
-     * @param params Optional parameters with account id and history query filters.
-     * @throws {NordError} If no account can be resolved or the request fails.
-     */
-    getAccountTriggerHistory(params: HistoryTriggerQuery & {
-        accountId?: number;
-    }): Promise<TriggerHistoryPage>;
-}