@polymarket/clob-client-v2 1.0.5 → 1.0.6-main.0

package/dist/types/clob.d.ts

@@ -0,0 +1,427 @@
+import { Side } from "../order-utils/model/side.js";
+
+//#region src/types/clob.d.ts
+interface ApiKeyCreds {
+  key: string;
+  secret: string;
+  passphrase: string;
+}
+interface BuilderConfig {
+  builderCode: string;
+}
+interface ApiKeyRaw {
+  apiKey: string;
+  secret: string;
+  passphrase: string;
+}
+interface L2HeaderArgs {
+  method: string;
+  requestPath: string;
+  body?: string;
+}
+type SimpleHeaders = Record<string, string | number | boolean>;
+interface L1PolyHeader extends SimpleHeaders {
+  POLY_ADDRESS: string;
+  POLY_SIGNATURE: string;
+  POLY_TIMESTAMP: string;
+  POLY_NONCE: string;
+}
+interface L2PolyHeader extends SimpleHeaders {
+  POLY_ADDRESS: string;
+  POLY_SIGNATURE: string;
+  POLY_TIMESTAMP: string;
+  POLY_API_KEY: string;
+  POLY_PASSPHRASE: string;
+}
+declare enum OrderType {
+  GTC = "GTC",
+  FOK = "FOK",
+  GTD = "GTD",
+  FAK = "FAK",
+}
+interface OrderPayload {
+  orderID: string;
+}
+interface OrderResponse {
+  success: boolean;
+  errorMsg: string;
+  orderID: string;
+  transactionsHashes?: string[];
+  tradeIDs?: string[];
+  status: string;
+  takingAmount: string;
+  makingAmount: string;
+}
+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;
+}
+type OpenOrdersResponse = OpenOrder[];
+type PreMigrationOrder = OpenOrder;
+type PreMigrationOrdersResponse = PreMigrationOrder[];
+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;
+  builder_fee?: string;
+  builder_code?: string;
+}
+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;
+  match_time_nano?: string;
+  last_update: string;
+  outcome: string;
+  bucket_index: number;
+  owner: string;
+  maker_address: string;
+  maker_orders: MakerOrder[];
+  transaction_hash?: string;
+  err_msg?: string | null;
+  trader_side: "TAKER" | "MAKER";
+}
+interface ApiKeysResponse {
+  apiKeys: ApiKeyCreds[];
+}
+interface BanStatus {
+  closed_only: boolean;
+}
+interface TradeParams {
+  id?: string;
+  maker_address?: string;
+  market?: string;
+  asset_id?: string;
+  before?: string;
+  after?: string;
+}
+interface BuilderTradeParams extends TradeParams {
+  builder_code: string;
+}
+interface OpenOrderParams {
+  id?: string;
+  market?: string;
+  asset_id?: string;
+}
+declare enum Chain {
+  POLYGON = 137,
+  AMOY = 80002,
+}
+interface MarketPrice {
+  t: number;
+  p: number;
+}
+interface PriceHistoryFilterParams {
+  market?: string;
+  startTs?: number;
+  endTs?: number;
+  fidelity?: number;
+  interval?: PriceHistoryInterval;
+}
+declare enum PriceHistoryInterval {
+  MAX = "max",
+  ONE_WEEK = "1w",
+  ONE_DAY = "1d",
+  SIX_HOURS = "6h",
+  ONE_HOUR = "1h",
+}
+interface DropNotificationParams {
+  ids: string[];
+}
+interface Notification {
+  type: number;
+  owner: string;
+  payload: any;
+}
+interface OrderMarketCancelParams {
+  market?: string;
+  asset_id?: string;
+}
+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;
+  last_trade_price: string;
+}
+interface OrderSummary {
+  price: string;
+  size: string;
+}
+declare enum AssetType {
+  COLLATERAL = "COLLATERAL",
+  CONDITIONAL = "CONDITIONAL",
+}
+interface BalanceAllowanceParams {
+  asset_type: AssetType;
+  token_id?: string;
+}
+interface BalanceAllowanceResponse {
+  balance: string;
+  allowances: Record<string, string>;
+}
+interface OrderScoringParams {
+  order_id: string;
+}
+interface OrderScoring {
+  scoring: boolean;
+}
+interface OrdersScoringParams {
+  orderIds: string[];
+}
+type OrdersScoring = { [orderId in string]: boolean };
+type OrderVersion = 1 | 2 | 3;
+type CreateOrderOptions = {
+  tickSize: TickSize;
+  negRisk?: boolean;
+  version?: OrderVersion;
+};
+type TickSize = "0.1" | "0.01" | "0.001" | "0.0001";
+interface RoundConfig {
+  readonly price: number;
+  readonly size: number;
+  readonly amount: number;
+}
+interface TickSizes {
+  [tokenId: string]: TickSize;
+}
+interface FeeRates {
+  [tokenId: string]: number;
+}
+interface NegRisk {
+  [tokenId: string]: boolean;
+}
+interface FeeInfo {
+  rate: number;
+  exponent: number;
+}
+interface FeeInfos {
+  [tokenId: string]: FeeInfo;
+}
+interface BuilderFeeRates {
+  [builderCode: string]: {
+    maker: number;
+    taker: number;
+  };
+}
+type TokenConditionMap = Record<string, string>;
+interface FeeDetails {
+  r?: number;
+  e?: number;
+  to?: boolean;
+}
+interface ClobRewards {
+  mi?: number;
+  ma?: number;
+  e?: boolean;
+  smoa?: boolean;
+  moas?: number;
+}
+interface ClobToken {
+  t: string;
+  o: string;
+}
+interface MarketDetails {
+  c: string;
+  t: [ClobToken, ClobToken];
+  mts: number;
+  nr?: boolean;
+  fd?: FeeDetails;
+  mbf?: number;
+  tbf?: number;
+  r: ClobRewards | null;
+  ao?: boolean;
+  mos?: number;
+  sd?: number;
+  gst?: string;
+  cbos?: boolean;
+  aot?: string;
+  rfqe?: boolean;
+  itode?: boolean;
+  ibce?: boolean;
+}
+interface PaginationPayload {
+  readonly limit: number;
+  readonly count: number;
+  readonly next_cursor: string;
+  readonly data: any[];
+}
+interface BookParams {
+  token_id: string;
+  side: Side;
+}
+interface UserEarning {
+  date: string;
+  condition_id: string;
+  asset_address: string;
+  maker_address: string;
+  earnings: number;
+  asset_rate: number;
+}
+interface TotalUserEarning {
+  date: string;
+  asset_address: string;
+  maker_address: string;
+  earnings: number;
+  asset_rate: number;
+}
+interface RewardsPercentages {
+  [market: string]: number;
+}
+interface Token {
+  token_id: string;
+  outcome: string;
+  price: number;
+}
+interface RewardsConfig {
+  asset_address: string;
+  start_date: string;
+  end_date: string;
+  rate_per_day: number;
+  total_rewards: number;
+}
+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[];
+}
+interface Earning {
+  asset_address: string;
+  earnings: number;
+  asset_rate: number;
+}
+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[];
+}
+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;
+  builderFee: string;
+  builderCode: string;
+  err_msg?: string | null;
+  createdAt: string | null;
+  updatedAt: string | null;
+}
+interface ReadonlyApiKeyResponse {
+  apiKey: string;
+}
+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;
+}
+interface BuilderApiKey {
+  key: string;
+  secret: string;
+  passphrase: string;
+}
+interface BuilderApiKeyResponse {
+  key: string;
+  createdAt?: string;
+  revokedAt?: string;
+}
+type ClobErrorResponseBody = {
+  error: string;
+};
+interface TradesPaginatedResponse {
+  trades: Trade[];
+  next_cursor: string;
+  limit: number;
+  count: number;
+}
+interface BuilderTradesResponse {
+  trades: BuilderTrade[];
+  next_cursor: string;
+  limit: number;
+  count: number;
+}
+//#endregion
+export { ApiKeyCreds, ApiKeyRaw, ApiKeysResponse, AssetType, BalanceAllowanceParams, BalanceAllowanceResponse, BanStatus, BookParams, BuilderApiKey, BuilderApiKeyResponse, BuilderConfig, BuilderFeeRates, BuilderTrade, BuilderTradeParams, BuilderTradesResponse, Chain, ClobErrorResponseBody, ClobRewards, ClobToken, CreateOrderOptions, DropNotificationParams, Earning, FeeDetails, FeeInfo, FeeInfos, FeeRates, L1PolyHeader, L2HeaderArgs, L2PolyHeader, MakerOrder, MarketDetails, MarketPrice, MarketReward, MarketTradeEvent, NegRisk, Notification, OpenOrder, OpenOrderParams, OpenOrdersResponse, OrderBookSummary, OrderMarketCancelParams, OrderPayload, OrderResponse, OrderScoring, OrderScoringParams, OrderSummary, OrderType, OrderVersion, OrdersScoring, OrdersScoringParams, PaginationPayload, PreMigrationOrder, PreMigrationOrdersResponse, PriceHistoryFilterParams, PriceHistoryInterval, ReadonlyApiKeyResponse, RewardsConfig, RewardsPercentages, RoundConfig, SimpleHeaders, TickSize, TickSizes, Token, TokenConditionMap, TotalUserEarning, Trade, TradeParams, TradesPaginatedResponse, UserEarning, UserRewardsEarning };
+//# sourceMappingURL=clob.d.ts.map

