@nktkas/hyperliquid 0.24.2 → 0.25.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (242) hide show
  1. package/README.md +197 -117
  2. package/esm/mod.d.ts +11 -11
  3. package/esm/mod.d.ts.map +1 -1
  4. package/esm/mod.js +1 -1
  5. package/esm/src/clients/exchange.d.ts +29 -18
  6. package/esm/src/clients/exchange.d.ts.map +1 -1
  7. package/esm/src/clients/exchange.js +50 -48
  8. package/esm/src/clients/info.d.ts +79 -75
  9. package/esm/src/clients/info.d.ts.map +1 -1
  10. package/esm/src/clients/info.js +294 -163
  11. package/esm/src/clients/multiSign.d.ts +11 -7
  12. package/esm/src/clients/multiSign.d.ts.map +1 -1
  13. package/esm/src/clients/subscription.d.ts +105 -32
  14. package/esm/src/clients/subscription.d.ts.map +1 -1
  15. package/esm/src/clients/subscription.js +114 -33
  16. package/esm/src/{base.d.ts → errors.d.ts} +1 -1
  17. package/esm/src/errors.d.ts.map +1 -0
  18. package/esm/src/schemas/_base.d.ts +10 -0
  19. package/esm/src/schemas/_base.d.ts.map +1 -0
  20. package/esm/src/schemas/_base.js +12 -0
  21. package/esm/src/schemas/exchange/requests.d.ts +8953 -0
  22. package/esm/src/schemas/exchange/requests.d.ts.map +1 -0
  23. package/esm/src/schemas/exchange/requests.js +1413 -0
  24. package/esm/src/schemas/exchange/responses.d.ts +567 -0
  25. package/esm/src/schemas/exchange/responses.d.ts.map +1 -0
  26. package/esm/src/schemas/exchange/responses.js +243 -0
  27. package/esm/src/schemas/explorer/requests.d.ts +44 -0
  28. package/esm/src/schemas/explorer/requests.d.ts.map +1 -0
  29. package/esm/src/schemas/explorer/requests.js +32 -0
  30. package/esm/src/schemas/explorer/responses.d.ts +360 -0
  31. package/esm/src/schemas/explorer/responses.d.ts.map +1 -0
  32. package/esm/src/schemas/explorer/responses.js +56 -0
  33. package/esm/src/schemas/info/accounts.d.ts +2159 -0
  34. package/esm/src/schemas/info/accounts.d.ts.map +1 -0
  35. package/esm/src/schemas/info/accounts.js +622 -0
  36. package/esm/src/schemas/info/assets.d.ts +945 -0
  37. package/esm/src/schemas/info/assets.d.ts.map +1 -0
  38. package/esm/src/schemas/info/assets.js +265 -0
  39. package/esm/src/schemas/info/markets.d.ts +138 -0
  40. package/esm/src/schemas/info/markets.d.ts.map +1 -0
  41. package/esm/src/schemas/info/markets.js +58 -0
  42. package/esm/src/schemas/info/orders.d.ts +957 -0
  43. package/esm/src/schemas/info/orders.d.ts.map +1 -0
  44. package/esm/src/schemas/info/orders.js +297 -0
  45. package/esm/src/schemas/info/requests.d.ts +882 -0
  46. package/esm/src/schemas/info/requests.d.ts.map +1 -0
  47. package/esm/src/schemas/info/requests.js +655 -0
  48. package/esm/src/schemas/info/validators.d.ts +305 -0
  49. package/esm/src/schemas/info/validators.d.ts.map +1 -0
  50. package/esm/src/schemas/info/validators.js +112 -0
  51. package/esm/src/schemas/info/vaults.d.ts +447 -0
  52. package/esm/src/schemas/info/vaults.d.ts.map +1 -0
  53. package/esm/src/schemas/info/vaults.js +110 -0
  54. package/esm/src/schemas/mod.d.ts +100 -0
  55. package/esm/src/schemas/mod.d.ts.map +1 -0
  56. package/esm/src/schemas/mod.js +113 -0
  57. package/esm/src/schemas/subscriptions/requests.d.ts +332 -0
  58. package/esm/src/schemas/subscriptions/requests.d.ts.map +1 -0
  59. package/esm/src/schemas/subscriptions/requests.js +258 -0
  60. package/esm/src/schemas/subscriptions/responses.d.ts +3643 -0
  61. package/esm/src/schemas/subscriptions/responses.d.ts.map +1 -0
  62. package/esm/src/schemas/subscriptions/responses.js +233 -0
  63. package/esm/src/signing/mod.d.ts +109 -29
  64. package/esm/src/signing/mod.d.ts.map +1 -1
  65. package/esm/src/signing/mod.js +135 -29
  66. package/esm/src/transports/base.d.ts +2 -2
  67. package/esm/src/transports/base.d.ts.map +1 -1
  68. package/esm/src/transports/base.js +2 -2
  69. package/esm/src/transports/http/http_transport.d.ts +2 -1
  70. package/esm/src/transports/http/http_transport.d.ts.map +1 -1
  71. package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts +1 -1
  72. package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
  73. package/esm/src/transports/websocket/websocket_transport.d.ts +2 -1
  74. package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
  75. package/package.json +6 -5
  76. package/script/mod.d.ts +11 -11
  77. package/script/mod.d.ts.map +1 -1
  78. package/script/mod.js +1 -1
  79. package/script/src/clients/exchange.d.ts +29 -18
  80. package/script/src/clients/exchange.d.ts.map +1 -1
  81. package/script/src/clients/exchange.js +56 -54
  82. package/script/src/clients/info.d.ts +79 -75
  83. package/script/src/clients/info.d.ts.map +1 -1
  84. package/script/src/clients/info.js +294 -163
  85. package/script/src/clients/multiSign.d.ts +11 -7
  86. package/script/src/clients/multiSign.d.ts.map +1 -1
  87. package/script/src/clients/subscription.d.ts +105 -32
  88. package/script/src/clients/subscription.d.ts.map +1 -1
  89. package/script/src/clients/subscription.js +114 -33
  90. package/script/src/{base.d.ts → errors.d.ts} +1 -1
  91. package/script/src/errors.d.ts.map +1 -0
  92. package/script/src/schemas/_base.d.ts +10 -0
  93. package/script/src/schemas/_base.d.ts.map +1 -0
  94. package/script/src/schemas/_base.js +48 -0
  95. package/script/src/schemas/exchange/requests.d.ts +8953 -0
  96. package/script/src/schemas/exchange/requests.d.ts.map +1 -0
  97. package/script/src/schemas/exchange/requests.js +1449 -0
  98. package/script/src/schemas/exchange/responses.d.ts +567 -0
  99. package/script/src/schemas/exchange/responses.d.ts.map +1 -0
  100. package/script/src/schemas/exchange/responses.js +279 -0
  101. package/script/src/schemas/explorer/requests.d.ts +44 -0
  102. package/script/src/schemas/explorer/requests.d.ts.map +1 -0
  103. package/script/src/schemas/explorer/requests.js +68 -0
  104. package/script/src/schemas/explorer/responses.d.ts +360 -0
  105. package/script/src/schemas/explorer/responses.d.ts.map +1 -0
  106. package/script/src/schemas/explorer/responses.js +92 -0
  107. package/script/src/schemas/info/accounts.d.ts +2159 -0
  108. package/script/src/schemas/info/accounts.d.ts.map +1 -0
  109. package/script/src/schemas/info/accounts.js +658 -0
  110. package/script/src/schemas/info/assets.d.ts +945 -0
  111. package/script/src/schemas/info/assets.d.ts.map +1 -0
  112. package/script/src/schemas/info/assets.js +301 -0
  113. package/script/src/schemas/info/markets.d.ts +138 -0
  114. package/script/src/schemas/info/markets.d.ts.map +1 -0
  115. package/script/src/schemas/info/markets.js +94 -0
  116. package/script/src/schemas/info/orders.d.ts +957 -0
  117. package/script/src/schemas/info/orders.d.ts.map +1 -0
  118. package/script/src/schemas/info/orders.js +333 -0
  119. package/script/src/schemas/info/requests.d.ts +882 -0
  120. package/script/src/schemas/info/requests.d.ts.map +1 -0
  121. package/script/src/schemas/info/requests.js +692 -0
  122. package/script/src/schemas/info/validators.d.ts +305 -0
  123. package/script/src/schemas/info/validators.d.ts.map +1 -0
  124. package/script/src/schemas/info/validators.js +148 -0
  125. package/script/src/schemas/info/vaults.d.ts +447 -0
  126. package/script/src/schemas/info/vaults.d.ts.map +1 -0
  127. package/script/src/schemas/info/vaults.js +146 -0
  128. package/script/src/schemas/mod.d.ts +100 -0
  129. package/script/src/schemas/mod.d.ts.map +1 -0
  130. package/script/src/schemas/mod.js +154 -0
  131. package/script/src/schemas/subscriptions/requests.d.ts +332 -0
  132. package/script/src/schemas/subscriptions/requests.d.ts.map +1 -0
  133. package/script/src/schemas/subscriptions/requests.js +294 -0
  134. package/script/src/schemas/subscriptions/responses.d.ts +3643 -0
  135. package/script/src/schemas/subscriptions/responses.d.ts.map +1 -0
  136. package/script/src/schemas/subscriptions/responses.js +269 -0
  137. package/script/src/signing/mod.d.ts +109 -29
  138. package/script/src/signing/mod.d.ts.map +1 -1
  139. package/script/src/signing/mod.js +137 -33
  140. package/script/src/transports/base.d.ts +2 -2
  141. package/script/src/transports/base.d.ts.map +1 -1
  142. package/script/src/transports/base.js +3 -3
  143. package/script/src/transports/http/http_transport.d.ts +2 -1
  144. package/script/src/transports/http/http_transport.d.ts.map +1 -1
  145. package/script/src/transports/websocket/_hyperliquid_event_target.d.ts +1 -1
  146. package/script/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
  147. package/script/src/transports/websocket/websocket_transport.d.ts +2 -1
  148. package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
  149. package/esm/src/base.d.ts.map +0 -1
  150. package/esm/src/signing/_sorter.d.ts +0 -127
  151. package/esm/src/signing/_sorter.d.ts.map +0 -1
  152. package/esm/src/signing/_sorter.js +0 -693
  153. package/esm/src/types/exchange/requests.d.ts +0 -1345
  154. package/esm/src/types/exchange/requests.d.ts.map +0 -1
  155. package/esm/src/types/exchange/requests.js +0 -1
  156. package/esm/src/types/exchange/responses.d.ts +0 -233
  157. package/esm/src/types/exchange/responses.d.ts.map +0 -1
  158. package/esm/src/types/exchange/responses.js +0 -1
  159. package/esm/src/types/explorer/requests.d.ts +0 -32
  160. package/esm/src/types/explorer/requests.d.ts.map +0 -1
  161. package/esm/src/types/explorer/requests.js +0 -1
  162. package/esm/src/types/explorer/responses.d.ts +0 -58
  163. package/esm/src/types/explorer/responses.d.ts.map +0 -1
  164. package/esm/src/types/explorer/responses.js +0 -1
  165. package/esm/src/types/info/accounts.d.ts +0 -864
  166. package/esm/src/types/info/accounts.d.ts.map +0 -1
  167. package/esm/src/types/info/accounts.js +0 -1
  168. package/esm/src/types/info/assets.d.ts +0 -354
  169. package/esm/src/types/info/assets.d.ts.map +0 -1
  170. package/esm/src/types/info/assets.js +0 -1
  171. package/esm/src/types/info/markets.d.ts +0 -79
  172. package/esm/src/types/info/markets.d.ts.map +0 -1
  173. package/esm/src/types/info/markets.js +0 -1
  174. package/esm/src/types/info/orders.d.ts +0 -266
  175. package/esm/src/types/info/orders.d.ts.map +0 -1
  176. package/esm/src/types/info/orders.js +0 -1
  177. package/esm/src/types/info/requests.d.ts +0 -634
  178. package/esm/src/types/info/requests.d.ts.map +0 -1
  179. package/esm/src/types/info/requests.js +0 -1
  180. package/esm/src/types/info/validators.d.ts +0 -147
  181. package/esm/src/types/info/validators.d.ts.map +0 -1
  182. package/esm/src/types/info/validators.js +0 -1
  183. package/esm/src/types/info/vaults.d.ts +0 -119
  184. package/esm/src/types/info/vaults.d.ts.map +0 -1
  185. package/esm/src/types/info/vaults.js +0 -1
  186. package/esm/src/types/mod.d.ts +0 -38
  187. package/esm/src/types/mod.d.ts.map +0 -1
  188. package/esm/src/types/mod.js +0 -24
  189. package/esm/src/types/subscriptions/requests.d.ts +0 -143
  190. package/esm/src/types/subscriptions/requests.d.ts.map +0 -1
  191. package/esm/src/types/subscriptions/requests.js +0 -1
  192. package/esm/src/types/subscriptions/responses.d.ts +0 -213
  193. package/esm/src/types/subscriptions/responses.d.ts.map +0 -1
  194. package/esm/src/types/subscriptions/responses.js +0 -1
  195. package/script/src/base.d.ts.map +0 -1
  196. package/script/src/signing/_sorter.d.ts +0 -127
  197. package/script/src/signing/_sorter.d.ts.map +0 -1
  198. package/script/src/signing/_sorter.js +0 -696
  199. package/script/src/types/exchange/requests.d.ts +0 -1345
  200. package/script/src/types/exchange/requests.d.ts.map +0 -1
  201. package/script/src/types/exchange/requests.js +0 -2
  202. package/script/src/types/exchange/responses.d.ts +0 -233
  203. package/script/src/types/exchange/responses.d.ts.map +0 -1
  204. package/script/src/types/exchange/responses.js +0 -2
  205. package/script/src/types/explorer/requests.d.ts +0 -32
  206. package/script/src/types/explorer/requests.d.ts.map +0 -1
  207. package/script/src/types/explorer/requests.js +0 -2
  208. package/script/src/types/explorer/responses.d.ts +0 -58
  209. package/script/src/types/explorer/responses.d.ts.map +0 -1
  210. package/script/src/types/explorer/responses.js +0 -2
  211. package/script/src/types/info/accounts.d.ts +0 -864
  212. package/script/src/types/info/accounts.d.ts.map +0 -1
  213. package/script/src/types/info/accounts.js +0 -2
  214. package/script/src/types/info/assets.d.ts +0 -354
  215. package/script/src/types/info/assets.d.ts.map +0 -1
  216. package/script/src/types/info/assets.js +0 -2
  217. package/script/src/types/info/markets.d.ts +0 -79
  218. package/script/src/types/info/markets.d.ts.map +0 -1
  219. package/script/src/types/info/markets.js +0 -2
  220. package/script/src/types/info/orders.d.ts +0 -266
  221. package/script/src/types/info/orders.d.ts.map +0 -1
  222. package/script/src/types/info/orders.js +0 -2
  223. package/script/src/types/info/requests.d.ts +0 -634
  224. package/script/src/types/info/requests.d.ts.map +0 -1
  225. package/script/src/types/info/requests.js +0 -2
  226. package/script/src/types/info/validators.d.ts +0 -147
  227. package/script/src/types/info/validators.d.ts.map +0 -1
  228. package/script/src/types/info/validators.js +0 -2
  229. package/script/src/types/info/vaults.d.ts +0 -119
  230. package/script/src/types/info/vaults.d.ts.map +0 -1
  231. package/script/src/types/info/vaults.js +0 -2
  232. package/script/src/types/mod.d.ts +0 -38
  233. package/script/src/types/mod.d.ts.map +0 -1
  234. package/script/src/types/mod.js +0 -25
  235. package/script/src/types/subscriptions/requests.d.ts +0 -143
  236. package/script/src/types/subscriptions/requests.d.ts.map +0 -1
  237. package/script/src/types/subscriptions/requests.js +0 -2
  238. package/script/src/types/subscriptions/responses.d.ts +0 -213
  239. package/script/src/types/subscriptions/responses.d.ts.map +0 -1
  240. package/script/src/types/subscriptions/responses.js +0 -2
  241. /package/esm/src/{base.js → errors.js} +0 -0
  242. /package/script/src/{base.js → errors.js} +0 -0
