@nktkas/hyperliquid 0.25.0-beta.1 → 0.25.0-beta.3
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.
- package/README.md +64 -16
- package/esm/bin/cli.d.ts +3 -0
- package/esm/bin/cli.d.ts.map +1 -0
- package/esm/bin/cli.js +452 -0
- package/esm/bin/cli.js.map +1 -0
- package/{script/src/errors.d.ts → esm/src/_errors.d.ts} +1 -1
- package/esm/src/_errors.d.ts.map +1 -0
- package/esm/src/{errors.js → _errors.js} +1 -0
- package/esm/src/_errors.js.map +1 -0
- package/esm/src/clients/exchange.d.ts +4 -11
- package/esm/src/clients/exchange.d.ts.map +1 -1
- package/esm/src/clients/exchange.js +8 -9
- package/esm/src/clients/exchange.js.map +1 -0
- package/esm/src/clients/info.d.ts +86 -2
- package/esm/src/clients/info.d.ts.map +1 -1
- package/esm/src/clients/info.js +103 -1
- package/esm/src/clients/info.js.map +1 -0
- package/esm/src/clients/multiSign.d.ts +1 -1
- package/esm/src/clients/multiSign.d.ts.map +1 -1
- package/esm/src/clients/multiSign.js +3 -2
- package/esm/src/clients/multiSign.js.map +1 -0
- package/esm/src/clients/subscription.js +1 -0
- package/esm/src/clients/subscription.js.map +1 -0
- package/esm/src/mod.d.ts +21 -0
- package/esm/src/mod.d.ts.map +1 -0
- package/esm/src/mod.js +14 -0
- package/esm/src/mod.js.map +1 -0
- package/esm/src/schemas/_base.d.ts +11 -3
- package/esm/src/schemas/_base.d.ts.map +1 -1
- package/esm/src/schemas/_base.js +30 -2
- package/esm/src/schemas/_base.js.map +1 -0
- package/esm/src/schemas/exchange/requests.d.ts +1872 -1872
- package/esm/src/schemas/exchange/requests.d.ts.map +1 -1
- package/esm/src/schemas/exchange/requests.js +277 -281
- package/esm/src/schemas/exchange/requests.js.map +1 -0
- package/esm/src/schemas/exchange/responses.d.ts +51 -51
- package/esm/src/schemas/exchange/responses.js +55 -54
- package/esm/src/schemas/exchange/responses.js.map +1 -0
- package/esm/src/schemas/explorer/requests.d.ts +5 -5
- package/esm/src/schemas/explorer/requests.js +6 -5
- package/esm/src/schemas/explorer/requests.js.map +1 -0
- package/esm/src/schemas/explorer/responses.d.ts +10 -10
- package/esm/src/schemas/explorer/responses.js +12 -11
- package/esm/src/schemas/explorer/responses.js.map +1 -0
- package/esm/src/schemas/info/accounts.d.ts +1042 -296
- package/esm/src/schemas/info/accounts.d.ts.map +1 -1
- package/esm/src/schemas/info/accounts.js +154 -109
- package/esm/src/schemas/info/accounts.js.map +1 -0
- package/esm/src/schemas/info/assets.d.ts +130 -101
- package/esm/src/schemas/info/assets.d.ts.map +1 -1
- package/esm/src/schemas/info/assets.js +69 -49
- package/esm/src/schemas/info/assets.js.map +1 -0
- package/esm/src/schemas/info/markets.d.ts +35 -18
- package/esm/src/schemas/info/markets.d.ts.map +1 -1
- package/esm/src/schemas/info/markets.js +27 -15
- package/esm/src/schemas/info/markets.js.map +1 -0
- package/esm/src/schemas/info/orders.d.ts +151 -151
- package/esm/src/schemas/info/orders.js +37 -36
- package/esm/src/schemas/info/orders.js.map +1 -0
- package/esm/src/schemas/info/requests.d.ts +145 -88
- package/esm/src/schemas/info/requests.d.ts.map +1 -1
- package/esm/src/schemas/info/requests.js +116 -73
- package/esm/src/schemas/info/requests.js.map +1 -0
- package/esm/src/schemas/info/validators.d.ts +60 -39
- package/esm/src/schemas/info/validators.d.ts.map +1 -1
- package/esm/src/schemas/info/validators.js +40 -26
- package/esm/src/schemas/info/validators.js.map +1 -0
- package/esm/src/schemas/info/vaults.d.ts +59 -59
- package/esm/src/schemas/info/vaults.js +20 -19
- package/esm/src/schemas/info/vaults.js.map +1 -0
- package/esm/src/schemas/mod.d.ts +4 -3
- package/esm/src/schemas/mod.d.ts.map +1 -1
- package/esm/src/schemas/mod.js +5 -3
- package/esm/src/schemas/mod.js.map +1 -0
- package/esm/src/schemas/subscriptions/requests.d.ts +23 -23
- package/esm/src/schemas/subscriptions/requests.d.ts.map +1 -1
- package/esm/src/schemas/subscriptions/requests.js +25 -24
- package/esm/src/schemas/subscriptions/requests.js.map +1 -0
- package/esm/src/schemas/subscriptions/responses.d.ts +547 -547
- package/esm/src/schemas/subscriptions/responses.js +41 -40
- package/esm/src/schemas/subscriptions/responses.js.map +1 -0
- package/esm/src/signing/mod.d.ts +1 -1
- package/esm/src/signing/mod.d.ts.map +1 -1
- package/esm/src/signing/mod.js +3 -2
- package/esm/src/signing/mod.js.map +1 -0
- package/esm/src/signing/signTypedData/ethers.d.ts.map +1 -0
- package/esm/src/signing/{_signTypedData → signTypedData}/ethers.js +1 -0
- package/esm/src/signing/signTypedData/ethers.js.map +1 -0
- package/esm/src/signing/signTypedData/mod.d.ts.map +1 -0
- package/esm/src/signing/{_signTypedData → signTypedData}/mod.js +1 -0
- package/esm/src/signing/signTypedData/mod.js.map +1 -0
- package/esm/src/signing/signTypedData/private_key.d.ts.map +1 -0
- package/esm/src/signing/{_signTypedData → signTypedData}/private_key.js +10 -8
- package/esm/src/signing/signTypedData/private_key.js.map +1 -0
- package/esm/src/signing/signTypedData/viem.d.ts.map +1 -0
- package/esm/src/signing/{_signTypedData → signTypedData}/viem.js +1 -0
- package/esm/src/signing/signTypedData/viem.js.map +1 -0
- package/esm/src/transports/base.d.ts +4 -4
- package/esm/src/transports/base.d.ts.map +1 -1
- package/esm/src/transports/base.js +3 -2
- package/esm/src/transports/base.js.map +1 -0
- package/esm/src/transports/http/http_transport.d.ts +1 -1
- package/esm/src/transports/http/http_transport.js +1 -0
- package/esm/src/transports/http/http_transport.js.map +1 -0
- package/esm/src/transports/websocket/_hyperliquid_event_target.js +1 -0
- package/esm/src/transports/websocket/_hyperliquid_event_target.js.map +1 -0
- package/esm/src/transports/websocket/_reconnecting_websocket.js +1 -0
- package/esm/src/transports/websocket/_reconnecting_websocket.js.map +1 -0
- package/esm/src/transports/websocket/_websocket_async_request.js +1 -0
- package/esm/src/transports/websocket/_websocket_async_request.js.map +1 -0
- package/esm/src/transports/websocket/websocket_transport.d.ts +7 -0
- package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/esm/src/transports/websocket/websocket_transport.js +4 -0
- package/esm/src/transports/websocket/websocket_transport.js.map +1 -0
- package/package.json +15 -7
- package/script/bin/cli.d.ts +3 -0
- package/script/bin/cli.d.ts.map +1 -0
- package/script/bin/cli.js +490 -0
- package/script/bin/cli.js.map +1 -0
- package/{esm/src/errors.d.ts → script/src/_errors.d.ts} +1 -1
- package/script/src/_errors.d.ts.map +1 -0
- package/script/src/{errors.js → _errors.js} +1 -0
- package/script/src/_errors.js.map +1 -0
- package/script/src/clients/exchange.d.ts +4 -11
- package/script/src/clients/exchange.d.ts.map +1 -1
- package/script/src/clients/exchange.js +9 -10
- package/script/src/clients/exchange.js.map +1 -0
- package/script/src/clients/info.d.ts +86 -2
- package/script/src/clients/info.d.ts.map +1 -1
- package/script/src/clients/info.js +102 -0
- package/script/src/clients/info.js.map +1 -0
- package/script/src/clients/multiSign.d.ts +1 -1
- package/script/src/clients/multiSign.d.ts.map +1 -1
- package/script/src/clients/multiSign.js +3 -2
- package/script/src/clients/multiSign.js.map +1 -0
- package/script/src/clients/subscription.js +1 -0
- package/script/src/clients/subscription.js.map +1 -0
- package/script/src/mod.d.ts +21 -0
- package/script/src/mod.d.ts.map +1 -0
- package/script/{mod.js → src/mod.js} +13 -8
- package/script/src/mod.js.map +1 -0
- package/script/src/schemas/_base.d.ts +11 -3
- package/script/src/schemas/_base.d.ts.map +1 -1
- package/script/src/schemas/_base.js +31 -3
- package/script/src/schemas/_base.js.map +1 -0
- package/script/src/schemas/exchange/requests.d.ts +1872 -1872
- package/script/src/schemas/exchange/requests.d.ts.map +1 -1
- package/script/src/schemas/exchange/requests.js +276 -280
- package/script/src/schemas/exchange/requests.js.map +1 -0
- package/script/src/schemas/exchange/responses.d.ts +51 -51
- package/script/src/schemas/exchange/responses.js +54 -53
- package/script/src/schemas/exchange/responses.js.map +1 -0
- package/script/src/schemas/explorer/requests.d.ts +5 -5
- package/script/src/schemas/explorer/requests.js +5 -4
- package/script/src/schemas/explorer/requests.js.map +1 -0
- package/script/src/schemas/explorer/responses.d.ts +10 -10
- package/script/src/schemas/explorer/responses.js +11 -10
- package/script/src/schemas/explorer/responses.js.map +1 -0
- package/script/src/schemas/info/accounts.d.ts +1042 -296
- package/script/src/schemas/info/accounts.d.ts.map +1 -1
- package/script/src/schemas/info/accounts.js +154 -109
- package/script/src/schemas/info/accounts.js.map +1 -0
- package/script/src/schemas/info/assets.d.ts +130 -101
- package/script/src/schemas/info/assets.d.ts.map +1 -1
- package/script/src/schemas/info/assets.js +69 -49
- package/script/src/schemas/info/assets.js.map +1 -0
- package/script/src/schemas/info/markets.d.ts +35 -18
- package/script/src/schemas/info/markets.d.ts.map +1 -1
- package/script/src/schemas/info/markets.js +27 -15
- package/script/src/schemas/info/markets.js.map +1 -0
- package/script/src/schemas/info/orders.d.ts +151 -151
- package/script/src/schemas/info/orders.js +36 -35
- package/script/src/schemas/info/orders.js.map +1 -0
- package/script/src/schemas/info/requests.d.ts +145 -88
- package/script/src/schemas/info/requests.d.ts.map +1 -1
- package/script/src/schemas/info/requests.js +116 -73
- package/script/src/schemas/info/requests.js.map +1 -0
- package/script/src/schemas/info/validators.d.ts +60 -39
- package/script/src/schemas/info/validators.d.ts.map +1 -1
- package/script/src/schemas/info/validators.js +40 -26
- package/script/src/schemas/info/validators.js.map +1 -0
- package/script/src/schemas/info/vaults.d.ts +59 -59
- package/script/src/schemas/info/vaults.js +19 -18
- package/script/src/schemas/info/vaults.js.map +1 -0
- package/script/src/schemas/mod.d.ts +4 -3
- package/script/src/schemas/mod.d.ts.map +1 -1
- package/script/src/schemas/mod.js +8 -5
- package/script/src/schemas/mod.js.map +1 -0
- package/script/src/schemas/subscriptions/requests.d.ts +23 -23
- package/script/src/schemas/subscriptions/requests.d.ts.map +1 -1
- package/script/src/schemas/subscriptions/requests.js +24 -23
- package/script/src/schemas/subscriptions/requests.js.map +1 -0
- package/script/src/schemas/subscriptions/responses.d.ts +547 -547
- package/script/src/schemas/subscriptions/responses.js +40 -39
- package/script/src/schemas/subscriptions/responses.js.map +1 -0
- package/script/src/signing/mod.d.ts +1 -1
- package/script/src/signing/mod.d.ts.map +1 -1
- package/script/src/signing/mod.js +4 -3
- package/script/src/signing/mod.js.map +1 -0
- package/script/src/signing/signTypedData/ethers.d.ts.map +1 -0
- package/script/src/signing/{_signTypedData → signTypedData}/ethers.js +1 -0
- package/script/src/signing/signTypedData/ethers.js.map +1 -0
- package/script/src/signing/signTypedData/mod.d.ts.map +1 -0
- package/script/src/signing/{_signTypedData → signTypedData}/mod.js +1 -0
- package/script/src/signing/signTypedData/mod.js.map +1 -0
- package/script/src/signing/signTypedData/private_key.d.ts.map +1 -0
- package/script/src/signing/{_signTypedData → signTypedData}/private_key.js +17 -15
- package/script/src/signing/signTypedData/private_key.js.map +1 -0
- package/script/src/signing/signTypedData/viem.d.ts.map +1 -0
- package/script/src/signing/{_signTypedData → signTypedData}/viem.js +1 -0
- package/script/src/signing/signTypedData/viem.js.map +1 -0
- package/script/src/transports/base.d.ts +4 -4
- package/script/src/transports/base.d.ts.map +1 -1
- package/script/src/transports/base.js +4 -3
- package/script/src/transports/base.js.map +1 -0
- package/script/src/transports/http/http_transport.d.ts +1 -1
- package/script/src/transports/http/http_transport.js +1 -0
- package/script/src/transports/http/http_transport.js.map +1 -0
- package/script/src/transports/websocket/_hyperliquid_event_target.js +1 -0
- package/script/src/transports/websocket/_hyperliquid_event_target.js.map +1 -0
- package/script/src/transports/websocket/_reconnecting_websocket.js +1 -0
- package/script/src/transports/websocket/_reconnecting_websocket.js.map +1 -0
- package/script/src/transports/websocket/_websocket_async_request.js +1 -0
- package/script/src/transports/websocket/_websocket_async_request.js.map +1 -0
- package/script/src/transports/websocket/websocket_transport.d.ts +7 -0
- package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/script/src/transports/websocket/websocket_transport.js +4 -0
- package/script/src/transports/websocket/websocket_transport.js.map +1 -0
- package/src/bin/cli.ts +481 -0
- package/src/src/_errors.ts +7 -0
- package/src/src/clients/exchange.ts +2246 -0
- package/src/src/clients/info.ts +2110 -0
- package/src/src/clients/multiSign.ts +183 -0
- package/src/src/clients/subscription.ts +841 -0
- package/src/src/mod.ts +29 -0
- package/src/src/schemas/_base.ts +82 -0
- package/src/src/schemas/exchange/requests.ts +3052 -0
- package/src/src/schemas/exchange/responses.ts +540 -0
- package/src/src/schemas/explorer/requests.ts +65 -0
- package/src/src/schemas/explorer/responses.ts +138 -0
- package/src/src/schemas/info/accounts.ts +1598 -0
- package/src/src/schemas/info/assets.ts +693 -0
- package/src/src/schemas/info/markets.ts +171 -0
- package/src/src/schemas/info/orders.ts +597 -0
- package/src/src/schemas/info/requests.ts +1401 -0
- package/src/src/schemas/info/validators.ts +297 -0
- package/src/src/schemas/info/vaults.ts +262 -0
- package/src/src/schemas/mod.ts +121 -0
- package/src/src/schemas/subscriptions/requests.ts +514 -0
- package/src/src/schemas/subscriptions/responses.ts +576 -0
- package/src/src/signing/mod.ts +572 -0
- package/src/src/signing/signTypedData/ethers.ts +59 -0
- package/src/src/signing/signTypedData/mod.ts +121 -0
- package/src/src/signing/signTypedData/private_key.ts +234 -0
- package/src/src/signing/signTypedData/viem.ts +55 -0
- package/src/src/transports/base.ts +54 -0
- package/src/src/transports/http/http_transport.ts +208 -0
- package/src/src/transports/websocket/_hyperliquid_event_target.ts +118 -0
- package/src/src/transports/websocket/_reconnecting_websocket.ts +404 -0
- package/src/src/transports/websocket/_websocket_async_request.ts +229 -0
- package/src/src/transports/websocket/websocket_transport.ts +394 -0
- package/esm/mod.d.ts +0 -20
- package/esm/mod.d.ts.map +0 -1
- package/esm/mod.js +0 -11
- package/esm/src/errors.d.ts.map +0 -1
- package/esm/src/signing/_signTypedData/ethers.d.ts.map +0 -1
- package/esm/src/signing/_signTypedData/mod.d.ts.map +0 -1
- package/esm/src/signing/_signTypedData/private_key.d.ts.map +0 -1
- package/esm/src/signing/_signTypedData/viem.d.ts.map +0 -1
- package/script/mod.d.ts +0 -20
- package/script/mod.d.ts.map +0 -1
- package/script/src/errors.d.ts.map +0 -1
- package/script/src/signing/_signTypedData/ethers.d.ts.map +0 -1
- package/script/src/signing/_signTypedData/mod.d.ts.map +0 -1
- package/script/src/signing/_signTypedData/private_key.d.ts.map +0 -1
- package/script/src/signing/_signTypedData/viem.d.ts.map +0 -1
- /package/esm/src/signing/{_signTypedData → signTypedData}/ethers.d.ts +0 -0
- /package/esm/src/signing/{_signTypedData → signTypedData}/mod.d.ts +0 -0
- /package/esm/src/signing/{_signTypedData → signTypedData}/private_key.d.ts +0 -0
- /package/esm/src/signing/{_signTypedData → signTypedData}/viem.d.ts +0 -0
- /package/script/src/signing/{_signTypedData → signTypedData}/ethers.d.ts +0 -0
- /package/script/src/signing/{_signTypedData → signTypedData}/mod.d.ts +0 -0
- /package/script/src/signing/{_signTypedData → signTypedData}/private_key.d.ts +0 -0
- /package/script/src/signing/{_signTypedData → signTypedData}/viem.d.ts +0 -0
|
@@ -4,7 +4,7 @@ import * as v from "valibot";
|
|
|
4
4
|
* @returns {ActiveAssetData}
|
|
5
5
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-active-asset-data
|
|
6
6
|
*/
|
|
7
|
-
export declare const ActiveAssetDataRequest: v.SchemaWithPipe<readonly [v.
|
|
7
|
+
export declare const ActiveAssetDataRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
8
8
|
/** Type of request. */
|
|
9
9
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"activeAssetData", undefined>, v.DescriptionAction<"activeAssetData", "Type of request.">]>;
|
|
10
10
|
/** Asset symbol (e.g., BTC). */
|
|
@@ -22,7 +22,7 @@ export type ActiveAssetDataRequest = v.InferOutput<typeof ActiveAssetDataRequest
|
|
|
22
22
|
* @returns {AllMids}
|
|
23
23
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
|
|
24
24
|
*/
|
|
25
|
-
export declare const AllMidsRequest: v.SchemaWithPipe<readonly [v.
|
|
25
|
+
export declare const AllMidsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
26
26
|
/** Type of request. */
|
|
27
27
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"allMids", undefined>, v.DescriptionAction<"allMids", "Type of request.">]>;
|
|
28
28
|
/** DEX name (empty string for main dex). */
|
|
@@ -37,32 +37,32 @@ export type AllMidsRequest = v.InferOutput<typeof AllMidsRequest>;
|
|
|
37
37
|
* @returns {Candle[]}
|
|
38
38
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
|
|
39
39
|
*/
|
|
40
|
-
export declare const CandleSnapshotRequest: v.SchemaWithPipe<readonly [v.
|
|
40
|
+
export declare const CandleSnapshotRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
41
41
|
/** Type of request. */
|
|
42
42
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"candleSnapshot", undefined>, v.DescriptionAction<"candleSnapshot", "Type of request.">]>;
|
|
43
43
|
/** Request parameters. */
|
|
44
|
-
readonly req: v.SchemaWithPipe<readonly [v.
|
|
44
|
+
readonly req: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
45
45
|
/** Asset symbol (e.g., BTC). */
|
|
46
46
|
readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
|
|
47
47
|
/** Time interval. */
|
|
48
48
|
readonly interval: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"1m", undefined>, v.LiteralSchema<"3m", undefined>, v.LiteralSchema<"5m", undefined>, v.LiteralSchema<"15m", undefined>, v.LiteralSchema<"30m", undefined>, v.LiteralSchema<"1h", undefined>, v.LiteralSchema<"2h", undefined>, v.LiteralSchema<"4h", undefined>, v.LiteralSchema<"8h", undefined>, v.LiteralSchema<"12h", undefined>, v.LiteralSchema<"1d", undefined>, v.LiteralSchema<"3d", undefined>, v.LiteralSchema<"1w", undefined>, v.LiteralSchema<"1M", undefined>], undefined>, v.DescriptionAction<"1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M", "Time interval.">]>;
|
|
49
49
|
/** Start time (in ms since epoch). */
|
|
50
|
-
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.
|
|
50
|
+
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, v.DescriptionAction<string | number, "Start time (in ms since epoch).">]>;
|
|
51
51
|
/** End time (in ms since epoch). */
|
|
52
|
-
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.
|
|
52
|
+
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, undefined>, v.DescriptionAction<string | number | null | undefined, "End time (in ms since epoch).">]>;
|
|
53
53
|
}, undefined>, v.DescriptionAction<{
|
|
54
54
|
coin: string;
|
|
55
55
|
interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
|
|
56
|
-
startTime: number;
|
|
57
|
-
endTime?: number | null | undefined;
|
|
56
|
+
startTime: string | number;
|
|
57
|
+
endTime?: string | number | null | undefined;
|
|
58
58
|
}, "Request parameters.">]>;
|
|
59
59
|
}, undefined>, v.DescriptionAction<{
|
|
60
60
|
type: "candleSnapshot";
|
|
61
61
|
req: {
|
|
62
62
|
coin: string;
|
|
63
63
|
interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
|
|
64
|
-
startTime: number;
|
|
65
|
-
endTime?: number | null | undefined;
|
|
64
|
+
startTime: string | number;
|
|
65
|
+
endTime?: string | number | null | undefined;
|
|
66
66
|
};
|
|
67
67
|
}, "Request candlestick snapshots.">]>;
|
|
68
68
|
export type CandleSnapshotRequest = v.InferOutput<typeof CandleSnapshotRequest>;
|
|
@@ -71,7 +71,7 @@ export type CandleSnapshotRequest = v.InferOutput<typeof CandleSnapshotRequest>;
|
|
|
71
71
|
* @returns {PerpsClearinghouseState}
|
|
72
72
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
|
|
73
73
|
*/
|
|
74
|
-
export declare const ClearinghouseStateRequest: v.SchemaWithPipe<readonly [v.
|
|
74
|
+
export declare const ClearinghouseStateRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
75
75
|
/** Type of request. */
|
|
76
76
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"clearinghouseState", undefined>, v.DescriptionAction<"clearinghouseState", "Type of request.">]>;
|
|
77
77
|
/** User address. */
|
|
@@ -89,7 +89,7 @@ export type ClearinghouseStateRequest = v.InferOutput<typeof ClearinghouseStateR
|
|
|
89
89
|
* @returns {Delegation[]}
|
|
90
90
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
|
|
91
91
|
*/
|
|
92
|
-
export declare const DelegationsRequest: v.SchemaWithPipe<readonly [v.
|
|
92
|
+
export declare const DelegationsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
93
93
|
/** Type of request. */
|
|
94
94
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"delegations", undefined>, v.DescriptionAction<"delegations", "Type of request.">]>;
|
|
95
95
|
/** User address. */
|
|
@@ -104,7 +104,7 @@ export type DelegationsRequest = v.InferOutput<typeof DelegationsRequest>;
|
|
|
104
104
|
* @returns {DelegatorUpdate[]}
|
|
105
105
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
|
|
106
106
|
*/
|
|
107
|
-
export declare const DelegatorHistoryRequest: v.SchemaWithPipe<readonly [v.
|
|
107
|
+
export declare const DelegatorHistoryRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
108
108
|
/** Type of request. */
|
|
109
109
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"delegatorHistory", undefined>, v.DescriptionAction<"delegatorHistory", "Type of request.">]>;
|
|
110
110
|
/** User address. */
|
|
@@ -119,7 +119,7 @@ export type DelegatorHistoryRequest = v.InferOutput<typeof DelegatorHistoryReque
|
|
|
119
119
|
* @returns {DelegatorReward[]}
|
|
120
120
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-rewards
|
|
121
121
|
*/
|
|
122
|
-
export declare const DelegatorRewardsRequest: v.SchemaWithPipe<readonly [v.
|
|
122
|
+
export declare const DelegatorRewardsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
123
123
|
/** Type of request. */
|
|
124
124
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"delegatorRewards", undefined>, v.DescriptionAction<"delegatorRewards", "Type of request.">]>;
|
|
125
125
|
/** User address. */
|
|
@@ -134,7 +134,7 @@ export type DelegatorRewardsRequest = v.InferOutput<typeof DelegatorRewardsReque
|
|
|
134
134
|
* @returns {DelegatorSummary}
|
|
135
135
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
|
|
136
136
|
*/
|
|
137
|
-
export declare const DelegatorSummaryRequest: v.SchemaWithPipe<readonly [v.
|
|
137
|
+
export declare const DelegatorSummaryRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
138
138
|
/** Type of request. */
|
|
139
139
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"delegatorSummary", undefined>, v.DescriptionAction<"delegatorSummary", "Type of request.">]>;
|
|
140
140
|
/** User address. */
|
|
@@ -149,7 +149,7 @@ export type DelegatorSummaryRequest = v.InferOutput<typeof DelegatorSummaryReque
|
|
|
149
149
|
* @returns {ExchangeStatus}
|
|
150
150
|
* @see null
|
|
151
151
|
*/
|
|
152
|
-
export declare const ExchangeStatusRequest: v.SchemaWithPipe<readonly [v.
|
|
152
|
+
export declare const ExchangeStatusRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
153
153
|
/** Type of request. */
|
|
154
154
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"exchangeStatus", undefined>, v.DescriptionAction<"exchangeStatus", "Type of request.">]>;
|
|
155
155
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -161,7 +161,7 @@ export type ExchangeStatusRequest = v.InferOutput<typeof ExchangeStatusRequest>;
|
|
|
161
161
|
* @returns {ExtraAgent[]}
|
|
162
162
|
* @see null
|
|
163
163
|
*/
|
|
164
|
-
export declare const ExtraAgentsRequest: v.SchemaWithPipe<readonly [v.
|
|
164
|
+
export declare const ExtraAgentsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
165
165
|
/** Type of request. */
|
|
166
166
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"extraAgents", undefined>, v.DescriptionAction<"extraAgents", "Type of request.">]>;
|
|
167
167
|
/** User address. */
|
|
@@ -176,7 +176,7 @@ export type ExtraAgentsRequest = v.InferOutput<typeof ExtraAgentsRequest>;
|
|
|
176
176
|
* @returns {FrontendOrder[]}
|
|
177
177
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
|
|
178
178
|
*/
|
|
179
|
-
export declare const FrontendOpenOrdersRequest: v.SchemaWithPipe<readonly [v.
|
|
179
|
+
export declare const FrontendOpenOrdersRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
180
180
|
/** Type of request. */
|
|
181
181
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"frontendOpenOrders", undefined>, v.DescriptionAction<"frontendOpenOrders", "Type of request.">]>;
|
|
182
182
|
/** User address. */
|
|
@@ -194,20 +194,20 @@ export type FrontendOpenOrdersRequest = v.InferOutput<typeof FrontendOpenOrdersR
|
|
|
194
194
|
* @returns {FundingHistory[]}
|
|
195
195
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
|
|
196
196
|
*/
|
|
197
|
-
export declare const FundingHistoryRequest: v.SchemaWithPipe<readonly [v.
|
|
197
|
+
export declare const FundingHistoryRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
198
198
|
/** Type of request. */
|
|
199
199
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"fundingHistory", undefined>, v.DescriptionAction<"fundingHistory", "Type of request.">]>;
|
|
200
200
|
/** Asset symbol (e.g., BTC). */
|
|
201
201
|
readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
|
|
202
202
|
/** Start time (in ms since epoch). */
|
|
203
|
-
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.
|
|
203
|
+
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, v.DescriptionAction<string | number, "Start time (in ms since epoch).">]>;
|
|
204
204
|
/** End time (in ms since epoch). */
|
|
205
|
-
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.
|
|
205
|
+
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, undefined>, v.DescriptionAction<string | number | null | undefined, "End time (in ms since epoch).">]>;
|
|
206
206
|
}, undefined>, v.DescriptionAction<{
|
|
207
207
|
type: "fundingHistory";
|
|
208
208
|
coin: string;
|
|
209
|
-
startTime: number;
|
|
210
|
-
endTime?: number | null | undefined;
|
|
209
|
+
startTime: string | number;
|
|
210
|
+
endTime?: string | number | null | undefined;
|
|
211
211
|
}, "Request funding history.">]>;
|
|
212
212
|
export type FundingHistoryRequest = v.InferOutput<typeof FundingHistoryRequest>;
|
|
213
213
|
/**
|
|
@@ -215,7 +215,7 @@ export type FundingHistoryRequest = v.InferOutput<typeof FundingHistoryRequest>;
|
|
|
215
215
|
* @returns {FrontendOrderStatus[]}
|
|
216
216
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
|
|
217
217
|
*/
|
|
218
|
-
export declare const HistoricalOrdersRequest: v.SchemaWithPipe<readonly [v.
|
|
218
|
+
export declare const HistoricalOrdersRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
219
219
|
/** Type of request. */
|
|
220
220
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"historicalOrders", undefined>, v.DescriptionAction<"historicalOrders", "Type of request.">]>;
|
|
221
221
|
/** User address. */
|
|
@@ -230,7 +230,7 @@ export type HistoricalOrdersRequest = v.InferOutput<typeof HistoricalOrdersReque
|
|
|
230
230
|
* @returns {boolean | null}
|
|
231
231
|
* @see null
|
|
232
232
|
*/
|
|
233
|
-
export declare const IsVipRequest: v.SchemaWithPipe<readonly [v.
|
|
233
|
+
export declare const IsVipRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
234
234
|
/** Type of request. */
|
|
235
235
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"isVip", undefined>, v.DescriptionAction<"isVip", "Type of request.">]>;
|
|
236
236
|
/** User address. */
|
|
@@ -245,15 +245,15 @@ export type IsVipRequest = v.InferOutput<typeof IsVipRequest>;
|
|
|
245
245
|
* @returns {Book}
|
|
246
246
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
|
|
247
247
|
*/
|
|
248
|
-
export declare const L2BookRequest: v.SchemaWithPipe<readonly [v.
|
|
248
|
+
export declare const L2BookRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
249
249
|
/** Type of request. */
|
|
250
250
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"l2Book", undefined>, v.DescriptionAction<"l2Book", "Type of request.">]>;
|
|
251
251
|
/** Asset symbol (e.g., BTC). */
|
|
252
252
|
readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
|
|
253
253
|
/** Number of significant figures. */
|
|
254
|
-
readonly nSigFigs: v.SchemaWithPipe<readonly [v.NullishSchema<v.UnionSchema<[v.LiteralSchema<2, undefined>, v.LiteralSchema<3, undefined>, v.LiteralSchema<4, undefined>, v.LiteralSchema<5, undefined>], undefined>, undefined>, v.DescriptionAction<3 | 2 | 4 | 5 | null | undefined, "Number of significant figures.">]>;
|
|
254
|
+
readonly nSigFigs: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, v.UnionSchema<[v.LiteralSchema<2, undefined>, v.LiteralSchema<3, undefined>, v.LiteralSchema<4, undefined>, v.LiteralSchema<5, undefined>], undefined>]>, undefined>, v.DescriptionAction<3 | 2 | 4 | 5 | null | undefined, "Number of significant figures.">]>;
|
|
255
255
|
/** Mantissa for aggregation (if `nSigFigs` is 5). */
|
|
256
|
-
readonly mantissa: v.SchemaWithPipe<readonly [v.NullishSchema<v.UnionSchema<[v.LiteralSchema<2, undefined>, v.LiteralSchema<5, undefined>], undefined>, undefined>, v.DescriptionAction<2 | 5 | null | undefined, "Mantissa for aggregation (if `nSigFigs` is 5).">]>;
|
|
256
|
+
readonly mantissa: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, v.UnionSchema<[v.LiteralSchema<2, undefined>, v.LiteralSchema<5, undefined>], undefined>]>, undefined>, v.DescriptionAction<2 | 5 | null | undefined, "Mantissa for aggregation (if `nSigFigs` is 5).">]>;
|
|
257
257
|
}, undefined>, v.DescriptionAction<{
|
|
258
258
|
type: "l2Book";
|
|
259
259
|
coin: string;
|
|
@@ -266,7 +266,7 @@ export type L2BookRequest = v.InferOutput<typeof L2BookRequest>;
|
|
|
266
266
|
* @returns {VaultLeading[]}
|
|
267
267
|
* @see null
|
|
268
268
|
*/
|
|
269
|
-
export declare const LeadingVaultsRequest: v.SchemaWithPipe<readonly [v.
|
|
269
|
+
export declare const LeadingVaultsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
270
270
|
/** Type of request. */
|
|
271
271
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"leadingVaults", undefined>, v.DescriptionAction<"leadingVaults", "Type of request.">]>;
|
|
272
272
|
/** User address. */
|
|
@@ -281,7 +281,7 @@ export type LeadingVaultsRequest = v.InferOutput<typeof LeadingVaultsRequest>;
|
|
|
281
281
|
* @returns {LegalCheck}
|
|
282
282
|
* @see null
|
|
283
283
|
*/
|
|
284
|
-
export declare const LegalCheckRequest: v.SchemaWithPipe<readonly [v.
|
|
284
|
+
export declare const LegalCheckRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
285
285
|
/** Type of request. */
|
|
286
286
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"legalCheck", undefined>, v.DescriptionAction<"legalCheck", "Type of request.">]>;
|
|
287
287
|
/** User address. */
|
|
@@ -296,7 +296,7 @@ export type LegalCheckRequest = v.InferOutput<typeof LegalCheckRequest>;
|
|
|
296
296
|
* @returns {unknown[]} FIXME: Define the return type
|
|
297
297
|
* @see null
|
|
298
298
|
*/
|
|
299
|
-
export declare const LiquidatableRequest: v.SchemaWithPipe<readonly [v.
|
|
299
|
+
export declare const LiquidatableRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
300
300
|
/** Type of request. */
|
|
301
301
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"liquidatable", undefined>, v.DescriptionAction<"liquidatable", "Type of request.">]>;
|
|
302
302
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -308,14 +308,14 @@ export type LiquidatableRequest = v.InferOutput<typeof LiquidatableRequest>;
|
|
|
308
308
|
* @returns {MarginTable}
|
|
309
309
|
* @see null
|
|
310
310
|
*/
|
|
311
|
-
export declare const MarginTableRequest: v.SchemaWithPipe<readonly [v.
|
|
311
|
+
export declare const MarginTableRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
312
312
|
/** Type of request. */
|
|
313
313
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"marginTable", undefined>, v.DescriptionAction<"marginTable", "Type of request.">]>;
|
|
314
314
|
/** Margin requirements table. */
|
|
315
|
-
readonly id: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.
|
|
315
|
+
readonly id: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, v.DescriptionAction<string | number, "Margin requirements table.">]>;
|
|
316
316
|
}, undefined>, v.DescriptionAction<{
|
|
317
317
|
type: "marginTable";
|
|
318
|
-
id: number;
|
|
318
|
+
id: string | number;
|
|
319
319
|
}, "Request margin table data.">]>;
|
|
320
320
|
export type MarginTableRequest = v.InferOutput<typeof MarginTableRequest>;
|
|
321
321
|
/**
|
|
@@ -323,7 +323,7 @@ export type MarginTableRequest = v.InferOutput<typeof MarginTableRequest>;
|
|
|
323
323
|
* @returns {number}
|
|
324
324
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
|
|
325
325
|
*/
|
|
326
|
-
export declare const MaxBuilderFeeRequest: v.SchemaWithPipe<readonly [v.
|
|
326
|
+
export declare const MaxBuilderFeeRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
327
327
|
/** Type of request. */
|
|
328
328
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"maxBuilderFee", undefined>, v.DescriptionAction<"maxBuilderFee", "Type of request.">]>;
|
|
329
329
|
/** User address. */
|
|
@@ -341,7 +341,7 @@ export type MaxBuilderFeeRequest = v.InferOutput<typeof MaxBuilderFeeRequest>;
|
|
|
341
341
|
* @returns {[number, string][]}
|
|
342
342
|
* @see null
|
|
343
343
|
*/
|
|
344
|
-
export declare const MaxMarketOrderNtlsRequest: v.SchemaWithPipe<readonly [v.
|
|
344
|
+
export declare const MaxMarketOrderNtlsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
345
345
|
/** Type of request. */
|
|
346
346
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"maxMarketOrderNtls", undefined>, v.DescriptionAction<"maxMarketOrderNtls", "Type of request.">]>;
|
|
347
347
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -353,7 +353,7 @@ export type MaxMarketOrderNtlsRequest = v.InferOutput<typeof MaxMarketOrderNtlsR
|
|
|
353
353
|
* @returns {PerpsMeta}
|
|
354
354
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata-universe-and-margin-tables
|
|
355
355
|
*/
|
|
356
|
-
export declare const MetaRequest: v.SchemaWithPipe<readonly [v.
|
|
356
|
+
export declare const MetaRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
357
357
|
/** Type of request. */
|
|
358
358
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"meta", undefined>, v.DescriptionAction<"meta", "Type of request.">]>;
|
|
359
359
|
/** DEX name (empty string for main dex). */
|
|
@@ -368,7 +368,7 @@ export type MetaRequest = v.InferOutput<typeof MetaRequest>;
|
|
|
368
368
|
* @returns {PerpsMetaAndAssetCtxs}
|
|
369
369
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc
|
|
370
370
|
*/
|
|
371
|
-
export declare const MetaAndAssetCtxsRequest: v.SchemaWithPipe<readonly [v.
|
|
371
|
+
export declare const MetaAndAssetCtxsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
372
372
|
/** Type of request. */
|
|
373
373
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"metaAndAssetCtxs", undefined>, v.DescriptionAction<"metaAndAssetCtxs", "Type of request.">]>;
|
|
374
374
|
/** DEX name (empty string for main dex). */
|
|
@@ -383,7 +383,7 @@ export type MetaAndAssetCtxsRequest = v.InferOutput<typeof MetaAndAssetCtxsReque
|
|
|
383
383
|
* @returns {Order[]}
|
|
384
384
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
|
|
385
385
|
*/
|
|
386
|
-
export declare const OpenOrdersRequest: v.SchemaWithPipe<readonly [v.
|
|
386
|
+
export declare const OpenOrdersRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
387
387
|
/** Type of request. */
|
|
388
388
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"openOrders", undefined>, v.DescriptionAction<"openOrders", "Type of request.">]>;
|
|
389
389
|
/** User address. */
|
|
@@ -401,17 +401,17 @@ export type OpenOrdersRequest = v.InferOutput<typeof OpenOrdersRequest>;
|
|
|
401
401
|
* @returns {OrderLookup}
|
|
402
402
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
|
|
403
403
|
*/
|
|
404
|
-
export declare const OrderStatusRequest: v.SchemaWithPipe<readonly [v.
|
|
404
|
+
export declare const OrderStatusRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
405
405
|
/** Type of request. */
|
|
406
406
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"orderStatus", undefined>, v.DescriptionAction<"orderStatus", "Type of request.">]>;
|
|
407
407
|
/** User address. */
|
|
408
408
|
readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
|
|
409
409
|
/** Order ID or Client Order ID. */
|
|
410
|
-
readonly oid: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.
|
|
410
|
+
readonly oid: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 34, undefined>]>], undefined>, v.DescriptionAction<string | number, "Order ID or Client Order ID.">]>;
|
|
411
411
|
}, undefined>, v.DescriptionAction<{
|
|
412
412
|
type: "orderStatus";
|
|
413
413
|
user: `0x${string}`;
|
|
414
|
-
oid:
|
|
414
|
+
oid: string | number;
|
|
415
415
|
}, "Request order status.">]>;
|
|
416
416
|
export type OrderStatusRequest = v.InferOutput<typeof OrderStatusRequest>;
|
|
417
417
|
/**
|
|
@@ -419,7 +419,7 @@ export type OrderStatusRequest = v.InferOutput<typeof OrderStatusRequest>;
|
|
|
419
419
|
* @returns {DeployAuctionStatus}
|
|
420
420
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
|
|
421
421
|
*/
|
|
422
|
-
export declare const PerpDeployAuctionStatusRequest: v.SchemaWithPipe<readonly [v.
|
|
422
|
+
export declare const PerpDeployAuctionStatusRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
423
423
|
/** Type of request. */
|
|
424
424
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeployAuctionStatus", undefined>, v.DescriptionAction<"perpDeployAuctionStatus", "Type of request.">]>;
|
|
425
425
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -431,7 +431,7 @@ export type PerpDeployAuctionStatusRequest = v.InferOutput<typeof PerpDeployAuct
|
|
|
431
431
|
* @returns {PerpDexs}
|
|
432
432
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
|
|
433
433
|
*/
|
|
434
|
-
export declare const PerpDexsRequest: v.SchemaWithPipe<readonly [v.
|
|
434
|
+
export declare const PerpDexsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
435
435
|
/** Type of request. */
|
|
436
436
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDexs", undefined>, v.DescriptionAction<"perpDexs", "Type of request.">]>;
|
|
437
437
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -443,7 +443,7 @@ export type PerpDexsRequest = v.InferOutput<typeof PerpDexsRequest>;
|
|
|
443
443
|
* @returns {string[]}
|
|
444
444
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
|
|
445
445
|
*/
|
|
446
|
-
export declare const PerpsAtOpenInterestCapRequest: v.SchemaWithPipe<readonly [v.
|
|
446
|
+
export declare const PerpsAtOpenInterestCapRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
447
447
|
/** Type of request. */
|
|
448
448
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpsAtOpenInterestCap", undefined>, v.DescriptionAction<"perpsAtOpenInterestCap", "Type of request.">]>;
|
|
449
449
|
/** DEX name (empty string for main dex). */
|
|
@@ -458,7 +458,7 @@ export type PerpsAtOpenInterestCapRequest = v.InferOutput<typeof PerpsAtOpenInte
|
|
|
458
458
|
* @returns {PortfolioPeriods}
|
|
459
459
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
|
|
460
460
|
*/
|
|
461
|
-
export declare const PortfolioRequest: v.SchemaWithPipe<readonly [v.
|
|
461
|
+
export declare const PortfolioRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
462
462
|
/** Type of request. */
|
|
463
463
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"portfolio", undefined>, v.DescriptionAction<"portfolio", "Type of request.">]>;
|
|
464
464
|
/** User address. */
|
|
@@ -473,7 +473,7 @@ export type PortfolioRequest = v.InferOutput<typeof PortfolioRequest>;
|
|
|
473
473
|
* @returns {PredictedFunding[]}
|
|
474
474
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
|
|
475
475
|
*/
|
|
476
|
-
export declare const PredictedFundingsRequest: v.SchemaWithPipe<readonly [v.
|
|
476
|
+
export declare const PredictedFundingsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
477
477
|
/** Type of request. */
|
|
478
478
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"predictedFundings", undefined>, v.DescriptionAction<"predictedFundings", "Type of request.">]>;
|
|
479
479
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -485,7 +485,7 @@ export type PredictedFundingsRequest = v.InferOutput<typeof PredictedFundingsReq
|
|
|
485
485
|
* @returns {PreTransferCheck}
|
|
486
486
|
* @see null
|
|
487
487
|
*/
|
|
488
|
-
export declare const PreTransferCheckRequest: v.SchemaWithPipe<readonly [v.
|
|
488
|
+
export declare const PreTransferCheckRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
489
489
|
/** Type of request. */
|
|
490
490
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"preTransferCheck", undefined>, v.DescriptionAction<"preTransferCheck", "Type of request.">]>;
|
|
491
491
|
/** User address. */
|
|
@@ -503,7 +503,7 @@ export type PreTransferCheckRequest = v.InferOutput<typeof PreTransferCheckReque
|
|
|
503
503
|
* @returns {Referral}
|
|
504
504
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
|
|
505
505
|
*/
|
|
506
|
-
export declare const ReferralRequest: v.SchemaWithPipe<readonly [v.
|
|
506
|
+
export declare const ReferralRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
507
507
|
/** Type of request. */
|
|
508
508
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"referral", undefined>, v.DescriptionAction<"referral", "Type of request.">]>;
|
|
509
509
|
/** User address. */
|
|
@@ -518,7 +518,7 @@ export type ReferralRequest = v.InferOutput<typeof ReferralRequest>;
|
|
|
518
518
|
* @returns {SpotClearinghouseState}
|
|
519
519
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
|
|
520
520
|
*/
|
|
521
|
-
export declare const SpotClearinghouseStateRequest: v.SchemaWithPipe<readonly [v.
|
|
521
|
+
export declare const SpotClearinghouseStateRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
522
522
|
/** Type of request. */
|
|
523
523
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotClearinghouseState", undefined>, v.DescriptionAction<"spotClearinghouseState", "Type of request.">]>;
|
|
524
524
|
/** User address. */
|
|
@@ -536,7 +536,7 @@ export type SpotClearinghouseStateRequest = v.InferOutput<typeof SpotClearinghou
|
|
|
536
536
|
* @returns {SpotDeployState}
|
|
537
537
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
|
|
538
538
|
*/
|
|
539
|
-
export declare const SpotDeployStateRequest: v.SchemaWithPipe<readonly [v.
|
|
539
|
+
export declare const SpotDeployStateRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
540
540
|
/** Type of request. */
|
|
541
541
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotDeployState", undefined>, v.DescriptionAction<"spotDeployState", "Type of request.">]>;
|
|
542
542
|
/** User address. */
|
|
@@ -551,7 +551,7 @@ export type SpotDeployStateRequest = v.InferOutput<typeof SpotDeployStateRequest
|
|
|
551
551
|
* @returns {SpotMeta}
|
|
552
552
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
|
|
553
553
|
*/
|
|
554
|
-
export declare const SpotMetaRequest: v.SchemaWithPipe<readonly [v.
|
|
554
|
+
export declare const SpotMetaRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
555
555
|
/** Type of request. */
|
|
556
556
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotMeta", undefined>, v.DescriptionAction<"spotMeta", "Type of request.">]>;
|
|
557
557
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -563,7 +563,7 @@ export type SpotMetaRequest = v.InferOutput<typeof SpotMetaRequest>;
|
|
|
563
563
|
* @returns {SpotMetaAndAssetCtxs}
|
|
564
564
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
|
|
565
565
|
*/
|
|
566
|
-
export declare const SpotMetaAndAssetCtxsRequest: v.SchemaWithPipe<readonly [v.
|
|
566
|
+
export declare const SpotMetaAndAssetCtxsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
567
567
|
/** Type of request. */
|
|
568
568
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotMetaAndAssetCtxs", undefined>, v.DescriptionAction<"spotMetaAndAssetCtxs", "Type of request.">]>;
|
|
569
569
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -575,7 +575,7 @@ export type SpotMetaAndAssetCtxsRequest = v.InferOutput<typeof SpotMetaAndAssetC
|
|
|
575
575
|
* @returns {DeployAuctionStatus}
|
|
576
576
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-pair-deploy-auction
|
|
577
577
|
*/
|
|
578
|
-
export declare const SpotPairDeployAuctionStatusRequest: v.SchemaWithPipe<readonly [v.
|
|
578
|
+
export declare const SpotPairDeployAuctionStatusRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
579
579
|
/** Type of request. */
|
|
580
580
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotPairDeployAuctionStatus", undefined>, v.DescriptionAction<"spotPairDeployAuctionStatus", "Type of request.">]>;
|
|
581
581
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -587,7 +587,7 @@ export type SpotPairDeployAuctionStatusRequest = v.InferOutput<typeof SpotPairDe
|
|
|
587
587
|
* @returns {SubAccount[] | null}
|
|
588
588
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
|
|
589
589
|
*/
|
|
590
|
-
export declare const SubAccountsRequest: v.SchemaWithPipe<readonly [v.
|
|
590
|
+
export declare const SubAccountsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
591
591
|
/** Type of request. */
|
|
592
592
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"subAccounts", undefined>, v.DescriptionAction<"subAccounts", "Type of request.">]>;
|
|
593
593
|
/** User address. */
|
|
@@ -602,7 +602,7 @@ export type SubAccountsRequest = v.InferOutput<typeof SubAccountsRequest>;
|
|
|
602
602
|
* @returns {TokenDetails}
|
|
603
603
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
|
|
604
604
|
*/
|
|
605
|
-
export declare const TokenDetailsRequest: v.SchemaWithPipe<readonly [v.
|
|
605
|
+
export declare const TokenDetailsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
606
606
|
/** Type of request. */
|
|
607
607
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"tokenDetails", undefined>, v.DescriptionAction<"tokenDetails", "Type of request.">]>;
|
|
608
608
|
/** Token ID. */
|
|
@@ -617,7 +617,7 @@ export type TokenDetailsRequest = v.InferOutput<typeof TokenDetailsRequest>;
|
|
|
617
617
|
* @returns {TwapHistory[]}
|
|
618
618
|
* @see null
|
|
619
619
|
*/
|
|
620
|
-
export declare const TwapHistoryRequest: v.SchemaWithPipe<readonly [v.
|
|
620
|
+
export declare const TwapHistoryRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
621
621
|
/** Type of request. */
|
|
622
622
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"twapHistory", undefined>, v.DescriptionAction<"twapHistory", "Type of request.">]>;
|
|
623
623
|
/** User address. */
|
|
@@ -632,7 +632,7 @@ export type TwapHistoryRequest = v.InferOutput<typeof TwapHistoryRequest>;
|
|
|
632
632
|
* @returns {UserFees}
|
|
633
633
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
|
|
634
634
|
*/
|
|
635
|
-
export declare const UserFeesRequest: v.SchemaWithPipe<readonly [v.
|
|
635
|
+
export declare const UserFeesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
636
636
|
/** Type of request. */
|
|
637
637
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFees", undefined>, v.DescriptionAction<"userFees", "Type of request.">]>;
|
|
638
638
|
/** User address. */
|
|
@@ -647,7 +647,7 @@ export type UserFeesRequest = v.InferOutput<typeof UserFeesRequest>;
|
|
|
647
647
|
* @returns {Fill[]}
|
|
648
648
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
|
|
649
649
|
*/
|
|
650
|
-
export declare const UserFillsRequest: v.SchemaWithPipe<readonly [v.
|
|
650
|
+
export declare const UserFillsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
651
651
|
/** Type of request. */
|
|
652
652
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFills", undefined>, v.DescriptionAction<"userFills", "Type of request.">]>;
|
|
653
653
|
/** User address. */
|
|
@@ -665,22 +665,22 @@ export type UserFillsRequest = v.InferOutput<typeof UserFillsRequest>;
|
|
|
665
665
|
* @returns {Fill[]}
|
|
666
666
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
|
|
667
667
|
*/
|
|
668
|
-
export declare const UserFillsByTimeRequest: v.SchemaWithPipe<readonly [v.
|
|
668
|
+
export declare const UserFillsByTimeRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
669
669
|
/** Type of request. */
|
|
670
670
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFillsByTime", undefined>, v.DescriptionAction<"userFillsByTime", "Type of request.">]>;
|
|
671
671
|
/** User address. */
|
|
672
672
|
readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
|
|
673
673
|
/** Start time (in ms since epoch). */
|
|
674
|
-
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.
|
|
674
|
+
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, v.DescriptionAction<string | number, "Start time (in ms since epoch).">]>;
|
|
675
675
|
/** End time (in ms since epoch). */
|
|
676
|
-
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.
|
|
676
|
+
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, undefined>, v.DescriptionAction<string | number | null | undefined, "End time (in ms since epoch).">]>;
|
|
677
677
|
/** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
|
|
678
678
|
readonly aggregateByTime: v.SchemaWithPipe<readonly [v.OptionalSchema<v.BooleanSchema<undefined>, undefined>, v.DescriptionAction<boolean | undefined, "If true, partial fills are aggregated when a crossing order fills multiple resting orders.">]>;
|
|
679
679
|
}, undefined>, v.DescriptionAction<{
|
|
680
680
|
type: "userFillsByTime";
|
|
681
681
|
user: `0x${string}`;
|
|
682
|
-
startTime: number;
|
|
683
|
-
endTime?: number | null | undefined;
|
|
682
|
+
startTime: string | number;
|
|
683
|
+
endTime?: string | number | null | undefined;
|
|
684
684
|
aggregateByTime?: boolean | undefined;
|
|
685
685
|
}, "Request user fills by time.">]>;
|
|
686
686
|
export type UserFillsByTimeRequest = v.InferOutput<typeof UserFillsByTimeRequest>;
|
|
@@ -689,20 +689,20 @@ export type UserFillsByTimeRequest = v.InferOutput<typeof UserFillsByTimeRequest
|
|
|
689
689
|
* @returns {UserFundingUpdate[]}
|
|
690
690
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
|
|
691
691
|
*/
|
|
692
|
-
export declare const UserFundingRequest: v.SchemaWithPipe<readonly [v.
|
|
692
|
+
export declare const UserFundingRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
693
693
|
/** Type of request. */
|
|
694
694
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFunding", undefined>, v.DescriptionAction<"userFunding", "Type of request.">]>;
|
|
695
695
|
/** User address. */
|
|
696
696
|
readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
|
|
697
697
|
/** Start time (in ms since epoch). */
|
|
698
|
-
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.
|
|
698
|
+
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, v.DescriptionAction<string | number, "Start time (in ms since epoch).">]>;
|
|
699
699
|
/** End time (in ms since epoch). */
|
|
700
|
-
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.
|
|
700
|
+
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, undefined>, v.DescriptionAction<string | number | null | undefined, "End time (in ms since epoch).">]>;
|
|
701
701
|
}, undefined>, v.DescriptionAction<{
|
|
702
702
|
type: "userFunding";
|
|
703
703
|
user: `0x${string}`;
|
|
704
|
-
startTime: number;
|
|
705
|
-
endTime?: number | null | undefined;
|
|
704
|
+
startTime: string | number;
|
|
705
|
+
endTime?: string | number | null | undefined;
|
|
706
706
|
}, "Request user funding.">]>;
|
|
707
707
|
export type UserFundingRequest = v.InferOutput<typeof UserFundingRequest>;
|
|
708
708
|
/**
|
|
@@ -710,20 +710,20 @@ export type UserFundingRequest = v.InferOutput<typeof UserFundingRequest>;
|
|
|
710
710
|
* @returns {UserNonFundingLedgerUpdate[]}
|
|
711
711
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
|
|
712
712
|
*/
|
|
713
|
-
export declare const UserNonFundingLedgerUpdatesRequest: v.SchemaWithPipe<readonly [v.
|
|
713
|
+
export declare const UserNonFundingLedgerUpdatesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
714
714
|
/** Type of request. */
|
|
715
715
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userNonFundingLedgerUpdates", undefined>, v.DescriptionAction<"userNonFundingLedgerUpdates", "Type of request.">]>;
|
|
716
716
|
/** User address. */
|
|
717
717
|
readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
|
|
718
718
|
/** Start time (in ms since epoch). */
|
|
719
|
-
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.
|
|
719
|
+
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, v.DescriptionAction<string | number, "Start time (in ms since epoch).">]>;
|
|
720
720
|
/** End time (in ms since epoch). */
|
|
721
|
-
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.
|
|
721
|
+
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, undefined>, v.DescriptionAction<string | number | null | undefined, "End time (in ms since epoch).">]>;
|
|
722
722
|
}, undefined>, v.DescriptionAction<{
|
|
723
723
|
type: "userNonFundingLedgerUpdates";
|
|
724
724
|
user: `0x${string}`;
|
|
725
|
-
startTime: number;
|
|
726
|
-
endTime?: number | null | undefined;
|
|
725
|
+
startTime: string | number;
|
|
726
|
+
endTime?: string | number | null | undefined;
|
|
727
727
|
}, "Request user non-funding ledger updates.">]>;
|
|
728
728
|
export type UserNonFundingLedgerUpdatesRequest = v.InferOutput<typeof UserNonFundingLedgerUpdatesRequest>;
|
|
729
729
|
/**
|
|
@@ -731,7 +731,7 @@ export type UserNonFundingLedgerUpdatesRequest = v.InferOutput<typeof UserNonFun
|
|
|
731
731
|
* @returns {UserRateLimit}
|
|
732
732
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
|
|
733
733
|
*/
|
|
734
|
-
export declare const UserRateLimitRequest: v.SchemaWithPipe<readonly [v.
|
|
734
|
+
export declare const UserRateLimitRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
735
735
|
/** Type of request. */
|
|
736
736
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userRateLimit", undefined>, v.DescriptionAction<"userRateLimit", "Type of request.">]>;
|
|
737
737
|
/** User address. */
|
|
@@ -746,7 +746,7 @@ export type UserRateLimitRequest = v.InferOutput<typeof UserRateLimitRequest>;
|
|
|
746
746
|
* @returns {UserRole}
|
|
747
747
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
|
|
748
748
|
*/
|
|
749
|
-
export declare const UserRoleRequest: v.SchemaWithPipe<readonly [v.
|
|
749
|
+
export declare const UserRoleRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
750
750
|
/** Type of request. */
|
|
751
751
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userRole", undefined>, v.DescriptionAction<"userRole", "Type of request.">]>;
|
|
752
752
|
/** User address. */
|
|
@@ -761,7 +761,7 @@ export type UserRoleRequest = v.InferOutput<typeof UserRoleRequest>;
|
|
|
761
761
|
* @returns {MultiSigSigners | null}
|
|
762
762
|
* @see null
|
|
763
763
|
*/
|
|
764
|
-
export declare const UserToMultiSigSignersRequest: v.SchemaWithPipe<readonly [v.
|
|
764
|
+
export declare const UserToMultiSigSignersRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
765
765
|
/** Type of request. */
|
|
766
766
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userToMultiSigSigners", undefined>, v.DescriptionAction<"userToMultiSigSigners", "Type of request.">]>;
|
|
767
767
|
/** User address. */
|
|
@@ -776,7 +776,7 @@ export type UserToMultiSigSignersRequest = v.InferOutput<typeof UserToMultiSigSi
|
|
|
776
776
|
* @returns {TwapSliceFill[]}
|
|
777
777
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
|
|
778
778
|
*/
|
|
779
|
-
export declare const UserTwapSliceFillsRequest: v.SchemaWithPipe<readonly [v.
|
|
779
|
+
export declare const UserTwapSliceFillsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
780
780
|
/** Type of request. */
|
|
781
781
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userTwapSliceFills", undefined>, v.DescriptionAction<"userTwapSliceFills", "Type of request.">]>;
|
|
782
782
|
/** User address. */
|
|
@@ -791,22 +791,22 @@ export type UserTwapSliceFillsRequest = v.InferOutput<typeof UserTwapSliceFillsR
|
|
|
791
791
|
* @returns {TwapSliceFill[]}
|
|
792
792
|
* @see null
|
|
793
793
|
*/
|
|
794
|
-
export declare const UserTwapSliceFillsByTimeRequest: v.SchemaWithPipe<readonly [v.
|
|
794
|
+
export declare const UserTwapSliceFillsByTimeRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
795
795
|
/** Type of request. */
|
|
796
796
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userTwapSliceFillsByTime", undefined>, v.DescriptionAction<"userTwapSliceFillsByTime", "Type of request.">]>;
|
|
797
797
|
/** User address. */
|
|
798
798
|
readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
|
|
799
799
|
/** Start time (in ms since epoch). */
|
|
800
|
-
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.
|
|
800
|
+
readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, v.DescriptionAction<string | number, "Start time (in ms since epoch).">]>;
|
|
801
801
|
/** End time (in ms since epoch). */
|
|
802
|
-
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.
|
|
802
|
+
readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.UnknownSchema, v.TransformAction<unknown, unknown>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>]>, undefined>, v.DescriptionAction<string | number | null | undefined, "End time (in ms since epoch).">]>;
|
|
803
803
|
/** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
|
|
804
804
|
readonly aggregateByTime: v.SchemaWithPipe<readonly [v.OptionalSchema<v.BooleanSchema<undefined>, undefined>, v.DescriptionAction<boolean | undefined, "If true, partial fills are aggregated when a crossing order fills multiple resting orders.">]>;
|
|
805
805
|
}, undefined>, v.DescriptionAction<{
|
|
806
806
|
type: "userTwapSliceFillsByTime";
|
|
807
807
|
user: `0x${string}`;
|
|
808
|
-
startTime: number;
|
|
809
|
-
endTime?: number | null | undefined;
|
|
808
|
+
startTime: string | number;
|
|
809
|
+
endTime?: string | number | null | undefined;
|
|
810
810
|
aggregateByTime?: boolean | undefined;
|
|
811
811
|
}, "Request user TWAP slice fills by time.">]>;
|
|
812
812
|
export type UserTwapSliceFillsByTimeRequest = v.InferOutput<typeof UserTwapSliceFillsByTimeRequest>;
|
|
@@ -815,7 +815,7 @@ export type UserTwapSliceFillsByTimeRequest = v.InferOutput<typeof UserTwapSlice
|
|
|
815
815
|
* @returns {VaultEquity[]}
|
|
816
816
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
|
|
817
817
|
*/
|
|
818
|
-
export declare const UserVaultEquitiesRequest: v.SchemaWithPipe<readonly [v.
|
|
818
|
+
export declare const UserVaultEquitiesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
819
819
|
/** Type of request. */
|
|
820
820
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userVaultEquities", undefined>, v.DescriptionAction<"userVaultEquities", "Type of request.">]>;
|
|
821
821
|
/** User address. */
|
|
@@ -830,7 +830,7 @@ export type UserVaultEquitiesRequest = v.InferOutput<typeof UserVaultEquitiesReq
|
|
|
830
830
|
* @returns {unknown[]} FIXME: Define the return type
|
|
831
831
|
* @see null
|
|
832
832
|
*/
|
|
833
|
-
export declare const ValidatorL1VotesRequest: v.SchemaWithPipe<readonly [v.
|
|
833
|
+
export declare const ValidatorL1VotesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
834
834
|
/** Type of request. */
|
|
835
835
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"validatorL1Votes", undefined>, v.DescriptionAction<"validatorL1Votes", "Type of request.">]>;
|
|
836
836
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -842,7 +842,7 @@ export type ValidatorL1VotesRequest = v.InferOutput<typeof ValidatorL1VotesReque
|
|
|
842
842
|
* @returns {ValidatorSummary[]}
|
|
843
843
|
* @see null
|
|
844
844
|
*/
|
|
845
|
-
export declare const ValidatorSummariesRequest: v.SchemaWithPipe<readonly [v.
|
|
845
|
+
export declare const ValidatorSummariesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
846
846
|
/** Type of request. */
|
|
847
847
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"validatorSummaries", undefined>, v.DescriptionAction<"validatorSummaries", "Type of request.">]>;
|
|
848
848
|
}, undefined>, v.DescriptionAction<{
|
|
@@ -854,7 +854,7 @@ export type ValidatorSummariesRequest = v.InferOutput<typeof ValidatorSummariesR
|
|
|
854
854
|
* @returns {VaultDetails | null}
|
|
855
855
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
|
|
856
856
|
*/
|
|
857
|
-
export declare const VaultDetailsRequest: v.SchemaWithPipe<readonly [v.
|
|
857
|
+
export declare const VaultDetailsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
858
858
|
/** Type of request. */
|
|
859
859
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"vaultDetails", undefined>, v.DescriptionAction<"vaultDetails", "Type of request.">]>;
|
|
860
860
|
/** Vault address. */
|
|
@@ -872,11 +872,68 @@ export type VaultDetailsRequest = v.InferOutput<typeof VaultDetailsRequest>;
|
|
|
872
872
|
* @returns {VaultSummary[]}
|
|
873
873
|
* @see null
|
|
874
874
|
*/
|
|
875
|
-
export declare const VaultSummariesRequest: v.SchemaWithPipe<readonly [v.
|
|
875
|
+
export declare const VaultSummariesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
876
876
|
/** Type of request. */
|
|
877
877
|
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"vaultSummaries", undefined>, v.DescriptionAction<"vaultSummaries", "Type of request.">]>;
|
|
878
878
|
}, undefined>, v.DescriptionAction<{
|
|
879
879
|
type: "vaultSummaries";
|
|
880
880
|
}, "Request a list of vaults less than 2 hours old.">]>;
|
|
881
881
|
export type VaultSummariesRequest = v.InferOutput<typeof VaultSummariesRequest>;
|
|
882
|
+
/**
|
|
883
|
+
* Request gossip root IPs.
|
|
884
|
+
* @returns {GossipRootIps[]}
|
|
885
|
+
* @see null
|
|
886
|
+
*/
|
|
887
|
+
export declare const GossipRootIpsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
888
|
+
/** Type of request. */
|
|
889
|
+
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"gossipRootIps", undefined>, v.DescriptionAction<"gossipRootIps", "Type of request.">]>;
|
|
890
|
+
}, undefined>, v.DescriptionAction<{
|
|
891
|
+
type: "gossipRootIps";
|
|
892
|
+
}, "Request gossip root IPs.">]>;
|
|
893
|
+
export type GossipRootIpsRequest = v.InferOutput<typeof GossipRootIpsRequest>;
|
|
894
|
+
/**
|
|
895
|
+
* Request recent trades.
|
|
896
|
+
* @returns {Trade[]}
|
|
897
|
+
* @see null
|
|
898
|
+
*/
|
|
899
|
+
export declare const RecentTradesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
900
|
+
/** Type of request. */
|
|
901
|
+
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"recentTrades", undefined>, v.DescriptionAction<"recentTrades", "Type of request.">]>;
|
|
902
|
+
/** Asset symbol (e.g., BTC). */
|
|
903
|
+
readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
|
|
904
|
+
}, undefined>, v.DescriptionAction<{
|
|
905
|
+
type: "recentTrades";
|
|
906
|
+
coin: string;
|
|
907
|
+
}, "Request recent trades.">]>;
|
|
908
|
+
export type RecentTradesRequest = v.InferOutput<typeof RecentTradesRequest>;
|
|
909
|
+
/**
|
|
910
|
+
* Request builder deployed perpetual market limits.
|
|
911
|
+
* @returns {PerpDexLimits}
|
|
912
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
|
|
913
|
+
*/
|
|
914
|
+
export declare const PerpDexLimitsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
915
|
+
/** Type of request. */
|
|
916
|
+
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDexLimits", undefined>, v.DescriptionAction<"perpDexLimits", "Type of request.">]>;
|
|
917
|
+
/** DEX name (empty string for main dex). */
|
|
918
|
+
readonly dex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "DEX name (empty string for main dex).">]>;
|
|
919
|
+
}, undefined>, v.DescriptionAction<{
|
|
920
|
+
type: "perpDexLimits";
|
|
921
|
+
dex: string;
|
|
922
|
+
}, "Request perpetual DEX limits.">]>;
|
|
923
|
+
export type PerpDexLimitsRequest = v.InferOutput<typeof PerpDexLimitsRequest>;
|
|
924
|
+
/**
|
|
925
|
+
* Request comprehensive user and market data.
|
|
926
|
+
* @returns {WebData2}
|
|
927
|
+
* @see null
|
|
928
|
+
*/
|
|
929
|
+
export declare const WebData2Request: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
930
|
+
/** Type of request. */
|
|
931
|
+
readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"webData2", undefined>, v.DescriptionAction<"webData2", "Type of request.">]>;
|
|
932
|
+
/** User address. */
|
|
933
|
+
readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
|
|
934
|
+
}, undefined>, v.DescriptionAction<{
|
|
935
|
+
type: "webData2";
|
|
936
|
+
user: `0x${string}`;
|
|
937
|
+
}, "Request web data v2.">]>;
|
|
938
|
+
export type WebData2Request = v.InferOutput<typeof WebData2Request>;
|
|
882
939
|
//# sourceMappingURL=requests.d.ts.map
|