package/dist/types/clob.js

@@ -0,0 +1,32 @@
+import { Side } from "../order-utils/model/side.js";
+
+//#region src/types/clob.ts
+let OrderType = /* @__PURE__ */ function(OrderType$1) {
+	OrderType$1["GTC"] = "GTC";
+	OrderType$1["FOK"] = "FOK";
+	OrderType$1["GTD"] = "GTD";
+	OrderType$1["FAK"] = "FAK";
+	return OrderType$1;
+}({});
+let Chain = /* @__PURE__ */ function(Chain$1) {
+	Chain$1[Chain$1["POLYGON"] = 137] = "POLYGON";
+	Chain$1[Chain$1["AMOY"] = 80002] = "AMOY";
+	return Chain$1;
+}({});
+let PriceHistoryInterval = /* @__PURE__ */ function(PriceHistoryInterval$1) {
+	PriceHistoryInterval$1["MAX"] = "max";
+	PriceHistoryInterval$1["ONE_WEEK"] = "1w";
+	PriceHistoryInterval$1["ONE_DAY"] = "1d";
+	PriceHistoryInterval$1["SIX_HOURS"] = "6h";
+	PriceHistoryInterval$1["ONE_HOUR"] = "1h";
+	return PriceHistoryInterval$1;
+}({});
+let AssetType = /* @__PURE__ */ function(AssetType$1) {
+	AssetType$1["COLLATERAL"] = "COLLATERAL";
+	AssetType$1["CONDITIONAL"] = "CONDITIONAL";
+	return AssetType$1;
+}({});
+
+//#endregion
+export { AssetType, Chain, OrderType, PriceHistoryInterval };
+//# sourceMappingURL=clob.js.map

