pmxtjs 0.0.1 → 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.
- package/API_REFERENCE.md +88 -0
- package/coverage/clover.xml +334 -0
- package/coverage/coverage-final.json +4 -0
- package/coverage/lcov-report/base.css +224 -0
- package/coverage/lcov-report/block-navigation.js +87 -0
- package/coverage/lcov-report/favicon.png +0 -0
- package/coverage/lcov-report/index.html +131 -0
- package/coverage/lcov-report/pmxt/BaseExchange.ts.html +256 -0
- package/coverage/lcov-report/pmxt/exchanges/Kalshi.ts.html +1132 -0
- package/coverage/lcov-report/pmxt/exchanges/Polymarket.ts.html +1456 -0
- package/coverage/lcov-report/pmxt/exchanges/index.html +131 -0
- package/coverage/lcov-report/pmxt/index.html +116 -0
- package/coverage/lcov-report/prettify.css +1 -0
- package/coverage/lcov-report/prettify.js +2 -0
- package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
- package/coverage/lcov-report/sorter.js +210 -0
- package/coverage/lcov-report/src/BaseExchange.ts.html +256 -0
- package/coverage/lcov-report/src/exchanges/Kalshi.ts.html +1132 -0
- package/coverage/lcov-report/src/exchanges/Polymarket.ts.html +1456 -0
- package/coverage/lcov-report/src/exchanges/index.html +131 -0
- package/coverage/lcov-report/src/index.html +116 -0
- package/coverage/lcov.info +766 -0
- package/examples/get_event_prices.ts +37 -0
- package/examples/historical_prices.ts +117 -0
- package/examples/orderbook.ts +102 -0
- package/examples/recent_trades.ts +29 -0
- package/examples/search_events.ts +68 -0
- package/examples/search_market.ts +29 -0
- package/jest.config.js +11 -0
- package/package.json +21 -21
- package/pmxt-0.1.0.tgz +0 -0
- package/src/BaseExchange.ts +57 -0
- package/src/exchanges/Kalshi.ts +349 -0
- package/src/exchanges/Polymarket.ts +457 -0
- package/src/index.ts +5 -0
- package/src/types.ts +61 -0
- package/test/exchanges/kalshi/ApiErrors.test.ts +132 -0
- package/test/exchanges/kalshi/EmptyResponse.test.ts +44 -0
- package/test/exchanges/kalshi/FetchAndNormalizeMarkets.test.ts +56 -0
- package/test/exchanges/kalshi/LiveApi.integration.test.ts +40 -0
- package/test/exchanges/kalshi/MarketHistory.test.ts +185 -0
- package/test/exchanges/kalshi/OrderBook.test.ts +149 -0
- package/test/exchanges/kalshi/SearchMarkets.test.ts +174 -0
- package/test/exchanges/kalshi/VolumeFallback.test.ts +44 -0
- package/test/exchanges/polymarket/DataValidation.test.ts +271 -0
- package/test/exchanges/polymarket/ErrorHandling.test.ts +34 -0
- package/test/exchanges/polymarket/FetchAndNormalizeMarkets.test.ts +68 -0
- package/test/exchanges/polymarket/GetMarketsBySlug.test.ts +268 -0
- package/test/exchanges/polymarket/LiveApi.integration.test.ts +44 -0
- package/test/exchanges/polymarket/MarketHistory.test.ts +207 -0
- package/test/exchanges/polymarket/OrderBook.test.ts +167 -0
- package/test/exchanges/polymarket/RequestParameters.test.ts +39 -0
- package/test/exchanges/polymarket/SearchMarkets.test.ts +176 -0
- package/test/exchanges/polymarket/TradeHistory.test.ts +248 -0
- package/tsconfig.json +12 -0
- package/Cargo.toml +0 -15
- package/README.md +0 -47
- package/src/lib.rs +0 -6
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
|
|
2
|
+
<!doctype html>
|
|
3
|
+
<html lang="en">
|
|
4
|
+
|
|
5
|
+
<head>
|
|
6
|
+
<title>Code coverage report for src/BaseExchange.ts</title>
|
|
7
|
+
<meta charset="utf-8" />
|
|
8
|
+
<link rel="stylesheet" href="../prettify.css" />
|
|
9
|
+
<link rel="stylesheet" href="../base.css" />
|
|
10
|
+
<link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
|
|
11
|
+
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
12
|
+
<style type='text/css'>
|
|
13
|
+
.coverage-summary .sorter {
|
|
14
|
+
background-image: url(../sort-arrow-sprite.png);
|
|
15
|
+
}
|
|
16
|
+
</style>
|
|
17
|
+
</head>
|
|
18
|
+
|
|
19
|
+
<body>
|
|
20
|
+
<div class='wrapper'>
|
|
21
|
+
<div class='pad1'>
|
|
22
|
+
<h1><a href="../index.html">All files</a> / <a href="index.html">src</a> BaseExchange.ts</h1>
|
|
23
|
+
<div class='clearfix'>
|
|
24
|
+
|
|
25
|
+
<div class='fl pad1y space-right2'>
|
|
26
|
+
<span class="strong">25% </span>
|
|
27
|
+
<span class="quiet">Statements</span>
|
|
28
|
+
<span class='fraction'>1/4</span>
|
|
29
|
+
</div>
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
<div class='fl pad1y space-right2'>
|
|
33
|
+
<span class="strong">100% </span>
|
|
34
|
+
<span class="quiet">Branches</span>
|
|
35
|
+
<span class='fraction'>0/0</span>
|
|
36
|
+
</div>
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
<div class='fl pad1y space-right2'>
|
|
40
|
+
<span class="strong">0% </span>
|
|
41
|
+
<span class="quiet">Functions</span>
|
|
42
|
+
<span class='fraction'>0/3</span>
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div class='fl pad1y space-right2'>
|
|
47
|
+
<span class="strong">25% </span>
|
|
48
|
+
<span class="quiet">Lines</span>
|
|
49
|
+
<span class='fraction'>1/4</span>
|
|
50
|
+
</div>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
</div>
|
|
54
|
+
<p class="quiet">
|
|
55
|
+
Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
|
|
56
|
+
</p>
|
|
57
|
+
<template id="filterTemplate">
|
|
58
|
+
<div class="quiet">
|
|
59
|
+
Filter:
|
|
60
|
+
<input type="search" id="fileSearch">
|
|
61
|
+
</div>
|
|
62
|
+
</template>
|
|
63
|
+
</div>
|
|
64
|
+
<div class='status-line low'></div>
|
|
65
|
+
<pre><table class="coverage">
|
|
66
|
+
<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
|
|
67
|
+
<a name='L2'></a><a href='#L2'>2</a>
|
|
68
|
+
<a name='L3'></a><a href='#L3'>3</a>
|
|
69
|
+
<a name='L4'></a><a href='#L4'>4</a>
|
|
70
|
+
<a name='L5'></a><a href='#L5'>5</a>
|
|
71
|
+
<a name='L6'></a><a href='#L6'>6</a>
|
|
72
|
+
<a name='L7'></a><a href='#L7'>7</a>
|
|
73
|
+
<a name='L8'></a><a href='#L8'>8</a>
|
|
74
|
+
<a name='L9'></a><a href='#L9'>9</a>
|
|
75
|
+
<a name='L10'></a><a href='#L10'>10</a>
|
|
76
|
+
<a name='L11'></a><a href='#L11'>11</a>
|
|
77
|
+
<a name='L12'></a><a href='#L12'>12</a>
|
|
78
|
+
<a name='L13'></a><a href='#L13'>13</a>
|
|
79
|
+
<a name='L14'></a><a href='#L14'>14</a>
|
|
80
|
+
<a name='L15'></a><a href='#L15'>15</a>
|
|
81
|
+
<a name='L16'></a><a href='#L16'>16</a>
|
|
82
|
+
<a name='L17'></a><a href='#L17'>17</a>
|
|
83
|
+
<a name='L18'></a><a href='#L18'>18</a>
|
|
84
|
+
<a name='L19'></a><a href='#L19'>19</a>
|
|
85
|
+
<a name='L20'></a><a href='#L20'>20</a>
|
|
86
|
+
<a name='L21'></a><a href='#L21'>21</a>
|
|
87
|
+
<a name='L22'></a><a href='#L22'>22</a>
|
|
88
|
+
<a name='L23'></a><a href='#L23'>23</a>
|
|
89
|
+
<a name='L24'></a><a href='#L24'>24</a>
|
|
90
|
+
<a name='L25'></a><a href='#L25'>25</a>
|
|
91
|
+
<a name='L26'></a><a href='#L26'>26</a>
|
|
92
|
+
<a name='L27'></a><a href='#L27'>27</a>
|
|
93
|
+
<a name='L28'></a><a href='#L28'>28</a>
|
|
94
|
+
<a name='L29'></a><a href='#L29'>29</a>
|
|
95
|
+
<a name='L30'></a><a href='#L30'>30</a>
|
|
96
|
+
<a name='L31'></a><a href='#L31'>31</a>
|
|
97
|
+
<a name='L32'></a><a href='#L32'>32</a>
|
|
98
|
+
<a name='L33'></a><a href='#L33'>33</a>
|
|
99
|
+
<a name='L34'></a><a href='#L34'>34</a>
|
|
100
|
+
<a name='L35'></a><a href='#L35'>35</a>
|
|
101
|
+
<a name='L36'></a><a href='#L36'>36</a>
|
|
102
|
+
<a name='L37'></a><a href='#L37'>37</a>
|
|
103
|
+
<a name='L38'></a><a href='#L38'>38</a>
|
|
104
|
+
<a name='L39'></a><a href='#L39'>39</a>
|
|
105
|
+
<a name='L40'></a><a href='#L40'>40</a>
|
|
106
|
+
<a name='L41'></a><a href='#L41'>41</a>
|
|
107
|
+
<a name='L42'></a><a href='#L42'>42</a>
|
|
108
|
+
<a name='L43'></a><a href='#L43'>43</a>
|
|
109
|
+
<a name='L44'></a><a href='#L44'>44</a>
|
|
110
|
+
<a name='L45'></a><a href='#L45'>45</a>
|
|
111
|
+
<a name='L46'></a><a href='#L46'>46</a>
|
|
112
|
+
<a name='L47'></a><a href='#L47'>47</a>
|
|
113
|
+
<a name='L48'></a><a href='#L48'>48</a>
|
|
114
|
+
<a name='L49'></a><a href='#L49'>49</a>
|
|
115
|
+
<a name='L50'></a><a href='#L50'>50</a>
|
|
116
|
+
<a name='L51'></a><a href='#L51'>51</a>
|
|
117
|
+
<a name='L52'></a><a href='#L52'>52</a>
|
|
118
|
+
<a name='L53'></a><a href='#L53'>53</a>
|
|
119
|
+
<a name='L54'></a><a href='#L54'>54</a>
|
|
120
|
+
<a name='L55'></a><a href='#L55'>55</a>
|
|
121
|
+
<a name='L56'></a><a href='#L56'>56</a>
|
|
122
|
+
<a name='L57'></a><a href='#L57'>57</a>
|
|
123
|
+
<a name='L58'></a><a href='#L58'>58</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral"> </span>
|
|
124
|
+
<span class="cline-any cline-neutral"> </span>
|
|
125
|
+
<span class="cline-any cline-neutral"> </span>
|
|
126
|
+
<span class="cline-any cline-neutral"> </span>
|
|
127
|
+
<span class="cline-any cline-neutral"> </span>
|
|
128
|
+
<span class="cline-any cline-neutral"> </span>
|
|
129
|
+
<span class="cline-any cline-neutral"> </span>
|
|
130
|
+
<span class="cline-any cline-neutral"> </span>
|
|
131
|
+
<span class="cline-any cline-neutral"> </span>
|
|
132
|
+
<span class="cline-any cline-neutral"> </span>
|
|
133
|
+
<span class="cline-any cline-neutral"> </span>
|
|
134
|
+
<span class="cline-any cline-neutral"> </span>
|
|
135
|
+
<span class="cline-any cline-neutral"> </span>
|
|
136
|
+
<span class="cline-any cline-neutral"> </span>
|
|
137
|
+
<span class="cline-any cline-neutral"> </span>
|
|
138
|
+
<span class="cline-any cline-neutral"> </span>
|
|
139
|
+
<span class="cline-any cline-neutral"> </span>
|
|
140
|
+
<span class="cline-any cline-neutral"> </span>
|
|
141
|
+
<span class="cline-any cline-neutral"> </span>
|
|
142
|
+
<span class="cline-any cline-yes">18x</span>
|
|
143
|
+
<span class="cline-any cline-neutral"> </span>
|
|
144
|
+
<span class="cline-any cline-neutral"> </span>
|
|
145
|
+
<span class="cline-any cline-neutral"> </span>
|
|
146
|
+
<span class="cline-any cline-neutral"> </span>
|
|
147
|
+
<span class="cline-any cline-neutral"> </span>
|
|
148
|
+
<span class="cline-any cline-neutral"> </span>
|
|
149
|
+
<span class="cline-any cline-neutral"> </span>
|
|
150
|
+
<span class="cline-any cline-neutral"> </span>
|
|
151
|
+
<span class="cline-any cline-neutral"> </span>
|
|
152
|
+
<span class="cline-any cline-neutral"> </span>
|
|
153
|
+
<span class="cline-any cline-neutral"> </span>
|
|
154
|
+
<span class="cline-any cline-neutral"> </span>
|
|
155
|
+
<span class="cline-any cline-neutral"> </span>
|
|
156
|
+
<span class="cline-any cline-neutral"> </span>
|
|
157
|
+
<span class="cline-any cline-neutral"> </span>
|
|
158
|
+
<span class="cline-any cline-neutral"> </span>
|
|
159
|
+
<span class="cline-any cline-neutral"> </span>
|
|
160
|
+
<span class="cline-any cline-neutral"> </span>
|
|
161
|
+
<span class="cline-any cline-no"> </span>
|
|
162
|
+
<span class="cline-any cline-neutral"> </span>
|
|
163
|
+
<span class="cline-any cline-neutral"> </span>
|
|
164
|
+
<span class="cline-any cline-neutral"> </span>
|
|
165
|
+
<span class="cline-any cline-neutral"> </span>
|
|
166
|
+
<span class="cline-any cline-neutral"> </span>
|
|
167
|
+
<span class="cline-any cline-neutral"> </span>
|
|
168
|
+
<span class="cline-any cline-neutral"> </span>
|
|
169
|
+
<span class="cline-any cline-no"> </span>
|
|
170
|
+
<span class="cline-any cline-neutral"> </span>
|
|
171
|
+
<span class="cline-any cline-neutral"> </span>
|
|
172
|
+
<span class="cline-any cline-neutral"> </span>
|
|
173
|
+
<span class="cline-any cline-neutral"> </span>
|
|
174
|
+
<span class="cline-any cline-neutral"> </span>
|
|
175
|
+
<span class="cline-any cline-neutral"> </span>
|
|
176
|
+
<span class="cline-any cline-neutral"> </span>
|
|
177
|
+
<span class="cline-any cline-no"> </span>
|
|
178
|
+
<span class="cline-any cline-neutral"> </span>
|
|
179
|
+
<span class="cline-any cline-neutral"> </span>
|
|
180
|
+
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">import { UnifiedMarket, PriceCandle, CandleInterval, OrderBook, Trade } from './types';
|
|
181
|
+
|
|
182
|
+
export interface MarketFilterParams {
|
|
183
|
+
limit?: number;
|
|
184
|
+
offset?: number;
|
|
185
|
+
sort?: 'volume' | 'liquidity' | 'newest';
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
export interface HistoryFilterParams {
|
|
189
|
+
resolution: CandleInterval;
|
|
190
|
+
start?: Date;
|
|
191
|
+
end?: Date;
|
|
192
|
+
limit?: number;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
// ----------------------------------------------------------------------------
|
|
196
|
+
// Base Exchange Class
|
|
197
|
+
// ----------------------------------------------------------------------------
|
|
198
|
+
|
|
199
|
+
export abstract class PredictionMarketExchange {
|
|
200
|
+
abstract get name(): string;
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* Fetch all relevant markets from the source.
|
|
204
|
+
*/
|
|
205
|
+
abstract fetchMarkets(params?: MarketFilterParams): Promise<UnifiedMarket[]>;
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* Search for markets matching a keyword query.
|
|
209
|
+
* Searches across title and description fields.
|
|
210
|
+
*/
|
|
211
|
+
abstract searchMarkets(query: string, params?: MarketFilterParams): Promise<UnifiedMarket[]>;
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* Fetch historical price data for a specific market or outcome.
|
|
215
|
+
* @param id - The market ID or specific outcome ID/Token ID depending on the exchange
|
|
216
|
+
*/
|
|
217
|
+
<span class="fstat-no" title="function not covered" > async </span>getMarketHistory(id: string, params: HistoryFilterParams): Promise<PriceCandle[]> {
|
|
218
|
+
<span class="cstat-no" title="statement not covered" > throw new Error("Method getMarketHistory not implemented.");</span>
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Fetch the current order book (bids/asks) for a specific outcome.
|
|
223
|
+
* Essential for calculating localized spread and depth.
|
|
224
|
+
*/
|
|
225
|
+
<span class="fstat-no" title="function not covered" > async </span>getOrderBook(id: string): Promise<OrderBook> {
|
|
226
|
+
<span class="cstat-no" title="statement not covered" > throw new Error("Method getOrderBook not implemented.");</span>
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Fetch raw trade history.
|
|
231
|
+
* Useful for generating synthetic OHLCV candles if the exchange doesn't provide them natively.
|
|
232
|
+
*/
|
|
233
|
+
<span class="fstat-no" title="function not covered" > async </span>getTradeHistory(id: string, params: HistoryFilterParams): Promise<Trade[]> {
|
|
234
|
+
<span class="cstat-no" title="statement not covered" > throw new Error("Method getTradeHistory not implemented.");</span>
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
</pre></td></tr></table></pre>
|
|
238
|
+
|
|
239
|
+
<div class='push'></div><!-- for sticky footer -->
|
|
240
|
+
</div><!-- /wrapper -->
|
|
241
|
+
<div class='footer quiet pad2 space-top1 center small'>
|
|
242
|
+
Code coverage generated by
|
|
243
|
+
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
244
|
+
at 2026-01-08T19:42:57.093Z
|
|
245
|
+
</div>
|
|
246
|
+
<script src="../prettify.js"></script>
|
|
247
|
+
<script>
|
|
248
|
+
window.onload = function () {
|
|
249
|
+
prettyPrint();
|
|
250
|
+
};
|
|
251
|
+
</script>
|
|
252
|
+
<script src="../sorter.js"></script>
|
|
253
|
+
<script src="../block-navigation.js"></script>
|
|
254
|
+
</body>
|
|
255
|
+
</html>
|
|
256
|
+
|