@polymarket/clob-client 1.0.46 → 1.1.1

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 (73) hide show
  1. package/README.md +5 -12
  2. package/dist/client.d.ts +7 -9
  3. package/dist/client.js +170 -362
  4. package/dist/client.js.map +1 -1
  5. package/dist/constants.d.ts +0 -1
  6. package/dist/constants.js +4 -1
  7. package/dist/constants.js.map +1 -1
  8. package/dist/endpoints.d.ts +1 -3
  9. package/dist/endpoints.js +2 -3
  10. package/dist/endpoints.js.map +1 -1
  11. package/dist/errors.d.ts +0 -1
  12. package/dist/errors.js.map +1 -1
  13. package/dist/headers/index.d.ts +2 -3
  14. package/dist/headers/index.js +33 -85
  15. package/dist/headers/index.js.map +1 -1
  16. package/dist/{http_helpers → http-helpers}/index.d.ts +4 -1
  17. package/dist/http-helpers/index.js +108 -0
  18. package/dist/http-helpers/index.js.map +1 -0
  19. package/dist/index.d.ts +0 -1
  20. package/dist/index.js +4 -13
  21. package/dist/index.js.map +1 -1
  22. package/dist/order-builder/builder.d.ts +6 -10
  23. package/dist/order-builder/builder.js +12 -59
  24. package/dist/order-builder/builder.js.map +1 -1
  25. package/dist/order-builder/helpers.d.ts +13 -9
  26. package/dist/order-builder/helpers.js +83 -327
  27. package/dist/order-builder/helpers.js.map +1 -1
  28. package/dist/order-builder/index.d.ts +0 -2
  29. package/dist/order-builder/index.js +2 -12
  30. package/dist/order-builder/index.js.map +1 -1
  31. package/dist/signing/constants.d.ts +0 -1
  32. package/dist/signing/eip712.d.ts +2 -2
  33. package/dist/signing/eip712.js +29 -74
  34. package/dist/signing/eip712.js.map +1 -1
  35. package/dist/signing/hmac.d.ts +1 -2
  36. package/dist/signing/hmac.js +17 -54
  37. package/dist/signing/hmac.js.map +1 -1
  38. package/dist/signing/index.d.ts +0 -1
  39. package/dist/signing/index.js +3 -12
  40. package/dist/signing/index.js.map +1 -1
  41. package/dist/types.d.ts +55 -51
  42. package/dist/types.js +6 -12
  43. package/dist/types.js.map +1 -1
  44. package/dist/utilities.d.ts +2 -6
  45. package/dist/utilities.js +32 -75
  46. package/dist/utilities.js.map +1 -1
  47. package/package.json +38 -38
  48. package/dist/client.d.ts.map +0 -1
  49. package/dist/constants.d.ts.map +0 -1
  50. package/dist/endpoints.d.ts.map +0 -1
  51. package/dist/errors.d.ts.map +0 -1
  52. package/dist/headers/index.d.ts.map +0 -1
  53. package/dist/http_helpers/index.d.ts.map +0 -1
  54. package/dist/http_helpers/index.js +0 -107
  55. package/dist/http_helpers/index.js.map +0 -1
  56. package/dist/index.d.ts.map +0 -1
  57. package/dist/order-builder/builder.d.ts.map +0 -1
  58. package/dist/order-builder/constants.d.ts +0 -3
  59. package/dist/order-builder/constants.d.ts.map +0 -1
  60. package/dist/order-builder/constants.js +0 -6
  61. package/dist/order-builder/constants.js.map +0 -1
  62. package/dist/order-builder/helpers.d.ts.map +0 -1
  63. package/dist/order-builder/index.d.ts.map +0 -1
  64. package/dist/order-builder/utils.d.ts +0 -4
  65. package/dist/order-builder/utils.d.ts.map +0 -1
  66. package/dist/order-builder/utils.js +0 -50
  67. package/dist/order-builder/utils.js.map +0 -1
  68. package/dist/signing/constants.d.ts.map +0 -1
  69. package/dist/signing/eip712.d.ts.map +0 -1
  70. package/dist/signing/hmac.d.ts.map +0 -1
  71. package/dist/signing/index.d.ts.map +0 -1
  72. package/dist/types.d.ts.map +0 -1
  73. package/dist/utilities.d.ts.map +0 -1
package/README.md CHANGED
@@ -18,28 +18,21 @@ const creds: ApiKeyCreds = {
18
18
  }
19
19
 
20
20
  // Initialize the clob client
