@varla/polymarket 1.1.3 → 1.1.4

package/dist/clob-trading-client.d.ts

@@ -0,0 +1,259 @@
+/**
+ * CLOB Trading Client
+ *
+ * Authenticated client for Polymarket CLOB trading operations.
+ * Combines auth, order creation, and API calls into a unified interface.
+ */
+import type { WalletClient } from "viem";
+import type { ApiKeyCreds, BatchOrderResponse, BuilderApiKey, BuilderApiKeyInfo, BuilderTradesFilter, BuilderTradesResponse, CancelResponse, ClobTradingClientConfig, HeartbeatResponse, LiquidityRewardPercentages, MarketBuyParams, MarketOptions, MarketSellParams, OpenOrdersFilter, Order, OrderBook, OrderParams, OrderResponse, OrderType, RewardsMarket, SignedOrder, TimeInForce, Trade, TradeHistoryFilter, UserEarnings } from "./clob-trading-types.js";
+export type ClobTradingClientFullConfig = ClobTradingClientConfig & {
+    /** Fetch function override (for testing) */
+    fetchFn?: typeof fetch;
+    /** Clock function override (for testing) */
+    now?: () => number;
+};
+/**
+ * CLOB Trading Client for authenticated Polymarket trading.
+ *
+ * @example
+ * ```typescript
+ * import { createWalletClient, http } from "viem";
+ * import { polygon } from "viem/chains";
+ * import { privateKeyToAccount } from "viem/accounts";
+ *
+ * const account = privateKeyToAccount("0x...");
+ * const walletClient = createWalletClient({
+ *   account,
+ *   chain: polygon,
+ *   transport: http(),
+ * });
+ *
+ * const client = new ClobTradingClient(walletClient);
+ * await client.init();
+ *
+ * const order = await client.createAndPostOrder(
+ *   { tokenId: "123...", price: 0.5, size: 10, side: "BUY" },
+ *   { tickSize: "0.01", negRisk: false },
+ *   "GTC"
+ * );
+ * ```
+ */
+export declare class ClobTradingClient {
+    private readonly baseUrl;
+    private readonly authManager;
+    private readonly orderBuilder;
+    private readonly fetchFn;
+    private readonly requestTimeoutMs;
+    private readonly maxRetries;
+    private readonly log?;
+    private creds?;
+    private initialized;
+    constructor(walletClient: WalletClient, config?: ClobTradingClientFullConfig);
+    /**
+     * Initialize the client by creating or deriving API credentials.
+     *
+     * Must be called before any trading operations.
+     */
+    init(): Promise<void>;
+    /**
+     * Check if the client is initialized.
+     */
+    isInitialized(): boolean;
+    /**
+     * Get the current API credentials.
+     *
+     * @throws Error if not initialized
+     */
+    getCredentials(): ApiKeyCreds;
+    /**
+     * Manually set API credentials (useful for testing or cached creds).
+     */
+    setCredentials(creds: ApiKeyCreds): void;
+    /**
+     * Create and post an order in a single call.
+     *
+     * @param params Order parameters (tokenId, price, size, side)
+     * @param options Market options (tickSize, negRisk)
+     * @param orderType Order type (GTC, GTD, FOK)
+     */
+    createAndPostOrder(params: OrderParams, options: MarketOptions, orderType?: OrderType): Promise<OrderResponse>;
+    /**
+     * Create a signed order without posting it.
+     *
+     * Useful for batching or review before submission.
+     */
+    createOrder(params: OrderParams, options: MarketOptions): Promise<SignedOrder>;
+    /**
+     * Post a signed order to the CLOB.
+     *
+     * @param signedOrder Signed order from createOrder()
+     * @param orderType Order type (GTC, GTD, FOK)
+     */
+    postOrder(signedOrder: SignedOrder, orderType?: OrderType): Promise<OrderResponse>;
+    /**
+     * Cancel a single order by ID.
+     */
+    cancelOrder(orderId: string): Promise<CancelResponse>;
+    /**
+     * Cancel multiple orders by ID.
+     */
+    cancelOrders(orderIds: string[]): Promise<CancelResponse>;
+    /**
+     * Cancel all orders for a specific market.
+     */
+    cancelMarketOrders(filter: {
+        market?: string;
+        asset_id?: string;
+    }): Promise<CancelResponse>;
+    /**
+     * Cancel all open orders.
+     */
+    cancelAll(): Promise<CancelResponse>;
+    /**
+     * Get all open orders.
+     *
+     * @param filter Optional filters (market, asset_id)
+     */
+    getOpenOrders(filter?: OpenOrdersFilter): Promise<Order[]>;
+    /**
+     * Get a single order by ID.
+     */
+    getOrder(orderId: string): Promise<Order>;
+    /**
+     * Check if account is in closed-only mode.
+     */
+    getClosedOnlyMode(): Promise<{
+        closedOnly: boolean;
+        reason?: string;
+    }>;
+    /**
+     * Get all API keys for the account.
+     */
+    getApiKeys(): Promise<{
+        apiKeys: Array<{
+            apiKey: string;
+            createdAt: number;
+        }>;
+    }>;
+    /**
+     * Delete the current API key.
+     *
+     * Warning: This will invalidate the current session.
+     */
+    deleteApiKey(): Promise<void>;
+    /**
+     * Create a market buy order.
+     *
+     * Market buys execute immediately against the order book.
+     * Use FOK for all-or-nothing, FAK for partial fills.
+     *
+     * @param params Market buy parameters (tokenId, amount in USDC)
+     * @param options Market options (tickSize, negRisk)
+     * @param timeInForce FOK (fill-or-kill) or FAK (fill-and-kill)
+     */
+    marketBuy(params: MarketBuyParams, options: MarketOptions, timeInForce?: TimeInForce): Promise<OrderResponse>;
+    /**
+     * Create a market sell order.
+     *
+     * Market sells execute immediately against the order book.
+     * Use FOK for all-or-nothing, FAK for partial fills.
+     *
+     * @param params Market sell parameters (tokenId, size in shares)
+     * @param options Market options (tickSize, negRisk)
+     * @param timeInForce FOK (fill-or-kill) or FAK (fill-and-kill)
+     */
+    marketSell(params: MarketSellParams, options: MarketOptions, timeInForce?: TimeInForce): Promise<OrderResponse>;
+    /**
+     * Get the order book for a token.
+     */
+    getOrderBook(tokenId: string): Promise<OrderBook>;
+    /**
+     * Calculate weighted average price for market buy.
+     */
+    private calculateMarketBuyPrice;
+    /**
+     * Calculate weighted average price for market sell.
+     */
+    private calculateMarketSellPrice;
+    /**
+     * Post multiple orders in a single request.
+     *
+     * More efficient than posting orders individually.
+     */
+    postOrders(signedOrders: SignedOrder[], orderType?: OrderType): Promise<BatchOrderResponse>;
+    /**
+     * Create and post multiple orders.
+     */
+    createAndPostOrders(ordersParams: Array<{
+        params: OrderParams;
+        options: MarketOptions;
+    }>, orderType?: OrderType): Promise<BatchOrderResponse>;
+    /**
+     * Send a heartbeat to keep the session alive.
+     *
+     * The server may auto-cancel orders if heartbeats stop.
+     * Call this periodically (e.g., every 30 seconds) for active sessions.
+     */
+    heartbeat(): Promise<HeartbeatResponse>;
+    /**
+     * Get trade history for the authenticated user.
+     */
+    getTrades(filter?: TradeHistoryFilter): Promise<Trade[]>;
+    /**
+     * Get user earnings for a specific day.
+     *
+     * @param date Date in YYYY-MM-DD format
+     */
+    getEarningsForDay(date: string): Promise<UserEarnings>;
+    /**
+     * Get total earnings for user for a specific day.
+     *
+     * @param date Date in YYYY-MM-DD format
+     */
+    getTotalEarningsForDay(date: string): Promise<UserEarnings>;
+    /**
+     * Get liquidity reward percentages.
+     */
+    getLiquidityRewardPercentages(): Promise<LiquidityRewardPercentages>;
+    /**
+     * Get current reward markets.
+     */
+    getRewardsMarkets(): Promise<RewardsMarket[]>;
+    /**
+     * Create a new builder API key.
+     *
+     * Builder API keys are used by professional market makers for
+     * builder-specific operations and trade tracking.
+     *
+     * @returns New builder API key credentials
+     */
+    createBuilderApiKey(): Promise<BuilderApiKey>;
+    /**
+     * Get all builder API keys for the account.
+     *
+     * @returns List of builder API keys with creation/revocation timestamps
+     */
+    getBuilderApiKeys(): Promise<BuilderApiKeyInfo[]>;
+    /**
+     * Revoke a builder API key.
+     *
+     * Warning: This will invalidate the builder key permanently.
+     */
+    revokeBuilderApiKey(): Promise<void>;
+    /**
+     * Get trade history for the builder.
+     *
+     * Returns trades executed through the builder flow, with pagination support.
+     *
+     * @param filter Optional filters (market, asset_id, limit)
+     * @param cursor Pagination cursor for next page
+     */
+    getBuilderTrades(filter?: BuilderTradesFilter, cursor?: string): Promise<BuilderTradesResponse>;
+    private ensureInitialized;
+    private authenticatedRequest;
+}
+/**
+ * Create a new CLOB trading client.
+ */
+export declare function createClobTradingClient(walletClient: WalletClient, config?: ClobTradingClientFullConfig): ClobTradingClient;
+//# sourceMappingURL=clob-trading-client.d.ts.map

