pmxtjs 2.26.2 → 2.27.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 (138) hide show
  1. package/dist/esm/generated/src/apis/DefaultApi.d.ts +266 -106
  2. package/dist/esm/generated/src/apis/DefaultApi.js +346 -61
  3. package/dist/esm/generated/src/models/index.d.ts +0 -19
  4. package/dist/esm/generated/src/models/index.js +0 -19
  5. package/dist/esm/pmxt/client.d.ts +59 -4
  6. package/dist/esm/pmxt/client.js +181 -195
  7. package/dist/esm/pmxt/constants.d.ts +53 -0
  8. package/dist/esm/pmxt/constants.js +60 -0
  9. package/dist/generated/src/apis/DefaultApi.d.ts +266 -106
  10. package/dist/generated/src/apis/DefaultApi.js +346 -61
  11. package/dist/generated/src/models/index.d.ts +0 -19
  12. package/dist/generated/src/models/index.js +0 -19
  13. package/dist/pmxt/client.d.ts +59 -4
  14. package/dist/pmxt/client.js +181 -195
  15. package/dist/pmxt/constants.d.ts +53 -0
  16. package/dist/pmxt/constants.js +64 -0
  17. package/generated/.openapi-generator/FILES +0 -38
  18. package/generated/docs/DefaultApi.md +276 -120
  19. package/generated/package.json +1 -1
  20. package/generated/src/apis/DefaultApi.ts +590 -210
  21. package/generated/src/models/index.ts +0 -19
  22. package/package.json +2 -2
  23. package/pmxt/client.ts +223 -208
  24. package/pmxt/constants.ts +67 -0
  25. package/dist/esm/generated/src/models/FetchAllOrdersRequest.d.ts +0 -40
  26. package/dist/esm/generated/src/models/FetchAllOrdersRequest.js +0 -45
  27. package/dist/esm/generated/src/models/FetchBalanceRequest.d.ts +0 -39
  28. package/dist/esm/generated/src/models/FetchBalanceRequest.js +0 -44
  29. package/dist/esm/generated/src/models/FetchClosedOrdersRequest.d.ts +0 -40
  30. package/dist/esm/generated/src/models/FetchClosedOrdersRequest.js +0 -45
  31. package/dist/esm/generated/src/models/FetchEventRequest.d.ts +0 -40
  32. package/dist/esm/generated/src/models/FetchEventRequest.js +0 -45
  33. package/dist/esm/generated/src/models/FetchEventsRequest.d.ts +0 -40
  34. package/dist/esm/generated/src/models/FetchEventsRequest.js +0 -45
  35. package/dist/esm/generated/src/models/FetchMarketRequest.d.ts +0 -40
  36. package/dist/esm/generated/src/models/FetchMarketRequest.js +0 -45
  37. package/dist/esm/generated/src/models/FetchMarketsPaginatedRequest.d.ts +0 -40
  38. package/dist/esm/generated/src/models/FetchMarketsPaginatedRequest.js +0 -45
  39. package/dist/esm/generated/src/models/FetchMarketsPaginatedRequestArgsInner.d.ts +0 -38
  40. package/dist/esm/generated/src/models/FetchMarketsPaginatedRequestArgsInner.js +0 -43
  41. package/dist/esm/generated/src/models/FetchMarketsRequest.d.ts +0 -40
  42. package/dist/esm/generated/src/models/FetchMarketsRequest.js +0 -45
  43. package/dist/esm/generated/src/models/FetchMyTradesRequest.d.ts +0 -40
  44. package/dist/esm/generated/src/models/FetchMyTradesRequest.js +0 -45
  45. package/dist/esm/generated/src/models/FetchOHLCVRequest.d.ts +0 -40
  46. package/dist/esm/generated/src/models/FetchOHLCVRequest.js +0 -47
  47. package/dist/esm/generated/src/models/FetchOHLCVRequestArgsInner.d.ts +0 -22
  48. package/dist/esm/generated/src/models/FetchOHLCVRequestArgsInner.js +0 -50
  49. package/dist/esm/generated/src/models/FetchOpenOrdersRequest.d.ts +0 -39
  50. package/dist/esm/generated/src/models/FetchOpenOrdersRequest.js +0 -44
  51. package/dist/esm/generated/src/models/FetchOrderBookRequest.d.ts +0 -39
  52. package/dist/esm/generated/src/models/FetchOrderBookRequest.js +0 -46
  53. package/dist/esm/generated/src/models/FetchOrderRequest.d.ts +0 -39
  54. package/dist/esm/generated/src/models/FetchOrderRequest.js +0 -46
  55. package/dist/esm/generated/src/models/FetchPositionsRequest.d.ts +0 -39
  56. package/dist/esm/generated/src/models/FetchPositionsRequest.js +0 -44
  57. package/dist/esm/generated/src/models/FetchTradesRequest.d.ts +0 -40
  58. package/dist/esm/generated/src/models/FetchTradesRequest.js +0 -47
  59. package/dist/esm/generated/src/models/FetchTradesRequestArgsInner.d.ts +0 -22
  60. package/dist/esm/generated/src/models/FetchTradesRequestArgsInner.js +0 -50
  61. package/dist/esm/generated/src/models/FetchTradesRequestArgsInnerOneOf.d.ts +0 -24
  62. package/dist/esm/generated/src/models/FetchTradesRequestArgsInnerOneOf.js +0 -54
  63. package/dist/generated/src/models/FetchAllOrdersRequest.d.ts +0 -40
  64. package/dist/generated/src/models/FetchAllOrdersRequest.js +0 -52
  65. package/dist/generated/src/models/FetchBalanceRequest.d.ts +0 -39
  66. package/dist/generated/src/models/FetchBalanceRequest.js +0 -51
  67. package/dist/generated/src/models/FetchClosedOrdersRequest.d.ts +0 -40
  68. package/dist/generated/src/models/FetchClosedOrdersRequest.js +0 -52
  69. package/dist/generated/src/models/FetchEventRequest.d.ts +0 -40
  70. package/dist/generated/src/models/FetchEventRequest.js +0 -52
  71. package/dist/generated/src/models/FetchEventsRequest.d.ts +0 -40
  72. package/dist/generated/src/models/FetchEventsRequest.js +0 -52
  73. package/dist/generated/src/models/FetchMarketRequest.d.ts +0 -40
  74. package/dist/generated/src/models/FetchMarketRequest.js +0 -52
  75. package/dist/generated/src/models/FetchMarketsPaginatedRequest.d.ts +0 -40
  76. package/dist/generated/src/models/FetchMarketsPaginatedRequest.js +0 -52
  77. package/dist/generated/src/models/FetchMarketsPaginatedRequestArgsInner.d.ts +0 -38
  78. package/dist/generated/src/models/FetchMarketsPaginatedRequestArgsInner.js +0 -50
  79. package/dist/generated/src/models/FetchMarketsRequest.d.ts +0 -40
  80. package/dist/generated/src/models/FetchMarketsRequest.js +0 -52
  81. package/dist/generated/src/models/FetchMyTradesRequest.d.ts +0 -40
  82. package/dist/generated/src/models/FetchMyTradesRequest.js +0 -52
  83. package/dist/generated/src/models/FetchOHLCVRequest.d.ts +0 -40
  84. package/dist/generated/src/models/FetchOHLCVRequest.js +0 -54
  85. package/dist/generated/src/models/FetchOHLCVRequestArgsInner.d.ts +0 -22
  86. package/dist/generated/src/models/FetchOHLCVRequestArgsInner.js +0 -56
  87. package/dist/generated/src/models/FetchOpenOrdersRequest.d.ts +0 -39
  88. package/dist/generated/src/models/FetchOpenOrdersRequest.js +0 -51
  89. package/dist/generated/src/models/FetchOrderBookRequest.d.ts +0 -39
  90. package/dist/generated/src/models/FetchOrderBookRequest.js +0 -53
  91. package/dist/generated/src/models/FetchOrderRequest.d.ts +0 -39
  92. package/dist/generated/src/models/FetchOrderRequest.js +0 -53
  93. package/dist/generated/src/models/FetchPositionsRequest.d.ts +0 -39
  94. package/dist/generated/src/models/FetchPositionsRequest.js +0 -51
  95. package/dist/generated/src/models/FetchTradesRequest.d.ts +0 -40
  96. package/dist/generated/src/models/FetchTradesRequest.js +0 -54
  97. package/dist/generated/src/models/FetchTradesRequestArgsInner.d.ts +0 -22
  98. package/dist/generated/src/models/FetchTradesRequestArgsInner.js +0 -56
  99. package/dist/generated/src/models/FetchTradesRequestArgsInnerOneOf.d.ts +0 -24
  100. package/dist/generated/src/models/FetchTradesRequestArgsInnerOneOf.js +0 -61
  101. package/generated/docs/FetchAllOrdersRequest.md +0 -36
  102. package/generated/docs/FetchBalanceRequest.md +0 -36
  103. package/generated/docs/FetchClosedOrdersRequest.md +0 -36
  104. package/generated/docs/FetchEventRequest.md +0 -36
  105. package/generated/docs/FetchEventsRequest.md +0 -36
  106. package/generated/docs/FetchMarketRequest.md +0 -36
  107. package/generated/docs/FetchMarketsPaginatedRequest.md +0 -36
  108. package/generated/docs/FetchMarketsPaginatedRequestArgsInner.md +0 -36
  109. package/generated/docs/FetchMarketsRequest.md +0 -36
  110. package/generated/docs/FetchMyTradesRequest.md +0 -36
  111. package/generated/docs/FetchOHLCVRequest.md +0 -36
  112. package/generated/docs/FetchOHLCVRequestArgsInner.md +0 -40
  113. package/generated/docs/FetchOpenOrdersRequest.md +0 -36
  114. package/generated/docs/FetchOrderBookRequest.md +0 -36
  115. package/generated/docs/FetchOrderRequest.md +0 -36
  116. package/generated/docs/FetchPositionsRequest.md +0 -36
  117. package/generated/docs/FetchTradesRequest.md +0 -36
  118. package/generated/docs/FetchTradesRequestArgsInner.md +0 -40
  119. package/generated/docs/FetchTradesRequestArgsInnerOneOf.md +0 -40
  120. package/generated/src/models/FetchAllOrdersRequest.ts +0 -88
  121. package/generated/src/models/FetchBalanceRequest.ts +0 -81
  122. package/generated/src/models/FetchClosedOrdersRequest.ts +0 -88
  123. package/generated/src/models/FetchEventRequest.ts +0 -88
  124. package/generated/src/models/FetchEventsRequest.ts +0 -88
  125. package/generated/src/models/FetchMarketRequest.ts +0 -88
  126. package/generated/src/models/FetchMarketsPaginatedRequest.ts +0 -88
  127. package/generated/src/models/FetchMarketsPaginatedRequestArgsInner.ts +0 -73
  128. package/generated/src/models/FetchMarketsRequest.ts +0 -88
  129. package/generated/src/models/FetchMyTradesRequest.ts +0 -88
  130. package/generated/src/models/FetchOHLCVRequest.ts +0 -89
  131. package/generated/src/models/FetchOHLCVRequestArgsInner.ts +0 -69
  132. package/generated/src/models/FetchOpenOrdersRequest.ts +0 -81
  133. package/generated/src/models/FetchOrderBookRequest.ts +0 -82
  134. package/generated/src/models/FetchOrderRequest.ts +0 -82
  135. package/generated/src/models/FetchPositionsRequest.ts +0 -81
  136. package/generated/src/models/FetchTradesRequest.ts +0 -89
  137. package/generated/src/models/FetchTradesRequestArgsInner.ts +0 -69
  138. package/generated/src/models/FetchTradesRequestArgsInnerOneOf.ts +0 -80
@@ -16,37 +16,18 @@ export * from './EventFetchParams';
16
16
  export * from './ExchangeCredentials';
17
17
  export * from './ExchangeCredentialsSignatureType';
18
18
  export * from './ExecutionPriceResult';
19
- export * from './FetchAllOrdersRequest';
20
19
  export * from './FetchBalance200Response';
21
- export * from './FetchBalanceRequest';
22
- export * from './FetchClosedOrdersRequest';
23
20
  export * from './FetchEvent200Response';
24
- export * from './FetchEventRequest';
25
21
  export * from './FetchEvents200Response';
26
- export * from './FetchEventsRequest';
27
22
  export * from './FetchMarket200Response';
28
- export * from './FetchMarketRequest';
29
23
  export * from './FetchMarkets200Response';
30
24
  export * from './FetchMarketsPaginated200Response';
31
- export * from './FetchMarketsPaginatedRequest';
32
- export * from './FetchMarketsPaginatedRequestArgsInner';
33
- export * from './FetchMarketsRequest';
34
25
  export * from './FetchMyTrades200Response';
35
- export * from './FetchMyTradesRequest';
36
26
  export * from './FetchOHLCV200Response';
37
- export * from './FetchOHLCVRequest';
38
- export * from './FetchOHLCVRequestArgsInner';
39
27
  export * from './FetchOpenOrders200Response';
