@nktkas/hyperliquid 0.13.1 → 0.13.2

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 (183) hide show
  1. package/LICENSE +20 -20
  2. package/README.md +33 -17
  3. package/esm/deps/jsr.io/@std/bytes/1.0.5/_types.d.ts +9 -0
  4. package/esm/deps/jsr.io/@std/bytes/1.0.5/_types.d.ts.map +1 -0
  5. package/esm/deps/jsr.io/@std/bytes/1.0.5/_types.js +2 -0
  6. package/esm/deps/jsr.io/@std/bytes/{1.0.4 → 1.0.5}/concat.d.ts +3 -1
  7. package/esm/deps/jsr.io/@std/bytes/1.0.5/concat.d.ts.map +1 -0
  8. package/esm/deps/jsr.io/@std/bytes/{1.0.4 → 1.0.5}/concat.js +1 -1
  9. package/esm/deps/jsr.io/@std/encoding/1.0.7/_types.d.ts +9 -0
  10. package/esm/deps/jsr.io/@std/encoding/1.0.7/_types.d.ts.map +1 -0
  11. package/esm/deps/jsr.io/@std/encoding/1.0.7/_types.js +2 -0
  12. package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.d.ts.map +1 -1
  13. package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.js +1 -1
  14. package/{script/deps/jsr.io/@std/encoding/1.0.6 → esm/deps/jsr.io/@std/encoding/1.0.7}/hex.d.ts +3 -1
  15. package/esm/deps/jsr.io/@std/encoding/1.0.7/hex.d.ts.map +1 -0
  16. package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/hex.js +1 -1
  17. package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts +9 -0
  18. package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts.map +1 -0
  19. package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.js +2 -0
  20. package/esm/deps/jsr.io/@std/msgpack/{1.0.2 → 1.0.3}/encode.d.ts +3 -1
  21. package/esm/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts.map +1 -0
  22. package/esm/deps/jsr.io/@std/msgpack/{1.0.2 → 1.0.3}/encode.js +2 -2
  23. package/esm/mod.d.ts +1 -0
  24. package/esm/mod.d.ts.map +1 -1
  25. package/esm/src/clients/event.d.ts +57 -16
  26. package/esm/src/clients/event.d.ts.map +1 -1
  27. package/esm/src/clients/event.js +72 -16
  28. package/esm/src/clients/public.d.ts +241 -49
  29. package/esm/src/clients/public.d.ts.map +1 -1
  30. package/esm/src/clients/public.js +243 -47
  31. package/esm/src/clients/wallet.d.ts +120 -51
  32. package/esm/src/clients/wallet.d.ts.map +1 -1
  33. package/esm/src/clients/wallet.js +192 -58
  34. package/esm/src/transports/websocket/hyperliquid_event_target.d.ts +27 -21
  35. package/esm/src/transports/websocket/hyperliquid_event_target.d.ts.map +1 -1
  36. package/esm/src/transports/websocket/hyperliquid_event_target.js +37 -0
  37. package/esm/src/transports/websocket/websocket_request_dispatcher.js +3 -3
  38. package/esm/src/transports/websocket/websocket_transport.d.ts +7 -10
  39. package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
  40. package/esm/src/transports/websocket/websocket_transport.js +41 -35
  41. package/esm/src/types/exchange/common.d.ts +6 -6
  42. package/esm/src/types/exchange/common.d.ts.map +1 -1
  43. package/esm/src/types/exchange/requests.d.ts +131 -64
  44. package/esm/src/types/exchange/requests.d.ts.map +1 -1
  45. package/esm/src/types/exchange/responses.d.ts +7 -7
  46. package/esm/src/types/exchange/responses.d.ts.map +1 -1
  47. package/esm/src/types/explorer/common.d.ts +15 -15
  48. package/esm/src/types/explorer/common.d.ts.map +1 -1
  49. package/esm/src/types/explorer/requests.d.ts +19 -6
  50. package/esm/src/types/explorer/requests.d.ts.map +1 -1
  51. package/esm/src/types/explorer/responses.d.ts +9 -2
  52. package/esm/src/types/explorer/responses.d.ts.map +1 -1
  53. package/esm/src/types/info/accounts.d.ts +189 -124
  54. package/esm/src/types/info/accounts.d.ts.map +1 -1
  55. package/esm/src/types/info/assets.d.ts +82 -78
  56. package/esm/src/types/info/assets.d.ts.map +1 -1
  57. package/esm/src/types/info/delegations.d.ts +117 -0
  58. package/esm/src/types/info/delegations.d.ts.map +1 -0
  59. package/esm/src/types/info/delegations.js +1 -0
  60. package/esm/src/types/info/orders.d.ts +67 -67
  61. package/esm/src/types/info/orders.d.ts.map +1 -1
  62. package/esm/src/types/info/requests.d.ts +128 -63
  63. package/esm/src/types/info/requests.d.ts.map +1 -1
  64. package/esm/src/types/info/vaults.d.ts +41 -84
  65. package/esm/src/types/info/vaults.d.ts.map +1 -1
  66. package/esm/src/types/subscriptions/common.d.ts +3 -0
  67. package/esm/src/types/subscriptions/common.d.ts.map +1 -1
  68. package/esm/src/types/subscriptions/requests.d.ts +10 -0
  69. package/esm/src/types/subscriptions/requests.d.ts.map +1 -1
  70. package/esm/src/utils/key_sort.d.ts +2 -2
  71. package/esm/src/utils/key_sort.d.ts.map +1 -1
  72. package/esm/src/utils/signing.d.ts +1 -1
  73. package/esm/src/utils/signing.js +2 -2
  74. package/package.json +1 -1
  75. package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.js +13 -3
  76. package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.js +23 -13
  77. package/script/deps/jsr.io/@noble/hashes/1.7.1/src/_assert.js +55 -45
  78. package/script/deps/jsr.io/@noble/hashes/1.7.1/src/_u64.js +97 -87
  79. package/script/deps/jsr.io/@noble/hashes/1.7.1/src/crypto.js +14 -4
  80. package/script/deps/jsr.io/@noble/hashes/1.7.1/src/sha3.js +288 -278
  81. package/script/deps/jsr.io/@noble/hashes/1.7.1/src/utils.js +238 -228
  82. package/script/deps/jsr.io/@std/bytes/1.0.5/_types.d.ts +9 -0
  83. package/script/deps/jsr.io/@std/bytes/1.0.5/_types.d.ts.map +1 -0
  84. package/script/deps/jsr.io/@std/bytes/1.0.5/_types.js +13 -0
  85. package/script/deps/jsr.io/@std/bytes/{1.0.4 → 1.0.5}/concat.d.ts +3 -1
  86. package/script/deps/jsr.io/@std/bytes/1.0.5/concat.d.ts.map +1 -0
  87. package/script/deps/jsr.io/@std/bytes/1.0.5/concat.js +45 -0
  88. package/script/deps/jsr.io/@std/encoding/1.0.7/_types.d.ts +9 -0
  89. package/script/deps/jsr.io/@std/encoding/1.0.7/_types.d.ts.map +1 -0
  90. package/script/deps/jsr.io/@std/encoding/1.0.7/_types.js +13 -0
  91. package/script/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.d.ts.map +1 -1
  92. package/script/deps/jsr.io/@std/encoding/1.0.7/_validate_binary_like.js +39 -0
  93. package/{esm/deps/jsr.io/@std/encoding/1.0.6 → script/deps/jsr.io/@std/encoding/1.0.7}/hex.d.ts +3 -1
  94. package/script/deps/jsr.io/@std/encoding/1.0.7/hex.d.ts.map +1 -0
  95. package/script/deps/jsr.io/@std/encoding/1.0.7/hex.js +123 -0
  96. package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts +9 -0
  97. package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts.map +1 -0
  98. package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.js +13 -0
  99. package/script/deps/jsr.io/@std/msgpack/{1.0.2 → 1.0.3}/encode.d.ts +3 -1
  100. package/script/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts.map +1 -0
  101. package/script/deps/jsr.io/@std/msgpack/1.0.3/encode.js +250 -0
  102. package/script/mod.d.ts +1 -0
  103. package/script/mod.d.ts.map +1 -1
  104. package/script/mod.js +23 -13
  105. package/script/src/clients/event.d.ts +57 -16
  106. package/script/src/clients/event.d.ts.map +1 -1
  107. package/script/src/clients/event.js +551 -485
  108. package/script/src/clients/public.d.ts +241 -49
  109. package/script/src/clients/public.d.ts.map +1 -1
  110. package/script/src/clients/public.js +914 -708
  111. package/script/src/clients/wallet.d.ts +120 -51
  112. package/script/src/clients/wallet.d.ts.map +1 -1
  113. package/script/src/clients/wallet.js +1121 -977
  114. package/script/src/transports/base.js +25 -15
  115. package/script/src/transports/http/http_transport.js +174 -164
  116. package/script/src/transports/websocket/hyperliquid_event_target.d.ts +27 -21
  117. package/script/src/transports/websocket/hyperliquid_event_target.d.ts.map +1 -1
  118. package/script/src/transports/websocket/hyperliquid_event_target.js +80 -33
  119. package/script/src/transports/websocket/reconnecting_websocket.js +364 -354
  120. package/script/src/transports/websocket/websocket_request_dispatcher.js +196 -186
  121. package/script/src/transports/websocket/websocket_transport.d.ts +7 -10
  122. package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
  123. package/script/src/transports/websocket/websocket_transport.js +236 -220
  124. package/script/src/types/common.js +12 -2
  125. package/script/src/types/exchange/common.d.ts +6 -6
  126. package/script/src/types/exchange/common.d.ts.map +1 -1
  127. package/script/src/types/exchange/common.js +12 -2
  128. package/script/src/types/exchange/requests.d.ts +131 -64
  129. package/script/src/types/exchange/requests.d.ts.map +1 -1
  130. package/script/src/types/exchange/requests.js +12 -2
  131. package/script/src/types/exchange/responses.d.ts +7 -7
  132. package/script/src/types/exchange/responses.d.ts.map +1 -1
  133. package/script/src/types/exchange/responses.js +12 -2
  134. package/script/src/types/explorer/common.d.ts +15 -15
  135. package/script/src/types/explorer/common.d.ts.map +1 -1
  136. package/script/src/types/explorer/common.js +12 -2
  137. package/script/src/types/explorer/requests.d.ts +19 -6
  138. package/script/src/types/explorer/requests.d.ts.map +1 -1
  139. package/script/src/types/explorer/requests.js +12 -2
  140. package/script/src/types/explorer/responses.d.ts +9 -2
  141. package/script/src/types/explorer/responses.d.ts.map +1 -1
  142. package/script/src/types/explorer/responses.js +12 -2
  143. package/script/src/types/info/accounts.d.ts +189 -124
  144. package/script/src/types/info/accounts.d.ts.map +1 -1
  145. package/script/src/types/info/accounts.js +12 -2
  146. package/script/src/types/info/assets.d.ts +82 -78
  147. package/script/src/types/info/assets.d.ts.map +1 -1
  148. package/script/src/types/info/assets.js +12 -2
  149. package/script/src/types/info/delegations.d.ts +117 -0
  150. package/script/src/types/info/delegations.d.ts.map +1 -0
  151. package/script/src/types/info/delegations.js +12 -0
  152. package/script/src/types/info/orders.d.ts +67 -67
  153. package/script/src/types/info/orders.d.ts.map +1 -1
  154. package/script/src/types/info/orders.js +12 -2
  155. package/script/src/types/info/requests.d.ts +128 -63
  156. package/script/src/types/info/requests.d.ts.map +1 -1
  157. package/script/src/types/info/requests.js +12 -2
  158. package/script/src/types/info/vaults.d.ts +41 -84
  159. package/script/src/types/info/vaults.d.ts.map +1 -1
  160. package/script/src/types/info/vaults.js +12 -2
  161. package/script/src/types/subscriptions/common.d.ts +3 -0
  162. package/script/src/types/subscriptions/common.d.ts.map +1 -1
  163. package/script/src/types/subscriptions/common.js +12 -2
  164. package/script/src/types/subscriptions/requests.d.ts +10 -0
  165. package/script/src/types/subscriptions/requests.d.ts.map +1 -1
  166. package/script/src/types/subscriptions/requests.js +12 -2
  167. package/script/src/utils/key_sort.d.ts +2 -2
  168. package/script/src/utils/key_sort.d.ts.map +1 -1
  169. package/script/src/utils/key_sort.js +133 -123
  170. package/script/src/utils/signing.d.ts +1 -1
  171. package/script/src/utils/signing.js +172 -162
  172. package/esm/deps/jsr.io/@std/bytes/1.0.4/concat.d.ts.map +0 -1
  173. package/esm/deps/jsr.io/@std/encoding/1.0.6/hex.d.ts.map +0 -1
  174. package/esm/deps/jsr.io/@std/msgpack/1.0.2/encode.d.ts.map +0 -1
  175. package/script/deps/jsr.io/@std/bytes/1.0.4/concat.d.ts.map +0 -1
  176. package/script/deps/jsr.io/@std/bytes/1.0.4/concat.js +0 -35
  177. package/script/deps/jsr.io/@std/encoding/1.0.6/_validate_binary_like.js +0 -29
  178. package/script/deps/jsr.io/@std/encoding/1.0.6/hex.d.ts.map +0 -1
  179. package/script/deps/jsr.io/@std/encoding/1.0.6/hex.js +0 -113
  180. package/script/deps/jsr.io/@std/msgpack/1.0.2/encode.d.ts.map +0 -1
  181. package/script/deps/jsr.io/@std/msgpack/1.0.2/encode.js +0 -240
  182. /package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.d.ts +0 -0
  183. /package/script/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.d.ts +0 -0
