@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
@@ -0,0 +1,882 @@
1
+ import * as v from "valibot";
2
+ /**
3
+ * Request user active asset data.
4
+ * @returns {ActiveAssetData}
5
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-active-asset-data
6
+ */
7
+ export declare const ActiveAssetDataRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
8
+ /** Type of request. */
9
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"activeAssetData", undefined>, v.DescriptionAction<"activeAssetData", "Type of request.">]>;
10
+ /** Asset symbol (e.g., BTC). */
11
+ readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
12
+ /** User address. */
13
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
14
+ }, undefined>, v.DescriptionAction<{
15
+ type: "activeAssetData";
16
+ coin: string;
17
+ user: `0x${string}`;
18
+ }, "Request user active asset data.">]>;
19
+ export type ActiveAssetDataRequest = v.InferOutput<typeof ActiveAssetDataRequest>;
20
+ /**
21
+ * Request mid coin prices.
22
+ * @returns {AllMids}
23
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
24
+ */
25
+ export declare const AllMidsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
26
+ /** Type of request. */
27
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"allMids", undefined>, v.DescriptionAction<"allMids", "Type of request.">]>;
28
+ /** DEX name (empty string for main dex). */
29
+ readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
30
+ }, undefined>, v.DescriptionAction<{
31
+ type: "allMids";
32
+ dex?: string | undefined;
33
+ }, "Request mid coin prices.">]>;
34
+ export type AllMidsRequest = v.InferOutput<typeof AllMidsRequest>;
35
+ /**
36
+ * Request candlestick snapshots.
37
+ * @returns {Candle[]}
38
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
39
+ */
40
+ export declare const CandleSnapshotRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
41
+ /** Type of request. */
42
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"candleSnapshot", undefined>, v.DescriptionAction<"candleSnapshot", "Type of request.">]>;
43
+ /** Request parameters. */
44
+ readonly req: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
45
+ /** Asset symbol (e.g., BTC). */
46
+ readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
47
+ /** Time interval. */
48
+ readonly interval: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"1m", undefined>, v.LiteralSchema<"3m", undefined>, v.LiteralSchema<"5m", undefined>, v.LiteralSchema<"15m", undefined>, v.LiteralSchema<"30m", undefined>, v.LiteralSchema<"1h", undefined>, v.LiteralSchema<"2h", undefined>, v.LiteralSchema<"4h", undefined>, v.LiteralSchema<"8h", undefined>, v.LiteralSchema<"12h", undefined>, v.LiteralSchema<"1d", undefined>, v.LiteralSchema<"3d", undefined>, v.LiteralSchema<"1w", undefined>, v.LiteralSchema<"1M", undefined>], undefined>, v.DescriptionAction<"1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M", "Time interval.">]>;
49
+ /** Start time (in ms since epoch). */
50
+ readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Start time (in ms since epoch).">]>;
51
+ /** End time (in ms since epoch). */
52
+ readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null | undefined, "End time (in ms since epoch).">]>;
53
+ }, undefined>, v.DescriptionAction<{
54
+ coin: string;
55
+ interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
56
+ startTime: number;
57
+ endTime?: number | null | undefined;
58
+ }, "Request parameters.">]>;
59
+ }, undefined>, v.DescriptionAction<{
60
+ type: "candleSnapshot";
61
+ req: {
62
+ coin: string;
63
+ interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
64
+ startTime: number;
65
+ endTime?: number | null | undefined;
66
+ };
67
+ }, "Request candlestick snapshots.">]>;
68
+ export type CandleSnapshotRequest = v.InferOutput<typeof CandleSnapshotRequest>;
69
+ /**
70
+ * Request clearinghouse state.
71
+ * @returns {PerpsClearinghouseState}
72
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
73
+ */
74
+ export declare const ClearinghouseStateRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
75
+ /** Type of request. */
76
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"clearinghouseState", undefined>, v.DescriptionAction<"clearinghouseState", "Type of request.">]>;
77
+ /** User address. */
78
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
79
+ /** DEX name (empty string for main dex). */
80
+ readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
81
+ }, undefined>, v.DescriptionAction<{
82
+ type: "clearinghouseState";
83
+ user: `0x${string}`;
84
+ dex?: string | undefined;
85
+ }, "Request clearinghouse state.">]>;
86
+ export type ClearinghouseStateRequest = v.InferOutput<typeof ClearinghouseStateRequest>;
87
+ /**
88
+ * Request user staking delegations.
89
+ * @returns {Delegation[]}
90
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
91
+ */
92
+ export declare const DelegationsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
93
+ /** Type of request. */
94
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"delegations", undefined>, v.DescriptionAction<"delegations", "Type of request.">]>;
95
+ /** User address. */
96
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
97
+ }, undefined>, v.DescriptionAction<{
98
+ type: "delegations";
99
+ user: `0x${string}`;
100
+ }, "Request user staking delegations.">]>;
101
+ export type DelegationsRequest = v.InferOutput<typeof DelegationsRequest>;
102
+ /**
103
+ * Request user staking history.
104
+ * @returns {DelegatorUpdate[]}
105
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
106
+ */
107
+ export declare const DelegatorHistoryRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
108
+ /** Type of request. */
109
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"delegatorHistory", undefined>, v.DescriptionAction<"delegatorHistory", "Type of request.">]>;
110
+ /** User address. */
111
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
112
+ }, undefined>, v.DescriptionAction<{
113
+ type: "delegatorHistory";
114
+ user: `0x${string}`;
115
+ }, "Request user staking history.">]>;
116
+ export type DelegatorHistoryRequest = v.InferOutput<typeof DelegatorHistoryRequest>;
117
+ /**
118
+ * Request user staking rewards.
119
+ * @returns {DelegatorReward[]}
120
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-rewards
121
+ */
122
+ export declare const DelegatorRewardsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
123
+ /** Type of request. */
124
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"delegatorRewards", undefined>, v.DescriptionAction<"delegatorRewards", "Type of request.">]>;
125
+ /** User address. */
126
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
127
+ }, undefined>, v.DescriptionAction<{
128
+ type: "delegatorRewards";
129
+ user: `0x${string}`;
130
+ }, "Request user staking rewards.">]>;
131
+ export type DelegatorRewardsRequest = v.InferOutput<typeof DelegatorRewardsRequest>;
132
+ /**
133
+ * Request user staking summary.
134
+ * @returns {DelegatorSummary}
135
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
136
+ */
137
+ export declare const DelegatorSummaryRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
138
+ /** Type of request. */
139
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"delegatorSummary", undefined>, v.DescriptionAction<"delegatorSummary", "Type of request.">]>;
140
+ /** User address. */
141
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
142
+ }, undefined>, v.DescriptionAction<{
143
+ type: "delegatorSummary";
144
+ user: `0x${string}`;
145
+ }, "Request user staking summary.">]>;
146
+ export type DelegatorSummaryRequest = v.InferOutput<typeof DelegatorSummaryRequest>;
147
+ /**
148
+ * Request exchange status information.
149
+ * @returns {ExchangeStatus}
150
+ * @see null
151
+ */
152
+ export declare const ExchangeStatusRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
153
+ /** Type of request. */
154
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"exchangeStatus", undefined>, v.DescriptionAction<"exchangeStatus", "Type of request.">]>;
155
+ }, undefined>, v.DescriptionAction<{
156
+ type: "exchangeStatus";
157
+ }, "Request exchange status information.">]>;
158
+ export type ExchangeStatusRequest = v.InferOutput<typeof ExchangeStatusRequest>;
159
+ /**
160
+ * Request user extra agents.
161
+ * @returns {ExtraAgent[]}
162
+ * @see null
163
+ */
164
+ export declare const ExtraAgentsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
165
+ /** Type of request. */
166
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"extraAgents", undefined>, v.DescriptionAction<"extraAgents", "Type of request.">]>;
167
+ /** User address. */
168
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
169
+ }, undefined>, v.DescriptionAction<{
170
+ type: "extraAgents";
171
+ user: `0x${string}`;
172
+ }, "Request user extra agents.">]>;
173
+ export type ExtraAgentsRequest = v.InferOutput<typeof ExtraAgentsRequest>;
174
+ /**
175
+ * Request frontend open orders.
176
+ * @returns {FrontendOrder[]}
177
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
178
+ */
179
+ export declare const FrontendOpenOrdersRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
180
+ /** Type of request. */
181
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"frontendOpenOrders", undefined>, v.DescriptionAction<"frontendOpenOrders", "Type of request.">]>;
182
+ /** User address. */
183
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
184
+ /** DEX name (empty string for main dex). */
185
+ readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
186
+ }, undefined>, v.DescriptionAction<{
187
+ type: "frontendOpenOrders";
188
+ user: `0x${string}`;
189
+ dex?: string | undefined;
190
+ }, "Request frontend open orders.">]>;
191
+ export type FrontendOpenOrdersRequest = v.InferOutput<typeof FrontendOpenOrdersRequest>;
192
+ /**
193
+ * Request funding history.
194
+ * @returns {FundingHistory[]}
195
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
196
+ */
197
+ export declare const FundingHistoryRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
198
+ /** Type of request. */
199
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"fundingHistory", undefined>, v.DescriptionAction<"fundingHistory", "Type of request.">]>;
200
+ /** Asset symbol (e.g., BTC). */
201
+ readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
202
+ /** Start time (in ms since epoch). */
203
+ readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Start time (in ms since epoch).">]>;
204
+ /** End time (in ms since epoch). */
205
+ readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null | undefined, "End time (in ms since epoch).">]>;
206
+ }, undefined>, v.DescriptionAction<{
207
+ type: "fundingHistory";
208
+ coin: string;
209
+ startTime: number;
210
+ endTime?: number | null | undefined;
211
+ }, "Request funding history.">]>;
212
+ export type FundingHistoryRequest = v.InferOutput<typeof FundingHistoryRequest>;
213
+ /**
214
+ * Request user historical orders.
215
+ * @returns {FrontendOrderStatus[]}
216
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
217
+ */
218
+ export declare const HistoricalOrdersRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
219
+ /** Type of request. */
220
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"historicalOrders", undefined>, v.DescriptionAction<"historicalOrders", "Type of request.">]>;
221
+ /** User address. */
222
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
223
+ }, undefined>, v.DescriptionAction<{
224
+ type: "historicalOrders";
225
+ user: `0x${string}`;
226
+ }, "Request user historical orders.">]>;
227
+ export type HistoricalOrdersRequest = v.InferOutput<typeof HistoricalOrdersRequest>;
228
+ /**
229
+ * Request to check if a user is a VIP.
230
+ * @returns {boolean | null}
231
+ * @see null
232
+ */
233
+ export declare const IsVipRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
234
+ /** Type of request. */
235
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"isVip", undefined>, v.DescriptionAction<"isVip", "Type of request.">]>;
236
+ /** User address. */
237
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
238
+ }, undefined>, v.DescriptionAction<{
239
+ type: "isVip";
240
+ user: `0x${string}`;
241
+ }, "Request to check if a user is a VIP.">]>;
242
+ export type IsVipRequest = v.InferOutput<typeof IsVipRequest>;
243
+ /**
244
+ * Request L2 order book.
245
+ * @returns {Book}
246
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
247
+ */
248
+ export declare const L2BookRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
249
+ /** Type of request. */
250
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"l2Book", undefined>, v.DescriptionAction<"l2Book", "Type of request.">]>;
251
+ /** Asset symbol (e.g., BTC). */
252
+ readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
253
+ /** Number of significant figures. */
254
+ readonly nSigFigs: v.SchemaWithPipe<readonly [v.NullishSchema<v.UnionSchema<[v.LiteralSchema<2, undefined>, v.LiteralSchema<3, undefined>, v.LiteralSchema<4, undefined>, v.LiteralSchema<5, undefined>], undefined>, undefined>, v.DescriptionAction<3 | 2 | 4 | 5 | null | undefined, "Number of significant figures.">]>;
255
+ /** Mantissa for aggregation (if `nSigFigs` is 5). */
256
+ readonly mantissa: v.SchemaWithPipe<readonly [v.NullishSchema<v.UnionSchema<[v.LiteralSchema<2, undefined>, v.LiteralSchema<5, undefined>], undefined>, undefined>, v.DescriptionAction<2 | 5 | null | undefined, "Mantissa for aggregation (if `nSigFigs` is 5).">]>;
257
+ }, undefined>, v.DescriptionAction<{
258
+ type: "l2Book";
259
+ coin: string;
260
+ nSigFigs?: 3 | 2 | 4 | 5 | null | undefined;
261
+ mantissa?: 2 | 5 | null | undefined;
262
+ }, "Request L2 order book.">]>;
263
+ export type L2BookRequest = v.InferOutput<typeof L2BookRequest>;
264
+ /**
265
+ * Request leading vaults for a user.
266
+ * @returns {VaultLeading[]}
267
+ * @see null
268
+ */
269
+ export declare const LeadingVaultsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
270
+ /** Type of request. */
271
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"leadingVaults", undefined>, v.DescriptionAction<"leadingVaults", "Type of request.">]>;
272
+ /** User address. */
273
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
274
+ }, undefined>, v.DescriptionAction<{
275
+ type: "leadingVaults";
276
+ user: `0x${string}`;
277
+ }, "Request leading vaults for a user.">]>;
278
+ export type LeadingVaultsRequest = v.InferOutput<typeof LeadingVaultsRequest>;
279
+ /**
280
+ * Request legal verification status of a user.
281
+ * @returns {LegalCheck}
282
+ * @see null
283
+ */
284
+ export declare const LegalCheckRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
285
+ /** Type of request. */
286
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"legalCheck", undefined>, v.DescriptionAction<"legalCheck", "Type of request.">]>;
287
+ /** User address. */
288
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
289
+ }, undefined>, v.DescriptionAction<{
290
+ type: "legalCheck";
291
+ user: `0x${string}`;
292
+ }, "Request legal verification status of a user.">]>;
293
+ export type LegalCheckRequest = v.InferOutput<typeof LegalCheckRequest>;
294
+ /**
295
+ * Request liquidatable.
296
+ * @returns {unknown[]} FIXME: Define the return type
297
+ * @see null
298
+ */
299
+ export declare const LiquidatableRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
300
+ /** Type of request. */
301
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"liquidatable", undefined>, v.DescriptionAction<"liquidatable", "Type of request.">]>;
302
+ }, undefined>, v.DescriptionAction<{
303
+ type: "liquidatable";
304
+ }, "Request liquidatable.">]>;
305
+ export type LiquidatableRequest = v.InferOutput<typeof LiquidatableRequest>;
306
+ /**
307
+ * Request margin table data.
308
+ * @returns {MarginTable}
309
+ * @see null
310
+ */
311
+ export declare const MarginTableRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
312
+ /** Type of request. */
313
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"marginTable", undefined>, v.DescriptionAction<"marginTable", "Type of request.">]>;
314
+ /** Margin requirements table. */
315
+ readonly id: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Margin requirements table.">]>;
316
+ }, undefined>, v.DescriptionAction<{
317
+ type: "marginTable";
318
+ id: number;
319
+ }, "Request margin table data.">]>;
320
+ export type MarginTableRequest = v.InferOutput<typeof MarginTableRequest>;
321
+ /**
322
+ * Request builder fee approval.
323
+ * @returns {number}
324
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
325
+ */
326
+ export declare const MaxBuilderFeeRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
327
+ /** Type of request. */
328
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"maxBuilderFee", undefined>, v.DescriptionAction<"maxBuilderFee", "Type of request.">]>;
329
+ /** User address. */
330
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
331
+ /** Builder address. */
332
+ readonly builder: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Builder address.">]>;
333
+ }, undefined>, v.DescriptionAction<{
334
+ type: "maxBuilderFee";
335
+ user: `0x${string}`;
336
+ builder: `0x${string}`;
337
+ }, "Request builder fee approval.">]>;
338
+ export type MaxBuilderFeeRequest = v.InferOutput<typeof MaxBuilderFeeRequest>;
339
+ /**
340
+ * Request maximum market order notionals.
341
+ * @returns {[number, string][]}
342
+ * @see null
343
+ */
344
+ export declare const MaxMarketOrderNtlsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
345
+ /** Type of request. */
346
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"maxMarketOrderNtls", undefined>, v.DescriptionAction<"maxMarketOrderNtls", "Type of request.">]>;
347
+ }, undefined>, v.DescriptionAction<{
348
+ type: "maxMarketOrderNtls";
349
+ }, "Request maximum market order notionals.">]>;
350
+ export type MaxMarketOrderNtlsRequest = v.InferOutput<typeof MaxMarketOrderNtlsRequest>;
351
+ /**
352
+ * Request trading metadata.
353
+ * @returns {PerpsMeta}
354
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata-universe-and-margin-tables
355
+ */
356
+ export declare const MetaRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
357
+ /** Type of request. */
358
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"meta", undefined>, v.DescriptionAction<"meta", "Type of request.">]>;
359
+ /** DEX name (empty string for main dex). */
360
+ readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
361
+ }, undefined>, v.DescriptionAction<{
362
+ type: "meta";
363
+ dex?: string | undefined;
364
+ }, "Request trading metadata.">]>;
365
+ export type MetaRequest = v.InferOutput<typeof MetaRequest>;
366
+ /**
367
+ * Request metadata and asset contexts.
368
+ * @returns {PerpsMetaAndAssetCtxs}
369
+ * @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
370
+ */
371
+ export declare const MetaAndAssetCtxsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
372
+ /** Type of request. */
373
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"metaAndAssetCtxs", undefined>, v.DescriptionAction<"metaAndAssetCtxs", "Type of request.">]>;
374
+ /** DEX name (empty string for main dex). */
375
+ readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
376
+ }, undefined>, v.DescriptionAction<{
377
+ type: "metaAndAssetCtxs";
378
+ dex?: string | undefined;
379
+ }, "Request metadata and asset contexts.">]>;
380
+ export type MetaAndAssetCtxsRequest = v.InferOutput<typeof MetaAndAssetCtxsRequest>;
381
+ /**
382
+ * Request open orders.
383
+ * @returns {Order[]}
384
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
385
+ */
386
+ export declare const OpenOrdersRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
387
+ /** Type of request. */
388
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"openOrders", undefined>, v.DescriptionAction<"openOrders", "Type of request.">]>;
389
+ /** User address. */
390
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
391
+ /** DEX name (empty string for main dex). */
392
+ readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
393
+ }, undefined>, v.DescriptionAction<{
394
+ type: "openOrders";
395
+ user: `0x${string}`;
396
+ dex?: string | undefined;
397
+ }, "Request open orders.">]>;
398
+ export type OpenOrdersRequest = v.InferOutput<typeof OpenOrdersRequest>;
399
+ /**
400
+ * Request order status.
401
+ * @returns {OrderLookup}
402
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
403
+ */
404
+ export declare const OrderStatusRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
405
+ /** Type of request. */
406
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"orderStatus", undefined>, v.DescriptionAction<"orderStatus", "Type of request.">]>;
407
+ /** User address. */
408
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
409
+ /** Order ID or Client Order ID. */
410
+ readonly oid: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 34, undefined>]>], undefined>, v.DescriptionAction<number | `0x${string}`, "Order ID or Client Order ID.">]>;
411
+ }, undefined>, v.DescriptionAction<{
412
+ type: "orderStatus";
413
+ user: `0x${string}`;
414
+ oid: number | `0x${string}`;
415
+ }, "Request order status.">]>;
416
+ export type OrderStatusRequest = v.InferOutput<typeof OrderStatusRequest>;
417
+ /**
418
+ * Request for the status of the perpetual deploy auction.
419
+ * @returns {DeployAuctionStatus}
420
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
421
+ */
422
+ export declare const PerpDeployAuctionStatusRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
423
+ /** Type of request. */
424
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeployAuctionStatus", undefined>, v.DescriptionAction<"perpDeployAuctionStatus", "Type of request.">]>;
425
+ }, undefined>, v.DescriptionAction<{
426
+ type: "perpDeployAuctionStatus";
427
+ }, "Request for the status of the perpetual deploy auction.">]>;
428
+ export type PerpDeployAuctionStatusRequest = v.InferOutput<typeof PerpDeployAuctionStatusRequest>;
429
+ /**
430
+ * Request all perpetual dexs.
431
+ * @returns {PerpDexs}
432
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
433
+ */
434
+ export declare const PerpDexsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
435
+ /** Type of request. */
436
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDexs", undefined>, v.DescriptionAction<"perpDexs", "Type of request.">]>;
437
+ }, undefined>, v.DescriptionAction<{
438
+ type: "perpDexs";
439
+ }, "Request all perpetual dexs.">]>;
440
+ export type PerpDexsRequest = v.InferOutput<typeof PerpDexsRequest>;
441
+ /**
442
+ * Request perpetuals at open interest cap.
443
+ * @returns {string[]}
444
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
445
+ */
446
+ export declare const PerpsAtOpenInterestCapRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
447
+ /** Type of request. */
448
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpsAtOpenInterestCap", undefined>, v.DescriptionAction<"perpsAtOpenInterestCap", "Type of request.">]>;
449
+ /** DEX name (empty string for main dex). */
450
+ readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
451
+ }, undefined>, v.DescriptionAction<{
452
+ type: "perpsAtOpenInterestCap";
453
+ dex?: string | undefined;
454
+ }, "Request perpetuals at open interest cap.">]>;
455
+ export type PerpsAtOpenInterestCapRequest = v.InferOutput<typeof PerpsAtOpenInterestCapRequest>;
456
+ /**
457
+ * Request user portfolio.
458
+ * @returns {PortfolioPeriods}
459
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
460
+ */
461
+ export declare const PortfolioRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
462
+ /** Type of request. */
463
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"portfolio", undefined>, v.DescriptionAction<"portfolio", "Type of request.">]>;
464
+ /** User address. */
465
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
466
+ }, undefined>, v.DescriptionAction<{
467
+ type: "portfolio";
468
+ user: `0x${string}`;
469
+ }, "Request user portfolio.">]>;
470
+ export type PortfolioRequest = v.InferOutput<typeof PortfolioRequest>;
471
+ /**
472
+ * Request predicted funding rates.
473
+ * @returns {PredictedFunding[]}
474
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
475
+ */
476
+ export declare const PredictedFundingsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
477
+ /** Type of request. */
478
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"predictedFundings", undefined>, v.DescriptionAction<"predictedFundings", "Type of request.">]>;
479
+ }, undefined>, v.DescriptionAction<{
480
+ type: "predictedFundings";
481
+ }, "Request predicted funding rates.">]>;
482
+ export type PredictedFundingsRequest = v.InferOutput<typeof PredictedFundingsRequest>;
483
+ /**
484
+ * Request user existence check before transfer.
485
+ * @returns {PreTransferCheck}
486
+ * @see null
487
+ */
488
+ export declare const PreTransferCheckRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
489
+ /** Type of request. */
490
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"preTransferCheck", undefined>, v.DescriptionAction<"preTransferCheck", "Type of request.">]>;
491
+ /** User address. */
492
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
493
+ /** Source address. */
494
+ readonly source: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Source address.">]>;
495
+ }, undefined>, v.DescriptionAction<{
496
+ type: "preTransferCheck";
497
+ user: `0x${string}`;
498
+ source: `0x${string}`;
499
+ }, "Request user existence check before transfer.">]>;
500
+ export type PreTransferCheckRequest = v.InferOutput<typeof PreTransferCheckRequest>;
501
+ /**
502
+ * Request user referral.
503
+ * @returns {Referral}
504
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
505
+ */
506
+ export declare const ReferralRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
507
+ /** Type of request. */
508
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"referral", undefined>, v.DescriptionAction<"referral", "Type of request.">]>;
509
+ /** User address. */
510
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
511
+ }, undefined>, v.DescriptionAction<{
512
+ type: "referral";
513
+ user: `0x${string}`;
514
+ }, "Request user referral.">]>;
515
+ export type ReferralRequest = v.InferOutput<typeof ReferralRequest>;
516
+ /**
517
+ * Request spot clearinghouse state.
518
+ * @returns {SpotClearinghouseState}
519
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
520
+ */
521
+ export declare const SpotClearinghouseStateRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
522
+ /** Type of request. */
523
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotClearinghouseState", undefined>, v.DescriptionAction<"spotClearinghouseState", "Type of request.">]>;
524
+ /** User address. */
525
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
526
+ /** DEX name (empty string for main dex). */
527
+ readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
528
+ }, undefined>, v.DescriptionAction<{
529
+ type: "spotClearinghouseState";
530
+ user: `0x${string}`;
531
+ dex?: string | undefined;
532
+ }, "Request spot clearinghouse state.">]>;
533
+ export type SpotClearinghouseStateRequest = v.InferOutput<typeof SpotClearinghouseStateRequest>;
534
+ /**
535
+ * Request spot deploy state.
536
+ * @returns {SpotDeployState}
537
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
538
+ */
539
+ export declare const SpotDeployStateRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
540
+ /** Type of request. */
541
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotDeployState", undefined>, v.DescriptionAction<"spotDeployState", "Type of request.">]>;
542
+ /** User address. */
543
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
544
+ }, undefined>, v.DescriptionAction<{
545
+ type: "spotDeployState";
546
+ user: `0x${string}`;
547
+ }, "Request spot deploy state.">]>;
548
+ export type SpotDeployStateRequest = v.InferOutput<typeof SpotDeployStateRequest>;
549
+ /**
550
+ * Request spot trading metadata.
551
+ * @returns {SpotMeta}
552
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
553
+ */
554
+ export declare const SpotMetaRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
555
+ /** Type of request. */
556
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotMeta", undefined>, v.DescriptionAction<"spotMeta", "Type of request.">]>;
557
+ }, undefined>, v.DescriptionAction<{
558
+ type: "spotMeta";
559
+ }, "Request spot trading metadata.">]>;
560
+ export type SpotMetaRequest = v.InferOutput<typeof SpotMetaRequest>;
561
+ /**
562
+ * Request spot metadata and asset contexts.
563
+ * @returns {SpotMetaAndAssetCtxs}
564
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
565
+ */
566
+ export declare const SpotMetaAndAssetCtxsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
567
+ /** Type of request. */
568
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotMetaAndAssetCtxs", undefined>, v.DescriptionAction<"spotMetaAndAssetCtxs", "Type of request.">]>;
569
+ }, undefined>, v.DescriptionAction<{
570
+ type: "spotMetaAndAssetCtxs";
571
+ }, "Request spot metadata and asset contexts.">]>;
572
+ export type SpotMetaAndAssetCtxsRequest = v.InferOutput<typeof SpotMetaAndAssetCtxsRequest>;
573
+ /**
574
+ * Request for the status of the spot deploy auction.
575
+ * @returns {DeployAuctionStatus}
576
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-pair-deploy-auction
577
+ */
578
+ export declare const SpotPairDeployAuctionStatusRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
579
+ /** Type of request. */
580
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotPairDeployAuctionStatus", undefined>, v.DescriptionAction<"spotPairDeployAuctionStatus", "Type of request.">]>;
581
+ }, undefined>, v.DescriptionAction<{
582
+ type: "spotPairDeployAuctionStatus";
583
+ }, "Request for the status of the spot deploy auction.">]>;
584
+ export type SpotPairDeployAuctionStatusRequest = v.InferOutput<typeof SpotPairDeployAuctionStatusRequest>;
585
+ /**
586
+ * Request user sub-accounts.
587
+ * @returns {SubAccount[] | null}
588
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
589
+ */
590
+ export declare const SubAccountsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
591
+ /** Type of request. */
592
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"subAccounts", undefined>, v.DescriptionAction<"subAccounts", "Type of request.">]>;
593
+ /** User address. */
594
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
595
+ }, undefined>, v.DescriptionAction<{
596
+ type: "subAccounts";
597
+ user: `0x${string}`;
598
+ }, "Request user sub-accounts.">]>;
599
+ export type SubAccountsRequest = v.InferOutput<typeof SubAccountsRequest>;
600
+ /**
601
+ * Request token details.
602
+ * @returns {TokenDetails}
603
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
604
+ */
605
+ export declare const TokenDetailsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
606
+ /** Type of request. */
607
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"tokenDetails", undefined>, v.DescriptionAction<"tokenDetails", "Type of request.">]>;
608
+ /** Token ID. */
609
+ readonly tokenId: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 34, undefined>]>, v.DescriptionAction<`0x${string}`, "Token ID.">]>;
610
+ }, undefined>, v.DescriptionAction<{
611
+ type: "tokenDetails";
612
+ tokenId: `0x${string}`;
613
+ }, "Request token details.">]>;
614
+ export type TokenDetailsRequest = v.InferOutput<typeof TokenDetailsRequest>;
615
+ /**
616
+ * Request twap history of a user.
617
+ * @returns {TwapHistory[]}
618
+ * @see null
619
+ */
620
+ export declare const TwapHistoryRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
621
+ /** Type of request. */
622
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"twapHistory", undefined>, v.DescriptionAction<"twapHistory", "Type of request.">]>;
623
+ /** User address. */
624
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
625
+ }, undefined>, v.DescriptionAction<{
626
+ type: "twapHistory";
627
+ user: `0x${string}`;
628
+ }, "Request twap history of a user.">]>;
629
+ export type TwapHistoryRequest = v.InferOutput<typeof TwapHistoryRequest>;
630
+ /**
631
+ * Request user fees.
632
+ * @returns {UserFees}
633
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
634
+ */
635
+ export declare const UserFeesRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
636
+ /** Type of request. */
637
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFees", undefined>, v.DescriptionAction<"userFees", "Type of request.">]>;
638
+ /** User address. */
639
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
640
+ }, undefined>, v.DescriptionAction<{
641
+ type: "userFees";
642
+ user: `0x${string}`;
643
+ }, "Request user fees.">]>;
644
+ export type UserFeesRequest = v.InferOutput<typeof UserFeesRequest>;
645
+ /**
646
+ * Request user fills.
647
+ * @returns {Fill[]}
648
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
649
+ */
650
+ export declare const UserFillsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
651
+ /** Type of request. */
652
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFills", undefined>, v.DescriptionAction<"userFills", "Type of request.">]>;
653
+ /** User address. */
654
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
655
+ /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
656
+ readonly aggregateByTime: v.SchemaWithPipe<readonly [v.OptionalSchema<v.BooleanSchema<undefined>, undefined>, v.DescriptionAction<boolean | undefined, "If true, partial fills are aggregated when a crossing order fills multiple resting orders.">]>;
657
+ }, undefined>, v.DescriptionAction<{
658
+ type: "userFills";
659
+ user: `0x${string}`;
660
+ aggregateByTime?: boolean | undefined;
661
+ }, "Request user fills.">]>;
662
+ export type UserFillsRequest = v.InferOutput<typeof UserFillsRequest>;
663
+ /**
664
+ * Request user fills by time.
665
+ * @returns {Fill[]}
666
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
667
+ */
668
+ export declare const UserFillsByTimeRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
669
+ /** Type of request. */
670
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFillsByTime", undefined>, v.DescriptionAction<"userFillsByTime", "Type of request.">]>;
671
+ /** User address. */
672
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
673
+ /** Start time (in ms since epoch). */
674
+ readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Start time (in ms since epoch).">]>;
675
+ /** End time (in ms since epoch). */
676
+ readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null | undefined, "End time (in ms since epoch).">]>;
677
+ /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
678
+ readonly aggregateByTime: v.SchemaWithPipe<readonly [v.OptionalSchema<v.BooleanSchema<undefined>, undefined>, v.DescriptionAction<boolean | undefined, "If true, partial fills are aggregated when a crossing order fills multiple resting orders.">]>;
679
+ }, undefined>, v.DescriptionAction<{
680
+ type: "userFillsByTime";
681
+ user: `0x${string}`;
682
+ startTime: number;
683
+ endTime?: number | null | undefined;
684
+ aggregateByTime?: boolean | undefined;
685
+ }, "Request user fills by time.">]>;
686
+ export type UserFillsByTimeRequest = v.InferOutput<typeof UserFillsByTimeRequest>;
687
+ /**
688
+ * Request user funding.
689
+ * @returns {UserFundingUpdate[]}
690
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
691
+ */
692
+ export declare const UserFundingRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
693
+ /** Type of request. */
694
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFunding", undefined>, v.DescriptionAction<"userFunding", "Type of request.">]>;
695
+ /** User address. */
696
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
697
+ /** Start time (in ms since epoch). */
698
+ readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Start time (in ms since epoch).">]>;
699
+ /** End time (in ms since epoch). */
700
+ readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null | undefined, "End time (in ms since epoch).">]>;
701
+ }, undefined>, v.DescriptionAction<{
702
+ type: "userFunding";
703
+ user: `0x${string}`;
704
+ startTime: number;
705
+ endTime?: number | null | undefined;
706
+ }, "Request user funding.">]>;
707
+ export type UserFundingRequest = v.InferOutput<typeof UserFundingRequest>;
708
+ /**
709
+ * Request user non-funding ledger updates.
710
+ * @returns {UserNonFundingLedgerUpdate[]}
711
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
712
+ */
713
+ export declare const UserNonFundingLedgerUpdatesRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
714
+ /** Type of request. */
715
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userNonFundingLedgerUpdates", undefined>, v.DescriptionAction<"userNonFundingLedgerUpdates", "Type of request.">]>;
716
+ /** User address. */
717
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
718
+ /** Start time (in ms since epoch). */
719
+ readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Start time (in ms since epoch).">]>;
720
+ /** End time (in ms since epoch). */
721
+ readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null | undefined, "End time (in ms since epoch).">]>;
722
+ }, undefined>, v.DescriptionAction<{
723
+ type: "userNonFundingLedgerUpdates";
724
+ user: `0x${string}`;
725
+ startTime: number;
726
+ endTime?: number | null | undefined;
727
+ }, "Request user non-funding ledger updates.">]>;
728
+ export type UserNonFundingLedgerUpdatesRequest = v.InferOutput<typeof UserNonFundingLedgerUpdatesRequest>;
729
+ /**
730
+ * Request user rate limits.
731
+ * @returns {UserRateLimit}
732
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
733
+ */
734
+ export declare const UserRateLimitRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
735
+ /** Type of request. */
736
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userRateLimit", undefined>, v.DescriptionAction<"userRateLimit", "Type of request.">]>;
737
+ /** User address. */
738
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
739
+ }, undefined>, v.DescriptionAction<{
740
+ type: "userRateLimit";
741
+ user: `0x${string}`;
742
+ }, "Request user rate limits.">]>;
743
+ export type UserRateLimitRequest = v.InferOutput<typeof UserRateLimitRequest>;
744
+ /**
745
+ * Request user role.
746
+ * @returns {UserRole}
747
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
748
+ */
749
+ export declare const UserRoleRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
750
+ /** Type of request. */
751
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userRole", undefined>, v.DescriptionAction<"userRole", "Type of request.">]>;
752
+ /** User address. */
753
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
754
+ }, undefined>, v.DescriptionAction<{
755
+ type: "userRole";
756
+ user: `0x${string}`;
757
+ }, "Request user role.">]>;
758
+ export type UserRoleRequest = v.InferOutput<typeof UserRoleRequest>;
759
+ /**
760
+ * Request multi-sig signers for a user.
761
+ * @returns {MultiSigSigners | null}
762
+ * @see null
763
+ */
764
+ export declare const UserToMultiSigSignersRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
765
+ /** Type of request. */
766
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userToMultiSigSigners", undefined>, v.DescriptionAction<"userToMultiSigSigners", "Type of request.">]>;
767
+ /** User address. */
768
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
769
+ }, undefined>, v.DescriptionAction<{
770
+ type: "userToMultiSigSigners";
771
+ user: `0x${string}`;
772
+ }, "Request multi-sig signers for a user.">]>;
773
+ export type UserToMultiSigSignersRequest = v.InferOutput<typeof UserToMultiSigSignersRequest>;
774
+ /**
775
+ * Request user TWAP slice fills.
776
+ * @returns {TwapSliceFill[]}
777
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
778
+ */
779
+ export declare const UserTwapSliceFillsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
780
+ /** Type of request. */
781
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userTwapSliceFills", undefined>, v.DescriptionAction<"userTwapSliceFills", "Type of request.">]>;
782
+ /** User address. */
783
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
784
+ }, undefined>, v.DescriptionAction<{
785
+ type: "userTwapSliceFills";
786
+ user: `0x${string}`;
787
+ }, "Request user TWAP slice fills.">]>;
788
+ export type UserTwapSliceFillsRequest = v.InferOutput<typeof UserTwapSliceFillsRequest>;
789
+ /**
790
+ * Request user TWAP slice fills by time.
791
+ * @returns {TwapSliceFill[]}
792
+ * @see null
793
+ */
794
+ export declare const UserTwapSliceFillsByTimeRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
795
+ /** Type of request. */
796
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userTwapSliceFillsByTime", undefined>, v.DescriptionAction<"userTwapSliceFillsByTime", "Type of request.">]>;
797
+ /** User address. */
798
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
799
+ /** Start time (in ms since epoch). */
800
+ readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Start time (in ms since epoch).">]>;
801
+ /** End time (in ms since epoch). */
802
+ readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null | undefined, "End time (in ms since epoch).">]>;
803
+ /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
804
+ readonly aggregateByTime: v.SchemaWithPipe<readonly [v.OptionalSchema<v.BooleanSchema<undefined>, undefined>, v.DescriptionAction<boolean | undefined, "If true, partial fills are aggregated when a crossing order fills multiple resting orders.">]>;
805
+ }, undefined>, v.DescriptionAction<{
806
+ type: "userTwapSliceFillsByTime";
807
+ user: `0x${string}`;
808
+ startTime: number;
809
+ endTime?: number | null | undefined;
810
+ aggregateByTime?: boolean | undefined;
811
+ }, "Request user TWAP slice fills by time.">]>;
812
+ export type UserTwapSliceFillsByTimeRequest = v.InferOutput<typeof UserTwapSliceFillsByTimeRequest>;
813
+ /**
814
+ * Request user vault deposits.
815
+ * @returns {VaultEquity[]}
816
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
817
+ */
818
+ export declare const UserVaultEquitiesRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
819
+ /** Type of request. */
820
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userVaultEquities", undefined>, v.DescriptionAction<"userVaultEquities", "Type of request.">]>;
821
+ /** User address. */
822
+ readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
823
+ }, undefined>, v.DescriptionAction<{
824
+ type: "userVaultEquities";
825
+ user: `0x${string}`;
826
+ }, "Request user vault deposits.">]>;
827
+ export type UserVaultEquitiesRequest = v.InferOutput<typeof UserVaultEquitiesRequest>;
828
+ /**
829
+ * Request validator L1 votes.
830
+ * @returns {unknown[]} FIXME: Define the return type
831
+ * @see null
832
+ */
833
+ export declare const ValidatorL1VotesRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
834
+ /** Type of request. */
835
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"validatorL1Votes", undefined>, v.DescriptionAction<"validatorL1Votes", "Type of request.">]>;
836
+ }, undefined>, v.DescriptionAction<{
837
+ type: "validatorL1Votes";
838
+ }, "Request validator L1 votes.">]>;
839
+ export type ValidatorL1VotesRequest = v.InferOutput<typeof ValidatorL1VotesRequest>;
840
+ /**
841
+ * Request validator summaries.
842
+ * @returns {ValidatorSummary[]}
843
+ * @see null
844
+ */
845
+ export declare const ValidatorSummariesRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
846
+ /** Type of request. */
847
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"validatorSummaries", undefined>, v.DescriptionAction<"validatorSummaries", "Type of request.">]>;
848
+ }, undefined>, v.DescriptionAction<{
849
+ type: "validatorSummaries";
850
+ }, "Request validator summaries.">]>;
851
+ export type ValidatorSummariesRequest = v.InferOutput<typeof ValidatorSummariesRequest>;
852
+ /**
853
+ * Request details of a vault.
854
+ * @returns {VaultDetails | null}
855
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
856
+ */
857
+ export declare const VaultDetailsRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
858
+ /** Type of request. */
859
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"vaultDetails", undefined>, v.DescriptionAction<"vaultDetails", "Type of request.">]>;
860
+ /** Vault address. */
861
+ readonly vaultAddress: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Vault address.">]>;
862
+ /** User address. */
863
+ readonly user: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | null | undefined, "User address.">]>;
864
+ }, undefined>, v.DescriptionAction<{
865
+ type: "vaultDetails";
866
+ vaultAddress: `0x${string}`;
867
+ user?: `0x${string}` | null | undefined;
868
+ }, "Request details of a vault.">]>;
869
+ export type VaultDetailsRequest = v.InferOutput<typeof VaultDetailsRequest>;
870
+ /**
871
+ * Request a list of vaults less than 2 hours old.
872
+ * @returns {VaultSummary[]}
873
+ * @see null
874
+ */
875
+ export declare const VaultSummariesRequest: v.SchemaWithPipe<readonly [v.StrictObjectSchema<{
876
+ /** Type of request. */
877
+ readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"vaultSummaries", undefined>, v.DescriptionAction<"vaultSummaries", "Type of request.">]>;
878
+ }, undefined>, v.DescriptionAction<{
879
+ type: "vaultSummaries";
880
+ }, "Request a list of vaults less than 2 hours old.">]>;
881
+ export type VaultSummariesRequest = v.InferOutput<typeof VaultSummariesRequest>;
882
+ //# sourceMappingURL=requests.d.ts.map