@polymarket/clob-client-v2 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Polymarket
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# Polymarket CLOB Client

package/dist/client.d.ts

@@ -0,0 +1,125 @@
+import type { JsonRpcSigner } from "@ethersproject/providers";
+import type { Wallet } from "@ethersproject/wallet";
+import { OrderBuilder } from "./order-builder";
+import type { SignatureTypeV2 } from "./order-utils/model/signatureTypeV2";
+import type { ApiKeyCreds, ApiKeysResponse, BalanceAllowanceParams, BalanceAllowanceResponse, BanStatus, BookParams, BuilderApiKey, BuilderApiKeyResponse, BuilderConfig, BuilderFeeRates, BuilderTrade, BuilderTradeParams, Chain, CreateOrderOptions, DropNotificationParams, FeeExponents, FeeRates, MarketDetails, MarketPrice, MarketReward, MarketTradeEvent, NegRisk, Notification, OpenOrder, OpenOrderParams, OpenOrdersResponse, OrderBookSummary, OrderMarketCancelParams, OrderPayload, OrderScoring, OrderScoringParams, OrdersScoring, OrdersScoringParams, PaginationPayload, PostOrdersV1Args, PostOrdersV2Args, PriceHistoryFilterParams, RewardsPercentages, TickSize, TickSizes, TotalUserEarning, Trade, TradeParams, UserEarning, UserMarketOrderV2, UserOrderV2, UserRewardsEarning } from "./types";
+import { OrderType, Side } from "./types";
+import { type SignedOrder } from "./types/unifiedOrder";
+export declare class ClobClient {
+    readonly host: string;
+    readonly chainId: Chain;
+    readonly signer?: Wallet | JsonRpcSigner;
+    readonly creds?: ApiKeyCreds;
+    readonly orderBuilder: OrderBuilder;
+    readonly tickSizes: TickSizes;
+    readonly negRisk: NegRisk;
+    readonly feeRates: FeeRates;
+    readonly feeExponents: FeeExponents;
+    readonly builderFeeRates: BuilderFeeRates;
+    private readonly tokenConditionMap;
+    readonly geoBlockToken?: string;
+    readonly useServerTime?: boolean;
+    readonly builderConfig?: BuilderConfig;
+    private cachedVersion?;
+    constructor(host: string, chainId: Chain, signer?: Wallet | JsonRpcSigner, creds?: ApiKeyCreds, signatureType?: SignatureTypeV2, funderAddress?: string, geoBlockToken?: string, useServerTime?: boolean, builderConfig?: BuilderConfig, getSigner?: () => Promise<Wallet | JsonRpcSigner> | (Wallet | JsonRpcSigner));
+    getOk(): Promise<any>;
+    getVersion(): Promise<number>;
+    getServerTime(): Promise<number>;
+    getSamplingSimplifiedMarkets(next_cursor?: string): Promise<PaginationPayload>;
+    getSamplingMarkets(next_cursor?: string): Promise<PaginationPayload>;
+    getSimplifiedMarkets(next_cursor?: string): Promise<PaginationPayload>;
+    getMarkets(next_cursor?: string): Promise<PaginationPayload>;
+    getMarket(conditionID: string): Promise<any>;
+    getClobMarketInfo(conditionID: string): Promise<MarketDetails>;
+    getOrderBook(tokenID: string): Promise<OrderBookSummary>;
+    getOrderBooks(params: BookParams[]): Promise<OrderBookSummary[]>;
+    getTickSize(tokenID: string): Promise<TickSize>;
+    getNegRisk(tokenID: string): Promise<boolean>;
+    getFeeRateBps(tokenID: string): Promise<number>;
+    getFeeExponent(tokenID: string): Promise<number>;
+    /**
+     * Calculates the hash for the given orderbook
+     * @param orderbook
+     * @returns
+     */
+    getOrderBookHash(orderbook: OrderBookSummary): string;
+    getMidpoint(tokenID: string): Promise<any>;
+    getMidpoints(params: BookParams[]): Promise<any>;
+    getPrice(tokenID: string, side: string): Promise<any>;
+    getPrices(params: BookParams[]): Promise<any>;
+    getSpread(tokenID: string): Promise<any>;
+    getSpreads(params: BookParams[]): Promise<any>;
+    getLastTradePrice(tokenID: string): Promise<any>;
+    getLastTradesPrices(params: BookParams[]): Promise<any>;
+    getPricesHistory(params: PriceHistoryFilterParams): Promise<MarketPrice[]>;
+    /**
+     * Creates a new API key for a user
+     * @param nonce
+     * @returns ApiKeyCreds
+     */
+    createApiKey(nonce?: number): Promise<ApiKeyCreds>;
+    /**
+     * Derives an existing API key for a user
+     * @param nonce
+     * @returns ApiKeyCreds
+     */
+    deriveApiKey(nonce?: number): Promise<ApiKeyCreds>;
+    createOrDeriveApiKey(nonce?: number): Promise<ApiKeyCreds>;
+    getApiKeys(): Promise<ApiKeysResponse>;
+    getClosedOnlyMode(): Promise<BanStatus>;
+    deleteApiKey(): Promise<any>;
+    getOrder(orderID: string): Promise<OpenOrder>;
+    getTrades(params?: TradeParams, only_first_page?: boolean, next_cursor?: string): Promise<Trade[]>;
+    getTradesPaginated(params?: TradeParams, next_cursor?: string): Promise<{
+        trades: Trade[];
+        next_cursor: string;
+        limit: number;
+        count: number;
+    }>;
+    getBuilderTrades(params: BuilderTradeParams, next_cursor?: string): Promise<{
+        trades: BuilderTrade[];
+        next_cursor: string;
+        limit: number;
+        count: number;
+    }>;
+    getNotifications(): Promise<Notification[]>;
+    dropNotifications(params?: DropNotificationParams): Promise<void>;
+    getBalanceAllowance(params?: BalanceAllowanceParams): Promise<BalanceAllowanceResponse>;
+    updateBalanceAllowance(params?: BalanceAllowanceParams): Promise<void>;
+    createOrder(userOrder: UserOrderV2, options?: Partial<CreateOrderOptions>): Promise<SignedOrder>;
+    createMarketOrder(userMarketOrder: UserMarketOrderV2, options?: Partial<CreateOrderOptions>): Promise<SignedOrder>;
+    createAndPostOrder<T extends OrderType.GTC | OrderType.GTD = OrderType.GTC>(userOrder: UserOrderV2, options?: Partial<CreateOrderOptions>, orderType?: T, deferExec?: boolean): Promise<any>;
+    createAndPostMarketOrder<T extends OrderType.FOK | OrderType.FAK = OrderType.FOK>(userMarketOrder: UserMarketOrderV2, options?: Partial<CreateOrderOptions>, orderType?: T, deferExec?: boolean): Promise<any>;
+    getOpenOrders(params?: OpenOrderParams, only_first_page?: boolean, next_cursor?: string): Promise<OpenOrdersResponse>;
+    postOrder<T extends OrderType = OrderType.GTC>(order: SignedOrder, orderType?: T, deferExec?: boolean): Promise<any>;
+    postOrders(args: (PostOrdersV2Args | PostOrdersV1Args)[], deferExec?: boolean): Promise<any>;
+    cancelOrder(payload: OrderPayload): Promise<any>;
+    cancelOrders(ordersHashes: string[]): Promise<any>;
+    cancelAll(): Promise<any>;
+    cancelMarketOrders(payload: OrderMarketCancelParams): Promise<any>;
+    isOrderScoring(params?: OrderScoringParams): Promise<OrderScoring>;
+    areOrdersScoring(params?: OrdersScoringParams): Promise<OrdersScoring>;
+    getEarningsForUserForDay(date: string): Promise<UserEarning[]>;
+    getTotalEarningsForUserForDay(date: string): Promise<TotalUserEarning[]>;
+    getUserEarningsAndMarketsConfig(date: string, order_by?: string, position?: string, no_competition?: boolean): Promise<UserRewardsEarning[]>;
+    getRewardPercentages(): Promise<RewardsPercentages>;
+    getCurrentRewards(): Promise<MarketReward[]>;
+    getRawRewardsForMarket(conditionId: string): Promise<MarketReward[]>;
+    getMarketTradesEvents(conditionID: string): Promise<MarketTradeEvent[]>;
+    calculateMarketPrice(tokenID: string, side: Side, amount: number, orderType?: OrderType): Promise<number>;
+    createBuilderApiKey(): Promise<BuilderApiKey>;
+    getBuilderApiKeys(): Promise<BuilderApiKeyResponse[]>;
+    private canL1Auth;
+    private canL2Auth;
+    private isBuilderOrder;
+    private _ensureMarketInfoCached;
+    private _resolveTickSize;
+    private resolveVersion;
+    private _calculatePlatformFeeRate;
+    private _calculateFeeAdjustedAmount;
+    private _retryOnVersionUpdate;
+    private _isOrderVersionMismatch;
+    private get;
+    private post;
+    private del;
+}