@@ -1,59 +1,59 @@
1
1
  import type { Hex } from "../common.js";
2
2
  /**
3
- * Order type for market execution:
4
- * - `"Market"`: An order that executes immediately at the current market price.
5
- * - `"Limit"`: An order that executes at the selected limit price or better.
6
- * - `"Stop Market"`: A market order that is activated when the price reaches the selected stop price.
7
- * - `"Stop Limit"`: A limit order that is activated when the price reaches the selected stop price.
3
+ * Order types for market execution.
4
+ * - Market: Executes immediately at the market price.
5
+ * - Limit: Executes at the specified limit price or better.
6
+ * - Stop Market: Activates as a market order when a stop price is reached.
7
+ * - Stop Limit: Activates as a limit order when a stop price is reached.
8
8
  *
9
- * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/trading/order-types | Hyperliquid GitBook}
9
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/order-types
10
10
  */
11
11
  export type OrderType = "Market" | "Limit" | "Stop Market" | "Stop Limit";
12
12
  /**
13
- * Time-in-force options:
14
- * - `"Gtc"` (Good Til Cancelled): Remains active until filled or canceled.
15
- * - `"Ioc"` (Immediate or Cancel): Fills immediately or cancels any unfilled portion.
16
- * - `"Alo"` (Add Liquidity Only): Only adds liquidity; does not take liquidity.
17
- * - `"FrontendMarket"`: Equivalent `Ioc`. Used in Hyperliquid UI.
18
- * - `"LiquidationMarket"`: Equivalent `Ioc`. Used in Hyperliquid UI.
13
+ * Time-in-force options.
14
+ * - Gtc: Remains active until filled or canceled.
15
+ * - Ioc: Fills immediately or cancels any unfilled portion.
16
+ * - Alo: Adds liquidity only.
17
+ * - FrontendMarket: Similar to Ioc, used in Hyperliquid UI.
18
+ * - LiquidationMarket: Similar to Ioc, used in Hyperliquid UI.
19
19
  */
20
20
  export type TIF = "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket";
21
21
  /**
22
- * TWAP status:
23
- * - `"finished"`: The TWAP order has been fully executed.
24
- * - `"activated"`: The TWAP order has been activated and is currently executing
25
- * - `"terminated"`: The TWAP order has been terminated.
26
- * - `"error"`: An error occurred while processing the TWAP order.
22
+ * TWAP order status.
23
+ * - finished: Fully executed.
24
+ * - activated: Active and executing.
25
+ * - terminated: Terminated.
26
+ * - error: An error occurred.
27
27
  */
28
28
  export type TwapStatus = {
29
- /** The status of the twap. */
29
+ /** Status of the TWAP order. */
30
30
  status: "finished" | "activated" | "terminated";
31
31
  } | {
32
- /** The status of the twap. */
32
+ /** Status of the TWAP order. */
33
33
  status: "error";
34
- /** The error message. */
34
+ /** Error message. */
35
35
  description: string;
36
36
  };
37
37
  /**
38
- * Order processing status:
39
- * - `"filled"`: Order fully executed.
40
- * - `"open"`: Order is active and waiting to be filled.
41
- * - `"canceled"`: Order canceled by the user.
42
- * - `"triggered"`: Order triggered and awaiting execution.
43
- * - `"rejected"`: Order rejected by the system.
44
- * - `"marginCanceled"`: Order canceled due to insufficient margin.
38
+ * Order processing status.
39
+ * - filled: Order fully executed.
40
+ * - open: Order active and waiting to be filled.
41
+ * - canceled: Order canceled by the user.
42
+ * - triggered: Order triggered and awaiting execution.
43
+ * - rejected: Order rejected by the system.
44
+ * - marginCanceled: Order canceled due to insufficient margin.
45
45
  */
