@nktkas/hyperliquid 0.13.2 → 0.14.0
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 +302 -91
- package/esm/mod.d.ts +3 -12
- package/esm/mod.d.ts.map +1 -1
- package/esm/mod.js +2 -2
- package/esm/src/{transports/base.d.ts → base.d.ts} +10 -13
- package/esm/src/base.d.ts.map +1 -0
- package/esm/src/base.js +14 -0
- package/esm/src/clients/event.d.ts +4 -4
- package/esm/src/clients/event.d.ts.map +1 -1
- package/esm/src/clients/event.js +2 -2
- package/esm/src/clients/public.d.ts +109 -6
- package/esm/src/clients/public.d.ts.map +1 -1
- package/esm/src/clients/public.js +106 -3
- package/esm/src/clients/wallet.d.ts +232 -29
- package/esm/src/clients/wallet.d.ts.map +1 -1
- package/esm/src/clients/wallet.js +836 -220
- package/esm/src/signing.d.ts +135 -0
- package/esm/src/signing.d.ts.map +1 -0
- package/esm/src/signing.js +188 -0
- package/esm/src/transports/http/http_transport.d.ts +1 -1
- package/esm/src/transports/http/http_transport.d.ts.map +1 -1
- package/esm/src/transports/http/http_transport.js +1 -1
- package/{script/src/transports/websocket/hyperliquid_event_target.d.ts → esm/src/transports/websocket/_hyperliquid_event_target.d.ts} +7 -15
- package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -0
- package/esm/src/transports/websocket/{hyperliquid_event_target.js → _hyperliquid_event_target.js} +4 -22
- package/esm/src/transports/websocket/{reconnecting_websocket.d.ts → _reconnecting_websocket.d.ts} +26 -26
- package/esm/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -0
- package/esm/src/transports/websocket/{reconnecting_websocket.js → _reconnecting_websocket.js} +91 -76
- package/esm/src/transports/websocket/{websocket_request_dispatcher.d.ts → _websocket_request_dispatcher.d.ts} +3 -7
- package/esm/src/transports/websocket/_websocket_request_dispatcher.d.ts.map +1 -0
- package/esm/src/transports/websocket/{websocket_request_dispatcher.js → _websocket_request_dispatcher.js} +3 -7
- package/esm/src/transports/websocket/websocket_transport.d.ts +12 -15
- package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/esm/src/transports/websocket/websocket_transport.js +45 -48
- package/esm/src/types/exchange/requests.d.ts +172 -20
- package/esm/src/types/exchange/requests.d.ts.map +1 -1
- package/esm/src/types/exchange/responses.d.ts +32 -32
- package/esm/src/types/exchange/responses.d.ts.map +1 -1
- package/esm/src/types/explorer/requests.d.ts +12 -12
- package/esm/src/types/explorer/requests.d.ts.map +1 -1
- package/esm/src/types/explorer/responses.d.ts +36 -1
- package/esm/src/types/explorer/responses.d.ts.map +1 -1
- package/esm/src/types/info/accounts.d.ts +130 -105
- package/esm/src/types/info/accounts.d.ts.map +1 -1
- package/esm/src/types/info/assets.d.ts +154 -152
- package/esm/src/types/info/assets.d.ts.map +1 -1
- package/esm/src/types/info/delegations.d.ts +20 -20
- package/esm/src/types/info/delegations.d.ts.map +1 -1
- package/esm/src/types/info/orders.d.ts +55 -55
- package/esm/src/types/info/orders.d.ts.map +1 -1
- package/esm/src/types/info/requests.d.ts +73 -10
- package/esm/src/types/info/requests.d.ts.map +1 -1
- package/esm/src/types/info/vaults.d.ts +1 -1
- package/esm/src/types/info/vaults.d.ts.map +1 -1
- package/esm/src/types/mod.d.ts +14 -0
- package/esm/src/types/mod.d.ts.map +1 -0
- package/esm/src/types/subscriptions/requests.d.ts +1 -1
- package/esm/src/types/subscriptions/requests.d.ts.map +1 -1
- package/{script/src/types/subscriptions/common.d.ts → esm/src/types/subscriptions/responses.d.ts} +16 -4
- package/esm/src/types/subscriptions/responses.d.ts.map +1 -0
- package/package.json +20 -4
- package/script/mod.d.ts +3 -12
- package/script/mod.d.ts.map +1 -1
- package/script/mod.js +3 -5
- package/script/src/{transports/base.d.ts → base.d.ts} +10 -13
- package/script/src/base.d.ts.map +1 -0
- package/script/src/{transports/base.js → base.js} +13 -12
- package/script/src/clients/event.d.ts +4 -4
- package/script/src/clients/event.d.ts.map +1 -1
- package/script/src/clients/event.js +2 -2
- package/script/src/clients/public.d.ts +109 -6
- package/script/src/clients/public.d.ts.map +1 -1
- package/script/src/clients/public.js +106 -3
- package/script/src/clients/wallet.d.ts +232 -29
- package/script/src/clients/wallet.d.ts.map +1 -1
- package/script/src/clients/wallet.js +837 -221
- package/script/src/signing.d.ts +135 -0
- package/script/src/signing.d.ts.map +1 -0
- package/script/src/signing.js +203 -0
- package/script/src/transports/http/http_transport.d.ts +1 -1
- package/script/src/transports/http/http_transport.d.ts.map +1 -1
- package/script/src/transports/http/http_transport.js +2 -2
- package/{esm/src/transports/websocket/hyperliquid_event_target.d.ts → script/src/transports/websocket/_hyperliquid_event_target.d.ts} +7 -15
- package/script/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -0
- package/script/src/transports/websocket/{hyperliquid_event_target.js → _hyperliquid_event_target.js} +4 -22
- package/script/src/transports/websocket/{reconnecting_websocket.d.ts → _reconnecting_websocket.d.ts} +26 -26
- package/script/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -0
- package/script/src/transports/websocket/{reconnecting_websocket.js → _reconnecting_websocket.js} +94 -78
- package/script/src/transports/websocket/{websocket_request_dispatcher.d.ts → _websocket_request_dispatcher.d.ts} +3 -7
- package/script/src/transports/websocket/_websocket_request_dispatcher.d.ts.map +1 -0
- package/script/src/transports/websocket/{websocket_request_dispatcher.js → _websocket_request_dispatcher.js} +4 -8
- package/script/src/transports/websocket/websocket_transport.d.ts +12 -15
- package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/script/src/transports/websocket/websocket_transport.js +51 -54
- package/script/src/types/exchange/requests.d.ts +172 -20
- package/script/src/types/exchange/requests.d.ts.map +1 -1
- package/script/src/types/exchange/responses.d.ts +32 -32
- package/script/src/types/exchange/responses.d.ts.map +1 -1
- package/script/src/types/explorer/requests.d.ts +12 -12
- package/script/src/types/explorer/requests.d.ts.map +1 -1
- package/script/src/types/explorer/responses.d.ts +36 -1
- package/script/src/types/explorer/responses.d.ts.map +1 -1
- package/script/src/types/info/accounts.d.ts +130 -105
- package/script/src/types/info/accounts.d.ts.map +1 -1
- package/script/src/types/info/assets.d.ts +154 -152
- package/script/src/types/info/assets.d.ts.map +1 -1
- package/script/src/types/info/delegations.d.ts +20 -20
- package/script/src/types/info/delegations.d.ts.map +1 -1
- package/script/src/types/info/orders.d.ts +55 -55
- package/script/src/types/info/orders.d.ts.map +1 -1
- package/script/src/types/info/requests.d.ts +73 -10
- package/script/src/types/info/requests.d.ts.map +1 -1
- package/script/src/types/info/vaults.d.ts +1 -1
- package/script/src/types/info/vaults.d.ts.map +1 -1
- package/script/src/types/mod.d.ts +14 -0
- package/script/src/types/mod.d.ts.map +1 -0
- package/script/src/types/subscriptions/requests.d.ts +1 -1
- package/script/src/types/subscriptions/requests.d.ts.map +1 -1
- package/{esm/src/types/subscriptions/common.d.ts → script/src/types/subscriptions/responses.d.ts} +16 -4
- package/script/src/types/subscriptions/responses.d.ts.map +1 -0
- package/esm/src/transports/base.d.ts.map +0 -1
- package/esm/src/transports/base.js +0 -14
- package/esm/src/transports/websocket/hyperliquid_event_target.d.ts.map +0 -1
- package/esm/src/transports/websocket/reconnecting_websocket.d.ts.map +0 -1
- package/esm/src/transports/websocket/websocket_request_dispatcher.d.ts.map +0 -1
- package/esm/src/types/common.d.ts +0 -3
- package/esm/src/types/common.d.ts.map +0 -1
- package/esm/src/types/exchange/common.d.ts +0 -36
- package/esm/src/types/exchange/common.d.ts.map +0 -1
- package/esm/src/types/explorer/common.d.ts +0 -37
- package/esm/src/types/explorer/common.d.ts.map +0 -1
- package/esm/src/types/explorer/common.js +0 -1
- package/esm/src/types/subscriptions/common.d.ts.map +0 -1
- package/esm/src/types/subscriptions/common.js +0 -1
- package/esm/src/utils/key_sort.d.ts +0 -21
- package/esm/src/utils/key_sort.d.ts.map +0 -1
- package/esm/src/utils/key_sort.js +0 -124
- package/esm/src/utils/signing.d.ts +0 -109
- package/esm/src/utils/signing.d.ts.map +0 -1
- package/esm/src/utils/signing.js +0 -164
- package/script/src/transports/base.d.ts.map +0 -1
- package/script/src/transports/websocket/hyperliquid_event_target.d.ts.map +0 -1
- package/script/src/transports/websocket/reconnecting_websocket.d.ts.map +0 -1
- package/script/src/transports/websocket/websocket_request_dispatcher.d.ts.map +0 -1
- package/script/src/types/common.d.ts +0 -3
- package/script/src/types/common.d.ts.map +0 -1
- package/script/src/types/exchange/common.d.ts +0 -36
- package/script/src/types/exchange/common.d.ts.map +0 -1
- package/script/src/types/explorer/common.d.ts +0 -37
- package/script/src/types/explorer/common.d.ts.map +0 -1
- package/script/src/types/explorer/common.js +0 -12
- package/script/src/types/subscriptions/common.d.ts.map +0 -1
- package/script/src/types/subscriptions/common.js +0 -12
- package/script/src/utils/key_sort.d.ts +0 -21
- package/script/src/utils/key_sort.d.ts.map +0 -1
- package/script/src/utils/key_sort.js +0 -137
- package/script/src/utils/signing.d.ts +0 -109
- package/script/src/utils/signing.d.ts.map +0 -1
- package/script/src/utils/signing.js +0 -182
- /package/esm/src/types/{common.js → mod.js} +0 -0
- /package/esm/src/types/{exchange/common.js → subscriptions/responses.js} +0 -0
- /package/script/src/types/{common.js → mod.js} +0 -0
- /package/script/src/types/{exchange/common.js → subscriptions/responses.js} +0 -0
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import type { IRequestTransport } from "../
|
|
1
|
+
import type { IRequestTransport } from "../base.js";
|
|
2
2
|
import type { BlockDetailsRequest, TxDetailsRequest, UserDetailsRequest } from "../types/explorer/requests.js";
|
|
3
3
|
import type { BlockDetailsResponse, TxDetailsResponse, UserDetailsResponse } from "../types/explorer/responses.js";
|
|
4
|
-
import type { ExtraAgent, PerpsClearinghouseState, PortfolioPeriods, Referral, SpotClearinghouseState, SubAccount, UserFees, UserFundingUpdate, UserNonFundingLedgerUpdate, UserRateLimit, UserRole } from "../types/info/accounts.js";
|
|
4
|
+
import type { ExtraAgent, LegalCheck, MultiSigSigners, PerpsClearinghouseState, PortfolioPeriods, PreTransferCheck, Referral, SpotClearinghouseState, SubAccount, UserFees, UserFundingUpdate, UserNonFundingLedgerUpdate, UserRateLimit, UserRole } from "../types/info/accounts.js";
|
|
5
5
|
import type { AllMids, Candle, FundingHistory, PerpsMeta, PerpsMetaAndAssetCtxs, PredictedFunding, SpotDeployState, SpotMeta, SpotMetaAndAssetCtxs, TokenDetails } from "../types/info/assets.js";
|
|
6
6
|
import type { Delegation, DelegatorReward, DelegatorSummary, DelegatorUpdate, ValidatorSummary } from "../types/info/delegations.js";
|
|
7
7
|
import type { Book, Fill, FrontendOrder, Order, OrderLookup, OrderStatus, TwapHistory, TwapSliceFill } from "../types/info/orders.js";
|
|
8
|
-
import type { CandleSnapshotRequest, ClearinghouseStateRequest, DelegationsRequest, DelegatorHistoryRequest, DelegatorRewardsRequest, DelegatorSummaryRequest, ExtraAgentsRequest, FrontendOpenOrdersRequest, FundingHistoryRequest, HistoricalOrdersRequest, L2BookRequest, MaxBuilderFeeRequest, OpenOrdersRequest, OrderStatusRequest, PortfolioRequest, ReferralRequest, SpotClearinghouseStateRequest, SpotDeployStateRequest, SubAccountsRequest, TokenDetailsRequest, TwapHistoryRequest, UserFeesRequest, UserFillsByTimeRequest, UserFillsRequest, UserFundingRequest, UserNonFundingLedgerUpdatesRequest, UserRateLimitRequest, UserRoleRequest, UserTwapSliceFillsRequest, UserVaultEquitiesRequest, VaultDetailsRequest } from "../types/info/requests.js";
|
|
8
|
+
import type { CandleSnapshotRequest, ClearinghouseStateRequest, DelegationsRequest, DelegatorHistoryRequest, DelegatorRewardsRequest, DelegatorSummaryRequest, ExtraAgentsRequest, FrontendOpenOrdersRequest, FundingHistoryRequest, HistoricalOrdersRequest, IsVipRequest, L2BookRequest, LegalCheckRequest, MaxBuilderFeeRequest, OpenOrdersRequest, OrderStatusRequest, PortfolioRequest, PreTransferCheckRequest, ReferralRequest, SpotClearinghouseStateRequest, SpotDeployStateRequest, SubAccountsRequest, TokenDetailsRequest, TwapHistoryRequest, UserFeesRequest, UserFillsByTimeRequest, UserFillsRequest, UserFundingRequest, UserNonFundingLedgerUpdatesRequest, UserRateLimitRequest, UserRoleRequest, UserToMultiSigSignersRequest, UserTwapSliceFillsByTimeRequest, UserTwapSliceFillsRequest, UserVaultEquitiesRequest, VaultDetailsRequest } from "../types/info/requests.js";
|
|
9
9
|
import type { VaultDetails, VaultEquity, VaultSummary } from "../types/info/vaults.js";
|
|
10
10
|
/** Parameters for the {@linkcode PublicClient} constructor. */
|
|
11
11
|
export interface PublicClientParameters<T extends IRequestTransport = IRequestTransport> {
|
|
@@ -32,8 +32,12 @@ export type FrontendOpenOrdersParameters = Omit<FrontendOpenOrdersRequest, "type
|
|
|
32
32
|
export type FundingHistoryParameters = Omit<FundingHistoryRequest, "type">;
|
|
33
33
|
/** Parameters for the {@linkcode PublicClient.historicalOrders} method. */
|
|
34
34
|
export type HistoricalOrdersParameters = Omit<HistoricalOrdersRequest, "type">;
|
|
35
|
+
/** Parameters for the {@linkcode PublicClient.isVip} method. */
|
|
36
|
+
export type IsVipParameters = Omit<IsVipRequest, "type">;
|
|
35
37
|
/** Parameters for the {@linkcode PublicClient.l2Book} method. */
|
|
36
38
|
export type L2BookParameters = Omit<L2BookRequest, "type">;
|
|
39
|
+
/** Parameters for the {@linkcode PublicClient.legalCheck} method. */
|
|
40
|
+
export type LegalCheckParameters = Omit<LegalCheckRequest, "type">;
|
|
37
41
|
/** Parameters for the {@linkcode PublicClient.maxBuilderFee} method. */
|
|
38
42
|
export type MaxBuilderFeeParameters = Omit<MaxBuilderFeeRequest, "type">;
|
|
39
43
|
/** Parameters for the {@linkcode PublicClient.openOrders} method. */
|
|
@@ -42,6 +46,8 @@ export type OpenOrdersParameters = Omit<OpenOrdersRequest, "type">;
|
|
|
42
46
|
export type OrderStatusParameters = Omit<OrderStatusRequest, "type">;
|
|
43
47
|
/** Parameters for the {@linkcode PublicClient.portfolio} method. */
|
|
44
48
|
export type PortfolioParameters = Omit<PortfolioRequest, "type">;
|
|
49
|
+
/** Parameters for the {@linkcode PublicClient.preTransferCheck} method. */
|
|
50
|
+
export type PreTransferCheckParameters = Omit<PreTransferCheckRequest, "type">;
|
|
45
51
|
/** Parameters for the {@linkcode PublicClient.referral} method. */
|
|
46
52
|
export type ReferralParameters = Omit<ReferralRequest, "type">;
|
|
47
53
|
/** Parameters for the {@linkcode PublicClient.spotClearinghouseState} method. */
|
|
@@ -68,8 +74,12 @@ export type UserNonFundingLedgerUpdatesParameters = Omit<UserNonFundingLedgerUpd
|
|
|
68
74
|
export type UserRateLimitParameters = Omit<UserRateLimitRequest, "type">;
|
|
69
75
|
/** Parameters for the {@linkcode PublicClient.userRole} method. */
|
|
70
76
|
export type UserRoleParameters = Omit<UserRoleRequest, "type">;
|
|
77
|
+
/** Parameters for the {@linkcode PublicClient.userToMultiSigSigners} method. */
|
|
78
|
+
export type UserToMultiSigSignersParameters = Omit<UserToMultiSigSignersRequest, "type">;
|
|
71
79
|
/** Parameters for the {@linkcode PublicClient.userTwapSliceFills} method. */
|
|
72
80
|
export type UserTwapSliceFillsParameters = Omit<UserTwapSliceFillsRequest, "type">;
|
|
81
|
+
/** Parameters for the {@linkcode PublicClient.userTwapSliceFillsByTime} method. */
|
|
82
|
+
export type UserTwapSliceFillsByTimeParameters = Omit<UserTwapSliceFillsByTimeRequest, "type">;
|
|
73
83
|
/** Parameters for the {@linkcode PublicClient.userVaultEquities} method. */
|
|
74
84
|
export type UserVaultEquitiesParameters = Omit<UserVaultEquitiesRequest, "type">;
|
|
75
85
|
/** Parameters for the {@linkcode PublicClient.vaultDetails} method. */
|
|
@@ -82,7 +92,7 @@ export type TxDetailsParameters = Omit<TxDetailsRequest, "type">;
|
|
|
82
92
|
export type UserDetailsParameters = Omit<UserDetailsRequest, "type">;
|
|
83
93
|
/**
|
|
84
94
|
* Public client for interacting with the Hyperliquid API.
|
|
85
|
-
* @typeParam T
|
|
95
|
+
* @typeParam T The type of transport used to connect to the Hyperliquid API.
|
|
86
96
|
*/
|
|
87
97
|
export declare class PublicClient<T extends IRequestTransport = IRequestTransport> {
|
|
88
98
|
/** The transport used to connect to the Hyperliquid API. */
|
|
@@ -286,6 +296,24 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
|
|
|
286
296
|
* ```
|
|
287
297
|
*/
|
|
288
298
|
fundingHistory(args: FundingHistoryParameters, signal?: AbortSignal): Promise<FundingHistory[]>;
|
|
299
|
+
/**
|
|
300
|
+
* Request to check if a user is a VIP.
|
|
301
|
+
* @param args - The parameters for the request.
|
|
302
|
+
* @param signal - An optional abort signal.
|
|
303
|
+
* @returns Boolean indicating user's VIP status.
|
|
304
|
+
*
|
|
305
|
+
* @see null - no documentation
|
|
306
|
+
* @example
|
|
307
|
+
* ```ts
|
|
308
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
309
|
+
*
|
|
310
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
311
|
+
* const client = new hl.PublicClient({ transport });
|
|
312
|
+
*
|
|
313
|
+
* const isVip = await client.isVip({ user: "0x..." });
|
|
314
|
+
* ```
|
|
315
|
+
*/
|
|
316
|
+
isVip(args: IsVipParameters, signal?: AbortSignal): Promise<boolean>;
|
|
289
317
|
/**
|
|
290
318
|
* Request user's historical orders.
|
|
291
319
|
* @param args - The parameters for the request.
|
|
@@ -322,6 +350,24 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
|
|
|
322
350
|
* ```
|
|
323
351
|
*/
|
|
324
352
|
l2Book(args: L2BookParameters, signal?: AbortSignal): Promise<Book>;
|
|
353
|
+
/**
|
|
354
|
+
* Request legal verification status of a user.
|
|
355
|
+
* @param args - The parameters for the request.
|
|
356
|
+
* @param signal - An optional abort signal.
|
|
357
|
+
* @returns Legal verification status for a user.
|
|
358
|
+
*
|
|
359
|
+
* @see null - no documentation
|
|
360
|
+
* @example
|
|
361
|
+
* ```ts
|
|
362
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
363
|
+
*
|
|
364
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
365
|
+
* const client = new hl.PublicClient({ transport });
|
|
366
|
+
*
|
|
367
|
+
* const legalCheck = await client.legalCheck({ user: "0x..." });
|
|
368
|
+
* ```
|
|
369
|
+
*/
|
|
370
|
+
legalCheck(args: LegalCheckParameters, signal?: AbortSignal): Promise<LegalCheck>;
|
|
325
371
|
/**
|
|
326
372
|
* Request builder fee approval.
|
|
327
373
|
* @param args - The parameters for the request.
|
|
@@ -428,6 +474,24 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
|
|
|
428
474
|
* ```
|
|
429
475
|
*/
|
|
430
476
|
portfolio(args: PortfolioParameters, signal?: AbortSignal): Promise<PortfolioPeriods>;
|
|
477
|
+
/**
|
|
478
|
+
* Request user's existence check before transfer.
|
|
479
|
+
* @param args - The parameters for the request.
|
|
480
|
+
* @param signal - An optional abort signal.
|
|
481
|
+
* @returns Pre-transfer user existence check result.
|
|
482
|
+
*
|
|
483
|
+
* @see null - no documentation
|
|
484
|
+
* @example
|
|
485
|
+
* ```ts
|
|
486
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
487
|
+
*
|
|
488
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
489
|
+
* const client = new hl.PublicClient({ transport });
|
|
490
|
+
*
|
|
491
|
+
* const preTransferCheck = await client.preTransferCheck({ user: "0x...", source: "0x..." });
|
|
492
|
+
* ```
|
|
493
|
+
*/
|
|
494
|
+
preTransferCheck(args: PreTransferCheckParameters, signal?: AbortSignal): Promise<PreTransferCheck>;
|
|
431
495
|
/**
|
|
432
496
|
* Request perpetuals at open interest cap.
|
|
433
497
|
* @param args - The parameters for the request.
|
|
@@ -555,7 +619,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
|
|
|
555
619
|
* Request user sub-accounts.
|
|
556
620
|
* @param args - The parameters for the request.
|
|
557
621
|
* @param signal - An optional abort signal.
|
|
558
|
-
* @returns Array of user sub-account.
|
|
622
|
+
* @returns Array of user sub-account or null if the user does not have any sub-accounts.
|
|
559
623
|
*
|
|
560
624
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
|
|
561
625
|
* @example
|
|
@@ -740,6 +804,24 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
|
|
|
740
804
|
* ```
|
|
741
805
|
*/
|
|
742
806
|
userRole(args: UserRoleParameters, signal?: AbortSignal): Promise<UserRole>;
|
|
807
|
+
/**
|
|
808
|
+
* Request multi-sig signers for a user.
|
|
809
|
+
* @param args - The parameters for the request.
|
|
810
|
+
* @param signal - An optional abort signal.
|
|
811
|
+
* @returns Multi-sig signers for a user or null if the user does not have any multi-sig signers.
|
|
812
|
+
*
|
|
813
|
+
* @see null - no documentation
|
|
814
|
+
* @example
|
|
815
|
+
* ```ts
|
|
816
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
817
|
+
*
|
|
818
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
819
|
+
* const client = new hl.PublicClient({ transport });
|
|
820
|
+
*
|
|
821
|
+
* const multiSigSigners = await client.userToMultiSigSigners({ user: "0x..." });
|
|
822
|
+
* ```
|
|
823
|
+
*/
|
|
824
|
+
userToMultiSigSigners(args: UserToMultiSigSignersParameters, signal?: AbortSignal): Promise<MultiSigSigners | null>;
|
|
743
825
|
/**
|
|
744
826
|
* Request user twap slice fills.
|
|
745
827
|
* @param args - The parameters for the request.
|
|
@@ -758,6 +840,27 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
|
|
|
758
840
|
* ```
|
|
759
841
|
*/
|
|
760
842
|
userTwapSliceFills(args: UserTwapSliceFillsParameters, signal?: AbortSignal): Promise<TwapSliceFill[]>;
|
|
843
|
+
/**
|
|
844
|
+
* Request user twap slice fills by time.
|
|
845
|
+
* @param args - The parameters for the request.
|
|
846
|
+
* @param signal - An optional abort signal.
|
|
847
|
+
* @returns Array of user's twap slice fill.
|
|
848
|
+
*
|
|
849
|
+
* @see null - no documentation
|
|
850
|
+
* @example
|
|
851
|
+
* ```ts
|
|
852
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
853
|
+
*
|
|
854
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
855
|
+
* const client = new hl.PublicClient({ transport });
|
|
856
|
+
*
|
|
857
|
+
* const twapSliceFillsByTime = await client.userTwapSliceFillsByTime({
|
|
858
|
+
* user: "0x...",
|
|
859
|
+
* startTime: Date.now() - 1000 * 60 * 60 * 24
|
|
860
|
+
* });
|
|
861
|
+
* ```
|
|
862
|
+
*/
|
|
863
|
+
userTwapSliceFillsByTime(args: UserTwapSliceFillsByTimeParameters, signal?: AbortSignal): Promise<TwapSliceFill[]>;
|
|
761
864
|
/**
|
|
762
865
|
* Request user vault deposits.
|
|
763
866
|
* @param args - The parameters for the request.
|
|
@@ -797,7 +900,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
|
|
|
797
900
|
* Request details of a vault.
|
|
798
901
|
* @param args - The parameters for the request.
|
|
799
902
|
* @param signal - An optional abort signal.
|
|
800
|
-
* @returns Details of a vault.
|
|
903
|
+
* @returns Details of a vault or null if the vault does not exist.
|
|
801
904
|
*
|
|
802
905
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
|
|
803
906
|
* @example
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../../src/src/clients/public.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../../src/src/clients/public.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAC/G,OAAO,KAAK,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACnH,OAAO,KAAK,EACR,UAAU,EACV,UAAU,EACV,eAAe,EACf,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,QAAQ,EACR,sBAAsB,EACtB,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,0BAA0B,EAC1B,aAAa,EACb,QAAQ,EACX,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EACR,OAAO,EACP,MAAM,EACN,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,gBAAgB,EAChB,eAAe,EACf,QAAQ,EACR,oBAAoB,EACpB,YAAY,EACf,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EACR,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EACR,IAAI,EACJ,IAAI,EACJ,aAAa,EACb,KAAK,EACL,WAAW,EACX,WAAW,EACX,WAAW,EACX,aAAa,EAChB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EACR,qBAAqB,EACrB,yBAAyB,EACzB,kBAAkB,EAClB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,EACvB,kBAAkB,EAClB,yBAAyB,EACzB,qBAAqB,EACrB,uBAAuB,EACvB,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EACvB,eAAe,EACf,6BAA6B,EAC7B,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,kCAAkC,EAClC,oBAAoB,EACpB,eAAe,EACf,4BAA4B,EAC5B,+BAA+B,EAC/B,yBAAyB,EACzB,wBAAwB,EACxB,mBAAmB,EACtB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAIvF,+DAA+D;AAC/D,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB;IACnF,4DAA4D;IAC5D,SAAS,EAAE,CAAC,CAAC;CAChB;AAED,yEAAyE;AACzE,MAAM,MAAM,wBAAwB,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;AAEpE,6EAA6E;AAC7E,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;AAEnF,sEAAsE;AACtE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AAErE,2EAA2E;AAC3E,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AAE/E,2EAA2E;AAC3E,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AAE/E,2EAA2E;AAC3E,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AAE/E,sEAAsE;AACtE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AAErE,6EAA6E;AAC7E,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;AAEnF,yEAAyE;AACzE,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAE3E,2EAA2E;AAC3E,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AAE/E,gEAAgE;AAChE,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAEzD,iEAAiE;AACjE,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;AAE3D,qEAAqE;AACrE,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;AAEnE,wEAAwE;AACxE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAEzE,qEAAqE;AACrE,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;AAEnE,sEAAsE;AACtE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AAErE,oEAAoE;AACpE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;AAEjE,2EAA2E;AAC3E,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AAE/E,mEAAmE;AACnE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AAE/D,iFAAiF;AACjF,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;AAE3F,0EAA0E;AAC1E,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;AAE7E,sEAAsE;AACtE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AAErE,uEAAuE;AACvE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAEvE,sEAAsE;AACtE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AAErE,mEAAmE;AACnE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AAE/D,oEAAoE;AACpE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;AAEjE,0EAA0E;AAC1E,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;AAE7E,sEAAsE;AACtE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AAErE,sFAAsF;AACtF,MAAM,MAAM,qCAAqC,GAAG,IAAI,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;AAErG,wEAAwE;AACxE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAEzE,mEAAmE;AACnE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AAE/D,gFAAgF;AAChF,MAAM,MAAM,+BAA+B,GAAG,IAAI,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;AAEzF,6EAA6E;AAC7E,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;AAEnF,mFAAmF;AACnF,MAAM,MAAM,kCAAkC,GAAG,IAAI,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;AAE/F,4EAA4E;AAC5E,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;AAEjF,uEAAuE;AACvE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAIvE,uEAAuE;AACvE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAEvE,oEAAoE;AACpE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;AAEjE,sEAAsE;AACtE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AAIrE;;;GAGG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB;IACrE,4DAA4D;IAC5D,SAAS,EAAE,CAAC,CAAC;IAEb;;;;;;;;;;;OAWG;gBACS,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC;IAM3C;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ/C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQvF;;;;;;;;;;;;;;;;OAgBG;IACH,kBAAkB,CAAC,IAAI,EAAE,4BAA4B,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAQ9G;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAQrF;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,IAAI,EAAE,0BAA0B,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAQpG;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,IAAI,EAAE,0BAA0B,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAQpG;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,IAAI,EAAE,0BAA0B,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQnG;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAQrF;;;;;;;;;;;;;;;;OAgBG;IACH,kBAAkB,CAAC,IAAI,EAAE,4BAA4B,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAQtG;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAQ/F;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAQpE;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,IAAI,EAAE,0BAA0B,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;IAQ/G;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnE;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAQjF;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CAAC,IAAI,EAAE,uBAAuB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAQnF;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;IAQ9C;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAQtE;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAQ9E;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAQpF;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,IAAI,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQrF;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,IAAI,EAAE,0BAA0B,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQnG;;;;;;;;;;;;;;;;OAgBG;IACH,sBAAsB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQ/D;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAQpE;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQ3E;;;;;;;;;;;;;;;;OAgBG;IACH,sBAAsB,CAClB,IAAI,EAAE,gCAAgC,EACtC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,sBAAsB,CAAC;IAQlC;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,IAAI,EAAE,yBAAyB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC;IAQhG;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQjD;;;;;;;;;;;;;;;OAeG;IACH,oBAAoB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQzE;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC;IAQ5F;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,IAAI,EAAE,sBAAsB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IAQvF;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAQtF;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQ3E;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,IAAI,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAQ3E;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CAAC,IAAI,EAAE,yBAAyB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAQvF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAQ5F;;;;;;;;;;;;;;;;;;;OAmBG;IACH,2BAA2B,CACvB,IAAI,EAAE,qCAAqC,EAC3C,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,0BAA0B,EAAE,CAAC;IAQxC;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CAAC,IAAI,EAAE,uBAAuB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;IAQ1F;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQ3E;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CACjB,IAAI,EAAE,+BAA+B,EACrC,MAAM,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAQlC;;;;;;;;;;;;;;;;OAgBG;IACH,kBAAkB,CAAC,IAAI,EAAE,4BAA4B,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAQtG;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,CAAC,IAAI,EAAE,kCAAkC,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAQlH;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,IAAI,EAAE,2BAA2B,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAQlG;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAQrE;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,IAAI,EAAE,sBAAsB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAQ9F;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAU7D;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,IAAI,EAAE,sBAAsB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQ/F;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,IAAI,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQtF;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAO/F"}
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
// ——————————————— Client ———————————————
|
|
14
14
|
/**
|
|
15
15
|
* Public client for interacting with the Hyperliquid API.
|
|
16
|
-
* @typeParam T
|
|
16
|
+
* @typeParam T The type of transport used to connect to the Hyperliquid API.
|
|
17
17
|
*/
|
|
18
18
|
class PublicClient {
|
|
19
19
|
/**
|
|
@@ -245,6 +245,26 @@
|
|
|
245
245
|
fundingHistory(args, signal) {
|
|
246
246
|
return this.transport.request("info", { type: "fundingHistory", ...args }, signal);
|
|
247
247
|
}
|
|
248
|
+
/**
|
|
249
|
+
* Request to check if a user is a VIP.
|
|
250
|
+
* @param args - The parameters for the request.
|
|
251
|
+
* @param signal - An optional abort signal.
|
|
252
|
+
* @returns Boolean indicating user's VIP status.
|
|
253
|
+
*
|
|
254
|
+
* @see null - no documentation
|
|
255
|
+
* @example
|
|
256
|
+
* ```ts
|
|
257
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
258
|
+
*
|
|
259
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
260
|
+
* const client = new hl.PublicClient({ transport });
|
|
261
|
+
*
|
|
262
|
+
* const isVip = await client.isVip({ user: "0x..." });
|
|
263
|
+
* ```
|
|
264
|
+
*/
|
|
265
|
+
isVip(args, signal) {
|
|
266
|
+
return this.transport.request("info", { type: "isVip", ...args }, signal);
|
|
267
|
+
}
|
|
248
268
|
/**
|
|
249
269
|
* Request user's historical orders.
|
|
250
270
|
* @param args - The parameters for the request.
|
|
@@ -285,6 +305,26 @@
|
|
|
285
305
|
l2Book(args, signal) {
|
|
286
306
|
return this.transport.request("info", { type: "l2Book", ...args }, signal);
|
|
287
307
|
}
|
|
308
|
+
/**
|
|
309
|
+
* Request legal verification status of a user.
|
|
310
|
+
* @param args - The parameters for the request.
|
|
311
|
+
* @param signal - An optional abort signal.
|
|
312
|
+
* @returns Legal verification status for a user.
|
|
313
|
+
*
|
|
314
|
+
* @see null - no documentation
|
|
315
|
+
* @example
|
|
316
|
+
* ```ts
|
|
317
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
318
|
+
*
|
|
319
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
320
|
+
* const client = new hl.PublicClient({ transport });
|
|
321
|
+
*
|
|
322
|
+
* const legalCheck = await client.legalCheck({ user: "0x..." });
|
|
323
|
+
* ```
|
|
324
|
+
*/
|
|
325
|
+
legalCheck(args, signal) {
|
|
326
|
+
return this.transport.request("info", { type: "legalCheck", ...args }, signal);
|
|
327
|
+
}
|
|
288
328
|
/**
|
|
289
329
|
* Request builder fee approval.
|
|
290
330
|
* @param args - The parameters for the request.
|
|
@@ -403,6 +443,26 @@
|
|
|
403
443
|
portfolio(args, signal) {
|
|
404
444
|
return this.transport.request("info", { type: "portfolio", ...args }, signal);
|
|
405
445
|
}
|
|
446
|
+
/**
|
|
447
|
+
* Request user's existence check before transfer.
|
|
448
|
+
* @param args - The parameters for the request.
|
|
449
|
+
* @param signal - An optional abort signal.
|
|
450
|
+
* @returns Pre-transfer user existence check result.
|
|
451
|
+
*
|
|
452
|
+
* @see null - no documentation
|
|
453
|
+
* @example
|
|
454
|
+
* ```ts
|
|
455
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
456
|
+
*
|
|
457
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
458
|
+
* const client = new hl.PublicClient({ transport });
|
|
459
|
+
*
|
|
460
|
+
* const preTransferCheck = await client.preTransferCheck({ user: "0x...", source: "0x..." });
|
|
461
|
+
* ```
|
|
462
|
+
*/
|
|
463
|
+
preTransferCheck(args, signal) {
|
|
464
|
+
return this.transport.request("info", { type: "preTransferCheck", ...args }, signal);
|
|
465
|
+
}
|
|
406
466
|
/**
|
|
407
467
|
* Request perpetuals at open interest cap.
|
|
408
468
|
* @param args - The parameters for the request.
|
|
@@ -544,7 +604,7 @@
|
|
|
544
604
|
* Request user sub-accounts.
|
|
545
605
|
* @param args - The parameters for the request.
|
|
546
606
|
* @param signal - An optional abort signal.
|
|
547
|
-
* @returns Array of user sub-account.
|
|
607
|
+
* @returns Array of user sub-account or null if the user does not have any sub-accounts.
|
|
548
608
|
*
|
|
549
609
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
|
|
550
610
|
* @example
|
|
@@ -749,6 +809,26 @@
|
|
|
749
809
|
userRole(args, signal) {
|
|
750
810
|
return this.transport.request("info", { type: "userRole", ...args }, signal);
|
|
751
811
|
}
|
|
812
|
+
/**
|
|
813
|
+
* Request multi-sig signers for a user.
|
|
814
|
+
* @param args - The parameters for the request.
|
|
815
|
+
* @param signal - An optional abort signal.
|
|
816
|
+
* @returns Multi-sig signers for a user or null if the user does not have any multi-sig signers.
|
|
817
|
+
*
|
|
818
|
+
* @see null - no documentation
|
|
819
|
+
* @example
|
|
820
|
+
* ```ts
|
|
821
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
822
|
+
*
|
|
823
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
824
|
+
* const client = new hl.PublicClient({ transport });
|
|
825
|
+
*
|
|
826
|
+
* const multiSigSigners = await client.userToMultiSigSigners({ user: "0x..." });
|
|
827
|
+
* ```
|
|
828
|
+
*/
|
|
829
|
+
userToMultiSigSigners(args, signal) {
|
|
830
|
+
return this.transport.request("info", { type: "userToMultiSigSigners", ...args }, signal);
|
|
831
|
+
}
|
|
752
832
|
/**
|
|
753
833
|
* Request user twap slice fills.
|
|
754
834
|
* @param args - The parameters for the request.
|
|
@@ -769,6 +849,29 @@
|
|
|
769
849
|
userTwapSliceFills(args, signal) {
|
|
770
850
|
return this.transport.request("info", { type: "userTwapSliceFills", ...args }, signal);
|
|
771
851
|
}
|
|
852
|
+
/**
|
|
853
|
+
* Request user twap slice fills by time.
|
|
854
|
+
* @param args - The parameters for the request.
|
|
855
|
+
* @param signal - An optional abort signal.
|
|
856
|
+
* @returns Array of user's twap slice fill.
|
|
857
|
+
*
|
|
858
|
+
* @see null - no documentation
|
|
859
|
+
* @example
|
|
860
|
+
* ```ts
|
|
861
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
862
|
+
*
|
|
863
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
864
|
+
* const client = new hl.PublicClient({ transport });
|
|
865
|
+
*
|
|
866
|
+
* const twapSliceFillsByTime = await client.userTwapSliceFillsByTime({
|
|
867
|
+
* user: "0x...",
|
|
868
|
+
* startTime: Date.now() - 1000 * 60 * 60 * 24
|
|
869
|
+
* });
|
|
870
|
+
* ```
|
|
871
|
+
*/
|
|
872
|
+
userTwapSliceFillsByTime(args, signal) {
|
|
873
|
+
return this.transport.request("info", { type: "userTwapSliceFillsByTime", ...args }, signal);
|
|
874
|
+
}
|
|
772
875
|
/**
|
|
773
876
|
* Request user vault deposits.
|
|
774
877
|
* @param args - The parameters for the request.
|
|
@@ -812,7 +915,7 @@
|
|
|
812
915
|
* Request details of a vault.
|
|
813
916
|
* @param args - The parameters for the request.
|
|
814
917
|
* @param signal - An optional abort signal.
|
|
815
|
-
* @returns Details of a vault.
|
|
918
|
+
* @returns Details of a vault or null if the vault does not exist.
|
|
816
919
|
*
|
|
817
920
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
|
|
818
921
|
* @example
|