@nktkas/hyperliquid 0.24.2 → 0.25.0-beta.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 (242) hide show
  1. package/README.md +197 -117
  2. package/esm/mod.d.ts +11 -11
  3. package/esm/mod.d.ts.map +1 -1
  4. package/esm/mod.js +1 -1
  5. package/esm/src/clients/exchange.d.ts +29 -18
  6. package/esm/src/clients/exchange.d.ts.map +1 -1
  7. package/esm/src/clients/exchange.js +50 -48
  8. package/esm/src/clients/info.d.ts +79 -75
  9. package/esm/src/clients/info.d.ts.map +1 -1
  10. package/esm/src/clients/info.js +294 -163
  11. package/esm/src/clients/multiSign.d.ts +11 -7
  12. package/esm/src/clients/multiSign.d.ts.map +1 -1
  13. package/esm/src/clients/subscription.d.ts +105 -32
  14. package/esm/src/clients/subscription.d.ts.map +1 -1
  15. package/esm/src/clients/subscription.js +114 -33
  16. package/esm/src/{base.d.ts → errors.d.ts} +1 -1
  17. package/esm/src/errors.d.ts.map +1 -0
  18. package/esm/src/schemas/_base.d.ts +10 -0
  19. package/esm/src/schemas/_base.d.ts.map +1 -0
  20. package/esm/src/schemas/_base.js +12 -0
  21. package/esm/src/schemas/exchange/requests.d.ts +8953 -0
  22. package/esm/src/schemas/exchange/requests.d.ts.map +1 -0
  23. package/esm/src/schemas/exchange/requests.js +1413 -0
  24. package/esm/src/schemas/exchange/responses.d.ts +567 -0
  25. package/esm/src/schemas/exchange/responses.d.ts.map +1 -0
  26. package/esm/src/schemas/exchange/responses.js +243 -0
  27. package/esm/src/schemas/explorer/requests.d.ts +44 -0
  28. package/esm/src/schemas/explorer/requests.d.ts.map +1 -0
  29. package/esm/src/schemas/explorer/requests.js +32 -0
  30. package/esm/src/schemas/explorer/responses.d.ts +360 -0
  31. package/esm/src/schemas/explorer/responses.d.ts.map +1 -0
  32. package/esm/src/schemas/explorer/responses.js +56 -0
  33. package/esm/src/schemas/info/accounts.d.ts +2159 -0
  34. package/esm/src/schemas/info/accounts.d.ts.map +1 -0
  35. package/esm/src/schemas/info/accounts.js +622 -0
  36. package/esm/src/schemas/info/assets.d.ts +945 -0
  37. package/esm/src/schemas/info/assets.d.ts.map +1 -0
  38. package/esm/src/schemas/info/assets.js +265 -0
  39. package/esm/src/schemas/info/markets.d.ts +138 -0
  40. package/esm/src/schemas/info/markets.d.ts.map +1 -0
  41. package/esm/src/schemas/info/markets.js +58 -0
  42. package/esm/src/schemas/info/orders.d.ts +957 -0
  43. package/esm/src/schemas/info/orders.d.ts.map +1 -0
  44. package/esm/src/schemas/info/orders.js +297 -0
  45. package/esm/src/schemas/info/requests.d.ts +882 -0
  46. package/esm/src/schemas/info/requests.d.ts.map +1 -0
  47. package/esm/src/schemas/info/requests.js +655 -0
  48. package/esm/src/schemas/info/validators.d.ts +305 -0
  49. package/esm/src/schemas/info/validators.d.ts.map +1 -0
  50. package/esm/src/schemas/info/validators.js +112 -0
  51. package/esm/src/schemas/info/vaults.d.ts +447 -0
  52. package/esm/src/schemas/info/vaults.d.ts.map +1 -0
  53. package/esm/src/schemas/info/vaults.js +110 -0
  54. package/esm/src/schemas/mod.d.ts +100 -0
  55. package/esm/src/schemas/mod.d.ts.map +1 -0
  56. package/esm/src/schemas/mod.js +113 -0
  57. package/esm/src/schemas/subscriptions/requests.d.ts +332 -0
  58. package/esm/src/schemas/subscriptions/requests.d.ts.map +1 -0
  59. package/esm/src/schemas/subscriptions/requests.js +258 -0
  60. package/esm/src/schemas/subscriptions/responses.d.ts +3643 -0
  61. package/esm/src/schemas/subscriptions/responses.d.ts.map +1 -0
  62. package/esm/src/schemas/subscriptions/responses.js +233 -0
  63. package/esm/src/signing/mod.d.ts +109 -29
  64. package/esm/src/signing/mod.d.ts.map +1 -1
  65. package/esm/src/signing/mod.js +135 -29
  66. package/esm/src/transports/base.d.ts +2 -2
  67. package/esm/src/transports/base.d.ts.map +1 -1
  68. package/esm/src/transports/base.js +2 -2
  69. package/esm/src/transports/http/http_transport.d.ts +2 -1
  70. package/esm/src/transports/http/http_transport.d.ts.map +1 -1
  71. package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts +1 -1
  72. package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
  73. package/esm/src/transports/websocket/websocket_transport.d.ts +2 -1
  74. package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
  75. package/package.json +6 -5
  76. package/script/mod.d.ts +11 -11
  77. package/script/mod.d.ts.map +1 -1
  78. package/script/mod.js +1 -1
  79. package/script/src/clients/exchange.d.ts +29 -18
  80. package/script/src/clients/exchange.d.ts.map +1 -1
  81. package/script/src/clients/exchange.js +56 -54
  82. package/script/src/clients/info.d.ts +79 -75
  83. package/script/src/clients/info.d.ts.map +1 -1
  84. package/script/src/clients/info.js +294 -163
  85. package/script/src/clients/multiSign.d.ts +11 -7
  86. package/script/src/clients/multiSign.d.ts.map +1 -1
  87. package/script/src/clients/subscription.d.ts +105 -32
  88. package/script/src/clients/subscription.d.ts.map +1 -1
  89. package/script/src/clients/subscription.js +114 -33
  90. package/script/src/{base.d.ts → errors.d.ts} +1 -1
  91. package/script/src/errors.d.ts.map +1 -0
  92. package/script/src/schemas/_base.d.ts +10 -0
  93. package/script/src/schemas/_base.d.ts.map +1 -0
  94. package/script/src/schemas/_base.js +48 -0
  95. package/script/src/schemas/exchange/requests.d.ts +8953 -0
  96. package/script/src/schemas/exchange/requests.d.ts.map +1 -0
  97. package/script/src/schemas/exchange/requests.js +1449 -0
  98. package/script/src/schemas/exchange/responses.d.ts +567 -0
  99. package/script/src/schemas/exchange/responses.d.ts.map +1 -0
  100. package/script/src/schemas/exchange/responses.js +279 -0
  101. package/script/src/schemas/explorer/requests.d.ts +44 -0
  102. package/script/src/schemas/explorer/requests.d.ts.map +1 -0
  103. package/script/src/schemas/explorer/requests.js +68 -0
  104. package/script/src/schemas/explorer/responses.d.ts +360 -0
  105. package/script/src/schemas/explorer/responses.d.ts.map +1 -0
  106. package/script/src/schemas/explorer/responses.js +92 -0
  107. package/script/src/schemas/info/accounts.d.ts +2159 -0
  108. package/script/src/schemas/info/accounts.d.ts.map +1 -0
  109. package/script/src/schemas/info/accounts.js +658 -0
  110. package/script/src/schemas/info/assets.d.ts +945 -0
  111. package/script/src/schemas/info/assets.d.ts.map +1 -0
  112. package/script/src/schemas/info/assets.js +301 -0
  113. package/script/src/schemas/info/markets.d.ts +138 -0
  114. package/script/src/schemas/info/markets.d.ts.map +1 -0
  115. package/script/src/schemas/info/markets.js +94 -0
  116. package/script/src/schemas/info/orders.d.ts +957 -0
  117. package/script/src/schemas/info/orders.d.ts.map +1 -0
  118. package/script/src/schemas/info/orders.js +333 -0
  119. package/script/src/schemas/info/requests.d.ts +882 -0
  120. package/script/src/schemas/info/requests.d.ts.map +1 -0
  121. package/script/src/schemas/info/requests.js +692 -0
  122. package/script/src/schemas/info/validators.d.ts +305 -0
  123. package/script/src/schemas/info/validators.d.ts.map +1 -0
  124. package/script/src/schemas/info/validators.js +148 -0
  125. package/script/src/schemas/info/vaults.d.ts +447 -0
  126. package/script/src/schemas/info/vaults.d.ts.map +1 -0
  127. package/script/src/schemas/info/vaults.js +146 -0
  128. package/script/src/schemas/mod.d.ts +100 -0
  129. package/script/src/schemas/mod.d.ts.map +1 -0
  130. package/script/src/schemas/mod.js +154 -0
  131. package/script/src/schemas/subscriptions/requests.d.ts +332 -0
  132. package/script/src/schemas/subscriptions/requests.d.ts.map +1 -0
  133. package/script/src/schemas/subscriptions/requests.js +294 -0
  134. package/script/src/schemas/subscriptions/responses.d.ts +3643 -0
  135. package/script/src/schemas/subscriptions/responses.d.ts.map +1 -0
  136. package/script/src/schemas/subscriptions/responses.js +269 -0
  137. package/script/src/signing/mod.d.ts +109 -29
  138. package/script/src/signing/mod.d.ts.map +1 -1
  139. package/script/src/signing/mod.js +137 -33
  140. package/script/src/transports/base.d.ts +2 -2
  141. package/script/src/transports/base.d.ts.map +1 -1
  142. package/script/src/transports/base.js +3 -3
  143. package/script/src/transports/http/http_transport.d.ts +2 -1
  144. package/script/src/transports/http/http_transport.d.ts.map +1 -1
  145. package/script/src/transports/websocket/_hyperliquid_event_target.d.ts +1 -1
  146. package/script/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
  147. package/script/src/transports/websocket/websocket_transport.d.ts +2 -1
  148. package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
  149. package/esm/src/base.d.ts.map +0 -1
  150. package/esm/src/signing/_sorter.d.ts +0 -127
  151. package/esm/src/signing/_sorter.d.ts.map +0 -1
  152. package/esm/src/signing/_sorter.js +0 -693
  153. package/esm/src/types/exchange/requests.d.ts +0 -1345
  154. package/esm/src/types/exchange/requests.d.ts.map +0 -1
  155. package/esm/src/types/exchange/requests.js +0 -1
  156. package/esm/src/types/exchange/responses.d.ts +0 -233
  157. package/esm/src/types/exchange/responses.d.ts.map +0 -1
  158. package/esm/src/types/exchange/responses.js +0 -1
  159. package/esm/src/types/explorer/requests.d.ts +0 -32
  160. package/esm/src/types/explorer/requests.d.ts.map +0 -1
  161. package/esm/src/types/explorer/requests.js +0 -1
  162. package/esm/src/types/explorer/responses.d.ts +0 -58
  163. package/esm/src/types/explorer/responses.d.ts.map +0 -1
  164. package/esm/src/types/explorer/responses.js +0 -1
  165. package/esm/src/types/info/accounts.d.ts +0 -864
  166. package/esm/src/types/info/accounts.d.ts.map +0 -1
  167. package/esm/src/types/info/accounts.js +0 -1
  168. package/esm/src/types/info/assets.d.ts +0 -354
  169. package/esm/src/types/info/assets.d.ts.map +0 -1
  170. package/esm/src/types/info/assets.js +0 -1
  171. package/esm/src/types/info/markets.d.ts +0 -79
  172. package/esm/src/types/info/markets.d.ts.map +0 -1
  173. package/esm/src/types/info/markets.js +0 -1
  174. package/esm/src/types/info/orders.d.ts +0 -266
  175. package/esm/src/types/info/orders.d.ts.map +0 -1
  176. package/esm/src/types/info/orders.js +0 -1
  177. package/esm/src/types/info/requests.d.ts +0 -634
  178. package/esm/src/types/info/requests.d.ts.map +0 -1
  179. package/esm/src/types/info/requests.js +0 -1
  180. package/esm/src/types/info/validators.d.ts +0 -147
  181. package/esm/src/types/info/validators.d.ts.map +0 -1
  182. package/esm/src/types/info/validators.js +0 -1
  183. package/esm/src/types/info/vaults.d.ts +0 -119
  184. package/esm/src/types/info/vaults.d.ts.map +0 -1
  185. package/esm/src/types/info/vaults.js +0 -1
  186. package/esm/src/types/mod.d.ts +0 -38
  187. package/esm/src/types/mod.d.ts.map +0 -1
  188. package/esm/src/types/mod.js +0 -24
  189. package/esm/src/types/subscriptions/requests.d.ts +0 -143
  190. package/esm/src/types/subscriptions/requests.d.ts.map +0 -1
  191. package/esm/src/types/subscriptions/requests.js +0 -1
  192. package/esm/src/types/subscriptions/responses.d.ts +0 -213
  193. package/esm/src/types/subscriptions/responses.d.ts.map +0 -1
  194. package/esm/src/types/subscriptions/responses.js +0 -1
  195. package/script/src/base.d.ts.map +0 -1
  196. package/script/src/signing/_sorter.d.ts +0 -127
  197. package/script/src/signing/_sorter.d.ts.map +0 -1
  198. package/script/src/signing/_sorter.js +0 -696
  199. package/script/src/types/exchange/requests.d.ts +0 -1345
  200. package/script/src/types/exchange/requests.d.ts.map +0 -1
  201. package/script/src/types/exchange/requests.js +0 -2
  202. package/script/src/types/exchange/responses.d.ts +0 -233
  203. package/script/src/types/exchange/responses.d.ts.map +0 -1
  204. package/script/src/types/exchange/responses.js +0 -2
  205. package/script/src/types/explorer/requests.d.ts +0 -32
  206. package/script/src/types/explorer/requests.d.ts.map +0 -1
  207. package/script/src/types/explorer/requests.js +0 -2
  208. package/script/src/types/explorer/responses.d.ts +0 -58
  209. package/script/src/types/explorer/responses.d.ts.map +0 -1
  210. package/script/src/types/explorer/responses.js +0 -2
  211. package/script/src/types/info/accounts.d.ts +0 -864
  212. package/script/src/types/info/accounts.d.ts.map +0 -1
  213. package/script/src/types/info/accounts.js +0 -2
  214. package/script/src/types/info/assets.d.ts +0 -354
  215. package/script/src/types/info/assets.d.ts.map +0 -1
  216. package/script/src/types/info/assets.js +0 -2
  217. package/script/src/types/info/markets.d.ts +0 -79
  218. package/script/src/types/info/markets.d.ts.map +0 -1
  219. package/script/src/types/info/markets.js +0 -2
  220. package/script/src/types/info/orders.d.ts +0 -266
  221. package/script/src/types/info/orders.d.ts.map +0 -1
  222. package/script/src/types/info/orders.js +0 -2
  223. package/script/src/types/info/requests.d.ts +0 -634
  224. package/script/src/types/info/requests.d.ts.map +0 -1
  225. package/script/src/types/info/requests.js +0 -2
  226. package/script/src/types/info/validators.d.ts +0 -147
  227. package/script/src/types/info/validators.d.ts.map +0 -1
  228. package/script/src/types/info/validators.js +0 -2
  229. package/script/src/types/info/vaults.d.ts +0 -119
  230. package/script/src/types/info/vaults.d.ts.map +0 -1
  231. package/script/src/types/info/vaults.js +0 -2
  232. package/script/src/types/mod.d.ts +0 -38
  233. package/script/src/types/mod.d.ts.map +0 -1
  234. package/script/src/types/mod.js +0 -25
  235. package/script/src/types/subscriptions/requests.d.ts +0 -143
  236. package/script/src/types/subscriptions/requests.d.ts.map +0 -1
  237. package/script/src/types/subscriptions/requests.js +0 -2
  238. package/script/src/types/subscriptions/responses.d.ts +0 -213
  239. package/script/src/types/subscriptions/responses.d.ts.map +0 -1
  240. package/script/src/types/subscriptions/responses.js +0 -2
  241. /package/esm/src/{base.js → errors.js} +0 -0
  242. /package/script/src/{base.js → errors.js} +0 -0
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.InfoClient = void 0;
4
+ const mod_js_1 = require("../schemas/mod.js");
4
5
  /**
5
6
  * Info client for interacting with the Hyperliquid API.
6
7
  * @typeParam T The type of transport used to connect to the Hyperliquid API.
@@ -15,7 +16,7 @@ class InfoClient {
15
16
  * ```ts
16
17
  * import * as hl from "@nktkas/hyperliquid";
17
18
  *
18
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
19
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
19
20
  * const infoClient = new hl.InfoClient({ transport });
20
21
  * ```
21
22
  */
@@ -35,20 +36,26 @@ class InfoClient {
35
36
  * ```ts
36
37
  * import * as hl from "@nktkas/hyperliquid";
37
38
  *
38
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
39
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
39
40
  * const infoClient = new hl.InfoClient({ transport });
40
41
  *
41
42
  * const data = await infoClient.activeAssetData({ user: "0x...", coin: "ETH" });
42
43
  * ```
43
44
  */
44
45
  activeAssetData(params, signal) {
45
- const request = { type: "activeAssetData", ...params };
46
+ const request = (0, mod_js_1.parser)(mod_js_1.ActiveAssetDataRequest)({
47
+ type: "activeAssetData",
48
+ ...params,
49
+ });
46
50
  return this.transport.request("info", request, signal);
47
51
  }
48
52
  allMids(params_or_signal, maybeSignal) {
49
53
  const params = params_or_signal instanceof AbortSignal ? {} : params_or_signal;
50
54
  const signal = params_or_signal instanceof AbortSignal ? params_or_signal : maybeSignal;
51
- const request = { type: "allMids", ...params };
55
+ const request = (0, mod_js_1.parser)(mod_js_1.AllMidsRequest)({
56
+ type: "allMids",
57
+ ...params,
58
+ });
52
59
  return this.transport.request("info", request, signal);
53
60
  }
54
61
  /**
@@ -71,7 +78,10 @@ class InfoClient {
71
78
  * ```
72
79
  */
73
80
  blockDetails(params, signal) {
74
- const request = { type: "blockDetails", ...params };
81
+ const request = (0, mod_js_1.parser)(mod_js_1.BlockDetailsRequest)({
82
+ type: "blockDetails",
83
+ ...params,
84
+ });
75
85
  return this.transport.request("explorer", request, signal)
76
86
  .then(({ blockDetails }) => blockDetails);
77
87
  }
@@ -88,7 +98,7 @@ class InfoClient {
88
98
  * ```ts
89
99
  * import * as hl from "@nktkas/hyperliquid";
90
100
  *
91
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
101
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
92
102
  * const infoClient = new hl.InfoClient({ transport });
93
103
  *
94
104
  * const data = await infoClient.candleSnapshot({
@@ -99,7 +109,10 @@ class InfoClient {
99
109
  * ```
100
110
  */
101
111
  candleSnapshot(params, signal) {
102
- const request = { type: "candleSnapshot", req: params };
112
+ const request = (0, mod_js_1.parser)(mod_js_1.CandleSnapshotRequest)({
113
+ type: "candleSnapshot",
114
+ req: params,
115
+ });
103
116
  return this.transport.request("info", request, signal);
104
117
  }
105
118
  /**
@@ -115,14 +128,17 @@ class InfoClient {
115
128
  * ```ts
116
129
  * import * as hl from "@nktkas/hyperliquid";
117
130
  *
118
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
131
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
119
132
  * const infoClient = new hl.InfoClient({ transport });
120
133
  *
121
134
  * const data = await infoClient.clearinghouseState({ user: "0x..." });
122
135
  * ```
123
136
  */
124
137
  clearinghouseState(params, signal) {
125
- const request = { type: "clearinghouseState", ...params };
138
+ const request = (0, mod_js_1.parser)(mod_js_1.ClearinghouseStateRequest)({
139
+ type: "clearinghouseState",
140
+ ...params,
141
+ });
126
142
  return this.transport.request("info", request, signal);
127
143
  }
128
144
  /**
@@ -138,14 +154,17 @@ class InfoClient {
138
154
  * ```ts
139
155
  * import * as hl from "@nktkas/hyperliquid";
140
156
  *
141
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
157
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
142
158
  * const infoClient = new hl.InfoClient({ transport });
143
159
  *
144
160
  * const data = await infoClient.delegations({ user: "0x..." });
145
161
  * ```
146
162
  */
147
163
  delegations(params, signal) {
148
- const request = { type: "delegations", ...params };
164
+ const request = (0, mod_js_1.parser)(mod_js_1.DelegationsRequest)({
165
+ type: "delegations",
166
+ ...params,
167
+ });
149
168
  return this.transport.request("info", request, signal);
150
169
  }
151
170
  /**
@@ -161,14 +180,17 @@ class InfoClient {
161
180
  * ```ts
162
181
  * import * as hl from "@nktkas/hyperliquid";
163
182
  *
164
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
183
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
165
184
  * const infoClient = new hl.InfoClient({ transport });
166
185
  *
167
186
  * const data = await infoClient.delegatorHistory({ user: "0x..." });
168
187
  * ```
169
188
  */
170
189
  delegatorHistory(params, signal) {
171
- const request = { type: "delegatorHistory", ...params };
190
+ const request = (0, mod_js_1.parser)(mod_js_1.DelegatorHistoryRequest)({
191
+ type: "delegatorHistory",
192
+ ...params,
193
+ });
172
194
  return this.transport.request("info", request, signal);
173
195
  }
174
196
  /**
@@ -184,14 +206,17 @@ class InfoClient {
184
206
  * ```ts
185
207
  * import * as hl from "@nktkas/hyperliquid";
186
208
  *
187
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
209
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
188
210
  * const infoClient = new hl.InfoClient({ transport });
189
211
  *
190
212
  * const data = await infoClient.delegatorRewards({ user: "0x..." });
191
213
  * ```
192
214
  */
193
215
  delegatorRewards(params, signal) {
194
- const request = { type: "delegatorRewards", ...params };
216
+ const request = (0, mod_js_1.parser)(mod_js_1.DelegatorRewardsRequest)({
217
+ type: "delegatorRewards",
218
+ ...params,
219
+ });
195
220
  return this.transport.request("info", request, signal);
196
221
  }
197
222
  /**
@@ -207,14 +232,17 @@ class InfoClient {
207
232
  * ```ts
208
233
  * import * as hl from "@nktkas/hyperliquid";
209
234
  *
210
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
235
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
211
236
  * const infoClient = new hl.InfoClient({ transport });
212
237
  *
213
238
  * const data = await infoClient.delegatorSummary({ user: "0x..." });
214
239
  * ```
215
240
  */
216
241
  delegatorSummary(params, signal) {
217
- const request = { type: "delegatorSummary", ...params };
242
+ const request = (0, mod_js_1.parser)(mod_js_1.DelegatorSummaryRequest)({
243
+ type: "delegatorSummary",
244
+ ...params,
245
+ });
218
246
  return this.transport.request("info", request, signal);
219
247
  }
220
248
  /**
@@ -229,14 +257,16 @@ class InfoClient {
229
257
  * ```ts
230
258
  * import * as hl from "@nktkas/hyperliquid";
231
259
  *
232
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
260
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
233
261
  * const infoClient = new hl.InfoClient({ transport });
234
262
  *
235
263
  * const data = await infoClient.exchangeStatus();
236
264
  * ```
237
265
  */
238
266
  exchangeStatus(signal) {
239
- const request = { type: "exchangeStatus" };
267
+ const request = (0, mod_js_1.parser)(mod_js_1.ExchangeStatusRequest)({
268
+ type: "exchangeStatus",
269
+ });
240
270
  return this.transport.request("info", request, signal);
241
271
  }
242
272
  /**
@@ -252,14 +282,17 @@ class InfoClient {
252
282
  * ```ts
253
283
  * import * as hl from "@nktkas/hyperliquid";
254
284
  *
255
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
285
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
256
286
  * const infoClient = new hl.InfoClient({ transport });
257
287
  *
258
288
  * const data = await infoClient.extraAgents({ user: "0x..." });
259
289
  * ```
260
290
  */
261
291
  extraAgents(params, signal) {
262
- const request = { type: "extraAgents", ...params };
292
+ const request = (0, mod_js_1.parser)(mod_js_1.ExtraAgentsRequest)({
293
+ type: "extraAgents",
294
+ ...params,
295
+ });
263
296
  return this.transport.request("info", request, signal);
264
297
  }
265
298
  /**
@@ -275,14 +308,17 @@ class InfoClient {
275
308
  * ```ts
276
309
  * import * as hl from "@nktkas/hyperliquid";
277
310
  *
278
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
311
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
279
312
  * const infoClient = new hl.InfoClient({ transport });
280
313
  *
281
314
  * const data = await infoClient.frontendOpenOrders({ user: "0x..." });
282
315
  * ```
283
316
  */
284
317
  frontendOpenOrders(params, signal) {
285
- const request = { type: "frontendOpenOrders", ...params };
318
+ const request = (0, mod_js_1.parser)(mod_js_1.FrontendOpenOrdersRequest)({
319
+ type: "frontendOpenOrders",
320
+ ...params,
321
+ });
286
322
  return this.transport.request("info", request, signal);
287
323
  }
288
324
  /**
@@ -298,7 +334,7 @@ class InfoClient {
298
334
  * ```ts
299
335
  * import * as hl from "@nktkas/hyperliquid";
300
336
  *
301
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
337
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
302
338
  * const infoClient = new hl.InfoClient({ transport });
303
339
  *
304
340
  * const data = await infoClient.fundingHistory({
@@ -308,7 +344,10 @@ class InfoClient {
308
344
  * ```
309
345
  */
310
346
  fundingHistory(params, signal) {
311
- const request = { type: "fundingHistory", ...params };
347
+ const request = (0, mod_js_1.parser)(mod_js_1.FundingHistoryRequest)({
348
+ type: "fundingHistory",
349
+ ...params,
350
+ });
312
351
  return this.transport.request("info", request, signal);
313
352
  }
314
353
  /**
@@ -324,14 +363,17 @@ class InfoClient {
324
363
  * ```ts
325
364
  * import * as hl from "@nktkas/hyperliquid";
326
365
  *
327
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
366
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
328
367
  * const infoClient = new hl.InfoClient({ transport });
329
368
  *
330
369
  * const data = await infoClient.historicalOrders({ user: "0x..." });
331
370
  * ```
332
371
  */
333
372
  historicalOrders(params, signal) {
334
- const request = { type: "historicalOrders", ...params };
373
+ const request = (0, mod_js_1.parser)(mod_js_1.HistoricalOrdersRequest)({
374
+ type: "historicalOrders",
375
+ ...params,
376
+ });
335
377
  return this.transport.request("info", request, signal);
336
378
  }
337
379
  /**
@@ -347,14 +389,17 @@ class InfoClient {
347
389
  * ```ts
348
390
  * import * as hl from "@nktkas/hyperliquid";
349
391
  *
350
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
392
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
351
393
  * const infoClient = new hl.InfoClient({ transport });
352
394
  *
353
395
  * const data = await infoClient.isVip({ user: "0x..." });
354
396
  * ```
355
397
  */
356
398
  isVip(params, signal) {
357
- const request = { type: "isVip", ...params };
399
+ const request = (0, mod_js_1.parser)(mod_js_1.IsVipRequest)({
400
+ type: "isVip",
401
+ ...params,
402
+ });
358
403
  return this.transport.request("info", request, signal);
359
404
  }
360
405
  /**
@@ -370,14 +415,17 @@ class InfoClient {
370
415
  * ```ts
371
416
  * import * as hl from "@nktkas/hyperliquid";
372
417
  *
373
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
418
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
374
419
  * const infoClient = new hl.InfoClient({ transport });
375
420
  *
376
421
  * const data = await infoClient.l2Book({ coin: "ETH", nSigFigs: 2 });
377
422
  * ```
378
423
  */
379
424
  l2Book(params, signal) {
380
- const request = { type: "l2Book", ...params };
425
+ const request = (0, mod_js_1.parser)(mod_js_1.L2BookRequest)({
426
+ type: "l2Book",
427
+ ...params,
428
+ });
381
429
  return this.transport.request("info", request, signal);
382
430
  }
383
431
  /**
@@ -393,14 +441,17 @@ class InfoClient {
393
441
  * ```ts
394
442
  * import * as hl from "@nktkas/hyperliquid";
395
443
  *
396
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
444
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
397
445
  * const infoClient = new hl.InfoClient({ transport });
398
446
  *
399
447
  * const data = await infoClient.leadingVaults({ user: "0x..." });
400
448
  * ```
401
449
  */
402
450
  leadingVaults(params, signal) {
403
- const request = { type: "leadingVaults", ...params };
451
+ const request = (0, mod_js_1.parser)(mod_js_1.LeadingVaultsRequest)({
452
+ type: "leadingVaults",
453
+ ...params,
454
+ });
404
455
  return this.transport.request("info", request, signal);
405
456
  }
406
457
  /**
@@ -416,14 +467,17 @@ class InfoClient {
416
467
  * ```ts
417
468
  * import * as hl from "@nktkas/hyperliquid";
418
469
  *
419
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
470
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
420
471
  * const infoClient = new hl.InfoClient({ transport });
421
472
  *
422
473
  * const data = await infoClient.legalCheck({ user: "0x..." });
423
474
  * ```
424
475
  */
425
476
  legalCheck(params, signal) {
426
- const request = { type: "legalCheck", ...params };
477
+ const request = (0, mod_js_1.parser)(mod_js_1.LegalCheckRequest)({
478
+ type: "legalCheck",
479
+ ...params,
480
+ });
427
481
  return this.transport.request("info", request, signal);
428
482
  }
429
483
  /**
@@ -438,14 +492,16 @@ class InfoClient {
438
492
  * ```ts
439
493
  * import * as hl from "@nktkas/hyperliquid";
440
494
  *
441
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
495
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
442
496
  * const infoClient = new hl.InfoClient({ transport });
443
497
  *
444
498
  * const data = await infoClient.liquidatable();
445
499
  * ```
446
500
  */
447
501
  liquidatable(signal) {
448
- const request = { type: "liquidatable" };
502
+ const request = (0, mod_js_1.parser)(mod_js_1.LiquidatableRequest)({
503
+ type: "liquidatable",
504
+ });
449
505
  return this.transport.request("info", request, signal);
450
506
  }
451
507
  /**
@@ -461,14 +517,17 @@ class InfoClient {
461
517
  * ```ts
462
518
  * import * as hl from "@nktkas/hyperliquid";
463
519
  *
464
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
520
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
465
521
  * const infoClient = new hl.InfoClient({ transport });
466
522
  *
467
523
  * const data = await infoClient.marginTable({ id: 1 });
468
524
  * ```
469
525
  */
470
526
  marginTable(params, signal) {
471
- const request = { type: "marginTable", ...params };
527
+ const request = (0, mod_js_1.parser)(mod_js_1.MarginTableRequest)({
528
+ type: "marginTable",
529
+ ...params,
530
+ });
472
531
  return this.transport.request("info", request, signal);
473
532
  }
474
533
  /**
@@ -484,14 +543,17 @@ class InfoClient {
484
543
  * ```ts
485
544
  * import * as hl from "@nktkas/hyperliquid";
486
545
  *
487
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
546
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
488
547
  * const infoClient = new hl.InfoClient({ transport });
489
548
  *
490
549
  * const data = await infoClient.maxBuilderFee({ user: "0x...", builder: "0x..." });
491
550
  * ```
492
551
  */
493
552
  maxBuilderFee(params, signal) {
494
- const request = { type: "maxBuilderFee", ...params };
553
+ const request = (0, mod_js_1.parser)(mod_js_1.MaxBuilderFeeRequest)({
554
+ type: "maxBuilderFee",
555
+ ...params,
556
+ });
495
557
  return this.transport.request("info", request, signal);
496
558
  }
497
559
  /**
@@ -506,42 +568,34 @@ class InfoClient {
506
568
  * ```ts
507
569
  * import * as hl from "@nktkas/hyperliquid";
508
570
  *
509
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
571
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
510
572
  * const infoClient = new hl.InfoClient({ transport });
511
573
  *
512
574
  * const data = await infoClient.maxMarketOrderNtls();
513
575
  * ```
514
576
  */
515
577
  maxMarketOrderNtls(signal) {
516
- const request = { type: "maxMarketOrderNtls" };
578
+ const request = (0, mod_js_1.parser)(mod_js_1.MaxMarketOrderNtlsRequest)({
579
+ type: "maxMarketOrderNtls",
580
+ });
517
581
  return this.transport.request("info", request, signal);
518
582
  }
519
583
  meta(params_or_signal, maybeSignal) {
520
584
  const params = params_or_signal instanceof AbortSignal ? {} : params_or_signal;
521
585
  const signal = params_or_signal instanceof AbortSignal ? params_or_signal : maybeSignal;
522
- const request = { type: "meta", ...params };
586
+ const request = (0, mod_js_1.parser)(mod_js_1.MetaRequest)({
587
+ type: "meta",
588
+ ...params,
589
+ });
523
590
  return this.transport.request("info", request, signal);
524
591
  }
525
- /**
526
- * Request metadata and asset contexts.
527
- * @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
528
- * @returns Metadata and context for perpetual assets.
529
- *
530
- * @throws {TransportError} When the transport layer throws an error.
531
- *
532
- * @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
533
- * @example
534
- * ```ts
535
- * import * as hl from "@nktkas/hyperliquid";
536
- *
537
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
538
- * const infoClient = new hl.InfoClient({ transport });
539
- *
540
- * const data = await infoClient.metaAndAssetCtxs();
541
- * ```
542
- */
543
- metaAndAssetCtxs(signal) {
544
- const request = { type: "metaAndAssetCtxs" };
592
+ metaAndAssetCtxs(params_or_signal, maybeSignal) {
593
+ const params = params_or_signal instanceof AbortSignal ? {} : params_or_signal;
594
+ const signal = params_or_signal instanceof AbortSignal ? params_or_signal : maybeSignal;
595
+ const request = (0, mod_js_1.parser)(mod_js_1.MetaAndAssetCtxsRequest)({
596
+ type: "metaAndAssetCtxs",
597
+ ...params,
598
+ });
545
599
  return this.transport.request("info", request, signal);
546
600
  }
547
601
  /**
@@ -557,14 +611,17 @@ class InfoClient {
557
611
  * ```ts
558
612
  * import * as hl from "@nktkas/hyperliquid";
559
613
  *
560
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
614
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
561
615
  * const infoClient = new hl.InfoClient({ transport });
562
616
  *
563
617
  * const data = await infoClient.openOrders({ user: "0x..." });
564
618
  * ```
565
619
  */
566
620
  openOrders(params, signal) {
567
- const request = { type: "openOrders", ...params };
621
+ const request = (0, mod_js_1.parser)(mod_js_1.OpenOrdersRequest)({
622
+ type: "openOrders",
623
+ ...params,
624
+ });
568
625
  return this.transport.request("info", request, signal);
569
626
  }
570
627
  /**
@@ -580,14 +637,17 @@ class InfoClient {
580
637
  * ```ts
581
638
  * import * as hl from "@nktkas/hyperliquid";
582
639
  *
583
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
640
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
584
641
  * const infoClient = new hl.InfoClient({ transport });
585
642
  *
586
643
  * const data = await infoClient.orderStatus({ user: "0x...", oid: 12345 });
587
644
  * ```
588
645
  */
589
646
  orderStatus(params, signal) {
590
- const request = { type: "orderStatus", ...params };
647
+ const request = (0, mod_js_1.parser)(mod_js_1.OrderStatusRequest)({
648
+ type: "orderStatus",
649
+ ...params,
650
+ });
591
651
  return this.transport.request("info", request, signal);
592
652
  }
593
653
  /**
@@ -602,14 +662,16 @@ class InfoClient {
602
662
  * ```ts
603
663
  * import * as hl from "@nktkas/hyperliquid";
604
664
  *
605
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
665
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
606
666
  * const infoClient = new hl.InfoClient({ transport });
607
667
  *
608
668
  * const data = await infoClient.perpDeployAuctionStatus();
609
669
  * ```
610
670
  */
611
671
  perpDeployAuctionStatus(signal) {
612
- const request = { type: "perpDeployAuctionStatus" };
672
+ const request = (0, mod_js_1.parser)(mod_js_1.PerpDeployAuctionStatusRequest)({
673
+ type: "perpDeployAuctionStatus",
674
+ });
613
675
  return this.transport.request("info", request, signal);
614
676
  }
615
677
  /**
@@ -624,36 +686,25 @@ class InfoClient {
624
686
  * ```ts
625
687
  * import * as hl from "@nktkas/hyperliquid";
626
688
  *
627
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
689
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
628
690
  * const infoClient = new hl.InfoClient({ transport });
629
691
  *
630
692
  * const data = await infoClient.perpDexs();
631
693
  * ```
632
694
  */
633
695
  perpDexs(signal) {
634
- const request = { type: "perpDexs" };
696
+ const request = (0, mod_js_1.parser)(mod_js_1.PerpDexsRequest)({
697
+ type: "perpDexs",
698
+ });
635
699
  return this.transport.request("info", request, signal);
636
700
  }
637
- /**
638
- * Request perpetuals at open interest cap.
639
- * @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
640
- * @returns Array of perpetuals at open interest caps.
641
- *
642
- * @throws {TransportError} When the transport layer throws an error.
643
- *
644
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
645
- * @example
646
- * ```ts
647
- * import * as hl from "@nktkas/hyperliquid";
648
- *
649
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
650
- * const infoClient = new hl.InfoClient({ transport });
651
- *
652
- * const data = await infoClient.perpsAtOpenInterestCap();
653
- * ```
654
- */
655
- perpsAtOpenInterestCap(signal) {
656
- const request = { type: "perpsAtOpenInterestCap" };
701
+ perpsAtOpenInterestCap(params_or_signal, maybeSignal) {
702
+ const params = params_or_signal instanceof AbortSignal ? {} : params_or_signal;
703
+ const signal = params_or_signal instanceof AbortSignal ? params_or_signal : maybeSignal;
704
+ const request = (0, mod_js_1.parser)(mod_js_1.PerpsAtOpenInterestCapRequest)({
705
+ type: "perpsAtOpenInterestCap",
706
+ ...params,
707
+ });
657
708
  return this.transport.request("info", request, signal);
658
709
  }
659
710
  /**
@@ -669,14 +720,17 @@ class InfoClient {
669
720
  * ```ts
670
721
  * import * as hl from "@nktkas/hyperliquid";
671
722
  *
672
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
723
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
673
724
  * const infoClient = new hl.InfoClient({ transport });
674
725
  *
675
726
  * const data = await infoClient.portfolio({ user: "0x..." });
676
727
  * ```
677
728
  */
678
729
  portfolio(params, signal) {
679
- const request = { type: "portfolio", ...params };
730
+ const request = (0, mod_js_1.parser)(mod_js_1.PortfolioRequest)({
731
+ type: "portfolio",
732
+ ...params,
733
+ });
680
734
  return this.transport.request("info", request, signal);
681
735
  }
682
736
  /**
@@ -691,14 +745,16 @@ class InfoClient {
691
745
  * ```ts
692
746
  * import * as hl from "@nktkas/hyperliquid";
693
747
  *
694
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
748
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
695
749
  * const infoClient = new hl.InfoClient({ transport });
696
750
  *
697
751
  * const data = await infoClient.predictedFundings();
698
752
  * ```
699
753
  */
700
754
  predictedFundings(signal) {
701
- const request = { type: "predictedFundings" };
755
+ const request = (0, mod_js_1.parser)(mod_js_1.PredictedFundingsRequest)({
756
+ type: "predictedFundings",
757
+ });
702
758
  return this.transport.request("info", request, signal);
703
759
  }
704
760
  /**
@@ -714,14 +770,17 @@ class InfoClient {
714
770
  * ```ts
715
771
  * import * as hl from "@nktkas/hyperliquid";
716
772
  *
717
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
773
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
718
774
  * const infoClient = new hl.InfoClient({ transport });
719
775
  *
720
776
  * const data = await infoClient.preTransferCheck({ user: "0x...", source: "0x..." });
721
777
  * ```
722
778
  */
723
779
  preTransferCheck(params, signal) {
724
- const request = { type: "preTransferCheck", ...params };
780
+ const request = (0, mod_js_1.parser)(mod_js_1.PreTransferCheckRequest)({
781
+ type: "preTransferCheck",
782
+ ...params,
783
+ });
725
784
  return this.transport.request("info", request, signal);
726
785
  }
727
786
  /**
@@ -737,14 +796,17 @@ class InfoClient {
737
796
  * ```ts
738
797
  * import * as hl from "@nktkas/hyperliquid";
739
798
  *
740
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
799
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
741
800
  * const infoClient = new hl.InfoClient({ transport });
742
801
  *
743
802
  * const data = await infoClient.referral({ user: "0x..." });
744
803
  * ```
745
804
  */
746
805
  referral(params, signal) {
747
- const request = { type: "referral", ...params };
806
+ const request = (0, mod_js_1.parser)(mod_js_1.ReferralRequest)({
807
+ type: "referral",
808
+ ...params,
809
+ });
748
810
  return this.transport.request("info", request, signal);
749
811
  }
750
812
  /**
@@ -760,14 +822,17 @@ class InfoClient {
760
822
  * ```ts
761
823
  * import * as hl from "@nktkas/hyperliquid";
762
824
  *
763
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
825
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
764
826
  * const infoClient = new hl.InfoClient({ transport });
765
827
  *
766
828
  * const data = await infoClient.spotClearinghouseState({ user: "0x..." });
767
829
  * ```
768
830
  */
769
831
  spotClearinghouseState(params, signal) {
770
- const request = { type: "spotClearinghouseState", ...params };
832
+ const request = (0, mod_js_1.parser)(mod_js_1.SpotClearinghouseStateRequest)({
833
+ type: "spotClearinghouseState",
834
+ ...params,
835
+ });
771
836
  return this.transport.request("info", request, signal);
772
837
  }
773
838
  /**
@@ -783,80 +848,89 @@ class InfoClient {
783
848
  * ```ts
784
849
  * import * as hl from "@nktkas/hyperliquid";
785
850
  *
786
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
851
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
787
852
  * const infoClient = new hl.InfoClient({ transport });
788
853
  *
789
854
  * const data = await infoClient.spotDeployState({ user: "0x..." });
790
855
  * ```
791
856
  */
792
857
  spotDeployState(params, signal) {
793
- const request = { type: "spotDeployState", ...params };
858
+ const request = (0, mod_js_1.parser)(mod_js_1.SpotDeployStateRequest)({
859
+ type: "spotDeployState",
860
+ ...params,
861
+ });
794
862
  return this.transport.request("info", request, signal);
795
863
  }
796
864
  /**
797
- * Request for the status of the spot deploy auction.
865
+ * Request spot trading metadata.
798
866
  * @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
799
- * @returns Status of the spot deploy auction.
867
+ * @returns Metadata for spot assets.
800
868
  *
801
869
  * @throws {TransportError} When the transport layer throws an error.
802
870
  *
803
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-pair-deploy-auction
871
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
804
872
  * @example
805
873
  * ```ts
806
874
  * import * as hl from "@nktkas/hyperliquid";
807
875
  *
808
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
876
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
809
877
  * const infoClient = new hl.InfoClient({ transport });
810
878
  *
811
- * const data = await infoClient.spotPairDeployAuctionStatus();
879
+ * const data = await infoClient.spotMeta();
812
880
  * ```
813
881
  */
814
- spotPairDeployAuctionStatus(signal) {
815
- const request = { type: "spotPairDeployAuctionStatus" };
882
+ spotMeta(signal) {
883
+ const request = (0, mod_js_1.parser)(mod_js_1.SpotMetaRequest)({
884
+ type: "spotMeta",
885
+ });
816
886
  return this.transport.request("info", request, signal);
817
887
  }
818
888
  /**
819
- * Request spot trading metadata.
889
+ * Request spot metadata and asset contexts.
820
890
  * @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
821
- * @returns Metadata for spot assets.
891
+ * @returns Metadata and context for spot assets.
822
892
  *
823
893
  * @throws {TransportError} When the transport layer throws an error.
824
894
  *
825
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
895
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
826
896
  * @example
827
897
  * ```ts
828
898
  * import * as hl from "@nktkas/hyperliquid";
829
899
  *
830
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
900
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
831
901
  * const infoClient = new hl.InfoClient({ transport });
832
902
  *
833
- * const data = await infoClient.spotMeta();
903
+ * const data = await infoClient.spotMetaAndAssetCtxs();
834
904
  * ```
835
905
  */
836
- spotMeta(signal) {
837
- const request = { type: "spotMeta" };
906
+ spotMetaAndAssetCtxs(signal) {
907
+ const request = (0, mod_js_1.parser)(mod_js_1.SpotMetaAndAssetCtxsRequest)({
908
+ type: "spotMetaAndAssetCtxs",
909
+ });
838
910
  return this.transport.request("info", request, signal);
839
911
  }
840
912
  /**
841
- * Request spot metadata and asset contexts.
913
+ * Request for the status of the spot deploy auction.
842
914
  * @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
843
- * @returns Metadata and context for spot assets.
915
+ * @returns Status of the spot deploy auction.
844
916
  *
845
917
  * @throws {TransportError} When the transport layer throws an error.
846
918
  *
847
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
919
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-pair-deploy-auction
848
920
  * @example
849
921
  * ```ts
850
922
  * import * as hl from "@nktkas/hyperliquid";
851
923
  *
852
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
924
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
853
925
  * const infoClient = new hl.InfoClient({ transport });
854
926
  *
855
- * const data = await infoClient.spotMetaAndAssetCtxs();
927
+ * const data = await infoClient.spotPairDeployAuctionStatus();
856
928
  * ```
857
929
  */
858
- spotMetaAndAssetCtxs(signal) {
859
- const request = { type: "spotMetaAndAssetCtxs" };
930
+ spotPairDeployAuctionStatus(signal) {
931
+ const request = (0, mod_js_1.parser)(mod_js_1.SpotPairDeployAuctionStatusRequest)({
932
+ type: "spotPairDeployAuctionStatus",
933
+ });
860
934
  return this.transport.request("info", request, signal);
861
935
  }
862
936
  /**
@@ -872,14 +946,17 @@ class InfoClient {
872
946
  * ```ts
873
947
  * import * as hl from "@nktkas/hyperliquid";
874
948
  *
875
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
949
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
876
950
  * const infoClient = new hl.InfoClient({ transport });
877
951
  *
878
952
  * const data = await infoClient.subAccounts({ user: "0x..." });
879
953
  * ```
880
954
  */
881
955
  subAccounts(params, signal) {
882
- const request = { type: "subAccounts", ...params };
956
+ const request = (0, mod_js_1.parser)(mod_js_1.SubAccountsRequest)({
957
+ type: "subAccounts",
958
+ ...params,
959
+ });
883
960
  return this.transport.request("info", request, signal);
884
961
  }
885
962
  /**
@@ -895,14 +972,17 @@ class InfoClient {
895
972
  * ```ts
896
973
  * import * as hl from "@nktkas/hyperliquid";
897
974
  *
898
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
975
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
899
976
  * const infoClient = new hl.InfoClient({ transport });
900
977
  *
901
978
  * const data = await infoClient.tokenDetails({ tokenId: "0x..." });
902
979
  * ```
903
980
  */
904
981
  tokenDetails(params, signal) {
905
- const request = { type: "tokenDetails", ...params };
982
+ const request = (0, mod_js_1.parser)(mod_js_1.TokenDetailsRequest)({
983
+ type: "tokenDetails",
984
+ ...params,
985
+ });
906
986
  return this.transport.request("info", request, signal);
907
987
  }
908
988
  /**
@@ -918,14 +998,17 @@ class InfoClient {
918
998
  * ```ts
919
999
  * import * as hl from "@nktkas/hyperliquid";
920
1000
  *
921
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1001
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
922
1002
  * const infoClient = new hl.InfoClient({ transport });
923
1003
  *
924
1004
  * const data = await infoClient.twapHistory({ user: "0x..." });
925
1005
  * ```
926
1006
  */
927
1007
  twapHistory(params, signal) {
928
- const request = { type: "twapHistory", ...params };
1008
+ const request = (0, mod_js_1.parser)(mod_js_1.TwapHistoryRequest)({
1009
+ type: "twapHistory",
1010
+ ...params,
1011
+ });
929
1012
  return this.transport.request("info", request, signal);
930
1013
  }
931
1014
  /**
@@ -948,7 +1031,10 @@ class InfoClient {
948
1031
  * ```
949
1032
  */
950
1033
  txDetails(params, signal) {
951
- const request = { type: "txDetails", ...params };
1034
+ const request = (0, mod_js_1.parser)(mod_js_1.TxDetailsRequest)({
1035
+ type: "txDetails",
1036
+ ...params,
1037
+ });
952
1038
  return this.transport.request("explorer", request, signal)
953
1039
  .then(({ tx }) => tx);
954
1040
  }
@@ -972,7 +1058,10 @@ class InfoClient {
972
1058
  * ```
973
1059
  */
974
1060
  userDetails(params, signal) {
975
- const request = { type: "userDetails", ...params };
1061
+ const request = (0, mod_js_1.parser)(mod_js_1.UserDetailsRequest)({
1062
+ type: "userDetails",
1063
+ ...params,
1064
+ });
976
1065
  return this.transport.request("explorer", request, signal)
977
1066
  .then(({ txs }) => txs);
978
1067
  }
@@ -989,14 +1078,17 @@ class InfoClient {
989
1078
  * ```ts
990
1079
  * import * as hl from "@nktkas/hyperliquid";
991
1080
  *
992
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1081
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
993
1082
  * const infoClient = new hl.InfoClient({ transport });
994
1083
  *
995
1084
  * const data = await infoClient.userFees({ user: "0x..." });
996
1085
  * ```
997
1086
  */
998
1087
  userFees(params, signal) {
999
- const request = { type: "userFees", ...params };
1088
+ const request = (0, mod_js_1.parser)(mod_js_1.UserFeesRequest)({
1089
+ type: "userFees",
1090
+ ...params,
1091
+ });
1000
1092
  return this.transport.request("info", request, signal);
1001
1093
  }
1002
1094
  /**
@@ -1012,14 +1104,17 @@ class InfoClient {
1012
1104
  * ```ts
1013
1105
  * import * as hl from "@nktkas/hyperliquid";
1014
1106
  *
1015
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1107
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1016
1108
  * const infoClient = new hl.InfoClient({ transport });
1017
1109
  *
1018
1110
  * const data = await infoClient.userFills({ user: "0x..." });
1019
1111
  * ```
1020
1112
  */
1021
1113
  userFills(params, signal) {
1022
- const request = { type: "userFills", ...params };
1114
+ const request = (0, mod_js_1.parser)(mod_js_1.UserFillsRequest)({
1115
+ type: "userFills",
1116
+ ...params,
1117
+ });
1023
1118
  return this.transport.request("info", request, signal);
1024
1119
  }
1025
1120
  /**
@@ -1035,7 +1130,7 @@ class InfoClient {
1035
1130
  * ```ts
1036
1131
  * import * as hl from "@nktkas/hyperliquid";
1037
1132
  *
1038
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1133
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1039
1134
  * const infoClient = new hl.InfoClient({ transport });
1040
1135
  *
1041
1136
  * const data = await infoClient.userFillsByTime({
@@ -1045,7 +1140,10 @@ class InfoClient {
1045
1140
  * ```
1046
1141
  */
1047
1142
  userFillsByTime(params, signal) {
1048
- const request = { type: "userFillsByTime", ...params };
1143
+ const request = (0, mod_js_1.parser)(mod_js_1.UserFillsByTimeRequest)({
1144
+ type: "userFillsByTime",
1145
+ ...params,
1146
+ });
1049
1147
  return this.transport.request("info", request, signal);
1050
1148
  }
1051
1149
  /**
@@ -1061,7 +1159,7 @@ class InfoClient {
1061
1159
  * ```ts
1062
1160
  * import * as hl from "@nktkas/hyperliquid";
1063
1161
  *
1064
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1162
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1065
1163
  * const infoClient = new hl.InfoClient({ transport });
1066
1164
  *
1067
1165
  * const data = await infoClient.userFunding({
@@ -1071,7 +1169,10 @@ class InfoClient {
1071
1169
  * ```
1072
1170
  */
1073
1171
  userFunding(params, signal) {
1074
- const request = { type: "userFunding", ...params };
1172
+ const request = (0, mod_js_1.parser)(mod_js_1.UserFundingRequest)({
1173
+ type: "userFunding",
1174
+ ...params,
1175
+ });
1075
1176
  return this.transport.request("info", request, signal);
1076
1177
  }
1077
1178
  /**
@@ -1087,7 +1188,7 @@ class InfoClient {
1087
1188
  * ```ts
1088
1189
  * import * as hl from "@nktkas/hyperliquid";
1089
1190
  *
1090
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1191
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1091
1192
  * const infoClient = new hl.InfoClient({ transport });
1092
1193
  *
1093
1194
  * const data = await infoClient.userNonFundingLedgerUpdates({
@@ -1097,7 +1198,10 @@ class InfoClient {
1097
1198
  * ```
1098
1199
  */
1099
1200
  userNonFundingLedgerUpdates(params, signal) {
1100
- const request = { type: "userNonFundingLedgerUpdates", ...params };
1201
+ const request = (0, mod_js_1.parser)(mod_js_1.UserNonFundingLedgerUpdatesRequest)({
1202
+ type: "userNonFundingLedgerUpdates",
1203
+ ...params,
1204
+ });
1101
1205
  return this.transport.request("info", request, signal);
1102
1206
  }
1103
1207
  /**
@@ -1113,14 +1217,17 @@ class InfoClient {
1113
1217
  * ```ts
1114
1218
  * import * as hl from "@nktkas/hyperliquid";
1115
1219
  *
1116
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1220
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1117
1221
  * const infoClient = new hl.InfoClient({ transport });
1118
1222
  *
1119
1223
  * const data = await infoClient.userRateLimit({ user: "0x..." });
1120
1224
  * ```
1121
1225
  */
1122
1226
  userRateLimit(params, signal) {
1123
- const request = { type: "userRateLimit", ...params };
1227
+ const request = (0, mod_js_1.parser)(mod_js_1.UserRateLimitRequest)({
1228
+ type: "userRateLimit",
1229
+ ...params,
1230
+ });
1124
1231
  return this.transport.request("info", request, signal);
1125
1232
  }
1126
1233
  /**
@@ -1136,14 +1243,17 @@ class InfoClient {
1136
1243
  * ```ts
1137
1244
  * import * as hl from "@nktkas/hyperliquid";
1138
1245
  *
1139
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1246
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1140
1247
  * const infoClient = new hl.InfoClient({ transport });
1141
1248
  *
1142
1249
  * const data = await infoClient.userRole({ user: "0x..." });
1143
1250
  * ```
1144
1251
  */
1145
1252
  userRole(params, signal) {
1146
- const request = { type: "userRole", ...params };
1253
+ const request = (0, mod_js_1.parser)(mod_js_1.UserRoleRequest)({
1254
+ type: "userRole",
1255
+ ...params,
1256
+ });
1147
1257
  return this.transport.request("info", request, signal);
1148
1258
  }
1149
1259
  /**
@@ -1159,14 +1269,17 @@ class InfoClient {
1159
1269
  * ```ts
1160
1270
  * import * as hl from "@nktkas/hyperliquid";
1161
1271
  *
1162
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1272
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1163
1273
  * const infoClient = new hl.InfoClient({ transport });
1164
1274
  *
1165
1275
  * const data = await infoClient.userToMultiSigSigners({ user: "0x..." });
1166
1276
  * ```
1167
1277
  */
1168
1278
  userToMultiSigSigners(params, signal) {
1169
- const request = { type: "userToMultiSigSigners", ...params };
1279
+ const request = (0, mod_js_1.parser)(mod_js_1.UserToMultiSigSignersRequest)({
1280
+ type: "userToMultiSigSigners",
1281
+ ...params,
1282
+ });
1170
1283
  return this.transport.request("info", request, signal);
1171
1284
  }
1172
1285
  /**
@@ -1182,14 +1295,17 @@ class InfoClient {
1182
1295
  * ```ts
1183
1296
  * import * as hl from "@nktkas/hyperliquid";
1184
1297
  *
1185
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1298
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1186
1299
  * const infoClient = new hl.InfoClient({ transport });
1187
1300
  *
1188
1301
  * const data = await infoClient.userTwapSliceFills({ user: "0x..." });
1189
1302
  * ```
1190
1303
  */
1191
1304
  userTwapSliceFills(params, signal) {
1192
- const request = { type: "userTwapSliceFills", ...params };
1305
+ const request = (0, mod_js_1.parser)(mod_js_1.UserTwapSliceFillsRequest)({
1306
+ type: "userTwapSliceFills",
1307
+ ...params,
1308
+ });
1193
1309
  return this.transport.request("info", request, signal);
1194
1310
  }
1195
1311
  /**
@@ -1205,7 +1321,7 @@ class InfoClient {
1205
1321
  * ```ts
1206
1322
  * import * as hl from "@nktkas/hyperliquid";
1207
1323
  *
1208
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1324
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1209
1325
  * const infoClient = new hl.InfoClient({ transport });
1210
1326
  *
1211
1327
  * const data = await infoClient.userTwapSliceFillsByTime({
@@ -1215,7 +1331,10 @@ class InfoClient {
1215
1331
  * ```
1216
1332
  */
1217
1333
  userTwapSliceFillsByTime(params, signal) {
1218
- const request = { type: "userTwapSliceFillsByTime", ...params };
1334
+ const request = (0, mod_js_1.parser)(mod_js_1.UserTwapSliceFillsByTimeRequest)({
1335
+ type: "userTwapSliceFillsByTime",
1336
+ ...params,
1337
+ });
1219
1338
  return this.transport.request("info", request, signal);
1220
1339
  }
1221
1340
  /**
@@ -1231,14 +1350,17 @@ class InfoClient {
1231
1350
  * ```ts
1232
1351
  * import * as hl from "@nktkas/hyperliquid";
1233
1352
  *
1234
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1353
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1235
1354
  * const infoClient = new hl.InfoClient({ transport });
1236
1355
  *
1237
1356
  * const data = await infoClient.userVaultEquities({ user: "0x..." });
1238
1357
  * ```
1239
1358
  */
1240
1359
  userVaultEquities(params, signal) {
1241
- const request = { type: "userVaultEquities", ...params };
1360
+ const request = (0, mod_js_1.parser)(mod_js_1.UserVaultEquitiesRequest)({
1361
+ type: "userVaultEquities",
1362
+ ...params,
1363
+ });
1242
1364
  return this.transport.request("info", request, signal);
1243
1365
  }
1244
1366
  /**
@@ -1253,14 +1375,16 @@ class InfoClient {
1253
1375
  * ```ts
1254
1376
  * import * as hl from "@nktkas/hyperliquid";
1255
1377
  *
1256
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1378
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1257
1379
  * const infoClient = new hl.InfoClient({ transport });
1258
1380
  *
1259
1381
  * const data = await infoClient.validatorL1Votes();
1260
1382
  * ```
1261
1383
  */
1262
1384
  validatorL1Votes(signal) {
1263
- const request = { type: "validatorL1Votes" };
1385
+ const request = (0, mod_js_1.parser)(mod_js_1.ValidatorL1VotesRequest)({
1386
+ type: "validatorL1Votes",
1387
+ });
1264
1388
  return this.transport.request("info", request, signal);
1265
1389
  }
1266
1390
  /**
@@ -1275,14 +1399,16 @@ class InfoClient {
1275
1399
  * ```ts
1276
1400
  * import * as hl from "@nktkas/hyperliquid";
1277
1401
  *
1278
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1402
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1279
1403
  * const infoClient = new hl.InfoClient({ transport });
1280
1404
  *
1281
1405
  * const data = await infoClient.validatorSummaries();
1282
1406
  * ```
1283
1407
  */
1284
1408
  validatorSummaries(signal) {
1285
- const request = { type: "validatorSummaries" };
1409
+ const request = (0, mod_js_1.parser)(mod_js_1.ValidatorSummariesRequest)({
1410
+ type: "validatorSummaries",
1411
+ });
1286
1412
  return this.transport.request("info", request, signal);
1287
1413
  }
1288
1414
  /**
@@ -1298,14 +1424,17 @@ class InfoClient {
1298
1424
  * ```ts
1299
1425
  * import * as hl from "@nktkas/hyperliquid";
1300
1426
  *
1301
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1427
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1302
1428
  * const infoClient = new hl.InfoClient({ transport });
1303
1429
  *
1304
1430
  * const data = await infoClient.vaultDetails({ vaultAddress: "0x..." });
1305
1431
  * ```
1306
1432
  */
1307
1433
  vaultDetails(params, signal) {
1308
- const request = { type: "vaultDetails", ...params };
1434
+ const request = (0, mod_js_1.parser)(mod_js_1.VaultDetailsRequest)({
1435
+ type: "vaultDetails",
1436
+ ...params,
1437
+ });
1309
1438
  return this.transport.request("info", request, signal);
1310
1439
  }
1311
1440
  /**
@@ -1320,14 +1449,16 @@ class InfoClient {
1320
1449
  * ```ts
1321
1450
  * import * as hl from "@nktkas/hyperliquid";
1322
1451
  *
1323
- * const transport = new hl.HttpTransport(); // or WebSocketTransport
1452
+ * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
1324
1453
  * const infoClient = new hl.InfoClient({ transport });
1325
1454
  *
1326
1455
  * const data = await infoClient.vaultSummaries();
1327
1456
  * ```
1328
1457
  */
1329
1458
  vaultSummaries(signal) {
1330
- const request = { type: "vaultSummaries" };
1459
+ const request = (0, mod_js_1.parser)(mod_js_1.VaultSummariesRequest)({
1460
+ type: "vaultSummaries",
1461
+ });
1331
1462
  return this.transport.request("info", request, signal);
1332
1463
  }
1333
1464
  async [Symbol.asyncDispose]() {