@limitless-exchange/sdk 0.0.1 → 0.0.2

package/dist/index.d.mts

@@ -30,26 +30,138 @@ interface SignatureHeaders {
     'x-signature': string;
 }
 /**
- * User profile information returned after authentication.
+ * User rank information.
+ * @public
+ */
+interface UserRank {
+    /**
+     * Rank ID
+     */
+    id: number;
+    /**
+     * Rank name
+     */
+    name: string;
+    /**
+     * Fee rate in basis points
+     */
+    feeRateBps: number;
+}
+/**
+ * Referral data for a user.
+ * @public
+ */
+interface ReferralData {
+    /**
+     * Referral creation timestamp
+     */
+    createdAt: string;
+    /**
+     * Referral ID
+     */
+    id: number;
+    /**
+     * Referred user's profile ID
+     */
+    referredProfileId: number;
+    /**
+     * Profile picture URL
+     */
+    pfpUrl: string | null;
+    /**
+     * Display name
+     */
+    displayName: string;
+}
+/**
+ * User profile information returned after authentication (1:1 with API response).
  * @public
  */
 interface UserProfile {
+    /**
+     * User ID (used as ownerId for orders)
+     */
+    id: number;
     /**
      * User's Ethereum address (EOA)
      */
     account: string;
+    /**
+     * Client type used for authentication
+     */
+    client: ClientType;
+    /**
+     * User rank information containing feeRateBps
+     */
+    rank?: UserRank;
+    /**
+     * Account creation timestamp
+     */
+    createdAt?: string;
+    /**
+     * Username
+     */
+    username?: string;
     /**
      * Display name for the user
      */
-    displayName: string;
+    displayName?: string;
+    /**
+     * Profile picture URL
+     */
+    pfpUrl?: string;
+    /**
+     * User bio
+     */
+    bio?: string;
+    /**
+     * Social media URL
+     */
+    socialUrl?: string;
     /**
      * Smart wallet address (optional, required for ETHERSPOT client)
      */
     smartWallet?: string;
     /**
-     * Client type used for authentication
+     * Trade wallet option
      */
-    client: ClientType;
+    tradeWalletOption?: string;
+    /**
+     * Embedded account address
+     */
+    embeddedAccount?: string;
+    /**
+     * Total points
+     */
+    points?: number;
+    /**
+     * Accumulative points
+     */
+    accumulativePoints?: number;
+    /**
+     * Whether enrolled in points program
+     */
+    enrolledInPointsProgram?: boolean;
+    /**
+     * Position on leaderboard
+     */
+    leaderboardPosition?: number;
+    /**
+     * Whether user is in top 100
+     */
+    isTop100?: boolean;
+    /**
+     * Whether user is a captain
+     */
+    isCaptain?: boolean;
+    /**
+     * List of referral information
+     */
+    referralData?: ReferralData[];
+    /**
+     * Count of referred users
+     */
+    referredUsersCount?: number;
 }
 /**
  * Mode information from authentication response.
@@ -585,35 +697,177 @@ interface OrderSigningConfig {
  * Market-related types for Limitless Exchange.
  * @module types/markets
  */
