@nktkas/hyperliquid 0.13.1 → 0.13.2
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/LICENSE +20 -20
- package/README.md +33 -17
- package/esm/deps/jsr.io/@std/bytes/1.0.5/_types.d.ts +9 -0
- package/esm/deps/jsr.io/@std/bytes/1.0.5/_types.d.ts.map +1 -0
- package/esm/deps/jsr.io/@std/bytes/1.0.5/_types.js +2 -0
- package/esm/deps/jsr.io/@std/bytes/{1.0.4 → 1.0.5}/concat.d.ts +3 -1
- package/esm/deps/jsr.io/@std/bytes/1.0.5/concat.d.ts.map +1 -0
- package/esm/deps/jsr.io/@std/bytes/{1.0.4 → 1.0.5}/concat.js +1 -1
- package/esm/deps/jsr.io/@std/encoding/1.0.7/_types.d.ts +9 -0
- package/esm/deps/jsr.io/@std/encoding/1.0.7/_types.d.ts.map +1 -0
- package/esm/deps/jsr.io/@std/encoding/1.0.7/_types.js +2 -0
- package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.d.ts.map +1 -1
- package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.js +1 -1
- package/{script/deps/jsr.io/@std/encoding/1.0.6 → esm/deps/jsr.io/@std/encoding/1.0.7}/hex.d.ts +3 -1
- package/esm/deps/jsr.io/@std/encoding/1.0.7/hex.d.ts.map +1 -0
- package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/hex.js +1 -1
- package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts +9 -0
- package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts.map +1 -0
- package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.js +2 -0
- package/esm/deps/jsr.io/@std/msgpack/{1.0.2 → 1.0.3}/encode.d.ts +3 -1
- package/esm/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts.map +1 -0
- package/esm/deps/jsr.io/@std/msgpack/{1.0.2 → 1.0.3}/encode.js +2 -2
- package/esm/mod.d.ts +1 -0
- package/esm/mod.d.ts.map +1 -1
- package/esm/src/clients/event.d.ts +57 -16
- package/esm/src/clients/event.d.ts.map +1 -1
- package/esm/src/clients/event.js +72 -16
- package/esm/src/clients/public.d.ts +241 -49
- package/esm/src/clients/public.d.ts.map +1 -1
- package/esm/src/clients/public.js +243 -47
- package/esm/src/clients/wallet.d.ts +120 -51
- package/esm/src/clients/wallet.d.ts.map +1 -1
- package/esm/src/clients/wallet.js +192 -58
- package/esm/src/transports/websocket/hyperliquid_event_target.d.ts +27 -21
- package/esm/src/transports/websocket/hyperliquid_event_target.d.ts.map +1 -1
- package/esm/src/transports/websocket/hyperliquid_event_target.js +37 -0
- package/esm/src/transports/websocket/websocket_request_dispatcher.js +3 -3
- package/esm/src/transports/websocket/websocket_transport.d.ts +7 -10
- package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/esm/src/transports/websocket/websocket_transport.js +41 -35
- package/esm/src/types/exchange/common.d.ts +6 -6
- package/esm/src/types/exchange/common.d.ts.map +1 -1
- package/esm/src/types/exchange/requests.d.ts +131 -64
- package/esm/src/types/exchange/requests.d.ts.map +1 -1
- package/esm/src/types/exchange/responses.d.ts +7 -7
- package/esm/src/types/exchange/responses.d.ts.map +1 -1
- package/esm/src/types/explorer/common.d.ts +15 -15
- package/esm/src/types/explorer/common.d.ts.map +1 -1
- package/esm/src/types/explorer/requests.d.ts +19 -6
- package/esm/src/types/explorer/requests.d.ts.map +1 -1
- package/esm/src/types/explorer/responses.d.ts +9 -2
- package/esm/src/types/explorer/responses.d.ts.map +1 -1
- package/esm/src/types/info/accounts.d.ts +189 -124
- package/esm/src/types/info/accounts.d.ts.map +1 -1
- package/esm/src/types/info/assets.d.ts +82 -78
- package/esm/src/types/info/assets.d.ts.map +1 -1
- package/esm/src/types/info/delegations.d.ts +117 -0
- package/esm/src/types/info/delegations.d.ts.map +1 -0
- package/esm/src/types/info/delegations.js +1 -0
- package/esm/src/types/info/orders.d.ts +67 -67
- package/esm/src/types/info/orders.d.ts.map +1 -1
- package/esm/src/types/info/requests.d.ts +128 -63
- package/esm/src/types/info/requests.d.ts.map +1 -1
- package/esm/src/types/info/vaults.d.ts +41 -84
- package/esm/src/types/info/vaults.d.ts.map +1 -1
- package/esm/src/types/subscriptions/common.d.ts +3 -0
- package/esm/src/types/subscriptions/common.d.ts.map +1 -1
- package/esm/src/types/subscriptions/requests.d.ts +10 -0
- package/esm/src/types/subscriptions/requests.d.ts.map +1 -1
- package/esm/src/utils/key_sort.d.ts +2 -2
- package/esm/src/utils/key_sort.d.ts.map +1 -1
- package/esm/src/utils/signing.d.ts +1 -1
- package/esm/src/utils/signing.js +2 -2
- package/package.json +1 -1
- package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.js +13 -3
- package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.js +23 -13
- package/script/deps/jsr.io/@noble/hashes/1.7.1/src/_assert.js +55 -45
- package/script/deps/jsr.io/@noble/hashes/1.7.1/src/_u64.js +97 -87
- package/script/deps/jsr.io/@noble/hashes/1.7.1/src/crypto.js +14 -4
- package/script/deps/jsr.io/@noble/hashes/1.7.1/src/sha3.js +288 -278
- package/script/deps/jsr.io/@noble/hashes/1.7.1/src/utils.js +238 -228
- package/script/deps/jsr.io/@std/bytes/1.0.5/_types.d.ts +9 -0
- package/script/deps/jsr.io/@std/bytes/1.0.5/_types.d.ts.map +1 -0
- package/script/deps/jsr.io/@std/bytes/1.0.5/_types.js +13 -0
- package/script/deps/jsr.io/@std/bytes/{1.0.4 → 1.0.5}/concat.d.ts +3 -1
- package/script/deps/jsr.io/@std/bytes/1.0.5/concat.d.ts.map +1 -0
- package/script/deps/jsr.io/@std/bytes/1.0.5/concat.js +45 -0
- package/script/deps/jsr.io/@std/encoding/1.0.7/_types.d.ts +9 -0
- package/script/deps/jsr.io/@std/encoding/1.0.7/_types.d.ts.map +1 -0
- package/script/deps/jsr.io/@std/encoding/1.0.7/_types.js +13 -0
- package/script/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.d.ts.map +1 -1
- package/script/deps/jsr.io/@std/encoding/1.0.7/_validate_binary_like.js +39 -0
- package/{esm/deps/jsr.io/@std/encoding/1.0.6 → script/deps/jsr.io/@std/encoding/1.0.7}/hex.d.ts +3 -1
- package/script/deps/jsr.io/@std/encoding/1.0.7/hex.d.ts.map +1 -0
- package/script/deps/jsr.io/@std/encoding/1.0.7/hex.js +123 -0
- package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts +9 -0
- package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts.map +1 -0
- package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.js +13 -0
- package/script/deps/jsr.io/@std/msgpack/{1.0.2 → 1.0.3}/encode.d.ts +3 -1
- package/script/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts.map +1 -0
- package/script/deps/jsr.io/@std/msgpack/1.0.3/encode.js +250 -0
- package/script/mod.d.ts +1 -0
- package/script/mod.d.ts.map +1 -1
- package/script/mod.js +23 -13
- package/script/src/clients/event.d.ts +57 -16
- package/script/src/clients/event.d.ts.map +1 -1
- package/script/src/clients/event.js +551 -485
- package/script/src/clients/public.d.ts +241 -49
- package/script/src/clients/public.d.ts.map +1 -1
- package/script/src/clients/public.js +914 -708
- package/script/src/clients/wallet.d.ts +120 -51
- package/script/src/clients/wallet.d.ts.map +1 -1
- package/script/src/clients/wallet.js +1121 -977
- package/script/src/transports/base.js +25 -15
- package/script/src/transports/http/http_transport.js +174 -164
- package/script/src/transports/websocket/hyperliquid_event_target.d.ts +27 -21
- package/script/src/transports/websocket/hyperliquid_event_target.d.ts.map +1 -1
- package/script/src/transports/websocket/hyperliquid_event_target.js +80 -33
- package/script/src/transports/websocket/reconnecting_websocket.js +364 -354
- package/script/src/transports/websocket/websocket_request_dispatcher.js +196 -186
- package/script/src/transports/websocket/websocket_transport.d.ts +7 -10
- package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/script/src/transports/websocket/websocket_transport.js +236 -220
- package/script/src/types/common.js +12 -2
- package/script/src/types/exchange/common.d.ts +6 -6
- package/script/src/types/exchange/common.d.ts.map +1 -1
- package/script/src/types/exchange/common.js +12 -2
- package/script/src/types/exchange/requests.d.ts +131 -64
- package/script/src/types/exchange/requests.d.ts.map +1 -1
- package/script/src/types/exchange/requests.js +12 -2
- package/script/src/types/exchange/responses.d.ts +7 -7
- package/script/src/types/exchange/responses.d.ts.map +1 -1
- package/script/src/types/exchange/responses.js +12 -2
- package/script/src/types/explorer/common.d.ts +15 -15
- package/script/src/types/explorer/common.d.ts.map +1 -1
- package/script/src/types/explorer/common.js +12 -2
- package/script/src/types/explorer/requests.d.ts +19 -6
- package/script/src/types/explorer/requests.d.ts.map +1 -1
- package/script/src/types/explorer/requests.js +12 -2
- package/script/src/types/explorer/responses.d.ts +9 -2
- package/script/src/types/explorer/responses.d.ts.map +1 -1
- package/script/src/types/explorer/responses.js +12 -2
- package/script/src/types/info/accounts.d.ts +189 -124
- package/script/src/types/info/accounts.d.ts.map +1 -1
- package/script/src/types/info/accounts.js +12 -2
- package/script/src/types/info/assets.d.ts +82 -78
- package/script/src/types/info/assets.d.ts.map +1 -1
- package/script/src/types/info/assets.js +12 -2
- package/script/src/types/info/delegations.d.ts +117 -0
- package/script/src/types/info/delegations.d.ts.map +1 -0
- package/script/src/types/info/delegations.js +12 -0
- package/script/src/types/info/orders.d.ts +67 -67
- package/script/src/types/info/orders.d.ts.map +1 -1
- package/script/src/types/info/orders.js +12 -2
- package/script/src/types/info/requests.d.ts +128 -63
- package/script/src/types/info/requests.d.ts.map +1 -1
- package/script/src/types/info/requests.js +12 -2
- package/script/src/types/info/vaults.d.ts +41 -84
- package/script/src/types/info/vaults.d.ts.map +1 -1
- package/script/src/types/info/vaults.js +12 -2
- package/script/src/types/subscriptions/common.d.ts +3 -0
- package/script/src/types/subscriptions/common.d.ts.map +1 -1
- package/script/src/types/subscriptions/common.js +12 -2
- package/script/src/types/subscriptions/requests.d.ts +10 -0
- package/script/src/types/subscriptions/requests.d.ts.map +1 -1
- package/script/src/types/subscriptions/requests.js +12 -2
- package/script/src/utils/key_sort.d.ts +2 -2
- package/script/src/utils/key_sort.d.ts.map +1 -1
- package/script/src/utils/key_sort.js +133 -123
- package/script/src/utils/signing.d.ts +1 -1
- package/script/src/utils/signing.js +172 -162
- package/esm/deps/jsr.io/@std/bytes/1.0.4/concat.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/encoding/1.0.6/hex.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/msgpack/1.0.2/encode.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/bytes/1.0.4/concat.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/bytes/1.0.4/concat.js +0 -35
- package/script/deps/jsr.io/@std/encoding/1.0.6/_validate_binary_like.js +0 -29
- package/script/deps/jsr.io/@std/encoding/1.0.6/hex.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/encoding/1.0.6/hex.js +0 -113
- package/script/deps/jsr.io/@std/msgpack/1.0.2/encode.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/msgpack/1.0.2/encode.js +0 -240
- /package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.d.ts +0 -0
- /package/script/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.d.ts +0 -0
|
@@ -1,708 +1,914 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
1
|
+
(function (factory) {
|
|
2
|
+
if (typeof module === "object" && typeof module.exports === "object") {
|
|
3
|
+
var v = factory(require, exports);
|
|
4
|
+
if (v !== undefined) module.exports = v;
|
|
5
|
+
}
|
|
6
|
+
else if (typeof define === "function" && define.amd) {
|
|
7
|
+
define(["require", "exports"], factory);
|
|
8
|
+
}
|
|
9
|
+
})(function (require, exports) {
|
|
10
|
+
"use strict";
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.PublicClient = void 0;
|
|
13
|
+
// ——————————————— Client ———————————————
|
|
14
|
+
/**
|
|
15
|
+
* Public client for interacting with the Hyperliquid API.
|
|
16
|
+
* @typeParam T - The type of transport used to connect to the Hyperliquid API.
|
|
17
|
+
*/
|
|
18
|
+
class PublicClient {
|
|
19
|
+
/**
|
|
20
|
+
* Initialises a new instance.
|
|
21
|
+
* @param args - The arguments for initialisation.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
26
|
+
*
|
|
27
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
28
|
+
* const client = new hl.PublicClient({ transport });
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
constructor(args) {
|
|
32
|
+
/** The transport used to connect to the Hyperliquid API. */
|
|
33
|
+
Object.defineProperty(this, "transport", {
|
|
34
|
+
enumerable: true,
|
|
35
|
+
configurable: true,
|
|
36
|
+
writable: true,
|
|
37
|
+
value: void 0
|
|
38
|
+
});
|
|
39
|
+
this.transport = args.transport;
|
|
40
|
+
}
|
|
41
|
+
// ——————————————— Info API ———————————————
|
|
42
|
+
/**
|
|
43
|
+
* Request mid coin prices.
|
|
44
|
+
* @param signal - An optional abort signal.
|
|
45
|
+
* @returns Mid coin prices.
|
|
46
|
+
*
|
|
47
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
51
|
+
*
|
|
52
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
53
|
+
* const client = new hl.PublicClient({ transport });
|
|
54
|
+
*
|
|
55
|
+
* const allMids = await client.allMids();
|
|
56
|
+
* ```
|
|
57
|
+
*/
|
|
58
|
+
allMids(signal) {
|
|
59
|
+
return this.transport.request("info", { type: "allMids" }, signal);
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Request candlestick snapshots.
|
|
63
|
+
* @param args - The parameters for the request.
|
|
64
|
+
* @param signal - An optional abort signal.
|
|
65
|
+
* @returns Array of candlestick data points.
|
|
66
|
+
*
|
|
67
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
|
|
68
|
+
* @example
|
|
69
|
+
* ```ts
|
|
70
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
71
|
+
*
|
|
72
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
73
|
+
* const client = new hl.PublicClient({ transport });
|
|
74
|
+
*
|
|
75
|
+
* const candleSnapshot = await client.candleSnapshot({
|
|
76
|
+
* coin: "ETH",
|
|
77
|
+
* interval: "1h",
|
|
78
|
+
* startTime: Date.now() - 1000 * 60 * 60 * 24
|
|
79
|
+
* });
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
candleSnapshot(args, signal) {
|
|
83
|
+
return this.transport.request("info", { type: "candleSnapshot", req: args }, signal);
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Request clearinghouse state.
|
|
87
|
+
* @param args - The parameters for the request.
|
|
88
|
+
* @param signal - An optional abort signal.
|
|
89
|
+
* @returns Account summary for perpetual trading.
|
|
90
|
+
*
|
|
91
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
|
|
92
|
+
* @example
|
|
93
|
+
* ```ts
|
|
94
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
95
|
+
*
|
|
96
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
97
|
+
* const client = new hl.PublicClient({ transport });
|
|
98
|
+
*
|
|
99
|
+
* const clearinghouseState = await client.clearinghouseState({ user: "0x..." });
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
clearinghouseState(args, signal) {
|
|
103
|
+
return this.transport.request("info", { type: "clearinghouseState", ...args }, signal);
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Request user staking delegations.
|
|
107
|
+
* @param args - The parameters for the request.
|
|
108
|
+
* @param signal - An optional abort signal.
|
|
109
|
+
* @returns Array of user's delegations to validators.
|
|
110
|
+
*
|
|
111
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-delegations
|
|
112
|
+
* @example
|
|
113
|
+
* ```ts
|
|
114
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
115
|
+
*
|
|
116
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
117
|
+
* const client = new hl.PublicClient({ transport });
|
|
118
|
+
*
|
|
119
|
+
* const delegations = await client.delegations({ user: "0x..." });
|
|
120
|
+
* ```
|
|
121
|
+
*/
|
|
122
|
+
delegations(args, signal) {
|
|
123
|
+
return this.transport.request("info", { type: "delegations", ...args }, signal);
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* Request user staking history.
|
|
127
|
+
* @param args - The parameters for the request.
|
|
128
|
+
* @param signal - An optional abort signal.
|
|
129
|
+
* @returns Array of user's staking updates.
|
|
130
|
+
*
|
|
131
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-history
|
|
132
|
+
* @example
|
|
133
|
+
* ```ts
|
|
134
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
135
|
+
*
|
|
136
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
137
|
+
* const client = new hl.PublicClient({ transport });
|
|
138
|
+
*
|
|
139
|
+
* const delegatorHistory = await client.delegatorHistory({ user: "0x..." });
|
|
140
|
+
* ```
|
|
141
|
+
*/
|
|
142
|
+
delegatorHistory(args, signal) {
|
|
143
|
+
return this.transport.request("info", { type: "delegatorHistory", ...args }, signal);
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* Request user staking rewards.
|
|
147
|
+
* @param args - The parameters for the request.
|
|
148
|
+
* @param signal - An optional abort signal.
|
|
149
|
+
* @returns Array of user's staking rewards.
|
|
150
|
+
*
|
|
151
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-rewards
|
|
152
|
+
* @example
|
|
153
|
+
* ```ts
|
|
154
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
155
|
+
*
|
|
156
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
157
|
+
* const client = new hl.PublicClient({ transport });
|
|
158
|
+
*
|
|
159
|
+
* const delegatorRewards = await client.delegatorRewards({ user: "0x..." });
|
|
160
|
+
* ```
|
|
161
|
+
*/
|
|
162
|
+
delegatorRewards(args, signal) {
|
|
163
|
+
return this.transport.request("info", { type: "delegatorRewards", ...args }, signal);
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Request user staking summary.
|
|
167
|
+
* @param args - The parameters for the request.
|
|
168
|
+
* @param signal - An optional abort signal.
|
|
169
|
+
* @returns Summary of a user's staking delegations.
|
|
170
|
+
*
|
|
171
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-summary
|
|
172
|
+
* @example
|
|
173
|
+
* ```ts
|
|
174
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
175
|
+
*
|
|
176
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
177
|
+
* const client = new hl.PublicClient({ transport });
|
|
178
|
+
*
|
|
179
|
+
* const delegatorSummary = await client.delegatorSummary({ user: "0x..." });
|
|
180
|
+
* ```
|
|
181
|
+
*/
|
|
182
|
+
delegatorSummary(args, signal) {
|
|
183
|
+
return this.transport.request("info", { type: "delegatorSummary", ...args }, signal);
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Request user's extra agents.
|
|
187
|
+
* @param args - The parameters for the request.
|
|
188
|
+
* @param signal - An optional abort signal.
|
|
189
|
+
* @returns User's extra agents.
|
|
190
|
+
*
|
|
191
|
+
* @see null - no documentation
|
|
192
|
+
* @example
|
|
193
|
+
* ```ts
|
|
194
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
195
|
+
*
|
|
196
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
197
|
+
* const client = new hl.PublicClient({ transport });
|
|
198
|
+
*
|
|
199
|
+
* const extraAgents = await client.extraAgents({ user: "0x..." });
|
|
200
|
+
* ```
|
|
201
|
+
*/
|
|
202
|
+
extraAgents(args, signal) {
|
|
203
|
+
return this.transport.request("info", { type: "extraAgents", ...args }, signal);
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* Request frontend open orders.
|
|
207
|
+
* @param args - The parameters for the request.
|
|
208
|
+
* @param signal - An optional abort signal.
|
|
209
|
+
* @returns Array of open orders with additional frontend information.
|
|
210
|
+
*
|
|
211
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
|
|
212
|
+
* @example
|
|
213
|
+
* ```ts
|
|
214
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
215
|
+
*
|
|
216
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
217
|
+
* const client = new hl.PublicClient({ transport });
|
|
218
|
+
*
|
|
219
|
+
* const frontendOpenOrders = await client.frontendOpenOrders({ user: "0x..." });
|
|
220
|
+
* ```
|
|
221
|
+
*/
|
|
222
|
+
frontendOpenOrders(args, signal) {
|
|
223
|
+
return this.transport.request("info", { type: "frontendOpenOrders", ...args }, signal);
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Request funding history.
|
|
227
|
+
* @param args - The parameters for the request.
|
|
228
|
+
* @param signal - An optional abort signal.
|
|
229
|
+
* @returns Array of historical funding rate data for an asset.
|
|
230
|
+
*
|
|
231
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
|
|
232
|
+
* @example
|
|
233
|
+
* ```ts
|
|
234
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
235
|
+
*
|
|
236
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
237
|
+
* const client = new hl.PublicClient({ transport });
|
|
238
|
+
*
|
|
239
|
+
* const fundingHistory = await client.fundingHistory({
|
|
240
|
+
* coin: "ETH",
|
|
241
|
+
* startTime: Date.now() - 1000 * 60 * 60 * 24
|
|
242
|
+
* });
|
|
243
|
+
* ```
|
|
244
|
+
*/
|
|
245
|
+
fundingHistory(args, signal) {
|
|
246
|
+
return this.transport.request("info", { type: "fundingHistory", ...args }, signal);
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* Request user's historical orders.
|
|
250
|
+
* @param args - The parameters for the request.
|
|
251
|
+
* @param signal - An optional abort signal.
|
|
252
|
+
* @returns Array of user's historical orders.
|
|
253
|
+
*
|
|
254
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
|
|
255
|
+
* @example
|
|
256
|
+
* ```ts
|
|
257
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
258
|
+
*
|
|
259
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
260
|
+
* const client = new hl.PublicClient({ transport });
|
|
261
|
+
*
|
|
262
|
+
* const historicalOrders = await client.historicalOrders({ user: "0x..." });
|
|
263
|
+
* ```
|
|
264
|
+
*/
|
|
265
|
+
historicalOrders(args, signal) {
|
|
266
|
+
return this.transport.request("info", { type: "historicalOrders", ...args }, signal);
|
|
267
|
+
}
|
|
268
|
+
/**
|
|
269
|
+
* Request L2 order book.
|
|
270
|
+
* @param args - The parameters for the request.
|
|
271
|
+
* @param signal - An optional abort signal.
|
|
272
|
+
* @returns L2 order book snapshot.
|
|
273
|
+
*
|
|
274
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
|
|
275
|
+
* @example
|
|
276
|
+
* ```ts
|
|
277
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
278
|
+
*
|
|
279
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
280
|
+
* const client = new hl.PublicClient({ transport });
|
|
281
|
+
*
|
|
282
|
+
* const l2Book = await client.l2Book({ coin: "ETH", nSigFigs: 2 });
|
|
283
|
+
* ```
|
|
284
|
+
*/
|
|
285
|
+
l2Book(args, signal) {
|
|
286
|
+
return this.transport.request("info", { type: "l2Book", ...args }, signal);
|
|
287
|
+
}
|
|
288
|
+
/**
|
|
289
|
+
* Request builder fee approval.
|
|
290
|
+
* @param args - The parameters for the request.
|
|
291
|
+
* @param signal - An optional abort signal.
|
|
292
|
+
* @returns Maximum builder fee approval.
|
|
293
|
+
*
|
|
294
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
|
|
295
|
+
* @example
|
|
296
|
+
* ```ts
|
|
297
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
298
|
+
*
|
|
299
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
300
|
+
* const client = new hl.PublicClient({ transport });
|
|
301
|
+
*
|
|
302
|
+
* const maxBuilderFee = await client.maxBuilderFee({ user: "0x...", builder: "0x..." });
|
|
303
|
+
* ```
|
|
304
|
+
*/
|
|
305
|
+
maxBuilderFee(args, signal) {
|
|
306
|
+
return this.transport.request("info", { type: "maxBuilderFee", ...args }, signal);
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* Request trading metadata.
|
|
310
|
+
* @param signal - An optional abort signal.
|
|
311
|
+
* @returns Metadata for perpetual assets.
|
|
312
|
+
*
|
|
313
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata
|
|
314
|
+
* @example
|
|
315
|
+
* ```ts
|
|
316
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
317
|
+
*
|
|
318
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
319
|
+
* const client = new hl.PublicClient({ transport });
|
|
320
|
+
*
|
|
321
|
+
* const meta = await client.meta();
|
|
322
|
+
* ```
|
|
323
|
+
*/
|
|
324
|
+
meta(signal) {
|
|
325
|
+
return this.transport.request("info", { type: "meta" }, signal);
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* Request metadata and asset contexts.
|
|
329
|
+
* @param signal - An optional abort signal.
|
|
330
|
+
* @returns Metadata and context information for each perpetual asset.
|
|
331
|
+
*
|
|
332
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc
|
|
333
|
+
* @example
|
|
334
|
+
* ```ts
|
|
335
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
336
|
+
*
|
|
337
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
338
|
+
* const client = new hl.PublicClient({ transport });
|
|
339
|
+
*
|
|
340
|
+
* const [meta, assetCtxs] = await client.metaAndAssetCtxs();
|
|
341
|
+
* ```
|
|
342
|
+
*/
|
|
343
|
+
metaAndAssetCtxs(signal) {
|
|
344
|
+
return this.transport.request("info", { type: "metaAndAssetCtxs" }, signal);
|
|
345
|
+
}
|
|
346
|
+
/**
|
|
347
|
+
* Request open orders.
|
|
348
|
+
* @param args - The parameters for the request.
|
|
349
|
+
* @param signal - An optional abort signal.
|
|
350
|
+
* @returns Array of open order.
|
|
351
|
+
*
|
|
352
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
|
|
353
|
+
* @example
|
|
354
|
+
* ```ts
|
|
355
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
356
|
+
*
|
|
357
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
358
|
+
* const client = new hl.PublicClient({ transport });
|
|
359
|
+
*
|
|
360
|
+
* const openOrders = await client.openOrders({ user: "0x..." });
|
|
361
|
+
* ```
|
|
362
|
+
*/
|
|
363
|
+
openOrders(args, signal) {
|
|
364
|
+
return this.transport.request("info", { type: "openOrders", ...args }, signal);
|
|
365
|
+
}
|
|
366
|
+
/**
|
|
367
|
+
* Request order status.
|
|
368
|
+
* @param args - The parameters for the request.
|
|
369
|
+
* @param signal - An optional abort signal.
|
|
370
|
+
* @returns Result of an order status lookup.
|
|
371
|
+
*
|
|
372
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
|
|
373
|
+
* @example
|
|
374
|
+
* ```ts
|
|
375
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
376
|
+
*
|
|
377
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
378
|
+
* const client = new hl.PublicClient({ transport });
|
|
379
|
+
*
|
|
380
|
+
* const orderStatus = await client.orderStatus({ user: "0x...", oid: 12345 });
|
|
381
|
+
* ```
|
|
382
|
+
*/
|
|
383
|
+
orderStatus(args, signal) {
|
|
384
|
+
return this.transport.request("info", { type: "orderStatus", ...args }, signal);
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* Request portfolio.
|
|
388
|
+
* @param args - The parameters for the request.
|
|
389
|
+
* @param signal - An optional abort signal.
|
|
390
|
+
* @returns Portfolio of a user.
|
|
391
|
+
*
|
|
392
|
+
* @see null - no documentation
|
|
393
|
+
* @example
|
|
394
|
+
* ```ts
|
|
395
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
396
|
+
*
|
|
397
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
398
|
+
* const client = new hl.PublicClient({ transport });
|
|
399
|
+
*
|
|
400
|
+
* const portfolio = await client.portfolio({ user: "0x..." });
|
|
401
|
+
* ```
|
|
402
|
+
*/
|
|
403
|
+
portfolio(args, signal) {
|
|
404
|
+
return this.transport.request("info", { type: "portfolio", ...args }, signal);
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
* Request perpetuals at open interest cap.
|
|
408
|
+
* @param args - The parameters for the request.
|
|
409
|
+
* @param signal - An optional abort signal.
|
|
410
|
+
* @returns Array of perpetuals at open interest caps.
|
|
411
|
+
*
|
|
412
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
|
|
413
|
+
* @example
|
|
414
|
+
* ```ts
|
|
415
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
416
|
+
*
|
|
417
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
418
|
+
* const client = new hl.PublicClient({ transport });
|
|
419
|
+
*
|
|
420
|
+
* const perpsAtOpenInterestCap = await client.perpsAtOpenInterestCap();
|
|
421
|
+
* ```
|
|
422
|
+
*/
|
|
423
|
+
perpsAtOpenInterestCap(signal) {
|
|
424
|
+
return this.transport.request("info", { type: "perpsAtOpenInterestCap" }, signal);
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* Request predicted funding rates.
|
|
428
|
+
* @param signal - An optional abort signal.
|
|
429
|
+
* @returns Array of predicted funding rates.
|
|
430
|
+
*
|
|
431
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
|
|
432
|
+
* @example
|
|
433
|
+
* ```ts
|
|
434
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
435
|
+
*
|
|
436
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
437
|
+
* const client = new hl.PublicClient({ transport });
|
|
438
|
+
*
|
|
439
|
+
* const predictedFundings = await client.predictedFundings();
|
|
440
|
+
* ```
|
|
441
|
+
*/
|
|
442
|
+
predictedFundings(signal) {
|
|
443
|
+
return this.transport.request("info", { type: "predictedFundings" }, signal);
|
|
444
|
+
}
|
|
445
|
+
/**
|
|
446
|
+
* Request user referral.
|
|
447
|
+
* @param args - The parameters for the request.
|
|
448
|
+
* @param signal - An optional abort signal.
|
|
449
|
+
* @returns Referral information for a user.
|
|
450
|
+
*
|
|
451
|
+
* @see null - no documentation
|
|
452
|
+
* @example
|
|
453
|
+
* ```ts
|
|
454
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
455
|
+
*
|
|
456
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
457
|
+
* const client = new hl.PublicClient({ transport });
|
|
458
|
+
*
|
|
459
|
+
* const referral = await client.referral({ user: "0x..." });
|
|
460
|
+
* ```
|
|
461
|
+
*/
|
|
462
|
+
referral(args, signal) {
|
|
463
|
+
return this.transport.request("info", { type: "referral", ...args }, signal);
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* Request spot clearinghouse state.
|
|
467
|
+
* @param args - The parameters for the request.
|
|
468
|
+
* @param signal - An optional abort signal.
|
|
469
|
+
* @returns Balances for spot tokens.
|
|
470
|
+
*
|
|
471
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
|
|
472
|
+
* @example
|
|
473
|
+
* ```ts
|
|
474
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
475
|
+
*
|
|
476
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
477
|
+
* const client = new hl.PublicClient({ transport });
|
|
478
|
+
*
|
|
479
|
+
* const spotClearinghouseState = await client.spotClearinghouseState({ user: "0x..." });
|
|
480
|
+
* ```
|
|
481
|
+
*/
|
|
482
|
+
spotClearinghouseState(args, signal) {
|
|
483
|
+
return this.transport.request("info", { type: "spotClearinghouseState", ...args }, signal);
|
|
484
|
+
}
|
|
485
|
+
/**
|
|
486
|
+
* Request spot deploy state.
|
|
487
|
+
* @param args - The parameters for the request.
|
|
488
|
+
* @param signal - An optional abort signal.
|
|
489
|
+
* @returns The deploy state of a user.
|
|
490
|
+
*
|
|
491
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
|
|
492
|
+
* @example
|
|
493
|
+
* ```ts
|
|
494
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
495
|
+
*
|
|
496
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
497
|
+
* const client = new hl.PublicClient({ transport });
|
|
498
|
+
*
|
|
499
|
+
* const spotDeployState = await client.spotDeployState({ user: "0x..." });
|
|
500
|
+
* ```
|
|
501
|
+
*/
|
|
502
|
+
spotDeployState(args, signal) {
|
|
503
|
+
return this.transport.request("info", { type: "spotDeployState", ...args }, signal);
|
|
504
|
+
}
|
|
505
|
+
/**
|
|
506
|
+
* Request spot trading metadata.
|
|
507
|
+
* @param signal - An optional abort signal.
|
|
508
|
+
* @returns Metadata for spot assets.
|
|
509
|
+
*
|
|
510
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
|
|
511
|
+
* @example
|
|
512
|
+
* ```ts
|
|
513
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
514
|
+
*
|
|
515
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
516
|
+
* const client = new hl.PublicClient({ transport });
|
|
517
|
+
*
|
|
518
|
+
* const spotMeta = await client.spotMeta();
|
|
519
|
+
* ```
|
|
520
|
+
*/
|
|
521
|
+
spotMeta(signal) {
|
|
522
|
+
return this.transport.request("info", { type: "spotMeta" }, signal);
|
|
523
|
+
}
|
|
524
|
+
/**
|
|
525
|
+
* Request spot metadata and asset contexts.
|
|
526
|
+
* @param signal - An optional abort signal.
|
|
527
|
+
* @returns Metadata and context information for each spot asset.
|
|
528
|
+
*
|
|
529
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
|
|
530
|
+
* @example
|
|
531
|
+
* ```ts
|
|
532
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
533
|
+
*
|
|
534
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
535
|
+
* const client = new hl.PublicClient({ transport });
|
|
536
|
+
*
|
|
537
|
+
* const [spotMeta, spotAssetCtxs] = await client.spotMetaAndAssetCtxs();
|
|
538
|
+
* ```
|
|
539
|
+
*/
|
|
540
|
+
spotMetaAndAssetCtxs(signal) {
|
|
541
|
+
return this.transport.request("info", { type: "spotMetaAndAssetCtxs" }, signal);
|
|
542
|
+
}
|
|
543
|
+
/**
|
|
544
|
+
* Request user sub-accounts.
|
|
545
|
+
* @param args - The parameters for the request.
|
|
546
|
+
* @param signal - An optional abort signal.
|
|
547
|
+
* @returns Array of user sub-account.
|
|
548
|
+
*
|
|
549
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
|
|
550
|
+
* @example
|
|
551
|
+
* ```ts
|
|
552
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
553
|
+
*
|
|
554
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
555
|
+
* const client = new hl.PublicClient({ transport });
|
|
556
|
+
*
|
|
557
|
+
* const subAccounts = await client.subAccounts({ user: "0x..." });
|
|
558
|
+
* ```
|
|
559
|
+
*/
|
|
560
|
+
subAccounts(args, signal) {
|
|
561
|
+
return this.transport.request("info", { type: "subAccounts", ...args }, signal);
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* Request token details.
|
|
565
|
+
* @param args - The parameters for the request.
|
|
566
|
+
* @param signal - An optional abort signal.
|
|
567
|
+
* @returns The details of a token.
|
|
568
|
+
*
|
|
569
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
|
|
570
|
+
* @example
|
|
571
|
+
* ```ts
|
|
572
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
573
|
+
*
|
|
574
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
575
|
+
* const client = new hl.PublicClient({ transport });
|
|
576
|
+
*
|
|
577
|
+
* const tokenDetails = await client.tokenDetails({ tokenId: "0x..." });
|
|
578
|
+
* ```
|
|
579
|
+
*/
|
|
580
|
+
tokenDetails(args, signal) {
|
|
581
|
+
return this.transport.request("info", { type: "tokenDetails", ...args }, signal);
|
|
582
|
+
}
|
|
583
|
+
/**
|
|
584
|
+
* Request twap history of a user.
|
|
585
|
+
* @param args - The parameters for the request.
|
|
586
|
+
* @param signal - An optional abort signal.
|
|
587
|
+
* @returns The twap history of a user.
|
|
588
|
+
*
|
|
589
|
+
* @see null - no documentation
|
|
590
|
+
* @example
|
|
591
|
+
* ```ts
|
|
592
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
593
|
+
*
|
|
594
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
595
|
+
* const client = new hl.PublicClient({ transport });
|
|
596
|
+
*
|
|
597
|
+
* const twapHistory = await client.twapHistory({ user: "0x..." });
|
|
598
|
+
* ```
|
|
599
|
+
*/
|
|
600
|
+
twapHistory(args, signal) {
|
|
601
|
+
return this.transport.request("info", { type: "twapHistory", ...args }, signal);
|
|
602
|
+
}
|
|
603
|
+
/**
|
|
604
|
+
* Request user fees.
|
|
605
|
+
* @param args - The parameters for the request.
|
|
606
|
+
* @param signal - An optional abort signal.
|
|
607
|
+
* @returns User fees.
|
|
608
|
+
*
|
|
609
|
+
* @see null - no documentation
|
|
610
|
+
* @example
|
|
611
|
+
* ```ts
|
|
612
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
613
|
+
*
|
|
614
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
615
|
+
* const client = new hl.PublicClient({ transport });
|
|
616
|
+
*
|
|
617
|
+
* const fees = await client.userFees({ user: "0x..." });
|
|
618
|
+
* ```
|
|
619
|
+
*/
|
|
620
|
+
userFees(args, signal) {
|
|
621
|
+
return this.transport.request("info", { type: "userFees", ...args }, signal);
|
|
622
|
+
}
|
|
623
|
+
/**
|
|
624
|
+
* Request user fills.
|
|
625
|
+
* @param args - The parameters for the request.
|
|
626
|
+
* @param signal - An optional abort signal.
|
|
627
|
+
* @returns Array of user's trade fill.
|
|
628
|
+
*
|
|
629
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
|
|
630
|
+
* @example
|
|
631
|
+
* ```ts
|
|
632
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
633
|
+
*
|
|
634
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
635
|
+
* const client = new hl.PublicClient({ transport });
|
|
636
|
+
*
|
|
637
|
+
* const fills = await client.userFills({ user: "0x..." });
|
|
638
|
+
* ```
|
|
639
|
+
*/
|
|
640
|
+
userFills(args, signal) {
|
|
641
|
+
return this.transport.request("info", { type: "userFills", ...args }, signal);
|
|
642
|
+
}
|
|
643
|
+
/**
|
|
644
|
+
* Request user fills by time.
|
|
645
|
+
* @param args - The parameters for the request.
|
|
646
|
+
* @param signal - An optional abort signal.
|
|
647
|
+
* @returns Array of user's trade fill.
|
|
648
|
+
*
|
|
649
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
|
|
650
|
+
* @example
|
|
651
|
+
* ```ts
|
|
652
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
653
|
+
*
|
|
654
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
655
|
+
* const client = new hl.PublicClient({ transport });
|
|
656
|
+
*
|
|
657
|
+
* const fills = await client.userFillsByTime({
|
|
658
|
+
* user: "0x...",
|
|
659
|
+
* startTime: Date.now() - 1000 * 60 * 60 * 24
|
|
660
|
+
* });
|
|
661
|
+
* ```
|
|
662
|
+
*/
|
|
663
|
+
userFillsByTime(args, signal) {
|
|
664
|
+
return this.transport.request("info", { type: "userFillsByTime", ...args }, signal);
|
|
665
|
+
}
|
|
666
|
+
/**
|
|
667
|
+
* Request user funding.
|
|
668
|
+
* @param args - The parameters for the request.
|
|
669
|
+
* @param signal - An optional abort signal.
|
|
670
|
+
* @returns Array of user's funding ledger update.
|
|
671
|
+
*
|
|
672
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
|
|
673
|
+
* @example
|
|
674
|
+
* ```ts
|
|
675
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
676
|
+
*
|
|
677
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
678
|
+
* const client = new hl.PublicClient({ transport });
|
|
679
|
+
*
|
|
680
|
+
* const funding = await client.userFunding({
|
|
681
|
+
* user: "0x...",
|
|
682
|
+
* startTime: Date.now() - 1000 * 60 * 60 * 24
|
|
683
|
+
* });
|
|
684
|
+
* ```
|
|
685
|
+
*/
|
|
686
|
+
userFunding(args, signal) {
|
|
687
|
+
return this.transport.request("info", { type: "userFunding", ...args }, signal);
|
|
688
|
+
}
|
|
689
|
+
/**
|
|
690
|
+
* Request user non-funding ledger updates.
|
|
691
|
+
* @param args - The parameters for the request.
|
|
692
|
+
* @param signal - An optional abort signal.
|
|
693
|
+
* @returns Array of user's non-funding ledger update.
|
|
694
|
+
*
|
|
695
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
|
|
696
|
+
* @example
|
|
697
|
+
* ```ts
|
|
698
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
699
|
+
*
|
|
700
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
701
|
+
* const client = new hl.PublicClient({ transport });
|
|
702
|
+
*
|
|
703
|
+
* const nonFundingLedgerUpdates = await client.userNonFundingLedgerUpdates({
|
|
704
|
+
* user: "0x...",
|
|
705
|
+
* startTime: Date.now() - 1000 * 60 * 60 * 24
|
|
706
|
+
* });
|
|
707
|
+
* ```
|
|
708
|
+
*/
|
|
709
|
+
userNonFundingLedgerUpdates(args, signal) {
|
|
710
|
+
return this.transport.request("info", { type: "userNonFundingLedgerUpdates", ...args }, signal);
|
|
711
|
+
}
|
|
712
|
+
/**
|
|
713
|
+
* Request user rate limits.
|
|
714
|
+
* @param args - The parameters for the request.
|
|
715
|
+
* @param signal - An optional abort signal.
|
|
716
|
+
* @returns User's rate limits.
|
|
717
|
+
*
|
|
718
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
|
|
719
|
+
* @example
|
|
720
|
+
* ```ts
|
|
721
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
722
|
+
*
|
|
723
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
724
|
+
* const client = new hl.PublicClient({ transport });
|
|
725
|
+
*
|
|
726
|
+
* const rateLimit = await client.userRateLimit({ user: "0x..." });
|
|
727
|
+
* ```
|
|
728
|
+
*/
|
|
729
|
+
userRateLimit(args, signal) {
|
|
730
|
+
return this.transport.request("info", { type: "userRateLimit", ...args }, signal);
|
|
731
|
+
}
|
|
732
|
+
/**
|
|
733
|
+
* Request user role.
|
|
734
|
+
* @param args - The parameters for the request.
|
|
735
|
+
* @param signal - An optional abort signal.
|
|
736
|
+
* @returns User's role.
|
|
737
|
+
*
|
|
738
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
|
|
739
|
+
* @example
|
|
740
|
+
* ```ts
|
|
741
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
742
|
+
*
|
|
743
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
744
|
+
* const client = new hl.PublicClient({ transport });
|
|
745
|
+
*
|
|
746
|
+
* const userRole = await client.userRole({ user: "0x..." });
|
|
747
|
+
* ```
|
|
748
|
+
*/
|
|
749
|
+
userRole(args, signal) {
|
|
750
|
+
return this.transport.request("info", { type: "userRole", ...args }, signal);
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
* Request user twap slice fills.
|
|
754
|
+
* @param args - The parameters for the request.
|
|
755
|
+
* @param signal - An optional abort signal.
|
|
756
|
+
* @returns Array of user's twap slice fill.
|
|
757
|
+
*
|
|
758
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
|
|
759
|
+
* @example
|
|
760
|
+
* ```ts
|
|
761
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
762
|
+
*
|
|
763
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
764
|
+
* const client = new hl.PublicClient({ transport });
|
|
765
|
+
*
|
|
766
|
+
* const twapSliceFills = await client.userTwapSliceFills({ user: "0x..." });
|
|
767
|
+
* ```
|
|
768
|
+
*/
|
|
769
|
+
userTwapSliceFills(args, signal) {
|
|
770
|
+
return this.transport.request("info", { type: "userTwapSliceFills", ...args }, signal);
|
|
771
|
+
}
|
|
772
|
+
/**
|
|
773
|
+
* Request user vault deposits.
|
|
774
|
+
* @param args - The parameters for the request.
|
|
775
|
+
* @param signal - An optional abort signal.
|
|
776
|
+
* @returns Array of user's vault deposits.
|
|
777
|
+
*
|
|
778
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
|
|
779
|
+
* @example
|
|
780
|
+
* ```ts
|
|
781
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
782
|
+
*
|
|
783
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
784
|
+
* const client = new hl.PublicClient({ transport });
|
|
785
|
+
*
|
|
786
|
+
* const userVaultEquities = await client.userVaultDeposits({ user: "0x..." });
|
|
787
|
+
* ```
|
|
788
|
+
*/
|
|
789
|
+
userVaultEquities(args, signal) {
|
|
790
|
+
return this.transport.request("info", { type: "userVaultEquities", ...args }, signal);
|
|
791
|
+
}
|
|
792
|
+
/**
|
|
793
|
+
* Request validator summaries.
|
|
794
|
+
* @param args - The parameters for the request.
|
|
795
|
+
* @returns Array of validator summaries.
|
|
796
|
+
*
|
|
797
|
+
* @see null - no documentation
|
|
798
|
+
* @example
|
|
799
|
+
* ```ts
|
|
800
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
801
|
+
*
|
|
802
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
803
|
+
* const client = new hl.PublicClient({ transport });
|
|
804
|
+
*
|
|
805
|
+
* const validatorSummaries = await client.validatorSummaries();
|
|
806
|
+
* ```
|
|
807
|
+
*/
|
|
808
|
+
validatorSummaries(signal) {
|
|
809
|
+
return this.transport.request("info", { type: "validatorSummaries" }, signal);
|
|
810
|
+
}
|
|
811
|
+
/**
|
|
812
|
+
* Request details of a vault.
|
|
813
|
+
* @param args - The parameters for the request.
|
|
814
|
+
* @param signal - An optional abort signal.
|
|
815
|
+
* @returns Details of a vault.
|
|
816
|
+
*
|
|
817
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
|
|
818
|
+
* @example
|
|
819
|
+
* ```ts
|
|
820
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
821
|
+
*
|
|
822
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
823
|
+
* const client = new hl.PublicClient({ transport });
|
|
824
|
+
*
|
|
825
|
+
* const vaultDetails = await client.vaultDetails({ vaultAddress: "0x..." });
|
|
826
|
+
* ```
|
|
827
|
+
*/
|
|
828
|
+
vaultDetails(args, signal) {
|
|
829
|
+
return this.transport.request("info", { type: "vaultDetails", ...args }, signal);
|
|
830
|
+
}
|
|
831
|
+
/**
|
|
832
|
+
* Request a list of vaults less than 2 hours old.
|
|
833
|
+
* @param args - The parameters for the request.
|
|
834
|
+
* @param signal - An optional abort signal.
|
|
835
|
+
* @returns Array of vault summaries.
|
|
836
|
+
*
|
|
837
|
+
* @see null - no documentation
|
|
838
|
+
* @example
|
|
839
|
+
* ```ts
|
|
840
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
841
|
+
*
|
|
842
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
843
|
+
* const client = new hl.PublicClient({ transport });
|
|
844
|
+
*
|
|
845
|
+
* const vaultSummaries = await client.vaultSummaries();
|
|
846
|
+
* ```
|
|
847
|
+
*/
|
|
848
|
+
vaultSummaries(signal) {
|
|
849
|
+
return this.transport.request("info", { type: "vaultSummaries" }, signal);
|
|
850
|
+
}
|
|
851
|
+
// ——————————————— Explorer API ———————————————
|
|
852
|
+
/**
|
|
853
|
+
* Gets the details of a block.
|
|
854
|
+
* @param args - The parameters for the request.
|
|
855
|
+
* @param signal - An optional abort signal.
|
|
856
|
+
* @returns A promise that resolves with the details of the block.
|
|
857
|
+
*
|
|
858
|
+
* @see null - no documentation
|
|
859
|
+
* @example
|
|
860
|
+
* ```ts
|
|
861
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
862
|
+
*
|
|
863
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
864
|
+
* const client = new hl.PublicClient({ transport });
|
|
865
|
+
*
|
|
866
|
+
* const { blockDetails } = await client.blockDetails({ height: 123 });
|
|
867
|
+
* ```
|
|
868
|
+
*/
|
|
869
|
+
blockDetails(args, signal) {
|
|
870
|
+
return this.transport.request("explorer", { type: "blockDetails", ...args }, signal);
|
|
871
|
+
}
|
|
872
|
+
/**
|
|
873
|
+
* Gets the details of a transaction.
|
|
874
|
+
* @param args - The parameters for the request.
|
|
875
|
+
* @param signal - An optional abort signal.
|
|
876
|
+
* @returns A promise that resolves with the details of the transaction.
|
|
877
|
+
*
|
|
878
|
+
* @see null - no documentation
|
|
879
|
+
* @example
|
|
880
|
+
* ```ts
|
|
881
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
882
|
+
*
|
|
883
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
884
|
+
* const client = new hl.PublicClient({ transport });
|
|
885
|
+
*
|
|
886
|
+
* const { tx } = await client.txDetails({ hash: "0x..." });
|
|
887
|
+
* ```
|
|
888
|
+
*/
|
|
889
|
+
txDetails(args, signal) {
|
|
890
|
+
return this.transport.request("explorer", { type: "txDetails", ...args }, signal);
|
|
891
|
+
}
|
|
892
|
+
/**
|
|
893
|
+
* Request user details.
|
|
894
|
+
* @param args - The parameters for the request.
|
|
895
|
+
* @param signal - An optional abort signal.
|
|
896
|
+
* @returns User details.
|
|
897
|
+
*
|
|
898
|
+
* @see null - no documentation
|
|
899
|
+
* @example
|
|
900
|
+
* ```ts
|
|
901
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
902
|
+
*
|
|
903
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
904
|
+
* const client = new hl.PublicClient({ transport });
|
|
905
|
+
*
|
|
906
|
+
* const { txs } = await client.userDetails({ user: "0x..." });
|
|
907
|
+
* ```
|
|
908
|
+
*/
|
|
909
|
+
userDetails(args, signal) {
|
|
910
|
+
return this.transport.request("explorer", { type: "userDetails", ...args }, signal);
|
|
911
|
+
}
|
|
912
|
+
}
|
|
913
|
+
exports.PublicClient = PublicClient;
|
|
914
|
+
});
|