@nktkas/hyperliquid 0.22.2 → 0.23.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 (256) hide show
  1. package/README.md +79 -67
  2. package/esm/mod.d.ts +1 -1
  3. package/esm/mod.d.ts.map +1 -1
  4. package/esm/src/base.d.ts +4 -1
  5. package/esm/src/base.d.ts.map +1 -1
  6. package/esm/src/base.js +2 -2
  7. package/esm/src/clients/exchange.d.ts +289 -207
  8. package/esm/src/clients/exchange.d.ts.map +1 -1
  9. package/esm/src/clients/exchange.js +605 -410
  10. package/esm/src/clients/info.d.ts +264 -48
  11. package/esm/src/clients/info.d.ts.map +1 -1
  12. package/esm/src/clients/info.js +273 -31
  13. package/esm/src/clients/multiSign.d.ts +285 -204
  14. package/esm/src/clients/multiSign.d.ts.map +1 -1
  15. package/esm/src/clients/multiSign.js +521 -493
  16. package/esm/src/clients/subscription.d.ts +38 -3
  17. package/esm/src/clients/subscription.d.ts.map +1 -1
  18. package/esm/src/clients/subscription.js +36 -3
  19. package/esm/src/signing/{_ethers.d.ts → _signTypedData/ethers.d.ts} +1 -1
  20. package/esm/src/signing/_signTypedData/ethers.d.ts.map +1 -0
  21. package/esm/src/signing/_signTypedData/mod.d.ts +35 -0
  22. package/esm/src/signing/_signTypedData/mod.d.ts.map +1 -0
  23. package/esm/src/signing/_signTypedData/mod.js +59 -0
  24. package/esm/src/signing/_signTypedData/private_key.d.ts +26 -0
  25. package/esm/src/signing/_signTypedData/private_key.d.ts.map +1 -0
  26. package/esm/src/signing/_signTypedData/private_key.js +144 -0
  27. package/esm/src/signing/{_viem.d.ts → _signTypedData/viem.d.ts} +2 -2
  28. package/esm/src/signing/_signTypedData/viem.d.ts.map +1 -0
  29. package/{script/src/signing/_window.d.ts → esm/src/signing/_signTypedData/window.d.ts} +18 -12
  30. package/esm/src/signing/_signTypedData/window.d.ts.map +1 -0
  31. package/esm/src/signing/{_window.js → _signTypedData/window.js} +3 -2
  32. package/esm/src/signing/_sorter.d.ts +56 -82
  33. package/esm/src/signing/_sorter.d.ts.map +1 -1
  34. package/esm/src/signing/_sorter.js +36 -49
  35. package/esm/src/signing/mod.d.ts +151 -130
  36. package/esm/src/signing/mod.d.ts.map +1 -1
  37. package/esm/src/signing/mod.js +182 -228
  38. package/esm/src/transports/base.d.ts +1 -1
  39. package/esm/src/transports/base.d.ts.map +1 -1
  40. package/esm/src/transports/base.js +2 -2
  41. package/esm/src/transports/http/http_transport.d.ts +9 -15
  42. package/esm/src/transports/http/http_transport.d.ts.map +1 -1
  43. package/esm/src/transports/http/http_transport.js +64 -59
  44. package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts +1 -1
  45. package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
  46. package/esm/src/transports/websocket/_hyperliquid_event_target.js +1 -1
  47. package/esm/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -1
  48. package/esm/src/transports/websocket/_reconnecting_websocket.js +17 -4
  49. package/esm/src/transports/websocket/_websocket_async_request.d.ts +0 -9
  50. package/esm/src/transports/websocket/_websocket_async_request.d.ts.map +1 -1
  51. package/esm/src/transports/websocket/_websocket_async_request.js +14 -20
  52. package/esm/src/transports/websocket/websocket_transport.d.ts +8 -4
  53. package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
  54. package/esm/src/transports/websocket/websocket_transport.js +83 -54
  55. package/esm/src/types/exchange/requests.d.ts +27 -51
  56. package/esm/src/types/exchange/requests.d.ts.map +1 -1
  57. package/esm/src/types/explorer/requests.d.ts +5 -8
  58. package/esm/src/types/explorer/requests.d.ts.map +1 -1
  59. package/esm/src/types/info/accounts.d.ts +5 -5
  60. package/esm/src/types/info/accounts.d.ts.map +1 -1
  61. package/esm/src/types/info/markets.d.ts +6 -0
  62. package/esm/src/types/info/markets.d.ts.map +1 -1
  63. package/esm/src/types/info/orders.d.ts +1 -1
  64. package/esm/src/types/info/orders.d.ts.map +1 -1
  65. package/esm/src/types/info/requests.d.ts +129 -124
  66. package/esm/src/types/info/requests.d.ts.map +1 -1
  67. package/{script/src/types/info/delegations.d.ts → esm/src/types/info/validators.d.ts} +2 -2
  68. package/esm/src/types/info/validators.d.ts.map +1 -0
  69. package/esm/src/types/info/vaults.d.ts +7 -0
  70. package/esm/src/types/info/vaults.d.ts.map +1 -1
  71. package/esm/src/types/mod.d.ts +1 -1
  72. package/esm/src/types/mod.d.ts.map +1 -1
  73. package/esm/src/types/subscriptions/requests.d.ts +72 -18
  74. package/esm/src/types/subscriptions/requests.d.ts.map +1 -1
  75. package/esm/src/types/subscriptions/responses.d.ts +2 -0
  76. package/esm/src/types/subscriptions/responses.d.ts.map +1 -1
  77. package/package.json +8 -5
  78. package/script/mod.d.ts +1 -1
  79. package/script/mod.d.ts.map +1 -1
  80. package/script/mod.js +13 -23
  81. package/script/src/base.d.ts +4 -1
  82. package/script/src/base.d.ts.map +1 -1
  83. package/script/src/base.js +10 -20
  84. package/script/src/clients/exchange.d.ts +289 -207
  85. package/script/src/clients/exchange.d.ts.map +1 -1
  86. package/script/src/clients/exchange.js +2000 -1815
  87. package/script/src/clients/info.d.ts +264 -48
  88. package/script/src/clients/info.d.ts.map +1 -1
  89. package/script/src/clients/info.js +1442 -1210
  90. package/script/src/clients/multiSign.d.ts +285 -204
  91. package/script/src/clients/multiSign.d.ts.map +1 -1
  92. package/script/src/clients/multiSign.js +2043 -2025
  93. package/script/src/clients/subscription.d.ts +38 -3
  94. package/script/src/clients/subscription.d.ts.map +1 -1
  95. package/script/src/clients/subscription.js +568 -545
  96. package/script/src/signing/{_ethers.d.ts → _signTypedData/ethers.d.ts} +1 -1
  97. package/script/src/signing/_signTypedData/ethers.d.ts.map +1 -0
  98. package/script/src/signing/_signTypedData/ethers.js +16 -0
  99. package/script/src/signing/_signTypedData/mod.d.ts +35 -0
  100. package/script/src/signing/_signTypedData/mod.d.ts.map +1 -0
  101. package/script/src/signing/_signTypedData/mod.js +67 -0
  102. package/script/src/signing/_signTypedData/private_key.d.ts +26 -0
  103. package/script/src/signing/_signTypedData/private_key.d.ts.map +1 -0
  104. package/script/src/signing/_signTypedData/private_key.js +148 -0
  105. package/script/src/signing/{_viem.d.ts → _signTypedData/viem.d.ts} +2 -2
  106. package/script/src/signing/_signTypedData/viem.d.ts.map +1 -0
  107. package/script/src/signing/_signTypedData/viem.js +9 -0
  108. package/{esm/src/signing/_window.d.ts → script/src/signing/_signTypedData/window.d.ts} +18 -12
  109. package/script/src/signing/_signTypedData/window.d.ts.map +1 -0
  110. package/script/src/signing/_signTypedData/window.js +34 -0
  111. package/script/src/signing/_sorter.d.ts +56 -82
  112. package/script/src/signing/_sorter.d.ts.map +1 -1
  113. package/script/src/signing/_sorter.js +655 -678
  114. package/script/src/signing/mod.d.ts +151 -130
  115. package/script/src/signing/mod.d.ts.map +1 -1
  116. package/script/src/signing/mod.js +286 -342
  117. package/script/src/transports/base.d.ts +1 -1
  118. package/script/src/transports/base.d.ts.map +1 -1
  119. package/script/src/transports/base.js +11 -21
  120. package/script/src/transports/http/http_transport.d.ts +9 -15
  121. package/script/src/transports/http/http_transport.d.ts.map +1 -1
  122. package/script/src/transports/http/http_transport.js +97 -102
  123. package/script/src/transports/websocket/_hyperliquid_event_target.d.ts +1 -1
  124. package/script/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
  125. package/script/src/transports/websocket/_hyperliquid_event_target.js +51 -61
  126. package/script/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -1
  127. package/script/src/transports/websocket/_reconnecting_websocket.js +271 -268
  128. package/script/src/transports/websocket/_websocket_async_request.d.ts +0 -9
  129. package/script/src/transports/websocket/_websocket_async_request.d.ts.map +1 -1
  130. package/script/src/transports/websocket/_websocket_async_request.js +157 -174
  131. package/script/src/transports/websocket/websocket_transport.d.ts +8 -4
  132. package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
  133. package/script/src/transports/websocket/websocket_transport.js +209 -189
  134. package/script/src/types/exchange/requests.d.ts +27 -51
  135. package/script/src/types/exchange/requests.d.ts.map +1 -1
  136. package/script/src/types/exchange/requests.js +2 -12
  137. package/script/src/types/exchange/responses.js +2 -12
  138. package/script/src/types/explorer/requests.d.ts +5 -8
  139. package/script/src/types/explorer/requests.d.ts.map +1 -1
  140. package/script/src/types/explorer/requests.js +2 -12
  141. package/script/src/types/explorer/responses.js +2 -12
  142. package/script/src/types/info/accounts.d.ts +5 -5
  143. package/script/src/types/info/accounts.d.ts.map +1 -1
  144. package/script/src/types/info/accounts.js +2 -12
  145. package/script/src/types/info/assets.js +2 -12
  146. package/script/src/types/info/markets.d.ts +6 -0
  147. package/script/src/types/info/markets.d.ts.map +1 -1
  148. package/script/src/types/info/markets.js +2 -12
  149. package/script/src/types/info/orders.d.ts +1 -1
  150. package/script/src/types/info/orders.d.ts.map +1 -1
  151. package/script/src/types/info/orders.js +2 -12
  152. package/script/src/types/info/requests.d.ts +129 -124
  153. package/script/src/types/info/requests.d.ts.map +1 -1
  154. package/script/src/types/info/requests.js +2 -12
  155. package/{esm/src/types/info/delegations.d.ts → script/src/types/info/validators.d.ts} +2 -2
  156. package/script/src/types/info/validators.d.ts.map +1 -0
  157. package/script/src/types/info/validators.js +2 -0
  158. package/script/src/types/info/vaults.d.ts +7 -0
  159. package/script/src/types/info/vaults.d.ts.map +1 -1
  160. package/script/src/types/info/vaults.js +2 -12
  161. package/script/src/types/mod.d.ts +1 -1
  162. package/script/src/types/mod.d.ts.map +1 -1
  163. package/script/src/types/mod.js +2 -12
  164. package/script/src/types/subscriptions/requests.d.ts +72 -18
  165. package/script/src/types/subscriptions/requests.d.ts.map +1 -1
  166. package/script/src/types/subscriptions/requests.js +2 -12
  167. package/script/src/types/subscriptions/responses.d.ts +2 -0
  168. package/script/src/types/subscriptions/responses.d.ts.map +1 -1
  169. package/script/src/types/subscriptions/responses.js +2 -12
  170. package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.d.ts +0 -2
  171. package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.d.ts.map +0 -1
  172. package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.js +0 -1
  173. package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.d.ts +0 -95
  174. package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.d.ts.map +0 -1
  175. package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.js +0 -10
  176. package/esm/deps/jsr.io/@std/async/1.0.13/delay.d.ts +0 -43
  177. package/esm/deps/jsr.io/@std/async/1.0.13/delay.d.ts.map +0 -1
  178. package/esm/deps/jsr.io/@std/async/1.0.13/delay.js +0 -63
  179. package/esm/deps/jsr.io/@std/bytes/1.0.6/_types.d.ts +0 -9
  180. package/esm/deps/jsr.io/@std/bytes/1.0.6/_types.d.ts.map +0 -1
  181. package/esm/deps/jsr.io/@std/bytes/1.0.6/_types.js +0 -2
  182. package/esm/deps/jsr.io/@std/bytes/1.0.6/concat.d.ts +0 -21
  183. package/esm/deps/jsr.io/@std/bytes/1.0.6/concat.d.ts.map +0 -1
  184. package/esm/deps/jsr.io/@std/bytes/1.0.6/concat.js +0 -32
  185. package/esm/deps/jsr.io/@std/encoding/1.0.10/_common16.d.ts +0 -23
  186. package/esm/deps/jsr.io/@std/encoding/1.0.10/_common16.d.ts.map +0 -1
  187. package/esm/deps/jsr.io/@std/encoding/1.0.10/_common16.js +0 -51
  188. package/esm/deps/jsr.io/@std/encoding/1.0.10/_common_detach.d.ts +0 -4
  189. package/esm/deps/jsr.io/@std/encoding/1.0.10/_common_detach.d.ts.map +0 -1
  190. package/esm/deps/jsr.io/@std/encoding/1.0.10/_common_detach.js +0 -13
  191. package/esm/deps/jsr.io/@std/encoding/1.0.10/_types.d.ts +0 -9
  192. package/esm/deps/jsr.io/@std/encoding/1.0.10/_types.d.ts.map +0 -1
  193. package/esm/deps/jsr.io/@std/encoding/1.0.10/_types.js +0 -2
  194. package/esm/deps/jsr.io/@std/encoding/1.0.10/hex.d.ts +0 -39
  195. package/esm/deps/jsr.io/@std/encoding/1.0.10/hex.d.ts.map +0 -1
  196. package/esm/deps/jsr.io/@std/encoding/1.0.10/hex.js +0 -87
  197. package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts +0 -9
  198. package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts.map +0 -1
  199. package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.js +0 -2
  200. package/esm/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts +0 -39
  201. package/esm/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts.map +0 -1
  202. package/esm/deps/jsr.io/@std/msgpack/1.0.3/encode.js +0 -237
  203. package/esm/src/signing/_ethers.d.ts.map +0 -1
  204. package/esm/src/signing/_private_key.d.ts +0 -22
  205. package/esm/src/signing/_private_key.d.ts.map +0 -1
  206. package/esm/src/signing/_private_key.js +0 -124
  207. package/esm/src/signing/_viem.d.ts.map +0 -1
  208. package/esm/src/signing/_window.d.ts.map +0 -1
  209. package/esm/src/types/info/delegations.d.ts.map +0 -1
  210. package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.d.ts +0 -2
  211. package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.d.ts.map +0 -1
  212. package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.js +0 -27
  213. package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.d.ts +0 -95
  214. package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.d.ts.map +0 -1
  215. package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.js +0 -24
  216. package/script/deps/jsr.io/@std/async/1.0.13/delay.d.ts +0 -43
  217. package/script/deps/jsr.io/@std/async/1.0.13/delay.d.ts.map +0 -1
  218. package/script/deps/jsr.io/@std/async/1.0.13/delay.js +0 -76
  219. package/script/deps/jsr.io/@std/bytes/1.0.6/_types.d.ts +0 -9
  220. package/script/deps/jsr.io/@std/bytes/1.0.6/_types.d.ts.map +0 -1
  221. package/script/deps/jsr.io/@std/bytes/1.0.6/_types.js +0 -13
  222. package/script/deps/jsr.io/@std/bytes/1.0.6/concat.d.ts +0 -21
  223. package/script/deps/jsr.io/@std/bytes/1.0.6/concat.d.ts.map +0 -1
  224. package/script/deps/jsr.io/@std/bytes/1.0.6/concat.js +0 -45
  225. package/script/deps/jsr.io/@std/encoding/1.0.10/_common16.d.ts +0 -23
  226. package/script/deps/jsr.io/@std/encoding/1.0.10/_common16.d.ts.map +0 -1
  227. package/script/deps/jsr.io/@std/encoding/1.0.10/_common16.js +0 -67
  228. package/script/deps/jsr.io/@std/encoding/1.0.10/_common_detach.d.ts +0 -4
  229. package/script/deps/jsr.io/@std/encoding/1.0.10/_common_detach.d.ts.map +0 -1
  230. package/script/deps/jsr.io/@std/encoding/1.0.10/_common_detach.js +0 -26
  231. package/script/deps/jsr.io/@std/encoding/1.0.10/_types.d.ts +0 -9
  232. package/script/deps/jsr.io/@std/encoding/1.0.10/_types.d.ts.map +0 -1
  233. package/script/deps/jsr.io/@std/encoding/1.0.10/_types.js +0 -13
  234. package/script/deps/jsr.io/@std/encoding/1.0.10/hex.d.ts +0 -39
  235. package/script/deps/jsr.io/@std/encoding/1.0.10/hex.d.ts.map +0 -1
  236. package/script/deps/jsr.io/@std/encoding/1.0.10/hex.js +0 -101
  237. package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts +0 -9
  238. package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts.map +0 -1
  239. package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.js +0 -13
  240. package/script/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts +0 -39
  241. package/script/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts.map +0 -1
  242. package/script/deps/jsr.io/@std/msgpack/1.0.3/encode.js +0 -250
  243. package/script/src/signing/_ethers.d.ts.map +0 -1
  244. package/script/src/signing/_ethers.js +0 -26
  245. package/script/src/signing/_private_key.d.ts +0 -22
  246. package/script/src/signing/_private_key.d.ts.map +0 -1
  247. package/script/src/signing/_private_key.js +0 -138
  248. package/script/src/signing/_viem.d.ts.map +0 -1
  249. package/script/src/signing/_viem.js +0 -19
  250. package/script/src/signing/_window.d.ts.map +0 -1
  251. package/script/src/signing/_window.js +0 -43
  252. package/script/src/types/info/delegations.d.ts.map +0 -1
  253. package/script/src/types/info/delegations.js +0 -12
  254. /package/esm/src/signing/{_ethers.js → _signTypedData/ethers.js} +0 -0
  255. /package/esm/src/signing/{_viem.js → _signTypedData/viem.js} +0 -0
  256. /package/esm/src/types/info/{delegations.js → validators.js} +0 -0