package/dist/clob-trading-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clob-trading-client.d.ts","sourceRoot":"","sources":["../src/clob-trading-client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGzC,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,cAAc,EACd,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,EAC1B,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,SAAS,EACT,WAAW,EACX,aAAa,EACb,SAAS,EACT,aAAa,EAEb,WAAW,EACX,WAAW,EACX,KAAK,EACL,kBAAkB,EAClB,YAAY,EACb,MAAM,yBAAyB,CAAC;AA4BjC,MAAM,MAAM,2BAA2B,GAAG,uBAAuB,GAAG;IAClE,4CAA4C;IAC5C,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;IACvB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;CACpB,CAAC;AAMF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAkB;IAC9C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAmB;IAChD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAiC;IAEtD,OAAO,CAAC,KAAK,CAAC,CAAc;IAC5B,OAAO,CAAC,WAAW,CAAS;gBAEhB,YAAY,EAAE,YAAY,EAAE,MAAM,GAAE,2BAAgC;IAgChF;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAa3B;;OAEG;IACH,aAAa,IAAI,OAAO;IAIxB;;;;OAIG;IACH,cAAc,IAAI,WAAW;IAK7B;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IASxC;;;;;;OAMG;IACG,kBAAkB,CACtB,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,aAAa,EACtB,SAAS,GAAE,SAAiB,GAC3B,OAAO,CAAC,aAAa,CAAC;IAKzB;;;;OAIG;IACG,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC;IAKpF;;;;;OAKG;IACG,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,GAAE,SAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;IA4B/F;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAc3D;;OAEG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAuB/D;;OAEG;IACG,kBAAkB,CAAC,MAAM,EAAE;QAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,cAAc,CAAC;IAkB3B;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC;IAkB1C;;;;OAIG;IACG,aAAa,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAyBhE;;OAEG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAY/C;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC;QAAE,UAAU,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAW5E;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,KAAK,CAAC;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC;IAKtF;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAWnC;;;;;;;;;OASG;IACG,SAAS,CACb,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,aAAa,EACtB,WAAW,GAAE,WAAmB,GAC/B,OAAO,CAAC,aAAa,CAAC;IA8BzB;;;;;;;;;OASG;IACG,UAAU,CACd,MAAM,EAAE,gBAAgB,EACxB,OAAO,EAAE,aAAa,EACtB,WAAW,GAAE,WAAmB,GAC/B,OAAO,CAAC,aAAa,CAAC;IA0BzB;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IASvD;;OAEG;IACH,OAAO,CAAC,uBAAuB;IA0C/B;;OAEG;IACH,OAAO,CAAC,wBAAwB;IA6ChC;;;;OAIG;IACG,UAAU,CACd,YAAY,EAAE,WAAW,EAAE,EAC3B,SAAS,GAAE,SAAiB,GAC3B,OAAO,CAAC,kBAAkB,CAAC;IA4B9B;;OAEG;IACG,mBAAmB,CACvB,YAAY,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,WAAW,CAAC;QAAC,OAAO,EAAE,aAAa,CAAA;KAAE,CAAC,EACpE,SAAS,GAAE,SAAiB,GAC3B,OAAO,CAAC,kBAAkB,CAAC;IAW9B;;;;;OAKG;IACG,SAAS,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAgB7C;;OAEG;IACG,SAAS,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAqB9D;;;;OAIG;IACG,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAW5D;;;;OAIG;IACG,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IASjE;;OAEG;IACG,6BAA6B,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAS1E;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAUnD;;;;;;;OAOG;IACG,mBAAmB,IAAI,OAAO,CAAC,aAAa,CAAC;IAkBnD;;;;OAIG;IACG,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAQvD;;;;OAIG;IACG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAU1C;;;;;;;OAOG;IACG,gBAAgB,CACpB,MAAM,CAAC,EAAE,mBAAmB,EAC5B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,qBAAqB,CAAC;IAoBjC,OAAO,CAAC,iBAAiB;YAMX,oBAAoB;CAgDnC;AAMD;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,YAAY,EAAE,YAAY,EAC1B,MAAM,CAAC,EAAE,2BAA2B,GACnC,iBAAiB,CAEnB"}