@limitless-exchange/sdk 0.0.2 → 0.0.3

package/dist/index.d.ts

@@ -309,14 +309,6 @@ declare enum OrderType {
     /** Good-Til-Cancelled: Remain on orderbook until filled or cancelled */
     GTC = "GTC"
 }
-/**
- * Market type enum.
- * @public
- */
-declare enum MarketType {
-    CLOB = "CLOB",
-    NEGRISK = "NEGRISK"
-}
 /**
  * Signature type enum.
  * @public
@@ -342,11 +334,6 @@ interface BaseOrderArgs {
      * Order side (BUY or SELL)
      */
     side: Side;
-    /**
-     * Market type (CLOB or NEGRISK)
-     * @defaultValue 'CLOB'
-     */
-    marketType?: MarketType;
     /**
      * Expiration timestamp (0 for no expiration)
      * @defaultValue '0'
@@ -684,13 +671,9 @@ interface OrderSigningConfig {
      */
     chainId: number;
     /**
-     * Contract address for verification
+     * Contract address for verification (from venue.exchange)
      */
     contractAddress: string;
-    /**
-     * Market type (CLOB or NEGRISK)
-     */
-    marketType: MarketType;
 }
 
 /**
@@ -931,6 +914,35 @@ interface MarketOutcome {
      */
     price?: number;
 }
+/**
+ * Venue information for CLOB markets.
+ *
+ * @remarks
+ * Contains contract addresses required for trading:
+ * - exchange: Used as verifyingContract for EIP-712 order signing
+ * - adapter: Required for NegRisk/Grouped market SELL approvals
+ *
+ * @public
+ */
+interface Venue {
+    /**
+     * Exchange contract address.
+     *
+     * @remarks
+     * This address is used as the verifyingContract in EIP-712 order signing.
+     * All BUY orders require USDC approval to this address.
+     * Simple CLOB SELL orders require CT approval to this address.
+     */
+    exchange: string;
+    /**
+     * Adapter contract address.
+     *
+     * @remarks
+     * Required for NegRisk/Grouped markets only.
+     * SELL orders on NegRisk markets require CT approval to both exchange AND adapter.
+     */
+    adapter: string;
+}
 /**
  * Market token IDs for CLOB markets.
  * @public
@@ -1063,6 +1075,17 @@ interface Market {
      * Market settings (CLOB only)
      */
     settings?: MarketSettings;
+    /**
+     * Venue information for CLOB markets.
+     *
+     * @remarks
+     * Contains exchange and adapter contract addresses for order signing and approvals.
+     * The exchange address is used as verifyingContract in EIP-712 signatures.
+     *
+     * Performance tip: Call getMarket() before createOrder() to cache venue data
+     * and avoid additional API requests during order creation.
+     */
+    venue?: Venue;
     /**
      * Market logo URL
      */
@@ -2552,22 +2575,34 @@ declare const SIGNING_MESSAGE_TEMPLATE = "Welcome to Limitless.exchange! Please
 declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
 /**
  * Contract addresses by network
+ *
+ * @remarks
+ * Note: CLOB and NegRisk exchange addresses are provided dynamically via the venue system
+ * (market.venue.exchange and market.venue.adapter). These addresses vary per market and
+ * should be fetched from the API rather than hardcoded.
+ *
  * @public
  */
 declare const CONTRACT_ADDRESSES: {
     readonly 8453: {
-        readonly CLOB: "0xa4409D988CA2218d956BeEFD3874100F444f0DC3";
-        readonly NEGRISK: "0x5a38afc17F7E97ad8d6C547ddb837E40B4aEDfC6";
+        readonly USDC: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913";
+        readonly CTF: "0xC9c98965297Bc527861c898329Ee280632B76e18";
     };
     readonly 84532: {
-        readonly CLOB: "0x...";
-        readonly NEGRISK: "0x...";
+        readonly USDC: "0x...";
+        readonly CTF: "0x...";
     };
 };
 /**
- * Get contract address for a specific market type and chain
+ * Get contract address for tokens (USDC or CTF)
+ *
+ * @remarks
+ * For CLOB and NegRisk exchange addresses, use the venue system instead:
+ * - Fetch market via `marketFetcher.getMarket(slug)`
+ * - Use `market.venue.exchange` for signing and approvals
+ * - Use `market.venue.adapter` for NegRisk adapter approvals
  *
- * @param marketType - Market type (CLOB or NEGRISK)
+ * @param contractType - Contract type (USDC or CTF)
  * @param chainId - Chain ID (default: 8453 for Base mainnet)
  * @returns Contract address
  *
@@ -2575,7 +2610,7 @@ declare const CONTRACT_ADDRESSES: {
  *
  * @public
  */