package/dist/types/clob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clob.js","names":[],"sources":["../../src/types/clob.ts"],"sourcesContent":["import { Side } from \"../order-utils/model/side.js\";\n\nexport { Side };\n\nexport interface ApiKeyCreds {\n\tkey: string;\n\tsecret: string;\n\tpassphrase: string;\n}\n\nexport interface BuilderConfig {\n\tbuilderCode: string;\n}\n\nexport interface ApiKeyRaw {\n\tapiKey: string;\n\tsecret: string;\n\tpassphrase: string;\n}\n\nexport interface L2HeaderArgs {\n\tmethod: string;\n\trequestPath: string;\n\tbody?: string;\n}\n\nexport type SimpleHeaders = Record<string, string | number | boolean>;\n\n// EIP712 sig verification\nexport interface L1PolyHeader extends SimpleHeaders {\n\tPOLY_ADDRESS: string;\n\tPOLY_SIGNATURE: string;\n\tPOLY_TIMESTAMP: string;\n\tPOLY_NONCE: string;\n}\n\n// API key verification\nexport interface L2PolyHeader extends SimpleHeaders {\n\tPOLY_ADDRESS: string;\n\tPOLY_SIGNATURE: string;\n\tPOLY_TIMESTAMP: string;\n\tPOLY_API_KEY: string;\n\tPOLY_PASSPHRASE: string;\n}\n\nexport enum OrderType {\n\tGTC = \"GTC\",\n\tFOK = \"FOK\",\n\tGTD = \"GTD\",\n\tFAK = \"FAK\",\n}\n\nexport interface OrderPayload {\n\torderID: string;\n}\n\nexport interface OrderResponse {\n\tsuccess: boolean;\n\terrorMsg: string;\n\torderID: string;\n\ttransactionsHashes?: string[];\n\ttradeIDs?: string[];\n\tstatus: string;\n\ttakingAmount: string;\n\tmakingAmount: string;\n}\n\nexport interface OpenOrder {\n\tid: string;\n\tstatus: string;\n\towner: string;\n\tmaker_address: string;\n\tmarket: string;\n\tasset_id: string;\n\tside: string;\n\toriginal_size: string;\n\tsize_matched: string;\n\tprice: string;\n\tassociate_trades: string[];\n\toutcome: string;\n\tcreated_at: number;\n\texpiration: string;\n\torder_type: string;\n}\n\nexport type OpenOrdersResponse = OpenOrder[];\n\nexport type PreMigrationOrder = OpenOrder;\n\nexport type PreMigrationOrdersResponse = PreMigrationOrder[];\n\nexport interface MakerOrder {\n\torder_id: string;\n\towner: string;\n\tmaker_address: string;\n\tmatched_amount: string;\n\tprice: string;\n\tfee_rate_bps: string;\n\tasset_id: string;\n\toutcome: string;\n\tside?: Side;\n\tbuilder_fee?: string;\n\tbuilder_code?: string;\n}\n\nexport interface Trade {\n\tid: string;\n\ttaker_order_id: string;\n\tmarket: string;\n\tasset_id: string;\n\tside: Side;\n\tsize: string;\n\tfee_rate_bps: string;\n\tprice: string;\n\tstatus: string;\n\tmatch_time: string;\n\tmatch_time_nano?: string;\n\tlast_update: string;\n\toutcome: string;\n\tbucket_index: number;\n\towner: string;\n\tmaker_address: string;\n\tmaker_orders: MakerOrder[];\n\ttransaction_hash?: string;\n\terr_msg?: string | null;\n\ttrader_side: \"TAKER\" | \"MAKER\";\n}\n\nexport interface ApiKeysResponse {\n\tapiKeys: ApiKeyCreds[];\n}\n\nexport interface BanStatus {\n\tclosed_only: boolean;\n}\n\nexport interface TradeParams {\n\tid?: string;\n\tmaker_address?: string;\n\tmarket?: string;\n\tasset_id?: string;\n\tbefore?: string;\n\tafter?: string;\n}\n\nexport interface BuilderTradeParams extends TradeParams {\n\tbuilder_code: string;\n}\n\nexport interface OpenOrderParams {\n\tid?: string;\n\tmarket?: string;\n\tasset_id?: string;\n}\n\nexport enum Chain {\n\tPOLYGON = 137,\n\tAMOY = 80002,\n}\n\nexport interface MarketPrice {\n\tt: number; // timestamp\n\tp: number; // price\n}\n\nexport interface PriceHistoryFilterParams {\n\tmarket?: string;\n\tstartTs?: number;\n\tendTs?: number;\n\tfidelity?: number;\n\tinterval?: PriceHistoryInterval;\n}\n\nexport enum PriceHistoryInterval {\n\tMAX = \"max\",\n\tONE_WEEK = \"1w\",\n\tONE_DAY = \"1d\",\n\tSIX_HOURS = \"6h\",\n\tONE_HOUR = \"1h\",\n}\n\nexport interface DropNotificationParams {\n\tids: string[];\n}\n\nexport interface Notification {\n\ttype: number;\n\towner: string;\n\n\tpayload: any;\n}\n\nexport interface OrderMarketCancelParams {\n\tmarket?: string;\n\tasset_id?: string;\n}\n\nexport interface OrderBookSummary {\n\tmarket: string;\n\tasset_id: string;\n\ttimestamp: string;\n\tbids: OrderSummary[];\n\tasks: OrderSummary[];\n\tmin_order_size: string;\n\ttick_size: string;\n\tneg_risk: boolean;\n\thash: string;\n\tlast_trade_price: string;\n}\n\nexport interface OrderSummary {\n\tprice: string;\n\tsize: string;\n}\n\nexport enum AssetType {\n\tCOLLATERAL = \"COLLATERAL\",\n\tCONDITIONAL = \"CONDITIONAL\",\n}\n\nexport interface BalanceAllowanceParams {\n\tasset_type: AssetType;\n\ttoken_id?: string;\n}\n\nexport interface BalanceAllowanceResponse {\n\tbalance: string;\n\tallowances: Record<string, string>;\n}\n\nexport interface OrderScoringParams {\n\torder_id: string;\n}\n\nexport interface OrderScoring {\n\tscoring: boolean;\n}\n\nexport interface OrdersScoringParams {\n\torderIds: string[];\n}\n\nexport type OrdersScoring = { [orderId in string]: boolean };\n\nexport type OrderVersion = 1 | 2 | 3;\n\nexport type CreateOrderOptions = {\n\ttickSize: TickSize;\n\tnegRisk?: boolean;\n\tversion?: OrderVersion;\n};\n\nexport type TickSize = \"0.1\" | \"0.01\" | \"0.001\" | \"0.0001\";\n\nexport interface RoundConfig {\n\treadonly price: number;\n\treadonly size: number;\n\treadonly amount: number;\n}\n\nexport interface TickSizes {\n\t[tokenId: string]: TickSize;\n}\n\nexport interface FeeRates {\n\t[tokenId: string]: number;\n}\n\nexport interface NegRisk {\n\t[tokenId: string]: boolean;\n}\n\nexport interface FeeInfo {\n\trate: number;\n\texponent: number;\n}\n\nexport interface FeeInfos {\n\t[tokenId: string]: FeeInfo;\n}\n\nexport interface BuilderFeeRates {\n\t[builderCode: string]: { maker: number; taker: number };\n}\n\nexport type TokenConditionMap = Record<string, string>;\n\nexport interface FeeDetails {\n\tr?: number; // fee rate\n\te?: number; // fee exponent\n\tto?: boolean; // taker only (omitted when false)\n}\n\nexport interface ClobRewards {\n\tmi?: number; // min size\n\tma?: number; // max spread\n\te?: boolean; // enabled\n\tsmoa?: boolean; // skip min order age\n\tmoas?: number; // min order age seconds\n}\n\nexport interface ClobToken {\n\tt: string; // token ID\n\to: string; // outcome\n}\n\nexport interface MarketDetails {\n\tc: string; // condition ID\n\tt: [ClobToken, ClobToken]; // YES and NO tokens\n\tmts: number; // min tick size\n\tnr?: boolean; // neg risk (omitted when false)\n\tfd?: FeeDetails; // platform fee details\n\tmbf?: number; // maker base fee\n\ttbf?: number; // taker base fee\n\tr: ClobRewards | null; // rewards config (always present, null if unset)\n\tao?: boolean; // accepting orders\n\tmos?: number; // min order size\n\tsd?: number; // seconds delay\n\tgst?: string; // game start time (ISO 8601)\n\tcbos?: boolean; // clear book on start\n\taot?: string; // accepting orders timestamp (ISO 8601)\n\trfqe?: boolean; // RFQ enabled\n\titode?: boolean; // taker order delay enabled\n\tibce?: boolean; // blockaid check enabled\n}\n\nexport interface PaginationPayload {\n\treadonly limit: number;\n\treadonly count: number;\n\treadonly next_cursor: string;\n\treadonly data: any[];\n}\n\nexport interface BookParams {\n\ttoken_id: string;\n\tside: Side;\n}\n\nexport interface UserEarning {\n\tdate: string;\n\tcondition_id: string;\n\tasset_address: string;\n\tmaker_address: string;\n\tearnings: number;\n\tasset_rate: number;\n}\n\nexport interface TotalUserEarning {\n\tdate: string;\n\tasset_address: string;\n\tmaker_address: string;\n\tearnings: number;\n\tasset_rate: number;\n}\n\nexport interface RewardsPercentages {\n\t[market: string]: number;\n}\n\nexport interface Token {\n\ttoken_id: string;\n\toutcome: string;\n\tprice: number;\n}\n\nexport interface RewardsConfig {\n\tasset_address: string;\n\tstart_date: string;\n\tend_date: string;\n\trate_per_day: number;\n\ttotal_rewards: number;\n}\n\nexport interface MarketReward {\n\tcondition_id: string;\n\tquestion: string;\n\tmarket_slug: string;\n\tevent_slug: string;\n\timage: string;\n\trewards_max_spread: number;\n\trewards_min_size: number;\n\ttokens: Token[];\n\trewards_config: RewardsConfig[];\n}\n\nexport interface Earning {\n\tasset_address: string;\n\tearnings: number;\n\tasset_rate: number;\n}\n\nexport interface UserRewardsEarning {\n\tcondition_id: string;\n\tquestion: string;\n\tmarket_slug: string;\n\tevent_slug: string;\n\timage: string;\n\trewards_max_spread: number;\n\trewards_min_size: number;\n\tmarket_competitiveness: number;\n\ttokens: Token[];\n\trewards_config: RewardsConfig[];\n\tmaker_address: string;\n\tearning_percentage: number;\n\tearnings: Earning[];\n}\n\nexport interface BuilderTrade {\n\tid: string;\n\ttradeType: string;\n\ttakerOrderHash: string;\n\tbuilder: string;\n\tmarket: string;\n\tassetId: string;\n\tside: string;\n\tsize: string;\n\tsizeUsdc: string;\n\tprice: string;\n\tstatus: string;\n\toutcome: string;\n\toutcomeIndex: number;\n\towner: string;\n\tmaker: string;\n\ttransactionHash: string;\n\tmatchTime: string;\n\tbucketIndex: number;\n\tfee: string;\n\tfeeUsdc: string;\n\tbuilderFee: string;\n\tbuilderCode: string;\n\terr_msg?: string | null;\n\tcreatedAt: string | null;\n\tupdatedAt: string | null;\n}\n\nexport interface ReadonlyApiKeyResponse {\n\tapiKey: string;\n}\n\nexport interface MarketTradeEvent {\n\tevent_type: string;\n\tmarket: {\n\t\tcondition_id: string;\n\t\tasset_id: string;\n\t\tquestion: string;\n\t\ticon: string;\n\t\tslug: string;\n\t};\n\tuser: {\n\t\taddress: string;\n\t\tusername: string;\n\t\tprofile_picture: string;\n\t\toptimized_profile_picture: string;\n\t\tpseudonym: string;\n\t};\n\tside: Side;\n\tsize: string;\n\tfee_rate_bps: string;\n\tprice: string;\n\toutcome: string;\n\toutcome_index: number;\n\ttransaction_hash: string;\n\ttimestamp: string;\n}\n\nexport interface BuilderApiKey {\n\tkey: string;\n\tsecret: string;\n\tpassphrase: string;\n}\n\nexport interface BuilderApiKeyResponse {\n\tkey: string;\n\tcreatedAt?: string;\n\trevokedAt?: string;\n}\n\nexport type ClobErrorResponseBody = {\n\terror: string;\n};\n\nexport interface TradesPaginatedResponse {\n\ttrades: Trade[];\n\tnext_cursor: string;\n\tlimit: number;\n\tcount: number;\n}\n\nexport interface BuilderTradesResponse {\n\ttrades: BuilderTrade[];\n\tnext_cursor: string;\n\tlimit: number;\n\tcount: number;\n}\n"],"mappings":";;;AA6CA,IAAY,kDAAL;AACN;AACA;AACA;AACA;;;AA0GD,IAAY,0CAAL;AACN;AACA;;;AAgBD,IAAY,wEAAL;AACN;AACA;AACA;AACA;AACA;;;AAqCD,IAAY,kDAAL;AACN;AACA"}

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+import { Side } from "../order-utils/model/side.js";
+import { ApiKeyCreds, ApiKeyRaw, ApiKeysResponse, AssetType, BalanceAllowanceParams, BalanceAllowanceResponse, BanStatus, BookParams, BuilderApiKey, BuilderApiKeyResponse, BuilderConfig, BuilderFeeRates, BuilderTrade, BuilderTradeParams, BuilderTradesResponse, Chain, ClobErrorResponseBody, ClobRewards, ClobToken, CreateOrderOptions, DropNotificationParams, Earning, FeeDetails, FeeInfo, FeeInfos, FeeRates, L1PolyHeader, L2HeaderArgs, L2PolyHeader, MakerOrder, MarketDetails, MarketPrice, MarketReward, MarketTradeEvent, NegRisk, Notification, OpenOrder, OpenOrderParams, OpenOrdersResponse, OrderBookSummary, OrderMarketCancelParams, OrderPayload, OrderResponse, OrderScoring, OrderScoringParams, OrderSummary, OrderType, OrderVersion, OrdersScoring, OrdersScoringParams, PaginationPayload, PreMigrationOrder, PreMigrationOrdersResponse, PriceHistoryFilterParams, PriceHistoryInterval, ReadonlyApiKeyResponse, RewardsConfig, RewardsPercentages, RoundConfig, SimpleHeaders, TickSize, TickSizes, Token, TokenConditionMap, TotalUserEarning, Trade, TradeParams, TradesPaginatedResponse, UserEarning, UserRewardsEarning } from "./clob.js";
+import { NewOrderV1, PostOrdersV1Args, UserMarketOrderV1, UserOrderV1, orderToJsonV1 } from "./ordersV1.js";
+import { NewOrderV2, PostOrdersV2Args, UserMarketOrderV2, UserOrderV2, orderToJsonV2 } from "./ordersV2.js";
+import { ExchangeV3OrderAmounts } from "./ordersV3.js";
+import { PostOrdersArgs, SignedOrder, VersionedPostOrdersArgs, VersionedSignedOrder, VersionedUserMarketOrder, VersionedUserOrder, isV2Order } from "./unifiedOrder.js";

