@polymarket/clob-client-v2 1.2.0 → 1.3.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.
- package/README.md +24 -3
- package/dist/client.cjs +71 -94
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.cts +7 -0
- package/dist/client.d.ts +7 -0
- package/dist/client.js +72 -95
- package/dist/client.js.map +1 -1
- package/dist/config.cjs +1 -1
- package/dist/config.cjs.map +1 -1
- package/dist/config.js +1 -1
- package/dist/config.js.map +1 -1
- package/dist/errors.cjs +6 -0
- package/dist/errors.cjs.map +1 -1
- package/dist/errors.d.cts +14 -1
- package/dist/errors.d.ts +14 -1
- package/dist/errors.js +6 -1
- package/dist/errors.js.map +1 -1
- package/dist/index.cjs +1 -0
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
> [!
|
|
2
|
-
>
|
|
1
|
+
> [!WARNING]
|
|
2
|
+
> **This package is deprecated.** Please migrate to the unified Polymarket SDK. Follow the [migration guide](https://docs.polymarket.com/migrate/clob-sdk-to-unified-sdk) to get started.
|
|
3
3
|
|
|
4
4
|
# Polymarket CLOB Client V2
|
|
5
5
|
|
|
@@ -131,7 +131,20 @@ const client = new ClobClient({ host, chain: chainId, signer: walletClient, cred
|
|
|
131
131
|
|
|
132
132
|
### Error Handling
|
|
133
133
|
|
|
134
|
-
By default, API errors are returned as `{ error: "...", status: ... }` objects.
|
|
134
|
+
By default, API errors are returned as `{ error: "...", status: ... }` objects. Check a result with `isApiErrorResponse` before using it:
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
import { isApiErrorResponse, Side } from "@polymarket/clob-client-v2";
|
|
138
|
+
|
|
139
|
+
const books = await client.getOrderBooks([{ token_id: tokenID, side: Side.BUY }]);
|
|
140
|
+
if (isApiErrorResponse(books)) {
|
|
141
|
+
console.log(books.status, books.error); // 500 "Internal server error"
|
|
142
|
+
} else {
|
|
143
|
+
books.forEach(book => console.log(book.market));
|
|
144
|
+
}
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
To have the client throw instead, pass `throwOnError: true`:
|
|
135
148
|
|
|
136
149
|
```ts
|
|
137
150
|
import { ApiError, ClobClient } from "@polymarket/clob-client-v2";
|
|
@@ -148,3 +161,11 @@ try {
|
|
|
148
161
|
}
|
|
149
162
|
}
|
|
150
163
|
```
|
|
164
|
+
|
|
165
|
+
Methods that collect every page of a list (`getTrades`, `getOpenOrders`, `getPreMigrationOrders`,
|
|
166
|
+
`getEarningsForUserForDay`, `getUserEarningsAndMarketsConfig`, `getCurrentRewards`,
|
|
167
|
+
`getRawRewardsForMarket`) throw `ApiError` when any page fails, with or without `throwOnError`,
|
|
168
|
+
because a partial list cannot be told apart from a complete one. The market metadata the client
|
|
169
|
+
caches (`getTickSize`, `getNegRisk`, `getFeeRateBps`, builder fee rates, `getClobMarketInfo`) is
|
|
170
|
+
also never cached from a failed response: those lookups throw `ApiError` instead, and so does
|
|
171
|
+
market order pricing when the order book request fails.
|
package/dist/client.cjs
CHANGED
|
@@ -23,6 +23,20 @@ const RESOLVE_TRADES_POLL_INTERVAL_MS = 250;
|
|
|
23
23
|
const FAILED_TRADE_STATUS = "FAILED";
|
|
24
24
|
const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
|
|
25
25
|
const isTradeResolved = (trade) => trade.status.toUpperCase() === FAILED_TRADE_STATUS || Boolean(trade.transaction_hash && trade.transaction_hash.length > 0);
|
|
26
|
+
const toApiError = (result) => {
|
|
27
|
+
return new require_errors.ApiError(typeof result.error === "string" ? result.error : JSON.stringify(result.error), result.status, result);
|
|
28
|
+
};
|
|
29
|
+
const pageItems = (page, endpoint) => {
|
|
30
|
+
if (Array.isArray(page?.data)) return page.data;
|
|
31
|
+
if (require_errors.isApiErrorResponse(page)) throw toApiError(page);
|
|
32
|
+
throw new require_errors.ApiError(`unexpected response from ${endpoint}: expected a page with a data array`, void 0, page);
|
|
33
|
+
};
|
|
34
|
+
const requireFields = (result, endpoint, ...fields) => {
|
|
35
|
+
if (require_errors.isApiErrorResponse(result)) throw toApiError(result);
|
|
36
|
+
const missing = fields.filter((field) => result?.[field] === void 0 || result[field] === null);
|
|
37
|
+
if (missing.length > 0) throw new require_errors.ApiError(`unexpected response from ${endpoint}: missing ${missing.join(", ")}`, void 0, result);
|
|
38
|
+
return result;
|
|
39
|
+
};
|
|
26
40
|
var ClobClient = class {
|
|
27
41
|
host;
|
|
28
42
|
chainId;
|
|
@@ -139,7 +153,8 @@ var ClobClient = class {
|
|
|
139
153
|
}
|
|
140
154
|
async fetchClobMarketInfo(conditionID) {
|
|
141
155
|
const result = await this.get(`${this.host}${require_endpoints.GET_CLOB_MARKET}${conditionID}`);
|
|
142
|
-
if (
|
|
156
|
+
if (require_errors.isApiErrorResponse(result)) throw toApiError(result);
|
|
157
|
+
if (!result?.t) throw new require_errors.ApiError(`failed to fetch market info for condition id ${conditionID}`, void 0, result);
|
|
143
158
|
for (const token of result.t) {
|
|
144
159
|
if (!token) continue;
|
|
145
160
|
const tokenId = token.t;
|
|
@@ -165,7 +180,7 @@ var ClobClient = class {
|
|
|
165
180
|
await this.getClobMarketInfo(this.tokenConditionMap[tokenID]);
|
|
166
181
|
return this.tickSizes[tokenID];
|
|
167
182
|
}
|
|
168
|
-
const result = await this.get(`${this.host}${require_endpoints.GET_TICK_SIZE}`, { params: { token_id: tokenID } });
|
|
183
|
+
const result = requireFields(await this.get(`${this.host}${require_endpoints.GET_TICK_SIZE}`, { params: { token_id: tokenID } }), require_endpoints.GET_TICK_SIZE, "minimum_tick_size");
|
|
169
184
|
this.tickSizes[tokenID] = result.minimum_tick_size.toString();
|
|
170
185
|
return this.tickSizes[tokenID];
|
|
171
186
|
}
|
|
@@ -175,13 +190,13 @@ var ClobClient = class {
|
|
|
175
190
|
await this.getClobMarketInfo(this.tokenConditionMap[tokenID]);
|
|
176
191
|
return this.negRisk[tokenID];
|
|
177
192
|
}
|
|
178
|
-
const result = await this.get(`${this.host}${require_endpoints.GET_NEG_RISK}`, { params: { token_id: tokenID } });
|
|
193
|
+
const result = requireFields(await this.get(`${this.host}${require_endpoints.GET_NEG_RISK}`, { params: { token_id: tokenID } }), require_endpoints.GET_NEG_RISK, "neg_risk");
|
|
179
194
|
this.negRisk[tokenID] = result.neg_risk;
|
|
180
195
|
return this.negRisk[tokenID];
|
|
181
196
|
}
|
|
182
197
|
async getFeeRateBps(tokenID) {
|
|
183
198
|
if (tokenID in this.feeRates) return this.feeRates[tokenID];
|
|
184
|
-
const result = await this.get(`${this.host}${require_endpoints.GET_FEE_RATE}`, { params: { token_id: tokenID } });
|
|
199
|
+
const result = requireFields(await this.get(`${this.host}${require_endpoints.GET_FEE_RATE}`, { params: { token_id: tokenID } }), require_endpoints.GET_FEE_RATE, "base_fee");
|
|
185
200
|
this.feeRates[tokenID] = result.base_fee;
|
|
186
201
|
return this.feeRates[tokenID];
|
|
187
202
|
}
|
|
@@ -352,21 +367,10 @@ var ClobClient = class {
|
|
|
352
367
|
requestPath: endpoint
|
|
353
368
|
};
|
|
354
369
|
const headers = await require_index$1.createL2Headers(this.signer, this.creds, headerArgs, this.useServerTime ? await this.getServerTime() : void 0);
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
...params,
|
|
360
|
-
next_cursor
|
|
361
|
-
};
|
|
362
|
-
const response = await this.get(`${this.host}${endpoint}`, {
|
|
363
|
-
headers,
|
|
364
|
-
params: _params
|
|
365
|
-
});
|
|
366
|
-
next_cursor = response.next_cursor;
|
|
367
|
-
results = [...results, ...response.data];
|
|
368
|
-
}
|
|
369
|
-
return results;
|
|
370
|
+
return this.getAllPages(endpoint, {
|
|
371
|
+
headers,
|
|
372
|
+
params
|
|
373
|
+
}, next_cursor, only_first_page);
|
|
370
374
|
}
|
|
371
375
|
async getTradesPaginated(params, next_cursor) {
|
|
372
376
|
this.canL2Auth();
|
|
@@ -535,21 +539,10 @@ var ClobClient = class {
|
|
|
535
539
|
requestPath: endpoint
|
|
536
540
|
};
|
|
537
541
|
const headers = await require_index$1.createL2Headers(this.signer, this.creds, l2HeaderArgs, this.useServerTime ? await this.getServerTime() : void 0);
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
...params,
|
|
543
|
-
next_cursor
|
|
544
|
-
};
|
|
545
|
-
const response = await this.get(`${this.host}${endpoint}`, {
|
|
546
|
-
headers,
|
|
547
|
-
params: _params
|
|
548
|
-
});
|
|
549
|
-
next_cursor = response.next_cursor;
|
|
550
|
-
results = [...results, ...response.data];
|
|
551
|
-
}
|
|
552
|
-
return results;
|
|
542
|
+
return this.getAllPages(endpoint, {
|
|
543
|
+
headers,
|
|
544
|
+
params
|
|
545
|
+
}, next_cursor, only_first_page);
|
|
553
546
|
}
|
|
554
547
|
async getPreMigrationOrders(only_first_page = false, next_cursor) {
|
|
555
548
|
this.canL2Auth();
|
|
@@ -559,18 +552,7 @@ var ClobClient = class {
|
|
|
559
552
|
requestPath: endpoint
|
|
560
553
|
};
|
|
561
554
|
const headers = await require_index$1.createL2Headers(this.signer, this.creds, l2HeaderArgs, this.useServerTime ? await this.getServerTime() : void 0);
|
|
562
|
-
|
|
563
|
-
next_cursor = next_cursor || require_constants.INITIAL_CURSOR;
|
|
564
|
-
while (next_cursor !== require_constants.END_CURSOR && (next_cursor === require_constants.INITIAL_CURSOR || !only_first_page)) {
|
|
565
|
-
const _params = { next_cursor };
|
|
566
|
-
const response = await this.get(`${this.host}${endpoint}`, {
|
|
567
|
-
headers,
|
|
568
|
-
params: _params
|
|
569
|
-
});
|
|
570
|
-
next_cursor = response.next_cursor;
|
|
571
|
-
results = [...results, ...response.data];
|
|
572
|
-
}
|
|
573
|
-
return results;
|
|
555
|
+
return this.getAllPages(endpoint, { headers }, next_cursor, only_first_page);
|
|
574
556
|
}
|
|
575
557
|
/**
|
|
576
558
|
* Posts an order to the CLOB.
|
|
@@ -738,22 +720,13 @@ var ClobClient = class {
|
|
|
738
720
|
requestPath: endpoint
|
|
739
721
|
};
|
|
740
722
|
const headers = await require_index$1.createL2Headers(this.signer, this.creds, headerArgs, this.useServerTime ? await this.getServerTime() : void 0);
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
const params = {
|
|
723
|
+
return this.getAllPages(endpoint, {
|
|
724
|
+
headers,
|
|
725
|
+
params: {
|
|
745
726
|
date,
|
|
746
|
-
signature_type: this.orderBuilder.signatureType
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
const response = await this.get(`${this.host}${endpoint}`, {
|
|
750
|
-
headers,
|
|
751
|
-
params
|
|
752
|
-
});
|
|
753
|
-
next_cursor = response.next_cursor;
|
|
754
|
-
results = [...results, ...response.data];
|
|
755
|
-
}
|
|
756
|
-
return results;
|
|
727
|
+
signature_type: this.orderBuilder.signatureType
|
|
728
|
+
}
|
|
729
|
+
});
|
|
757
730
|
}
|
|
758
731
|
async getTotalEarningsForUserForDay(date) {
|
|
759
732
|
this.canL2Auth();
|
|
@@ -780,25 +753,16 @@ var ClobClient = class {
|
|
|
780
753
|
requestPath: endpoint
|
|
781
754
|
};
|
|
782
755
|
const headers = await require_index$1.createL2Headers(this.signer, this.creds, headerArgs, this.useServerTime ? await this.getServerTime() : void 0);
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
const params = {
|
|
756
|
+
return this.getAllPages(endpoint, {
|
|
757
|
+
headers,
|
|
758
|
+
params: {
|
|
787
759
|
date,
|
|
788
760
|
signature_type: this.orderBuilder.signatureType,
|
|
789
|
-
next_cursor,
|
|
790
761
|
order_by,
|
|
791
762
|
position,
|
|
792
763
|
no_competition
|
|
793
|
-
}
|
|
794
|
-
|
|
795
|
-
headers,
|
|
796
|
-
params
|
|
797
|
-
});
|
|
798
|
-
next_cursor = response.next_cursor;
|
|
799
|
-
results = [...results, ...response.data];
|
|
800
|
-
}
|
|
801
|
-
return results;
|
|
764
|
+
}
|
|
765
|
+
});
|
|
802
766
|
}
|
|
803
767
|
async getRewardPercentages() {
|
|
804
768
|
this.canL2Auth();
|
|
@@ -815,27 +779,14 @@ var ClobClient = class {
|
|
|
815
779
|
});
|
|
816
780
|
}
|
|
817
781
|
async getCurrentRewards() {
|
|
818
|
-
|
|
819
|
-
let next_cursor = require_constants.INITIAL_CURSOR;
|
|
820
|
-
while (next_cursor !== require_constants.END_CURSOR) {
|
|
821
|
-
const response = await this.get(`${this.host}${require_endpoints.GET_REWARDS_MARKETS_CURRENT}`, { params: { next_cursor } });
|
|
822
|
-
next_cursor = response.next_cursor;
|
|
823
|
-
results = [...results, ...response.data];
|
|
824
|
-
}
|
|
825
|
-
return results;
|
|
782
|
+
return this.getAllPages(require_endpoints.GET_REWARDS_MARKETS_CURRENT);
|
|
826
783
|
}
|
|
827
784
|
async getRawRewardsForMarket(conditionId) {
|
|
828
|
-
|
|
829
|
-
let next_cursor = require_constants.INITIAL_CURSOR;
|
|
830
|
-
while (next_cursor !== require_constants.END_CURSOR) {
|
|
831
|
-
const response = await this.get(`${this.host}${require_endpoints.GET_REWARDS_MARKETS}${conditionId}`, { params: { next_cursor } });
|
|
832
|
-
next_cursor = response.next_cursor;
|
|
833
|
-
results = [...results, ...response.data];
|
|
834
|
-
}
|
|
835
|
-
return results;
|
|
785
|
+
return this.getAllPages(`${require_endpoints.GET_REWARDS_MARKETS}${conditionId}`);
|
|
836
786
|
}
|
|
837
787
|
async calculateMarketPrice(tokenID, side, amount, orderType = require_clob.OrderType.FOK) {
|
|
838
788
|
const book = await this.getOrderBook(tokenID);
|
|
789
|
+
if (require_errors.isApiErrorResponse(book)) throw toApiError(book);
|
|
839
790
|
if (!book) throw new Error("no orderbook");
|
|
840
791
|
if (side === require_side.Side.BUY) {
|
|
841
792
|
if (!book.asks) throw new Error("no match");
|
|
@@ -902,7 +853,8 @@ var ClobClient = class {
|
|
|
902
853
|
if (tokenID in this.feeInfos) return;
|
|
903
854
|
if (!(tokenID in this.tokenConditionMap)) {
|
|
904
855
|
const result = await this.get(`${this.host}${require_endpoints.GET_MARKET_BY_TOKEN}${tokenID}`);
|
|
905
|
-
if (
|
|
856
|
+
if (require_errors.isApiErrorResponse(result)) throw toApiError(result);
|
|
857
|
+
if (!result?.condition_id) throw new require_errors.ApiError(`failed to resolve condition id for token ${tokenID}`, void 0, result);
|
|
906
858
|
this.tokenConditionMap[tokenID] = result.condition_id;
|
|
907
859
|
}
|
|
908
860
|
if (tokenID in this.feeInfos) return;
|
|
@@ -911,7 +863,8 @@ var ClobClient = class {
|
|
|
911
863
|
async ensureBuilderFeeRateCached(builderCode) {
|
|
912
864
|
if (!builderCode || builderCode === require_constants.bytes32Zero) return;
|
|
913
865
|
if (builderCode in this.builderFeeRates) return;
|
|
914
|
-
const
|
|
866
|
+
const endpoint = `${require_endpoints.GET_BUILDER_FEES}${builderCode}`;
|
|
867
|
+
const result = requireFields(await this.get(`${this.host}${endpoint}`), endpoint, "builder_maker_fee_rate_bps", "builder_taker_fee_rate_bps");
|
|
915
868
|
this.builderFeeRates[builderCode] = {
|
|
916
869
|
maker: result.builder_maker_fee_rate_bps / require_constants.BUILDER_FEES_BPS,
|
|
917
870
|
taker: result.builder_taker_fee_rate_bps / require_constants.BUILDER_FEES_BPS
|
|
@@ -950,9 +903,33 @@ var ClobClient = class {
|
|
|
950
903
|
return (typeof error === "string" ? error : JSON.stringify(error)).includes(require_constants.ORDER_VERSION_MISMATCH_ERROR);
|
|
951
904
|
}
|
|
952
905
|
throwIfError(result) {
|
|
953
|
-
if (this.throwOnError &&
|
|
906
|
+
if (this.throwOnError && require_errors.isApiErrorResponse(result)) throw toApiError(result);
|
|
954
907
|
return result;
|
|
955
908
|
}
|
|
909
|
+
/**
|
|
910
|
+
* Collects the items of a cursor-paginated GET endpoint, starting at `cursor` and
|
|
911
|
+
* following `next_cursor` until the server returns END_CURSOR. With `onlyFirstPage`
|
|
912
|
+
* it fetches the page at `cursor` alone. A failed page rejects with ApiError whatever
|
|
913
|
+
* `throwOnError` is, since a partial list cannot be told apart from a complete one.
|
|
914
|
+
*/
|
|
915
|
+
async getAllPages(endpoint, options = {}, cursor, onlyFirstPage = false) {
|
|
916
|
+
const items = [];
|
|
917
|
+
let nextCursor = cursor || require_constants.INITIAL_CURSOR;
|
|
918
|
+
while (nextCursor !== require_constants.END_CURSOR) {
|
|
919
|
+
const page = await this.get(`${this.host}${endpoint}`, {
|
|
920
|
+
...options,
|
|
921
|
+
params: {
|
|
922
|
+
...options.params,
|
|
923
|
+
next_cursor: nextCursor
|
|
924
|
+
}
|
|
925
|
+
});
|
|
926
|
+
items.push(...pageItems(page, endpoint));
|
|
927
|
+
if (onlyFirstPage) break;
|
|
928
|
+
if (typeof page.next_cursor !== "string" || page.next_cursor.length === 0) throw new require_errors.ApiError(`unexpected response from ${endpoint}: expected a non-empty next_cursor string`, void 0, page);
|
|
929
|
+
nextCursor = page.next_cursor;
|
|
930
|
+
}
|
|
931
|
+
return items;
|
|
932
|
+
}
|
|
956
933
|
async get(endpoint, options, skipThrow = false) {
|
|
957
934
|
const result = await require_index$2.get(endpoint, options);
|
|
958
935
|
return skipThrow ? result : this.throwIfError(result);
|