@polymarket/clob-client-v2 0.0.1

package/dist/types/clob.d.ts

@@ -0,0 +1,377 @@
+import { Side } from "../order-utils/model/side";
+export { Side };
+export interface ApiKeyCreds {
+    key: string;
+    secret: string;
+    passphrase: string;
+}
+export interface BuilderConfig {
+    builderCode: string;
+}
+export interface ApiKeyRaw {
+    apiKey: string;
+    secret: string;
+    passphrase: string;
+}
+export interface L2HeaderArgs {
+    method: string;
+    requestPath: string;
+    body?: string;
+}
+export type SimpleHeaders = Record<string, string | number | boolean>;
+export interface L1PolyHeader extends SimpleHeaders {
+    POLY_ADDRESS: string;
+    POLY_SIGNATURE: string;
+    POLY_TIMESTAMP: string;
+    POLY_NONCE: string;
+}
+export interface L2PolyHeader extends SimpleHeaders {
+    POLY_ADDRESS: string;
+    POLY_SIGNATURE: string;
+    POLY_TIMESTAMP: string;
+    POLY_API_KEY: string;
+    POLY_PASSPHRASE: string;
+}
+export declare enum OrderType {
+    GTC = "GTC",
+    FOK = "FOK",
+    GTD = "GTD",
+    FAK = "FAK"
+}
+export interface OrderPayload {
+    orderID: string;
+}
+export interface OrderResponse {
+    success: boolean;
+    errorMsg: string;
+    orderID: string;
+    transactionsHashes: string[];
+    status: string;
+    takingAmount: string;
+    makingAmount: string;
+}
+export interface OpenOrder {
+    id: string;
+    status: string;
+    owner: string;
+    maker_address: string;
+    market: string;
+    asset_id: string;
+    side: string;
+    original_size: string;
+    size_matched: string;
+    price: string;
+    associate_trades: string[];
+    outcome: string;
+    created_at: number;
+    expiration: string;
+    order_type: string;
+}
+export type OpenOrdersResponse = OpenOrder[];
+export interface MakerOrder {
+    order_id: string;
+    owner: string;
+    maker_address: string;
+    matched_amount: string;
+    price: string;
+    fee_rate_bps: string;
+    asset_id: string;
+    outcome: string;
+    side: Side;
+}
+export interface Trade {
+    id: string;
+    taker_order_id: string;
+    market: string;
+    asset_id: string;
+    side: Side;
+    size: string;
+    fee_rate_bps: string;
+    price: string;
+    status: string;
+    match_time: string;
+    last_update: string;
+    outcome: string;
+    bucket_index: number;
+    owner: string;
+    maker_address: string;
+    maker_orders: MakerOrder[];
+    transaction_hash: string;
+    trader_side: "TAKER" | "MAKER";
+}
+export interface ApiKeysResponse {
+    apiKeys: ApiKeyCreds[];
+}
+export interface BanStatus {
+    closed_only: boolean;
+}
+export interface TradeParams {
+    id?: string;
+    maker_address?: string;
+    market?: string;
+    asset_id?: string;
+    before?: string;
+    after?: string;
+}
+export interface BuilderTradeParams extends TradeParams {
+    builder_code: string;
+}
+export interface OpenOrderParams {
+    id?: string;
+    market?: string;
+    asset_id?: string;
+}
+export declare enum Chain {
+    POLYGON = 137,
+    AMOY = 80002
+}
+export interface MarketPrice {
+    t: number;
+    p: number;
+}
+export interface PriceHistoryFilterParams {
+    market?: string;
+    startTs?: number;
+    endTs?: number;
+    fidelity?: number;
+    interval?: PriceHistoryInterval;
+}
+export declare enum PriceHistoryInterval {
+    MAX = "max",
+    ONE_WEEK = "1w",
+    ONE_DAY = "1d",
+    SIX_HOURS = "6h",
+    ONE_HOUR = "1h"
+}
+export interface DropNotificationParams {
+    ids: string[];
+}
+export interface Notification {
+    type: number;
+    owner: string;
+    payload: any;
+}
+export interface OrderMarketCancelParams {
+    market?: string;
+    asset_id?: string;
+}
+export interface OrderBookSummary {
+    market: string;
+    asset_id: string;
+    timestamp: string;
+    bids: OrderSummary[];
+    asks: OrderSummary[];
+    min_order_size: string;
+    tick_size: string;
+    neg_risk: boolean;
+    hash: string;
+}
+export interface OrderSummary {
+    price: string;
+    size: string;
+}
+export declare enum AssetType {
+    COLLATERAL = "COLLATERAL",
+    CONDITIONAL = "CONDITIONAL"
+}
+export interface BalanceAllowanceParams {
+    asset_type: AssetType;
+    token_id?: string;
+}
+export interface BalanceAllowanceResponse {
+    balance: string;
+    allowance: string;
+}
+export interface OrderScoringParams {
+    order_id: string;
+}
+export interface OrderScoring {
+    scoring: boolean;
+}
+export interface OrdersScoringParams {
+    orderIds: string[];
+}
+export type OrdersScoring = {
+    [orderId in string]: boolean;
+};
+export type CreateOrderOptions = {
+    tickSize: TickSize;
+    negRisk?: boolean;
+};
+export type TickSize = "0.1" | "0.01" | "0.001" | "0.0001";
+export interface RoundConfig {
+    readonly price: number;
+    readonly size: number;
+    readonly amount: number;
+}
+export interface TickSizes {
+    [tokenId: string]: TickSize;
+}
+export interface NegRisk {
+    [tokenId: string]: boolean;
+}
+export interface FeeRates {
+    [tokenId: string]: number;
+}
+export interface FeeExponents {
+    [tokenId: string]: number;
+}
+export interface BuilderFeeRates {
+    [tokenId: string]: {
+        maker: number;
+        taker: number;
+    };
+}
+export type TokenConditionMap = Record<string, string>;
+export interface FeeDetails {
+    r?: number;
+    e?: number;
+    to: boolean;
+}
+export interface ClobToken {
+    t: string;
+    o: string;
+}
+export interface MarketDetails {
+    c: string;
+    t: [ClobToken | null, ClobToken | null];
+    mts: number;
+    nr: boolean;
+    fd?: FeeDetails;
+    mbf?: number;
+    tbf?: number;
+}
+export interface PaginationPayload {
+    readonly limit: number;
+    readonly count: number;
+    readonly next_cursor: string;
+    readonly data: any[];
+}
+export interface MarketTradeEvent {
+    event_type: string;
+    market: {
+        condition_id: string;
+        asset_id: string;
+        question: string;
+        icon: string;
+        slug: string;
+    };
+    user: {
+        address: string;
+        username: string;
+        profile_picture: string;
+        optimized_profile_picture: string;
+        pseudonym: string;
+    };
+    side: Side;
+    size: string;
+    fee_rate_bps: string;
+    price: string;
+    outcome: string;
+    outcome_index: number;
+    transaction_hash: string;
+    timestamp: string;
+}
+export interface BookParams {
+    token_id: string;
+    side: Side;
+}
+export interface UserEarning {
+    date: string;
+    condition_id: string;
+    asset_address: string;
+    maker_address: string;
+    earnings: number;
+    asset_rate: number;
+}
+export interface TotalUserEarning {
+    date: string;
+    asset_address: string;
+    maker_address: string;
+    earnings: number;
+    asset_rate: number;
+}
+export interface RewardsPercentages {
+    [market: string]: number;
+}
+export interface Token {
+    token_id: string;
+    outcome: string;
+    price: number;
+}
+export interface RewardsConfig {
+    asset_address: string;
+    start_date: string;
+    end_date: string;
+    rate_per_day: number;
+    total_rewards: number;
+}
+export interface MarketReward {
+    condition_id: string;
+    question: string;
+    market_slug: string;
+    event_slug: string;
+    image: string;
+    rewards_max_spread: number;
+    rewards_min_size: number;
+    tokens: Token[];
+    rewards_config: RewardsConfig[];
+}
+export interface Earning {
+    asset_address: string;
+    earnings: number;
+    asset_rate: number;
+}
+export interface UserRewardsEarning {
+    condition_id: string;
+    question: string;
+    market_slug: string;
+    event_slug: string;
+    image: string;
+    rewards_max_spread: number;
+    rewards_min_size: number;
+    market_competitiveness: number;
+    tokens: Token[];
+    rewards_config: RewardsConfig[];
+    maker_address: string;
+    earning_percentage: number;
+    earnings: Earning[];
+}
+export interface BuilderTrade {
+    id: string;
+    tradeType: string;
+    takerOrderHash: string;
+    builder: string;
+    market: string;
+    assetId: string;
+    side: string;
+    size: string;
+    sizeUsdc: string;
+    price: string;
+    status: string;
+    outcome: string;
+    outcomeIndex: number;
+    owner: string;
+    maker: string;
+    transactionHash: string;
+    matchTime: string;
+    bucketIndex: number;
+    fee: string;
+    feeUsdc: string;
+    err_msg?: string | null;
+    createdAt: string | null;
+    updatedAt: string | null;
+}
+export interface BuilderApiKey {
+    key: string;
+    secret: string;
+    passphrase: string;
+}
+export interface BuilderApiKeyResponse {
+    key: string;
+    createdAt?: string;
+    revokedAt?: string;
+}
+export type ClobErrorResponseBody = {
+    error: string;
+};

