@polymarket/clob-client-v2 0.0.3 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (124) hide show
  1. package/dist/client.d.ts +15 -29
  2. package/dist/client.js +723 -862
  3. package/dist/client.js.map +1 -1
  4. package/dist/config.js +1 -6
  5. package/dist/config.js.map +1 -1
  6. package/dist/constants.js +6 -9
  7. package/dist/constants.js.map +1 -1
  8. package/dist/endpoints.d.ts +1 -0
  9. package/dist/endpoints.js +54 -56
  10. package/dist/endpoints.js.map +1 -1
  11. package/dist/errors.js +2 -5
  12. package/dist/errors.js.map +1 -1
  13. package/dist/headers/index.d.ts +4 -5
  14. package/dist/headers/index.js +10 -15
  15. package/dist/headers/index.js.map +1 -1
  16. package/dist/http-helpers/index.d.ts +1 -1
  17. package/dist/http-helpers/index.js +41 -53
  18. package/dist/http-helpers/index.js.map +1 -1
  19. package/dist/index.d.ts +7 -7
  20. package/dist/index.js +7 -10
  21. package/dist/index.js.map +1 -1
  22. package/dist/order-builder/helpers/buildMarketOrderCreationArgs.d.ts +2 -2
  23. package/dist/order-builder/helpers/buildMarketOrderCreationArgs.js +12 -19
  24. package/dist/order-builder/helpers/buildMarketOrderCreationArgs.js.map +1 -1
  25. package/dist/order-builder/helpers/buildOrder.d.ts +5 -6
  26. package/dist/order-builder/helpers/buildOrder.js +11 -18
  27. package/dist/order-builder/helpers/buildOrder.js.map +1 -1
  28. package/dist/order-builder/helpers/buildOrderCreationArgs.d.ts +2 -2
  29. package/dist/order-builder/helpers/buildOrderCreationArgs.js +13 -19
  30. package/dist/order-builder/helpers/buildOrderCreationArgs.js.map +1 -1
  31. package/dist/order-builder/helpers/calculateBuyMarketPrice.d.ts +1 -1
  32. package/dist/order-builder/helpers/calculateBuyMarketPrice.js +3 -7
  33. package/dist/order-builder/helpers/calculateBuyMarketPrice.js.map +1 -1
  34. package/dist/order-builder/helpers/calculateSellMarketPrice.d.ts +1 -1
  35. package/dist/order-builder/helpers/calculateSellMarketPrice.js +3 -7
  36. package/dist/order-builder/helpers/calculateSellMarketPrice.js.map +1 -1
  37. package/dist/order-builder/helpers/createMarketOrder.d.ts +5 -6
  38. package/dist/order-builder/helpers/createMarketOrder.js +15 -19
  39. package/dist/order-builder/helpers/createMarketOrder.js.map +1 -1
  40. package/dist/order-builder/helpers/createOrder.d.ts +5 -6
  41. package/dist/order-builder/helpers/createOrder.js +15 -19
  42. package/dist/order-builder/helpers/createOrder.js.map +1 -1
  43. package/dist/order-builder/helpers/getMarketOrderRawAmounts.d.ts +1 -1
  44. package/dist/order-builder/helpers/getMarketOrderRawAmounts.js +17 -21
  45. package/dist/order-builder/helpers/getMarketOrderRawAmounts.js.map +1 -1
  46. package/dist/order-builder/helpers/getOrderRawAmounts.d.ts +1 -1
  47. package/dist/order-builder/helpers/getOrderRawAmounts.js +17 -21
  48. package/dist/order-builder/helpers/getOrderRawAmounts.js.map +1 -1
  49. package/dist/order-builder/helpers/index.d.ts +10 -10
  50. package/dist/order-builder/helpers/index.js +10 -23
  51. package/dist/order-builder/helpers/index.js.map +1 -1
  52. package/dist/order-builder/helpers/roundingConfig.d.ts +1 -1
  53. package/dist/order-builder/helpers/roundingConfig.js +1 -4
  54. package/dist/order-builder/helpers/roundingConfig.js.map +1 -1
  55. package/dist/order-builder/index.d.ts +1 -1
  56. package/dist/order-builder/index.js +1 -4
  57. package/dist/order-builder/index.js.map +1 -1
  58. package/dist/order-builder/orderBuilder.d.ts +5 -6
  59. package/dist/order-builder/orderBuilder.js +34 -29
  60. package/dist/order-builder/orderBuilder.js.map +1 -1
  61. package/dist/order-utils/abi/ExchangeV1.js +1 -4
  62. package/dist/order-utils/abi/ExchangeV1.js.map +1 -1
  63. package/dist/order-utils/abi/ExchangeV2.js +1 -4
  64. package/dist/order-utils/abi/ExchangeV2.js.map +1 -1
  65. package/dist/order-utils/exchangeOrderBuilderV1.d.ts +5 -6
  66. package/dist/order-utils/exchangeOrderBuilderV1.js +76 -77
  67. package/dist/order-utils/exchangeOrderBuilderV1.js.map +1 -1
  68. package/dist/order-utils/exchangeOrderBuilderV2.d.ts +6 -7
  69. package/dist/order-utils/exchangeOrderBuilderV2.js +49 -50
  70. package/dist/order-utils/exchangeOrderBuilderV2.js.map +1 -1
  71. package/dist/order-utils/index.js +8 -11
  72. package/dist/order-utils/index.js.map +1 -1
  73. package/dist/order-utils/model/abi.js +1 -2
  74. package/dist/order-utils/model/ctfExchangeV1TypedData.js +3 -6
  75. package/dist/order-utils/model/ctfExchangeV1TypedData.js.map +1 -1
  76. package/dist/order-utils/model/ctfExchangeV2TypedData.js +3 -6
  77. package/dist/order-utils/model/ctfExchangeV2TypedData.js.map +1 -1
  78. package/dist/order-utils/model/eip712.js +1 -4
  79. package/dist/order-utils/model/eip712.js.map +1 -1
  80. package/dist/order-utils/model/order.js +1 -2
  81. package/dist/order-utils/model/orderDataV1.d.ts +4 -4
  82. package/dist/order-utils/model/orderDataV1.js +1 -2
  83. package/dist/order-utils/model/orderDataV2.d.ts +12 -13
  84. package/dist/order-utils/model/orderDataV2.js +1 -2
  85. package/dist/order-utils/model/side.js +2 -5
  86. package/dist/order-utils/model/side.js.map +1 -1
  87. package/dist/order-utils/model/signatureTypeV1.js +2 -5
  88. package/dist/order-utils/model/signatureTypeV1.js.map +1 -1
  89. package/dist/order-utils/model/signatureTypeV2.js +2 -5
  90. package/dist/order-utils/model/signatureTypeV2.js.map +1 -1
  91. package/dist/order-utils/utils.js +1 -4
  92. package/dist/order-utils/utils.js.map +1 -1
  93. package/dist/signing/constants.js +7 -10
  94. package/dist/signing/constants.js.map +1 -1
  95. package/dist/signing/eip712.d.ts +3 -4
  96. package/dist/signing/eip712.js +7 -12
  97. package/dist/signing/eip712.js.map +1 -1
  98. package/dist/signing/hmac.js +3 -8
  99. package/dist/signing/hmac.js.map +1 -1
  100. package/dist/signing/index.d.ts +3 -2
  101. package/dist/signing/index.js +3 -5
  102. package/dist/signing/index.js.map +1 -1
  103. package/dist/signing/signer.d.ts +9 -0
  104. package/dist/signing/signer.js +30 -0
  105. package/dist/signing/signer.js.map +1 -0
  106. package/dist/types/clob.d.ts +19 -6
  107. package/dist/types/clob.js +10 -13
  108. package/dist/types/clob.js.map +1 -1
  109. package/dist/types/index.d.ts +4 -4
  110. package/dist/types/index.js +4 -7
  111. package/dist/types/index.js.map +1 -1
  112. package/dist/types/ordersV1.d.ts +3 -2
  113. package/dist/types/ordersV1.js +22 -2
  114. package/dist/types/ordersV1.js.map +1 -1
  115. package/dist/types/ordersV2.d.ts +14 -5
  116. package/dist/types/ordersV2.js +23 -2
  117. package/dist/types/ordersV2.js.map +1 -1
  118. package/dist/types/unifiedOrder.d.ts +4 -4
  119. package/dist/types/unifiedOrder.js +1 -4
  120. package/dist/types/unifiedOrder.js.map +1 -1
  121. package/dist/utilities.d.ts +1 -5
  122. package/dist/utilities.js +15 -72
  123. package/dist/utilities.js.map +1 -1
  124. package/package.json +24 -18