40
- export * from './FetchOpenOrdersRequest';
41
28
  export * from './FetchOrderBook200Response';
42
- export * from './FetchOrderBookRequest';
43
- export * from './FetchOrderRequest';
44
29
  export * from './FetchPositions200Response';
45
- export * from './FetchPositionsRequest';
46
30
  export * from './FetchTrades200Response';
47
- export * from './FetchTradesRequest';
48
- export * from './FetchTradesRequestArgsInner';
49
- export * from './FetchTradesRequestArgsInnerOneOf';
50
31
  export * from './FilterEventsRequest';
51
32
  export * from './FilterEventsRequestArgsInner';
52
33
  export * from './FilterMarketsRequest';
@@ -34,37 +34,18 @@ __exportStar(require("./EventFetchParams"), exports);
34
34
  __exportStar(require("./ExchangeCredentials"), exports);
35
35
  __exportStar(require("./ExchangeCredentialsSignatureType"), exports);
36
36
  __exportStar(require("./ExecutionPriceResult"), exports);
37
- __exportStar(require("./FetchAllOrdersRequest"), exports);
38
37
  __exportStar(require("./FetchBalance200Response"), exports);
39
- __exportStar(require("./FetchBalanceRequest"), exports);
40
- __exportStar(require("./FetchClosedOrdersRequest"), exports);
41
38
  __exportStar(require("./FetchEvent200Response"), exports);