package/dist/types/clob.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetType = exports.PriceHistoryInterval = exports.Chain = exports.OrderType = exports.Side = void 0;
+const side_1 = require("../order-utils/model/side");
+Object.defineProperty(exports, "Side", { enumerable: true, get: function () { return side_1.Side; } });
+var OrderType;
+(function (OrderType) {
+    OrderType["GTC"] = "GTC";
+    OrderType["FOK"] = "FOK";
+    OrderType["GTD"] = "GTD";
+    OrderType["FAK"] = "FAK";
+})(OrderType || (exports.OrderType = OrderType = {}));
+var Chain;
+(function (Chain) {
+    Chain[Chain["POLYGON"] = 137] = "POLYGON";
+    Chain[Chain["AMOY"] = 80002] = "AMOY";
+})(Chain || (exports.Chain = Chain = {}));
+var PriceHistoryInterval;
+(function (PriceHistoryInterval) {
+    PriceHistoryInterval["MAX"] = "max";
+    PriceHistoryInterval["ONE_WEEK"] = "1w";
+    PriceHistoryInterval["ONE_DAY"] = "1d";
+    PriceHistoryInterval["SIX_HOURS"] = "6h";
+    PriceHistoryInterval["ONE_HOUR"] = "1h";
+})(PriceHistoryInterval || (exports.PriceHistoryInterval = PriceHistoryInterval = {}));
+var AssetType;
+(function (AssetType) {
+    AssetType["COLLATERAL"] = "COLLATERAL";
+    AssetType["CONDITIONAL"] = "CONDITIONAL";
+})(AssetType || (exports.AssetType = AssetType = {}));
+//# sourceMappingURL=clob.js.map

package/dist/types/clob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clob.js","sourceRoot":"","sources":["../../src/types/clob.ts"],"names":[],"mappings":";;;AAAA,oDAAiD;AAExC,qFAFA,WAAI,OAEA;AA2Cb,IAAY,SAKX;AALD,WAAY,SAAS;IACpB,wBAAW,CAAA;IACX,wBAAW,CAAA;IACX,wBAAW,CAAA;IACX,wBAAW,CAAA;AACZ,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAkGD,IAAY,KAGX;AAHD,WAAY,KAAK;IAChB,yCAAa,CAAA;IACb,qCAAY,CAAA;AACb,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB;AAeD,IAAY,oBAMX;AAND,WAAY,oBAAoB;IAC/B,mCAAW,CAAA;IACX,uCAAe,CAAA;IACf,sCAAc,CAAA;IACd,wCAAgB,CAAA;IAChB,uCAAe,CAAA;AAChB,CAAC,EANW,oBAAoB,oCAApB,oBAAoB,QAM/B;AAmCD,IAAY,SAGX;AAHD,WAAY,SAAS;IACpB,sCAAyB,CAAA;IACzB,wCAA2B,CAAA;AAC5B,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./clob";
+export * from "./ordersV1";
+export * from "./ordersV2";
+export * from "./unifiedOrder";