-declare function getContractAddress(marketType: 'CLOB' | 'NEGRISK', chainId?: number): string;
+declare function getContractAddress(contractType: 'USDC' | 'CTF', chainId?: number): string;
 
 /**
  * Order builder for constructing unsigned order payloads.
@@ -2639,8 +2674,7 @@ declare class OrderBuilder {
      * const fokOrder = builder.buildOrder({
      *   tokenId: '123456',
      *   makerAmount: 50,  // 50 USDC to spend
-     *   side: Side.BUY,
-     *   marketType: MarketType.CLOB
+     *   side: Side.BUY
      * });
      *
      * // GTC order (price + size)
@@ -2648,8 +2682,7 @@ declare class OrderBuilder {
      *   tokenId: '123456',
      *   price: 0.38,
      *   size: 22.123,  // Will be rounded to tick-aligned: 22.123 shares
-     *   side: Side.BUY,
-     *   marketType: MarketType.CLOB
+     *   side: Side.BUY
      * });
      * ```
      */
@@ -2803,8 +2836,7 @@ declare class OrderSigner {
      * ```typescript
      * const signature = await signer.signOrder(unsignedOrder, {
      *   chainId: 8453,
-     *   contractAddress: '0x...',
-     *   marketType: MarketType.CLOB
+     *   contractAddress: '0x...'
      * });
      * ```
      */
@@ -2891,6 +2923,139 @@ declare function validateUnsignedOrder(order: UnsignedOrder): void;
  */
 declare function validateSignedOrder(order: SignedOrder): void;
 
+/**
+ * Market data fetcher for Limitless Exchange.
+ * @module markets/fetcher
+ */
+
+/**
+ * Market data fetcher for retrieving market information and orderbooks.
+ *
+ * @remarks
+ * This class provides methods to fetch market data, orderbooks, and prices
+ * from the Limitless Exchange API.
+ *
+ * Venue caching: When fetching market data, venue information is automatically
+ * cached for efficient order signing. This eliminates redundant API calls when
+ * creating orders for the same market.
+ *
+ * @public
+ */
+declare class MarketFetcher {
+    private httpClient;
+    private logger;
+    private venueCache;
+    /**
+     * Creates a new market fetcher instance.
+     *
+     * @param httpClient - HTTP client for API requests
+     * @param logger - Optional logger for debugging (default: no logging)
+     *
+     * @example
+     * ```typescript
+     * const fetcher = new MarketFetcher(httpClient);
+     * ```
+     */
+    constructor(httpClient: HttpClient, logger?: ILogger);
+    /**
+     * Gets active markets with query parameters and pagination support.
+     *
+     * @param params - Query parameters for filtering and pagination
+     * @returns Promise resolving to active markets response
+     * @throws Error if API request fails
+     *
+     * @example
+     * ```typescript
+     * // Get 8 markets sorted by LP rewards
+     * const response = await fetcher.getActiveMarkets({
+     *   limit: 8,
+     *   sortBy: 'lp_rewards'
+     * });
+     * console.log(`Found ${response.data.length} of ${response.totalMarketsCount} markets`);
+     *
+     * // Get page 2
+     * const page2 = await fetcher.getActiveMarkets({
+     *   limit: 8,
+     *   page: 2,
+     *   sortBy: 'ending_soon'
+     * });
+     * ```
+     */
+    getActiveMarkets(params?: ActiveMarketsParams): Promise<ActiveMarketsResponse>;
+    /**
+     * Gets a single market by slug.
+     *
+     * @remarks
+     * Automatically caches venue information for efficient order signing.
+     * Always call this method before creating orders to ensure venue data
+     * is available and avoid additional API requests.
+     *
+     * @param slug - Market slug identifier
+     * @returns Promise resolving to market details
+     * @throws Error if API request fails or market not found
+     *
+     * @example
+     * ```typescript
+     * const market = await fetcher.getMarket('bitcoin-price-2024');
+     * console.log(`Market: ${market.title}`);
+     *
+     * // Venue is now cached for order signing
+     * await orderClient.createOrder({
+     *   marketSlug: 'bitcoin-price-2024',
+     *   ...
+     * });
+     * ```
+     */
+    getMarket(slug: string): Promise<Market>;
+    /**
+     * Gets cached venue information for a market.
+     *
+     * @remarks
+     * Returns venue data previously cached by getMarket() call.
+     * Used internally by OrderClient for efficient order signing.
+     *
+     * @param slug - Market slug identifier
+     * @returns Cached venue information, or undefined if not in cache
+     *
+     * @example
+     * ```typescript
+     * const venue = fetcher.getVenue('bitcoin-price-2024');
+     * if (venue) {
+     *   console.log(`Exchange: ${venue.exchange}`);
+     * }
+     * ```
+     */
+    getVenue(slug: string): Venue | undefined;
+    /**
+     * Gets the orderbook for a CLOB market.
+     *
+     * @param slug - Market slug identifier
+     * @returns Promise resolving to orderbook data
+     * @throws Error if API request fails
+     *
+     * @example
+     * ```typescript
+     * const orderbook = await fetcher.getOrderBook('bitcoin-price-2024');
+     * console.log(`Bids: ${orderbook.bids.length}, Asks: ${orderbook.asks.length}`);
+     * ```
+     */
+    getOrderBook(slug: string): Promise<OrderBook>;
+    /**
+     * Gets the current price for a token.
+     *
+     * @param tokenId - Token ID
+     * @returns Promise resolving to price information
+     * @throws Error if API request fails
+     *
+     * @example
+     * ```typescript
+     * const price = await fetcher.getPrice('123456');
+     * console.log(`Current price: ${price.price}`);
+     * ```
+     */
+    getPrice(tokenId: string): Promise<MarketPrice>;
+}
+
 /**
  * Order client for managing orders on Limitless Exchange.
  * @module orders/client
@@ -2900,9 +3065,11 @@ declare function validateSignedOrder(order: SignedOrder): void;
  * Configuration for the order client.
  *
  * @remarks
- * The order client supports two configuration modes:
- * 1. Simple mode: Provide userData and marketType (auto-configures signing)
- * 2. Advanced mode: Provide userData and custom signingConfig
+ * The order client auto-configures signing based on venue data from the API.
+ * Custom signingConfig is optional for advanced use cases.
+ *
+ * Performance tip: Provide a shared marketFetcher instance to enable venue caching
+ * across market fetches and order creation, avoiding redundant API calls.
  *
  * @public
  */
@@ -2928,23 +3095,41 @@ interface OrderClientConfig {
      */
     userData: UserData;
     /**
-     * Market type for auto-configuration (optional if signingConfig provided)
+     * Custom signing configuration (optional)
      *
      * @remarks
-     * When provided without signingConfig, automatically loads contract address
-     * from environment variables or SDK defaults.
-     *
-     * @defaultValue MarketType.CLOB
+     * If not provided, SDK will auto-configure from venue data.
+     * Useful for custom deployments or testing.
      */
-    marketType?: MarketType;
+    signingConfig?: OrderSigningConfig;
     /**
-     * Custom signing configuration (optional)
+     * Shared MarketFetcher instance for venue caching (optional)
      *
      * @remarks
-     * If not provided, SDK will auto-configure based on marketType.
-     * Useful for custom deployments or testing.
+     * When provided, enables efficient venue caching across market fetches and order creation.
+     * If not provided, OrderClient creates its own internal MarketFetcher instance.
+     *
+     * Best practice: Share the same MarketFetcher instance between market operations
+     * and order creation for optimal performance.
+     *
+     * @example
+     * ```typescript
+     * const marketFetcher = new MarketFetcher(httpClient);
+     * const orderClient = new OrderClient({
+     *   httpClient,
+     *   wallet,
+     *   userData,
+     *   marketFetcher  // Shared instance
+     * });
+     *
+     * // Venue is cached
+     * await marketFetcher.getMarket('bitcoin-2024');
+     *
+     * // Uses cached venue, no extra API call
+     * await orderClient.createOrder({ marketSlug: 'bitcoin-2024', ... });
+     * ```
      */
-    signingConfig?: OrderSigningConfig;
+    marketFetcher?: MarketFetcher;
     /**
      * Optional logger
      */
@@ -2957,17 +3142,21 @@ interface OrderClientConfig {
  * This class provides high-level methods for order operations,
  * abstracting away HTTP details and order signing complexity.
  *
+ * Uses dynamic venue addressing for EIP-712 order signing. For best performance,
+ * always call marketFetcher.getMarket() before creating orders to cache venue data.
+ *
  * @example
  * ```typescript
  * const orderClient = new OrderClient({
  *   httpClient,
  *   wallet,
- *   ownerId: 123,
- *   feeRateBps: 100,
+ *   userData: {
+ *     userId: 123,
+ *     feeRateBps: 100
+ *   },
  *   signingConfig: {
  *     chainId: 8453,
- *     contractAddress: '0x...',
- *     marketType: MarketType.CLOB
+ *     contractAddress: '0x...'
  *   }
  * });
  *
@@ -2987,6 +3176,7 @@ declare class OrderClient {
     private httpClient;
     private orderBuilder;
     private orderSigner;
+    private marketFetcher;
     private ownerId;
     private signingConfig;
     private logger;
@@ -2994,8 +3184,6 @@ declare class OrderClient {
      * Creates a new order client instance.
      *
      * @param config - Order client configuration
-     *
-     * @throws Error if neither marketType nor signingConfig is provided
      */
     constructor(config: OrderClientConfig);
     /**
@@ -3003,24 +3191,31 @@ declare class OrderClient {
      *
      * @remarks
      * This method handles the complete order creation flow:
-     * 1. Build unsigned order
-     * 2. Sign with EIP-712
-     * 3. Submit to API
+     * 1. Resolve venue address (from cache or API)
+     * 2. Build unsigned order
+     * 3. Sign with EIP-712 using venue.exchange as verifyingContract
+     * 4. Submit to API
+     *
+     * Performance best practice: Always call marketFetcher.getMarket(marketSlug)
+     * before createOrder() to cache venue data and avoid additional API requests.
      *
      * @param params - Order parameters
      * @returns Promise resolving to order response
      *
-     * @throws Error if order creation fails
+     * @throws Error if order creation fails or venue not found
      *
      * @example
      * ```typescript
+     * // Best practice: fetch market first to cache venue
+     * const market = await marketFetcher.getMarket('bitcoin-2024');
+     *
      * const order = await orderClient.createOrder({
-     *   tokenId: '123456',
+     *   tokenId: market.tokens.yes,
      *   price: 0.65,
      *   size: 100,
      *   side: Side.BUY,
      *   orderType: OrderType.GTC,
-     *   marketSlug: 'market-slug'
+     *   marketSlug: 'bitcoin-2024'
      * });
      *
      * console.log(`Order created: ${order.order.id}`);
@@ -3131,104 +3326,6 @@ declare class OrderClient {
     signOrder(order: UnsignedOrder): Promise<string>;
 }
 
-/**
- * Market data fetcher for Limitless Exchange.
- * @module markets/fetcher
- */
-
-/**
- * Market data fetcher for retrieving market information and orderbooks.
- *
- * @remarks
- * This class provides methods to fetch market data, orderbooks, and prices
- * from the Limitless Exchange API.
- *
- * @public
- */
-declare class MarketFetcher {
-    private httpClient;
-    private logger;
-    /**
-     * Creates a new market fetcher instance.
-     *
-     * @param httpClient - HTTP client for API requests
-     * @param logger - Optional logger for debugging (default: no logging)
-     *
-     * @example
-     * ```typescript
-     * const fetcher = new MarketFetcher(httpClient);
-     * ```
-     */
-    constructor(httpClient: HttpClient, logger?: ILogger);
-    /**
-     * Gets active markets with query parameters and pagination support.
-     *
-     * @param params - Query parameters for filtering and pagination
-     * @returns Promise resolving to active markets response
-     * @throws Error if API request fails
-     *
-     * @example
-     * ```typescript
-     * // Get 8 markets sorted by LP rewards
-     * const response = await fetcher.getActiveMarkets({
-     *   limit: 8,
-     *   sortBy: 'lp_rewards'
-     * });
-     * console.log(`Found ${response.data.length} of ${response.totalMarketsCount} markets`);
-     *
-     * // Get page 2
-     * const page2 = await fetcher.getActiveMarkets({
-     *   limit: 8,
-     *   page: 2,
-     *   sortBy: 'ending_soon'
-     * });
-     * ```
-     */
-    getActiveMarkets(params?: ActiveMarketsParams): Promise<ActiveMarketsResponse>;
-    /**
-     * Gets a single market by slug.
-     *
-     * @param slug - Market slug identifier
-     * @returns Promise resolving to market details
-     * @throws Error if API request fails or market not found
-     *
-     * @example
-     * ```typescript
-     * const market = await fetcher.getMarket('bitcoin-price-2024');
-     * console.log(`Market: ${market.title}`);
-     * ```
-     */
-    getMarket(slug: string): Promise<Market>;
-    /**
-     * Gets the orderbook for a CLOB market.
-     *
-     * @param slug - Market slug identifier
-     * @returns Promise resolving to orderbook data
-     * @throws Error if API request fails
-     *
-     * @example
-     * ```typescript
-     * const orderbook = await fetcher.getOrderBook('bitcoin-price-2024');
-     * console.log(`Bids: ${orderbook.bids.length}, Asks: ${orderbook.asks.length}`);
-     * ```
-     */
-    getOrderBook(slug: string): Promise<OrderBook>;
-    /**
-     * Gets the current price for a token.
-     *
-     * @param tokenId - Token ID
-     * @returns Promise resolving to price information
-     * @throws Error if API request fails
-     *
-     * @example
-     * ```typescript
-     * const price = await fetcher.getPrice('123456');
-     * console.log(`Current price: ${price.price}`);
-     * ```
-     */
-    getPrice(tokenId: string): Promise<MarketPrice>;
-}
-
 /**
  * Portfolio data fetcher for Limitless Exchange.
  * @module portfolio/fetcher
@@ -3550,4 +3647,4 @@ declare class WebSocketClient {
     private getChannelFromKey;
 }
 
-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 };
+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, 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, type Venue, WebSocketClient, type WebSocketConfig, type WebSocketEvents, WebSocketState, ZERO_ADDRESS, getContractAddress, retryOnErrors, validateOrderArgs, validateSignedOrder, validateUnsignedOrder, withRetry };