package/dist/types/ordersV1.cjs

@@ -0,0 +1,29 @@
+
+//#region src/types/ordersV1.ts
+function orderToJsonV1(order, owner, orderType, postOnly = false, deferExec = false) {
+	return {
+		deferExec,
+		postOnly,
+		order: {
+			salt: parseInt(order.salt, 10),
+			maker: order.maker,
+			signer: order.signer,
+			taker: order.taker,
+			tokenId: order.tokenId,
+			makerAmount: order.makerAmount,
+			takerAmount: order.takerAmount,
+			side: order.side,
+			expiration: order.expiration,
+			nonce: order.nonce,
+			feeRateBps: order.feeRateBps,
+			signatureType: order.signatureType,
+			signature: order.signature
+		},
+		owner,
+		orderType
+	};
+}
+
+//#endregion
+exports.orderToJsonV1 = orderToJsonV1;
+//# sourceMappingURL=ordersV1.cjs.map

package/dist/types/ordersV1.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ordersV1.cjs","names":[],"sources":["../../src/types/ordersV1.ts"],"sourcesContent":["import type { SignatureTypeV1, SignedOrderV1 } from \"../order-utils/index.js\";\n\nimport type { OrderType, Side } from \"./clob.js\";\n\nexport function orderToJsonV1<T extends OrderType>(\n\torder: SignedOrderV1,\n\towner: string,\n\torderType: T,\n\tpostOnly = false,\n\tdeferExec = false,\n): NewOrderV1<T> {\n\treturn {\n\t\tdeferExec,\n\t\tpostOnly,\n\t\torder: {\n\t\t\tsalt: parseInt(order.salt, 10),\n\t\t\tmaker: order.maker,\n\t\t\tsigner: order.signer,\n\t\t\ttaker: order.taker,\n\t\t\ttokenId: order.tokenId,\n\t\t\tmakerAmount: order.makerAmount,\n\t\t\ttakerAmount: order.takerAmount,\n\t\t\tside: order.side,\n\t\t\texpiration: order.expiration,\n\t\t\tnonce: order.nonce,\n\t\t\tfeeRateBps: order.feeRateBps,\n\t\t\tsignatureType: order.signatureType,\n\t\t\tsignature: order.signature,\n\t\t},\n\t\towner,\n\t\torderType,\n\t} as NewOrderV1<T>;\n}\n\nexport interface PostOrdersV1Args {\n\torder: SignedOrderV1;\n\torderType: OrderType;\n}\n\nexport interface NewOrderV1<T extends OrderType> {\n\treadonly order: {\n\t\treadonly salt: number;\n\t\treadonly maker: string;\n\t\treadonly signer: string;\n\t\treadonly taker: string;\n\t\treadonly tokenId: string;\n\t\treadonly makerAmount: string;\n\t\treadonly takerAmount: string;\n\t\treadonly expiration: string;\n\t\treadonly nonce: string;\n\t\treadonly feeRateBps: string;\n\t\treadonly side: string;\n\t\treadonly signatureType: SignatureTypeV1;\n\t\treadonly signature: string;\n\t};\n\treadonly owner: string;\n\treadonly orderType: T;\n\treadonly deferExec: boolean;\n\treadonly postOnly: boolean;\n}\n\n// Simplified order for users\nexport interface UserOrderV1 {\n\t/**\n\t * TokenID of the Conditional token asset being traded\n\t */\n\ttokenID: string;\n\n\t/**\n\t * Price used to create the order\n\t */\n\tprice: number;\n\n\t/**\n\t * Size in terms of the ConditionalToken\n\t */\n\tsize: number;\n\n\t/**\n\t * Side of the order\n\t */\n\tside: Side;\n\n\t/**\n\t * Fee rate, in basis points, charged to the order maker, charged on proceeds\n\t */\n\tfeeRateBps?: number;\n\n\t/**\n\t * Nonce used for onchain cancellations\n\t */\n\tnonce?: number;\n\n\t/**\n\t * Timestamp after which the order is expired.\n\t */\n\texpiration?: number;\n\n\t/**\n\t * Address of the order taker. The zero address is used to indicate a public order\n\t */\n\ttaker?: string;\n\n\t/**\n\t * Builder code (bytes32)\n\t */\n\tbuilderCode?: string;\n}\n\n// Simplified market order for users\nexport interface UserMarketOrderV1 {\n\t/**\n\t * TokenID of the Conditional token asset being traded\n\t */\n\ttokenID: string;\n\n\t/**\n\t * Price used to create the order\n\t * If it is not present the market price will be used.\n\t */\n\tprice?: number;\n\n\t/**\n\t * BUY orders: $$$ Amount to buy\n\t * SELL orders: Shares to sell\n\t */\n\tamount: number;\n\n\t/**\n\t * Side of the order\n\t */\n\tside: Side;\n\n\t/**\n\t * Fee rate, in basis points, charged to the order maker, charged on proceeds\n\t */\n\tfeeRateBps?: number;\n\n\t/**\n\t * Nonce used for onchain cancellations\n\t */\n\tnonce?: number;\n\n\t/**\n\t * Address of the order taker. The zero address is used to indicate a public order\n\t */\n\ttaker?: string;\n\n\t/**\n\t * Specifies the type of order execution:\n\t * - FOK (Fill or Kill): The order must be filled entirely or not at all.\n\t * - FAK (Fill and Kill): The order can be partially filled, and any unfilled portion is canceled.\n\t */\n\torderType?: OrderType.FOK | OrderType.FAK;\n\n\t/**\n\t * Builder code (bytes32)\n\t */\n\tbuilderCode?: string;\n}\n"],"mappings":";;AAIA,SAAgB,cACf,OACA,OACA,WACA,WAAW,OACX,YAAY,OACI;AAChB,QAAO;EACN;EACA;EACA,OAAO;GACN,MAAM,SAAS,MAAM,MAAM,GAAG;GAC9B,OAAO,MAAM;GACb,QAAQ,MAAM;GACd,OAAO,MAAM;GACb,SAAS,MAAM;GACf,aAAa,MAAM;GACnB,aAAa,MAAM;GACnB,MAAM,MAAM;GACZ,YAAY,MAAM;GAClB,OAAO,MAAM;GACb,YAAY,MAAM;GAClB,eAAe,MAAM;GACrB,WAAW,MAAM;GACjB;EACD;EACA;EACA"}

package/dist/types/ordersV1.d.cts

@@ -0,0 +1,115 @@
+import { Side } from "../order-utils/model/side.cjs";
+import { OrderType } from "./clob.cjs";
+import { SignatureTypeV1 } from "../order-utils/model/signatureTypeV1.cjs";
+import { SignedOrderV1 } from "../order-utils/model/orderDataV1.cjs";
+
+//#region src/types/ordersV1.d.ts
+declare function orderToJsonV1<T extends OrderType>(order: SignedOrderV1, owner: string, orderType: T, postOnly?: boolean, deferExec?: boolean): NewOrderV1<T>;
+interface PostOrdersV1Args {
+  order: SignedOrderV1;
+  orderType: OrderType;
+}
+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;
+  readonly postOnly: boolean;
+}
+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;
+}
+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;
+}
+//#endregion
+export { NewOrderV1, PostOrdersV1Args, UserMarketOrderV1, UserOrderV1, orderToJsonV1 };
+//# sourceMappingURL=ordersV1.d.cts.map