@nktkas/hyperliquid 0.23.0 → 0.24.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/CONTRIBUTING.md +3 -2
- package/README.md +184 -186
- package/esm/mod.d.ts +2 -2
- package/esm/mod.d.ts.map +1 -1
- package/esm/src/base.d.ts +0 -5
- package/esm/src/base.d.ts.map +1 -1
- package/esm/src/clients/exchange.d.ts +430 -393
- package/esm/src/clients/exchange.d.ts.map +1 -1
- package/esm/src/clients/exchange.js +467 -927
- package/esm/src/clients/info.d.ts +330 -185
- package/esm/src/clients/info.d.ts.map +1 -1
- package/esm/src/clients/info.js +348 -334
- package/esm/src/clients/multiSign.d.ts +14 -1184
- package/esm/src/clients/multiSign.d.ts.map +1 -1
- package/esm/src/clients/multiSign.js +37 -2004
- package/esm/src/clients/subscription.d.ts +95 -93
- package/esm/src/clients/subscription.d.ts.map +1 -1
- package/esm/src/clients/subscription.js +101 -146
- package/esm/src/signing/_signTypedData/ethers.d.ts +16 -4
- package/esm/src/signing/_signTypedData/ethers.d.ts.map +1 -1
- package/esm/src/signing/_signTypedData/ethers.js +1 -1
- package/esm/src/signing/_signTypedData/mod.d.ts +12 -12
- package/esm/src/signing/_signTypedData/mod.d.ts.map +1 -1
- package/esm/src/signing/_signTypedData/mod.js +52 -24
- package/esm/src/signing/_signTypedData/private_key.d.ts +6 -5
- package/esm/src/signing/_signTypedData/private_key.d.ts.map +1 -1
- package/esm/src/signing/_signTypedData/private_key.js +40 -19
- package/esm/src/signing/_signTypedData/viem.d.ts +27 -6
- package/esm/src/signing/_signTypedData/viem.d.ts.map +1 -1
- package/esm/src/signing/_signTypedData/viem.js +1 -1
- package/esm/src/signing/_sorter.d.ts +12 -21
- package/esm/src/signing/_sorter.d.ts.map +1 -1
- package/esm/src/signing/_sorter.js +30 -63
- package/esm/src/signing/mod.d.ts +177 -127
- package/esm/src/signing/mod.d.ts.map +1 -1
- package/esm/src/signing/mod.js +182 -130
- package/esm/src/transports/base.d.ts +2 -1
- package/esm/src/transports/base.d.ts.map +1 -1
- package/esm/src/transports/http/http_transport.d.ts +3 -2
- package/esm/src/transports/http/http_transport.d.ts.map +1 -1
- package/esm/src/transports/http/http_transport.js +4 -4
- package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts +14 -6
- package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
- package/esm/src/transports/websocket/_hyperliquid_event_target.js +1 -2
- package/esm/src/transports/websocket/_reconnecting_websocket.d.ts +2 -1
- package/esm/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -1
- package/esm/src/transports/websocket/_reconnecting_websocket.js +1 -0
- package/esm/src/transports/websocket/_websocket_async_request.d.ts.map +1 -1
- package/esm/src/transports/websocket/_websocket_async_request.js +17 -21
- package/esm/src/transports/websocket/websocket_transport.d.ts +4 -4
- package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/esm/src/transports/websocket/websocket_transport.js +6 -6
- package/esm/src/types/exchange/requests.d.ts +492 -306
- package/esm/src/types/exchange/requests.d.ts.map +1 -1
- package/esm/src/types/exchange/responses.d.ts +105 -25
- package/esm/src/types/exchange/responses.d.ts.map +1 -1
- package/esm/src/types/explorer/requests.d.ts +3 -3
- package/esm/src/types/explorer/requests.d.ts.map +1 -1
- package/esm/src/types/explorer/responses.d.ts +1 -1
- package/esm/src/types/explorer/responses.d.ts.map +1 -1
- package/esm/src/types/info/accounts.d.ts +403 -98
- package/esm/src/types/info/accounts.d.ts.map +1 -1
- package/esm/src/types/info/assets.d.ts +131 -35
- package/esm/src/types/info/assets.d.ts.map +1 -1
- package/esm/src/types/info/markets.d.ts +35 -8
- package/esm/src/types/info/markets.d.ts.map +1 -1
- package/esm/src/types/info/orders.d.ts +62 -17
- package/esm/src/types/info/orders.d.ts.map +1 -1
- package/esm/src/types/info/requests.d.ts +194 -76
- package/esm/src/types/info/requests.d.ts.map +1 -1
- package/{script/src/types/info/delegations.d.ts → esm/src/types/info/validators.d.ts} +45 -15
- package/esm/src/types/info/validators.d.ts.map +1 -0
- package/esm/src/types/info/vaults.d.ts +32 -10
- package/esm/src/types/info/vaults.d.ts.map +1 -1
- package/esm/src/types/mod.d.ts +2 -2
- package/esm/src/types/mod.d.ts.map +1 -1
- package/esm/src/types/subscriptions/requests.d.ts +21 -66
- package/esm/src/types/subscriptions/requests.d.ts.map +1 -1
- package/esm/src/types/subscriptions/responses.d.ts +46 -55
- package/esm/src/types/subscriptions/responses.d.ts.map +1 -1
- package/package.json +2 -3
- package/script/mod.d.ts +2 -2
- package/script/mod.d.ts.map +1 -1
- package/script/src/base.d.ts +0 -5
- package/script/src/base.d.ts.map +1 -1
- package/script/src/clients/exchange.d.ts +430 -393
- package/script/src/clients/exchange.d.ts.map +1 -1
- package/script/src/clients/exchange.js +466 -926
- package/script/src/clients/info.d.ts +330 -185
- package/script/src/clients/info.d.ts.map +1 -1
- package/script/src/clients/info.js +348 -334
- package/script/src/clients/multiSign.d.ts +14 -1184
- package/script/src/clients/multiSign.d.ts.map +1 -1
- package/script/src/clients/multiSign.js +38 -2005
- package/script/src/clients/subscription.d.ts +95 -93
- package/script/src/clients/subscription.d.ts.map +1 -1
- package/script/src/clients/subscription.js +101 -146
- package/script/src/signing/_signTypedData/ethers.d.ts +16 -4
- package/script/src/signing/_signTypedData/ethers.d.ts.map +1 -1
- package/script/src/signing/_signTypedData/ethers.js +2 -2
- package/script/src/signing/_signTypedData/mod.d.ts +12 -12
- package/script/src/signing/_signTypedData/mod.d.ts.map +1 -1
- package/script/src/signing/_signTypedData/mod.js +51 -26
- package/script/src/signing/_signTypedData/private_key.d.ts +6 -5
- package/script/src/signing/_signTypedData/private_key.d.ts.map +1 -1
- package/script/src/signing/_signTypedData/private_key.js +40 -18
- package/script/src/signing/_signTypedData/viem.d.ts +27 -6
- package/script/src/signing/_signTypedData/viem.d.ts.map +1 -1
- package/script/src/signing/_signTypedData/viem.js +2 -2
- package/script/src/signing/_sorter.d.ts +12 -21
- package/script/src/signing/_sorter.d.ts.map +1 -1
- package/script/src/signing/_sorter.js +30 -63
- package/script/src/signing/mod.d.ts +177 -127
- package/script/src/signing/mod.d.ts.map +1 -1
- package/script/src/signing/mod.js +185 -148
- package/script/src/transports/base.d.ts +2 -1
- package/script/src/transports/base.d.ts.map +1 -1
- package/script/src/transports/http/http_transport.d.ts +3 -2
- package/script/src/transports/http/http_transport.d.ts.map +1 -1
- package/script/src/transports/http/http_transport.js +4 -4
- package/script/src/transports/websocket/_hyperliquid_event_target.d.ts +14 -6
- package/script/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
- package/script/src/transports/websocket/_hyperliquid_event_target.js +1 -2
- package/script/src/transports/websocket/_reconnecting_websocket.d.ts +2 -1
- package/script/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -1
- package/script/src/transports/websocket/_reconnecting_websocket.js +1 -0
- package/script/src/transports/websocket/_websocket_async_request.d.ts.map +1 -1
- package/script/src/transports/websocket/_websocket_async_request.js +17 -21
- package/script/src/transports/websocket/websocket_transport.d.ts +4 -4
- package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/script/src/transports/websocket/websocket_transport.js +6 -6
- package/script/src/types/exchange/requests.d.ts +492 -306
- package/script/src/types/exchange/requests.d.ts.map +1 -1
- package/script/src/types/exchange/responses.d.ts +105 -25
- package/script/src/types/exchange/responses.d.ts.map +1 -1
- package/script/src/types/explorer/requests.d.ts +3 -3
- package/script/src/types/explorer/requests.d.ts.map +1 -1
- package/script/src/types/explorer/responses.d.ts +1 -1
- package/script/src/types/explorer/responses.d.ts.map +1 -1
- package/script/src/types/info/accounts.d.ts +403 -98
- package/script/src/types/info/accounts.d.ts.map +1 -1
- package/script/src/types/info/assets.d.ts +131 -35
- package/script/src/types/info/assets.d.ts.map +1 -1
- package/script/src/types/info/markets.d.ts +35 -8
- package/script/src/types/info/markets.d.ts.map +1 -1
- package/script/src/types/info/orders.d.ts +62 -17
- package/script/src/types/info/orders.d.ts.map +1 -1
- package/script/src/types/info/requests.d.ts +194 -76
- package/script/src/types/info/requests.d.ts.map +1 -1
- package/{esm/src/types/info/delegations.d.ts → script/src/types/info/validators.d.ts} +45 -15
- package/script/src/types/info/validators.d.ts.map +1 -0
- package/script/src/types/info/vaults.d.ts +32 -10
- package/script/src/types/info/vaults.d.ts.map +1 -1
- package/script/src/types/mod.d.ts +2 -2
- package/script/src/types/mod.d.ts.map +1 -1
- package/script/src/types/subscriptions/requests.d.ts +21 -66
- package/script/src/types/subscriptions/requests.d.ts.map +1 -1
- package/script/src/types/subscriptions/responses.d.ts +46 -55
- package/script/src/types/subscriptions/responses.d.ts.map +1 -1
- package/esm/src/signing/_signTypedData/window.d.ts +0 -29
- package/esm/src/signing/_signTypedData/window.d.ts.map +0 -1
- package/esm/src/signing/_signTypedData/window.js +0 -30
- package/esm/src/types/info/delegations.d.ts.map +0 -1
- package/script/src/signing/_signTypedData/window.d.ts +0 -29
- package/script/src/signing/_signTypedData/window.d.ts.map +0 -1
- package/script/src/signing/_signTypedData/window.js +0 -34
- package/script/src/types/info/delegations.d.ts.map +0 -1
- /package/esm/src/types/info/{delegations.js → validators.js} +0 -0
- /package/script/src/types/info/{delegations.js → validators.js} +0 -0
|
@@ -1,99 +1,101 @@
|
|
|
1
1
|
import type { IRequestTransport } from "../transports/base.js";
|
|
2
|
-
import type { BlockDetailsRequest, TxDetailsRequest, UserDetailsRequest } from "../types/
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
import type { DeployAuctionStatus, SpotDeployState } from "../types/info/markets.js";
|
|
8
|
-
import type { Book, Fill, FrontendOrder, Order, OrderLookup, OrderStatus, TwapHistory, TwapSliceFill } from "../types/info/orders.js";
|
|
9
|
-
import type { AllMidsRequest, CandleSnapshotRequest, ClearinghouseStateRequest, DelegationsRequest, DelegatorHistoryRequest, DelegatorRewardsRequest, DelegatorSummaryRequest, ExtraAgentsRequest, FrontendOpenOrdersRequest, FundingHistoryRequest, HistoricalOrdersRequest, IsVipRequest, L2BookRequest, LegalCheckRequest, MaxBuilderFeeRequest, MetaRequest, 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";
|
|
10
|
-
import type { VaultDetails, VaultEquity, VaultSummary } from "../types/info/vaults.js";
|
|
2
|
+
import type { ActiveAssetData, ActiveAssetDataRequest, AllMids, AllMidsRequest, BlockDetails, BlockDetailsRequest, Book, Candle, CandleSnapshotRequest, ClearinghouseStateRequest, Delegation, DelegationsRequest, DelegatorHistoryRequest, DelegatorReward, DelegatorRewardsRequest, DelegatorSummary, DelegatorSummaryRequest, DelegatorUpdate, DeployAuctionStatus, ExchangeStatus, ExtraAgent, ExtraAgentsRequest, Fill, FrontendOpenOrdersRequest, FrontendOrder, FundingHistory, FundingHistoryRequest, HistoricalOrdersRequest, IsVipRequest, L2BookRequest, LeadingVaultsRequest, LegalCheck, LegalCheckRequest, MarginTable, MarginTableRequest, MaxBuilderFeeRequest, MetaRequest, MultiSigSigners, OpenOrdersRequest, Order, OrderLookup, OrderStatus, OrderStatusRequest, PerpDex, PerpsClearinghouseState, PerpsMeta, PerpsMetaAndAssetCtxs, PortfolioPeriods, PortfolioRequest, PredictedFunding, PreTransferCheck, PreTransferCheckRequest, Referral, ReferralRequest, SpotClearinghouseState, SpotClearinghouseStateRequest, SpotDeployState, SpotDeployStateRequest, SpotMeta, SpotMetaAndAssetCtxs, SubAccount, SubAccountsRequest, TokenDetails, TokenDetailsRequest, TwapHistory, TwapHistoryRequest, TwapSliceFill, TxDetails, TxDetailsRequest, UserDetailsRequest, UserFees, UserFeesRequest, UserFillsByTimeRequest, UserFillsRequest, UserFundingRequest, UserFundingUpdate, UserNonFundingLedgerUpdate, UserNonFundingLedgerUpdatesRequest, UserRateLimit, UserRateLimitRequest, UserRole, UserRoleRequest, UserToMultiSigSignersRequest, UserTwapSliceFillsByTimeRequest, UserTwapSliceFillsRequest, UserVaultEquitiesRequest, ValidatorSummary, VaultDetails, VaultDetailsRequest, VaultEquity, VaultLeading, VaultSummary } from "../types/mod.js";
|
|
3
|
+
/** @see https://github.com/microsoft/TypeScript/issues/13923#issuecomment-2191862501 */
|
|
4
|
+
type DeepImmutable<T> = {
|
|
5
|
+
readonly [K in keyof T]: DeepImmutable<T[K]>;
|
|
6
|
+
};
|
|
11
7
|
/** Parameters for the {@linkcode InfoClient} constructor. */
|
|
12
8
|
export interface InfoClientParameters<T extends IRequestTransport = IRequestTransport> {
|
|
13
9
|
/** The transport used to connect to the Hyperliquid API. */
|
|
14
10
|
transport: T;
|
|
15
11
|
}
|
|
16
|
-
/**
|
|
12
|
+
/** Request parameters for the {@linkcode InfoClient.activeAssetData} method. */
|
|
13
|
+
export type ActiveAssetDataParameters = Omit<ActiveAssetDataRequest, "type">;
|
|
14
|
+
/** Request parameters for the {@linkcode InfoClient.allMids} method. */
|
|
17
15
|
export type AllMidsParameters = Omit<AllMidsRequest, "type">;
|
|
18
|
-
/**
|
|
16
|
+
/** Request parameters for the {@linkcode InfoClient.blockDetails} method. */
|
|
19
17
|
export type BlockDetailsParameters = Omit<BlockDetailsRequest, "type">;
|
|
20
|
-
/**
|
|
18
|
+
/** Request parameters for the {@linkcode InfoClient.candleSnapshot} method. */
|
|
21
19
|
export type CandleSnapshotParameters = CandleSnapshotRequest["req"];
|
|
22
|
-
/**
|
|
20
|
+
/** Request parameters for the {@linkcode InfoClient.clearinghouseState} method. */
|
|
23
21
|
export type ClearinghouseStateParameters = Omit<ClearinghouseStateRequest, "type">;
|
|
24
|
-
/**
|
|
22
|
+
/** Request parameters for the {@linkcode InfoClient.delegations} method. */
|
|
25
23
|
export type DelegationsParameters = Omit<DelegationsRequest, "type">;
|
|
26
|
-
/**
|
|
24
|
+
/** Request parameters for the {@linkcode InfoClient.delegatorHistory} method. */
|
|
27
25
|
export type DelegatorHistoryParameters = Omit<DelegatorHistoryRequest, "type">;
|
|
28
|
-
/**
|
|
26
|
+
/** Request parameters for the {@linkcode InfoClient.delegatorRewards} method. */
|
|
29
27
|
export type DelegatorRewardsParameters = Omit<DelegatorRewardsRequest, "type">;
|
|
30
|
-
/**
|
|
28
|
+
/** Request parameters for the {@linkcode InfoClient.delegatorSummary} method. */
|
|
31
29
|
export type DelegatorSummaryParameters = Omit<DelegatorSummaryRequest, "type">;
|
|
32
|
-
/**
|
|
30
|
+
/** Request parameters for the {@linkcode InfoClient.extraAgents} method. */
|
|
33
31
|
export type ExtraAgentsParameters = Omit<ExtraAgentsRequest, "type">;
|
|
34
|
-
/**
|
|
32
|
+
/** Request parameters for the {@linkcode InfoClient.frontendOpenOrders} method. */
|
|
35
33
|
export type FrontendOpenOrdersParameters = Omit<FrontendOpenOrdersRequest, "type">;
|
|
36
|
-
/**
|
|
34
|
+
/** Request parameters for the {@linkcode InfoClient.fundingHistory} method. */
|
|
37
35
|
export type FundingHistoryParameters = Omit<FundingHistoryRequest, "type">;
|
|
38
|
-
/**
|
|
36
|
+
/** Request parameters for the {@linkcode InfoClient.historicalOrders} method. */
|
|
39
37
|
export type HistoricalOrdersParameters = Omit<HistoricalOrdersRequest, "type">;
|
|
40
|
-
/**
|
|
38
|
+
/** Request parameters for the {@linkcode InfoClient.isVip} method. */
|
|
41
39
|
export type IsVipParameters = Omit<IsVipRequest, "type">;
|
|
42
|
-
/**
|
|
40
|
+
/** Request parameters for the {@linkcode InfoClient.l2Book} method. */
|
|
43
41
|
export type L2BookParameters = Omit<L2BookRequest, "type">;
|
|
44
|
-
/**
|
|
42
|
+
/** Request parameters for the {@linkcode InfoClient.leadingVaults} method. */
|
|
43
|
+
export type LeadingVaultsParameters = Omit<LeadingVaultsRequest, "type">;
|
|
44
|
+
/** Request parameters for the {@linkcode InfoClient.legalCheck} method. */
|
|
45
45
|
export type LegalCheckParameters = Omit<LegalCheckRequest, "type">;
|
|
46
|
-
/**
|
|
46
|
+
/** Request parameters for the {@linkcode InfoClient.marginTable} method. */
|
|
47
|
+
export type MarginTableParameters = Omit<MarginTableRequest, "type">;
|
|
48
|
+
/** Request parameters for the {@linkcode InfoClient.maxBuilderFee} method. */
|
|
47
49
|
export type MaxBuilderFeeParameters = Omit<MaxBuilderFeeRequest, "type">;
|
|
48
|
-
/**
|
|
50
|
+
/** Request parameters for the {@linkcode InfoClient.meta} method. */
|
|
49
51
|
export type MetaParameters = Omit<MetaRequest, "type">;
|
|
50
|
-
/**
|
|
52
|
+
/** Request parameters for the {@linkcode InfoClient.openOrders} method. */
|
|
51
53
|
export type OpenOrdersParameters = Omit<OpenOrdersRequest, "type">;
|
|
52
|
-
/**
|
|
54
|
+
/** Request parameters for the {@linkcode InfoClient.orderStatus} method. */
|
|
53
55
|
export type OrderStatusParameters = Omit<OrderStatusRequest, "type">;
|
|
54
|
-
/**
|
|
56
|
+
/** Request parameters for the {@linkcode InfoClient.portfolio} method. */
|
|
55
57
|
export type PortfolioParameters = Omit<PortfolioRequest, "type">;
|
|
56
|
-
/**
|
|
58
|
+
/** Request parameters for the {@linkcode InfoClient.preTransferCheck} method. */
|
|
57
59
|
export type PreTransferCheckParameters = Omit<PreTransferCheckRequest, "type">;
|
|
58
|
-
/**
|
|
60
|
+
/** Request parameters for the {@linkcode InfoClient.referral} method. */
|
|
59
61
|
export type ReferralParameters = Omit<ReferralRequest, "type">;
|
|
60
|
-
/**
|
|
62
|
+
/** Request parameters for the {@linkcode InfoClient.spotClearinghouseState} method. */
|
|
61
63
|
export type SpotClearinghouseStateParameters = Omit<SpotClearinghouseStateRequest, "type">;
|
|
62
|
-
/**
|
|
64
|
+
/** Request parameters for the {@linkcode InfoClient.spotDeployState} method. */
|
|
63
65
|
export type SpotDeployStateParameters = Omit<SpotDeployStateRequest, "type">;
|
|
64
|
-
/**
|
|
66
|
+
/** Request parameters for the {@linkcode InfoClient.subAccounts} method. */
|
|
65
67
|
export type SubAccountsParameters = Omit<SubAccountsRequest, "type">;
|
|
66
|
-
/**
|
|
68
|
+
/** Request parameters for the {@linkcode InfoClient.tokenDetails} method. */
|
|
67
69
|
export type TokenDetailsParameters = Omit<TokenDetailsRequest, "type">;
|
|
68
|
-
/**
|
|
70
|
+
/** Request parameters for the {@linkcode InfoClient.twapHistory} method. */
|
|
69
71
|
export type TwapHistoryParameters = Omit<TwapHistoryRequest, "type">;
|
|
70
|
-
/**
|
|
72
|
+
/** Request parameters for the {@linkcode InfoClient.txDetails} method. */
|
|
71
73
|
export type TxDetailsParameters = Omit<TxDetailsRequest, "type">;
|
|
72
|
-
/**
|
|
74
|
+
/** Request parameters for the {@linkcode InfoClient.userDetails} method. */
|
|
73
75
|
export type UserDetailsParameters = Omit<UserDetailsRequest, "type">;
|
|
74
|
-
/**
|
|
76
|
+
/** Request parameters for the {@linkcode InfoClient.userFees} method. */
|
|
75
77
|
export type UserFeesParameters = Omit<UserFeesRequest, "type">;
|
|
76
|
-
/**
|
|
78
|
+
/** Request parameters for the {@linkcode InfoClient.userFills} method. */
|
|
77
79
|
export type UserFillsParameters = Omit<UserFillsRequest, "type">;
|
|
78
|
-
/**
|
|
80
|
+
/** Request parameters for the {@linkcode InfoClient.userFillsByTime} method. */
|
|
79
81
|
export type UserFillsByTimeParameters = Omit<UserFillsByTimeRequest, "type">;
|
|
80
|
-
/**
|
|
82
|
+
/** Request parameters for the {@linkcode InfoClient.userFunding} method. */
|
|
81
83
|
export type UserFundingParameters = Omit<UserFundingRequest, "type">;
|
|
82
|
-
/**
|
|
84
|
+
/** Request parameters for the {@linkcode InfoClient.userNonFundingLedgerUpdates} method. */
|
|
83
85
|
export type UserNonFundingLedgerUpdatesParameters = Omit<UserNonFundingLedgerUpdatesRequest, "type">;
|
|
84
|
-
/**
|
|
86
|
+
/** Request parameters for the {@linkcode InfoClient.userRateLimit} method. */
|
|
85
87
|
export type UserRateLimitParameters = Omit<UserRateLimitRequest, "type">;
|
|
86
|
-
/**
|
|
88
|
+
/** Request parameters for the {@linkcode InfoClient.userRole} method. */
|
|
87
89
|
export type UserRoleParameters = Omit<UserRoleRequest, "type">;
|
|
88
|
-
/**
|
|
90
|
+
/** Request parameters for the {@linkcode InfoClient.userToMultiSigSigners} method. */
|
|
89
91
|
export type UserToMultiSigSignersParameters = Omit<UserToMultiSigSignersRequest, "type">;
|
|
90
|
-
/**
|
|
92
|
+
/** Request parameters for the {@linkcode InfoClient.userTwapSliceFills} method. */
|
|
91
93
|
export type UserTwapSliceFillsParameters = Omit<UserTwapSliceFillsRequest, "type">;
|
|
92
|
-
/**
|
|
94
|
+
/** Request parameters for the {@linkcode InfoClient.userTwapSliceFillsByTime} method. */
|
|
93
95
|
export type UserTwapSliceFillsByTimeParameters = Omit<UserTwapSliceFillsByTimeRequest, "type">;
|
|
94
|
-
/**
|
|
96
|
+
/** Request parameters for the {@linkcode InfoClient.userVaultEquities} method. */
|
|
95
97
|
export type UserVaultEquitiesParameters = Omit<UserVaultEquitiesRequest, "type">;
|
|
96
|
-
/**
|
|
98
|
+
/** Request parameters for the {@linkcode InfoClient.vaultDetails} method. */
|
|
97
99
|
export type VaultDetailsParameters = Omit<VaultDetailsRequest, "type">;
|
|
98
100
|
/**
|
|
99
101
|
* Info client for interacting with the Hyperliquid API.
|
|
@@ -114,9 +116,30 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
114
116
|
* ```
|
|
115
117
|
*/
|
|
116
118
|
constructor(args: InfoClientParameters<T>);
|
|
119
|
+
/**
|
|
120
|
+
* Request user active asset data.
|
|
121
|
+
* @param params - An optional request-specific parameters.
|
|
122
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
123
|
+
* @returns User active asset data.
|
|
124
|
+
*
|
|
125
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
126
|
+
*
|
|
127
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-active-asset-data
|
|
128
|
+
* @example
|
|
129
|
+
* ```ts
|
|
130
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
131
|
+
*
|
|
132
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
133
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
134
|
+
*
|
|
135
|
+
* const data = await infoClient.activeAssetData({ user: "0x...", coin: "BTC" });
|
|
136
|
+
* ```
|
|
137
|
+
*/
|
|
138
|
+
activeAssetData(params: DeepImmutable<ActiveAssetDataParameters>, signal?: AbortSignal): Promise<ActiveAssetData>;
|
|
117
139
|
/**
|
|
118
140
|
* Request mid coin prices.
|
|
119
|
-
* @param
|
|
141
|
+
* @param params - An optional request-specific parameters.
|
|
142
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
120
143
|
* @returns Mapping of coin symbols to mid prices.
|
|
121
144
|
*
|
|
122
145
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -132,12 +155,12 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
132
155
|
* const data = await infoClient.allMids();
|
|
133
156
|
* ```
|
|
134
157
|
*/
|
|
135
|
-
allMids(
|
|
158
|
+
allMids(params?: DeepImmutable<AllMidsParameters>, signal?: AbortSignal): Promise<AllMids>;
|
|
136
159
|
allMids(signal?: AbortSignal): Promise<AllMids>;
|
|
137
160
|
/**
|
|
138
161
|
* Block details by block height.
|
|
139
|
-
* @param
|
|
140
|
-
* @param signal - An
|
|
162
|
+
* @param params - Request-specific parameters.
|
|
163
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
141
164
|
* @returns Block details.
|
|
142
165
|
*
|
|
143
166
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -147,17 +170,19 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
147
170
|
* ```ts
|
|
148
171
|
* import * as hl from "@nktkas/hyperliquid";
|
|
149
172
|
*
|
|
150
|
-
* const transport = new hl.HttpTransport(); //
|
|
173
|
+
* const transport = new hl.HttpTransport(); // only `HttpTransport` supports this method
|
|
151
174
|
* const infoClient = new hl.InfoClient({ transport });
|
|
152
175
|
*
|
|
153
176
|
* const data = await infoClient.blockDetails({ height: 123 });
|
|
154
177
|
* ```
|
|
155
178
|
*/
|
|
156
|
-
blockDetails(
|
|
179
|
+
blockDetails(this: T extends {
|
|
180
|
+
request(endpoint: "explorer", ...args: unknown[]): unknown;
|
|
181
|
+
} ? this : never, params: DeepImmutable<BlockDetailsParameters>, signal?: AbortSignal): Promise<BlockDetails>;
|
|
157
182
|
/**
|
|
158
183
|
* Request candlestick snapshots.
|
|
159
|
-
* @param
|
|
160
|
-
* @param signal - An
|
|
184
|
+
* @param params - Request-specific parameters.
|
|
185
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
161
186
|
* @returns Array of candlestick data points.
|
|
162
187
|
*
|
|
163
188
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -177,11 +202,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
177
202
|
* });
|
|
178
203
|
* ```
|
|
179
204
|
*/
|
|
180
|
-
candleSnapshot(
|
|
205
|
+
candleSnapshot(params: DeepImmutable<CandleSnapshotParameters>, signal?: AbortSignal): Promise<Candle[]>;
|
|
181
206
|
/**
|
|
182
207
|
* Request clearinghouse state.
|
|
183
|
-
* @param
|
|
184
|
-
* @param signal - An
|
|
208
|
+
* @param params - Request-specific parameters.
|
|
209
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
185
210
|
* @returns Account summary for perpetual trading.
|
|
186
211
|
*
|
|
187
212
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -197,11 +222,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
197
222
|
* const data = await infoClient.clearinghouseState({ user: "0x..." });
|
|
198
223
|
* ```
|
|
199
224
|
*/
|
|
200
|
-
clearinghouseState(
|
|
225
|
+
clearinghouseState(params: DeepImmutable<ClearinghouseStateParameters>, signal?: AbortSignal): Promise<PerpsClearinghouseState>;
|
|
201
226
|
/**
|
|
202
227
|
* Request user staking delegations.
|
|
203
|
-
* @param
|
|
204
|
-
* @param signal - An
|
|
228
|
+
* @param params - Request-specific parameters.
|
|
229
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
205
230
|
* @returns Array of user's delegations to validators.
|
|
206
231
|
*
|
|
207
232
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -217,11 +242,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
217
242
|
* const data = await infoClient.delegations({ user: "0x..." });
|
|
218
243
|
* ```
|
|
219
244
|
*/
|
|
220
|
-
delegations(
|
|
245
|
+
delegations(params: DeepImmutable<DelegationsParameters>, signal?: AbortSignal): Promise<Delegation[]>;
|
|
221
246
|
/**
|
|
222
247
|
* Request user staking history.
|
|
223
|
-
* @param
|
|
224
|
-
* @param signal - An
|
|
248
|
+
* @param params - Request-specific parameters.
|
|
249
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
225
250
|
* @returns Array of user's staking updates.
|
|
226
251
|
*
|
|
227
252
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -237,11 +262,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
237
262
|
* const data = await infoClient.delegatorHistory({ user: "0x..." });
|
|
238
263
|
* ```
|
|
239
264
|
*/
|
|
240
|
-
delegatorHistory(
|
|
265
|
+
delegatorHistory(params: DeepImmutable<DelegatorHistoryParameters>, signal?: AbortSignal): Promise<DelegatorUpdate[]>;
|
|
241
266
|
/**
|
|
242
267
|
* Request user staking rewards.
|
|
243
|
-
* @param
|
|
244
|
-
* @param signal - An
|
|
268
|
+
* @param params - Request-specific parameters.
|
|
269
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
245
270
|
* @returns Array of user's staking rewards.
|
|
246
271
|
*
|
|
247
272
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -257,11 +282,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
257
282
|
* const data = await infoClient.delegatorRewards({ user: "0x..." });
|
|
258
283
|
* ```
|
|
259
284
|
*/
|
|
260
|
-
delegatorRewards(
|
|
285
|
+
delegatorRewards(params: DeepImmutable<DelegatorRewardsParameters>, signal?: AbortSignal): Promise<DelegatorReward[]>;
|
|
261
286
|
/**
|
|
262
287
|
* Request user staking summary.
|
|
263
|
-
* @param
|
|
264
|
-
* @param signal - An
|
|
288
|
+
* @param params - Request-specific parameters.
|
|
289
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
265
290
|
* @returns Summary of a user's staking delegations.
|
|
266
291
|
*
|
|
267
292
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -277,11 +302,30 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
277
302
|
* const data = await infoClient.delegatorSummary({ user: "0x..." });
|
|
278
303
|
* ```
|
|
279
304
|
*/
|
|
280
|
-
delegatorSummary(
|
|
305
|
+
delegatorSummary(params: DeepImmutable<DelegatorSummaryParameters>, signal?: AbortSignal): Promise<DelegatorSummary>;
|
|
306
|
+
/**
|
|
307
|
+
* Request exchange status information.
|
|
308
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
309
|
+
* @returns Exchange system status information.
|
|
310
|
+
*
|
|
311
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
312
|
+
*
|
|
313
|
+
* @see null
|
|
314
|
+
* @example
|
|
315
|
+
* ```ts
|
|
316
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
317
|
+
*
|
|
318
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
319
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
320
|
+
*
|
|
321
|
+
* const data = await infoClient.exchangeStatus();
|
|
322
|
+
* ```
|
|
323
|
+
*/
|
|
324
|
+
exchangeStatus(signal?: AbortSignal): Promise<ExchangeStatus>;
|
|
281
325
|
/**
|
|
282
326
|
* Request user's extra agents.
|
|
283
|
-
* @param
|
|
284
|
-
* @param signal - An
|
|
327
|
+
* @param params - Request-specific parameters.
|
|
328
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
285
329
|
* @returns User's extra agents.
|
|
286
330
|
*
|
|
287
331
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -297,11 +341,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
297
341
|
* const data = await infoClient.extraAgents({ user: "0x..." });
|
|
298
342
|
* ```
|
|
299
343
|
*/
|
|
300
|
-
extraAgents(
|
|
344
|
+
extraAgents(params: DeepImmutable<ExtraAgentsParameters>, signal?: AbortSignal): Promise<ExtraAgent[]>;
|
|
301
345
|
/**
|
|
302
346
|
* Request frontend open orders.
|
|
303
|
-
* @param
|
|
304
|
-
* @param signal - An
|
|
347
|
+
* @param params - Request-specific parameters.
|
|
348
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
305
349
|
* @returns Array of open orders with additional frontend information.
|
|
306
350
|
*
|
|
307
351
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -317,11 +361,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
317
361
|
* const data = await infoClient.frontendOpenOrders({ user: "0x..." });
|
|
318
362
|
* ```
|
|
319
363
|
*/
|
|
320
|
-
frontendOpenOrders(
|
|
364
|
+
frontendOpenOrders(params: DeepImmutable<FrontendOpenOrdersParameters>, signal?: AbortSignal): Promise<FrontendOrder[]>;
|
|
321
365
|
/**
|
|
322
366
|
* Request funding history.
|
|
323
|
-
* @param
|
|
324
|
-
* @param signal - An
|
|
367
|
+
* @param params - Request-specific parameters.
|
|
368
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
325
369
|
* @returns Array of historical funding rate data for an asset.
|
|
326
370
|
*
|
|
327
371
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -340,11 +384,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
340
384
|
* });
|
|
341
385
|
* ```
|
|
342
386
|
*/
|
|
343
|
-
fundingHistory(
|
|
387
|
+
fundingHistory(params: DeepImmutable<FundingHistoryParameters>, signal?: AbortSignal): Promise<FundingHistory[]>;
|
|
344
388
|
/**
|
|
345
389
|
* Request user's historical orders.
|
|
346
|
-
* @param
|
|
347
|
-
* @param signal - An
|
|
390
|
+
* @param params - Request-specific parameters.
|
|
391
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
348
392
|
* @returns Array of user's historical orders.
|
|
349
393
|
*
|
|
350
394
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -360,11 +404,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
360
404
|
* const data = await infoClient.historicalOrders({ user: "0x..." });
|
|
361
405
|
* ```
|
|
362
406
|
*/
|
|
363
|
-
historicalOrders(
|
|
407
|
+
historicalOrders(params: DeepImmutable<HistoricalOrdersParameters>, signal?: AbortSignal): Promise<OrderStatus<FrontendOrder>[]>;
|
|
364
408
|
/**
|
|
365
409
|
* Request to check if a user is a VIP.
|
|
366
|
-
* @param
|
|
367
|
-
* @param signal - An
|
|
410
|
+
* @param params - Request-specific parameters.
|
|
411
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
368
412
|
* @returns Boolean indicating user's VIP status.
|
|
369
413
|
*
|
|
370
414
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -380,11 +424,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
380
424
|
* const data = await infoClient.isVip({ user: "0x..." });
|
|
381
425
|
* ```
|
|
382
426
|
*/
|
|
383
|
-
isVip(
|
|
427
|
+
isVip(params: DeepImmutable<IsVipParameters>, signal?: AbortSignal): Promise<boolean | null>;
|
|
384
428
|
/**
|
|
385
429
|
* Request L2 order book.
|
|
386
|
-
* @param
|
|
387
|
-
* @param signal - An
|
|
430
|
+
* @param params - Request-specific parameters.
|
|
431
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
388
432
|
* @returns L2 order book snapshot.
|
|
389
433
|
*
|
|
390
434
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -400,11 +444,31 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
400
444
|
* const data = await infoClient.l2Book({ coin: "ETH", nSigFigs: 2 });
|
|
401
445
|
* ```
|
|
402
446
|
*/
|
|
403
|
-
l2Book(
|
|
447
|
+
l2Book(params: DeepImmutable<L2BookParameters>, signal?: AbortSignal): Promise<Book>;
|
|
448
|
+
/**
|
|
449
|
+
* Request leading vaults for a user.
|
|
450
|
+
* @param params - Request-specific parameters.
|
|
451
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
452
|
+
* @returns
|
|
453
|
+
*
|
|
454
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
455
|
+
*
|
|
456
|
+
* @see null
|
|
457
|
+
* @example
|
|
458
|
+
* ```ts
|
|
459
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
460
|
+
*
|
|
461
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
462
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
463
|
+
*
|
|
464
|
+
* const data = await infoClient.leadingVaults({ user: "0x..." });
|
|
465
|
+
* ```
|
|
466
|
+
*/
|
|
467
|
+
leadingVaults(params: DeepImmutable<LeadingVaultsParameters>, signal?: AbortSignal): Promise<VaultLeading[]>;
|
|
404
468
|
/**
|
|
405
469
|
* Request legal verification status of a user.
|
|
406
|
-
* @param
|
|
407
|
-
* @param signal - An
|
|
470
|
+
* @param params - Request-specific parameters.
|
|
471
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
408
472
|
* @returns Legal verification status for a user.
|
|
409
473
|
*
|
|
410
474
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -420,11 +484,50 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
420
484
|
* const data = await infoClient.legalCheck({ user: "0x..." });
|
|
421
485
|
* ```
|
|
422
486
|
*/
|
|
423
|
-
legalCheck(
|
|
487
|
+
legalCheck(params: DeepImmutable<LegalCheckParameters>, signal?: AbortSignal): Promise<LegalCheck>;
|
|
488
|
+
/**
|
|
489
|
+
* Request liquidatable.
|
|
490
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
491
|
+
* @returns
|
|
492
|
+
*
|
|
493
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
494
|
+
*
|
|
495
|
+
* @see null
|
|
496
|
+
* @example
|
|
497
|
+
* ```ts
|
|
498
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
499
|
+
*
|
|
500
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
501
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
502
|
+
*
|
|
503
|
+
* const data = await infoClient.liquidatable();
|
|
504
|
+
* ```
|
|
505
|
+
*/
|
|
506
|
+
liquidatable(signal?: AbortSignal): Promise<unknown[]>;
|
|
507
|
+
/**
|
|
508
|
+
* Request margin table data.
|
|
509
|
+
* @param params - Request-specific parameters.
|
|
510
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
511
|
+
* @returns Margin requirements table with multiple tiers.
|
|
512
|
+
*
|
|
513
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
514
|
+
*
|
|
515
|
+
* @see null
|
|
516
|
+
* @example
|
|
517
|
+
* ```ts
|
|
518
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
519
|
+
*
|
|
520
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
521
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
522
|
+
*
|
|
523
|
+
* const data = await infoClient.marginTable({ id: 1 });
|
|
524
|
+
* ```
|
|
525
|
+
*/
|
|
526
|
+
marginTable(params: DeepImmutable<MarginTableParameters>, signal?: AbortSignal): Promise<MarginTable>;
|
|
424
527
|
/**
|
|
425
528
|
* Request builder fee approval.
|
|
426
|
-
* @param
|
|
427
|
-
* @param signal - An
|
|
529
|
+
* @param params - Request-specific parameters.
|
|
530
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
428
531
|
* @returns Maximum builder fee approval.
|
|
429
532
|
*
|
|
430
533
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -440,10 +543,30 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
440
543
|
* const data = await infoClient.maxBuilderFee({ user: "0x...", builder: "0x..." });
|
|
441
544
|
* ```
|
|
442
545
|
*/
|
|
443
|
-
maxBuilderFee(
|
|
546
|
+
maxBuilderFee(params: DeepImmutable<MaxBuilderFeeParameters>, signal?: AbortSignal): Promise<number>;
|
|
547
|
+
/**
|
|
548
|
+
* Request maximum market order notionals.
|
|
549
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
550
|
+
* @returns
|
|
551
|
+
*
|
|
552
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
553
|
+
*
|
|
554
|
+
* @see null
|
|
555
|
+
* @example
|
|
556
|
+
* ```ts
|
|
557
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
558
|
+
*
|
|
559
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
560
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
561
|
+
*
|
|
562
|
+
* const data = await infoClient.maxMarketOrderNtls();
|
|
563
|
+
* ```
|
|
564
|
+
*/
|
|
565
|
+
maxMarketOrderNtls(signal?: AbortSignal): Promise<[number, string][]>;
|
|
444
566
|
/**
|
|
445
567
|
* Request trading metadata.
|
|
446
|
-
* @param
|
|
568
|
+
* @param params - An optional request-specific parameters.
|
|
569
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
447
570
|
* @returns Metadata for perpetual assets.
|
|
448
571
|
*
|
|
449
572
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -459,11 +582,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
459
582
|
* const data = await infoClient.meta();
|
|
460
583
|
* ```
|
|
461
584
|
*/
|
|
462
|
-
meta(
|
|
585
|
+
meta(params?: DeepImmutable<MetaParameters>, signal?: AbortSignal): Promise<PerpsMeta>;
|
|
463
586
|
meta(signal?: AbortSignal): Promise<PerpsMeta>;
|
|
464
587
|
/**
|
|
465
588
|
* Request metadata and asset contexts.
|
|
466
|
-
* @param signal - An
|
|
589
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
467
590
|
* @returns Metadata and context for perpetual assets.
|
|
468
591
|
*
|
|
469
592
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -482,8 +605,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
482
605
|
metaAndAssetCtxs(signal?: AbortSignal): Promise<PerpsMetaAndAssetCtxs>;
|
|
483
606
|
/**
|
|
484
607
|
* Request open orders.
|
|
485
|
-
* @param
|
|
486
|
-
* @param signal - An
|
|
608
|
+
* @param params - Request-specific parameters.
|
|
609
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
487
610
|
* @returns Array of open order.
|
|
488
611
|
*
|
|
489
612
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -499,11 +622,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
499
622
|
* const data = await infoClient.openOrders({ user: "0x..." });
|
|
500
623
|
* ```
|
|
501
624
|
*/
|
|
502
|
-
openOrders(
|
|
625
|
+
openOrders(params: DeepImmutable<OpenOrdersParameters>, signal?: AbortSignal): Promise<Order[]>;
|
|
503
626
|
/**
|
|
504
627
|
* Request order status.
|
|
505
|
-
* @param
|
|
506
|
-
* @param signal - An
|
|
628
|
+
* @param params - Request-specific parameters.
|
|
629
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
507
630
|
* @returns Result of an order status lookup.
|
|
508
631
|
*
|
|
509
632
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -519,10 +642,10 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
519
642
|
* const data = await infoClient.orderStatus({ user: "0x...", oid: 12345 });
|
|
520
643
|
* ```
|
|
521
644
|
*/
|
|
522
|
-
orderStatus(
|
|
645
|
+
orderStatus(params: DeepImmutable<OrderStatusParameters>, signal?: AbortSignal): Promise<OrderLookup>;
|
|
523
646
|
/**
|
|
524
647
|
* Request for the status of the perpetual deploy auction.
|
|
525
|
-
* @param signal - An
|
|
648
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
526
649
|
* @returns Status of the perpetual deploy auction.
|
|
527
650
|
*
|
|
528
651
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -541,7 +664,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
541
664
|
perpDeployAuctionStatus(signal?: AbortSignal): Promise<DeployAuctionStatus>;
|
|
542
665
|
/**
|
|
543
666
|
* Request all perpetual dexs.
|
|
544
|
-
* @param signal - An
|
|
667
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
545
668
|
* @returns Array of perpetual dexes (null is main dex).
|
|
546
669
|
*
|
|
547
670
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -560,8 +683,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
560
683
|
perpDexs(signal?: AbortSignal): Promise<(PerpDex | null)[]>;
|
|
561
684
|
/**
|
|
562
685
|
* Request perpetuals at open interest cap.
|
|
563
|
-
* @param
|
|
564
|
-
* @param signal - An optional abort signal.
|
|
686
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
565
687
|
* @returns Array of perpetuals at open interest caps.
|
|
566
688
|
*
|
|
567
689
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -580,8 +702,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
580
702
|
perpsAtOpenInterestCap(signal?: AbortSignal): Promise<string[]>;
|
|
581
703
|
/**
|
|
582
704
|
* Request user portfolio.
|
|
583
|
-
* @param
|
|
584
|
-
* @param signal - An
|
|
705
|
+
* @param params - Request-specific parameters.
|
|
706
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
585
707
|
* @returns Portfolio metrics grouped by time periods.
|
|
586
708
|
*
|
|
587
709
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -597,10 +719,10 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
597
719
|
* const data = await infoClient.portfolio({ user: "0x..." });
|
|
598
720
|
* ```
|
|
599
721
|
*/
|
|
600
|
-
portfolio(
|
|
722
|
+
portfolio(params: DeepImmutable<PortfolioParameters>, signal?: AbortSignal): Promise<PortfolioPeriods>;
|
|
601
723
|
/**
|
|
602
724
|
* Request predicted funding rates.
|
|
603
|
-
* @param signal - An
|
|
725
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
604
726
|
* @returns Array of predicted funding rates.
|
|
605
727
|
*
|
|
606
728
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -619,8 +741,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
619
741
|
predictedFundings(signal?: AbortSignal): Promise<PredictedFunding[]>;
|
|
620
742
|
/**
|
|
621
743
|
* Request user's existence check before transfer.
|
|
622
|
-
* @param
|
|
623
|
-
* @param signal - An
|
|
744
|
+
* @param params - Request-specific parameters.
|
|
745
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
624
746
|
* @returns Pre-transfer user existence check result.
|
|
625
747
|
*
|
|
626
748
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -636,11 +758,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
636
758
|
* const data = await infoClient.preTransferCheck({ user: "0x...", source: "0x..." });
|
|
637
759
|
* ```
|
|
638
760
|
*/
|
|
639
|
-
preTransferCheck(
|
|
761
|
+
preTransferCheck(params: DeepImmutable<PreTransferCheckParameters>, signal?: AbortSignal): Promise<PreTransferCheck>;
|
|
640
762
|
/**
|
|
641
763
|
* Request user referral.
|
|
642
|
-
* @param
|
|
643
|
-
* @param signal - An
|
|
764
|
+
* @param params - Request-specific parameters.
|
|
765
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
644
766
|
* @returns Referral information for a user.
|
|
645
767
|
*
|
|
646
768
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -656,11 +778,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
656
778
|
* const data = await infoClient.referral({ user: "0x..." });
|
|
657
779
|
* ```
|
|
658
780
|
*/
|
|
659
|
-
referral(
|
|
781
|
+
referral(params: DeepImmutable<ReferralParameters>, signal?: AbortSignal): Promise<Referral>;
|
|
660
782
|
/**
|
|
661
783
|
* Request spot clearinghouse state.
|
|
662
|
-
* @param
|
|
663
|
-
* @param signal - An
|
|
784
|
+
* @param params - Request-specific parameters.
|
|
785
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
664
786
|
* @returns Account summary for spot trading.
|
|
665
787
|
*
|
|
666
788
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -676,11 +798,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
676
798
|
* const data = await infoClient.spotClearinghouseState({ user: "0x..." });
|
|
677
799
|
* ```
|
|
678
800
|
*/
|
|
679
|
-
spotClearinghouseState(
|
|
801
|
+
spotClearinghouseState(params: DeepImmutable<SpotClearinghouseStateParameters>, signal?: AbortSignal): Promise<SpotClearinghouseState>;
|
|
680
802
|
/**
|
|
681
803
|
* Request spot deploy state.
|
|
682
|
-
* @param
|
|
683
|
-
* @param signal - An
|
|
804
|
+
* @param params - Request-specific parameters.
|
|
805
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
684
806
|
* @returns Deploy state for spot tokens.
|
|
685
807
|
*
|
|
686
808
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -696,10 +818,10 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
696
818
|
* const data = await infoClient.spotDeployState({ user: "0x..." });
|
|
697
819
|
* ```
|
|
698
820
|
*/
|
|
699
|
-
spotDeployState(
|
|
821
|
+
spotDeployState(params: DeepImmutable<SpotDeployStateParameters>, signal?: AbortSignal): Promise<SpotDeployState>;
|
|
700
822
|
/**
|
|
701
823
|
* Request spot trading metadata.
|
|
702
|
-
* @param signal - An
|
|
824
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
703
825
|
* @returns Metadata for spot assets.
|
|
704
826
|
*
|
|
705
827
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -718,7 +840,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
718
840
|
spotMeta(signal?: AbortSignal): Promise<SpotMeta>;
|
|
719
841
|
/**
|
|
720
842
|
* Request spot metadata and asset contexts.
|
|
721
|
-
* @param signal - An
|
|
843
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
722
844
|
* @returns Metadata and context for spot assets.
|
|
723
845
|
*
|
|
724
846
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -737,8 +859,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
737
859
|
spotMetaAndAssetCtxs(signal?: AbortSignal): Promise<SpotMetaAndAssetCtxs>;
|
|
738
860
|
/**
|
|
739
861
|
* Request user sub-accounts.
|
|
740
|
-
* @param
|
|
741
|
-
* @param signal - An
|
|
862
|
+
* @param params - Request-specific parameters.
|
|
863
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
742
864
|
* @returns Array of user sub-account or null if the user does not have any sub-accounts.
|
|
743
865
|
*
|
|
744
866
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -754,11 +876,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
754
876
|
* const data = await infoClient.subAccounts({ user: "0x..." });
|
|
755
877
|
* ```
|
|
756
878
|
*/
|
|
757
|
-
subAccounts(
|
|
879
|
+
subAccounts(params: DeepImmutable<SubAccountsParameters>, signal?: AbortSignal): Promise<SubAccount[] | null>;
|
|
758
880
|
/**
|
|
759
881
|
* Request token details.
|
|
760
|
-
* @param
|
|
761
|
-
* @param signal - An
|
|
882
|
+
* @param params - Request-specific parameters.
|
|
883
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
762
884
|
* @returns Details of a token.
|
|
763
885
|
*
|
|
764
886
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -774,11 +896,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
774
896
|
* const data = await infoClient.tokenDetails({ tokenId: "0x..." });
|
|
775
897
|
* ```
|
|
776
898
|
*/
|
|
777
|
-
tokenDetails(
|
|
899
|
+
tokenDetails(params: DeepImmutable<TokenDetailsParameters>, signal?: AbortSignal): Promise<TokenDetails>;
|
|
778
900
|
/**
|
|
779
901
|
* Request twap history of a user.
|
|
780
|
-
* @param
|
|
781
|
-
* @param signal - An
|
|
902
|
+
* @param params - Request-specific parameters.
|
|
903
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
782
904
|
* @returns Array of user's TWAP history.
|
|
783
905
|
*
|
|
784
906
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -794,11 +916,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
794
916
|
* const data = await infoClient.twapHistory({ user: "0x..." });
|
|
795
917
|
* ```
|
|
796
918
|
*/
|
|
797
|
-
twapHistory(
|
|
919
|
+
twapHistory(params: DeepImmutable<TwapHistoryParameters>, signal?: AbortSignal): Promise<TwapHistory[]>;
|
|
798
920
|
/**
|
|
799
921
|
* Request transaction details by transaction hash.
|
|
800
|
-
* @param
|
|
801
|
-
* @param signal - An
|
|
922
|
+
* @param params - Request-specific parameters.
|
|
923
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
802
924
|
* @returns Transaction details.
|
|
803
925
|
*
|
|
804
926
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -808,17 +930,19 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
808
930
|
* ```ts
|
|
809
931
|
* import * as hl from "@nktkas/hyperliquid";
|
|
810
932
|
*
|
|
811
|
-
* const transport = new hl.HttpTransport(); //
|
|
933
|
+
* const transport = new hl.HttpTransport(); // only `HttpTransport` supports this method
|
|
812
934
|
* const infoClient = new hl.InfoClient({ transport });
|
|
813
935
|
*
|
|
814
936
|
* const data = await infoClient.txDetails({ hash: "0x..." });
|
|
815
937
|
* ```
|
|
816
938
|
*/
|
|
817
|
-
txDetails(
|
|
939
|
+
txDetails(this: T extends {
|
|
940
|
+
request(endpoint: "explorer", ...args: unknown[]): unknown;
|
|
941
|
+
} ? this : never, params: DeepImmutable<TxDetailsParameters>, signal?: AbortSignal): Promise<TxDetails>;
|
|
818
942
|
/**
|
|
819
943
|
* Request user details by user's address.
|
|
820
|
-
* @param
|
|
821
|
-
* @param signal - An
|
|
944
|
+
* @param params - Request-specific parameters.
|
|
945
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
822
946
|
* @returns User details.
|
|
823
947
|
*
|
|
824
948
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -828,17 +952,19 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
828
952
|
* ```ts
|
|
829
953
|
* import * as hl from "@nktkas/hyperliquid";
|
|
830
954
|
*
|
|
831
|
-
* const transport = new hl.HttpTransport(); //
|
|
955
|
+
* const transport = new hl.HttpTransport(); // only `HttpTransport` supports this method
|
|
832
956
|
* const infoClient = new hl.InfoClient({ transport });
|
|
833
957
|
*
|
|
834
958
|
* const data = await infoClient.userDetails({ user: "0x..." });
|
|
835
959
|
* ```
|
|
836
960
|
*/
|
|
837
|
-
userDetails(
|
|
961
|
+
userDetails(this: T extends {
|
|
962
|
+
request(endpoint: "explorer", ...args: unknown[]): unknown;
|
|
963
|
+
} ? this : never, params: DeepImmutable<UserDetailsParameters>, signal?: AbortSignal): Promise<TxDetails[]>;
|
|
838
964
|
/**
|
|
839
965
|
* Request user fees.
|
|
840
|
-
* @param
|
|
841
|
-
* @param signal - An
|
|
966
|
+
* @param params - Request-specific parameters.
|
|
967
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
842
968
|
* @returns User fees.
|
|
843
969
|
*
|
|
844
970
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -854,11 +980,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
854
980
|
* const data = await infoClient.userFees({ user: "0x..." });
|
|
855
981
|
* ```
|
|
856
982
|
*/
|
|
857
|
-
userFees(
|
|
983
|
+
userFees(params: DeepImmutable<UserFeesParameters>, signal?: AbortSignal): Promise<UserFees>;
|
|
858
984
|
/**
|
|
859
985
|
* Request user fills.
|
|
860
|
-
* @param
|
|
861
|
-
* @param signal - An
|
|
986
|
+
* @param params - Request-specific parameters.
|
|
987
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
862
988
|
* @returns Array of user's trade fill.
|
|
863
989
|
*
|
|
864
990
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -874,11 +1000,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
874
1000
|
* const data = await infoClient.userFills({ user: "0x..." });
|
|
875
1001
|
* ```
|
|
876
1002
|
*/
|
|
877
|
-
userFills(
|
|
1003
|
+
userFills(params: DeepImmutable<UserFillsParameters>, signal?: AbortSignal): Promise<Fill[]>;
|
|
878
1004
|
/**
|
|
879
1005
|
* Request user fills by time.
|
|
880
|
-
* @param
|
|
881
|
-
* @param signal - An
|
|
1006
|
+
* @param params - Request-specific parameters.
|
|
1007
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
882
1008
|
* @returns Array of user's trade fill.
|
|
883
1009
|
*
|
|
884
1010
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -897,11 +1023,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
897
1023
|
* });
|
|
898
1024
|
* ```
|
|
899
1025
|
*/
|
|
900
|
-
userFillsByTime(
|
|
1026
|
+
userFillsByTime(params: DeepImmutable<UserFillsByTimeParameters>, signal?: AbortSignal): Promise<Fill[]>;
|
|
901
1027
|
/**
|
|
902
1028
|
* Request user funding.
|
|
903
|
-
* @param
|
|
904
|
-
* @param signal - An
|
|
1029
|
+
* @param params - Request-specific parameters.
|
|
1030
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
905
1031
|
* @returns Array of user's funding ledger update.
|
|
906
1032
|
*
|
|
907
1033
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -920,11 +1046,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
920
1046
|
* });
|
|
921
1047
|
* ```
|
|
922
1048
|
*/
|
|
923
|
-
userFunding(
|
|
1049
|
+
userFunding(params: DeepImmutable<UserFundingParameters>, signal?: AbortSignal): Promise<UserFundingUpdate[]>;
|
|
924
1050
|
/**
|
|
925
1051
|
* Request user non-funding ledger updates.
|
|
926
|
-
* @param
|
|
927
|
-
* @param signal - An
|
|
1052
|
+
* @param params - Request-specific parameters.
|
|
1053
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
928
1054
|
* @returns Array of user's non-funding ledger update.
|
|
929
1055
|
*
|
|
930
1056
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -943,11 +1069,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
943
1069
|
* });
|
|
944
1070
|
* ```
|
|
945
1071
|
*/
|
|
946
|
-
userNonFundingLedgerUpdates(
|
|
1072
|
+
userNonFundingLedgerUpdates(params: DeepImmutable<UserNonFundingLedgerUpdatesParameters>, signal?: AbortSignal): Promise<UserNonFundingLedgerUpdate[]>;
|
|
947
1073
|
/**
|
|
948
1074
|
* Request user rate limits.
|
|
949
|
-
* @param
|
|
950
|
-
* @param signal - An
|
|
1075
|
+
* @param params - Request-specific parameters.
|
|
1076
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
951
1077
|
* @returns User's rate limits.
|
|
952
1078
|
*
|
|
953
1079
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -963,11 +1089,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
963
1089
|
* const data = await infoClient.userRateLimit({ user: "0x..." });
|
|
964
1090
|
* ```
|
|
965
1091
|
*/
|
|
966
|
-
userRateLimit(
|
|
1092
|
+
userRateLimit(params: DeepImmutable<UserRateLimitParameters>, signal?: AbortSignal): Promise<UserRateLimit>;
|
|
967
1093
|
/**
|
|
968
1094
|
* Request user role.
|
|
969
|
-
* @param
|
|
970
|
-
* @param signal - An
|
|
1095
|
+
* @param params - Request-specific parameters.
|
|
1096
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
971
1097
|
* @returns User's role.
|
|
972
1098
|
*
|
|
973
1099
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -983,11 +1109,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
983
1109
|
* const data = await infoClient.userRole({ user: "0x..." });
|
|
984
1110
|
* ```
|
|
985
1111
|
*/
|
|
986
|
-
userRole(
|
|
1112
|
+
userRole(params: DeepImmutable<UserRoleParameters>, signal?: AbortSignal): Promise<UserRole>;
|
|
987
1113
|
/**
|
|
988
1114
|
* Request multi-sig signers for a user.
|
|
989
|
-
* @param
|
|
990
|
-
* @param signal - An
|
|
1115
|
+
* @param params - Request-specific parameters.
|
|
1116
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
991
1117
|
* @returns Multi-sig signers for a user or null if the user does not have any multi-sig signers.
|
|
992
1118
|
*
|
|
993
1119
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1003,11 +1129,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1003
1129
|
* const data = await infoClient.userToMultiSigSigners({ user: "0x..." });
|
|
1004
1130
|
* ```
|
|
1005
1131
|
*/
|
|
1006
|
-
userToMultiSigSigners(
|
|
1132
|
+
userToMultiSigSigners(params: DeepImmutable<UserToMultiSigSignersParameters>, signal?: AbortSignal): Promise<MultiSigSigners | null>;
|
|
1007
1133
|
/**
|
|
1008
1134
|
* Request user twap slice fills.
|
|
1009
|
-
* @param
|
|
1010
|
-
* @param signal - An
|
|
1135
|
+
* @param params - Request-specific parameters.
|
|
1136
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
1011
1137
|
* @returns Array of user's twap slice fill.
|
|
1012
1138
|
*
|
|
1013
1139
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1023,11 +1149,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1023
1149
|
* const data = await infoClient.userTwapSliceFills({ user: "0x..." });
|
|
1024
1150
|
* ```
|
|
1025
1151
|
*/
|
|
1026
|
-
userTwapSliceFills(
|
|
1152
|
+
userTwapSliceFills(params: DeepImmutable<UserTwapSliceFillsParameters>, signal?: AbortSignal): Promise<TwapSliceFill[]>;
|
|
1027
1153
|
/**
|
|
1028
1154
|
* Request user twap slice fills by time.
|
|
1029
|
-
* @param
|
|
1030
|
-
* @param signal - An
|
|
1155
|
+
* @param params - Request-specific parameters.
|
|
1156
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
1031
1157
|
* @returns Array of user's twap slice fill.
|
|
1032
1158
|
*
|
|
1033
1159
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1046,11 +1172,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1046
1172
|
* });
|
|
1047
1173
|
* ```
|
|
1048
1174
|
*/
|
|
1049
|
-
userTwapSliceFillsByTime(
|
|
1175
|
+
userTwapSliceFillsByTime(params: DeepImmutable<UserTwapSliceFillsByTimeParameters>, signal?: AbortSignal): Promise<TwapSliceFill[]>;
|
|
1050
1176
|
/**
|
|
1051
1177
|
* Request user vault deposits.
|
|
1052
|
-
* @param
|
|
1053
|
-
* @param signal - An
|
|
1178
|
+
* @param params - Request-specific parameters.
|
|
1179
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
1054
1180
|
* @returns Array of user's vault deposits.
|
|
1055
1181
|
*
|
|
1056
1182
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1066,10 +1192,29 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1066
1192
|
* const data = await infoClient.userVaultEquities({ user: "0x..." });
|
|
1067
1193
|
* ```
|
|
1068
1194
|
*/
|
|
1069
|
-
userVaultEquities(
|
|
1195
|
+
userVaultEquities(params: DeepImmutable<UserVaultEquitiesParameters>, signal?: AbortSignal): Promise<VaultEquity[]>;
|
|
1196
|
+
/**
|
|
1197
|
+
* Request validator L1 votes.
|
|
1198
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
1199
|
+
* @returns
|
|
1200
|
+
*
|
|
1201
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1202
|
+
*
|
|
1203
|
+
* @see null
|
|
1204
|
+
* @example
|
|
1205
|
+
* ```ts
|
|
1206
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
1207
|
+
*
|
|
1208
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
1209
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
1210
|
+
*
|
|
1211
|
+
* const data = await infoClient.validatorL1Votes();
|
|
1212
|
+
* ```
|
|
1213
|
+
*/
|
|
1214
|
+
validatorL1Votes(signal?: AbortSignal): Promise<unknown[]>;
|
|
1070
1215
|
/**
|
|
1071
1216
|
* Request validator summaries.
|
|
1072
|
-
* @param
|
|
1217
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
1073
1218
|
* @returns Array of validator summaries.
|
|
1074
1219
|
*
|
|
1075
1220
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1088,8 +1233,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1088
1233
|
validatorSummaries(signal?: AbortSignal): Promise<ValidatorSummary[]>;
|
|
1089
1234
|
/**
|
|
1090
1235
|
* Request details of a vault.
|
|
1091
|
-
* @param
|
|
1092
|
-
* @param signal - An
|
|
1236
|
+
* @param params - Request-specific parameters.
|
|
1237
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
1093
1238
|
* @returns Details of a vault or null if the vault does not exist.
|
|
1094
1239
|
*
|
|
1095
1240
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1105,11 +1250,10 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1105
1250
|
* const data = await infoClient.vaultDetails({ vaultAddress: "0x..." });
|
|
1106
1251
|
* ```
|
|
1107
1252
|
*/
|
|
1108
|
-
vaultDetails(
|
|
1253
|
+
vaultDetails(params: DeepImmutable<VaultDetailsParameters>, signal?: AbortSignal): Promise<VaultDetails | null>;
|
|
1109
1254
|
/**
|
|
1110
1255
|
* Request a list of vaults less than 2 hours old.
|
|
1111
|
-
* @param
|
|
1112
|
-
* @param signal - An optional abort signal.
|
|
1256
|
+
* @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
|
|
1113
1257
|
* @returns Array of vault summaries.
|
|
1114
1258
|
*
|
|
1115
1259
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1128,4 +1272,5 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1128
1272
|
vaultSummaries(signal?: AbortSignal): Promise<VaultSummary[]>;
|
|
1129
1273
|
[Symbol.asyncDispose](): Promise<void>;
|
|
1130
1274
|
}
|
|
1275
|
+
export {};
|
|
1131
1276
|
//# sourceMappingURL=info.d.ts.map
|