@nktkas/hyperliquid 0.25.0-beta.1 → 0.25.0-beta.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.
- package/README.md +46 -14
- package/esm/mod.js +1 -0
- package/esm/mod.js.map +1 -0
- package/esm/src/clients/exchange.d.ts +0 -7
- package/esm/src/clients/exchange.d.ts.map +1 -1
- package/esm/src/clients/exchange.js +4 -5
- package/esm/src/clients/exchange.js.map +1 -0
- package/esm/src/clients/info.d.ts +64 -2
- package/esm/src/clients/info.d.ts.map +1 -1
- package/esm/src/clients/info.js +77 -1
- package/esm/src/clients/info.js.map +1 -0
- package/esm/src/clients/multiSign.js +2 -1
- 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/errors.js +1 -0
- package/esm/src/errors.js.map +1 -0
- package/esm/src/schemas/_base.d.ts +6 -2
- package/esm/src/schemas/_base.d.ts.map +1 -1
- package/esm/src/schemas/_base.js +4 -1
- package/esm/src/schemas/_base.js.map +1 -0
- package/esm/src/schemas/exchange/requests.d.ts +284 -284
- package/esm/src/schemas/exchange/requests.js +260 -259
- package/esm/src/schemas/exchange/requests.js.map +1 -0
- package/esm/src/schemas/exchange/responses.d.ts +47 -47
- 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 +3 -3
- 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 +121 -121
- package/esm/src/schemas/info/accounts.js +110 -109
- package/esm/src/schemas/info/accounts.js.map +1 -0
- package/esm/src/schemas/info/assets.d.ts +68 -39
- 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 +25 -8
- 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 +56 -56
- 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 +98 -56
- package/esm/src/schemas/info/requests.d.ts.map +1 -1
- package/esm/src/schemas/info/requests.js +103 -71
- package/esm/src/schemas/info/requests.js.map +1 -0
- package/esm/src/schemas/info/validators.d.ts +44 -23
- 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 +40 -40
- 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 +1 -0
- package/esm/src/schemas/mod.d.ts.map +1 -1
- package/esm/src/schemas/mod.js +2 -0
- package/esm/src/schemas/mod.js.map +1 -0
- package/esm/src/schemas/subscriptions/requests.d.ts +21 -21
- package/esm/src/schemas/subscriptions/requests.js +22 -21
- package/esm/src/schemas/subscriptions/requests.js.map +1 -0
- package/esm/src/schemas/subscriptions/responses.d.ts +192 -192
- package/esm/src/schemas/subscriptions/responses.js +41 -40
- package/esm/src/schemas/subscriptions/responses.js.map +1 -0
- package/esm/src/signing/_signTypedData/ethers.js +1 -0
- package/esm/src/signing/_signTypedData/ethers.js.map +1 -0
- package/esm/src/signing/_signTypedData/mod.js +1 -0
- package/esm/src/signing/_signTypedData/mod.js.map +1 -0
- package/esm/src/signing/_signTypedData/private_key.js +1 -0
- package/esm/src/signing/_signTypedData/private_key.js.map +1 -0
- package/esm/src/signing/_signTypedData/viem.js +1 -0
- package/esm/src/signing/_signTypedData/viem.js.map +1 -0
- package/esm/src/signing/mod.js +1 -0
- package/esm/src/signing/mod.js.map +1 -0
- package/esm/src/transports/base.d.ts +2 -2
- package/esm/src/transports/base.d.ts.map +1 -1
- package/esm/src/transports/base.js +1 -0
- 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 +1 -1
- package/script/mod.js +1 -0
- package/script/mod.js.map +1 -0
- package/script/src/clients/exchange.d.ts +0 -7
- package/script/src/clients/exchange.d.ts.map +1 -1
- package/script/src/clients/exchange.js +4 -5
- package/script/src/clients/exchange.js.map +1 -0
- package/script/src/clients/info.d.ts +64 -2
- package/script/src/clients/info.d.ts.map +1 -1
- package/script/src/clients/info.js +76 -0
- package/script/src/clients/info.js.map +1 -0
- package/script/src/clients/multiSign.js +2 -1
- 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/errors.js +1 -0
- package/script/src/errors.js.map +1 -0
- package/script/src/schemas/_base.d.ts +6 -2
- package/script/src/schemas/_base.d.ts.map +1 -1
- package/script/src/schemas/_base.js +5 -2
- package/script/src/schemas/_base.js.map +1 -0
- package/script/src/schemas/exchange/requests.d.ts +284 -284
- package/script/src/schemas/exchange/requests.js +259 -258
- package/script/src/schemas/exchange/requests.js.map +1 -0
- package/script/src/schemas/exchange/responses.d.ts +47 -47
- 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 +3 -3
- 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 +121 -121
- package/script/src/schemas/info/accounts.js +109 -108
- package/script/src/schemas/info/accounts.js.map +1 -0
- package/script/src/schemas/info/assets.d.ts +68 -39
- 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 +25 -8
- 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 +56 -56
- 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 +98 -56
- package/script/src/schemas/info/requests.d.ts.map +1 -1
- package/script/src/schemas/info/requests.js +103 -71
- package/script/src/schemas/info/requests.js.map +1 -0
- package/script/src/schemas/info/validators.d.ts +44 -23
- 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 +40 -40
- 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 +1 -0
- package/script/src/schemas/mod.d.ts.map +1 -1
- package/script/src/schemas/mod.js +4 -1
- package/script/src/schemas/mod.js.map +1 -0
- package/script/src/schemas/subscriptions/requests.d.ts +21 -21
- package/script/src/schemas/subscriptions/requests.js +22 -21
- package/script/src/schemas/subscriptions/requests.js.map +1 -0
- package/script/src/schemas/subscriptions/responses.d.ts +192 -192
- package/script/src/schemas/subscriptions/responses.js +40 -39
- package/script/src/schemas/subscriptions/responses.js.map +1 -0
- package/script/src/signing/_signTypedData/ethers.js +1 -0
- package/script/src/signing/_signTypedData/ethers.js.map +1 -0
- package/script/src/signing/_signTypedData/mod.js +1 -0
- package/script/src/signing/_signTypedData/mod.js.map +1 -0
- package/script/src/signing/_signTypedData/private_key.js +1 -0
- package/script/src/signing/_signTypedData/private_key.js.map +1 -0
- package/script/src/signing/_signTypedData/viem.js +1 -0
- package/script/src/signing/_signTypedData/viem.js.map +1 -0
- package/script/src/signing/mod.js +1 -0
- package/script/src/signing/mod.js.map +1 -0
- package/script/src/transports/base.d.ts +2 -2
- package/script/src/transports/base.d.ts.map +1 -1
- package/script/src/transports/base.js +1 -0
- 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/mod.ts +28 -0
- package/src/src/clients/exchange.ts +2246 -0
- package/src/src/clients/info.ts +2076 -0
- package/src/src/clients/multiSign.ts +183 -0
- package/src/src/clients/subscription.ts +841 -0
- package/src/src/errors.ts +7 -0
- package/src/src/schemas/_base.ts +43 -0
- package/src/src/schemas/exchange/requests.ts +3057 -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 +1490 -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 +1369 -0
- package/src/src/schemas/info/validators.ts +299 -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 +504 -0
- package/src/src/schemas/subscriptions/responses.ts +576 -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 +229 -0
- package/src/src/signing/_signTypedData/viem.ts +55 -0
- package/src/src/signing/mod.ts +572 -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
|
@@ -34,7 +34,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
34
34
|
})();
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
36
|
exports.UserTwapSliceFillsByTimeRequest = exports.UserTwapSliceFillsRequest = exports.UserToMultiSigSignersRequest = exports.UserRoleRequest = exports.UserRateLimitRequest = exports.UserNonFundingLedgerUpdatesRequest = exports.UserFundingRequest = exports.UserFillsByTimeRequest = exports.UserFillsRequest = exports.UserFeesRequest = exports.TwapHistoryRequest = exports.TokenDetailsRequest = exports.SubAccountsRequest = exports.SpotPairDeployAuctionStatusRequest = exports.SpotMetaAndAssetCtxsRequest = exports.SpotMetaRequest = exports.SpotDeployStateRequest = exports.SpotClearinghouseStateRequest = exports.ReferralRequest = exports.PreTransferCheckRequest = exports.PredictedFundingsRequest = exports.PortfolioRequest = exports.PerpsAtOpenInterestCapRequest = exports.PerpDexsRequest = exports.PerpDeployAuctionStatusRequest = exports.OrderStatusRequest = exports.OpenOrdersRequest = exports.MetaAndAssetCtxsRequest = exports.MetaRequest = exports.MaxMarketOrderNtlsRequest = exports.MaxBuilderFeeRequest = exports.MarginTableRequest = exports.LiquidatableRequest = exports.LegalCheckRequest = exports.LeadingVaultsRequest = exports.L2BookRequest = exports.IsVipRequest = exports.HistoricalOrdersRequest = exports.FundingHistoryRequest = exports.FrontendOpenOrdersRequest = exports.ExtraAgentsRequest = exports.ExchangeStatusRequest = exports.DelegatorSummaryRequest = exports.DelegatorRewardsRequest = exports.DelegatorHistoryRequest = exports.DelegationsRequest = exports.ClearinghouseStateRequest = exports.CandleSnapshotRequest = exports.AllMidsRequest = exports.ActiveAssetDataRequest = void 0;
|
|
37
|
-
exports.VaultSummariesRequest = exports.VaultDetailsRequest = exports.ValidatorSummariesRequest = exports.ValidatorL1VotesRequest = exports.UserVaultEquitiesRequest = void 0;
|
|
37
|
+
exports.PerpDexLimitsRequest = exports.RecentTradesRequest = exports.GossipRootIpsRequest = exports.VaultSummariesRequest = exports.VaultDetailsRequest = exports.ValidatorSummariesRequest = exports.ValidatorL1VotesRequest = exports.UserVaultEquitiesRequest = void 0;
|
|
38
38
|
const v = __importStar(require("valibot"));
|
|
39
39
|
const _base_js_1 = require("../_base.js");
|
|
40
40
|
/**
|
|
@@ -42,7 +42,7 @@ const _base_js_1 = require("../_base.js");
|
|
|
42
42
|
* @returns {ActiveAssetData}
|
|
43
43
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-active-asset-data
|
|
44
44
|
*/
|
|
45
|
-
exports.ActiveAssetDataRequest = v.pipe(v.
|
|
45
|
+
exports.ActiveAssetDataRequest = v.pipe(v.object({
|
|
46
46
|
/** Type of request. */
|
|
47
47
|
type: v.pipe(v.literal("activeAssetData"), v.description("Type of request.")),
|
|
48
48
|
/** Asset symbol (e.g., BTC). */
|
|
@@ -55,7 +55,7 @@ exports.ActiveAssetDataRequest = v.pipe(v.strictObject({
|
|
|
55
55
|
* @returns {AllMids}
|
|
56
56
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
|
|
57
57
|
*/
|
|
58
|
-
exports.AllMidsRequest = v.pipe(v.
|
|
58
|
+
exports.AllMidsRequest = v.pipe(v.object({
|
|
59
59
|
/** Type of request. */
|
|
60
60
|
type: v.pipe(v.literal("allMids"), v.description("Type of request.")),
|
|
61
61
|
/** DEX name (empty string for main dex). */
|
|
@@ -66,11 +66,11 @@ exports.AllMidsRequest = v.pipe(v.strictObject({
|
|
|
66
66
|
* @returns {Candle[]}
|
|
67
67
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
|
|
68
68
|
*/
|
|
69
|
-
exports.CandleSnapshotRequest = v.pipe(v.
|
|
69
|
+
exports.CandleSnapshotRequest = v.pipe(v.object({
|
|
70
70
|
/** Type of request. */
|
|
71
71
|
type: v.pipe(v.literal("candleSnapshot"), v.description("Type of request.")),
|
|
72
72
|
/** Request parameters. */
|
|
73
|
-
req: v.pipe(v.
|
|
73
|
+
req: v.pipe(v.object({
|
|
74
74
|
/** Asset symbol (e.g., BTC). */
|
|
75
75
|
coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
|
|
76
76
|
/** Time interval. */
|
|
@@ -91,9 +91,9 @@ exports.CandleSnapshotRequest = v.pipe(v.strictObject({
|
|
|
91
91
|
v.literal("1M"),
|
|
92
92
|
]), v.description("Time interval.")),
|
|
93
93
|
/** Start time (in ms since epoch). */
|
|
94
|
-
startTime: v.pipe(
|
|
94
|
+
startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
|
|
95
95
|
/** End time (in ms since epoch). */
|
|
96
|
-
endTime: v.pipe(v.nullish(
|
|
96
|
+
endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
|
|
97
97
|
}), v.description("Request parameters.")),
|
|
98
98
|
}), v.description("Request candlestick snapshots."));
|
|
99
99
|
/**
|
|
@@ -101,7 +101,7 @@ exports.CandleSnapshotRequest = v.pipe(v.strictObject({
|
|
|
101
101
|
* @returns {PerpsClearinghouseState}
|
|
102
102
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
|
|
103
103
|
*/
|
|
104
|
-
exports.ClearinghouseStateRequest = v.pipe(v.
|
|
104
|
+
exports.ClearinghouseStateRequest = v.pipe(v.object({
|
|
105
105
|
/** Type of request. */
|
|
106
106
|
type: v.pipe(v.literal("clearinghouseState"), v.description("Type of request.")),
|
|
107
107
|
/** User address. */
|
|
@@ -114,7 +114,7 @@ exports.ClearinghouseStateRequest = v.pipe(v.strictObject({
|
|
|
114
114
|
* @returns {Delegation[]}
|
|
115
115
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
|
|
116
116
|
*/
|
|
117
|
-
exports.DelegationsRequest = v.pipe(v.
|
|
117
|
+
exports.DelegationsRequest = v.pipe(v.object({
|
|
118
118
|
/** Type of request. */
|
|
119
119
|
type: v.pipe(v.literal("delegations"), v.description("Type of request.")),
|
|
120
120
|
/** User address. */
|
|
@@ -125,7 +125,7 @@ exports.DelegationsRequest = v.pipe(v.strictObject({
|
|
|
125
125
|
* @returns {DelegatorUpdate[]}
|
|
126
126
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
|
|
127
127
|
*/
|
|
128
|
-
exports.DelegatorHistoryRequest = v.pipe(v.
|
|
128
|
+
exports.DelegatorHistoryRequest = v.pipe(v.object({
|
|
129
129
|
/** Type of request. */
|
|
130
130
|
type: v.pipe(v.literal("delegatorHistory"), v.description("Type of request.")),
|
|
131
131
|
/** User address. */
|
|
@@ -136,7 +136,7 @@ exports.DelegatorHistoryRequest = v.pipe(v.strictObject({
|
|
|
136
136
|
* @returns {DelegatorReward[]}
|
|
137
137
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-rewards
|
|
138
138
|
*/
|
|
139
|
-
exports.DelegatorRewardsRequest = v.pipe(v.
|
|
139
|
+
exports.DelegatorRewardsRequest = v.pipe(v.object({
|
|
140
140
|
/** Type of request. */
|
|
141
141
|
type: v.pipe(v.literal("delegatorRewards"), v.description("Type of request.")),
|
|
142
142
|
/** User address. */
|
|
@@ -147,7 +147,7 @@ exports.DelegatorRewardsRequest = v.pipe(v.strictObject({
|
|
|
147
147
|
* @returns {DelegatorSummary}
|
|
148
148
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
|
|
149
149
|
*/
|
|
150
|
-
exports.DelegatorSummaryRequest = v.pipe(v.
|
|
150
|
+
exports.DelegatorSummaryRequest = v.pipe(v.object({
|
|
151
151
|
/** Type of request. */
|
|
152
152
|
type: v.pipe(v.literal("delegatorSummary"), v.description("Type of request.")),
|
|
153
153
|
/** User address. */
|
|
@@ -158,7 +158,7 @@ exports.DelegatorSummaryRequest = v.pipe(v.strictObject({
|
|
|
158
158
|
* @returns {ExchangeStatus}
|
|
159
159
|
* @see null
|
|
160
160
|
*/
|
|
161
|
-
exports.ExchangeStatusRequest = v.pipe(v.
|
|
161
|
+
exports.ExchangeStatusRequest = v.pipe(v.object({
|
|
162
162
|
/** Type of request. */
|
|
163
163
|
type: v.pipe(v.literal("exchangeStatus"), v.description("Type of request.")),
|
|
164
164
|
}), v.description("Request exchange status information."));
|
|
@@ -167,7 +167,7 @@ exports.ExchangeStatusRequest = v.pipe(v.strictObject({
|
|
|
167
167
|
* @returns {ExtraAgent[]}
|
|
168
168
|
* @see null
|
|
169
169
|
*/
|
|
170
|
-
exports.ExtraAgentsRequest = v.pipe(v.
|
|
170
|
+
exports.ExtraAgentsRequest = v.pipe(v.object({
|
|
171
171
|
/** Type of request. */
|
|
172
172
|
type: v.pipe(v.literal("extraAgents"), v.description("Type of request.")),
|
|
173
173
|
/** User address. */
|
|
@@ -178,7 +178,7 @@ exports.ExtraAgentsRequest = v.pipe(v.strictObject({
|
|
|
178
178
|
* @returns {FrontendOrder[]}
|
|
179
179
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
|
|
180
180
|
*/
|
|
181
|
-
exports.FrontendOpenOrdersRequest = v.pipe(v.
|
|
181
|
+
exports.FrontendOpenOrdersRequest = v.pipe(v.object({
|
|
182
182
|
/** Type of request. */
|
|
183
183
|
type: v.pipe(v.literal("frontendOpenOrders"), v.description("Type of request.")),
|
|
184
184
|
/** User address. */
|
|
@@ -191,22 +191,22 @@ exports.FrontendOpenOrdersRequest = v.pipe(v.strictObject({
|
|
|
191
191
|
* @returns {FundingHistory[]}
|
|
192
192
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
|
|
193
193
|
*/
|
|
194
|
-
exports.FundingHistoryRequest = v.pipe(v.
|
|
194
|
+
exports.FundingHistoryRequest = v.pipe(v.object({
|
|
195
195
|
/** Type of request. */
|
|
196
196
|
type: v.pipe(v.literal("fundingHistory"), v.description("Type of request.")),
|
|
197
197
|
/** Asset symbol (e.g., BTC). */
|
|
198
198
|
coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
|
|
199
199
|
/** Start time (in ms since epoch). */
|
|
200
|
-
startTime: v.pipe(
|
|
200
|
+
startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
|
|
201
201
|
/** End time (in ms since epoch). */
|
|
202
|
-
endTime: v.pipe(v.nullish(
|
|
202
|
+
endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
|
|
203
203
|
}), v.description("Request funding history."));
|
|
204
204
|
/**
|
|
205
205
|
* Request user historical orders.
|
|
206
206
|
* @returns {FrontendOrderStatus[]}
|
|
207
207
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
|
|
208
208
|
*/
|
|
209
|
-
exports.HistoricalOrdersRequest = v.pipe(v.
|
|
209
|
+
exports.HistoricalOrdersRequest = v.pipe(v.object({
|
|
210
210
|
/** Type of request. */
|
|
211
211
|
type: v.pipe(v.literal("historicalOrders"), v.description("Type of request.")),
|
|
212
212
|
/** User address. */
|
|
@@ -217,7 +217,7 @@ exports.HistoricalOrdersRequest = v.pipe(v.strictObject({
|
|
|
217
217
|
* @returns {boolean | null}
|
|
218
218
|
* @see null
|
|
219
219
|
*/
|
|
220
|
-
exports.IsVipRequest = v.pipe(v.
|
|
220
|
+
exports.IsVipRequest = v.pipe(v.object({
|
|
221
221
|
/** Type of request. */
|
|
222
222
|
type: v.pipe(v.literal("isVip"), v.description("Type of request.")),
|
|
223
223
|
/** User address. */
|
|
@@ -228,7 +228,7 @@ exports.IsVipRequest = v.pipe(v.strictObject({
|
|
|
228
228
|
* @returns {Book}
|
|
229
229
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
|
|
230
230
|
*/
|
|
231
|
-
exports.L2BookRequest = v.pipe(v.
|
|
231
|
+
exports.L2BookRequest = v.pipe(v.object({
|
|
232
232
|
/** Type of request. */
|
|
233
233
|
type: v.pipe(v.literal("l2Book"), v.description("Type of request.")),
|
|
234
234
|
/** Asset symbol (e.g., BTC). */
|
|
@@ -243,7 +243,7 @@ exports.L2BookRequest = v.pipe(v.strictObject({
|
|
|
243
243
|
* @returns {VaultLeading[]}
|
|
244
244
|
* @see null
|
|
245
245
|
*/
|
|
246
|
-
exports.LeadingVaultsRequest = v.pipe(v.
|
|
246
|
+
exports.LeadingVaultsRequest = v.pipe(v.object({
|
|
247
247
|
/** Type of request. */
|
|
248
248
|
type: v.pipe(v.literal("leadingVaults"), v.description("Type of request.")),
|
|
249
249
|
/** User address. */
|
|
@@ -254,7 +254,7 @@ exports.LeadingVaultsRequest = v.pipe(v.strictObject({
|
|
|
254
254
|
* @returns {LegalCheck}
|
|
255
255
|
* @see null
|
|
256
256
|
*/
|
|
257
|
-
exports.LegalCheckRequest = v.pipe(v.
|
|
257
|
+
exports.LegalCheckRequest = v.pipe(v.object({
|
|
258
258
|
/** Type of request. */
|
|
259
259
|
type: v.pipe(v.literal("legalCheck"), v.description("Type of request.")),
|
|
260
260
|
/** User address. */
|
|
@@ -265,7 +265,7 @@ exports.LegalCheckRequest = v.pipe(v.strictObject({
|
|
|
265
265
|
* @returns {unknown[]} FIXME: Define the return type
|
|
266
266
|
* @see null
|
|
267
267
|
*/
|
|
268
|
-
exports.LiquidatableRequest = v.pipe(v.
|
|
268
|
+
exports.LiquidatableRequest = v.pipe(v.object({
|
|
269
269
|
/** Type of request. */
|
|
270
270
|
type: v.pipe(v.literal("liquidatable"), v.description("Type of request.")),
|
|
271
271
|
}), v.description("Request liquidatable."));
|
|
@@ -274,18 +274,18 @@ exports.LiquidatableRequest = v.pipe(v.strictObject({
|
|
|
274
274
|
* @returns {MarginTable}
|
|
275
275
|
* @see null
|
|
276
276
|
*/
|
|
277
|
-
exports.MarginTableRequest = v.pipe(v.
|
|
277
|
+
exports.MarginTableRequest = v.pipe(v.object({
|
|
278
278
|
/** Type of request. */
|
|
279
279
|
type: v.pipe(v.literal("marginTable"), v.description("Type of request.")),
|
|
280
280
|
/** Margin requirements table. */
|
|
281
|
-
id: v.pipe(
|
|
281
|
+
id: v.pipe(_base_js_1.UnsignedInteger, v.description("Margin requirements table.")),
|
|
282
282
|
}), v.description("Request margin table data."));
|
|
283
283
|
/**
|
|
284
284
|
* Request builder fee approval.
|
|
285
285
|
* @returns {number}
|
|
286
286
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
|
|
287
287
|
*/
|
|
288
|
-
exports.MaxBuilderFeeRequest = v.pipe(v.
|
|
288
|
+
exports.MaxBuilderFeeRequest = v.pipe(v.object({
|
|
289
289
|
/** Type of request. */
|
|
290
290
|
type: v.pipe(v.literal("maxBuilderFee"), v.description("Type of request.")),
|
|
291
291
|
/** User address. */
|
|
@@ -298,7 +298,7 @@ exports.MaxBuilderFeeRequest = v.pipe(v.strictObject({
|
|
|
298
298
|
* @returns {[number, string][]}
|
|
299
299
|
* @see null
|
|
300
300
|
*/
|
|
301
|
-
exports.MaxMarketOrderNtlsRequest = v.pipe(v.
|
|
301
|
+
exports.MaxMarketOrderNtlsRequest = v.pipe(v.object({
|
|
302
302
|
/** Type of request. */
|
|
303
303
|
type: v.pipe(v.literal("maxMarketOrderNtls"), v.description("Type of request.")),
|
|
304
304
|
}), v.description("Request maximum market order notionals."));
|
|
@@ -307,7 +307,7 @@ exports.MaxMarketOrderNtlsRequest = v.pipe(v.strictObject({
|
|
|
307
307
|
* @returns {PerpsMeta}
|
|
308
308
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata-universe-and-margin-tables
|
|
309
309
|
*/
|
|
310
|
-
exports.MetaRequest = v.pipe(v.
|
|
310
|
+
exports.MetaRequest = v.pipe(v.object({
|
|
311
311
|
/** Type of request. */
|
|
312
312
|
type: v.pipe(v.literal("meta"), v.description("Type of request.")),
|
|
313
313
|
/** DEX name (empty string for main dex). */
|
|
@@ -318,7 +318,7 @@ exports.MetaRequest = v.pipe(v.strictObject({
|
|
|
318
318
|
* @returns {PerpsMetaAndAssetCtxs}
|
|
319
319
|
* @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
|
|
320
320
|
*/
|
|
321
|
-
exports.MetaAndAssetCtxsRequest = v.pipe(v.
|
|
321
|
+
exports.MetaAndAssetCtxsRequest = v.pipe(v.object({
|
|
322
322
|
/** Type of request. */
|
|
323
323
|
type: v.pipe(v.literal("metaAndAssetCtxs"), v.description("Type of request.")),
|
|
324
324
|
/** DEX name (empty string for main dex). */
|
|
@@ -329,7 +329,7 @@ exports.MetaAndAssetCtxsRequest = v.pipe(v.strictObject({
|
|
|
329
329
|
* @returns {Order[]}
|
|
330
330
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
|
|
331
331
|
*/
|
|
332
|
-
exports.OpenOrdersRequest = v.pipe(v.
|
|
332
|
+
exports.OpenOrdersRequest = v.pipe(v.object({
|
|
333
333
|
/** Type of request. */
|
|
334
334
|
type: v.pipe(v.literal("openOrders"), v.description("Type of request.")),
|
|
335
335
|
/** User address. */
|
|
@@ -342,20 +342,20 @@ exports.OpenOrdersRequest = v.pipe(v.strictObject({
|
|
|
342
342
|
* @returns {OrderLookup}
|
|
343
343
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
|
|
344
344
|
*/
|
|
345
|
-
exports.OrderStatusRequest = v.pipe(v.
|
|
345
|
+
exports.OrderStatusRequest = v.pipe(v.object({
|
|
346
346
|
/** Type of request. */
|
|
347
347
|
type: v.pipe(v.literal("orderStatus"), v.description("Type of request.")),
|
|
348
348
|
/** User address. */
|
|
349
349
|
user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
|
|
350
350
|
/** Order ID or Client Order ID. */
|
|
351
|
-
oid: v.pipe(v.union([
|
|
351
|
+
oid: v.pipe(v.union([_base_js_1.UnsignedInteger, v.pipe(_base_js_1.Hex, v.length(34))]), v.description("Order ID or Client Order ID.")),
|
|
352
352
|
}), v.description("Request order status."));
|
|
353
353
|
/**
|
|
354
354
|
* Request for the status of the perpetual deploy auction.
|
|
355
355
|
* @returns {DeployAuctionStatus}
|
|
356
356
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
|
|
357
357
|
*/
|
|
358
|
-
exports.PerpDeployAuctionStatusRequest = v.pipe(v.
|
|
358
|
+
exports.PerpDeployAuctionStatusRequest = v.pipe(v.object({
|
|
359
359
|
/** Type of request. */
|
|
360
360
|
type: v.pipe(v.literal("perpDeployAuctionStatus"), v.description("Type of request.")),
|
|
361
361
|
}), v.description("Request for the status of the perpetual deploy auction."));
|
|
@@ -364,7 +364,7 @@ exports.PerpDeployAuctionStatusRequest = v.pipe(v.strictObject({
|
|
|
364
364
|
* @returns {PerpDexs}
|
|
365
365
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
|
|
366
366
|
*/
|
|
367
|
-
exports.PerpDexsRequest = v.pipe(v.
|
|
367
|
+
exports.PerpDexsRequest = v.pipe(v.object({
|
|
368
368
|
/** Type of request. */
|
|
369
369
|
type: v.pipe(v.literal("perpDexs"), v.description("Type of request.")),
|
|
370
370
|
}), v.description("Request all perpetual dexs."));
|
|
@@ -373,7 +373,7 @@ exports.PerpDexsRequest = v.pipe(v.strictObject({
|
|
|
373
373
|
* @returns {string[]}
|
|
374
374
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
|
|
375
375
|
*/
|
|
376
|
-
exports.PerpsAtOpenInterestCapRequest = v.pipe(v.
|
|
376
|
+
exports.PerpsAtOpenInterestCapRequest = v.pipe(v.object({
|
|
377
377
|
/** Type of request. */
|
|
378
378
|
type: v.pipe(v.literal("perpsAtOpenInterestCap"), v.description("Type of request.")),
|
|
379
379
|
/** DEX name (empty string for main dex). */
|
|
@@ -384,7 +384,7 @@ exports.PerpsAtOpenInterestCapRequest = v.pipe(v.strictObject({
|
|
|
384
384
|
* @returns {PortfolioPeriods}
|
|
385
385
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
|
|
386
386
|
*/
|
|
387
|
-
exports.PortfolioRequest = v.pipe(v.
|
|
387
|
+
exports.PortfolioRequest = v.pipe(v.object({
|
|
388
388
|
/** Type of request. */
|
|
389
389
|
type: v.pipe(v.literal("portfolio"), v.description("Type of request.")),
|
|
390
390
|
/** User address. */
|
|
@@ -395,7 +395,7 @@ exports.PortfolioRequest = v.pipe(v.strictObject({
|
|
|
395
395
|
* @returns {PredictedFunding[]}
|
|
396
396
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
|
|
397
397
|
*/
|
|
398
|
-
exports.PredictedFundingsRequest = v.pipe(v.
|
|
398
|
+
exports.PredictedFundingsRequest = v.pipe(v.object({
|
|
399
399
|
/** Type of request. */
|
|
400
400
|
type: v.pipe(v.literal("predictedFundings"), v.description("Type of request.")),
|
|
401
401
|
}), v.description("Request predicted funding rates."));
|
|
@@ -404,7 +404,7 @@ exports.PredictedFundingsRequest = v.pipe(v.strictObject({
|
|
|
404
404
|
* @returns {PreTransferCheck}
|
|
405
405
|
* @see null
|
|
406
406
|
*/
|
|
407
|
-
exports.PreTransferCheckRequest = v.pipe(v.
|
|
407
|
+
exports.PreTransferCheckRequest = v.pipe(v.object({
|
|
408
408
|
/** Type of request. */
|
|
409
409
|
type: v.pipe(v.literal("preTransferCheck"), v.description("Type of request.")),
|
|
410
410
|
/** User address. */
|
|
@@ -417,7 +417,7 @@ exports.PreTransferCheckRequest = v.pipe(v.strictObject({
|
|
|
417
417
|
* @returns {Referral}
|
|
418
418
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
|
|
419
419
|
*/
|
|
420
|
-
exports.ReferralRequest = v.pipe(v.
|
|
420
|
+
exports.ReferralRequest = v.pipe(v.object({
|
|
421
421
|
/** Type of request. */
|
|
422
422
|
type: v.pipe(v.literal("referral"), v.description("Type of request.")),
|
|
423
423
|
/** User address. */
|
|
@@ -428,7 +428,7 @@ exports.ReferralRequest = v.pipe(v.strictObject({
|
|
|
428
428
|
* @returns {SpotClearinghouseState}
|
|
429
429
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
|
|
430
430
|
*/
|
|
431
|
-
exports.SpotClearinghouseStateRequest = v.pipe(v.
|
|
431
|
+
exports.SpotClearinghouseStateRequest = v.pipe(v.object({
|
|
432
432
|
/** Type of request. */
|
|
433
433
|
type: v.pipe(v.literal("spotClearinghouseState"), v.description("Type of request.")),
|
|
434
434
|
/** User address. */
|
|
@@ -441,7 +441,7 @@ exports.SpotClearinghouseStateRequest = v.pipe(v.strictObject({
|
|
|
441
441
|
* @returns {SpotDeployState}
|
|
442
442
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
|
|
443
443
|
*/
|
|
444
|
-
exports.SpotDeployStateRequest = v.pipe(v.
|
|
444
|
+
exports.SpotDeployStateRequest = v.pipe(v.object({
|
|
445
445
|
/** Type of request. */
|
|
446
446
|
type: v.pipe(v.literal("spotDeployState"), v.description("Type of request.")),
|
|
447
447
|
/** User address. */
|
|
@@ -452,7 +452,7 @@ exports.SpotDeployStateRequest = v.pipe(v.strictObject({
|
|
|
452
452
|
* @returns {SpotMeta}
|
|
453
453
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
|
|
454
454
|
*/
|
|
455
|
-
exports.SpotMetaRequest = v.pipe(v.
|
|
455
|
+
exports.SpotMetaRequest = v.pipe(v.object({
|
|
456
456
|
/** Type of request. */
|
|
457
457
|
type: v.pipe(v.literal("spotMeta"), v.description("Type of request.")),
|
|
458
458
|
}), v.description("Request spot trading metadata."));
|
|
@@ -461,7 +461,7 @@ exports.SpotMetaRequest = v.pipe(v.strictObject({
|
|
|
461
461
|
* @returns {SpotMetaAndAssetCtxs}
|
|
462
462
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
|
|
463
463
|
*/
|
|
464
|
-
exports.SpotMetaAndAssetCtxsRequest = v.pipe(v.
|
|
464
|
+
exports.SpotMetaAndAssetCtxsRequest = v.pipe(v.object({
|
|
465
465
|
/** Type of request. */
|
|
466
466
|
type: v.pipe(v.literal("spotMetaAndAssetCtxs"), v.description("Type of request.")),
|
|
467
467
|
}), v.description("Request spot metadata and asset contexts."));
|
|
@@ -470,7 +470,7 @@ exports.SpotMetaAndAssetCtxsRequest = v.pipe(v.strictObject({
|
|
|
470
470
|
* @returns {DeployAuctionStatus}
|
|
471
471
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-pair-deploy-auction
|
|
472
472
|
*/
|
|
473
|
-
exports.SpotPairDeployAuctionStatusRequest = v.pipe(v.
|
|
473
|
+
exports.SpotPairDeployAuctionStatusRequest = v.pipe(v.object({
|
|
474
474
|
/** Type of request. */
|
|
475
475
|
type: v.pipe(v.literal("spotPairDeployAuctionStatus"), v.description("Type of request.")),
|
|
476
476
|
}), v.description("Request for the status of the spot deploy auction."));
|
|
@@ -479,7 +479,7 @@ exports.SpotPairDeployAuctionStatusRequest = v.pipe(v.strictObject({
|
|
|
479
479
|
* @returns {SubAccount[] | null}
|
|
480
480
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
|
|
481
481
|
*/
|
|
482
|
-
exports.SubAccountsRequest = v.pipe(v.
|
|
482
|
+
exports.SubAccountsRequest = v.pipe(v.object({
|
|
483
483
|
/** Type of request. */
|
|
484
484
|
type: v.pipe(v.literal("subAccounts"), v.description("Type of request.")),
|
|
485
485
|
/** User address. */
|
|
@@ -490,7 +490,7 @@ exports.SubAccountsRequest = v.pipe(v.strictObject({
|
|
|
490
490
|
* @returns {TokenDetails}
|
|
491
491
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
|
|
492
492
|
*/
|
|
493
|
-
exports.TokenDetailsRequest = v.pipe(v.
|
|
493
|
+
exports.TokenDetailsRequest = v.pipe(v.object({
|
|
494
494
|
/** Type of request. */
|
|
495
495
|
type: v.pipe(v.literal("tokenDetails"), v.description("Type of request.")),
|
|
496
496
|
/** Token ID. */
|
|
@@ -501,7 +501,7 @@ exports.TokenDetailsRequest = v.pipe(v.strictObject({
|
|
|
501
501
|
* @returns {TwapHistory[]}
|
|
502
502
|
* @see null
|
|
503
503
|
*/
|
|
504
|
-
exports.TwapHistoryRequest = v.pipe(v.
|
|
504
|
+
exports.TwapHistoryRequest = v.pipe(v.object({
|
|
505
505
|
/** Type of request. */
|
|
506
506
|
type: v.pipe(v.literal("twapHistory"), v.description("Type of request.")),
|
|
507
507
|
/** User address. */
|
|
@@ -512,7 +512,7 @@ exports.TwapHistoryRequest = v.pipe(v.strictObject({
|
|
|
512
512
|
* @returns {UserFees}
|
|
513
513
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
|
|
514
514
|
*/
|
|
515
|
-
exports.UserFeesRequest = v.pipe(v.
|
|
515
|
+
exports.UserFeesRequest = v.pipe(v.object({
|
|
516
516
|
/** Type of request. */
|
|
517
517
|
type: v.pipe(v.literal("userFees"), v.description("Type of request.")),
|
|
518
518
|
/** User address. */
|
|
@@ -523,7 +523,7 @@ exports.UserFeesRequest = v.pipe(v.strictObject({
|
|
|
523
523
|
* @returns {Fill[]}
|
|
524
524
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
|
|
525
525
|
*/
|
|
526
|
-
exports.UserFillsRequest = v.pipe(v.
|
|
526
|
+
exports.UserFillsRequest = v.pipe(v.object({
|
|
527
527
|
/** Type of request. */
|
|
528
528
|
type: v.pipe(v.literal("userFills"), v.description("Type of request.")),
|
|
529
529
|
/** User address. */
|
|
@@ -536,15 +536,15 @@ exports.UserFillsRequest = v.pipe(v.strictObject({
|
|
|
536
536
|
* @returns {Fill[]}
|
|
537
537
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
|
|
538
538
|
*/
|
|
539
|
-
exports.UserFillsByTimeRequest = v.pipe(v.
|
|
539
|
+
exports.UserFillsByTimeRequest = v.pipe(v.object({
|
|
540
540
|
/** Type of request. */
|
|
541
541
|
type: v.pipe(v.literal("userFillsByTime"), v.description("Type of request.")),
|
|
542
542
|
/** User address. */
|
|
543
543
|
user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
|
|
544
544
|
/** Start time (in ms since epoch). */
|
|
545
|
-
startTime: v.pipe(
|
|
545
|
+
startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
|
|
546
546
|
/** End time (in ms since epoch). */
|
|
547
|
-
endTime: v.pipe(v.nullish(
|
|
547
|
+
endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
|
|
548
548
|
/** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
|
|
549
549
|
aggregateByTime: v.pipe(v.optional(v.boolean()), v.description("If true, partial fills are aggregated when a crossing order fills multiple resting orders.")),
|
|
550
550
|
}), v.description("Request user fills by time."));
|
|
@@ -553,37 +553,37 @@ exports.UserFillsByTimeRequest = v.pipe(v.strictObject({
|
|
|
553
553
|
* @returns {UserFundingUpdate[]}
|
|
554
554
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
|
|
555
555
|
*/
|
|
556
|
-
exports.UserFundingRequest = v.pipe(v.
|
|
556
|
+
exports.UserFundingRequest = v.pipe(v.object({
|
|
557
557
|
/** Type of request. */
|
|
558
558
|
type: v.pipe(v.literal("userFunding"), v.description("Type of request.")),
|
|
559
559
|
/** User address. */
|
|
560
560
|
user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
|
|
561
561
|
/** Start time (in ms since epoch). */
|
|
562
|
-
startTime: v.pipe(
|
|
562
|
+
startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
|
|
563
563
|
/** End time (in ms since epoch). */
|
|
564
|
-
endTime: v.pipe(v.nullish(
|
|
564
|
+
endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
|
|
565
565
|
}), v.description("Request user funding."));
|
|
566
566
|
/**
|
|
567
567
|
* Request user non-funding ledger updates.
|
|
568
568
|
* @returns {UserNonFundingLedgerUpdate[]}
|
|
569
569
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
|
|
570
570
|
*/
|
|
571
|
-
exports.UserNonFundingLedgerUpdatesRequest = v.pipe(v.
|
|
571
|
+
exports.UserNonFundingLedgerUpdatesRequest = v.pipe(v.object({
|
|
572
572
|
/** Type of request. */
|
|
573
573
|
type: v.pipe(v.literal("userNonFundingLedgerUpdates"), v.description("Type of request.")),
|
|
574
574
|
/** User address. */
|
|
575
575
|
user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
|
|
576
576
|
/** Start time (in ms since epoch). */
|
|
577
|
-
startTime: v.pipe(
|
|
577
|
+
startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
|
|
578
578
|
/** End time (in ms since epoch). */
|
|
579
|
-
endTime: v.pipe(v.nullish(
|
|
579
|
+
endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
|
|
580
580
|
}), v.description("Request user non-funding ledger updates."));
|
|
581
581
|
/**
|
|
582
582
|
* Request user rate limits.
|
|
583
583
|
* @returns {UserRateLimit}
|
|
584
584
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
|
|
585
585
|
*/
|
|
586
|
-
exports.UserRateLimitRequest = v.pipe(v.
|
|
586
|
+
exports.UserRateLimitRequest = v.pipe(v.object({
|
|
587
587
|
/** Type of request. */
|
|
588
588
|
type: v.pipe(v.literal("userRateLimit"), v.description("Type of request.")),
|
|
589
589
|
/** User address. */
|
|
@@ -594,7 +594,7 @@ exports.UserRateLimitRequest = v.pipe(v.strictObject({
|
|
|
594
594
|
* @returns {UserRole}
|
|
595
595
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
|
|
596
596
|
*/
|
|
597
|
-
exports.UserRoleRequest = v.pipe(v.
|
|
597
|
+
exports.UserRoleRequest = v.pipe(v.object({
|
|
598
598
|
/** Type of request. */
|
|
599
599
|
type: v.pipe(v.literal("userRole"), v.description("Type of request.")),
|
|
600
600
|
/** User address. */
|
|
@@ -605,7 +605,7 @@ exports.UserRoleRequest = v.pipe(v.strictObject({
|
|
|
605
605
|
* @returns {MultiSigSigners | null}
|
|
606
606
|
* @see null
|
|
607
607
|
*/
|
|
608
|
-
exports.UserToMultiSigSignersRequest = v.pipe(v.
|
|
608
|
+
exports.UserToMultiSigSignersRequest = v.pipe(v.object({
|
|
609
609
|
/** Type of request. */
|
|
610
610
|
type: v.pipe(v.literal("userToMultiSigSigners"), v.description("Type of request.")),
|
|
611
611
|
/** User address. */
|
|
@@ -616,7 +616,7 @@ exports.UserToMultiSigSignersRequest = v.pipe(v.strictObject({
|
|
|
616
616
|
* @returns {TwapSliceFill[]}
|
|
617
617
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
|
|
618
618
|
*/
|
|
619
|
-
exports.UserTwapSliceFillsRequest = v.pipe(v.
|
|
619
|
+
exports.UserTwapSliceFillsRequest = v.pipe(v.object({
|
|
620
620
|
/** Type of request. */
|
|
621
621
|
type: v.pipe(v.literal("userTwapSliceFills"), v.description("Type of request.")),
|
|
622
622
|
/** User address. */
|
|
@@ -627,15 +627,15 @@ exports.UserTwapSliceFillsRequest = v.pipe(v.strictObject({
|
|
|
627
627
|
* @returns {TwapSliceFill[]}
|
|
628
628
|
* @see null
|
|
629
629
|
*/
|
|
630
|
-
exports.UserTwapSliceFillsByTimeRequest = v.pipe(v.
|
|
630
|
+
exports.UserTwapSliceFillsByTimeRequest = v.pipe(v.object({
|
|
631
631
|
/** Type of request. */
|
|
632
632
|
type: v.pipe(v.literal("userTwapSliceFillsByTime"), v.description("Type of request.")),
|
|
633
633
|
/** User address. */
|
|
634
634
|
user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
|
|
635
635
|
/** Start time (in ms since epoch). */
|
|
636
|
-
startTime: v.pipe(
|
|
636
|
+
startTime: v.pipe(_base_js_1.UnsignedInteger, v.description("Start time (in ms since epoch).")),
|
|
637
637
|
/** End time (in ms since epoch). */
|
|
638
|
-
endTime: v.pipe(v.nullish(
|
|
638
|
+
endTime: v.pipe(v.nullish(_base_js_1.UnsignedInteger), v.description("End time (in ms since epoch).")),
|
|
639
639
|
/** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
|
|
640
640
|
aggregateByTime: v.pipe(v.optional(v.boolean()), v.description("If true, partial fills are aggregated when a crossing order fills multiple resting orders.")),
|
|
641
641
|
}), v.description("Request user TWAP slice fills by time."));
|
|
@@ -644,7 +644,7 @@ exports.UserTwapSliceFillsByTimeRequest = v.pipe(v.strictObject({
|
|
|
644
644
|
* @returns {VaultEquity[]}
|
|
645
645
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
|
|
646
646
|
*/
|
|
647
|
-
exports.UserVaultEquitiesRequest = v.pipe(v.
|
|
647
|
+
exports.UserVaultEquitiesRequest = v.pipe(v.object({
|
|
648
648
|
/** Type of request. */
|
|
649
649
|
type: v.pipe(v.literal("userVaultEquities"), v.description("Type of request.")),
|
|
650
650
|
/** User address. */
|
|
@@ -655,7 +655,7 @@ exports.UserVaultEquitiesRequest = v.pipe(v.strictObject({
|
|
|
655
655
|
* @returns {unknown[]} FIXME: Define the return type
|
|
656
656
|
* @see null
|
|
657
657
|
*/
|
|
658
|
-
exports.ValidatorL1VotesRequest = v.pipe(v.
|
|
658
|
+
exports.ValidatorL1VotesRequest = v.pipe(v.object({
|
|
659
659
|
/** Type of request. */
|
|
660
660
|
type: v.pipe(v.literal("validatorL1Votes"), v.description("Type of request.")),
|
|
661
661
|
}), v.description("Request validator L1 votes."));
|
|
@@ -664,7 +664,7 @@ exports.ValidatorL1VotesRequest = v.pipe(v.strictObject({
|
|
|
664
664
|
* @returns {ValidatorSummary[]}
|
|
665
665
|
* @see null
|
|
666
666
|
*/
|
|
667
|
-
exports.ValidatorSummariesRequest = v.pipe(v.
|
|
667
|
+
exports.ValidatorSummariesRequest = v.pipe(v.object({
|
|
668
668
|
/** Type of request. */
|
|
669
669
|
type: v.pipe(v.literal("validatorSummaries"), v.description("Type of request.")),
|
|
670
670
|
}), v.description("Request validator summaries."));
|
|
@@ -673,7 +673,7 @@ exports.ValidatorSummariesRequest = v.pipe(v.strictObject({
|
|
|
673
673
|
* @returns {VaultDetails | null}
|
|
674
674
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
|
|
675
675
|
*/
|
|
676
|
-
exports.VaultDetailsRequest = v.pipe(v.
|
|
676
|
+
exports.VaultDetailsRequest = v.pipe(v.object({
|
|
677
677
|
/** Type of request. */
|
|
678
678
|
type: v.pipe(v.literal("vaultDetails"), v.description("Type of request.")),
|
|
679
679
|
/** Vault address. */
|
|
@@ -686,7 +686,39 @@ exports.VaultDetailsRequest = v.pipe(v.strictObject({
|
|
|
686
686
|
* @returns {VaultSummary[]}
|
|
687
687
|
* @see null
|
|
688
688
|
*/
|
|
689
|
-
exports.VaultSummariesRequest = v.pipe(v.
|
|
689
|
+
exports.VaultSummariesRequest = v.pipe(v.object({
|
|
690
690
|
/** Type of request. */
|
|
691
691
|
type: v.pipe(v.literal("vaultSummaries"), v.description("Type of request.")),
|
|
692
692
|
}), v.description("Request a list of vaults less than 2 hours old."));
|
|
693
|
+
/**
|
|
694
|
+
* Request gossip root IPs.
|
|
695
|
+
* @returns {GossipRootIps[]}
|
|
696
|
+
* @see null
|
|
697
|
+
*/
|
|
698
|
+
exports.GossipRootIpsRequest = v.pipe(v.object({
|
|
699
|
+
/** Type of request. */
|
|
700
|
+
type: v.pipe(v.literal("gossipRootIps"), v.description("Type of request.")),
|
|
701
|
+
}), v.description("Request gossip root IPs."));
|
|
702
|
+
/**
|
|
703
|
+
* Request recent trades.
|
|
704
|
+
* @returns {Trade[]}
|
|
705
|
+
* @see null
|
|
706
|
+
*/
|
|
707
|
+
exports.RecentTradesRequest = v.pipe(v.object({
|
|
708
|
+
/** Type of request. */
|
|
709
|
+
type: v.pipe(v.literal("recentTrades"), v.description("Type of request.")),
|
|
710
|
+
/** Asset symbol (e.g., BTC). */
|
|
711
|
+
coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
|
|
712
|
+
}), v.description("Request recent trades."));
|
|
713
|
+
/**
|
|
714
|
+
* Request builder deployed perpetual market limits.
|
|
715
|
+
* @returns {PerpDexLimits}
|
|
716
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
|
|
717
|
+
*/
|
|
718
|
+
exports.PerpDexLimitsRequest = v.pipe(v.object({
|
|
719
|
+
/** Type of request. */
|
|
720
|
+
type: v.pipe(v.literal("perpDexLimits"), v.description("Type of request.")),
|
|
721
|
+
/** DEX name (empty string for main dex). */
|
|
722
|
+
dex: v.pipe(v.string(), v.description("DEX name (empty string for main dex).")),
|
|
723
|
+
}), v.description("Request perpetual DEX limits."));
|
|
724
|
+
//# sourceMappingURL=requests.js.map
|