+/**
+ * Collateral token information.
+ * @public
+ */
+interface CollateralToken {
+    /**
+     * Token contract address
+     */
+    address: string;
+    /**
+     * Token decimals
+     */
+    decimals: number;
+    /**
+     * Token symbol (e.g., "USDC")
+     */
+    symbol: string;
+}
+/**
+ * Market creator information.
+ * @public
+ */
+interface MarketCreator {
+    /**
+     * Creator name
+     */
+    name: string;
+    /**
+     * Creator image URL
+     */
+    imageURI?: string;
+    /**
+     * Creator link URL
+     */
+    link?: string;
+}
+/**
+ * Market metadata.
+ * @public
+ */
+interface MarketMetadata {
+    /**
+     * Fee enabled flag
+     */
+    fee: boolean;
+    /**
+     * Banner flag
+     */
+    isBannered?: boolean;
+    /**
+     * Polymarket arbitrage flag
+     */
+    isPolyArbitrage?: boolean;
+    /**
+     * Market making flag
+     */
+    shouldMarketMake?: boolean;
+    /**
+     * Opening price for oracle markets
+     */
+    openPrice?: string;
+}
+/**
+ * Market settings for CLOB markets.
+ * @public
+ */
+interface MarketSettings {
+    /**
+     * Minimum order size
+     */
+    minSize: string;
+    /**
+     * Maximum spread allowed
+     */
+    maxSpread: number;
+    /**
+     * Daily reward amount
+     */
+    dailyReward: string;
+    /**
+     * Rewards epoch duration
+     */
+    rewardsEpoch: string;
+    /**
+     * Constant parameter
+     */
+    c: string;
+}
+/**
+ * Trade prices for different order types.
+ * @public
+ */
+interface TradePrices {
+    /**
+     * Buy prices (market and limit) for yes/no tokens
+     */
+    buy: {
+        market: [number, number];
+        limit: [number, number];
+    };
+    /**
+     * Sell prices (market and limit) for yes/no tokens
+     */
+    sell: {
+        market: [number, number];
+        limit: [number, number];
+    };
+}
+/**
+ * Price oracle metadata for oracle-based markets.
+ * @public
+ */
+interface PriceOracleMetadata {
+    /**
+     * Asset ticker symbol
+     */
+    ticker: string;
+    /**
+     * Asset type (e.g., "CRYPTO")
+     */
+    assetType: string;
+    /**
+     * Pyth Network price feed address
+     */
+    pythAddress: string;
+    /**
+     * Price feed symbol
+     */
+    symbol: string;
+    /**
+     * Asset name
+     */
+    name: string;
+    /**
+     * Logo URL
+     */
+    logo: string;
+}
 /**
  * Orderbook entry (bid or ask).
+ * Matches API response format exactly (1:1 parity).
+ *
  * @public
  */
 interface OrderbookEntry {
     /**
-     * Price per share
+     * Price per share (0-1 range)
      */
     price: number;
     /**
-     * Size in shares (scaled by 1e6)
+     * Size in shares
      */
     size: number;
     /**
-     * Order side (BUY or SELL)
+     * Order side ("BUY" or "SELL")
      */
     side: string;
 }
 /**
  * Complete orderbook for a market.
+ * Matches API response format exactly (1:1 parity).
+ *
  * @public
  */
 interface OrderBook {
     /**
-     * Bid orders (buy orders)
+     * Bid orders (buy orders) sorted by price descending
      */
     bids: OrderbookEntry[];
     /**
-     * Ask orders (sell orders)
+     * Ask orders (sell orders) sorted by price ascending
      */
     asks: OrderbookEntry[];
     /**
@@ -621,13 +875,21 @@ interface OrderBook {
      */
     tokenId: string;
     /**
-     * Minimum order size
+     * Adjusted midpoint price between best bid and ask
+     */
+    adjustedMidpoint: number;
+    /**
+     * Maximum allowed spread for the market
+     */
+    maxSpread: string;
+    /**
+     * Minimum order size allowed
      */
     minSize: string;
     /**
-     * Last trade price
+     * Last trade price for the market
      */
-    lastTradePrice?: number;
+    lastTradePrice: number;
 }
 /**
  * Market price information.
@@ -670,7 +932,17 @@ interface MarketOutcome {
     price?: number;
 }
 /**
- * Complete market information.
+ * Market token IDs for CLOB markets.
+ * @public
+ */
+interface MarketTokens {
+    yes: string;
+    no: string;
+}
+/**
+ * Complete market information (1:1 with API response).
+ * Handles both CLOB single markets and NegRisk group markets.
+ *
  * @public
  */
 interface Market {
@@ -679,9 +951,9 @@ interface Market {
      */
     id: number;
     /**
-     * Market contract address
+     * Market slug identifier
      */
-    address: string | null;
+    slug: string;
     /**
      * Market title
      */
@@ -693,19 +965,23 @@ interface Market {
     /**
      * Market description
      */
-    description: string;
+    description?: string;
     /**
-     * Market slug identifier
+     * Collateral token information
      */
-    slug: string;
+    collateralToken: CollateralToken;
     /**
-     * Market type (CLOB or AMM)
+     * Human-readable expiration date
      */
-    type?: string;
+    expirationDate: string;
     /**
-     * Market outcomes
+     * Expiration timestamp in milliseconds
      */
-    outcomes?: MarketOutcome[];
+    expirationTimestamp: number;
+    /**
+     * Whether market is expired
+     */
+    expired?: boolean;
     /**
      * Creation timestamp
      */
@@ -714,12 +990,133 @@ interface Market {
      * Last update timestamp
      */
     updatedAt: string;
+    /**
+     * Market categories
+     */
+    categories: string[];
     /**
      * Market status
      */
-    status?: string;
+    status: string;
+    /**
+     * Creator information
+     */
+    creator: MarketCreator;
+    /**
+     * Market tags
+     */
+    tags: string[];
+    /**
+     * Trade type (clob or amm)
+     */
+    tradeType: string;
+    /**
+     * Market type (single or group)
+     */
+    marketType: string;
+    /**
+     * Priority index for sorting
+     */
+    priorityIndex: number;
+    /**
+     * Market metadata
+     */
+    metadata: MarketMetadata;
+    /**
+     * Trading volume
+     */
+    volume?: string;
+    /**
+     * Formatted trading volume
+     */
+    volumeFormatted?: string;
+    /**
+     * Condition ID (CLOB only)
+     */
+    conditionId?: string;
+    /**
+     * NegRisk request ID (CLOB only)
+     */
+    negRiskRequestId?: string | null;
+    /**
+     * Token IDs for yes/no outcomes (CLOB only)
+     * @example
+     * {
+     *   yes: "27687694610130623013351012526567944730242898906227824547270172934678693687246",
+     *   no: "9288900480010863316984252765488448624297561656655547117581633191173128271467"
+     * }
+     */
+    tokens?: MarketTokens;
+    /**
+     * Current prices [yes, no] (CLOB only)
+     */
+    prices?: number[];
+    /**
+     * Trade prices for buy/sell market/limit orders (CLOB only)
+     */
+    tradePrices?: TradePrices;
+    /**
+     * Whether market is rewardable (CLOB only)
+     */
+    isRewardable?: boolean;
+    /**
+     * Market settings (CLOB only)
+     */
+    settings?: MarketSettings;
+    /**
+     * Market logo URL
+     */
+    logo?: string | null;
+    /**
+     * Price oracle metadata (oracle markets only)
+     */
+    priceOracleMetadata?: PriceOracleMetadata;
+    /**
+     * Order within group (group markets only)
+     */
+    orderInGroup?: number;
+    /**
+     * Winning outcome index
+     */
+    winningOutcomeIndex?: number | null;
+    /**
+     * Outcome token names (group only)
+     */
+    outcomeTokens?: string[];
+    /**
+     * OG image URI (group only)
+     */
+    ogImageURI?: string;
+    /**
+     * NegRisk market ID (group only)
+     */
+    negRiskMarketId?: string;
+    /**
+     * Child markets in group (group only)
+     */
+    markets?: Market[];
+    /**
+     * Daily reward for group (group only)
+     */
+    dailyReward?: string;
+    /**
+     * Market contract address
+     * @deprecated Use conditionId instead
+     */
+    address?: string | null;
+    /**
+     * Market type (CLOB or AMM)
+     * @deprecated Use tradeType instead
+     */
+    type?: string;
+    /**
+     * Market outcomes
+     * @deprecated Use tokens for CLOB markets
+     */
+    outcomes?: MarketOutcome[];
     /**
      * Resolution timestamp
+     * @deprecated Use expirationTimestamp instead
      */
     resolutionDate?: string;
 }
@@ -749,7 +1146,7 @@ interface MarketsResponse {
  * Sort options for active markets.
  * @public
  */
-type ActiveMarketsSortBy = 'lp_rewards' | 'ending_soon' | 'newest' | 'high_value';
+type ActiveMarketsSortBy = 'lp_rewards' | 'ending_soon' | 'newest' | 'high_value' | 'liquidity';
 /**
  * Query parameters for active markets endpoint.
  * @public
@@ -1132,6 +1529,7 @@ interface PortfolioSummary {
  * WebSocket types for real-time data streaming.
  * @module types/websocket
  */
+
 /**
  * WebSocket connection configuration.
  * @public
@@ -1177,22 +1575,36 @@ declare enum WebSocketState {
  * Subscription channels for WebSocket events.
  * @public
  */
-type SubscriptionChannel = 'orderbook' | 'trades' | 'orders' | 'fills' | 'markets' | 'prices';
+type SubscriptionChannel = 'orderbook' | 'trades' | 'orders' | 'fills' | 'markets' | 'prices' | 'subscribe_market_prices' | 'subscribe_positions' | 'subscribe_transactions';
+/**
+ * Orderbook data structure (nested object in OrderbookUpdate).
+ * @public
+ */
+interface OrderbookData {
+    /** List of bid orders sorted by price descending */
+    bids: OrderbookEntry[];
+    /** List of ask orders sorted by price ascending */
+    asks: OrderbookEntry[];
+    /** Token ID for the orderbook */
+    tokenId: string;
+    /** Adjusted midpoint price */
+    adjustedMidpoint: number;
+    /** Maximum spread allowed */
+    maxSpread: number;
+    /** Minimum order size */
+    minSize: number;
+}
 /**
- * Orderbook update event.
+ * Orderbook update event - matches API format exactly.
  * @public
  */
 interface OrderbookUpdate {
+    /** Market slug identifier (camelCase to match API) */
     marketSlug: string;
-    bids: Array<{
-        price: number;
-        size: number;
-    }>;
-    asks: Array<{
-        price: number;
-        size: number;
-    }>;
-    timestamp: number;
+    /** Nested orderbook data object */
+    orderbook: OrderbookData;
+    /** Timestamp as Date or number after serialization */
+    timestamp: Date | number | string;
 }
 /**
  * Trade event.
@@ -1245,14 +1657,79 @@ interface MarketUpdate {
     timestamp: number;
 }
 /**
- * Price update event.
+ * Price update event (deprecated - use NewPriceData for AMM prices).
+ *
+ * Note: This type does not match the actual API response.
+ * Use NewPriceData for the correct AMM price update format.
+ *
  * @public
+ * @deprecated
  */
 interface PriceUpdate {
     marketSlug: string;
     price: number;
     timestamp: number;
 }
+/**
+ * Single AMM price entry in updatedPrices array.
+ * @public
+ */
+interface AmmPriceEntry {
+    /** Market ID */
+    marketId: number;
+    /** Market contract address */
+    marketAddress: string;
+    /** YES token price (0-1 range) */
+    yesPrice: number;
+    /** NO token price (0-1 range) */
+    noPrice: number;
+}
+/**
+ * AMM price update event (newPriceData) - matches API format exactly.
+ * @public
+ */
+interface NewPriceData {
+    /** Market contract address (camelCase to match API) */
+    marketAddress: string;
+    /** Array of price updates for this market */
+    updatedPrices: AmmPriceEntry[];
+    /** Blockchain block number */
+    blockNumber: number;
+    /** Timestamp as Date or number after serialization */
+    timestamp: Date | number | string;
+}
+/**
+ * Transaction event (blockchain transaction status).
+ * @public
+ */
+interface TransactionEvent {
+    /** User ID (optional) */
+    userId?: number;
+    /** Transaction hash (optional) */
+    txHash?: string;
+    /** Transaction status */
+    status: 'CONFIRMED' | 'FAILED';
+    /** Transaction source */
+    source: string;
+    /** Transaction timestamp */
+    timestamp: Date | string;
+    /** Market address (optional) */
+    marketAddress?: string;
+    /** Market slug identifier (optional) */
+    marketSlug?: string;
+    /** Token ID (optional) */
+    tokenId?: string;
+    /** Condition ID (optional) */
+    conditionId?: string;
+    /** Amount of contracts (optional, in string format) */
+    amountContracts?: string;
+    /** Amount of collateral (optional, in string format) */
+    amountCollateral?: string;
+    /** Price (optional, in string format) */
+    price?: string;
+    /** Trade side (optional) */
+    side?: 'BUY' | 'SELL';
+}
 /**
  * WebSocket event types.
  * @public
@@ -1275,9 +1752,13 @@ interface WebSocketEvents {
      */
     reconnecting: (attempt: number) => void;
     /**
-     * Orderbook updates
+     * Orderbook updates (CLOB markets) - API event name: orderbookUpdate
      */
-    orderbook: (data: OrderbookUpdate) => void;
+    orderbookUpdate: (data: OrderbookUpdate) => void;
+    /**
+     * AMM price updates - API event name: newPriceData
+     */
+    newPriceData: (data: NewPriceData) => void;
     /**
      * Trade events
      */
@@ -1295,7 +1776,16 @@ interface WebSocketEvents {
      */
     market: (data: MarketUpdate) => void;
     /**
-     * Price updates
+     * Position updates
+     */
+    positions: (data: any) => void;
+    /**
+     * Transaction events (blockchain confirmations)
+     */
+    tx: (data: TransactionEvent) => void;
+    /**
+     * Price updates (deprecated - use newPriceData)
+     * @deprecated
      */
     price: (data: PriceUpdate) => void;
 }
@@ -1402,6 +1892,54 @@ interface HttpClientConfig {
      * @defaultValue NoOpLogger (no logging)
      */
     logger?: ILogger;
+    /**
+     * Enable HTTP connection pooling with keepAlive
+     * @defaultValue true
+     * @remarks
+     * When enabled, HTTP connections are reused across requests, reducing latency by 30-50%.
+     * Recommended for production environments with high request volume.
+     */
+    keepAlive?: boolean;
+    /**
+     * Maximum number of sockets to allow per host
+     * @defaultValue 50
+     * @remarks
+     * Controls the connection pool size. Higher values allow more concurrent requests
+     * but consume more system resources.
+     */
+    maxSockets?: number;
+    /**
+     * Maximum number of free sockets to keep open per host
+     * @defaultValue 10
+     * @remarks
+     * Determines how many idle connections to maintain in the pool.
+     * Keeping connections open reduces latency for subsequent requests.
+     */
+    maxFreeSockets?: number;
+    /**
+     * Socket timeout in milliseconds
+     * @defaultValue 60000
+     * @remarks
+     * Time to wait before closing an idle socket connection.
+     */
+    socketTimeout?: number;
+    /**
+     * Additional headers to include in all requests
+     * @remarks
+     * These headers will be merged with default headers and sent with every request.
+     * Can be overridden by per-request headers.
+     *
+     * @example
+     * ```typescript
+     * const client = new HttpClient({
+     *   additionalHeaders: {
+     *     'X-Custom-Header': 'value',
+     *     'X-API-Version': 'v1'
+     *   }
+     * });
+     * ```
+     */
+    additionalHeaders?: Record<string, string>;
 }
 /**
  * HTTP client wrapper for Limitless Exchange API.
@@ -3012,4 +3550,4 @@ declare class WebSocketClient {
     private getChannelFromKey;
 }
 
-export { type AMMPosition, APIError, type ActiveMarketsParams, type ActiveMarketsResponse, type ActiveMarketsSortBy, type AuthResult, AuthenticatedClient, type AuthenticatedClientConfig, Authenticator, BASE_SEPOLIA_CHAIN_ID, type BaseOrderArgs, type CLOBPosition, CONTRACT_ADDRESSES, type ClientType, ConsoleLogger, type CreatedOrder, DEFAULT_API_URL, DEFAULT_CHAIN_ID, DEFAULT_WS_URL, type FOKOrderArgs, type FillEvent, type GTCOrderArgs, HttpClient, type HttpClientConfig, type ILogger, type LatestTrade, type LoginOptions, type Market, MarketFetcher, type MarketOutcome, type MarketPrice, MarketType, type MarketUpdate, type MarketsResponse, MessageSigner, type ModeInfo, type NewOrderPayload, NoOpLogger, type OrderArgs, type OrderBook, OrderBuilder, OrderClient, type OrderClientConfig, type OrderMatch, type OrderResponse, OrderSigner, type OrderSigningConfig, OrderType, type OrderUpdate, type OrderbookEntry, type OrderbookUpdate, PortfolioFetcher, type PortfolioPositionsResponse, type PortfolioSummary, type Position, type PositionMarket, type PositionSide, type PriceUpdate, RetryConfig, type RetryConfigOptions, RetryableClient, SIGNING_MESSAGE_TEMPLATE, Side, type SignatureHeaders, SignatureType, type SignedOrder, type SubscriptionChannel, type SubscriptionOptions, type TokenBalance, type TradeEvent, type TradingMode, type UnsignedOrder, type UserData, type UserProfile, ValidationError, WebSocketClient, type WebSocketConfig, type WebSocketEvents, WebSocketState, ZERO_ADDRESS, getContractAddress, retryOnErrors, validateOrderArgs, validateSignedOrder, validateUnsignedOrder, withRetry };
+export { type AMMPosition, APIError, type ActiveMarketsParams, type ActiveMarketsResponse, type ActiveMarketsSortBy, type AmmPriceEntry, type AuthResult, AuthenticatedClient, type AuthenticatedClientConfig, Authenticator, BASE_SEPOLIA_CHAIN_ID, type BaseOrderArgs, type CLOBPosition, CONTRACT_ADDRESSES, type ClientType, type CollateralToken, ConsoleLogger, type CreatedOrder, DEFAULT_API_URL, DEFAULT_CHAIN_ID, DEFAULT_WS_URL, type FOKOrderArgs, type FillEvent, type GTCOrderArgs, HttpClient, type HttpClientConfig, type ILogger, type LatestTrade, type LoginOptions, type Market, type MarketCreator, MarketFetcher, type MarketMetadata, type MarketOutcome, type MarketPrice, type MarketSettings, type MarketTokens, MarketType, type MarketUpdate, type MarketsResponse, MessageSigner, type ModeInfo, type NewOrderPayload, type NewPriceData, NoOpLogger, type OrderArgs, type OrderBook, OrderBuilder, OrderClient, type OrderClientConfig, type OrderMatch, type OrderResponse, OrderSigner, type OrderSigningConfig, OrderType, type OrderUpdate, type OrderbookData, type OrderbookEntry, type OrderbookUpdate, PortfolioFetcher, type PortfolioPositionsResponse, type PortfolioSummary, type Position, type PositionMarket, type PositionSide, type PriceOracleMetadata, type PriceUpdate, type ReferralData, RetryConfig, type RetryConfigOptions, RetryableClient, SIGNING_MESSAGE_TEMPLATE, Side, type SignatureHeaders, SignatureType, type SignedOrder, type SubscriptionChannel, type SubscriptionOptions, type TokenBalance, type TradeEvent, type TradePrices, type TradingMode, type TransactionEvent, type UnsignedOrder, type UserData, type UserProfile, type UserRank, ValidationError, WebSocketClient, type WebSocketConfig, type WebSocketEvents, WebSocketState, ZERO_ADDRESS, getContractAddress, retryOnErrors, validateOrderArgs, validateSignedOrder, validateUnsignedOrder, withRetry };