42
- __exportStar(require("./FetchEventRequest"), exports);
43
39
  __exportStar(require("./FetchEvents200Response"), exports);
44
- __exportStar(require("./FetchEventsRequest"), exports);
45
40
  __exportStar(require("./FetchMarket200Response"), exports);
46
- __exportStar(require("./FetchMarketRequest"), exports);
47
41
  __exportStar(require("./FetchMarkets200Response"), exports);
48
42
  __exportStar(require("./FetchMarketsPaginated200Response"), exports);
49
- __exportStar(require("./FetchMarketsPaginatedRequest"), exports);
50
- __exportStar(require("./FetchMarketsPaginatedRequestArgsInner"), exports);
51
- __exportStar(require("./FetchMarketsRequest"), exports);
52
43
  __exportStar(require("./FetchMyTrades200Response"), exports);
53
- __exportStar(require("./FetchMyTradesRequest"), exports);
54
44
  __exportStar(require("./FetchOHLCV200Response"), exports);
55
- __exportStar(require("./FetchOHLCVRequest"), exports);
56
- __exportStar(require("./FetchOHLCVRequestArgsInner"), exports);
57
45
  __exportStar(require("./FetchOpenOrders200Response"), exports);
58
- __exportStar(require("./FetchOpenOrdersRequest"), exports);
59
46
  __exportStar(require("./FetchOrderBook200Response"), exports);
60
- __exportStar(require("./FetchOrderBookRequest"), exports);
61
- __exportStar(require("./FetchOrderRequest"), exports);
62
47
  __exportStar(require("./FetchPositions200Response"), exports);
63
- __exportStar(require("./FetchPositionsRequest"), exports);
64
48
  __exportStar(require("./FetchTrades200Response"), exports);
65
- __exportStar(require("./FetchTradesRequest"), exports);
66
- __exportStar(require("./FetchTradesRequestArgsInner"), exports);
67
- __exportStar(require("./FetchTradesRequestArgsInnerOneOf"), exports);
68
49
  __exportStar(require("./FilterEventsRequest"), exports);
69
50
  __exportStar(require("./FilterEventsRequestArgsInner"), exports);
70
51
  __exportStar(require("./FilterMarketsRequest"), exports);
@@ -11,13 +11,39 @@ import { ServerManager } from "./server-manager.js";
11
11
  * Base exchange client options.
12
12
  */