46
46
  export type OrderProcessingStatus = "filled" | "open" | "canceled" | "triggered" | "rejected" | "marginCanceled";
47
47
  /** L2 order book snapshot. */
48
48
  export interface Book {
49
49
  /** Asset symbol. */
50
50
  coin: string;
51
- /** Timestamp when the snapshot was taken (in ms since epoch). */
51
+ /** Timestamp of the snapshot (in ms since epoch). */
52
52
  time: number;
53
53
  /** Bid and ask levels (index 0 = bids, index 1 = asks). */
54
54
  levels: [BookLevel[], BookLevel[]];
55
55
  }
56
- /** Level of the order book. */
56
+ /** Order book level. */
57
57
  export interface BookLevel {
58
58
  /** Price. */
59
59
  px: string;
@@ -62,7 +62,7 @@ export interface BookLevel {
62
62
  /** Number of individual orders. */
63
63
  n: number;
64
64
  }
65
- /** Trade fill. */
65
+ /** Trade fill record. */
66
66
  export interface Fill {
67
67
  /** Asset symbol. */
68
68
  coin: string;
@@ -70,7 +70,7 @@ export interface Fill {
70
70
  px: string;
71
71
  /** Size. */
72
72
  sz: string;
73
- /** Side of the order ("B" = Bid = Buy, "A" = Ask = Sell). */
73
+ /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
74
74
  side: "B" | "A";
75
75
  /** Timestamp when the trade occurred (in ms since epoch). */
76
76
  time: number;
@@ -84,11 +84,11 @@ export interface Fill {
84
84
  hash: Hex;
85
85
  /** Order ID. */
86
86
  oid: number;
87
- /** Whether the fill was a taker order. */
87
+ /** Indicates if the fill was a taker order. */
88
88
  crossed: boolean;
89
- /** Fee charged or rebate received (negative value indicates rebate). */
89
+ /** Fee charged or rebate received (negative indicates rebate). */
90
90
  fee: string;
91
- /** Unique identifier of the transaction for the specified amount, which was a partial filling of one order (oid). */
91
+ /** Unique transaction identifier for a partial fill of an order. */
92
92
  tid: number;
93
93
  /** Client Order ID. */
94
94
  cloid?: Hex;
@@ -97,41 +97,41 @@ export interface Fill {
97
97
  /** Token in which the fee is denominated (e.g., "USDC"). */
98
98
  feeToken: string;
99
99
  }
100
- /** Liquidation details for a fill. */
100
+ /** Liquidation details for a trade fill. */
101
101
  export interface FillLiquidation {
102
- /** Address of the user who was liquidated. */
102
+ /** Address of the liquidated user. */
103
103
  liquidatedUser: Hex;
104
104
  /** Mark price at the time of liquidation. */
105
105
  markPx: string;
106
- /** Method of liquidation. */
106
+ /** Liquidation method. */
107
107
  method: "market" | "backstop";
108
108
  }
109
- /** Open order with additional frontend information. */
109
+ /** Frontend order with additional display information. */
110
110
  export interface FrontendOrder extends Omit<Order, "reduceOnly" | "cloid"> {
111
- /** Condition for triggering. */
111
+ /** Condition for triggering the order. */
112
112
  triggerCondition: string;
113
- /** Is the order a trigger order? */
113
+ /** Indicates if the order is a trigger order. */
114
114
  isTrigger: boolean;
115
115
  /** Trigger price. */
116
116
  triggerPx: string;
117
117
  /** Child orders associated with this order. */
118
118
  children: FrontendOrder[];
119
- /** Is the order a position TP/SL order (which changes depending on the position size)? */
119
+ /** Indicates if the order is a position TP/SL order. */
120
120
  isPositionTpsl: boolean;
121
- /** Is reduce-only? */
121
+ /** Indicates whether the order is reduce-only. */
122
122
  reduceOnly: boolean;
123
- /** Type of the order. */
123
+ /** Order type. */
124
124
  orderType: OrderType;
125
- /** Time-in-force. */
125
+ /** Time-in-force option. */
126
126
  tif: TIF | null;
127
127
  /** Client Order ID. */
128
128
  cloid: Hex | null;
129
129
  }
130
- /** Open order. */
130
+ /** Open order details. */
131
131
  export interface Order {
132
132
  /** Asset symbol. */
133
133
  coin: string;
134
- /** Side of the order ("B" = Bid = Buy, "A" = Ask = Sell). */
134
+ /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
135
135
  side: "B" | "A";
136
136
  /** Limit price. */
137
137
  limitPx: string;
@@ -141,14 +141,14 @@ export interface Order {
141
141
  oid: number;
142
142
  /** Timestamp when the order was placed (in ms since epoch). */
143
143
  timestamp: number;
144
- /** Original size when placed. */
144
+ /** Original size at order placement. */
145
145
  origSz: string;
146
146
  /** Client Order ID. */
147
147
  cloid?: Hex;
148
- /** Is reduce-only? */
148
+ /** Indicates if the order is reduce-only. */
149
149
  reduceOnly?: true;
150
150
  }
151
- /** Order status with additional frontend information and current status. */
151
+ /** Order status with additional frontend information and current state. */
152
152
  export interface OrderStatus<O extends Order | FrontendOrder> {
153
153
  /** Order details. */
154
154
  order: O;
@@ -167,43 +167,43 @@ export type OrderLookup = {
167
167
  /** Indicates that the order was not found. */
168
168
  status: "unknownOid";
169
169
  };
170
- /** The twap history of a user. */
170
+ /** TWAP history record for a user. */
171
171
  export interface TwapHistory {
172
- /** The creation time of this history record (in seconds since epoch). */
172
+ /** Creation time of the history record (in seconds since epoch). */
173
173
  time: number;
174
- /** The state of the twap. */
174
+ /** State of the TWAP order. */
175
175
  state: TwapState;
176
- /** The status of the twap. */
176
+ /** Current status of the TWAP order. */
177
177
  status: TwapStatus;
178
178
  }
179
- /** The twap slice fill of a user. */
179
+ /** TWAP slice fill details. */
180
180
  export interface TwapSliceFill {
181
- /** The fill of the twap slice. */
181
+ /** Fill details for the TWAP slice. */
182
182
  fill: Omit<Fill, "cloid" | "liquidation">;
183
- /** The id of the twap. */
183
+ /** ID of the TWAP. */
184
184
  twapId: number;
185
185
  }
186
- /** The twap state of a user. */
186
+ /** Current state of a TWAP order. */
187
187
  export interface TwapState {
188
- /** The asset symbol. */
188
+ /** Asset symbol. */
189
189
  coin: string;
190
- /** The executed notional. */
190
+ /** Executed notional value. */
191
191
  executedNtl: string;
192
- /** The executed size. */
192
+ /** Executed size. */
193
193
  executedSz: string;
194
- /** The number of minutes. */
194
+ /** Duration in minutes. */
195
195
  minutes: number;
196
- /** Whether to randomize the twap. */
196
+ /** Indicates if the TWAP randomizes execution. */
197
197
  randomize: boolean;
198
- /** Whether to reduce only. */
198
+ /** Indicates if the order is reduce-only. */
199
199
  reduceOnly: boolean;
200
- /** The side of the order ("B" = Bid = Buy, "A" = Ask = Sell). */
200
+ /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
201
201
  side: "B" | "A";
202
- /** The size of the order. */
202
+ /** Order size. */
203
203
  sz: string;
204
- /** The start time of the TWAP order (in milliseconds since epoch). */
204
+ /** Start time of the TWAP order (in ms since epoch). */
205
205
  timestamp: number;
206
- /** The user's address. */
206
+ /** User address. */
207
207
  user: Hex;
208
208
  }
209
209
  //# sourceMappingURL=orders.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"orders.d.ts","sourceRoot":"","sources":["../../../../src/src/types/info/orders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GACf,QAAQ,GACR,OAAO,GACP,aAAa,GACb,YAAY,CAAC;AAEnB;;;;;;;GAOG;AACH,MAAM,MAAM,GAAG,GACT,KAAK,GACL,KAAK,GACL,KAAK,GACL,gBAAgB,GAChB,mBAAmB,CAAC;AAE1B;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG;IACrB,8BAA8B;IAC9B,MAAM,EAAE,UAAU,GAAG,WAAW,GAAG,YAAY,CAAC;CACnD,GAAG;IACA,8BAA8B;IAC9B,MAAM,EAAE,OAAO,CAAC;IAEhB,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,GAC3B,QAAQ,GACR,MAAM,GACN,UAAU,GACV,WAAW,GACX,UAAU,GACV,gBAAgB,CAAC;AAEvB,8BAA8B;AAC9B,MAAM,WAAW,IAAI;IACjB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IAEb,2DAA2D;IAC3D,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;CACtC;AAED,+BAA+B;AAC/B,MAAM,WAAW,SAAS;IACtB,aAAa;IACb,EAAE,EAAE,MAAM,CAAC;IAEX,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IAEX,mCAAmC;IACnC,CAAC,EAAE,MAAM,CAAC;CACb;AAED,kBAAkB;AAClB,MAAM,WAAW,IAAI;IACjB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa;IACb,EAAE,EAAE,MAAM,CAAC;IAEX,YAAY;IACZ,EAAE,EAAE,MAAM,CAAC;IAEX,6DAA6D;IAC7D,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAEhB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IAEb,2BAA2B;IAC3B,aAAa,EAAE,MAAM,CAAC;IAEtB,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAC;IAEZ,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAC;IAElB,2BAA2B;IAC3B,IAAI,EAAE,GAAG,CAAC;IAEV,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IAEZ,0CAA0C;IAC1C,OAAO,EAAE,OAAO,CAAC;IAEjB,wEAAwE;IACxE,GAAG,EAAE,MAAM,CAAC;IAEZ,qHAAqH;IACrH,GAAG,EAAE,MAAM,CAAC;IAEZ,uBAAuB;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,2BAA2B;IAC3B,WAAW,CAAC,EAAE,eAAe,CAAC;IAE9B,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,sCAAsC;AACtC,MAAM,WAAW,eAAe;IAC5B,8CAA8C;IAC9C,cAAc,EAAE,GAAG,CAAC;IAEpB,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;IAEf,6BAA6B;IAC7B,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;CACjC;AAED,uDAAuD;AACvD,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC;IACtE,gCAAgC;IAChC,gBAAgB,EAAE,MAAM,CAAC;IAEzB,oCAAoC;IACpC,SAAS,EAAE,OAAO,CAAC;IAEnB,qBAAqB;IACrB,SAAS,EAAE,MAAM,CAAC;IAElB,+CAA+C;IAC/C,QAAQ,EAAE,aAAa,EAAE,CAAC;IAE1B,0FAA0F;IAC1F,cAAc,EAAE,OAAO,CAAC;IAExB,sBAAsB;IACtB,UAAU,EAAE,OAAO,CAAC;IAEpB,yBAAyB;IACzB,SAAS,EAAE,SAAS,CAAC;IAErB,qBAAqB;IACrB,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;IAEhB,uBAAuB;IACvB,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CACrB;AAED,kBAAkB;AAClB,MAAM,WAAW,KAAK;IAClB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb,6DAA6D;IAC7D,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAEhB,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAEhB,YAAY;IACZ,EAAE,EAAE,MAAM,CAAC;IAEX,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IAEZ,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAElB,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IAEf,uBAAuB;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,sBAAsB;IACtB,UAAU,CAAC,EAAE,IAAI,CAAC;CACrB;AAED,4EAA4E;AAC5E,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,KAAK,GAAG,aAAa;IACxD,qBAAqB;IACrB,KAAK,EAAE,CAAC,CAAC;IAET,+BAA+B;IAC/B,MAAM,EAAE,qBAAqB,CAAC;IAE9B,sEAAsE;IACtE,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,wCAAwC;AACxC,MAAM,MAAM,WAAW,GACjB;IACE,0CAA0C;IAC1C,MAAM,EAAE,OAAO,CAAC;IAEhB,qBAAqB;IACrB,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACrC,GACC;IACE,8CAA8C;IAC9C,MAAM,EAAE,YAAY,CAAC;CACxB,CAAC;AAEN,kCAAkC;AAClC,MAAM,WAAW,WAAW;IACxB,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC;IAEb,6BAA6B;IAC7B,KAAK,EAAE,SAAS,CAAC;IAEjB,8BAA8B;IAC9B,MAAM,EAAE,UAAU,CAAC;CACtB;AAED,qCAAqC;AACrC,MAAM,WAAW,aAAa;IAC1B,kCAAkC;IAClC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa,CAAC,CAAC;IAE1C,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,gCAAgC;AAChC,MAAM,WAAW,SAAS;IACtB,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IAEb,6BAA6B;IAC7B,WAAW,EAAE,MAAM,CAAC;IAEpB,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IAEnB,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC;IAEhB,qCAAqC;IACrC,SAAS,EAAE,OAAO,CAAC;IAEnB,8BAA8B;IAC9B,UAAU,EAAE,OAAO,CAAC;IAEpB,iEAAiE;IACjE,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAEhB,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IAEX,sEAAsE;IACtE,SAAS,EAAE,MAAM,CAAC;IAElB,0BAA0B;IAC1B,IAAI,EAAE,GAAG,CAAC;CACb"}
1
+ {"version":3,"file":"orders.d.ts","sourceRoot":"","sources":["../../../../src/src/types/info/orders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,aAAa,GAAG,YAAY,CAAC;AAE1E;;;;;;;GAOG;AACH,MAAM,MAAM,GAAG,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,gBAAgB,GAAG,mBAAmB,CAAC;AAEjF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAChB;IACE,gCAAgC;IAChC,MAAM,EAAE,UAAU,GAAG,WAAW,GAAG,YAAY,CAAC;CACnD,GACC;IACE,gCAAgC;IAChC,MAAM,EAAE,OAAO,CAAC;IAChB,qBAAqB;IACrB,WAAW,EAAE,MAAM,CAAC;CACvB,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,GAC3B,QAAQ,GACR,MAAM,GACN,UAAU,GACV,WAAW,GACX,UAAU,GACV,gBAAgB,CAAC;AAEvB,8BAA8B;AAC9B,MAAM,WAAW,IAAI;IACjB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;CACtC;AAED,wBAAwB;AACxB,MAAM,WAAW,SAAS;IACtB,aAAa;IACb,EAAE,EAAE,MAAM,CAAC;IACX,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,mCAAmC;IACnC,CAAC,EAAE,MAAM,CAAC;CACb;AAED,yBAAyB;AACzB,MAAM,WAAW,IAAI;IACjB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa;IACb,EAAE,EAAE,MAAM,CAAC;IACX,YAAY;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,IAAI,EAAE,GAAG,CAAC;IACV,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,kEAAkE;IAClE,GAAG,EAAE,MAAM,CAAC;IACZ,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAC;IACZ,uBAAuB;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,2BAA2B;IAC3B,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC5B,sCAAsC;IACtC,cAAc,EAAE,GAAG,CAAC;IACpB,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;CACjC;AAED,0DAA0D;AAC1D,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC;IACtE,0CAA0C;IAC1C,gBAAgB,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,SAAS,EAAE,OAAO,CAAC;IACnB,qBAAqB;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,wDAAwD;IACxD,cAAc,EAAE,OAAO,CAAC;IACxB,kDAAkD;IAClD,UAAU,EAAE,OAAO,CAAC;IACpB,kBAAkB;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,4BAA4B;IAC5B,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;IAChB,uBAAuB;IACvB,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CACrB;AAED,0BAA0B;AAC1B,MAAM,WAAW,KAAK;IAClB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,6CAA6C;IAC7C,UAAU,CAAC,EAAE,IAAI,CAAC;CACrB;AAED,2EAA2E;AAC3E,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,KAAK,GAAG,aAAa;IACxD,qBAAqB;IACrB,KAAK,EAAE,CAAC,CAAC;IACT,+BAA+B;IAC/B,MAAM,EAAE,qBAAqB,CAAC;IAC9B,sEAAsE;IACtE,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,wCAAwC;AACxC,MAAM,MAAM,WAAW,GACjB;IACE,0CAA0C;IAC1C,MAAM,EAAE,OAAO,CAAC;IAChB,qBAAqB;IACrB,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACrC,GACC;IACE,8CAA8C;IAC9C,MAAM,EAAE,YAAY,CAAC;CACxB,CAAC;AAEN,sCAAsC;AACtC,MAAM,WAAW,WAAW;IACxB,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,KAAK,EAAE,SAAS,CAAC;IACjB,wCAAwC;IACxC,MAAM,EAAE,UAAU,CAAC;CACtB;AAED,+BAA+B;AAC/B,MAAM,WAAW,aAAa;IAC1B,uCAAuC;IACvC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa,CAAC,CAAC;IAC1C,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,qCAAqC;AACrC,MAAM,WAAW,SAAS;IACtB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,qBAAqB;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,UAAU,EAAE,OAAO,CAAC;IACpB,kDAAkD;IAClD,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,IAAI,EAAE,GAAG,CAAC;CACb"}
@@ -1,2 +1,12 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ (function (factory) {
2
+ if (typeof module === "object" && typeof module.exports === "object") {
3
+ var v = factory(require, exports);
4
+ if (v !== undefined) module.exports = v;
5
+ }
6
+ else if (typeof define === "function" && define.amd) {
7
+ define(["require", "exports"], factory);
8
+ }
9
+ })(function (require, exports) {
10
+ "use strict";
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ });