@nktkas/hyperliquid 0.22.2 → 0.23.1
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 +79 -67
- package/esm/mod.d.ts +1 -1
- package/esm/mod.d.ts.map +1 -1
- package/esm/src/base.d.ts +4 -1
- package/esm/src/base.d.ts.map +1 -1
- package/esm/src/base.js +2 -2
- package/esm/src/clients/exchange.d.ts +289 -207
- package/esm/src/clients/exchange.d.ts.map +1 -1
- package/esm/src/clients/exchange.js +605 -410
- package/esm/src/clients/info.d.ts +264 -48
- package/esm/src/clients/info.d.ts.map +1 -1
- package/esm/src/clients/info.js +273 -31
- package/esm/src/clients/multiSign.d.ts +285 -204
- package/esm/src/clients/multiSign.d.ts.map +1 -1
- package/esm/src/clients/multiSign.js +521 -493
- package/esm/src/clients/subscription.d.ts +38 -3
- package/esm/src/clients/subscription.d.ts.map +1 -1
- package/esm/src/clients/subscription.js +36 -3
- package/esm/src/signing/{_ethers.d.ts → _signTypedData/ethers.d.ts} +1 -1
- package/esm/src/signing/_signTypedData/ethers.d.ts.map +1 -0
- package/esm/src/signing/_signTypedData/mod.d.ts +35 -0
- package/esm/src/signing/_signTypedData/mod.d.ts.map +1 -0
- package/esm/src/signing/_signTypedData/mod.js +59 -0
- package/esm/src/signing/_signTypedData/private_key.d.ts +26 -0
- package/esm/src/signing/_signTypedData/private_key.d.ts.map +1 -0
- package/esm/src/signing/_signTypedData/private_key.js +144 -0
- package/esm/src/signing/{_viem.d.ts → _signTypedData/viem.d.ts} +2 -2
- package/esm/src/signing/_signTypedData/viem.d.ts.map +1 -0
- package/{script/src/signing/_window.d.ts → esm/src/signing/_signTypedData/window.d.ts} +18 -12
- package/esm/src/signing/_signTypedData/window.d.ts.map +1 -0
- package/esm/src/signing/{_window.js → _signTypedData/window.js} +3 -2
- package/esm/src/signing/_sorter.d.ts +56 -82
- package/esm/src/signing/_sorter.d.ts.map +1 -1
- package/esm/src/signing/_sorter.js +36 -49
- package/esm/src/signing/mod.d.ts +151 -130
- package/esm/src/signing/mod.d.ts.map +1 -1
- package/esm/src/signing/mod.js +182 -228
- package/esm/src/transports/base.d.ts +1 -1
- package/esm/src/transports/base.d.ts.map +1 -1
- package/esm/src/transports/base.js +2 -2
- package/esm/src/transports/http/http_transport.d.ts +9 -15
- package/esm/src/transports/http/http_transport.d.ts.map +1 -1
- package/esm/src/transports/http/http_transport.js +64 -59
- package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts +1 -1
- package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
- package/esm/src/transports/websocket/_hyperliquid_event_target.js +1 -1
- package/esm/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -1
- package/esm/src/transports/websocket/_reconnecting_websocket.js +17 -4
- package/esm/src/transports/websocket/_websocket_async_request.d.ts +0 -9
- package/esm/src/transports/websocket/_websocket_async_request.d.ts.map +1 -1
- package/esm/src/transports/websocket/_websocket_async_request.js +14 -20
- package/esm/src/transports/websocket/websocket_transport.d.ts +8 -4
- package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/esm/src/transports/websocket/websocket_transport.js +83 -54
- package/esm/src/types/exchange/requests.d.ts +27 -51
- package/esm/src/types/exchange/requests.d.ts.map +1 -1
- package/esm/src/types/explorer/requests.d.ts +5 -8
- package/esm/src/types/explorer/requests.d.ts.map +1 -1
- package/esm/src/types/info/accounts.d.ts +5 -5
- package/esm/src/types/info/accounts.d.ts.map +1 -1
- package/esm/src/types/info/markets.d.ts +6 -0
- package/esm/src/types/info/markets.d.ts.map +1 -1
- package/esm/src/types/info/orders.d.ts +1 -1
- package/esm/src/types/info/orders.d.ts.map +1 -1
- package/esm/src/types/info/requests.d.ts +129 -124
- 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} +2 -2
- package/esm/src/types/info/validators.d.ts.map +1 -0
- package/esm/src/types/info/vaults.d.ts +7 -0
- package/esm/src/types/info/vaults.d.ts.map +1 -1
- package/esm/src/types/mod.d.ts +1 -1
- package/esm/src/types/mod.d.ts.map +1 -1
- package/esm/src/types/subscriptions/requests.d.ts +72 -18
- package/esm/src/types/subscriptions/requests.d.ts.map +1 -1
- package/esm/src/types/subscriptions/responses.d.ts +2 -0
- package/esm/src/types/subscriptions/responses.d.ts.map +1 -1
- package/package.json +8 -5
- package/script/mod.d.ts +1 -1
- package/script/mod.d.ts.map +1 -1
- package/script/mod.js +13 -23
- package/script/src/base.d.ts +4 -1
- package/script/src/base.d.ts.map +1 -1
- package/script/src/base.js +10 -20
- package/script/src/clients/exchange.d.ts +289 -207
- package/script/src/clients/exchange.d.ts.map +1 -1
- package/script/src/clients/exchange.js +2000 -1815
- package/script/src/clients/info.d.ts +264 -48
- package/script/src/clients/info.d.ts.map +1 -1
- package/script/src/clients/info.js +1442 -1210
- package/script/src/clients/multiSign.d.ts +285 -204
- package/script/src/clients/multiSign.d.ts.map +1 -1
- package/script/src/clients/multiSign.js +2043 -2025
- package/script/src/clients/subscription.d.ts +38 -3
- package/script/src/clients/subscription.d.ts.map +1 -1
- package/script/src/clients/subscription.js +568 -545
- package/script/src/signing/{_ethers.d.ts → _signTypedData/ethers.d.ts} +1 -1
- package/script/src/signing/_signTypedData/ethers.d.ts.map +1 -0
- package/script/src/signing/_signTypedData/ethers.js +16 -0
- package/script/src/signing/_signTypedData/mod.d.ts +35 -0
- package/script/src/signing/_signTypedData/mod.d.ts.map +1 -0
- package/script/src/signing/_signTypedData/mod.js +67 -0
- package/script/src/signing/_signTypedData/private_key.d.ts +26 -0
- package/script/src/signing/_signTypedData/private_key.d.ts.map +1 -0
- package/script/src/signing/_signTypedData/private_key.js +148 -0
- package/script/src/signing/{_viem.d.ts → _signTypedData/viem.d.ts} +2 -2
- package/script/src/signing/_signTypedData/viem.d.ts.map +1 -0
- package/script/src/signing/_signTypedData/viem.js +9 -0
- package/{esm/src/signing/_window.d.ts → script/src/signing/_signTypedData/window.d.ts} +18 -12
- package/script/src/signing/_signTypedData/window.d.ts.map +1 -0
- package/script/src/signing/_signTypedData/window.js +34 -0
- package/script/src/signing/_sorter.d.ts +56 -82
- package/script/src/signing/_sorter.d.ts.map +1 -1
- package/script/src/signing/_sorter.js +655 -678
- package/script/src/signing/mod.d.ts +151 -130
- package/script/src/signing/mod.d.ts.map +1 -1
- package/script/src/signing/mod.js +286 -342
- package/script/src/transports/base.d.ts +1 -1
- package/script/src/transports/base.d.ts.map +1 -1
- package/script/src/transports/base.js +11 -21
- package/script/src/transports/http/http_transport.d.ts +9 -15
- package/script/src/transports/http/http_transport.d.ts.map +1 -1
- package/script/src/transports/http/http_transport.js +97 -102
- package/script/src/transports/websocket/_hyperliquid_event_target.d.ts +1 -1
- package/script/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
- package/script/src/transports/websocket/_hyperliquid_event_target.js +51 -61
- package/script/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -1
- package/script/src/transports/websocket/_reconnecting_websocket.js +271 -268
- package/script/src/transports/websocket/_websocket_async_request.d.ts +0 -9
- package/script/src/transports/websocket/_websocket_async_request.d.ts.map +1 -1
- package/script/src/transports/websocket/_websocket_async_request.js +157 -174
- package/script/src/transports/websocket/websocket_transport.d.ts +8 -4
- package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/script/src/transports/websocket/websocket_transport.js +209 -189
- package/script/src/types/exchange/requests.d.ts +27 -51
- package/script/src/types/exchange/requests.d.ts.map +1 -1
- package/script/src/types/exchange/requests.js +2 -12
- package/script/src/types/exchange/responses.js +2 -12
- package/script/src/types/explorer/requests.d.ts +5 -8
- package/script/src/types/explorer/requests.d.ts.map +1 -1
- package/script/src/types/explorer/requests.js +2 -12
- package/script/src/types/explorer/responses.js +2 -12
- package/script/src/types/info/accounts.d.ts +5 -5
- package/script/src/types/info/accounts.d.ts.map +1 -1
- package/script/src/types/info/accounts.js +2 -12
- package/script/src/types/info/assets.js +2 -12
- package/script/src/types/info/markets.d.ts +6 -0
- package/script/src/types/info/markets.d.ts.map +1 -1
- package/script/src/types/info/markets.js +2 -12
- package/script/src/types/info/orders.d.ts +1 -1
- package/script/src/types/info/orders.d.ts.map +1 -1
- package/script/src/types/info/orders.js +2 -12
- package/script/src/types/info/requests.d.ts +129 -124
- package/script/src/types/info/requests.d.ts.map +1 -1
- package/script/src/types/info/requests.js +2 -12
- package/{esm/src/types/info/delegations.d.ts → script/src/types/info/validators.d.ts} +2 -2
- package/script/src/types/info/validators.d.ts.map +1 -0
- package/script/src/types/info/validators.js +2 -0
- package/script/src/types/info/vaults.d.ts +7 -0
- package/script/src/types/info/vaults.d.ts.map +1 -1
- package/script/src/types/info/vaults.js +2 -12
- package/script/src/types/mod.d.ts +1 -1
- package/script/src/types/mod.d.ts.map +1 -1
- package/script/src/types/mod.js +2 -12
- package/script/src/types/subscriptions/requests.d.ts +72 -18
- package/script/src/types/subscriptions/requests.d.ts.map +1 -1
- package/script/src/types/subscriptions/requests.js +2 -12
- package/script/src/types/subscriptions/responses.d.ts +2 -0
- package/script/src/types/subscriptions/responses.d.ts.map +1 -1
- package/script/src/types/subscriptions/responses.js +2 -12
- package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.d.ts +0 -2
- package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.d.ts.map +0 -1
- package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.js +0 -1
- package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.d.ts +0 -95
- package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.d.ts.map +0 -1
- package/esm/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.js +0 -10
- package/esm/deps/jsr.io/@std/async/1.0.13/delay.d.ts +0 -43
- package/esm/deps/jsr.io/@std/async/1.0.13/delay.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/async/1.0.13/delay.js +0 -63
- package/esm/deps/jsr.io/@std/bytes/1.0.6/_types.d.ts +0 -9
- package/esm/deps/jsr.io/@std/bytes/1.0.6/_types.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/bytes/1.0.6/_types.js +0 -2
- package/esm/deps/jsr.io/@std/bytes/1.0.6/concat.d.ts +0 -21
- package/esm/deps/jsr.io/@std/bytes/1.0.6/concat.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/bytes/1.0.6/concat.js +0 -32
- package/esm/deps/jsr.io/@std/encoding/1.0.10/_common16.d.ts +0 -23
- package/esm/deps/jsr.io/@std/encoding/1.0.10/_common16.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/encoding/1.0.10/_common16.js +0 -51
- package/esm/deps/jsr.io/@std/encoding/1.0.10/_common_detach.d.ts +0 -4
- package/esm/deps/jsr.io/@std/encoding/1.0.10/_common_detach.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/encoding/1.0.10/_common_detach.js +0 -13
- package/esm/deps/jsr.io/@std/encoding/1.0.10/_types.d.ts +0 -9
- package/esm/deps/jsr.io/@std/encoding/1.0.10/_types.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/encoding/1.0.10/_types.js +0 -2
- package/esm/deps/jsr.io/@std/encoding/1.0.10/hex.d.ts +0 -39
- package/esm/deps/jsr.io/@std/encoding/1.0.10/hex.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/encoding/1.0.10/hex.js +0 -87
- package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts +0 -9
- package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.js +0 -2
- package/esm/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts +0 -39
- package/esm/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts.map +0 -1
- package/esm/deps/jsr.io/@std/msgpack/1.0.3/encode.js +0 -237
- package/esm/src/signing/_ethers.d.ts.map +0 -1
- package/esm/src/signing/_private_key.d.ts +0 -22
- package/esm/src/signing/_private_key.d.ts.map +0 -1
- package/esm/src/signing/_private_key.js +0 -124
- package/esm/src/signing/_viem.d.ts.map +0 -1
- package/esm/src/signing/_window.d.ts.map +0 -1
- package/esm/src/types/info/delegations.d.ts.map +0 -1
- package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.d.ts +0 -2
- package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.d.ts.map +0 -1
- package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.js +0 -27
- package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.d.ts +0 -95
- package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.d.ts.map +0 -1
- package/script/deps/jsr.io/@derzade/typescript-event-target/1.1.1/src/TypedEventTarget.js +0 -24
- package/script/deps/jsr.io/@std/async/1.0.13/delay.d.ts +0 -43
- package/script/deps/jsr.io/@std/async/1.0.13/delay.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/async/1.0.13/delay.js +0 -76
- package/script/deps/jsr.io/@std/bytes/1.0.6/_types.d.ts +0 -9
- package/script/deps/jsr.io/@std/bytes/1.0.6/_types.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/bytes/1.0.6/_types.js +0 -13
- package/script/deps/jsr.io/@std/bytes/1.0.6/concat.d.ts +0 -21
- package/script/deps/jsr.io/@std/bytes/1.0.6/concat.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/bytes/1.0.6/concat.js +0 -45
- package/script/deps/jsr.io/@std/encoding/1.0.10/_common16.d.ts +0 -23
- package/script/deps/jsr.io/@std/encoding/1.0.10/_common16.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/encoding/1.0.10/_common16.js +0 -67
- package/script/deps/jsr.io/@std/encoding/1.0.10/_common_detach.d.ts +0 -4
- package/script/deps/jsr.io/@std/encoding/1.0.10/_common_detach.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/encoding/1.0.10/_common_detach.js +0 -26
- package/script/deps/jsr.io/@std/encoding/1.0.10/_types.d.ts +0 -9
- package/script/deps/jsr.io/@std/encoding/1.0.10/_types.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/encoding/1.0.10/_types.js +0 -13
- package/script/deps/jsr.io/@std/encoding/1.0.10/hex.d.ts +0 -39
- package/script/deps/jsr.io/@std/encoding/1.0.10/hex.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/encoding/1.0.10/hex.js +0 -101
- package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts +0 -9
- package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/msgpack/1.0.3/_types.js +0 -13
- package/script/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts +0 -39
- package/script/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts.map +0 -1
- package/script/deps/jsr.io/@std/msgpack/1.0.3/encode.js +0 -250
- package/script/src/signing/_ethers.d.ts.map +0 -1
- package/script/src/signing/_ethers.js +0 -26
- package/script/src/signing/_private_key.d.ts +0 -22
- package/script/src/signing/_private_key.d.ts.map +0 -1
- package/script/src/signing/_private_key.js +0 -138
- package/script/src/signing/_viem.d.ts.map +0 -1
- package/script/src/signing/_viem.js +0 -19
- package/script/src/signing/_window.d.ts.map +0 -1
- package/script/src/signing/_window.js +0 -43
- package/script/src/types/info/delegations.d.ts.map +0 -1
- package/script/src/types/info/delegations.js +0 -12
- /package/esm/src/signing/{_ethers.js → _signTypedData/ethers.js} +0 -0
- /package/esm/src/signing/{_viem.js → _signTypedData/viem.js} +0 -0
- /package/esm/src/types/info/{delegations.js → validators.js} +0 -0
|
@@ -2,12 +2,12 @@ import type { IRequestTransport } from "../transports/base.js";
|
|
|
2
2
|
import type { BlockDetailsRequest, TxDetailsRequest, UserDetailsRequest } from "../types/explorer/requests.js";
|
|
3
3
|
import type { BlockDetails, TxDetails } from "../types/explorer/responses.js";
|
|
4
4
|
import type { ExtraAgent, LegalCheck, MultiSigSigners, PerpsClearinghouseState, PortfolioPeriods, PreTransferCheck, Referral, SpotClearinghouseState, SubAccount, UserFees, UserFundingUpdate, UserNonFundingLedgerUpdate, UserRateLimit, UserRole } from "../types/info/accounts.js";
|
|
5
|
-
import type { AllMids, Candle, FundingHistory, PerpDex, PerpsMeta, PerpsMetaAndAssetCtxs, PredictedFunding, SpotMeta, SpotMetaAndAssetCtxs, TokenDetails } from "../types/info/assets.js";
|
|
6
|
-
import type { Delegation, DelegatorReward, DelegatorSummary, DelegatorUpdate, ValidatorSummary } from "../types/info/
|
|
7
|
-
import type { DeployAuctionStatus, SpotDeployState } from "../types/info/markets.js";
|
|
5
|
+
import type { AllMids, Candle, FundingHistory, MarginTable, PerpDex, PerpsMeta, PerpsMetaAndAssetCtxs, PredictedFunding, SpotMeta, SpotMetaAndAssetCtxs, TokenDetails } from "../types/info/assets.js";
|
|
6
|
+
import type { Delegation, DelegatorReward, DelegatorSummary, DelegatorUpdate, ValidatorSummary } from "../types/info/validators.js";
|
|
7
|
+
import type { DeployAuctionStatus, ExchangeStatus, SpotDeployState } from "../types/info/markets.js";
|
|
8
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,
|
|
10
|
-
import type { VaultDetails, VaultEquity, VaultSummary } from "../types/info/vaults.js";
|
|
9
|
+
import type { AllMidsRequest, CandleSnapshotRequest, ClearinghouseStateRequest, DelegationsRequest, DelegatorHistoryRequest, DelegatorRewardsRequest, DelegatorSummaryRequest, ExtraAgentsRequest, FrontendOpenOrdersRequest, FundingHistoryRequest, HistoricalOrdersRequest, IsVipRequest, L2BookRequest, LeadingVaultsRequest, LegalCheckRequest, MarginTableRequest, 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, VaultLeading, VaultSummary } from "../types/info/vaults.js";
|
|
11
11
|
/** Parameters for the {@linkcode InfoClient} constructor. */
|
|
12
12
|
export interface InfoClientParameters<T extends IRequestTransport = IRequestTransport> {
|
|
13
13
|
/** The transport used to connect to the Hyperliquid API. */
|
|
@@ -15,6 +15,8 @@ export interface InfoClientParameters<T extends IRequestTransport = IRequestTran
|
|
|
15
15
|
}
|
|
16
16
|
/** Parameters for the {@linkcode InfoClient.allMids} method. */
|
|
17
17
|
export type AllMidsParameters = Omit<AllMidsRequest, "type">;
|
|
18
|
+
/** Parameters for the {@linkcode InfoClient.blockDetails} method. */
|
|
19
|
+
export type BlockDetailsParameters = Omit<BlockDetailsRequest, "type">;
|
|
18
20
|
/** Parameters for the {@linkcode InfoClient.candleSnapshot} method. */
|
|
19
21
|
export type CandleSnapshotParameters = CandleSnapshotRequest["req"];
|
|
20
22
|
/** Parameters for the {@linkcode InfoClient.clearinghouseState} method. */
|
|
@@ -39,8 +41,12 @@ export type HistoricalOrdersParameters = Omit<HistoricalOrdersRequest, "type">;
|
|
|
39
41
|
export type IsVipParameters = Omit<IsVipRequest, "type">;
|
|
40
42
|
/** Parameters for the {@linkcode InfoClient.l2Book} method. */
|
|
41
43
|
export type L2BookParameters = Omit<L2BookRequest, "type">;
|
|
44
|
+
/** Parameters for the {@linkcode InfoClient.leadingVaults} method. */
|
|
45
|
+
export type LeadingVaultsParameters = Omit<LeadingVaultsRequest, "type">;
|
|
42
46
|
/** Parameters for the {@linkcode InfoClient.legalCheck} method. */
|
|
43
47
|
export type LegalCheckParameters = Omit<LegalCheckRequest, "type">;
|
|
48
|
+
/** Parameters for the {@linkcode InfoClient.marginTable} method. */
|
|
49
|
+
export type MarginTableParameters = Omit<MarginTableRequest, "type">;
|
|
44
50
|
/** Parameters for the {@linkcode InfoClient.maxBuilderFee} method. */
|
|
45
51
|
export type MaxBuilderFeeParameters = Omit<MaxBuilderFeeRequest, "type">;
|
|
46
52
|
/** Parameters for the {@linkcode InfoClient.meta} method. */
|
|
@@ -49,10 +55,6 @@ export type MetaParameters = Omit<MetaRequest, "type">;
|
|
|
49
55
|
export type OpenOrdersParameters = Omit<OpenOrdersRequest, "type">;
|
|
50
56
|
/** Parameters for the {@linkcode InfoClient.orderStatus} method. */
|
|
51
57
|
export type OrderStatusParameters = Omit<OrderStatusRequest, "type">;
|
|
52
|
-
/** Parameters for the {@linkcode InfoClient.perpDeployAuctionStatus} method. */
|
|
53
|
-
export type PerpDeployAuctionStatusParameters = Omit<PerpDeployAuctionStatusRequest, "type">;
|
|
54
|
-
/** Parameters for the {@linkcode InfoClient.perpDexs} method. */
|
|
55
|
-
export type PerpDexsParameters = Omit<PerpDexsRequest, "type">;
|
|
56
58
|
/** Parameters for the {@linkcode InfoClient.portfolio} method. */
|
|
57
59
|
export type PortfolioParameters = Omit<PortfolioRequest, "type">;
|
|
58
60
|
/** Parameters for the {@linkcode InfoClient.preTransferCheck} method. */
|
|
@@ -69,6 +71,10 @@ export type SubAccountsParameters = Omit<SubAccountsRequest, "type">;
|
|
|
69
71
|
export type TokenDetailsParameters = Omit<TokenDetailsRequest, "type">;
|
|
70
72
|
/** Parameters for the {@linkcode InfoClient.twapHistory} method. */
|
|
71
73
|
export type TwapHistoryParameters = Omit<TwapHistoryRequest, "type">;
|
|
74
|
+
/** Parameters for the {@linkcode InfoClient.txDetails} method. */
|
|
75
|
+
export type TxDetailsParameters = Omit<TxDetailsRequest, "type">;
|
|
76
|
+
/** Parameters for the {@linkcode InfoClient.userDetails} method. */
|
|
77
|
+
export type UserDetailsParameters = Omit<UserDetailsRequest, "type">;
|
|
72
78
|
/** Parameters for the {@linkcode InfoClient.userFees} method. */
|
|
73
79
|
export type UserFeesParameters = Omit<UserFeesRequest, "type">;
|
|
74
80
|
/** Parameters for the {@linkcode InfoClient.userFills} method. */
|
|
@@ -93,12 +99,6 @@ export type UserTwapSliceFillsByTimeParameters = Omit<UserTwapSliceFillsByTimeRe
|
|
|
93
99
|
export type UserVaultEquitiesParameters = Omit<UserVaultEquitiesRequest, "type">;
|
|
94
100
|
/** Parameters for the {@linkcode InfoClient.vaultDetails} method. */
|
|
95
101
|
export type VaultDetailsParameters = Omit<VaultDetailsRequest, "type">;
|
|
96
|
-
/** Parameters for the {@linkcode InfoClient.blockDetails} method. */
|
|
97
|
-
export type BlockDetailsParameters = Omit<BlockDetailsRequest, "type">;
|
|
98
|
-
/** Parameters for the {@linkcode InfoClient.txDetails} method. */
|
|
99
|
-
export type TxDetailsParameters = Omit<TxDetailsRequest, "type">;
|
|
100
|
-
/** Parameters for the {@linkcode InfoClient.userDetails} method. */
|
|
101
|
-
export type UserDetailsParameters = Omit<UserDetailsRequest, "type">;
|
|
102
102
|
/**
|
|
103
103
|
* Info client for interacting with the Hyperliquid API.
|
|
104
104
|
* @typeParam T The type of transport used to connect to the Hyperliquid API.
|
|
@@ -120,8 +120,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
120
120
|
constructor(args: InfoClientParameters<T>);
|
|
121
121
|
/**
|
|
122
122
|
* Request mid coin prices.
|
|
123
|
+
* @param args - An optional parameters for the request.
|
|
123
124
|
* @param signal - An optional abort signal.
|
|
124
|
-
* @returns
|
|
125
|
+
* @returns Mapping of coin symbols to mid prices.
|
|
126
|
+
*
|
|
127
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
125
128
|
*
|
|
126
129
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
|
|
127
130
|
* @example
|
|
@@ -140,9 +143,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
140
143
|
* Block details by block height.
|
|
141
144
|
* @param args - The parameters for the request.
|
|
142
145
|
* @param signal - An optional abort signal.
|
|
143
|
-
* @returns Block details
|
|
146
|
+
* @returns Block details.
|
|
144
147
|
*
|
|
145
|
-
* @
|
|
148
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
149
|
+
*
|
|
150
|
+
* @see null
|
|
146
151
|
* @example
|
|
147
152
|
* ```ts
|
|
148
153
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -160,6 +165,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
160
165
|
* @param signal - An optional abort signal.
|
|
161
166
|
* @returns Array of candlestick data points.
|
|
162
167
|
*
|
|
168
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
169
|
+
*
|
|
163
170
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
|
|
164
171
|
* @example
|
|
165
172
|
* ```ts
|
|
@@ -182,6 +189,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
182
189
|
* @param signal - An optional abort signal.
|
|
183
190
|
* @returns Account summary for perpetual trading.
|
|
184
191
|
*
|
|
192
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
193
|
+
*
|
|
185
194
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
|
|
186
195
|
* @example
|
|
187
196
|
* ```ts
|
|
@@ -200,6 +209,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
200
209
|
* @param signal - An optional abort signal.
|
|
201
210
|
* @returns Array of user's delegations to validators.
|
|
202
211
|
*
|
|
212
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
213
|
+
*
|
|
203
214
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
|
|
204
215
|
* @example
|
|
205
216
|
* ```ts
|
|
@@ -218,6 +229,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
218
229
|
* @param signal - An optional abort signal.
|
|
219
230
|
* @returns Array of user's staking updates.
|
|
220
231
|
*
|
|
232
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
233
|
+
*
|
|
221
234
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
|
|
222
235
|
* @example
|
|
223
236
|
* ```ts
|
|
@@ -236,6 +249,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
236
249
|
* @param signal - An optional abort signal.
|
|
237
250
|
* @returns Array of user's staking rewards.
|
|
238
251
|
*
|
|
252
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
253
|
+
*
|
|
239
254
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-rewards
|
|
240
255
|
* @example
|
|
241
256
|
* ```ts
|
|
@@ -254,6 +269,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
254
269
|
* @param signal - An optional abort signal.
|
|
255
270
|
* @returns Summary of a user's staking delegations.
|
|
256
271
|
*
|
|
272
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
273
|
+
*
|
|
257
274
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
|
|
258
275
|
* @example
|
|
259
276
|
* ```ts
|
|
@@ -266,13 +283,34 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
266
283
|
* ```
|
|
267
284
|
*/
|
|
268
285
|
delegatorSummary(args: DelegatorSummaryParameters, signal?: AbortSignal): Promise<DelegatorSummary>;
|
|
286
|
+
/**
|
|
287
|
+
* Request exchange status information.
|
|
288
|
+
* @param signal - An optional abort signal.
|
|
289
|
+
* @returns Exchange system status information.
|
|
290
|
+
*
|
|
291
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
292
|
+
*
|
|
293
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
|
|
294
|
+
* @example
|
|
295
|
+
* ```ts
|
|
296
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
297
|
+
*
|
|
298
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
299
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
300
|
+
*
|
|
301
|
+
* const data = await infoClient.exchangeStatus();
|
|
302
|
+
* ```
|
|
303
|
+
*/
|
|
304
|
+
exchangeStatus(signal?: AbortSignal): Promise<ExchangeStatus>;
|
|
269
305
|
/**
|
|
270
306
|
* Request user's extra agents.
|
|
271
307
|
* @param args - The parameters for the request.
|
|
272
308
|
* @param signal - An optional abort signal.
|
|
273
309
|
* @returns User's extra agents.
|
|
274
310
|
*
|
|
275
|
-
* @
|
|
311
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
312
|
+
*
|
|
313
|
+
* @see null
|
|
276
314
|
* @example
|
|
277
315
|
* ```ts
|
|
278
316
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -290,6 +328,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
290
328
|
* @param signal - An optional abort signal.
|
|
291
329
|
* @returns Array of open orders with additional frontend information.
|
|
292
330
|
*
|
|
331
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
332
|
+
*
|
|
293
333
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
|
|
294
334
|
* @example
|
|
295
335
|
* ```ts
|
|
@@ -308,6 +348,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
308
348
|
* @param signal - An optional abort signal.
|
|
309
349
|
* @returns Array of historical funding rate data for an asset.
|
|
310
350
|
*
|
|
351
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
352
|
+
*
|
|
311
353
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
|
|
312
354
|
* @example
|
|
313
355
|
* ```ts
|
|
@@ -329,6 +371,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
329
371
|
* @param signal - An optional abort signal.
|
|
330
372
|
* @returns Array of user's historical orders.
|
|
331
373
|
*
|
|
374
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
375
|
+
*
|
|
332
376
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
|
|
333
377
|
* @example
|
|
334
378
|
* ```ts
|
|
@@ -347,7 +391,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
347
391
|
* @param signal - An optional abort signal.
|
|
348
392
|
* @returns Boolean indicating user's VIP status.
|
|
349
393
|
*
|
|
350
|
-
* @
|
|
394
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
395
|
+
*
|
|
396
|
+
* @see null
|
|
351
397
|
* @example
|
|
352
398
|
* ```ts
|
|
353
399
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -365,6 +411,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
365
411
|
* @param signal - An optional abort signal.
|
|
366
412
|
* @returns L2 order book snapshot.
|
|
367
413
|
*
|
|
414
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
415
|
+
*
|
|
368
416
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
|
|
369
417
|
* @example
|
|
370
418
|
* ```ts
|
|
@@ -377,13 +425,35 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
377
425
|
* ```
|
|
378
426
|
*/
|
|
379
427
|
l2Book(args: L2BookParameters, signal?: AbortSignal): Promise<Book>;
|
|
428
|
+
/**
|
|
429
|
+
* Request leading vaults for a user.
|
|
430
|
+
* @param args - The parameters for the request.
|
|
431
|
+
* @param signal - An optional abort signal.
|
|
432
|
+
* @returns
|
|
433
|
+
*
|
|
434
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
435
|
+
*
|
|
436
|
+
* @see null
|
|
437
|
+
* @example
|
|
438
|
+
* ```ts
|
|
439
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
440
|
+
*
|
|
441
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
442
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
443
|
+
*
|
|
444
|
+
* const data = await infoClient.leadingVaults({ user: "0x..." });
|
|
445
|
+
* ```
|
|
446
|
+
*/
|
|
447
|
+
leadingVaults(args: LeadingVaultsParameters, signal?: AbortSignal): Promise<VaultLeading[]>;
|
|
380
448
|
/**
|
|
381
449
|
* Request legal verification status of a user.
|
|
382
450
|
* @param args - The parameters for the request.
|
|
383
451
|
* @param signal - An optional abort signal.
|
|
384
452
|
* @returns Legal verification status for a user.
|
|
385
453
|
*
|
|
386
|
-
* @
|
|
454
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
455
|
+
*
|
|
456
|
+
* @see null
|
|
387
457
|
* @example
|
|
388
458
|
* ```ts
|
|
389
459
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -395,12 +465,53 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
395
465
|
* ```
|
|
396
466
|
*/
|
|
397
467
|
legalCheck(args: LegalCheckParameters, signal?: AbortSignal): Promise<LegalCheck>;
|
|
468
|
+
/**
|
|
469
|
+
* Request liquidatable (unknown).
|
|
470
|
+
* @param signal - An optional abort signal.
|
|
471
|
+
* @returns
|
|
472
|
+
*
|
|
473
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
474
|
+
*
|
|
475
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
|
|
476
|
+
* @example
|
|
477
|
+
* ```ts
|
|
478
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
479
|
+
*
|
|
480
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
481
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
482
|
+
*
|
|
483
|
+
* const data = await infoClient.liquidatable();
|
|
484
|
+
* ```
|
|
485
|
+
*/
|
|
486
|
+
liquidatable(signal?: AbortSignal): Promise<unknown[]>;
|
|
487
|
+
/**
|
|
488
|
+
* Request margin table data.
|
|
489
|
+
* @param args - The parameters for the request.
|
|
490
|
+
* @param signal - An optional abort signal.
|
|
491
|
+
* @returns Margin requirements table with multiple tiers.
|
|
492
|
+
*
|
|
493
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
494
|
+
*
|
|
495
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
|
|
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.marginTable({ id: 1 });
|
|
504
|
+
* ```
|
|
505
|
+
*/
|
|
506
|
+
marginTable(args: MarginTableParameters, signal?: AbortSignal): Promise<MarginTable>;
|
|
398
507
|
/**
|
|
399
508
|
* Request builder fee approval.
|
|
400
509
|
* @param args - The parameters for the request.
|
|
401
510
|
* @param signal - An optional abort signal.
|
|
402
511
|
* @returns Maximum builder fee approval.
|
|
403
512
|
*
|
|
513
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
514
|
+
*
|
|
404
515
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
|
|
405
516
|
* @example
|
|
406
517
|
* ```ts
|
|
@@ -413,12 +524,34 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
413
524
|
* ```
|
|
414
525
|
*/
|
|
415
526
|
maxBuilderFee(args: MaxBuilderFeeParameters, signal?: AbortSignal): Promise<number>;
|
|
527
|
+
/**
|
|
528
|
+
* Request maximum market order notionals.
|
|
529
|
+
* @param signal - An optional abort signal.
|
|
530
|
+
* @returns
|
|
531
|
+
*
|
|
532
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
533
|
+
*
|
|
534
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
|
|
535
|
+
* @example
|
|
536
|
+
* ```ts
|
|
537
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
538
|
+
*
|
|
539
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
540
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
541
|
+
*
|
|
542
|
+
* const data = await infoClient.maxMarketOrderNtls();
|
|
543
|
+
* ```
|
|
544
|
+
*/
|
|
545
|
+
maxMarketOrderNtls(signal?: AbortSignal): Promise<[number, string][]>;
|
|
416
546
|
/**
|
|
417
547
|
* Request trading metadata.
|
|
548
|
+
* @param args - An optional parameters for the request.
|
|
418
549
|
* @param signal - An optional abort signal.
|
|
419
550
|
* @returns Metadata for perpetual assets.
|
|
420
551
|
*
|
|
421
|
-
* @
|
|
552
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
553
|
+
*
|
|
554
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata-universe-and-margin-tables
|
|
422
555
|
* @example
|
|
423
556
|
* ```ts
|
|
424
557
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -434,7 +567,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
434
567
|
/**
|
|
435
568
|
* Request metadata and asset contexts.
|
|
436
569
|
* @param signal - An optional abort signal.
|
|
437
|
-
* @returns Metadata and context
|
|
570
|
+
* @returns Metadata and context for perpetual assets.
|
|
571
|
+
*
|
|
572
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
438
573
|
*
|
|
439
574
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc
|
|
440
575
|
* @example
|
|
@@ -454,6 +589,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
454
589
|
* @param signal - An optional abort signal.
|
|
455
590
|
* @returns Array of open order.
|
|
456
591
|
*
|
|
592
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
593
|
+
*
|
|
457
594
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
|
|
458
595
|
* @example
|
|
459
596
|
* ```ts
|
|
@@ -472,6 +609,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
472
609
|
* @param signal - An optional abort signal.
|
|
473
610
|
* @returns Result of an order status lookup.
|
|
474
611
|
*
|
|
612
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
613
|
+
*
|
|
475
614
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
|
|
476
615
|
* @example
|
|
477
616
|
* ```ts
|
|
@@ -489,6 +628,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
489
628
|
* @param signal - An optional abort signal.
|
|
490
629
|
* @returns Status of the perpetual deploy auction.
|
|
491
630
|
*
|
|
631
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
632
|
+
*
|
|
492
633
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
|
|
493
634
|
* @example
|
|
494
635
|
* ```ts
|
|
@@ -504,7 +645,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
504
645
|
/**
|
|
505
646
|
* Request all perpetual dexs.
|
|
506
647
|
* @param signal - An optional abort signal.
|
|
507
|
-
* @returns Array of perpetual dexes.
|
|
648
|
+
* @returns Array of perpetual dexes (null is main dex).
|
|
649
|
+
*
|
|
650
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
508
651
|
*
|
|
509
652
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
|
|
510
653
|
* @example
|
|
@@ -520,10 +663,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
520
663
|
perpDexs(signal?: AbortSignal): Promise<(PerpDex | null)[]>;
|
|
521
664
|
/**
|
|
522
665
|
* Request perpetuals at open interest cap.
|
|
523
|
-
* @param args - The parameters for the request.
|
|
524
666
|
* @param signal - An optional abort signal.
|
|
525
667
|
* @returns Array of perpetuals at open interest caps.
|
|
526
668
|
*
|
|
669
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
670
|
+
*
|
|
527
671
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
|
|
528
672
|
* @example
|
|
529
673
|
* ```ts
|
|
@@ -537,10 +681,12 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
537
681
|
*/
|
|
538
682
|
perpsAtOpenInterestCap(signal?: AbortSignal): Promise<string[]>;
|
|
539
683
|
/**
|
|
540
|
-
* Request portfolio.
|
|
684
|
+
* Request user portfolio.
|
|
541
685
|
* @param args - The parameters for the request.
|
|
542
686
|
* @param signal - An optional abort signal.
|
|
543
|
-
* @returns Portfolio
|
|
687
|
+
* @returns Portfolio metrics grouped by time periods.
|
|
688
|
+
*
|
|
689
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
544
690
|
*
|
|
545
691
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
|
|
546
692
|
* @example
|
|
@@ -559,6 +705,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
559
705
|
* @param signal - An optional abort signal.
|
|
560
706
|
* @returns Array of predicted funding rates.
|
|
561
707
|
*
|
|
708
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
709
|
+
*
|
|
562
710
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
|
|
563
711
|
* @example
|
|
564
712
|
* ```ts
|
|
@@ -577,7 +725,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
577
725
|
* @param signal - An optional abort signal.
|
|
578
726
|
* @returns Pre-transfer user existence check result.
|
|
579
727
|
*
|
|
580
|
-
* @
|
|
728
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
729
|
+
*
|
|
730
|
+
* @see null
|
|
581
731
|
* @example
|
|
582
732
|
* ```ts
|
|
583
733
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -595,6 +745,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
595
745
|
* @param signal - An optional abort signal.
|
|
596
746
|
* @returns Referral information for a user.
|
|
597
747
|
*
|
|
748
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
749
|
+
*
|
|
598
750
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
|
|
599
751
|
* @example
|
|
600
752
|
* ```ts
|
|
@@ -611,7 +763,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
611
763
|
* Request spot clearinghouse state.
|
|
612
764
|
* @param args - The parameters for the request.
|
|
613
765
|
* @param signal - An optional abort signal.
|
|
614
|
-
* @returns
|
|
766
|
+
* @returns Account summary for spot trading.
|
|
767
|
+
*
|
|
768
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
615
769
|
*
|
|
616
770
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
|
|
617
771
|
* @example
|
|
@@ -629,7 +783,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
629
783
|
* Request spot deploy state.
|
|
630
784
|
* @param args - The parameters for the request.
|
|
631
785
|
* @param signal - An optional abort signal.
|
|
632
|
-
* @returns
|
|
786
|
+
* @returns Deploy state for spot tokens.
|
|
787
|
+
*
|
|
788
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
633
789
|
*
|
|
634
790
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
|
|
635
791
|
* @example
|
|
@@ -648,6 +804,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
648
804
|
* @param signal - An optional abort signal.
|
|
649
805
|
* @returns Metadata for spot assets.
|
|
650
806
|
*
|
|
807
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
808
|
+
*
|
|
651
809
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
|
|
652
810
|
* @example
|
|
653
811
|
* ```ts
|
|
@@ -663,7 +821,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
663
821
|
/**
|
|
664
822
|
* Request spot metadata and asset contexts.
|
|
665
823
|
* @param signal - An optional abort signal.
|
|
666
|
-
* @returns Metadata and context
|
|
824
|
+
* @returns Metadata and context for spot assets.
|
|
825
|
+
*
|
|
826
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
667
827
|
*
|
|
668
828
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
|
|
669
829
|
* @example
|
|
@@ -683,6 +843,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
683
843
|
* @param signal - An optional abort signal.
|
|
684
844
|
* @returns Array of user sub-account or null if the user does not have any sub-accounts.
|
|
685
845
|
*
|
|
846
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
847
|
+
*
|
|
686
848
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
|
|
687
849
|
* @example
|
|
688
850
|
* ```ts
|
|
@@ -699,7 +861,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
699
861
|
* Request token details.
|
|
700
862
|
* @param args - The parameters for the request.
|
|
701
863
|
* @param signal - An optional abort signal.
|
|
702
|
-
* @returns
|
|
864
|
+
* @returns Details of a token.
|
|
865
|
+
*
|
|
866
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
703
867
|
*
|
|
704
868
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
|
|
705
869
|
* @example
|
|
@@ -717,9 +881,11 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
717
881
|
* Request twap history of a user.
|
|
718
882
|
* @param args - The parameters for the request.
|
|
719
883
|
* @param signal - An optional abort signal.
|
|
720
|
-
* @returns
|
|
884
|
+
* @returns Array of user's TWAP history.
|
|
721
885
|
*
|
|
722
|
-
* @
|
|
886
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
887
|
+
*
|
|
888
|
+
* @see null
|
|
723
889
|
* @example
|
|
724
890
|
* ```ts
|
|
725
891
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -732,12 +898,14 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
732
898
|
*/
|
|
733
899
|
twapHistory(args: TwapHistoryParameters, signal?: AbortSignal): Promise<TwapHistory[]>;
|
|
734
900
|
/**
|
|
735
|
-
*
|
|
901
|
+
* Request transaction details by transaction hash.
|
|
736
902
|
* @param args - The parameters for the request.
|
|
737
903
|
* @param signal - An optional abort signal.
|
|
738
|
-
* @returns Transaction details
|
|
904
|
+
* @returns Transaction details.
|
|
905
|
+
*
|
|
906
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
739
907
|
*
|
|
740
|
-
* @see null
|
|
908
|
+
* @see null
|
|
741
909
|
* @example
|
|
742
910
|
* ```ts
|
|
743
911
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -750,12 +918,14 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
750
918
|
*/
|
|
751
919
|
txDetails(args: TxDetailsParameters, signal?: AbortSignal): Promise<TxDetails>;
|
|
752
920
|
/**
|
|
753
|
-
*
|
|
921
|
+
* Request user details by user's address.
|
|
754
922
|
* @param args - The parameters for the request.
|
|
755
923
|
* @param signal - An optional abort signal.
|
|
756
|
-
* @returns User details
|
|
924
|
+
* @returns User details.
|
|
757
925
|
*
|
|
758
|
-
* @
|
|
926
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
927
|
+
*
|
|
928
|
+
* @see null
|
|
759
929
|
* @example
|
|
760
930
|
* ```ts
|
|
761
931
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -773,7 +943,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
773
943
|
* @param signal - An optional abort signal.
|
|
774
944
|
* @returns User fees.
|
|
775
945
|
*
|
|
776
|
-
* @
|
|
946
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
947
|
+
*
|
|
948
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
|
|
777
949
|
* @example
|
|
778
950
|
* ```ts
|
|
779
951
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -791,6 +963,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
791
963
|
* @param signal - An optional abort signal.
|
|
792
964
|
* @returns Array of user's trade fill.
|
|
793
965
|
*
|
|
966
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
967
|
+
*
|
|
794
968
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
|
|
795
969
|
* @example
|
|
796
970
|
* ```ts
|
|
@@ -809,6 +983,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
809
983
|
* @param signal - An optional abort signal.
|
|
810
984
|
* @returns Array of user's trade fill.
|
|
811
985
|
*
|
|
986
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
987
|
+
*
|
|
812
988
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
|
|
813
989
|
* @example
|
|
814
990
|
* ```ts
|
|
@@ -830,6 +1006,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
830
1006
|
* @param signal - An optional abort signal.
|
|
831
1007
|
* @returns Array of user's funding ledger update.
|
|
832
1008
|
*
|
|
1009
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1010
|
+
*
|
|
833
1011
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
|
|
834
1012
|
* @example
|
|
835
1013
|
* ```ts
|
|
@@ -851,6 +1029,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
851
1029
|
* @param signal - An optional abort signal.
|
|
852
1030
|
* @returns Array of user's non-funding ledger update.
|
|
853
1031
|
*
|
|
1032
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1033
|
+
*
|
|
854
1034
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
|
|
855
1035
|
* @example
|
|
856
1036
|
* ```ts
|
|
@@ -872,6 +1052,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
872
1052
|
* @param signal - An optional abort signal.
|
|
873
1053
|
* @returns User's rate limits.
|
|
874
1054
|
*
|
|
1055
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1056
|
+
*
|
|
875
1057
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
|
|
876
1058
|
* @example
|
|
877
1059
|
* ```ts
|
|
@@ -890,6 +1072,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
890
1072
|
* @param signal - An optional abort signal.
|
|
891
1073
|
* @returns User's role.
|
|
892
1074
|
*
|
|
1075
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1076
|
+
*
|
|
893
1077
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
|
|
894
1078
|
* @example
|
|
895
1079
|
* ```ts
|
|
@@ -908,7 +1092,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
908
1092
|
* @param signal - An optional abort signal.
|
|
909
1093
|
* @returns Multi-sig signers for a user or null if the user does not have any multi-sig signers.
|
|
910
1094
|
*
|
|
911
|
-
* @
|
|
1095
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1096
|
+
*
|
|
1097
|
+
* @see null
|
|
912
1098
|
* @example
|
|
913
1099
|
* ```ts
|
|
914
1100
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -926,6 +1112,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
926
1112
|
* @param signal - An optional abort signal.
|
|
927
1113
|
* @returns Array of user's twap slice fill.
|
|
928
1114
|
*
|
|
1115
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1116
|
+
*
|
|
929
1117
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
|
|
930
1118
|
* @example
|
|
931
1119
|
* ```ts
|
|
@@ -944,7 +1132,9 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
944
1132
|
* @param signal - An optional abort signal.
|
|
945
1133
|
* @returns Array of user's twap slice fill.
|
|
946
1134
|
*
|
|
947
|
-
* @
|
|
1135
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1136
|
+
*
|
|
1137
|
+
* @see null
|
|
948
1138
|
* @example
|
|
949
1139
|
* ```ts
|
|
950
1140
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -965,6 +1155,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
965
1155
|
* @param signal - An optional abort signal.
|
|
966
1156
|
* @returns Array of user's vault deposits.
|
|
967
1157
|
*
|
|
1158
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1159
|
+
*
|
|
968
1160
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
|
|
969
1161
|
* @example
|
|
970
1162
|
* ```ts
|
|
@@ -973,16 +1165,37 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
973
1165
|
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
974
1166
|
* const infoClient = new hl.InfoClient({ transport });
|
|
975
1167
|
*
|
|
976
|
-
* const data = await infoClient.
|
|
1168
|
+
* const data = await infoClient.userVaultEquities({ user: "0x..." });
|
|
977
1169
|
* ```
|
|
978
1170
|
*/
|
|
979
1171
|
userVaultEquities(args: UserVaultEquitiesParameters, signal?: AbortSignal): Promise<VaultEquity[]>;
|
|
1172
|
+
/**
|
|
1173
|
+
* Request validator L1 votes.
|
|
1174
|
+
* @param signal - An optional abort signal.
|
|
1175
|
+
* @returns
|
|
1176
|
+
*
|
|
1177
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1178
|
+
*
|
|
1179
|
+
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
|
|
1180
|
+
* @example
|
|
1181
|
+
* ```ts
|
|
1182
|
+
* import * as hl from "@nktkas/hyperliquid";
|
|
1183
|
+
*
|
|
1184
|
+
* const transport = new hl.HttpTransport(); // or WebSocketTransport
|
|
1185
|
+
* const infoClient = new hl.InfoClient({ transport });
|
|
1186
|
+
*
|
|
1187
|
+
* const data = await infoClient.validatorL1Votes();
|
|
1188
|
+
* ```
|
|
1189
|
+
*/
|
|
1190
|
+
validatorL1Votes(signal?: AbortSignal): Promise<unknown[]>;
|
|
980
1191
|
/**
|
|
981
1192
|
* Request validator summaries.
|
|
982
|
-
* @param
|
|
1193
|
+
* @param signal - An optional abort signal.
|
|
983
1194
|
* @returns Array of validator summaries.
|
|
984
1195
|
*
|
|
985
|
-
* @
|
|
1196
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1197
|
+
*
|
|
1198
|
+
* @see null
|
|
986
1199
|
* @example
|
|
987
1200
|
* ```ts
|
|
988
1201
|
* import * as hl from "@nktkas/hyperliquid";
|
|
@@ -1000,6 +1213,8 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1000
1213
|
* @param signal - An optional abort signal.
|
|
1001
1214
|
* @returns Details of a vault or null if the vault does not exist.
|
|
1002
1215
|
*
|
|
1216
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1217
|
+
*
|
|
1003
1218
|
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
|
|
1004
1219
|
* @example
|
|
1005
1220
|
* ```ts
|
|
@@ -1014,11 +1229,12 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1014
1229
|
vaultDetails(args: VaultDetailsParameters, signal?: AbortSignal): Promise<VaultDetails | null>;
|
|
1015
1230
|
/**
|
|
1016
1231
|
* Request a list of vaults less than 2 hours old.
|
|
1017
|
-
* @param args - The parameters for the request.
|
|
1018
1232
|
* @param signal - An optional abort signal.
|
|
1019
1233
|
* @returns Array of vault summaries.
|
|
1020
1234
|
*
|
|
1021
|
-
* @
|
|
1235
|
+
* @throws {TransportError} When the transport layer throws an error.
|
|
1236
|
+
*
|
|
1237
|
+
* @see null
|
|
1022
1238
|
* @example
|
|
1023
1239
|
* ```ts
|
|
1024
1240
|
* import * as hl from "@nktkas/hyperliquid";
|