@@ -1,147 +0,0 @@
1
- import type { Hex } from "../mod.js";
2
- /** User delegation to a validator. */
3
- export interface Delegation {
4
- /** Validator address. */
5
- validator: Hex;
6
- /**
7
- * Amount of tokens delegated to the validator.
8
- * @pattern ^[0-9]+(\.[0-9]+)?$
9
- */
10
- amount: string;
11
- /** Locked until timestamp (in ms since epoch). */
12
- lockedUntilTimestamp: number;
13
- }
14
- /** Reward received from staking activities. */
15
- export interface DelegatorReward {
16
- /** Timestamp when the reward was received (in ms since epoch). */
17
- time: number;
18
- /** Source of the reward. */
19
- source: "delegation" | "commission";
20
- /**
21
- * Total reward amount.
22
- * @pattern ^[0-9]+(\.[0-9]+)?$
23
- */
24
- totalAmount: string;
25
- }
26
- /** Summary of a user staking delegations. */
27
- export interface DelegatorSummary {
28
- /**
29
- * Total amount of delegated tokens.
30
- * @pattern ^[0-9]+(\.[0-9]+)?$
31
- */
32
- delegated: string;
33
- /**
34
- * Total amount of undelegated tokens.
35
- * @pattern ^[0-9]+(\.[0-9]+)?$
36
- */
37
- undelegated: string;
38
- /**
39
- * Total amount of tokens pending withdrawal.
40
- * @pattern ^[0-9]+(\.[0-9]+)?$
41
- */
42
- totalPendingWithdrawal: string;
43
- /** Number of pending withdrawals. */
44
- nPendingWithdrawals: number;
45
- }
46
- /** Record of a staking event by a delegator. */
47
- export interface DelegatorUpdate {
48
- /** Timestamp of the delegation event (in ms since epoch). */
49
- time: number;
50
- /** Transaction hash of the delegation event. */
51
- hash: Hex;
52
- /** Details of the update. */
53
- delta: DelegatorUpdateDelegate | DelegatorUpdateDeposit | DelegatorUpdateWithdrawal;
54
- }
55
- /** Delegation operation in a delegator update. */
56
- export interface DelegatorUpdateDelegate {
57
- /** Delegation operation details. */
58
- delegate: {
59
- /** Address of the validator receiving or losing delegation. */
60
- validator: Hex;
61
- /**
62
- * Amount of tokens being delegated or undelegated.
63
- * @pattern ^[0-9]+(\.[0-9]+)?$
64
- */
65
- amount: string;
66
- /** Whether this is an undelegation operation. */
67
- isUndelegate: boolean;
68
- };
69
- }
70
- /** Deposit operation in a delegator update. */
71
- export interface DelegatorUpdateDeposit {
72
- /** Deposit details. */
73
- cDeposit: {
74
- /**
75
- * Amount of tokens being deposited.
76
- * @pattern ^[0-9]+(\.[0-9]+)?$
77
- */
78
- amount: string;
79
- };
80
- }
81
- /** Withdrawal operation in a delegator update. */
82
- export interface DelegatorUpdateWithdrawal {
83
- /** Withdrawal details. */
84
- withdrawal: {
85
- /**
86
- * Amount of tokens being withdrawn.
87
- * @pattern ^[0-9]+(\.[0-9]+)?$
88
- */
89
- amount: string;
90
- /** Phase of the withdrawal process. */
91
- phase: "initiated" | "finalized";
92
- };
93
- }
94
- /** Statistics for validator performance over a time period. */
95
- export interface ValidatorStats {
96
- /** Fraction of time the validator was online. */
97
- uptimeFraction: string;
98
- /**
99
- * Predicted annual percentage rate of returns.
100
- * @pattern ^[0-9]+(\.[0-9]+)?$
101
- */
102
- predictedApr: string;
103
- /** Number of samples used for statistics calculation. */
104
- nSamples: number;
105
- }
106
- /** Summary of a validator status and performance. */
107
- export interface ValidatorSummary {
108
- /** Address of the validator. */
109
- validator: Hex;
110
- /** Address of the validator signer. */
111
- signer: Hex;
112
- /** Name of the validator. */
113
- name: string;
114
- /** Description of the validator. */
115
- description: string;
116
- /** Number of blocks produced recently. */
117
- nRecentBlocks: number;
118
- /** Total amount of tokens staked. */
119
- stake: number;
120
- /** Whether the validator is currently jailed. */
121
- isJailed: boolean;
122
- /** Timestamp when the validator can be unjailed (in ms since epoch). */
123
- unjailableAfter: number | null;
124
- /** Whether the validator is currently active. */
125
- isActive: boolean;
126
- /**
127
- * Commission rate charged by the validator.
128
- * @pattern ^[0-9]+(\.[0-9]+)?$
129
- */
130
- commission: string;
131
- /** Performance statistics over different time periods. */
132
- stats: [
133
- [
134
- "day",
135
- ValidatorStats
136
- ],
137
- [
138
- "week",
139
- ValidatorStats
140
- ],
141
- [
142
- "month",
143
- ValidatorStats
144
- ]
145
- ];
146
- }
147
- //# sourceMappingURL=validators.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../../../../src/src/types/info/validators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAErC,sCAAsC;AACtC,MAAM,WAAW,UAAU;IACvB,yBAAyB;IACzB,SAAS,EAAE,GAAG,CAAC;IACf;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,kDAAkD;IAClD,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAED,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC5B,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,MAAM,EAAE,YAAY,GAAG,YAAY,CAAC;IACpC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,6CAA6C;AAC7C,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B,qCAAqC;IACrC,mBAAmB,EAAE,MAAM,CAAC;CAC/B;AAED,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC5B,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,IAAI,EAAE,GAAG,CAAC;IACV,6BAA6B;IAC7B,KAAK,EAAE,uBAAuB,GAAG,sBAAsB,GAAG,yBAAyB,CAAC;CACvF;AAED,kDAAkD;AAClD,MAAM,WAAW,uBAAuB;IACpC,oCAAoC;IACpC,QAAQ,EAAE;QACN,+DAA+D;QAC/D,SAAS,EAAE,GAAG,CAAC;QACf;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QACf,iDAAiD;QACjD,YAAY,EAAE,OAAO,CAAC;KACzB,CAAC;CACL;AAED,+CAA+C;AAC/C,MAAM,WAAW,sBAAsB;IACnC,uBAAuB;IACvB,QAAQ,EAAE;QACN;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL;AAED,kDAAkD;AAClD,MAAM,WAAW,yBAAyB;IACtC,0BAA0B;IAC1B,UAAU,EAAE;QACR;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QACf,uCAAuC;QACvC,KAAK,EAAE,WAAW,GAAG,WAAW,CAAC;KACpC,CAAC;CACL;AAED,+DAA+D;AAC/D,MAAM,WAAW,cAAc;IAC3B,iDAAiD;IACjD,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,qDAAqD;AACrD,MAAM,WAAW,gBAAgB;IAC7B,gCAAgC;IAChC,SAAS,EAAE,GAAG,CAAC;IACf,uCAAuC;IACvC,MAAM,EAAE,GAAG,CAAC;IACZ,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,QAAQ,EAAE,OAAO,CAAC;IAClB,wEAAwE;IACxE,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,iDAAiD;IACjD,QAAQ,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,0DAA0D;IAC1D,KAAK,EAAE;QACH;YAAC,KAAK;YAAE,cAAc;SAAC;QACvB;YAAC,MAAM;YAAE,cAAc;SAAC;QACxB;YAAC,OAAO;YAAE,cAAc;SAAC;KAC5B,CAAC;CACL"}
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,119 +0,0 @@
1
- import type { Hex } from "../mod.js";
2
- import type { PortfolioPeriods } from "./accounts.js";
3
- /** Details about a vault. */
4
- export interface VaultDetails {
5
- /** Vault name. */
6
- name: string;
7
- /** Vault address. */
8
- vaultAddress: Hex;
9
- /** Leader address. */
10
- leader: Hex;
11
- /** Vault description. */
12
- description: string;
13
- /** Vault portfolio metrics grouped by time periods. */
14
- portfolio: PortfolioPeriods;
15
- /** Annual percentage rate. */
16
- apr: number;
17
- /** Current user follower state */
18
- followerState: VaultFollowerState | null;
19
- /** Ownership percentage held by leader. */
20
- leaderFraction: number;
21
- /** Leader commission percentage. */
22
- leaderCommission: number;
23
- /** Vault followers list. */
24
- followers: (Omit<VaultFollowerState, "user"> & {
25
- /** Follower address or Leader. */
26
- user: Hex | "Leader";
27
- })[];
28
- /** Maximum distributable amount. */
29
- maxDistributable: number;
30
- /** Maximum withdrawable amount. */
31
- maxWithdrawable: number;
32
- /** Vault closure status. */
33
- isClosed: boolean;
34
- /** Vault relationship type. */
35
- relationship: VaultRelationship;
36
- /** Deposit permission status. */
37
- allowDeposits: boolean;
38
- /** Position closure policy on withdrawal. */
39
- alwaysCloseOnWithdraw: boolean;
40
- }
41
- /** User vault equity details. */
42
- export interface VaultEquity {
43
- /** Vault address. */
44
- vaultAddress: Hex;
45
- /**
46
- * User deposited equity.
47
- * @pattern ^[0-9]+(\.[0-9]+)?$
48
- */
49
- equity: string;
50
- /** Timestamp when the user can withdraw their equity. */
51
- lockedUntilTimestamp: number;
52
- }
53
- /** Vault follower state. */
54
- export interface VaultFollowerState {
55
- /** Follower address. */
56
- user: Hex;
57
- /**
58
- * Follower vault equity.
59
- * @pattern ^[0-9]+(\.[0-9]+)?$
60
- */
61
- vaultEquity: string;
62
- /**
63
- * Current profit and loss.
64
- * @pattern ^-?[0-9]+(\.[0-9]+)?$
65
- */
66
- pnl: string;
67
- /**
68
- * All-time profit and loss.
69
- * @pattern ^-?[0-9]+(\.[0-9]+)?$
70
- */
71
- allTimePnl: string;
72
- /** Subscription duration in days. */
73
- daysFollowing: number;
74
- /** Vault entry timestamp. */
75
- vaultEntryTime: number;
76
- /** Timestamp when funds become unlocked. */
77
- lockupUntil: number;
78
- }
79
- /** Vault relationship configuration. */
80
- export type VaultRelationship = {
81
- /** Relationship type. */
82
- type: "normal" | "child";
83
- } | {
84
- /** Relationship type. */
85
- type: "parent";
86
- /** Child vault information. */
87
- data: {
88
- /** Child vault addresses. */
89
- childAddresses: Hex[];
90
- };
91
- };
92
- /** Summary of a vault. */
93
- export interface VaultSummary {
94
- /** Vault name. */
95
- name: string;
96
- /** Vault address. */
97
- vaultAddress: Hex;
98
- /** Leader address. */
99
- leader: Hex;
100
- /**
101
- * Total value locked.
102
- * @pattern ^[0-9]+(\.[0-9]+)?$
103
- */
104
- tvl: string;
105
- /** Vault closure status. */
106
- isClosed: boolean;
107
- /** Vault relationship type. */
108
- relationship: VaultRelationship;
109
- /** Creation timestamp. */
110
- createTimeMillis: number;
111
- }
112
- /** Vault that a user is leading. */
113
- export interface VaultLeading {
114
- /** Vault address. */
115
- address: Hex;
116
- /** Vault name. */
117
- name: string;
118
- }
119
- //# sourceMappingURL=vaults.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"vaults.d.ts","sourceRoot":"","sources":["../../../../src/src/types/info/vaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEtD,6BAA6B;AAC7B,MAAM,WAAW,YAAY;IACzB,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,YAAY,EAAE,GAAG,CAAC;IAClB,sBAAsB;IACtB,MAAM,EAAE,GAAG,CAAC;IACZ,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,SAAS,EAAE,gBAAgB,CAAC;IAC5B,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,kCAAkC;IAClC,aAAa,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACzC,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,4BAA4B;IAC5B,SAAS,EAAE,CACL,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,GAChC;QACE,kCAAkC;QAClC,IAAI,EAAE,GAAG,GAAG,QAAQ,CAAC;KACxB,CACJ,EAAE,CAAC;IACJ,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mCAAmC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,4BAA4B;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,+BAA+B;IAC/B,YAAY,EAAE,iBAAiB,CAAC;IAChC,iCAAiC;IACjC,aAAa,EAAE,OAAO,CAAC;IACvB,6CAA6C;IAC7C,qBAAqB,EAAE,OAAO,CAAC;CAClC;AAED,iCAAiC;AACjC,MAAM,WAAW,WAAW;IACxB,qBAAqB;IACrB,YAAY,EAAE,GAAG,CAAC;IAClB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAED,4BAA4B;AAC5B,MAAM,WAAW,kBAAkB;IAC/B,wBAAwB;IACxB,IAAI,EAAE,GAAG,CAAC;IACV;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,6BAA6B;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,wCAAwC;AACxC,MAAM,MAAM,iBAAiB,GACvB;IACE,yBAAyB;IACzB,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;CAC5B,GACC;IACE,yBAAyB;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,+BAA+B;IAC/B,IAAI,EAAE;QACF,6BAA6B;QAC7B,cAAc,EAAE,GAAG,EAAE,CAAC;KACzB,CAAC;CACL,CAAC;AAEN,0BAA0B;AAC1B,MAAM,WAAW,YAAY;IACzB,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,YAAY,EAAE,GAAG,CAAC;IAClB,sBAAsB;IACtB,MAAM,EAAE,GAAG,CAAC;IACZ;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,4BAA4B;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,+BAA+B;IAC/B,YAAY,EAAE,iBAAiB,CAAC;IAChC,0BAA0B;IAC1B,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED,oCAAoC;AACpC,MAAM,WAAW,YAAY;IACzB,qBAAqB;IACrB,OAAO,EAAE,GAAG,CAAC;IACb,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;CAChB"}
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,38 +0,0 @@
1
- /**
2
- * This module contains all types related to the Hyperliquid API.
3
- *
4
- * @example
5
- * ```ts
6
- * import type { OrderParams } from "@nktkas/hyperliquid/types";
7
- *
8
- * const myOrder: OrderParams = {
9
- * a: 0, // Asset index
10
- * b: true, // Buy order
11
- * p: "30000", // Price
12
- * s: "0.1", // Size
13
- * r: false, // Not reduce-only
14
- * t: {
15
- * limit: {
16
- * tif: "Gtc", // Good-til-cancelled
17
- * },
18
- * },
19
- * };
20
- * ```
21
- *
22
- * @module
23
- */
24
- export type Hex = `0x${string}`;
25
- export type * from "./exchange/requests.js";
26
- export type * from "./exchange/responses.js";
27
- export type * from "./explorer/requests.js";
28
- export type * from "./explorer/responses.js";
29
- export type * from "./info/accounts.js";
30
- export type * from "./info/assets.js";
31
- export type * from "./info/markets.js";
32
- export type * from "./info/orders.js";
33
- export type * from "./info/requests.js";
34
- export type * from "./info/validators.js";
35
- export type * from "./info/vaults.js";
36
- export type * from "./subscriptions/responses.js";
37
- export type * from "./subscriptions/requests.js";
38
- //# sourceMappingURL=mod.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/src/types/mod.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AAEhC,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,yBAAyB,CAAC;AAE7C,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,yBAAyB,CAAC;AAE7C,mBAAmB,oBAAoB,CAAC;AACxC,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,oBAAoB,CAAC;AACxC,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,kBAAkB,CAAC;AAEtC,mBAAmB,8BAA8B,CAAC;AAClD,mBAAmB,6BAA6B,CAAC"}
@@ -1,25 +0,0 @@
1
- "use strict";
2
- /**
3
- * This module contains all types related to the Hyperliquid API.
4
- *
5
- * @example
6
- * ```ts
7
- * import type { OrderParams } from "@nktkas/hyperliquid/types";
8
- *
9
- * const myOrder: OrderParams = {
10
- * a: 0, // Asset index
11
- * b: true, // Buy order
12
- * p: "30000", // Price
13
- * s: "0.1", // Size
14
- * r: false, // Not reduce-only
15
- * t: {
16
- * limit: {
17
- * tif: "Gtc", // Good-til-cancelled
18
- * },
19
- * },
20
- * };
21
- * ```
22
- *
23
- * @module
24
- */
25
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,143 +0,0 @@
1
- import type { Hex } from "../mod.js";
2
- /**
3
- * Context events for a specific perpetual asset.
4
- * @returns {WsActiveAssetCtx | WsActiveSpotAssetCtx}
5
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
6
- */
7
- export interface WsActiveAssetCtxRequest {
8
- /** Type of subscription. */
9
- type: "activeAssetCtx";
10
- /** Asset symbol (e.g., BTC). */
11
- coin: string;
12
- }
13
- /**
14
- * Best bid and offer events for a specific asset.
15
- * @returns {WsBbo}
16
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
17
- */
18
- export interface WsBboRequest {
19
- /** Type of subscription. */
20
- type: "bbo";
21
- /** Asset symbol (e.g., BTC). */
22
- coin: string;
23
- }
24
- /**
25
- * Candlestick data events for a specific asset.
26
- * @returns {Candle}
27
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
28
- */
29
- export interface WsCandleRequest {
30
- /** Type of subscription. */
31
- type: "candle";
32
- /** Asset symbol (e.g., BTC). */
33
- coin: string;
34
- /** Time interval. */
35
- interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
36
- }
37
- /**
38
- * Explorer block events.
39
- * @returns {WsBlockDetails[]}
40
- * @see null
41
- */
42
- export interface WsExplorerBlockRequest {
43
- /** Type of subscription. */
44
- type: "explorerBlock";
45
- }
46
- /**
47
- * Explorer transaction events.
48
- * @returns {TxDetails[]}
49
- * @see null
50
- */
51
- export interface WsExplorerTxsRequest {
52
- /** Type of subscription. */
53
- type: "explorerTxs";
54
- }
55
- /**
56
- * Notification events for a specific user.
57
- * @returns {WsNotification}
58
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
59
- */
60
- export interface WsNotificationRequest {
61
- /** Type of subscription. */
62
- type: "notification";
63
- /** User address. */
64
- user: Hex;
65
- }
66
- /**
67
- * Order status events for a specific user.
68
- * @returns {OrderStatus<Order>[]}
69
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
70
- */
71
- export interface WsOrderUpdatesRequest {
72
- /** Type of subscription. */
73
- type: "orderUpdates";
74
- /** User address. */
75
- user: Hex;
76
- }
77
- /**
78
- * Real-time trade updates for a specific asset.
79
- * @returns {WsTrade[]}
80
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
81
- */
82
- export interface WsTradesRequest {
83
- /** Type of subscription. */
84
- type: "trades";
85
- /** Asset symbol (e.g., BTC). */
86
- coin: string;
87
- }
88
- /**
89
- * Non-order events for a specific user.
90
- * @returns {WsUserEvent}
91
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
92
- */
93
- export interface WsUserEventsRequest {
94
- /** Type of subscription. */
95
- type: "userEvents";
96
- /** User address. */
97
- user: Hex;
98
- }
99
- /**
100
- * Funding payment events for a specific user.
101
- * @returns {WsUserFundings}
102
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
103
- */
104
- export interface WsUserFundingsRequest {
105
- /** Type of subscription. */
106
- type: "userFundings";
107
- /** User address. */
108
- user: Hex;
109
- }
110
- /**
111
- * Non-funding ledger events for a specific user.
112
- * @returns {WsUserNonFundingLedgerUpdates}
113
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
114
- */
115
- export interface WsUserNonFundingLedgerUpdatesRequest {
116
- /** Type of subscription. */
117
- type: "userNonFundingLedgerUpdates";
118
- /** User address. */
119
- user: Hex;
120
- }
121
- /**
122
- * TWAP order history events for a specific user.
123
- * @returns {WsUserTwapHistory}
124
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
125
- */
126
- export interface WsUserTwapHistoryRequest {
127
- /** Type of subscription. */
128
- type: "userTwapHistory";
129
- /** User address. */
130
- user: Hex;
131
- }
132
- /**
133
- * Comprehensive user and market data events.
134
- * @returns {WsWebData2}
135
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
136
- */
137
- export interface WsWebData2Request {
138
- /** Type of subscription. */
139
- type: "webData2";
140
- /** User address. */
141
- user: Hex;
142
- }
143
- //# sourceMappingURL=requests.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/src/types/subscriptions/requests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,4BAA4B;IAC5B,IAAI,EAAE,gBAAgB,CAAC;IACvB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB,4BAA4B;IAC5B,IAAI,EAAE,KAAK,CAAC;IACZ,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B,4BAA4B;IAC5B,IAAI,EAAE,QAAQ,CAAC;IACf,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,QAAQ,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CAChH;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,4BAA4B;IAC5B,IAAI,EAAE,eAAe,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,4BAA4B;IAC5B,IAAI,EAAE,aAAa,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC,4BAA4B;IAC5B,IAAI,EAAE,cAAc,CAAC;IACrB,oBAAoB;IACpB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC,4BAA4B;IAC5B,IAAI,EAAE,cAAc,CAAC;IACrB,oBAAoB;IACpB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B,4BAA4B;IAC5B,IAAI,EAAE,QAAQ,CAAC;IACf,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,4BAA4B;IAC5B,IAAI,EAAE,YAAY,CAAC;IACnB,oBAAoB;IACpB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC,4BAA4B;IAC5B,IAAI,EAAE,cAAc,CAAC;IACrB,oBAAoB;IACpB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,oCAAoC;IACjD,4BAA4B;IAC5B,IAAI,EAAE,6BAA6B,CAAC;IACpC,oBAAoB;IACpB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC,4BAA4B;IAC5B,IAAI,EAAE,iBAAiB,CAAC;IACxB,oBAAoB;IACpB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B,4BAA4B;IAC5B,IAAI,EAAE,UAAU,CAAC;IACjB,oBAAoB;IACpB,IAAI,EAAE,GAAG,CAAC;CACb"}
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });