@nktkas/hyperliquid 0.23.1 → 0.24.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 (165) hide show
  1. package/CONTRIBUTING.md +3 -2
  2. package/README.md +178 -194
  3. package/esm/mod.d.ts +2 -1
  4. package/esm/mod.d.ts.map +1 -1
  5. package/esm/src/base.d.ts +0 -5
  6. package/esm/src/base.d.ts.map +1 -1
  7. package/esm/src/clients/exchange.d.ts +485 -392
  8. package/esm/src/clients/exchange.d.ts.map +1 -1
  9. package/esm/src/clients/exchange.js +517 -912
  10. package/esm/src/clients/info.d.ts +249 -203
  11. package/esm/src/clients/info.d.ts.map +1 -1
  12. package/esm/src/clients/info.js +258 -368
  13. package/esm/src/clients/multiSign.d.ts +14 -1184
  14. package/esm/src/clients/multiSign.d.ts.map +1 -1
  15. package/esm/src/clients/multiSign.js +37 -2004
  16. package/esm/src/clients/subscription.d.ts +101 -99
  17. package/esm/src/clients/subscription.d.ts.map +1 -1
  18. package/esm/src/clients/subscription.js +107 -152
  19. package/esm/src/signing/_signTypedData/ethers.d.ts +16 -4
  20. package/esm/src/signing/_signTypedData/ethers.d.ts.map +1 -1
  21. package/esm/src/signing/_signTypedData/ethers.js +1 -1
  22. package/esm/src/signing/_signTypedData/mod.d.ts +12 -12
  23. package/esm/src/signing/_signTypedData/mod.d.ts.map +1 -1
  24. package/esm/src/signing/_signTypedData/mod.js +52 -24
  25. package/esm/src/signing/_signTypedData/private_key.d.ts +6 -5
  26. package/esm/src/signing/_signTypedData/private_key.d.ts.map +1 -1
  27. package/esm/src/signing/_signTypedData/private_key.js +40 -19
  28. package/esm/src/signing/_signTypedData/viem.d.ts +27 -6
  29. package/esm/src/signing/_signTypedData/viem.d.ts.map +1 -1
  30. package/esm/src/signing/_signTypedData/viem.js +1 -1
  31. package/esm/src/signing/_sorter.d.ts +18 -19
  32. package/esm/src/signing/_sorter.d.ts.map +1 -1
  33. package/esm/src/signing/_sorter.js +57 -59
  34. package/esm/src/signing/mod.d.ts +179 -129
  35. package/esm/src/signing/mod.d.ts.map +1 -1
  36. package/esm/src/signing/mod.js +184 -132
  37. package/esm/src/transports/base.d.ts +2 -1
  38. package/esm/src/transports/base.d.ts.map +1 -1
  39. package/esm/src/transports/http/http_transport.d.ts +3 -2
  40. package/esm/src/transports/http/http_transport.d.ts.map +1 -1
  41. package/esm/src/transports/http/http_transport.js +4 -4
  42. package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts +14 -6
  43. package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
  44. package/esm/src/transports/websocket/_hyperliquid_event_target.js +1 -2
  45. package/esm/src/transports/websocket/_reconnecting_websocket.d.ts +2 -1
  46. package/esm/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -1
  47. package/esm/src/transports/websocket/_reconnecting_websocket.js +1 -0
  48. package/esm/src/transports/websocket/_websocket_async_request.d.ts.map +1 -1
  49. package/esm/src/transports/websocket/_websocket_async_request.js +17 -21
  50. package/esm/src/transports/websocket/websocket_transport.d.ts +4 -4
  51. package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
  52. package/esm/src/transports/websocket/websocket_transport.js +6 -6
  53. package/esm/src/types/exchange/requests.d.ts +547 -306
  54. package/esm/src/types/exchange/requests.d.ts.map +1 -1
  55. package/esm/src/types/exchange/responses.d.ts +105 -25
  56. package/esm/src/types/exchange/responses.d.ts.map +1 -1
  57. package/esm/src/types/explorer/requests.d.ts +3 -3
  58. package/esm/src/types/explorer/requests.d.ts.map +1 -1
  59. package/esm/src/types/explorer/responses.d.ts +1 -1
  60. package/esm/src/types/explorer/responses.d.ts.map +1 -1
  61. package/esm/src/types/info/accounts.d.ts +405 -98
  62. package/esm/src/types/info/accounts.d.ts.map +1 -1
  63. package/esm/src/types/info/assets.d.ts +131 -35
  64. package/esm/src/types/info/assets.d.ts.map +1 -1
  65. package/esm/src/types/info/markets.d.ts +29 -8
  66. package/esm/src/types/info/markets.d.ts.map +1 -1
  67. package/esm/src/types/info/orders.d.ts +64 -17
  68. package/esm/src/types/info/orders.d.ts.map +1 -1
  69. package/esm/src/types/info/requests.d.ts +126 -51
  70. package/esm/src/types/info/requests.d.ts.map +1 -1
  71. package/esm/src/types/info/validators.d.ts +44 -14
  72. package/esm/src/types/info/validators.d.ts.map +1 -1
  73. package/esm/src/types/info/vaults.d.ts +25 -10
  74. package/esm/src/types/info/vaults.d.ts.map +1 -1
  75. package/esm/src/types/mod.d.ts +1 -1
  76. package/esm/src/types/mod.d.ts.map +1 -1
  77. package/esm/src/types/subscriptions/requests.d.ts +21 -66
  78. package/esm/src/types/subscriptions/requests.d.ts.map +1 -1
  79. package/esm/src/types/subscriptions/responses.d.ts +46 -55
  80. package/esm/src/types/subscriptions/responses.d.ts.map +1 -1
  81. package/package.json +2 -3
  82. package/script/mod.d.ts +2 -1
  83. package/script/mod.d.ts.map +1 -1
  84. package/script/src/base.d.ts +0 -5
  85. package/script/src/base.d.ts.map +1 -1
  86. package/script/src/clients/exchange.d.ts +485 -392
  87. package/script/src/clients/exchange.d.ts.map +1 -1
  88. package/script/src/clients/exchange.js +516 -911
  89. package/script/src/clients/info.d.ts +249 -203
  90. package/script/src/clients/info.d.ts.map +1 -1
  91. package/script/src/clients/info.js +258 -368
  92. package/script/src/clients/multiSign.d.ts +14 -1184
  93. package/script/src/clients/multiSign.d.ts.map +1 -1
  94. package/script/src/clients/multiSign.js +38 -2005
  95. package/script/src/clients/subscription.d.ts +101 -99
  96. package/script/src/clients/subscription.d.ts.map +1 -1
  97. package/script/src/clients/subscription.js +107 -152
  98. package/script/src/signing/_signTypedData/ethers.d.ts +16 -4
  99. package/script/src/signing/_signTypedData/ethers.d.ts.map +1 -1
  100. package/script/src/signing/_signTypedData/ethers.js +2 -2
  101. package/script/src/signing/_signTypedData/mod.d.ts +12 -12
  102. package/script/src/signing/_signTypedData/mod.d.ts.map +1 -1
  103. package/script/src/signing/_signTypedData/mod.js +51 -26
  104. package/script/src/signing/_signTypedData/private_key.d.ts +6 -5
  105. package/script/src/signing/_signTypedData/private_key.d.ts.map +1 -1
  106. package/script/src/signing/_signTypedData/private_key.js +40 -18
  107. package/script/src/signing/_signTypedData/viem.d.ts +27 -6
  108. package/script/src/signing/_signTypedData/viem.d.ts.map +1 -1
  109. package/script/src/signing/_signTypedData/viem.js +2 -2
  110. package/script/src/signing/_sorter.d.ts +18 -19
  111. package/script/src/signing/_sorter.d.ts.map +1 -1
  112. package/script/src/signing/_sorter.js +57 -59
  113. package/script/src/signing/mod.d.ts +179 -129
  114. package/script/src/signing/mod.d.ts.map +1 -1
  115. package/script/src/signing/mod.js +187 -150
  116. package/script/src/transports/base.d.ts +2 -1
  117. package/script/src/transports/base.d.ts.map +1 -1
  118. package/script/src/transports/http/http_transport.d.ts +3 -2
  119. package/script/src/transports/http/http_transport.d.ts.map +1 -1
  120. package/script/src/transports/http/http_transport.js +4 -4
  121. package/script/src/transports/websocket/_hyperliquid_event_target.d.ts +14 -6
  122. package/script/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
  123. package/script/src/transports/websocket/_hyperliquid_event_target.js +1 -2
  124. package/script/src/transports/websocket/_reconnecting_websocket.d.ts +2 -1
  125. package/script/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -1
  126. package/script/src/transports/websocket/_reconnecting_websocket.js +1 -0
  127. package/script/src/transports/websocket/_websocket_async_request.d.ts.map +1 -1
  128. package/script/src/transports/websocket/_websocket_async_request.js +17 -21
  129. package/script/src/transports/websocket/websocket_transport.d.ts +4 -4
  130. package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
  131. package/script/src/transports/websocket/websocket_transport.js +6 -6
  132. package/script/src/types/exchange/requests.d.ts +547 -306
  133. package/script/src/types/exchange/requests.d.ts.map +1 -1
  134. package/script/src/types/exchange/responses.d.ts +105 -25
  135. package/script/src/types/exchange/responses.d.ts.map +1 -1
  136. package/script/src/types/explorer/requests.d.ts +3 -3
  137. package/script/src/types/explorer/requests.d.ts.map +1 -1
  138. package/script/src/types/explorer/responses.d.ts +1 -1
  139. package/script/src/types/explorer/responses.d.ts.map +1 -1
  140. package/script/src/types/info/accounts.d.ts +405 -98
  141. package/script/src/types/info/accounts.d.ts.map +1 -1
  142. package/script/src/types/info/assets.d.ts +131 -35
  143. package/script/src/types/info/assets.d.ts.map +1 -1
  144. package/script/src/types/info/markets.d.ts +29 -8
  145. package/script/src/types/info/markets.d.ts.map +1 -1
  146. package/script/src/types/info/orders.d.ts +64 -17
  147. package/script/src/types/info/orders.d.ts.map +1 -1
  148. package/script/src/types/info/requests.d.ts +126 -51
  149. package/script/src/types/info/requests.d.ts.map +1 -1
  150. package/script/src/types/info/validators.d.ts +44 -14
  151. package/script/src/types/info/validators.d.ts.map +1 -1
  152. package/script/src/types/info/vaults.d.ts +25 -10
  153. package/script/src/types/info/vaults.d.ts.map +1 -1
  154. package/script/src/types/mod.d.ts +1 -1
  155. package/script/src/types/mod.d.ts.map +1 -1
  156. package/script/src/types/subscriptions/requests.d.ts +21 -66
  157. package/script/src/types/subscriptions/requests.d.ts.map +1 -1
  158. package/script/src/types/subscriptions/responses.d.ts +46 -55
  159. package/script/src/types/subscriptions/responses.d.ts.map +1 -1
  160. package/esm/src/signing/_signTypedData/window.d.ts +0 -29
  161. package/esm/src/signing/_signTypedData/window.d.ts.map +0 -1
  162. package/esm/src/signing/_signTypedData/window.js +0 -30
  163. package/script/src/signing/_signTypedData/window.d.ts +0 -29
  164. package/script/src/signing/_signTypedData/window.d.ts.map +0 -1
  165. package/script/src/signing/_signTypedData/window.js +0 -34
@@ -1,4 +1,37 @@
1
- import type { Hex } from "../../base.js";
1
+ import type { Hex } from "../mod.js";
2
+ /** User active asset data. */
3
+ export interface ActiveAssetData {
4
+ /** User address. */
5
+ user: Hex;
6
+ /** Asset symbol (e.g., BTC). */
7
+ coin: string;
8
+ /** Leverage configuration. */
9
+ leverage: {
10
+ /** Leverage type. */
11
+ type: "isolated";
12
+ /** Leverage value used. */
13
+ value: number;
14
+ /**
15
+ * Amount of USD used (1 = 1$).
16
+ * @pattern ^[0-9]+(\.[0-9]+)?$
17
+ */
18
+ rawUsd: string;
19
+ } | {
20
+ /** Leverage type. */
21
+ type: "cross";
22
+ /** Leverage value used. */
23
+ value: number;
24
+ };
25
+ /** Maximum trade size range [min, max]. */
26
+ maxTradeSzs: [string, string];
27
+ /** Available to trade range [min, max]. */
28
+ availableToTrade: [string, string];
29
+ /**
30
+ * Mark price.
31
+ * @pattern ^[0-9]+(\.[0-9]+)?$
32
+ */
33
+ markPx: string;
34
+ }
2
35
  /** Position for a specific asset. */
3
36
  export interface AssetPosition {
4
37
  /** Position type. */
@@ -7,7 +40,10 @@ export interface AssetPosition {
7
40
  position: {
8
41
  /** Asset symbol. */
9
42
  coin: string;
10
- /** Signed position size. */
43
+ /**
44
+ * Signed position size.
45
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
46
+ */
11
47
  szi: string;
12
48
  /** Leverage details. */
13
49
  leverage: {
@@ -23,27 +59,54 @@ export interface AssetPosition {
23
59
  /** Leverage value used. */
24
60
  value: number;
25
61
  };
26
- /** Average entry price. */
62
+ /**
63
+ * Average entry price.
64
+ * @pattern ^[0-9]+(\.[0-9]+)?$
65
+ */
27
66
  entryPx: string;
28
- /** Position value. */
67
+ /**
68
+ * Position value.
69
+ * @pattern ^[0-9]+(\.[0-9]+)?$
70
+ */
29
71
  positionValue: string;
30
- /** Unrealized profit and loss. */
72
+ /**
73
+ * Unrealized profit and loss.
74
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
75
+ */
31
76
  unrealizedPnl: string;
32
- /** Return on equity. */
77
+ /**
78
+ * Return on equity.
79
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
80
+ */
33
81
  returnOnEquity: string;
34
- /** Liquidation price. */
82
+ /**
83
+ * Liquidation price.
84
+ * @pattern ^[0-9]+(\.[0-9]+)?$
85
+ */
35
86
  liquidationPx: string | null;
36
- /** Margin used. */
87
+ /**
88
+ * Margin used.
89
+ * @pattern ^[0-9]+(\.[0-9]+)?$
90
+ */
37
91
  marginUsed: string;
38
92
  /** Maximum allowed leverage. */
39
93
  maxLeverage: number;
40
94
  /** Cumulative funding details. */
41
95
  cumFunding: {
42
- /** Total funding paid or received since account opening. */
96
+ /**
97
+ * Total funding paid or received since account opening.
98
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
99
+ */
43
100
  allTime: string;
44
- /** Funding accumulated since the position was opened. */
101
+ /**
102
+ * Funding accumulated since the position was opened.
103
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
104
+ */
45
105
  sinceOpen: string;
46
- /** Funding accumulated since the last change in position size. */
106
+ /**
107
+ * Funding accumulated since the last change in position size.
108
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
109
+ */
47
110
  sinceChange: string;
48
111
  };
49
112
  };
@@ -54,7 +117,10 @@ export interface EvmEscrowsBalance {
54
117
  coin: string;
55
118
  /** Unique identifier for the token. */
56
119
  token: number;
57
- /** Total balance. */
120
+ /**
121
+ * Total balance.
122
+ * @pattern ^[0-9]+(\.[0-9]+)?$
123
+ */
58
124
  total: string;
59
125
  }
60
126
  /** Extra agent details for a user. */
@@ -68,7 +134,7 @@ export interface ExtraAgent {
68
134
  }
69
135
  /** Legal verification status for a user. */
70
136
  export interface LegalCheck {
71
- /** Whether the user's IP address is allowed. */
137
+ /** Whether the user IP address is allowed. */
72
138
  ipAllowed: boolean;
73
139
  /** Whether the user has accepted the terms of service. */
74
140
  acceptedTerms: boolean;
@@ -86,29 +152,59 @@ export interface MultiSigSigners {
86
152
  export interface PerpsClearinghouseState {
87
153
  /** Margin summary details. */
88
154
  marginSummary: {
89
- /** Total account value. */
155
+ /**
156
+ * Total account value.
157
+ * @pattern ^[0-9]+(\.[0-9]+)?$
158
+ */
90
159
  accountValue: string;
91
- /** Total notional position value. */
160
+ /**
161
+ * Total notional position value.
162
+ * @pattern ^[0-9]+(\.[0-9]+)?$
163
+ */
92
164
  totalNtlPos: string;
93
- /** Total raw USD value. */
165
+ /**
166
+ * Total raw USD value.
167
+ * @pattern ^[0-9]+(\.[0-9]+)?$
168
+ */
94
169
  totalRawUsd: string;
95
- /** Total margin used. */
170
+ /**
171
+ * Total margin used.
172
+ * @pattern ^[0-9]+(\.[0-9]+)?$
173
+ */
96
174
  totalMarginUsed: string;
97
175
  };
98
176
  /** Cross-margin summary details. */
99
177
  crossMarginSummary: {
100
- /** Total account value. */
178
+ /**
179
+ * Total account value.
180
+ * @pattern ^[0-9]+(\.[0-9]+)?$
181
+ */
101
182
  accountValue: string;
102
- /** Total notional position value. */
183
+ /**
184
+ * Total notional position value.
185
+ * @pattern ^[0-9]+(\.[0-9]+)?$
186
+ */
103
187
  totalNtlPos: string;
104
- /** Total raw USD value. */
188
+ /**
189
+ * Total raw USD value.
190
+ * @pattern ^[0-9]+(\.[0-9]+)?$
191
+ */
105
192
  totalRawUsd: string;
106
- /** Total margin used. */
193
+ /**
194
+ * Total margin used.
195
+ * @pattern ^[0-9]+(\.[0-9]+)?$
196
+ */
107
197
  totalMarginUsed: string;
108
198
  };
109
- /** Maintenance margin used for cross-margin positions. */
199
+ /**
200
+ * Maintenance margin used for cross-margin positions.
201
+ * @pattern ^[0-9]+(\.[0-9]+)?$
202
+ */
110
203
  crossMaintenanceMarginUsed: string;
111
- /** Amount available for withdrawal. */
204
+ /**
205
+ * Amount available for withdrawal.
206
+ * @pattern ^[0-9]+(\.[0-9]+)?$
207
+ */
112
208
  withdrawable: string;
113
209
  /** List of asset positions. */
114
210
  assetPositions: AssetPosition[];
@@ -121,7 +217,10 @@ export interface Portfolio {
121
217
  accountValueHistory: [number, string][];
122
218
  /** History entries for profit and loss as [timestamp, value]. */
123
219
  pnlHistory: [number, string][];
124
- /** Volume metric for the portfolio. */
220
+ /**
221
+ * Volume metric for the portfolio.
222
+ * @pattern ^[0-9]+(\.[0-9]+)?$
223
+ */
125
224
  vlm: string;
126
225
  }
127
226
  /** Portfolio metrics grouped by time periods. */
@@ -161,7 +260,10 @@ export type PortfolioPeriods = [
161
260
  ];
162
261
  /** Pre-transfer user existence check result. */
163
262
  export interface PreTransferCheck {
164
- /** Activation fee. */
263
+ /**
264
+ * Activation fee.
265
+ * @pattern ^[0-9]+(\.[0-9]+)?$
266
+ */
165
267
  fee: string;
166
268
  /** Whether the user is sanctioned. */
167
269
  isSanctioned: boolean;
@@ -179,13 +281,25 @@ export interface Referral {
179
281
  /** Referral code used. */
180
282
  code: string;
181
283
  } | null;
182
- /** Cumulative traded volume. */
284
+ /**
285
+ * Cumulative traded volume.
286
+ * @pattern ^[0-9]+(\.[0-9]+)?$
287
+ */
183
288
  cumVlm: string;
184
- /** Rewards earned but not yet claimed. */
289
+ /**
290
+ * Rewards earned but not yet claimed.
291
+ * @pattern ^[0-9]+(\.[0-9]+)?$
292
+ */
185
293
  unclaimedRewards: string;
186
- /** Rewards that have been claimed. */
294
+ /**
295
+ * Rewards that have been claimed.
296
+ * @pattern ^[0-9]+(\.[0-9]+)?$
297
+ */
187
298
  claimedRewards: string;
188
- /** Builder reward amount. */
299
+ /**
300
+ * Builder reward amount.
301
+ * @pattern ^[0-9]+(\.[0-9]+)?$
302
+ */
189
303
  builderRewards: string;
190
304
  /** Current state of the referrer. */
191
305
  referrerState: {
@@ -195,18 +309,29 @@ export interface Referral {
195
309
  data: {
196
310
  /** Assigned referral code. */
197
311
  code: string;
312
+ /** Total number of referrals. */
313
+ nReferrals: number;
198
314
  /** Summary of each referral state. */
199
315
  referralStates: {
200
- /** Cumulative traded volume. */
316
+ /**
317
+ * Cumulative traded volume.
318
+ * @pattern ^[0-9]+(\.[0-9]+)?$
319
+ */
201
320
  cumVlm: string;
202
- /** Total fees rewarded to the referred user since referral. */
321
+ /**
322
+ * Total fees rewarded to the referred user since referral.
323
+ * @pattern ^[0-9]+(\.[0-9]+)?$
324
+ */
203
325
  cumRewardedFeesSinceReferred: string;
204
- /** Total fees rewarded to the referrer from referred trades. */
326
+ /**
327
+ * Total fees rewarded to the referrer from referred trades.
328
+ * @pattern ^[0-9]+(\.[0-9]+)?$
329
+ */
205
330
  cumFeesRewardedToReferrer: string;
206
331
  /** Timestamp when the referred user joined (in ms since epoch). */
207
332
  timeJoined: number;
208
333
  /** Address of the referred user. */
209
- user: string;
334
+ user: Hex;
210
335
  }[];
211
336
  };
212
337
  } | {
@@ -217,17 +342,29 @@ export interface Referral {
217
342
  stage: "needToTrade";
218
343
  /** Required trading volume details for activation. */
219
344
  data: {
220
- /** Required trading volume. */
345
+ /**
346
+ * Required trading volume.
347
+ * @pattern ^[0-9]+(\.[0-9]+)?$
348
+ */
221
349
  required: string;
222
350
  };
223
351
  };
224
352
  /** History of referral rewards. */
225
353
  rewardHistory: {
226
- /** Amount of earned rewards. */
354
+ /**
355
+ * Amount of earned rewards.
356
+ * @pattern ^[0-9]+(\.[0-9]+)?$
357
+ */
227
358
  earned: string;
228
- /** Traded volume at the time of reward. */
359
+ /**
360
+ * Traded volume at the time of reward.
361
+ * @pattern ^[0-9]+(\.[0-9]+)?$
362
+ */
229
363
  vlm: string;
230
- /** Traded volume via referrals. */
364
+ /**
365
+ * Traded volume via referrals.
366
+ * @pattern ^[0-9]+(\.[0-9]+)?$
367
+ */
231
368
  referralVlm: string;
232
369
  /** Timestamp when the reward was earned (in ms since epoch). */
233
370
  time: number;
@@ -239,11 +376,20 @@ export interface SpotBalance {
239
376
  coin: string;
240
377
  /** Unique identifier for the token. */
241
378
  token: number;
242
- /** Total balance. */
379
+ /**
380
+ * Total balance.
381
+ * @pattern ^[0-9]+(\.[0-9]+)?$
382
+ */
243
383
  total: string;
244
- /** Amount on hold. */
384
+ /**
385
+ * Amount on hold.
386
+ * @pattern ^[0-9]+(\.[0-9]+)?$
387
+ */
245
388
  hold: string;
246
- /** Entry notional value. */
389
+ /**
390
+ * Entry notional value.
391
+ * @pattern ^[0-9]+(\.[0-9]+)?$
392
+ */
247
393
  entryNtl: string;
248
394
  }
249
395
  /** Account summary for spot trading. */
@@ -272,78 +418,153 @@ export interface UserFees {
272
418
  dailyUserVlm: {
273
419
  /** Date in YYYY-M-D format. */
274
420
  date: `${number}-${number}-${number}`;
275
- /** User cross-trade volume. */
421
+ /**
422
+ * User cross-trade volume.
423
+ * @pattern ^[0-9]+(\.[0-9]+)?$
424
+ */
276
425
  userCross: string;
277
- /** User add-liquidity volume. */
426
+ /**
427
+ * User add-liquidity volume.
428
+ * @pattern ^[0-9]+(\.[0-9]+)?$
429
+ */
278
430
  userAdd: string;
279
- /** Exchange total volume. */
431
+ /**
432
+ * Exchange total volume.
433
+ * @pattern ^[0-9]+(\.[0-9]+)?$
434
+ */
280
435
  exchange: string;
281
436
  }[];
282
437
  /** Fee schedule information. */
283
438
  feeSchedule: {
284
- /** Cross-trade fee rate. */
439
+ /**
440
+ * Cross-trade fee rate.
441
+ * @pattern ^[0-9]+(\.[0-9]+)?$
442
+ */
285
443
  cross: string;
286
- /** Add-liquidity fee rate. */
444
+ /**
445
+ * Add-liquidity fee rate.
446
+ * @pattern ^[0-9]+(\.[0-9]+)?$
447
+ */
287
448
  add: string;
288
- /** Spot cross-trade fee rate. */
449
+ /**
450
+ * Spot cross-trade fee rate.
451
+ * @pattern ^[0-9]+(\.[0-9]+)?$
452
+ */
289
453
  spotCross: string;
290
- /** Spot add-liquidity fee rate. */
454
+ /**
455
+ * Spot add-liquidity fee rate.
456
+ * @pattern ^[0-9]+(\.[0-9]+)?$
457
+ */
291
458
  spotAdd: string;
292
459
  /** Fee tiers details. */
293
460
  tiers: {
294
461
  /** VIP fee tier information. */
295
462
  vip: {
296
- /** Notional volume cutoff. */
463
+ /**
464
+ * Notional volume cutoff.
465
+ * @pattern ^[0-9]+(\.[0-9]+)?$
466
+ */
297
467
  ntlCutoff: string;
298
- /** Cross-trade fee rate. */
468
+ /**
469
+ * Cross-trade fee rate.
470
+ * @pattern ^[0-9]+(\.[0-9]+)?$
471
+ */
299
472
  cross: string;
300
- /** Add-liquidity fee rate. */
473
+ /**
474
+ * Add-liquidity fee rate.
475
+ * @pattern ^[0-9]+(\.[0-9]+)?$
476
+ */
301
477
  add: string;
302
- /** Spot cross-trade fee rate. */
478
+ /**
479
+ * Spot cross-trade fee rate.
480
+ * @pattern ^[0-9]+(\.[0-9]+)?$
481
+ */
303
482
  spotCross: string;
304
- /** Spot add-liquidity fee rate. */
483
+ /**
484
+ * Spot add-liquidity fee rate.
485
+ * @pattern ^[0-9]+(\.[0-9]+)?$
486
+ */
305
487
  spotAdd: string;
306
488
  }[];
307
489
  /** Market maker fee tier information. */
308
490
  mm: {
309
- /** Maker fraction cutoff. */
491
+ /**
492
+ * Maker fraction cutoff.
493
+ * @pattern ^[0-9]+(\.[0-9]+)?$
494
+ */
310
495
  makerFractionCutoff: string;
311
- /** Add-liquidity fee rate. */
496
+ /**
497
+ * Add-liquidity fee rate.
498
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
499
+ */
312
500
  add: string;
313
501
  }[];
314
502
  };
315
- /** Referral discount rate. */
503
+ /**
504
+ * Referral discount rate.
505
+ * @pattern ^[0-9]+(\.[0-9]+)?$
506
+ */
316
507
  referralDiscount: string;
317
508
  /** Staking discount tiers details. */
318
509
  stakingDiscountTiers: {
319
- /** Basis points of maximum supply. */
510
+ /**
511
+ * Basis points of maximum supply.
512
+ * @pattern ^[0-9]+(\.[0-9]+)?$
513
+ */
320
514
  bpsOfMaxSupply: string;
321
- /** Discount rate applied. */
515
+ /**
516
+ * Discount rate applied.
517
+ * @pattern ^[0-9]+(\.[0-9]+)?$
518
+ */
322
519
  discount: string;
323
520
  }[];
324
521
  };
325
- /** User cross-trade rate. */
522
+ /**
523
+ * User cross-trade rate.
524
+ * @pattern ^[0-9]+(\.[0-9]+)?$
525
+ */
326
526
  userCrossRate: string;
327
- /** User add-liquidity rate. */
527
+ /**
528
+ * User add-liquidity rate.
529
+ * @pattern ^[0-9]+(\.[0-9]+)?$
530
+ */
328
531
  userAddRate: string;
329
- /** User spot cross-trade rate. */
532
+ /**
533
+ * User spot cross-trade rate.
534
+ * @pattern ^[0-9]+(\.[0-9]+)?$
535
+ */
330
536
  userSpotCrossRate: string;
331
- /** User spot add-liquidity rate. */
537
+ /**
538
+ * User spot add-liquidity rate.
539
+ * @pattern ^[0-9]+(\.[0-9]+)?$
540
+ */
332
541
  userSpotAddRate: string;
333
- /** Active referral discount rate. */
542
+ /**
543
+ * Active referral discount rate.
544
+ * @pattern ^[0-9]+(\.[0-9]+)?$
545
+ */
334
546
  activeReferralDiscount: string;
335
547
  /** Trial details. */
336
548
  trial: unknown | null;
337
- /** Fee trial reward amount. */
549
+ /**
550
+ * Fee trial reward amount.
551
+ * @pattern ^[0-9]+(\.[0-9]+)?$
552
+ */
338
553
  feeTrialReward: string;
339
554
  /** Timestamp when next trial becomes available. */
340
555
  nextTrialAvailableTimestamp: unknown | null;
341
556
  stakingLink: unknown | null;
342
557
  /** Active staking discount details. */
343
558
  activeStakingDiscount: {
344
- /** Basis points of maximum supply. */
559
+ /**
560
+ * Basis points of maximum supply.
561
+ * @pattern ^[0-9]+(\.[0-9]+)?$
562
+ */
345
563
  bpsOfMaxSupply: string;
346
- /** Discount rate applied. */
564
+ /**
565
+ * Discount rate applied.
566
+ * @pattern ^[0-9]+(\.[0-9]+)?$
567
+ */
347
568
  discount: string;
348
569
  };
349
570
  }
@@ -362,25 +583,37 @@ export interface FundingUpdate {
362
583
  type: "funding";
363
584
  /** Asset symbol. */
364
585
  coin: string;
365
- /** Amount transferred in USDC. */
586
+ /**
587
+ * Amount transferred in USDC.
588
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
589
+ */
366
590
  usdc: string;
367
- /** Signed position size. */
591
+ /**
592
+ * Signed position size.
593
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
594
+ */
368
595
  szi: string;
369
- /** Applied funding rate. */
596
+ /**
597
+ * Applied funding rate.
598
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
599
+ */
370
600
  fundingRate: string;
371
601
  /** Number of samples. */
372
602
  nSamples: number | null;
373
603
  }
374
- /** User's rate limits. */
604
+ /** User rate limits. */
375
605
  export interface UserRateLimit {
376
- /** Cumulative trading volume. */
606
+ /**
607
+ * Cumulative trading volume.
608
+ * @pattern ^[0-9]+(\.[0-9]+)?$
609
+ */
377
610
  cumVlm: string;
378
611
  /** Number of API requests used. */
379
612
  nRequestsUsed: number;
380
613
  /** Maximum allowed API requests. */
381
614
  nRequestsCap: number;
382
615
  }
383
- /** User's role */
616
+ /** User role */
384
617
  export type UserRole = {
385
618
  /** Role identifier. */
386
619
  role: "missing" | "user" | "vault";
@@ -414,7 +647,10 @@ export interface UserNonFundingLedgerUpdate {
414
647
  export interface AccountClassTransferUpdate {
415
648
  /** Update type. */
416
649
  type: "accountClassTransfer";
417
- /** Amount transferred in USDC. */
650
+ /**
651
+ * Amount transferred in USDC.
652
+ * @pattern ^[0-9]+(\.[0-9]+)?$
653
+ */
418
654
  usdc: string;
419
655
  /** Indicates if the transfer is to the perpetual account. */
420
656
  toPerp: boolean;
@@ -423,29 +659,44 @@ export interface AccountClassTransferUpdate {
423
659
  export interface DepositUpdate {
424
660
  /** Update type. */
425
661
  type: "deposit";
426
- /** Amount deposited in USDC. */
662
+ /**
663
+ * Amount deposited in USDC.
664
+ * @pattern ^[0-9]+(\.[0-9]+)?$
665
+ */
427
666
  usdc: string;
428
667
  }
429
668
  /** Internal transfer between accounts. */
430
669
  export interface InternalTransferUpdate {
431
670
  /** Update type. */
432
671
  type: "internalTransfer";
433
- /** Amount transferred in USDC. */
672
+ /**
673
+ * Amount transferred in USDC.
674
+ * @pattern ^[0-9]+(\.[0-9]+)?$
675
+ */
434
676
  usdc: string;
435
- /** Initiator's address. */
677
+ /** Initiator address. */
436
678
  user: Hex;
437
679
  /** Destination address. */
438
680
  destination: Hex;
439
- /** Transfer fee. */
681
+ /**
682
+ * Transfer fee.
683
+ * @pattern ^[0-9]+(\.[0-9]+)?$
684
+ */
440
685
  fee: string;
441
686
  }
442
687
  /** Liquidation event update. */
443
688
  export interface LiquidationUpdate {
444
689
  /** Update type. */
445
690
  type: "liquidation";
446
- /** Total notional value of liquidated positions. */
691
+ /**
692
+ * Total notional value of liquidated positions.
693
+ * @pattern ^[0-9]+(\.[0-9]+)?$
694
+ */
447
695
  liquidatedNtlPos: string;
448
- /** Account value at liquidation time. */
696
+ /**
697
+ * Account value at liquidation time.
698
+ * @pattern ^[0-9]+(\.[0-9]+)?$
699
+ */
449
700
  accountValue: string;
450
701
  /** Leverage type for liquidated positions. */
451
702
  leverageType: "Cross" | "Isolated";
@@ -453,7 +704,10 @@ export interface LiquidationUpdate {
453
704
  liquidatedPositions: {
454
705
  /** Asset symbol of the liquidated position. */
455
706
  coin: string;
456
- /** Signed position size liquidated. */
707
+ /**
708
+ * Signed position size liquidated.
709
+ * @pattern ^-?[0-9]+(\.[0-9]+)?$
710
+ */
457
711
  szi: string;
458
712
  }[];
459
713
  }
@@ -461,7 +715,10 @@ export interface LiquidationUpdate {
461
715
  export interface RewardsClaimUpdate {
462
716
  /** Update type. */
463
717
  type: "rewardsClaim";
464
- /** Amount of rewards claimed. */
718
+ /**
719
+ * Amount of rewards claimed.
720
+ * @pattern ^[0-9]+(\.[0-9]+)?$
721
+ */
465
722
  amount: string;
466
723
  }
467
724
  /** Spot transfer update between accounts. */
@@ -470,27 +727,44 @@ export interface SpotTransferUpdate {
470
727
  type: "spotTransfer";
471
728
  /** Token symbol. */
472
729
  token: string;
473
- /** Amount transferred. */
730
+ /**
731
+ * Amount transferred.
732
+ * @pattern ^[0-9]+(\.[0-9]+)?$
733
+ */
474
734
  amount: string;
475
- /** Equivalent USDC value. */
735
+ /**
736
+ * Equivalent USDC value.
737
+ * @pattern ^[0-9]+(\.[0-9]+)?$
738
+ */
476
739
  usdcValue: string;
477
- /** Initiator's address. */
740
+ /** Initiator address. */
478
741
  user: Hex;
479
742
  /** Destination address. */
480
743
  destination: Hex;
481
- /** Transfer fee. */
744
+ /**
745
+ * Transfer fee.
746
+ * @pattern ^[0-9]+(\.[0-9]+)?$
747
+ */
482
748
  fee: string;
483
- /** Fee in native token. */
749
+ /**
750
+ * Fee in native token.
751
+ * @pattern ^[0-9]+(\.[0-9]+)?$
752
+ */
484
753
  nativeTokenFee: string;
485
754
  nonce: null;
755
+ /** Token in which the fee is denominated (e.g., "USDC"). */
756
+ feeToken: string;
486
757
  }
487
758
  /** Transfer update between sub-accounts. */
488
759
  export interface SubAccountTransferUpdate {
489
760
  /** Update type. */
490
761
  type: "subAccountTransfer";
491
- /** Amount transferred in USDC. */
762
+ /**
763
+ * Amount transferred in USDC.
764
+ * @pattern ^[0-9]+(\.[0-9]+)?$
765
+ */
492
766
  usdc: string;
493
- /** Initiator's address. */
767
+ /** Initiator address. */
494
768
  user: Hex;
495
769
  /** Destination address. */
496
770
  destination: Hex;
@@ -501,9 +775,15 @@ export interface VaultCreateUpdate {
501
775
  type: "vaultCreate";
502
776
  /** Address of the created vault. */
503
777
  vault: Hex;
504
- /** Initial allocated amount in USDC. */
778
+ /**
779
+ * Initial allocated amount in USDC.
780
+ * @pattern ^[0-9]+(\.[0-9]+)?$
781
+ */
505
782
  usdc: string;
506
- /** Vault creation fee. */
783
+ /**
784
+ * Vault creation fee.
785
+ * @pattern ^[0-9]+(\.[0-9]+)?$
786
+ */
507
787
  fee: string;
508
788
  }
509
789
  /** Vault deposit update. */
@@ -512,7 +792,10 @@ export interface VaultDepositUpdate {
512
792
  type: "vaultDeposit";
513
793
  /** Address of the target vault. */
514
794
  vault: Hex;
515
- /** Amount deposited in USDC. */
795
+ /**
796
+ * Amount deposited in USDC.
797
+ * @pattern ^[0-9]+(\.[0-9]+)?$
798
+ */
516
799
  usdc: string;
517
800
  }
518
801
  /** Vault distribution update. */
@@ -521,7 +804,10 @@ export interface VaultDistributionUpdate {
521
804
  type: "vaultDistribution";
522
805
  /** Address of the vault distributing funds. */
523
806
  vault: Hex;
524
- /** Amount distributed in USDC. */
807
+ /**
808
+ * Amount distributed in USDC.
809
+ * @pattern ^[0-9]+(\.[0-9]+)?$
810
+ */
525
811
  usdc: string;
526
812
  }
527
813
  /** Vault withdrawal event update. */
@@ -532,26 +818,47 @@ export interface VaultWithdrawUpdate {
532
818
  vault: Hex;
533
819
  /** Address of the user withdrawing funds. */
534
820
  user: Hex;
535
- /** Withdrawal request amount in USD. */
821
+ /**
822
+ * Withdrawal request amount in USD.
823
+ * @pattern ^[0-9]+(\.[0-9]+)?$
824
+ */
536
825
  requestedUsd: string;
537
- /** Withdrawal commission fee. */
826
+ /**
827
+ * Withdrawal commission fee.
828
+ * @pattern ^[0-9]+(\.[0-9]+)?$
829
+ */
538
830
  commission: string;
539
- /** Closing cost associated with positions. */
831
+ /**
832
+ * Closing cost associated with positions.
833
+ * @pattern ^[0-9]+(\.[0-9]+)?$
834
+ */
540
835
  closingCost: string;
541
- /** Basis value for withdrawal calculation. */
836
+ /**
837
+ * Basis value for withdrawal calculation.
838
+ * @pattern ^[0-9]+(\.[0-9]+)?$
839
+ */
542
840
  basis: string;
543
- /** Net withdrawn amount in USD after fees and costs. */
841
+ /**
842
+ * Net withdrawn amount in USD after fees and costs.
843
+ * @pattern ^[0-9]+(\.[0-9]+)?$
844
+ */
544
845
  netWithdrawnUsd: string;
545
846
  }
546
847
  /** Withdrawal update from an account. */
547
848
  export interface WithdrawUpdate {
548
849
  /** Update type. */
549
850
  type: "withdraw";
550
- /** Amount withdrawn in USDC. */
851
+ /**
852
+ * Amount withdrawn in USDC.
853
+ * @pattern ^[0-9]+(\.[0-9]+)?$
854
+ */
551
855
  usdc: string;
552
856
  /** Unique nonce for the withdrawal request. */
553
857
  nonce: number;
554
- /** Withdrawal fee. */
858
+ /**
859
+ * Withdrawal fee.
860
+ * @pattern ^[0-9]+(\.[0-9]+)?$
861
+ */
555
862
  fee: string;
556
863
  }
557
864
  //# sourceMappingURL=accounts.d.ts.map