@@ -32,9 +32,11 @@ export class InfoClient {
32
32
  * Block details by block height.
33
33
  * @param args - The parameters for the request.
34
34
  * @param signal - An optional abort signal.
35
- * @returns Block details response.
35
+ * @returns Block details.
36
36
  *
37
- * @see null - no documentation
37
+ * @throws {TransportError} When the transport layer throws an error.
38
+ *
39
+ * @see null
38
40
  * @example
39
41
  * ```ts
40
42
  * import * as hl from "@nktkas/hyperliquid";
@@ -59,6 +61,8 @@ export class InfoClient {
59
61
  * @param signal - An optional abort signal.
60
62
  * @returns Array of candlestick data points.
61
63
  *
64
+ * @throws {TransportError} When the transport layer throws an error.
65
+ *
62
66
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
63
67
  * @example
64
68
  * ```ts
@@ -87,6 +91,8 @@ export class InfoClient {
87
91
  * @param signal - An optional abort signal.
88
92
  * @returns Account summary for perpetual trading.
89
93
  *
94
+ * @throws {TransportError} When the transport layer throws an error.
95
+ *
90
96
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
91
97
  * @example
92
98
  * ```ts
@@ -111,6 +117,8 @@ export class InfoClient {
111
117
  * @param signal - An optional abort signal.
112
118
  * @returns Array of user's delegations to validators.
113
119
  *
120
+ * @throws {TransportError} When the transport layer throws an error.
121
+ *
114
122
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
115
123
  * @example
116
124
  * ```ts
@@ -135,6 +143,8 @@ export class InfoClient {
135
143
  * @param signal - An optional abort signal.
136
144
  * @returns Array of user's staking updates.
137
145
  *
146
+ * @throws {TransportError} When the transport layer throws an error.
147
+ *
138
148
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
139
149
  * @example
140
150
  * ```ts
@@ -159,6 +169,8 @@ export class InfoClient {
159
169
  * @param signal - An optional abort signal.
160
170
  * @returns Array of user's staking rewards.
161
171
  *
172
+ * @throws {TransportError} When the transport layer throws an error.
173
+ *
162
174
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-rewards
163
175
  * @example
164
176
  * ```ts
@@ -183,6 +195,8 @@ export class InfoClient {
183
195
  * @param signal - An optional abort signal.
184
196
  * @returns Summary of a user's staking delegations.
185
197
  *
198
+ * @throws {TransportError} When the transport layer throws an error.
199
+ *
186
200
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
187
201
  * @example
188
202
  * ```ts
@@ -201,13 +215,39 @@ export class InfoClient {
201
215
  };
202
216
  return this.transport.request("info", request, signal);
203
217
  }
218
+ /**
219
+ * Request exchange status information.
220
+ * @param signal - An optional abort signal.
221
+ * @returns Exchange system status information.
222
+ *
223
+ * @throws {TransportError} When the transport layer throws an error.
224
+ *
225
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
226
+ * @example
227
+ * ```ts
228
+ * import * as hl from "@nktkas/hyperliquid";
229
+ *
230
+ * const transport = new hl.HttpTransport(); // or WebSocketTransport
231
+ * const infoClient = new hl.InfoClient({ transport });
232
+ *
233
+ * const data = await infoClient.exchangeStatus();
234
+ * ```
235
+ */
236
+ exchangeStatus(signal) {
237
+ const request = {
238
+ type: "exchangeStatus",
239
+ };
240
+ return this.transport.request("info", request, signal);
241
+ }
204
242
  /**
205
243
  * Request user's extra agents.
206
244
  * @param args - The parameters for the request.
207
245
  * @param signal - An optional abort signal.
208
246
  * @returns User's extra agents.
209
247
  *
210
- * @see null - no documentation
248
+ * @throws {TransportError} When the transport layer throws an error.
249
+ *
250
+ * @see null
211
251
  * @example
212
252
  * ```ts
213
253
  * import * as hl from "@nktkas/hyperliquid";
@@ -231,6 +271,8 @@ export class InfoClient {
231
271
  * @param signal - An optional abort signal.
232
272
  * @returns Array of open orders with additional frontend information.
233
273
  *
274
+ * @throws {TransportError} When the transport layer throws an error.
275
+ *
234
276
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
235
277
  * @example
236
278
  * ```ts
@@ -255,6 +297,8 @@ export class InfoClient {
255
297
  * @param signal - An optional abort signal.
256
298
  * @returns Array of historical funding rate data for an asset.
257
299
  *
300
+ * @throws {TransportError} When the transport layer throws an error.
301
+ *
258
302
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
259
303
  * @example
260
304
  * ```ts
@@ -282,6 +326,8 @@ export class InfoClient {
282
326
  * @param signal - An optional abort signal.
283
327
  * @returns Array of user's historical orders.
284
328
  *
329
+ * @throws {TransportError} When the transport layer throws an error.
330
+ *
285
331
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
286
332
  * @example
287
333
  * ```ts
@@ -306,7 +352,9 @@ export class InfoClient {
306
352
  * @param signal - An optional abort signal.
307
353
  * @returns Boolean indicating user's VIP status.
308
354
  *
309
- * @see null - no documentation
355
+ * @throws {TransportError} When the transport layer throws an error.
356
+ *
357
+ * @see null
310
358
  * @example
311
359
  * ```ts
312
360
  * import * as hl from "@nktkas/hyperliquid";
@@ -330,6 +378,8 @@ export class InfoClient {
330
378
  * @param signal - An optional abort signal.
331
379
  * @returns L2 order book snapshot.
332
380
  *
381
+ * @throws {TransportError} When the transport layer throws an error.
382
+ *
333
383
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
334
384
  * @example
335
385
  * ```ts
@@ -348,13 +398,41 @@ export class InfoClient {
348
398
  };
349
399
  return this.transport.request("info", request, signal);
350
400
  }
401
+ /**
402
+ * Request leading vaults for a user.
403
+ * @param args - The parameters for the request.
404
+ * @param signal - An optional abort signal.
405
+ * @returns
406
+ *
407
+ * @throws {TransportError} When the transport layer throws an error.
408
+ *
409
+ * @see null
410
+ * @example
411
+ * ```ts
412
+ * import * as hl from "@nktkas/hyperliquid";
413
+ *
414
+ * const transport = new hl.HttpTransport(); // or WebSocketTransport
415
+ * const infoClient = new hl.InfoClient({ transport });
416
+ *
417
+ * const data = await infoClient.leadingVaults({ user: "0x..." });
418
+ * ```
419
+ */
420
+ leadingVaults(args, signal) {
421
+ const request = {
422
+ type: "leadingVaults",
423
+ ...args,
424
+ };
425
+ return this.transport.request("info", request, signal);
426
+ }
351
427
  /**
352
428
  * Request legal verification status of a user.
353
429
  * @param args - The parameters for the request.
354
430
  * @param signal - An optional abort signal.
355
431
  * @returns Legal verification status for a user.
356
432
  *
357
- * @see null - no documentation
433
+ * @throws {TransportError} When the transport layer throws an error.
434
+ *
435
+ * @see null
358
436
  * @example
359
437
  * ```ts
360
438
  * import * as hl from "@nktkas/hyperliquid";
@@ -372,12 +450,64 @@ export class InfoClient {
372
450
  };
373
451
  return this.transport.request("info", request, signal);
374
452
  }
453
+ /**
454
+ * Request liquidatable (unknown).
455
+ * @param signal - An optional abort signal.
456
+ * @returns
457
+ *
458
+ * @throws {TransportError} When the transport layer throws an error.
459
+ *
460
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
461
+ * @example
462
+ * ```ts
463
+ * import * as hl from "@nktkas/hyperliquid";
464
+ *
465
+ * const transport = new hl.HttpTransport(); // or WebSocketTransport
466
+ * const infoClient = new hl.InfoClient({ transport });
467
+ *
468
+ * const data = await infoClient.liquidatable();
469
+ * ```
470
+ */
471
+ liquidatable(signal) {
472
+ const request = {
473
+ type: "liquidatable",
474
+ };
475
+ return this.transport.request("info", request, signal);
476
+ }
477
+ /**
478
+ * Request margin table data.
479
+ * @param args - The parameters for the request.
480
+ * @param signal - An optional abort signal.
481
+ * @returns Margin requirements table with multiple tiers.
482
+ *
483
+ * @throws {TransportError} When the transport layer throws an error.
484
+ *
485
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
486
+ * @example
487
+ * ```ts
488
+ * import * as hl from "@nktkas/hyperliquid";
489
+ *
490
+ * const transport = new hl.HttpTransport(); // or WebSocketTransport
491
+ * const infoClient = new hl.InfoClient({ transport });
492
+ *
493
+ * const data = await infoClient.marginTable({ id: 1 });
494
+ * ```
495
+ */
496
+ marginTable(args, signal) {
497
+ const request = {
498
+ type: "marginTable",
499
+ ...args,
500
+ };
501
+ return this.transport.request("info", request, signal);
502
+ }
375
503
  /**
376
504
  * Request builder fee approval.
377
505
  * @param args - The parameters for the request.
378
506
  * @param signal - An optional abort signal.
379
507
  * @returns Maximum builder fee approval.
380
508
  *
509
+ * @throws {TransportError} When the transport layer throws an error.
510
+ *
381
511
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
382
512
  * @example
383
513
  * ```ts
@@ -396,6 +526,30 @@ export class InfoClient {
396
526
  };
397
527
  return this.transport.request("info", request, signal);
398
528
  }
529
+ /**
530
+ * Request maximum market order notionals.
531
+ * @param signal - An optional abort signal.
532
+ * @returns
533
+ *
534
+ * @throws {TransportError} When the transport layer throws an error.
535
+ *
536
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
537
+ * @example
538
+ * ```ts
539
+ * import * as hl from "@nktkas/hyperliquid";
540
+ *
541
+ * const transport = new hl.HttpTransport(); // or WebSocketTransport
542
+ * const infoClient = new hl.InfoClient({ transport });
543
+ *
544
+ * const data = await infoClient.maxMarketOrderNtls();
545
+ * ```
546
+ */
547
+ maxMarketOrderNtls(signal) {
548
+ const request = {
549
+ type: "maxMarketOrderNtls",
550
+ };
551
+ return this.transport.request("info", request, signal);
552
+ }
399
553
  meta(args_or_signal, maybeSignal) {
400
554
  const args = args_or_signal instanceof AbortSignal ? {} : args_or_signal;
401
555
  const signal = args_or_signal instanceof AbortSignal ? args_or_signal : maybeSignal;
@@ -408,7 +562,9 @@ export class InfoClient {
408
562
  /**
409
563
  * Request metadata and asset contexts.
410
564
  * @param signal - An optional abort signal.
411
- * @returns Metadata and context information for each perpetual asset.
565
+ * @returns Metadata and context for perpetual assets.
566
+ *
567
+ * @throws {TransportError} When the transport layer throws an error.
412
568
  *
413
569
  * @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
414
570
  * @example
@@ -433,6 +589,8 @@ export class InfoClient {
433
589
  * @param signal - An optional abort signal.
434
590
  * @returns Array of open order.
435
591
  *
592
+ * @throws {TransportError} When the transport layer throws an error.
593
+ *
436
594
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
437
595
  * @example
438
596
  * ```ts
@@ -457,6 +615,8 @@ export class InfoClient {
457
615
  * @param signal - An optional abort signal.
458
616
  * @returns Result of an order status lookup.
459
617
  *
618
+ * @throws {TransportError} When the transport layer throws an error.
619
+ *
460
620
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
461
621
  * @example
462
622
  * ```ts
@@ -480,6 +640,8 @@ export class InfoClient {
480
640
  * @param signal - An optional abort signal.
481
641
  * @returns Status of the perpetual deploy auction.
482
642
  *
643
+ * @throws {TransportError} When the transport layer throws an error.
644
+ *
483
645
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
484
646
  * @example
485
647
  * ```ts
@@ -500,7 +662,9 @@ export class InfoClient {
500
662
  /**
501
663
  * Request all perpetual dexs.
502
664
  * @param signal - An optional abort signal.
503
- * @returns Array of perpetual dexes.
665
+ * @returns Array of perpetual dexes (null is main dex).
666
+ *
667
+ * @throws {TransportError} When the transport layer throws an error.
504
668
  *
505
669
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
506
670
  * @example
@@ -521,10 +685,11 @@ export class InfoClient {
521
685
  }
522
686
  /**
523
687
  * Request perpetuals at open interest cap.
524
- * @param args - The parameters for the request.
525
688
  * @param signal - An optional abort signal.
526
689
  * @returns Array of perpetuals at open interest caps.
527
690
  *
691
+ * @throws {TransportError} When the transport layer throws an error.
692
+ *
528
693
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
529
694
  * @example
530
695
  * ```ts
@@ -543,10 +708,12 @@ export class InfoClient {
543
708
  return this.transport.request("info", request, signal);
544
709
  }
545
710
  /**
546
- * Request portfolio.
711
+ * Request user portfolio.
547
712
  * @param args - The parameters for the request.
548
713
  * @param signal - An optional abort signal.
549
- * @returns Portfolio of a user.
714
+ * @returns Portfolio metrics grouped by time periods.
715
+ *
716
+ * @throws {TransportError} When the transport layer throws an error.
550
717
  *
551
718
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
552
719
  * @example
@@ -571,6 +738,8 @@ export class InfoClient {
571
738
  * @param signal - An optional abort signal.
572
739
  * @returns Array of predicted funding rates.
573
740
  *
741
+ * @throws {TransportError} When the transport layer throws an error.
742
+ *
574
743
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
575
744
  * @example
576
745
  * ```ts
@@ -594,7 +763,9 @@ export class InfoClient {
594
763
  * @param signal - An optional abort signal.
595
764
  * @returns Pre-transfer user existence check result.
596
765
  *
597
- * @see null - no documentation
766
+ * @throws {TransportError} When the transport layer throws an error.
767
+ *
768
+ * @see null
598
769
  * @example
599
770
  * ```ts
600
771
  * import * as hl from "@nktkas/hyperliquid";
@@ -618,6 +789,8 @@ export class InfoClient {
618
789
  * @param signal - An optional abort signal.
619
790
  * @returns Referral information for a user.
620
791
  *
792
+ * @throws {TransportError} When the transport layer throws an error.
793
+ *
621
794
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
622
795
  * @example
623
796
  * ```ts
@@ -640,7 +813,9 @@ export class InfoClient {
640
813
  * Request spot clearinghouse state.
641
814
  * @param args - The parameters for the request.
642
815
  * @param signal - An optional abort signal.
643
- * @returns Balances for spot tokens.
816
+ * @returns Account summary for spot trading.
817
+ *
818
+ * @throws {TransportError} When the transport layer throws an error.
644
819
  *
645
820
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
646
821
  * @example
@@ -664,7 +839,9 @@ export class InfoClient {
664
839
  * Request spot deploy state.
665
840
  * @param args - The parameters for the request.
666
841
  * @param signal - An optional abort signal.
667
- * @returns The deploy state of a user.
842
+ * @returns Deploy state for spot tokens.
843
+ *
844
+ * @throws {TransportError} When the transport layer throws an error.
668
845
  *
669
846
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
670
847
  * @example
@@ -689,6 +866,8 @@ export class InfoClient {
689
866
  * @param signal - An optional abort signal.
690
867
  * @returns Metadata for spot assets.
691
868
  *
869
+ * @throws {TransportError} When the transport layer throws an error.
870
+ *
692
871
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
693
872
  * @example
694
873
  * ```ts
@@ -709,7 +888,9 @@ export class InfoClient {
709
888
  /**
710
889
  * Request spot metadata and asset contexts.
711
890
  * @param signal - An optional abort signal.
712
- * @returns Metadata and context information for each spot asset.
891
+ * @returns Metadata and context for spot assets.
892
+ *
893
+ * @throws {TransportError} When the transport layer throws an error.
713
894
  *
714
895
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
715
896
  * @example
@@ -734,6 +915,8 @@ export class InfoClient {
734
915
  * @param signal - An optional abort signal.
735
916
  * @returns Array of user sub-account or null if the user does not have any sub-accounts.
736
917
  *
918
+ * @throws {TransportError} When the transport layer throws an error.
919
+ *
737
920
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
738
921
  * @example
739
922
  * ```ts
@@ -756,7 +939,9 @@ export class InfoClient {
756
939
  * Request token details.
757
940
  * @param args - The parameters for the request.
758
941
  * @param signal - An optional abort signal.
759
- * @returns The details of a token.
942
+ * @returns Details of a token.
943
+ *
944
+ * @throws {TransportError} When the transport layer throws an error.
760
945
  *
761
946
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
762
947
  * @example
@@ -780,9 +965,11 @@ export class InfoClient {
780
965
  * Request twap history of a user.
781
966
  * @param args - The parameters for the request.
782
967
  * @param signal - An optional abort signal.
783
- * @returns The twap history of a user.
968
+ * @returns Array of user's TWAP history.
969
+ *
970
+ * @throws {TransportError} When the transport layer throws an error.
784
971
  *
785
- * @see null - no documentation
972
+ * @see null
786
973
  * @example
787
974
  * ```ts
788
975
  * import * as hl from "@nktkas/hyperliquid";
@@ -801,12 +988,14 @@ export class InfoClient {
801
988
  return this.transport.request("info", request, signal);
802
989
  }
803
990
  /**
804
- * Transaction details by transaction hash.
991
+ * Request transaction details by transaction hash.
805
992
  * @param args - The parameters for the request.
806
993
  * @param signal - An optional abort signal.
807
- * @returns Transaction details response.
994
+ * @returns Transaction details.
808
995
  *
809
- * @see null - no documentation
996
+ * @throws {TransportError} When the transport layer throws an error.
997
+ *
998
+ * @see null
810
999
  * @example
811
1000
  * ```ts
812
1001
  * import * as hl from "@nktkas/hyperliquid";
@@ -826,12 +1015,14 @@ export class InfoClient {
826
1015
  return tx;
827
1016
  }
828
1017
  /**
829
- * User details by user's address.
1018
+ * Request user details by user's address.
830
1019
  * @param args - The parameters for the request.
831
1020
  * @param signal - An optional abort signal.
832
- * @returns User details response.
1021
+ * @returns User details.
1022
+ *
1023
+ * @throws {TransportError} When the transport layer throws an error.
833
1024
  *
834
- * @see null - no documentation
1025
+ * @see null
835
1026
  * @example
836
1027
  * ```ts
837
1028
  * import * as hl from "@nktkas/hyperliquid";
@@ -856,7 +1047,9 @@ export class InfoClient {
856
1047
  * @param signal - An optional abort signal.
857
1048
  * @returns User fees.
858
1049
  *
859
- * @see null - no documentation
1050
+ * @throws {TransportError} When the transport layer throws an error.
1051
+ *
1052
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
860
1053
  * @example
861
1054
  * ```ts
862
1055
  * import * as hl from "@nktkas/hyperliquid";
@@ -880,6 +1073,8 @@ export class InfoClient {
880
1073
  * @param signal - An optional abort signal.
881
1074
  * @returns Array of user's trade fill.
882
1075
  *
1076
+ * @throws {TransportError} When the transport layer throws an error.
1077
+ *
883
1078
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
884
1079
  * @example
885
1080
  * ```ts
@@ -904,6 +1099,8 @@ export class InfoClient {
904
1099
  * @param signal - An optional abort signal.
905
1100
  * @returns Array of user's trade fill.
906
1101
  *
1102
+ * @throws {TransportError} When the transport layer throws an error.
1103
+ *
907
1104
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
908
1105
  * @example
909
1106
  * ```ts
@@ -931,6 +1128,8 @@ export class InfoClient {
931
1128
  * @param signal - An optional abort signal.
932
1129
  * @returns Array of user's funding ledger update.
933
1130
  *
1131
+ * @throws {TransportError} When the transport layer throws an error.
1132
+ *
934
1133
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
935
1134
  * @example
936
1135
  * ```ts
@@ -958,6 +1157,8 @@ export class InfoClient {
958
1157
  * @param signal - An optional abort signal.
959
1158
  * @returns Array of user's non-funding ledger update.
960
1159
  *
1160
+ * @throws {TransportError} When the transport layer throws an error.
1161
+ *
961
1162
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
962
1163
  * @example
963
1164
  * ```ts
@@ -985,6 +1186,8 @@ export class InfoClient {
985
1186
  * @param signal - An optional abort signal.
986
1187
  * @returns User's rate limits.
987
1188
  *
1189
+ * @throws {TransportError} When the transport layer throws an error.
1190
+ *
988
1191
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
989
1192
  * @example
990
1193
  * ```ts
@@ -1009,6 +1212,8 @@ export class InfoClient {
1009
1212
  * @param signal - An optional abort signal.
1010
1213
  * @returns User's role.
1011
1214
  *
1215
+ * @throws {TransportError} When the transport layer throws an error.
1216
+ *
1012
1217
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
1013
1218
  * @example
1014
1219
  * ```ts
@@ -1033,7 +1238,9 @@ export class InfoClient {
1033
1238
  * @param signal - An optional abort signal.
1034
1239
  * @returns Multi-sig signers for a user or null if the user does not have any multi-sig signers.
1035
1240
  *
1036
- * @see null - no documentation
1241
+ * @throws {TransportError} When the transport layer throws an error.
1242
+ *
1243
+ * @see null
1037
1244
  * @example
1038
1245
  * ```ts
1039
1246
  * import * as hl from "@nktkas/hyperliquid";
@@ -1057,6 +1264,8 @@ export class InfoClient {
1057
1264
  * @param signal - An optional abort signal.
1058
1265
  * @returns Array of user's twap slice fill.
1059
1266
  *
1267
+ * @throws {TransportError} When the transport layer throws an error.
1268
+ *
1060
1269
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
1061
1270
  * @example
1062
1271
  * ```ts
@@ -1081,7 +1290,9 @@ export class InfoClient {
1081
1290
  * @param signal - An optional abort signal.
1082
1291
  * @returns Array of user's twap slice fill.
1083
1292
  *
1084
- * @see null - no documentation
1293
+ * @throws {TransportError} When the transport layer throws an error.
1294
+ *
1295
+ * @see null
1085
1296
  * @example
1086
1297
  * ```ts
1087
1298
  * import * as hl from "@nktkas/hyperliquid";
@@ -1108,6 +1319,8 @@ export class InfoClient {
1108
1319
  * @param signal - An optional abort signal.
1109
1320
  * @returns Array of user's vault deposits.
1110
1321
  *
1322
+ * @throws {TransportError} When the transport layer throws an error.
1323
+ *
1111
1324
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
1112
1325
  * @example
1113
1326
  * ```ts
@@ -1116,7 +1329,7 @@ export class InfoClient {
1116
1329
  * const transport = new hl.HttpTransport(); // or WebSocketTransport
1117
1330
  * const infoClient = new hl.InfoClient({ transport });
1118
1331
  *
1119
- * const data = await infoClient.userVaultDeposits({ user: "0x..." });
1332
+ * const data = await infoClient.userVaultEquities({ user: "0x..." });
1120
1333
  * ```
1121
1334
  */
1122
1335
  userVaultEquities(args, signal) {
@@ -1126,12 +1339,38 @@ export class InfoClient {
1126
1339
  };
1127
1340
  return this.transport.request("info", request, signal);
1128
1341
  }
1342
+ /**
1343
+ * Request validator L1 votes.
1344
+ * @param signal - An optional abort signal.
1345
+ * @returns
1346
+ *
1347
+ * @throws {TransportError} When the transport layer throws an error.
1348
+ *
1349
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
1350
+ * @example
1351
+ * ```ts
1352
+ * import * as hl from "@nktkas/hyperliquid";
1353
+ *
1354
+ * const transport = new hl.HttpTransport(); // or WebSocketTransport
1355
+ * const infoClient = new hl.InfoClient({ transport });
1356
+ *
1357
+ * const data = await infoClient.validatorL1Votes();
1358
+ * ```
1359
+ */
1360
+ validatorL1Votes(signal) {
1361
+ const request = {
1362
+ type: "validatorL1Votes",
1363
+ };
1364
+ return this.transport.request("info", request, signal);
1365
+ }
1129
1366
  /**
1130
1367
  * Request validator summaries.
1131
- * @param args - The parameters for the request.
1368
+ * @param signal - An optional abort signal.
1132
1369
  * @returns Array of validator summaries.
1133
1370
  *
1134
- * @see null - no documentation
1371
+ * @throws {TransportError} When the transport layer throws an error.
1372
+ *
1373
+ * @see null
1135
1374
  * @example
1136
1375
  * ```ts
1137
1376
  * import * as hl from "@nktkas/hyperliquid";
@@ -1154,6 +1393,8 @@ export class InfoClient {
1154
1393
  * @param signal - An optional abort signal.
1155
1394
  * @returns Details of a vault or null if the vault does not exist.
1156
1395
  *
1396
+ * @throws {TransportError} When the transport layer throws an error.
1397
+ *
1157
1398
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
1158
1399
  * @example
1159
1400
  * ```ts
@@ -1174,11 +1415,12 @@ export class InfoClient {
1174
1415
  }
1175
1416
  /**
1176
1417
  * Request a list of vaults less than 2 hours old.
1177
- * @param args - The parameters for the request.
1178
1418
  * @param signal - An optional abort signal.
1179
1419
  * @returns Array of vault summaries.
1180
1420
  *
1181
- * @see null - no documentation
1421
+ * @throws {TransportError} When the transport layer throws an error.
1422
+ *
1423
+ * @see null
1182
1424
  * @example
1183
1425
  * ```ts
1184
1426
  * import * as hl from "@nktkas/hyperliquid";