21
- // NOTE: the signer must be approved on the LimitOrderProtocol and OrderExecutor contracts
21
+ // NOTE: the signer must be approved on the CTFExchange contract
22
22
  const clobClient = new ClobClient(host, signer, creds);
23
23
 
24
- // Create a limit buy order for 100 YES for 0.50c
25
- const order = await clobClient.createLimitOrder({
24
+ // Create a buy order for 100 YES for 0.50c
25
+ const order = await clobClient.createOrder({
26
26
  tokenId: "16678291189211314787145083999015737376658799626183230671758641503291735614088",
27
27
  price: 0.5,
28
28
  side: Side.Buy,
29
29
  size: 100,
30
+ feeRateBps: "100",
31
+ nonce: 1,
30
32
  });
31
33
 
32
34
  // Send it to the server
33
35
  const resp = await clobClient.postOrder(order);
34
-
35
- // Init a market sell of 100 YES tokens
36
- const marketSell = await clobClient.createMarketOrder({
37
- tokenId: "16678291189211314787145083999015737376658799626183230671758641503291735614088",
38
- side: Side.Sell,
39
- size: 100,
40
- });
41
-
42
- await clobClient.postOrder(marketSell);
43
36
  ```
44
37
 
45
38
  See [examples](examples/) for more information
package/dist/client.d.ts CHANGED
@@ -1,14 +1,15 @@
1
1
  import { Wallet } from "@ethersproject/wallet";
2
2
  import { JsonRpcSigner } from "@ethersproject/providers";
3
- import { SignatureType } from "@polymarket/order-utils";
4
- import { LimitOrderAndSignature, MarketOrderAndSignature, ApiKeyCreds, OrderPayload, UserLimitOrder, UserMarketOrder, OpenOrdersResponse, Order, ApiKeysResponse, FilterParams, TradeHistory, OrderHistory, OptionalParams, MarketOrderHistory } from "./types";
3
+ import { SignatureType, SignedOrder } from "@polymarket/order-utils";
4
+ import { ApiKeyCreds, OrderPayload, UserOrder, OpenOrdersResponse, Order, ApiKeysResponse, FilterParams, OrderHistory, OptionalParams, Chain, TradeParams, Trade } from "./types";
5
5
  import { OrderBuilder } from "./order-builder/builder";
6
6
  export declare class ClobClient {
7
7
  readonly host: string;
8
+ readonly chainId: Chain;
8
9
  readonly signer?: Wallet | JsonRpcSigner;
9
10
  readonly creds?: ApiKeyCreds;
10
11
  readonly orderBuilder: OrderBuilder;
11
- constructor(host: string, signer?: Wallet | JsonRpcSigner, creds?: ApiKeyCreds, signatureType?: SignatureType, funderAddress?: string);
12
+ constructor(host: string, chainId: Chain, signer?: Wallet | JsonRpcSigner, creds?: ApiKeyCreds, signatureType?: SignatureType, funderAddress?: string);
12
13
  getOk(): Promise<any>;
13
14
  getServerTime(): Promise<any>;
14
15
  getOrderBook(tokenID: string): Promise<any>;
@@ -34,15 +35,12 @@ export declare class ClobClient {
34
35
  deleteApiKey(): Promise<any>;
35
36
  getOrder(orderID: string): Promise<Order>;
36
37
  getOrderHistory(params?: FilterParams): Promise<OrderHistory>;
37
- getMarketOrderHistory(params?: FilterParams): Promise<MarketOrderHistory>;
38
- getTradeHistory(params?: FilterParams): Promise<TradeHistory>;
39
- createLimitOrder(userOrder: UserLimitOrder): Promise<LimitOrderAndSignature>;
40
- createMarketOrder(userOrder: UserMarketOrder): Promise<MarketOrderAndSignature>;
38
+ getTrades(params?: TradeParams): Promise<Trade[]>;
39
+ createOrder(userOrder: UserOrder): Promise<SignedOrder>;
41
40
  getOpenOrders(params?: FilterParams): Promise<OpenOrdersResponse>;
42
- postOrder(order: LimitOrderAndSignature | MarketOrderAndSignature, optionalParams?: OptionalParams): Promise<any>;
41
+ postOrder(order: SignedOrder, optionalParams?: OptionalParams): Promise<any>;
43
42
  cancelOrder(payload: OrderPayload): Promise<any>;
44
43
  cancelAll(): Promise<any>;
45
44
  private canL1Auth;
46
45
  private canL2Auth;
47
46
  }
48
- //# sourceMappingURL=client.d.ts.map