package/dist/types/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./clob"), exports);
+tslib_1.__exportStar(require("./ordersV1"), exports);
+tslib_1.__exportStar(require("./ordersV2"), exports);
+tslib_1.__exportStar(require("./unifiedOrder"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,qDAA2B;AAC3B,qDAA2B;AAC3B,yDAA+B"}

package/dist/types/ordersV1.d.ts

@@ -0,0 +1,106 @@
+import type { SignatureTypeV1, SignedOrderV1 } from "../order-utils";
+import type { OrderType, Side } from "./clob";
+export interface PostOrdersV1Args {
+    order: SignedOrderV1;
+    orderType: OrderType;
+}
+export interface NewOrderV1<T extends OrderType> {
+    readonly order: {
+        readonly salt: number;
+        readonly maker: string;
+        readonly signer: string;
+        readonly taker: string;
+        readonly tokenId: string;
+        readonly makerAmount: string;
+        readonly takerAmount: string;
+        readonly expiration: string;
+        readonly nonce: string;
+        readonly feeRateBps: string;
+        readonly side: string;
+        readonly signatureType: SignatureTypeV1;
+        readonly signature: string;
+    };
+    readonly owner: string;
+    readonly orderType: T;
+    readonly deferExec: boolean;
+}
+export interface UserOrderV1 {
+    /**
+     * TokenID of the Conditional token asset being traded
+     */
+    tokenID: string;
+    /**
+     * Price used to create the order
+     */
+    price: number;
+    /**
+     * Size in terms of the ConditionalToken
+     */
+    size: number;
+    /**
+     * Side of the order
+     */
+    side: Side;
+    /**
+     * Fee rate, in basis points, charged to the order maker, charged on proceeds
+     */
+    feeRateBps?: number;
+    /**
+     * Nonce used for onchain cancellations
+     */
+    nonce?: number;
+    /**
+     * Timestamp after which the order is expired.
+     */
+    expiration?: number;
+    /**
+     * Address of the order taker. The zero address is used to indicate a public order
+     */
+    taker?: string;
+    /**
+     * Builder code (bytes32)
+     */
+    builderCode?: string;
+}
+export interface UserMarketOrderV1 {
+    /**
+     * TokenID of the Conditional token asset being traded
+     */
+    tokenID: string;
+    /**
+     * Price used to create the order
+     * If it is not present the market price will be used.
+     */
+    price?: number;
+    /**
+     * BUY orders: $$$ Amount to buy
+     * SELL orders: Shares to sell
+     */
+    amount: number;
+    /**
+     * Side of the order
+     */
+    side: Side;
+    /**
+     * Fee rate, in basis points, charged to the order maker, charged on proceeds
+     */
+    feeRateBps?: number;
+    /**
+     * Nonce used for onchain cancellations
+     */
+    nonce?: number;
+    /**
+     * Address of the order taker. The zero address is used to indicate a public order
+     */
+    taker?: string;
+    /**
+     * Specifies the type of order execution:
+     * - FOK (Fill or Kill): The order must be filled entirely or not at all.
+     * - FAK (Fill and Kill): The order can be partially filled, and any unfilled portion is canceled.
+     */
+    orderType?: OrderType.FOK | OrderType.FAK;
+    /**
+     * Builder code (bytes32)
+     */
+    builderCode?: string;
+}

package/dist/types/ordersV1.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ordersV1.js.map

package/dist/types/ordersV1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ordersV1.js","sourceRoot":"","sources":["../../src/types/ordersV1.ts"],"names":[],"mappings":""}

package/dist/types/ordersV2.d.ts

@@ -0,0 +1,89 @@
+import type { SignatureTypeV2, SignedOrderV2 } from "../order-utils";
+import type { OrderType, Side } from "./clob";
+export interface PostOrdersV2Args {
+    order: SignedOrderV2;
+    orderType: OrderType;
+}
+export interface NewOrderV2<T extends OrderType> {
+    readonly order: {
+        readonly salt: number;
+        readonly maker: string;
+        readonly signer: string;
+        readonly taker: string;
+        readonly tokenId: string;
+        readonly makerAmount: string;
+        readonly takerAmount: string;
+        readonly expiration: string;
+        readonly side: string;
+        readonly signatureType: SignatureTypeV2;
+        readonly timestamp: string;
+        readonly metadata: string;
+        readonly builder: string;
+        readonly signature: string;
+    };
+    readonly owner: string;
+    readonly orderType: T;
+    readonly deferExec: boolean;
+}
+export interface UserOrderV2 {
+    /**
+     * TokenID of the Conditional token asset being traded
+     */
+    tokenID: string;
+    /**
+     * Price used to create the order
+     */
+    price: number;
+    /**
+     * Size in terms of the ConditionalToken
+     */
+    size: number;
+    /**
+     * Side of the order
+     */
+    side: Side;
+    /**
+     * Timestamp after which the order is expired.
+     */
+    expiration?: number;
+    /**
+     * Builder code (bytes32)
+     */
+    builderCode?: string;
+}
+export interface UserMarketOrderV2 {
+    /**
+     * TokenID of the Conditional token asset being traded
+     */
+    tokenID: string;
+    /**
+     * Price used to create the order
+     * If it is not present the market price will be used.
+     */
+    price?: number;
+    /**
+     * BUY orders: $$$ Amount to buy
+     * SELL orders: Shares to sell
+     */
+    amount: number;
+    /**
+     * Side of the order
+     */
+    side: Side;
+    /**
+     * Specifies the type of order execution:
+     * - FOK (Fill or Kill): The order must be filled entirely or not at all.
+     * - FAK (Fill and Kill): The order can be partially filled, and any unfilled portion is canceled.
+     */
+    orderType?: OrderType.FOK | OrderType.FAK;
+    /**
+     * User's USDC balance. If provided and sufficient to cover amount + fees, the order
+     * amount is used as-is. Otherwise fees are deducted from the amount.
+     * If this field is left empty, the default flow is to use the order amount as-is
+     */
+    userUSDCBalance?: number;
+    /**
+     * Builder code (bytes32)
+     */
+    builderCode?: string;
+}

package/dist/types/ordersV2.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ordersV2.js.map

package/dist/types/ordersV2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ordersV2.js","sourceRoot":"","sources":["../../src/types/ordersV2.ts"],"names":[],"mappings":""}

package/dist/types/unifiedOrder.d.ts

@@ -0,0 +1,34 @@
+import type { SignedOrderV1, SignedOrderV2 } from "../order-utils";
+import type { PostOrdersV1Args, UserMarketOrderV1, UserOrderV1 } from "./ordersV1";
+import type { PostOrdersV2Args, UserMarketOrderV2, UserOrderV2 } from "./ordersV2";
+export type SignedOrder = SignedOrderV1 | SignedOrderV2;
+export type PostOrdersArgs = PostOrdersV1Args | PostOrdersV2Args;
+export type VersionedSignedOrder = {
+    version: 1;
+    order: SignedOrderV1;
+} | {
+    version: 2;
+    order: SignedOrderV2;
+};
+export type VersionedUserOrder = {
+    version: 1;
+    order: UserOrderV1;
+} | {
+    version: 2;
+    order: UserOrderV2;
+};
+export type VersionedUserMarketOrder = {
+    version: 1;
+    order: UserMarketOrderV1;
+} | {
+    version: 2;
+    order: UserMarketOrderV2;
+};
+export type VersionedPostOrdersArgs = {
+    version: 1;
+    args: PostOrdersV1Args;
+} | {
+    version: 2;
+    args: PostOrdersV2Args;
+};
+export declare function isV2Order(order: SignedOrder | VersionedSignedOrder): order is SignedOrderV2;

package/dist/types/unifiedOrder.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isV2Order = isV2Order;
+function isV2Order(order) {
+    if ("version" in order && "order" in order) {
+        // VersionedSignedOrder type
+        return order.version === 2;
+    }
+    // Check for V2-specific fields
+    return "timestamp" in order && "metadata" in order && "builder" in order;
+}
+//# sourceMappingURL=unifiedOrder.js.map

package/dist/types/unifiedOrder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unifiedOrder.js","sourceRoot":"","sources":["../../src/types/unifiedOrder.ts"],"names":[],"mappings":";;AAwBA,8BAOC;AAPD,SAAgB,SAAS,CAAC,KAAyC;IAClE,IAAI,SAAS,IAAI,KAAK,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;QAC5C,4BAA4B;QAC5B,OAAO,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC;IAC5B,CAAC;IACD,+BAA+B;IAC/B,OAAO,WAAW,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK,CAAC;AAC1E,CAAC"}