@n1xyz/nord-ts 0.1.6 → 0.1.8

package/dist/{nord/client → client}/Nord.d.ts

@@ -1,26 +1,17 @@
 import { ProtonClient } from "@n1xyz/proton";
-import { PublicKey } from "@solana/web3.js";
+import { Connection, PublicKey } from "@solana/web3.js";
 import { EventEmitter } from "events";
-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";
+import { Client } from "openapi-fetch";
+import type { paths } from "../gen/openapi.ts";
+import { Account, AccountPnlPage, AccountPnlQuery, ActionResponse, MarketsInfo, Market, MarketStats, NordConfig, OrderbookQuery, OrderbookResponse, FeeTierConfig, Token, TradesResponse, User, AccountTriggerInfo, HistoryTriggerQuery, TriggerHistoryPage, FeeTierId, AccountFeeTierPage, PageResultStringOrderInfo, PageResultStringTrade, OrderInfoFromApi, TokenStats, FillRole, AdminInfo } from "../types";
+import { NordWebSocketClient } from "../websocket/index";
+import { OrderbookSubscription, TradeSubscription } from "../websocket/Subscriber";
 /**
  * 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
  */
@@ -28,7 +19,7 @@ export declare class Nord {
     /** Base URL for the Nord web server */
     readonly webServerUrl: string;
     /** Solana RPC URL */
-    readonly solanaUrl: string;
+    readonly solanaConnection: Connection;
     /** Available markets */
     markets: Market[];
     /** Available tokens */
@@ -38,7 +29,7 @@ export declare class Nord {
     /** Proton client for proton related operations */
     protonClient: ProtonClient;
     /** HTTP client for Nord operations */
-    private httpClient;
+    readonly httpClient: Client<paths>;
     /**
      * Create a new Nord client
      *
@@ -51,7 +42,9 @@ export declare class Nord {
     /**
      * Create a WebSocket client with specific subscriptions
      *
-     * @param options - Subscription options that specify which data streams to subscribe to
+     * @param trades - Market symbols to subscribe to for trade updates
+     * @param deltas - Market symbols to subscribe to for orderbook delta updates
+     * @param accounts - Account IDs to subscribe to for account updates
      * @returns A new WebSocket client with the requested subscriptions
      * @throws {NordError} If invalid subscription options are provided
      *
@@ -69,7 +62,11 @@ export declare class Nord {
      *   trades: ["BTCUSDC", "ETHUSDC"]
      * });
      */
-    createWebSocketClient(options: WebSocketSubscriptionOptions): NordWebSocketClient;
+    createWebSocketClient({ trades, deltas, accounts, }: Readonly<{
+        trades?: string[];
+        deltas?: string[];
+        accounts?: number[];
+    }>): NordWebSocketClient;
     private GET;
     /**
      * Get the current timestamp from the Nord server
@@ -85,12 +82,21 @@ export declare class Nord {
      * @throws {NordError} If the request fails
      */
     getActionNonce(): Promise<number>;
+    /**
+     * Get the admin list from the Nord server
+     *
+     * @returns List of admin registration keys paired with their ACL role mask
+     * @throws {NordError} If the request fails
+     */
+    getAdminList(): Promise<Array<AdminInfo>>;
     /**
      * Fetch information about Nord markets and tokens
      *
      * @throws {NordError} If the request fails
      */
     fetchNordInfo(): Promise<void>;
+    /** @deprecated use Nord.new */
+    static initNord(x: Readonly<NordConfig>): Promise<Nord>;
     /**
      * Initialize a new Nord client
      *
@@ -101,7 +107,7 @@ export declare class Nord {
      * @returns Initialized Nord client
      * @throws {NordError} If initialization fails
      */
-    static initNord({ app, solanaUrl, webServerUrl, protonUrl, }: Readonly<NordConfig>): Promise<Nord>;
+    static new({ app, solanaConnection, webServerUrl, protonUrl, }: Readonly<NordConfig>): Promise<Nord>;
     /**
      * Initialize the Nord client
      * @private
@@ -110,25 +116,25 @@ export declare class Nord {
     /**
      * Query a specific action
      *
-     * @param query - Action query parameters
+     * @param actionId - Action identifier to fetch
      * @returns Action response
      * @throws {NordError} If the request fails
      */
-    queryAction({ action_id, }: {
-        action_id: number;
-    }): Promise<ActionResponse | null>;
+    queryAction({ actionId, }: Readonly<{
+        actionId: number;
+    }>): Promise<ActionResponse | null>;
     /**
      * Query recent actions
      *
-     * @param from - Starting action index
-     * @param to - Ending action index
+     * @param from - Starting action index (inclusive)
+     * @param to - Ending action index (inclusive)
      * @returns Actions response
      * @throws {NordError} If the request fails
      */
-    queryRecentActions(query: {
+    queryRecentActions({ from, to, }: Readonly<{
         from: number;
         to: number;
-    }): Promise<ActionResponse[]>;
+    }>): Promise<ActionResponse[]>;
     /**
      * Get the last action ID
      *
@@ -136,54 +142,6 @@ export declare class Nord {
      * @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
      *
@@ -211,40 +169,48 @@ export declare class Nord {
     /**
      * Get trades for a market
      *
-     * @param query - Trades query parameters
+     * @param marketId - Market identifier to filter by
+     * @param takerId - Taker account identifier
+     * @param makerId - Maker account identifier
+     * @param takerSide - Side executed by the taker
+     * @param pageSize - Maximum number of trades to return
+     * @param since - RFC3339 timestamp to start from (inclusive)
+     * @param until - RFC3339 timestamp to end at (exclusive)
+     * @param pageId - Pagination cursor returned from a prior call
      * @returns Trades response
      * @throws {NordError} If the request fails
      */
-    getTrades(query: Readonly<{
+    getTrades({ marketId, takerId, makerId, takerSide, pageSize, since, until, startInclusive, }: Readonly<{
         marketId?: number;
         takerId?: number;
         makerId?: number;
         takerSide?: "bid" | "ask";
         pageSize?: number;
-        sinceRcf3339?: string;
-        untilRfc3339?: string;
-        pageId?: string;
+        since?: string;
+        until?: string;
+        startInclusive?: string;
     }>): Promise<TradesResponse>;
     /**
      * Get user account IDs
      *
-     * @param query - User account IDs query parameters
+     * @param pubkey - User public key to query
      * @returns User account IDs response
      * @throws {NordError} If the request fails
      */
-    getUser(query: {
+    getUser({ pubkey, }: Readonly<{
         pubkey: string | PublicKey;
-    }): Promise<User | null>;
+    }>): Promise<User | null>;
     /**
      * Get orderbook for a market
      *
-     * @param query - Orderbook query parameters (either market_id or symbol must be provided)
+     * @param symbol - Market symbol to resolve into an id
+     * @param marketId - Market identifier
      * @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>;
+    getOrderbook({ symbol, marketId, }: OrderbookQuery): Promise<OrderbookResponse>;
     /**
      * Get information about the Nord server
      *
@@ -295,50 +261,62 @@ export declare class Nord {
      * Get open orders for an account.
      *
      * @param accountId - Account id to query
-     * @param query - Optional pagination parameters
+     * @param startInclusive - Pagination cursor (client order id) to resume from
+     * @param pageSize - Maximum number of orders to return
      * @returns Page of orders keyed by client order id
      * @throws {NordError} If the request fails
      */
-    getAccountOrders(accountId: number, query?: {
+    getAccountOrders(accountId: number, { startInclusive, pageSize, }?: Readonly<{
         startInclusive?: string | null;
         pageSize?: number | null;
-    }): Promise<PageResultStringOrderInfo>;
+    }>): Promise<PageResultStringOrderInfo>;
     /**
      * List account fee tiers with pagination support.
+     *
+     * @param startInclusive - Account id cursor to resume from
+     * @param pageSize - Maximum number of entries to return
      */
-    getAccountsFeeTiers(query?: {
+    getAccountsFeeTiers({ startInclusive, pageSize, }?: Readonly<{
         startInclusive?: number | null;
         pageSize?: number | null;
-    }): Promise<AccountFeeTierPage>;
+    }>): Promise<AccountFeeTierPage>;
     /**
      * Get profit and loss history for an account
      *
      * @param accountId - Account ID to query
-     * @param query - Optional time and pagination filters
+     * @param since - RFC3339 timestamp to start from (inclusive)
+     * @param until - RFC3339 timestamp to end at (exclusive)
+     * @param startInclusive - Pagination cursor to resume from
+     * @param pageSize - Maximum number of entries to return
      * @returns Page of PnL entries ordered from latest to oldest
      * @throws {NordError} If the request fails
      */
-    getAccountPnl(accountId: number, query?: Partial<AccountPnlQuery>): Promise<AccountPnlPage>;
+    getAccountPnl(accountId: number, { since, until, startInclusive, pageSize, }?: Readonly<Partial<AccountPnlQuery>>): Promise<AccountPnlPage>;
     /**
      * Get market statistics (alias for marketsStats for backward compatibility)
      *
+     *
+     * @param marketId - Market identifier
+     *
      * @returns Market statistics response
      */
-    getMarketStats({ marketId, }: {
+    getMarketStats({ marketId, }: Readonly<{
         marketId: number;
-    }): Promise<MarketStats>;
+    }>): Promise<MarketStats>;
     /**
      * Fetch the per-market fee quote for an account.
      *
-     * @param params - Market id, fee kind, and account id to quote
+     * @param marketId - Market identifier
+     * @param feeKind - Fill role (maker/taker) to quote
+     * @param accountId - Account identifier to quote
      * @returns Fee in quote token units (negative means fee is charged)
      * @throws {NordError} If the request fails
      */
-    getMarketFee({ marketId, feeKind, accountId, }: {
+    getMarketFee({ marketId, feeKind, accountId, }: Readonly<{
         marketId: number;
         feeKind: FillRole;
         accountId: number;
-    }): Promise<number>;
+    }>): Promise<number>;
     /**
      * Fetch token statistics such as index price and oracle metadata.
      *
@@ -359,14 +337,15 @@ export declare class Nord {
      * Get trade history for a specific order.
      *
      * @param orderId - Order identifier
-     * @param query - Optional pagination parameters
+     * @param startInclusive - Trade pagination cursor
+     * @param pageSize - Maximum number of trades to return
      * @returns Page of trades associated with the order
      * @throws {NordError} If the request fails
      */
-    getOrderTrades(orderId: string, query?: {
+    getOrderTrades(orderId: string, { startInclusive, pageSize, }?: Readonly<{
         startInclusive?: string | null;
         pageSize?: number | null;
-    }): Promise<PageResultStringTrade>;
+    }>): Promise<PageResultStringTrade>;
     /**
      * Check if an account exists for the given address
      *
@@ -378,19 +357,23 @@ export declare class Nord {
     /**
      * Fetch active triggers for an account.
      *
-     * @param params Optional parameters containing an explicit account id.
+     * @param accountId - Account identifier owning the triggers
      * @throws {NordError} If no account can be resolved or the request fails.
      */
-    getAccountTriggers(params?: {
+    getAccountTriggers({ accountId, }?: Readonly<{
         accountId?: number;
-    }): Promise<AccountTriggerInfo[]>;
+    }>): Promise<AccountTriggerInfo[]>;
     /**
      * Fetch trigger history for an account.
      *
-     * @param params Optional parameters with account id and history query filters.
+     * @param accountId - Account identifier owning the triggers
+     * @param since - RFC3339 timestamp to start from (inclusive)
+     * @param until - RFC3339 timestamp to end at (exclusive)
+     * @param pageSize - Maximum number of entries to return
+     * @param startInclusive - Pagination cursor to resume from
      * @throws {NordError} If no account can be resolved or the request fails.
      */
-    getAccountTriggerHistory(params: HistoryTriggerQuery & {
+    getAccountTriggerHistory({ accountId, since, until, pageSize, startInclusive, }: Readonly<HistoryTriggerQuery & {
         accountId?: number;
-    }): Promise<TriggerHistoryPage>;
+    }>): Promise<TriggerHistoryPage>;
 }