package/dist/client.d.ts CHANGED
@@ -1,41 +1,38 @@
1
- import type { JsonRpcSigner } from "@ethersproject/providers";
2
- import type { Wallet } from "@ethersproject/wallet";
3
- import { OrderBuilder } from "./order-builder";
4
- import type { SignatureTypeV2 } from "./order-utils/model/signatureTypeV2";
5
- 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, PostOrdersArgs, PriceHistoryFilterParams, RewardsPercentages, TickSize, TickSizes, TotalUserEarning, Trade, TradeParams, UserEarning, UserMarketOrderV2, UserOrderV2, UserRewardsEarning } from "./types";
6
- import { OrderType, Side } from "./types";
7
- import { type SignedOrder } from "./types/unifiedOrder";
1
+ import { OrderBuilder } from "./order-builder/index.js";
2
+ import type { SignatureTypeV2 } from "./order-utils/model/signatureTypeV2.js";
3
+ import type { ClobSigner } from "./signing/signer.js";
4
+ import type { ApiKeyCreds, ApiKeysResponse, BalanceAllowanceParams, BalanceAllowanceResponse, BanStatus, BookParams, BuilderApiKey, BuilderApiKeyResponse, BuilderConfig, BuilderFeeRates, BuilderTradeParams, BuilderTradesResponse, Chain, CreateOrderOptions, DropNotificationParams, FeeInfos, MarketDetails, MarketPrice, MarketReward, MarketTradeEvent, NegRisk, Notification, OpenOrder, OpenOrderParams, OpenOrdersResponse, OrderBookSummary, OrderMarketCancelParams, OrderPayload, OrderScoring, OrderScoringParams, OrdersScoring, OrdersScoringParams, PaginationPayload, PostOrdersArgs, PriceHistoryFilterParams, RewardsPercentages, TickSize, TickSizes, TotalUserEarning, Trade, TradeParams, TradesPaginatedResponse, UserEarning, UserMarketOrderV2, UserOrderV2, UserRewardsEarning } from "./types/index.js";
5
+ import { OrderType, Side } from "./types/index.js";
6
+ import { type SignedOrder } from "./types/unifiedOrder.js";
7
+ export declare function adjustBuyAmountForFees(amount: number, price: number, userUSDCBalance: number, feeRate: number, feeExponent: number, builderTakerFeeRate: number): number;
8
8
  export interface ClobClientOptions {
9
9
  host: string;
10
10
  chain: Chain;
11
- signer?: Wallet | JsonRpcSigner;
11
+ signer?: ClobSigner;
12
12
  creds?: ApiKeyCreds;
13
13
  signatureType?: SignatureTypeV2;
14
14
  funderAddress?: string;
15
- geoBlockToken?: string;
16
15
  useServerTime?: boolean;
17
16
  builderConfig?: BuilderConfig;
18
- getSigner?: () => Promise<Wallet | JsonRpcSigner> | (Wallet | JsonRpcSigner);
17
+ getSigner?: () => Promise<ClobSigner> | ClobSigner;
19
18
  retryOnError?: boolean;
20
19
  }