13
13
  export interface ExchangeOptions {
14
- /** API key for authentication (optional) */
14
+ /** Venue-specific API key (e.g. Polymarket CLOB key). Optional. */
15
15
  apiKey?: string;
16
- /** Private key for authentication (optional) */
16
+ /** Venue-specific private key. Optional. */
17
17
  privateKey?: string;
18
- /** Base URL of the PMXT sidecar server */
18
+ /**
19
+ * Hosted pmxt API key.
20
+ *
21
+ * When set (either as this kwarg or via the `PMXT_API_KEY` env
22
+ * variable), and no explicit `baseUrl` / `PMXT_BASE_URL` is set,
23
+ * the Exchange will default to the hosted pmxt endpoint
24
+ * (`https://api.pmxt.dev`) instead of the local sidecar, and send
25
+ * `Authorization: Bearer <pmxtApiKey>` on every request.
26
+ *
27
+ * The local sidecar ignores this header, so it is safe to set in
28
+ * both local and hosted modes.
29
+ */
30
+ pmxtApiKey?: string;
31
+ /**
32
+ * Base URL of the pmxt server.
33
+ *
34
+ * Resolution precedence:
35
+ * 1. Explicit `baseUrl` kwarg.
36
+ * 2. `PMXT_BASE_URL` environment variable.
37
+ * 3. `HOSTED_URL` when `pmxtApiKey` (kwarg or env) is present.
38
+ * 4. Local sidecar (`http://localhost:3847`).
39
+ */
19
40
  baseUrl?: string;
20
- /** Automatically start server if not running (default: true) */
41
+ /**
42
+ * Automatically start the local sidecar if it is not running.
43
+ *
44
+ * Default: `true` when the resolved base URL is the local sidecar,
45
+ * `false` otherwise. Explicit `true` / `false` always wins.
46
+ */
21
47
  autoStartServer?: boolean;
22
48
  /** Optional Polymarket Proxy/Smart Wallet address */
23
49
  proxyAddress?: string;
@@ -34,12 +60,21 @@ export declare abstract class Exchange {
34
60
  protected exchangeName: string;
35
61
  protected apiKey?: string;
36
62
  protected privateKey?: string;
63
+ protected pmxtApiKey?: string;
37
64
  protected proxyAddress?: string;
38
65
  protected signatureType?: number;
39
66
  protected api: DefaultApi;
40
67
  protected config: Configuration;
41
68
  protected serverManager: ServerManager;
42
69
  protected initPromise: Promise<void>;
70
+ protected isHosted: boolean;
71
+ /**
72
+ * Sticky flag: set to `true` the first time a GET read is rejected by
73
+ * the sidecar with 404/405 (i.e. an older pmxt-core that only supports
74
+ * POST). While false, read methods try GET first; once flipped they
75
+ * POST directly and skip the GET probe for the lifetime of this client.
76
+ */
77
+ private _getReadsUnsupported;
43
78
  constructor(exchangeName: string, options?: ExchangeOptions);
44
79
  private initializeServer;
45
80
  protected handleResponse(response: any): any;
@@ -61,6 +96,26 @@ export declare abstract class Exchange {
61
96
  * ```
62
97
  */
63
98
  callApi(operationId: string, params?: Record<string, any>): Promise<any>;
99
+ /**
100
+ * Dispatch a sidecar read method, preferring GET but transparently
101
+ * falling back to POST for full backward compatibility.
102
+ *
103
+ * GET is used when:
104
+ * - the client has no per-instance credentials (the sidecar's GET
105
+ * handler intentionally drops credentials to avoid leaking them
106
+ * through query strings and access logs), and
107
+ * - the sidecar hasn't already returned 404/405 for a previous GET
108
+ * in this client's lifetime (`_getReadsUnsupported`), and
109
+ * - the query has no nested objects (query strings can't round-trip
110
+ * arbitrary JSON).
111
+ *
112
+ * Otherwise (or if the GET attempt is rejected with 404/405) the call
113
+ * is sent as POST with the original `{args, credentials}` body so that
114
+ * SDK users talking to an older pmxt-core continue to work unchanged.
115
+ *
116
+ * @internal — shared transport used by every generated read method.
117
+ */
118
+ protected sidecarReadRequest(methodName: string, query: Record<string, unknown>, args: unknown[]): Promise<any>;
64
119
  loadMarkets(reload?: boolean): Promise<Record<string, UnifiedMarket>>;
65
120
  fetchMarkets(params?: any): Promise<UnifiedMarket[]>;
66
121
  fetchMarketsPaginated(params?: any): Promise<PaginatedMarketsResult>;