21
20
  export declare class ClobClient {
22
21
  readonly host: string;
23
22
  readonly chainId: Chain;
24
- readonly signer?: Wallet | JsonRpcSigner;
23
+ readonly signer?: ClobSigner;
25
24
  readonly creds?: ApiKeyCreds;
26
25
  readonly orderBuilder: OrderBuilder;
27
26
  readonly tickSizes: TickSizes;
28
27
  readonly negRisk: NegRisk;
29
- readonly feeRates: FeeRates;
30
- readonly feeExponents: FeeExponents;
28
+ readonly feeInfos: FeeInfos;
31
29
  readonly builderFeeRates: BuilderFeeRates;
32
30
  private readonly tokenConditionMap;
33
- readonly geoBlockToken?: string;
34
31
  readonly useServerTime?: boolean;
35
32
  readonly builderConfig?: BuilderConfig;
36
33
  private cachedVersion?;
37
34
  readonly retryOnError?: boolean;
38
- constructor({ host, chain, signer, creds, signatureType, funderAddress, geoBlockToken, useServerTime, builderConfig, getSigner, retryOnError, }: ClobClientOptions);
35
+ constructor({ host, chain, signer, creds, signatureType, funderAddress, useServerTime, builderConfig, getSigner, retryOnError, }: ClobClientOptions);
39
36
  getOk(): Promise<any>;
40
37
  getVersion(): Promise<number>;
41
38
  getServerTime(): Promise<number>;
@@ -84,18 +81,8 @@ export declare class ClobClient {
84
81
  deleteApiKey(): Promise<any>;
85
82
  getOrder(orderID: string): Promise<OpenOrder>;
86
83
  getTrades(params?: TradeParams, only_first_page?: boolean, next_cursor?: string): Promise<Trade[]>;
87
- getTradesPaginated(params?: TradeParams, next_cursor?: string): Promise<{
88
- trades: Trade[];
89
- next_cursor: string;
90
- limit: number;
91
- count: number;
92
- }>;
93
- getBuilderTrades(params: BuilderTradeParams, next_cursor?: string): Promise<{
94
- trades: BuilderTrade[];
95
- next_cursor: string;
96
- limit: number;
97
- count: number;
98
- }>;
84
+ getTradesPaginated(params?: TradeParams, next_cursor?: string): Promise<TradesPaginatedResponse>;
85
+ getBuilderTrades(params: BuilderTradeParams, next_cursor?: string): Promise<BuilderTradesResponse>;
99
86
  getNotifications(): Promise<Notification[]>;
100
87
  dropNotifications(params?: DropNotificationParams): Promise<void>;
101
88
  getBalanceAllowance(params?: BalanceAllowanceParams): Promise<BalanceAllowanceResponse>;
@@ -127,10 +114,9 @@ export declare class ClobClient {
127
114
  private canL2Auth;
128
115
  private isBuilderOrder;
129
116
  private _ensureMarketInfoCached;
117
+ private ensureBuilderFeeRateCached;
130
118
  private _resolveTickSize;
131
119
  private resolveVersion;
132
- private _calculatePlatformFeeRate;
133
- private _calculateFeeAdjustedAmount;
134
120
  private _retryOnVersionUpdate;
135
121
  private _isOrderVersionMismatch;
136
122
  private get;