@nktkas/hyperliquid 0.25.0-beta.3 → 0.25.0-beta.4
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 +108 -116
- package/esm/bin/_utils.d.ts +80 -0
- package/esm/bin/_utils.d.ts.map +1 -0
- package/esm/bin/_utils.js +112 -0
- package/esm/bin/_utils.js.map +1 -0
- package/esm/bin/cli.js +43 -161
- package/esm/bin/cli.js.map +1 -1
- package/esm/src/clients/exchange.d.ts +93 -93
- package/esm/src/clients/exchange.d.ts.map +1 -1
- package/esm/src/clients/exchange.js +63 -58
- package/esm/src/clients/exchange.js.map +1 -1
- package/esm/src/clients/info.d.ts +113 -113
- package/esm/src/clients/info.d.ts.map +1 -1
- package/esm/src/clients/info.js +70 -73
- package/esm/src/clients/info.js.map +1 -1
- package/esm/src/clients/multiSign.d.ts +3 -3
- package/esm/src/clients/multiSign.d.ts.map +1 -1
- package/esm/src/clients/multiSign.js +4 -2
- package/esm/src/clients/multiSign.js.map +1 -1
- package/esm/src/clients/subscription.d.ts +23 -23
- package/esm/src/clients/subscription.d.ts.map +1 -1
- package/esm/src/clients/subscription.js +8 -11
- package/esm/src/clients/subscription.js.map +1 -1
- package/esm/src/schemas/_base.d.ts +6 -8
- package/esm/src/schemas/_base.d.ts.map +1 -1
- package/esm/src/schemas/_base.js +5 -28
- package/esm/src/schemas/_base.js.map +1 -1
- package/esm/src/schemas/exchange/requests.d.ts +1676 -1657
- package/esm/src/schemas/exchange/requests.d.ts.map +1 -1
- package/esm/src/schemas/exchange/requests.js +195 -199
- package/esm/src/schemas/exchange/requests.js.map +1 -1
- package/esm/src/schemas/exchange/responses.d.ts +10 -10
- package/esm/src/schemas/exchange/responses.js +3 -3
- package/esm/src/schemas/exchange/responses.js.map +1 -1
- package/esm/src/schemas/explorer/requests.d.ts +2 -2
- package/esm/src/schemas/explorer/requests.js +3 -3
- package/esm/src/schemas/explorer/requests.js.map +1 -1
- package/esm/src/schemas/explorer/responses.d.ts +16 -16
- package/esm/src/schemas/explorer/responses.js +3 -3
- package/esm/src/schemas/explorer/responses.js.map +1 -1
- package/esm/src/schemas/info/accounts.d.ts +298 -298
- package/esm/src/schemas/info/accounts.js +24 -24
- package/esm/src/schemas/info/accounts.js.map +1 -1
- package/esm/src/schemas/info/assets.d.ts +110 -110
- package/esm/src/schemas/info/assets.js +9 -9
- package/esm/src/schemas/info/assets.js.map +1 -1
- package/esm/src/schemas/info/markets.d.ts +25 -25
- package/esm/src/schemas/info/markets.js +3 -3
- package/esm/src/schemas/info/markets.js.map +1 -1
- package/esm/src/schemas/info/orders.d.ts +104 -104
- package/esm/src/schemas/info/orders.js +3 -3
- package/esm/src/schemas/info/orders.js.map +1 -1
- package/esm/src/schemas/info/requests.d.ts +32 -32
- package/esm/src/schemas/info/requests.js +55 -55
- package/esm/src/schemas/info/requests.js.map +1 -1
- package/esm/src/schemas/info/validators.d.ts +27 -27
- package/esm/src/schemas/info/validators.js +6 -6
- package/esm/src/schemas/info/validators.js.map +1 -1
- package/esm/src/schemas/info/vaults.d.ts +46 -46
- package/esm/src/schemas/info/vaults.js +10 -10
- package/esm/src/schemas/info/vaults.js.map +1 -1
- package/esm/src/schemas/subscriptions/requests.d.ts +4 -4
- package/esm/src/schemas/subscriptions/requests.js +17 -17
- package/esm/src/schemas/subscriptions/requests.js.map +1 -1
- package/esm/src/schemas/subscriptions/responses.d.ts +401 -401
- package/esm/src/schemas/subscriptions/responses.js +14 -14
- package/esm/src/schemas/subscriptions/responses.js.map +1 -1
- package/esm/src/signing/mod.js +4 -4
- package/esm/src/signing/mod.js.map +1 -1
- package/esm/src/signing/signTypedData/private_key.js +16 -16
- package/esm/src/signing/signTypedData/private_key.js.map +1 -1
- package/esm/src/transports/_polyfills.d.ts +12 -0
- package/esm/src/transports/_polyfills.d.ts.map +1 -0
- package/esm/src/transports/_polyfills.js +40 -0
- package/esm/src/transports/_polyfills.js.map +1 -0
- package/esm/src/transports/base.d.ts +6 -6
- package/esm/src/transports/base.d.ts.map +1 -1
- package/esm/src/transports/http/http_transport.d.ts +11 -4
- package/esm/src/transports/http/http_transport.d.ts.map +1 -1
- package/esm/src/transports/http/http_transport.js +17 -6
- package/esm/src/transports/http/http_transport.js.map +1 -1
- package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts +8 -7
- package/esm/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
- package/esm/src/transports/websocket/_hyperliquid_event_target.js +14 -33
- package/esm/src/transports/websocket/_hyperliquid_event_target.js.map +1 -1
- package/esm/src/transports/websocket/_reconnecting_websocket.d.ts +26 -29
- package/esm/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -1
- package/esm/src/transports/websocket/_reconnecting_websocket.js +82 -76
- package/esm/src/transports/websocket/_reconnecting_websocket.js.map +1 -1
- package/esm/src/transports/websocket/_websocket_async_request.d.ts +6 -0
- package/esm/src/transports/websocket/_websocket_async_request.d.ts.map +1 -1
- package/esm/src/transports/websocket/_websocket_async_request.js +49 -41
- package/esm/src/transports/websocket/_websocket_async_request.js.map +1 -1
- package/esm/src/transports/websocket/websocket_transport.d.ts +48 -70
- package/esm/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/esm/src/transports/websocket/websocket_transport.js +90 -103
- package/esm/src/transports/websocket/websocket_transport.js.map +1 -1
- package/package.json +3 -7
- package/script/bin/_utils.d.ts +80 -0
- package/script/bin/_utils.d.ts.map +1 -0
- package/script/bin/_utils.js +116 -0
- package/script/bin/_utils.js.map +1 -0
- package/script/bin/cli.js +43 -164
- package/script/bin/cli.js.map +1 -1
- package/script/src/clients/exchange.d.ts +93 -93
- package/script/src/clients/exchange.d.ts.map +1 -1
- package/script/src/clients/exchange.js +62 -57
- package/script/src/clients/exchange.js.map +1 -1
- package/script/src/clients/info.d.ts +113 -113
- package/script/src/clients/info.d.ts.map +1 -1
- package/script/src/clients/info.js +70 -73
- package/script/src/clients/info.js.map +1 -1
- package/script/src/clients/multiSign.d.ts +3 -3
- package/script/src/clients/multiSign.d.ts.map +1 -1
- package/script/src/clients/multiSign.js +10 -8
- package/script/src/clients/multiSign.js.map +1 -1
- package/script/src/clients/subscription.d.ts +23 -23
- package/script/src/clients/subscription.d.ts.map +1 -1
- package/script/src/clients/subscription.js +8 -11
- package/script/src/clients/subscription.js.map +1 -1
- package/script/src/schemas/_base.d.ts +6 -8
- package/script/src/schemas/_base.d.ts.map +1 -1
- package/script/src/schemas/_base.js +6 -29
- package/script/src/schemas/_base.js.map +1 -1
- package/script/src/schemas/exchange/requests.d.ts +1676 -1657
- package/script/src/schemas/exchange/requests.d.ts.map +1 -1
- package/script/src/schemas/exchange/requests.js +194 -198
- package/script/src/schemas/exchange/requests.js.map +1 -1
- package/script/src/schemas/exchange/responses.d.ts +10 -10
- package/script/src/schemas/exchange/responses.js +2 -2
- package/script/src/schemas/exchange/responses.js.map +1 -1
- package/script/src/schemas/explorer/requests.d.ts +2 -2
- package/script/src/schemas/explorer/requests.js +2 -2
- package/script/src/schemas/explorer/requests.js.map +1 -1
- package/script/src/schemas/explorer/responses.d.ts +16 -16
- package/script/src/schemas/explorer/responses.js +2 -2
- package/script/src/schemas/explorer/responses.js.map +1 -1
- package/script/src/schemas/info/accounts.d.ts +298 -298
- package/script/src/schemas/info/accounts.js +23 -23
- package/script/src/schemas/info/accounts.js.map +1 -1
- package/script/src/schemas/info/assets.d.ts +110 -110
- package/script/src/schemas/info/assets.js +8 -8
- package/script/src/schemas/info/assets.js.map +1 -1
- package/script/src/schemas/info/markets.d.ts +25 -25
- package/script/src/schemas/info/markets.js +2 -2
- package/script/src/schemas/info/markets.js.map +1 -1
- package/script/src/schemas/info/orders.d.ts +104 -104
- package/script/src/schemas/info/orders.js +2 -2
- package/script/src/schemas/info/orders.js.map +1 -1
- package/script/src/schemas/info/requests.d.ts +32 -32
- package/script/src/schemas/info/requests.js +54 -54
- package/script/src/schemas/info/requests.js.map +1 -1
- package/script/src/schemas/info/validators.d.ts +27 -27
- package/script/src/schemas/info/validators.js +5 -5
- package/script/src/schemas/info/validators.js.map +1 -1
- package/script/src/schemas/info/vaults.d.ts +46 -46
- package/script/src/schemas/info/vaults.js +9 -9
- package/script/src/schemas/info/vaults.js.map +1 -1
- package/script/src/schemas/subscriptions/requests.d.ts +4 -4
- package/script/src/schemas/subscriptions/requests.js +16 -16
- package/script/src/schemas/subscriptions/requests.js.map +1 -1
- package/script/src/schemas/subscriptions/responses.d.ts +401 -401
- package/script/src/schemas/subscriptions/responses.js +13 -13
- package/script/src/schemas/subscriptions/responses.js.map +1 -1
- package/script/src/signing/mod.js +37 -4
- package/script/src/signing/mod.js.map +1 -1
- package/script/src/signing/signTypedData/private_key.js +49 -16
- package/script/src/signing/signTypedData/private_key.js.map +1 -1
- package/script/src/transports/_polyfills.d.ts +12 -0
- package/script/src/transports/_polyfills.d.ts.map +1 -0
- package/script/src/transports/_polyfills.js +43 -0
- package/script/src/transports/_polyfills.js.map +1 -0
- package/script/src/transports/base.d.ts +6 -6
- package/script/src/transports/base.d.ts.map +1 -1
- package/script/src/transports/http/http_transport.d.ts +11 -4
- package/script/src/transports/http/http_transport.d.ts.map +1 -1
- package/script/src/transports/http/http_transport.js +17 -6
- package/script/src/transports/http/http_transport.js.map +1 -1
- package/script/src/transports/websocket/_hyperliquid_event_target.d.ts +8 -7
- package/script/src/transports/websocket/_hyperliquid_event_target.d.ts.map +1 -1
- package/script/src/transports/websocket/_hyperliquid_event_target.js +47 -33
- package/script/src/transports/websocket/_hyperliquid_event_target.js.map +1 -1
- package/script/src/transports/websocket/_reconnecting_websocket.d.ts +26 -29
- package/script/src/transports/websocket/_reconnecting_websocket.d.ts.map +1 -1
- package/script/src/transports/websocket/_reconnecting_websocket.js +82 -76
- package/script/src/transports/websocket/_reconnecting_websocket.js.map +1 -1
- package/script/src/transports/websocket/_websocket_async_request.d.ts +6 -0
- package/script/src/transports/websocket/_websocket_async_request.d.ts.map +1 -1
- package/script/src/transports/websocket/_websocket_async_request.js +52 -43
- package/script/src/transports/websocket/_websocket_async_request.js.map +1 -1
- package/script/src/transports/websocket/websocket_transport.d.ts +48 -70
- package/script/src/transports/websocket/websocket_transport.d.ts.map +1 -1
- package/script/src/transports/websocket/websocket_transport.js +92 -105
- package/script/src/transports/websocket/websocket_transport.js.map +1 -1
- package/src/bin/_utils.ts +185 -0
- package/src/bin/cli.ts +49 -171
- package/src/src/clients/exchange.ts +160 -149
- package/src/src/clients/info.ts +128 -128
- package/src/src/clients/multiSign.ts +15 -13
- package/src/src/clients/subscription.ts +32 -32
- package/src/src/schemas/_base.ts +18 -40
- package/src/src/schemas/exchange/requests.ts +202 -199
- package/src/src/schemas/exchange/responses.ts +3 -3
- package/src/src/schemas/explorer/requests.ts +3 -3
- package/src/src/schemas/explorer/responses.ts +3 -3
- package/src/src/schemas/info/accounts.ts +24 -24
- package/src/src/schemas/info/assets.ts +9 -9
- package/src/src/schemas/info/markets.ts +3 -3
- package/src/src/schemas/info/orders.ts +3 -3
- package/src/src/schemas/info/requests.ts +55 -55
- package/src/src/schemas/info/validators.ts +6 -6
- package/src/src/schemas/info/vaults.ts +10 -10
- package/src/src/schemas/subscriptions/requests.ts +17 -17
- package/src/src/schemas/subscriptions/responses.ts +14 -14
- package/src/src/signing/mod.ts +4 -4
- package/src/src/signing/signTypedData/private_key.ts +17 -17
- package/src/src/transports/_polyfills.ts +41 -0
- package/src/src/transports/base.ts +6 -6
- package/src/src/transports/http/http_transport.ts +25 -14
- package/src/src/transports/websocket/_hyperliquid_event_target.ts +24 -51
- package/src/src/transports/websocket/_reconnecting_websocket.ts +107 -119
- package/src/src/transports/websocket/_websocket_async_request.ts +57 -59
- package/src/src/transports/websocket/websocket_transport.ts +126 -167
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { IRequestTransport } from "../transports/base.js";
|
|
2
2
|
import { type ActiveAssetData, ActiveAssetDataRequest, type AllMids, AllMidsRequest, type BlockDetails, BlockDetailsRequest, type Book, type Candle, CandleSnapshotRequest, ClearinghouseStateRequest, type Delegation, DelegationsRequest, DelegatorHistoryRequest, type DelegatorReward, DelegatorRewardsRequest, type DelegatorSummary, DelegatorSummaryRequest, type DelegatorUpdate, type DeployAuctionStatus, type ExchangeStatus, type ExtraAgent, ExtraAgentsRequest, type Fill, FrontendOpenOrdersRequest, type FrontendOrder, type FrontendOrderStatus, type FundingHistory, FundingHistoryRequest, type GossipRootIps, HistoricalOrdersRequest, IsVipRequest, L2BookRequest, LeadingVaultsRequest, type LegalCheck, LegalCheckRequest, type MarginTable, MarginTableRequest, MaxBuilderFeeRequest, MetaAndAssetCtxsRequest, MetaRequest, type MultiSigSigners, OpenOrdersRequest, type Order, type OrderLookup, OrderStatusRequest, type PerpDex, type PerpDexLimits, PerpDexLimitsRequest, PerpsAtOpenInterestCapRequest, type PerpsClearinghouseState, type PerpsMeta, type PerpsMetaAndAssetCtxs, type PortfolioPeriods, PortfolioRequest, type PredictedFunding, type PreTransferCheck, PreTransferCheckRequest, RecentTradesRequest, type Referral, ReferralRequest, type SpotClearinghouseState, SpotClearinghouseStateRequest, type SpotDeployState, SpotDeployStateRequest, type SpotMeta, type SpotMetaAndAssetCtxs, type SubAccount, SubAccountsRequest, type TokenDetails, TokenDetailsRequest, type Trade, type TwapHistory, TwapHistoryRequest, type TwapSliceFill, type TxDetails, TxDetailsRequest, UserDetailsRequest, type UserFees, UserFeesRequest, UserFillsByTimeRequest, UserFillsRequest, UserFundingRequest, type UserFundingUpdate, type UserNonFundingLedgerUpdate, UserNonFundingLedgerUpdatesRequest, type UserRateLimit, UserRateLimitRequest, type UserRole, UserRoleRequest, UserToMultiSigSignersRequest, UserTwapSliceFillsByTimeRequest, UserTwapSliceFillsRequest, UserVaultEquitiesRequest, type ValidatorL1Vote, type ValidatorSummary, type VaultDetails, VaultDetailsRequest, type VaultEquity, type VaultLeading, type VaultSummary, type WebData2, WebData2Request } from "../schemas/mod.js";
|
|
3
|
+
import type * as v from "valibot";
|
|
3
4
|
/** @see https://github.com/microsoft/TypeScript/issues/13923#issuecomment-2191862501 */
|
|
4
5
|
type DeepImmutable<T> = {
|
|
5
6
|
readonly [K in keyof T]: DeepImmutable<T[K]>;
|
|
@@ -10,108 +11,108 @@ export interface InfoClientParameters<T extends IRequestTransport = IRequestTran
|
|
|
10
11
|
transport: T;
|
|
11
12
|
}
|
|
12
13
|
/** Request parameters for the {@linkcode InfoClient.activeAssetData} method. */
|
|
13
|
-
export type ActiveAssetDataParameters = Omit<ActiveAssetDataRequest
|
|
14
|
+
export type ActiveAssetDataParameters = Omit<v.InferInput<typeof ActiveAssetDataRequest>, "type">;
|
|
14
15
|
/** Request parameters for the {@linkcode InfoClient.allMids} method. */
|
|
15
|
-
export type AllMidsParameters = Omit<AllMidsRequest
|
|
16
|
+
export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type">;
|
|
16
17
|
/** Request parameters for the {@linkcode InfoClient.blockDetails} method. */
|
|
17
|
-
export type BlockDetailsParameters = Omit<BlockDetailsRequest
|
|
18
|
+
export type BlockDetailsParameters = Omit<v.InferInput<typeof BlockDetailsRequest>, "type">;
|
|
18
19
|
/** Request parameters for the {@linkcode InfoClient.candleSnapshot} method. */
|
|
19
|
-
export type CandleSnapshotParameters = CandleSnapshotRequest["req"];
|
|
20
|
+
export type CandleSnapshotParameters = v.InferInput<typeof CandleSnapshotRequest>["req"];
|
|
20
21
|
/** Request parameters for the {@linkcode InfoClient.clearinghouseState} method. */
|
|
21
|
-
export type ClearinghouseStateParameters = Omit<ClearinghouseStateRequest
|
|
22
|
+
export type ClearinghouseStateParameters = Omit<v.InferInput<typeof ClearinghouseStateRequest>, "type">;
|
|
22
23
|
/** Request parameters for the {@linkcode InfoClient.delegations} method. */
|
|
23
|
-
export type DelegationsParameters = Omit<DelegationsRequest
|
|
24
|
+
export type DelegationsParameters = Omit<v.InferInput<typeof DelegationsRequest>, "type">;
|
|
24
25
|
/** Request parameters for the {@linkcode InfoClient.delegatorHistory} method. */
|
|
25
|
-
export type DelegatorHistoryParameters = Omit<DelegatorHistoryRequest
|
|
26
|
+
export type DelegatorHistoryParameters = Omit<v.InferInput<typeof DelegatorHistoryRequest>, "type">;
|
|
26
27
|
/** Request parameters for the {@linkcode InfoClient.delegatorRewards} method. */
|
|
27
|
-
export type DelegatorRewardsParameters = Omit<DelegatorRewardsRequest
|
|
28
|
+
export type DelegatorRewardsParameters = Omit<v.InferInput<typeof DelegatorRewardsRequest>, "type">;
|
|
28
29
|
/** Request parameters for the {@linkcode InfoClient.delegatorSummary} method. */
|
|
29
|
-
export type DelegatorSummaryParameters = Omit<DelegatorSummaryRequest
|
|
30
|
+
export type DelegatorSummaryParameters = Omit<v.InferInput<typeof DelegatorSummaryRequest>, "type">;
|
|
30
31
|
/** Request parameters for the {@linkcode InfoClient.extraAgents} method. */
|
|
31
|
-
export type ExtraAgentsParameters = Omit<ExtraAgentsRequest
|
|
32
|
+
export type ExtraAgentsParameters = Omit<v.InferInput<typeof ExtraAgentsRequest>, "type">;
|
|
32
33
|
/** Request parameters for the {@linkcode InfoClient.frontendOpenOrders} method. */
|
|
33
|
-
export type FrontendOpenOrdersParameters = Omit<FrontendOpenOrdersRequest
|
|
34
|
+
export type FrontendOpenOrdersParameters = Omit<v.InferInput<typeof FrontendOpenOrdersRequest>, "type">;
|
|
34
35
|
/** Request parameters for the {@linkcode InfoClient.fundingHistory} method. */
|
|
35
|
-
export type FundingHistoryParameters = Omit<FundingHistoryRequest
|
|
36
|
+
export type FundingHistoryParameters = Omit<v.InferInput<typeof FundingHistoryRequest>, "type">;
|
|
36
37
|
/** Request parameters for the {@linkcode InfoClient.historicalOrders} method. */
|
|
37
|
-
export type HistoricalOrdersParameters = Omit<HistoricalOrdersRequest
|
|
38
|
+
export type HistoricalOrdersParameters = Omit<v.InferInput<typeof HistoricalOrdersRequest>, "type">;
|
|
38
39
|
/** Request parameters for the {@linkcode InfoClient.isVip} method. */
|
|
39
|
-
export type IsVipParameters = Omit<IsVipRequest
|
|
40
|
+
export type IsVipParameters = Omit<v.InferInput<typeof IsVipRequest>, "type">;
|
|
40
41
|
/** Request parameters for the {@linkcode InfoClient.l2Book} method. */
|
|
41
|
-
export type L2BookParameters = Omit<L2BookRequest
|
|
42
|
+
export type L2BookParameters = Omit<v.InferInput<typeof L2BookRequest>, "type">;
|
|
42
43
|
/** Request parameters for the {@linkcode InfoClient.leadingVaults} method. */
|
|
43
|
-
export type LeadingVaultsParameters = Omit<LeadingVaultsRequest
|
|
44
|
+
export type LeadingVaultsParameters = Omit<v.InferInput<typeof LeadingVaultsRequest>, "type">;
|
|
44
45
|
/** Request parameters for the {@linkcode InfoClient.legalCheck} method. */
|
|
45
|
-
export type LegalCheckParameters = Omit<LegalCheckRequest
|
|
46
|
+
export type LegalCheckParameters = Omit<v.InferInput<typeof LegalCheckRequest>, "type">;
|
|
46
47
|
/** Request parameters for the {@linkcode InfoClient.marginTable} method. */
|
|
47
|
-
export type MarginTableParameters = Omit<MarginTableRequest
|
|
48
|
+
export type MarginTableParameters = Omit<v.InferInput<typeof MarginTableRequest>, "type">;
|
|
48
49
|
/** Request parameters for the {@linkcode InfoClient.maxBuilderFee} method. */
|
|
49
|
-
export type MaxBuilderFeeParameters = Omit<MaxBuilderFeeRequest
|
|
50
|
+
export type MaxBuilderFeeParameters = Omit<v.InferInput<typeof MaxBuilderFeeRequest>, "type">;
|
|
50
51
|
/** Request parameters for the {@linkcode InfoClient.meta} method. */
|
|
51
|
-
export type MetaParameters = Omit<MetaRequest
|
|
52
|
+
export type MetaParameters = Omit<v.InferInput<typeof MetaRequest>, "type">;
|
|
52
53
|
/** Request parameters for the {@linkcode InfoClient.metaAndAssetCtxs} method. */
|
|
53
|
-
export type MetaAndAssetCtxsParameters = Omit<MetaAndAssetCtxsRequest
|
|
54
|
+
export type MetaAndAssetCtxsParameters = Omit<v.InferInput<typeof MetaAndAssetCtxsRequest>, "type">;
|
|
54
55
|
/** Request parameters for the {@linkcode InfoClient.openOrders} method. */
|
|
55
|
-
export type OpenOrdersParameters = Omit<OpenOrdersRequest
|
|
56
|
+
export type OpenOrdersParameters = Omit<v.InferInput<typeof OpenOrdersRequest>, "type">;
|
|
56
57
|
/** Request parameters for the {@linkcode InfoClient.orderStatus} method. */
|
|
57
|
-
export type OrderStatusParameters = Omit<OrderStatusRequest
|
|
58
|
+
export type OrderStatusParameters = Omit<v.InferInput<typeof OrderStatusRequest>, "type">;
|
|
58
59
|
/** Request parameters for the {@linkcode InfoClient.perpDexLimits} method. */
|
|
59
|
-
export type PerpDexLimitsParameters = Omit<PerpDexLimitsRequest
|
|
60
|
+
export type PerpDexLimitsParameters = Omit<v.InferInput<typeof PerpDexLimitsRequest>, "type">;
|
|
60
61
|
/** Request parameters for the {@linkcode InfoClient.perpsAtOpenInterestCap} method. */
|
|
61
|
-
export type PerpsAtOpenInterestCapParameters = Omit<PerpsAtOpenInterestCapRequest
|
|
62
|
+
export type PerpsAtOpenInterestCapParameters = Omit<v.InferInput<typeof PerpsAtOpenInterestCapRequest>, "type">;
|
|
62
63
|
/** Request parameters for the {@linkcode InfoClient.portfolio} method. */
|
|
63
|
-
export type PortfolioParameters = Omit<PortfolioRequest
|
|
64
|
+
export type PortfolioParameters = Omit<v.InferInput<typeof PortfolioRequest>, "type">;
|
|
64
65
|
/** Request parameters for the {@linkcode InfoClient.preTransferCheck} method. */
|
|
65
|
-
export type PreTransferCheckParameters = Omit<PreTransferCheckRequest
|
|
66
|
+
export type PreTransferCheckParameters = Omit<v.InferInput<typeof PreTransferCheckRequest>, "type">;
|
|
66
67
|
/** Request parameters for the {@linkcode InfoClient.recentTrades} method. */
|
|
67
|
-
export type RecentTradesParameters = Omit<RecentTradesRequest
|
|
68
|
+
export type RecentTradesParameters = Omit<v.InferInput<typeof RecentTradesRequest>, "type">;
|
|
68
69
|
/** Request parameters for the {@linkcode InfoClient.referral} method. */
|
|
69
|
-
export type ReferralParameters = Omit<ReferralRequest
|
|
70
|
+
export type ReferralParameters = Omit<v.InferInput<typeof ReferralRequest>, "type">;
|
|
70
71
|
/** Request parameters for the {@linkcode InfoClient.spotClearinghouseState} method. */
|
|
71
|
-
export type SpotClearinghouseStateParameters = Omit<SpotClearinghouseStateRequest
|
|
72
|
+
export type SpotClearinghouseStateParameters = Omit<v.InferInput<typeof SpotClearinghouseStateRequest>, "type">;
|
|
72
73
|
/** Request parameters for the {@linkcode InfoClient.spotDeployState} method. */
|
|
73
|
-
export type SpotDeployStateParameters = Omit<SpotDeployStateRequest
|
|
74
|
+
export type SpotDeployStateParameters = Omit<v.InferInput<typeof SpotDeployStateRequest>, "type">;
|
|
74
75
|
/** Request parameters for the {@linkcode InfoClient.subAccounts} method. */
|
|
75
|
-
export type SubAccountsParameters = Omit<SubAccountsRequest
|
|
76
|
+
export type SubAccountsParameters = Omit<v.InferInput<typeof SubAccountsRequest>, "type">;
|
|
76
77
|
/** Request parameters for the {@linkcode InfoClient.tokenDetails} method. */
|
|
77
|
-
export type TokenDetailsParameters = Omit<TokenDetailsRequest
|
|
78
|
+
export type TokenDetailsParameters = Omit<v.InferInput<typeof TokenDetailsRequest>, "type">;
|
|
78
79
|
/** Request parameters for the {@linkcode InfoClient.twapHistory} method. */
|
|
79
|
-
export type TwapHistoryParameters = Omit<TwapHistoryRequest
|
|
80
|
+
export type TwapHistoryParameters = Omit<v.InferInput<typeof TwapHistoryRequest>, "type">;
|
|
80
81
|
/** Request parameters for the {@linkcode InfoClient.txDetails} method. */
|
|
81
|
-
export type TxDetailsParameters = Omit<TxDetailsRequest
|
|
82
|
+
export type TxDetailsParameters = Omit<v.InferInput<typeof TxDetailsRequest>, "type">;
|
|
82
83
|
/** Request parameters for the {@linkcode InfoClient.userDetails} method. */
|
|
83
|
-
export type UserDetailsParameters = Omit<UserDetailsRequest
|
|
84
|
+
export type UserDetailsParameters = Omit<v.InferInput<typeof UserDetailsRequest>, "type">;
|
|
84
85
|
/** Request parameters for the {@linkcode InfoClient.userFees} method. */
|
|
85
|
-
export type UserFeesParameters = Omit<UserFeesRequest
|
|
86
|
+
export type UserFeesParameters = Omit<v.InferInput<typeof UserFeesRequest>, "type">;
|
|
86
87
|
/** Request parameters for the {@linkcode InfoClient.userFills} method. */
|
|
87
|
-
export type UserFillsParameters = Omit<UserFillsRequest
|
|
88
|
+
export type UserFillsParameters = Omit<v.InferInput<typeof UserFillsRequest>, "type">;
|
|
88
89
|
/** Request parameters for the {@linkcode InfoClient.userFillsByTime} method. */
|
|
89
|
-
export type UserFillsByTimeParameters = Omit<UserFillsByTimeRequest
|
|
90
|
+
export type UserFillsByTimeParameters = Omit<v.InferInput<typeof UserFillsByTimeRequest>, "type">;
|
|
90
91
|
/** Request parameters for the {@linkcode InfoClient.userFunding} method. */
|
|
91
|
-
export type UserFundingParameters = Omit<UserFundingRequest
|
|
92
|
+
export type UserFundingParameters = Omit<v.InferInput<typeof UserFundingRequest>, "type">;
|
|
92
93
|
/** Request parameters for the {@linkcode InfoClient.userNonFundingLedgerUpdates} method. */
|
|
93
|
-
export type UserNonFundingLedgerUpdatesParameters = Omit<UserNonFundingLedgerUpdatesRequest
|
|
94
|
+
export type UserNonFundingLedgerUpdatesParameters = Omit<v.InferInput<typeof UserNonFundingLedgerUpdatesRequest>, "type">;
|
|
94
95
|
/** Request parameters for the {@linkcode InfoClient.userRateLimit} method. */
|
|
95
|
-
export type UserRateLimitParameters = Omit<UserRateLimitRequest
|
|
96
|
+
export type UserRateLimitParameters = Omit<v.InferInput<typeof UserRateLimitRequest>, "type">;
|
|
96
97
|
/** Request parameters for the {@linkcode InfoClient.userRole} method. */
|
|
97
|
-
export type UserRoleParameters = Omit<UserRoleRequest
|
|
98
|
+
export type UserRoleParameters = Omit<v.InferInput<typeof UserRoleRequest>, "type">;
|
|
98
99
|
/** Request parameters for the {@linkcode InfoClient.userToMultiSigSigners} method. */
|
|
99
|
-
export type UserToMultiSigSignersParameters = Omit<UserToMultiSigSignersRequest
|
|
100
|
+
export type UserToMultiSigSignersParameters = Omit<v.InferInput<typeof UserToMultiSigSignersRequest>, "type">;
|
|
100
101
|
/** Request parameters for the {@linkcode InfoClient.userTwapSliceFills} method. */
|
|
101
|
-
export type UserTwapSliceFillsParameters = Omit<UserTwapSliceFillsRequest
|
|
102
|
+
export type UserTwapSliceFillsParameters = Omit<v.InferInput<typeof UserTwapSliceFillsRequest>, "type">;
|
|
102
103
|
/** Request parameters for the {@linkcode InfoClient.userTwapSliceFillsByTime} method. */
|
|
103
|
-
export type UserTwapSliceFillsByTimeParameters = Omit<UserTwapSliceFillsByTimeRequest
|
|
104
|
+
export type UserTwapSliceFillsByTimeParameters = Omit<v.InferInput<typeof UserTwapSliceFillsByTimeRequest>, "type">;
|
|
104
105
|
/** Request parameters for the {@linkcode InfoClient.userVaultEquities} method. */
|
|
105
|
-
export type UserVaultEquitiesParameters = Omit<UserVaultEquitiesRequest
|
|
106
|
+
export type UserVaultEquitiesParameters = Omit<v.InferInput<typeof UserVaultEquitiesRequest>, "type">;
|
|
106
107
|
/** Request parameters for the {@linkcode InfoClient.vaultDetails} method. */
|
|
107
|
-
export type VaultDetailsParameters = Omit<VaultDetailsRequest
|
|
108
|
+
export type VaultDetailsParameters = Omit<v.InferInput<typeof VaultDetailsRequest>, "type">;
|
|
108
109
|
/** Request parameters for the {@linkcode InfoClient.webData2} method. */
|
|
109
|
-
export type WebData2Parameters = Omit<WebData2Request
|
|
110
|
+
export type WebData2Parameters = Omit<v.InferInput<typeof WebData2Request>, "type">;
|
|
110
111
|
/**
|
|
111
112
|
* Info client for interacting with the Hyperliquid API.
|
|
112
113
|
* @typeParam T The type of transport used to connect to the Hyperliquid API.
|
|
113
114
|
*/
|
|
114
|
-
export declare class InfoClient<T extends IRequestTransport = IRequestTransport> implements InfoClientParameters<T
|
|
115
|
+
export declare class InfoClient<T extends IRequestTransport = IRequestTransport> implements InfoClientParameters<T> {
|
|
115
116
|
transport: T;
|
|
116
117
|
/**
|
|
117
118
|
* Initialises a new instance.
|
|
@@ -129,7 +130,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
129
130
|
/**
|
|
130
131
|
* Request user active asset data.
|
|
131
132
|
* @param params - An optional request-specific parameters.
|
|
132
|
-
* @param signal - An
|
|
133
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
133
134
|
* @returns User active asset data.
|
|
134
135
|
*
|
|
135
136
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -149,7 +150,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
149
150
|
/**
|
|
150
151
|
* Request mid coin prices.
|
|
151
152
|
* @param params - An optional request-specific parameters.
|
|
152
|
-
* @param signal - An
|
|
153
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
153
154
|
* @returns Mapping of coin symbols to mid prices.
|
|
154
155
|
*
|
|
155
156
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -170,7 +171,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
170
171
|
/**
|
|
171
172
|
* Block details by block height.
|
|
172
173
|
* @param params - Request-specific parameters.
|
|
173
|
-
* @param signal - An
|
|
174
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
174
175
|
* @returns Block details.
|
|
175
176
|
*
|
|
176
177
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -192,7 +193,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
192
193
|
/**
|
|
193
194
|
* Request candlestick snapshots.
|
|
194
195
|
* @param params - Request-specific parameters.
|
|
195
|
-
* @param signal - An
|
|
196
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
196
197
|
* @returns Array of candlestick data points.
|
|
197
198
|
*
|
|
198
199
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -216,7 +217,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
216
217
|
/**
|
|
217
218
|
* Request clearinghouse state.
|
|
218
219
|
* @param params - Request-specific parameters.
|
|
219
|
-
* @param signal - An
|
|
220
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
220
221
|
* @returns Account summary for perpetual trading.
|
|
221
222
|
*
|
|
222
223
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -236,7 +237,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
236
237
|
/**
|
|
237
238
|
* Request user staking delegations.
|
|
238
239
|
* @param params - Request-specific parameters.
|
|
239
|
-
* @param signal - An
|
|
240
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
240
241
|
* @returns Array of user's delegations to validators.
|
|
241
242
|
*
|
|
242
243
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -256,7 +257,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
256
257
|
/**
|
|
257
258
|
* Request user staking history.
|
|
258
259
|
* @param params - Request-specific parameters.
|
|
259
|
-
* @param signal - An
|
|
260
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
260
261
|
* @returns Array of user's staking updates.
|
|
261
262
|
*
|
|
262
263
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -276,7 +277,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
276
277
|
/**
|
|
277
278
|
* Request user staking rewards.
|
|
278
279
|
* @param params - Request-specific parameters.
|
|
279
|
-
* @param signal - An
|
|
280
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
280
281
|
* @returns Array of user's staking rewards.
|
|
281
282
|
*
|
|
282
283
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -296,7 +297,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
296
297
|
/**
|
|
297
298
|
* Request user staking summary.
|
|
298
299
|
* @param params - Request-specific parameters.
|
|
299
|
-
* @param signal - An
|
|
300
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
300
301
|
* @returns Summary of a user's staking delegations.
|
|
301
302
|
*
|
|
302
303
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -315,7 +316,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
315
316
|
delegatorSummary(params: DeepImmutable<DelegatorSummaryParameters>, signal?: AbortSignal): Promise<DelegatorSummary>;
|
|
316
317
|
/**
|
|
317
318
|
* Request exchange status information.
|
|
318
|
-
* @param signal - An
|
|
319
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
319
320
|
* @returns Exchange system status information.
|
|
320
321
|
*
|
|
321
322
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -335,7 +336,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
335
336
|
/**
|
|
336
337
|
* Request user's extra agents.
|
|
337
338
|
* @param params - Request-specific parameters.
|
|
338
|
-
* @param signal - An
|
|
339
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
339
340
|
* @returns User's extra agents.
|
|
340
341
|
*
|
|
341
342
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -355,7 +356,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
355
356
|
/**
|
|
356
357
|
* Request frontend open orders.
|
|
357
358
|
* @param params - Request-specific parameters.
|
|
358
|
-
* @param signal - An
|
|
359
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
359
360
|
* @returns Array of open orders with additional frontend information.
|
|
360
361
|
*
|
|
361
362
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -375,7 +376,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
375
376
|
/**
|
|
376
377
|
* Request funding history.
|
|
377
378
|
* @param params - Request-specific parameters.
|
|
378
|
-
* @param signal - An
|
|
379
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
379
380
|
* @returns Array of historical funding rate data for an asset.
|
|
380
381
|
*
|
|
381
382
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -397,7 +398,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
397
398
|
fundingHistory(params: DeepImmutable<FundingHistoryParameters>, signal?: AbortSignal): Promise<FundingHistory[]>;
|
|
398
399
|
/**
|
|
399
400
|
* Request gossip root IPs.
|
|
400
|
-
* @param signal - An
|
|
401
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
401
402
|
* @returns Array of gossip root IPs.
|
|
402
403
|
*
|
|
403
404
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -417,7 +418,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
417
418
|
/**
|
|
418
419
|
* Request user's historical orders.
|
|
419
420
|
* @param params - Request-specific parameters.
|
|
420
|
-
* @param signal - An
|
|
421
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
421
422
|
* @returns Array of user's historical orders.
|
|
422
423
|
*
|
|
423
424
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -437,7 +438,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
437
438
|
/**
|
|
438
439
|
* Request to check if a user is a VIP.
|
|
439
440
|
* @param params - Request-specific parameters.
|
|
440
|
-
* @param signal - An
|
|
441
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
441
442
|
* @returns Boolean indicating user's VIP status.
|
|
442
443
|
*
|
|
443
444
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -457,7 +458,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
457
458
|
/**
|
|
458
459
|
* Request L2 order book.
|
|
459
460
|
* @param params - Request-specific parameters.
|
|
460
|
-
* @param signal - An
|
|
461
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
461
462
|
* @returns L2 order book snapshot.
|
|
462
463
|
*
|
|
463
464
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -477,7 +478,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
477
478
|
/**
|
|
478
479
|
* Request leading vaults for a user.
|
|
479
480
|
* @param params - Request-specific parameters.
|
|
480
|
-
* @param signal - An
|
|
481
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
481
482
|
* @returns
|
|
482
483
|
*
|
|
483
484
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -497,7 +498,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
497
498
|
/**
|
|
498
499
|
* Request legal verification status of a user.
|
|
499
500
|
* @param params - Request-specific parameters.
|
|
500
|
-
* @param signal - An
|
|
501
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
501
502
|
* @returns Legal verification status for a user.
|
|
502
503
|
*
|
|
503
504
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -516,7 +517,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
516
517
|
legalCheck(params: DeepImmutable<LegalCheckParameters>, signal?: AbortSignal): Promise<LegalCheck>;
|
|
517
518
|
/**
|
|
518
519
|
* Request liquidatable.
|
|
519
|
-
* @param signal - An
|
|
520
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
520
521
|
* @returns
|
|
521
522
|
*
|
|
522
523
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -536,7 +537,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
536
537
|
/**
|
|
537
538
|
* Request margin table data.
|
|
538
539
|
* @param params - Request-specific parameters.
|
|
539
|
-
* @param signal - An
|
|
540
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
540
541
|
* @returns Margin requirements table with multiple tiers.
|
|
541
542
|
*
|
|
542
543
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -556,7 +557,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
556
557
|
/**
|
|
557
558
|
* Request builder fee approval.
|
|
558
559
|
* @param params - Request-specific parameters.
|
|
559
|
-
* @param signal - An
|
|
560
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
560
561
|
* @returns Maximum builder fee approval.
|
|
561
562
|
*
|
|
562
563
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -575,7 +576,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
575
576
|
maxBuilderFee(params: DeepImmutable<MaxBuilderFeeParameters>, signal?: AbortSignal): Promise<number>;
|
|
576
577
|
/**
|
|
577
578
|
* Request maximum market order notionals.
|
|
578
|
-
* @param signal - An
|
|
579
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
579
580
|
* @returns
|
|
580
581
|
*
|
|
581
582
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -595,7 +596,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
595
596
|
/**
|
|
596
597
|
* Request trading metadata.
|
|
597
598
|
* @param params - An optional request-specific parameters.
|
|
598
|
-
* @param signal - An
|
|
599
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
599
600
|
* @returns Metadata for perpetual assets.
|
|
600
601
|
*
|
|
601
602
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -615,7 +616,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
615
616
|
meta(signal?: AbortSignal): Promise<PerpsMeta>;
|
|
616
617
|
/**
|
|
617
618
|
* Request metadata and asset contexts.
|
|
618
|
-
* @param signal - An
|
|
619
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
619
620
|
* @returns Metadata and context for perpetual assets.
|
|
620
621
|
*
|
|
621
622
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -636,7 +637,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
636
637
|
/**
|
|
637
638
|
* Request open orders.
|
|
638
639
|
* @param params - Request-specific parameters.
|
|
639
|
-
* @param signal - An
|
|
640
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
640
641
|
* @returns Array of open order.
|
|
641
642
|
*
|
|
642
643
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -656,7 +657,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
656
657
|
/**
|
|
657
658
|
* Request order status.
|
|
658
659
|
* @param params - Request-specific parameters.
|
|
659
|
-
* @param signal - An
|
|
660
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
660
661
|
* @returns Result of an order status lookup.
|
|
661
662
|
*
|
|
662
663
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -675,7 +676,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
675
676
|
orderStatus(params: DeepImmutable<OrderStatusParameters>, signal?: AbortSignal): Promise<OrderLookup>;
|
|
676
677
|
/**
|
|
677
678
|
* Request for the status of the perpetual deploy auction.
|
|
678
|
-
* @param signal - An
|
|
679
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
679
680
|
* @returns Status of the perpetual deploy auction.
|
|
680
681
|
*
|
|
681
682
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -694,7 +695,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
694
695
|
perpDeployAuctionStatus(signal?: AbortSignal): Promise<DeployAuctionStatus>;
|
|
695
696
|
/**
|
|
696
697
|
* Request builder deployed perpetual market limits.
|
|
697
|
-
* @param signal - An
|
|
698
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
698
699
|
* @returns Status of the perpetual deploy auction.
|
|
699
700
|
*
|
|
700
701
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -713,7 +714,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
713
714
|
perpDexLimits(params: DeepImmutable<PerpDexLimitsParameters>, signal?: AbortSignal): Promise<PerpDexLimits | null>;
|
|
714
715
|
/**
|
|
715
716
|
* Request all perpetual dexs.
|
|
716
|
-
* @param signal - An
|
|
717
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
717
718
|
* @returns Array of perpetual dexes (null is main dex).
|
|
718
719
|
*
|
|
719
720
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -732,7 +733,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
732
733
|
perpDexs(signal?: AbortSignal): Promise<(PerpDex | null)[]>;
|
|
733
734
|
/**
|
|
734
735
|
* Request perpetuals at open interest cap.
|
|
735
|
-
* @param signal - An
|
|
736
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
736
737
|
* @returns Array of perpetuals at open interest caps.
|
|
737
738
|
*
|
|
738
739
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -753,7 +754,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
753
754
|
/**
|
|
754
755
|
* Request user portfolio.
|
|
755
756
|
* @param params - Request-specific parameters.
|
|
756
|
-
* @param signal - An
|
|
757
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
757
758
|
* @returns Portfolio metrics grouped by time periods.
|
|
758
759
|
*
|
|
759
760
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -772,7 +773,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
772
773
|
portfolio(params: DeepImmutable<PortfolioParameters>, signal?: AbortSignal): Promise<PortfolioPeriods>;
|
|
773
774
|
/**
|
|
774
775
|
* Request predicted funding rates.
|
|
775
|
-
* @param signal - An
|
|
776
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
776
777
|
* @returns Array of predicted funding rates.
|
|
777
778
|
*
|
|
778
779
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -792,7 +793,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
792
793
|
/**
|
|
793
794
|
* Request user's existence check before transfer.
|
|
794
795
|
* @param params - Request-specific parameters.
|
|
795
|
-
* @param signal - An
|
|
796
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
796
797
|
* @returns Pre-transfer user existence check result.
|
|
797
798
|
*
|
|
798
799
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -812,7 +813,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
812
813
|
/**
|
|
813
814
|
* Request recent trades.
|
|
814
815
|
* @param params - Request-specific parameters.
|
|
815
|
-
* @param signal - An
|
|
816
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
816
817
|
* @returns Array of recent trades.
|
|
817
818
|
*
|
|
818
819
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -832,7 +833,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
832
833
|
/**
|
|
833
834
|
* Request user referral.
|
|
834
835
|
* @param params - Request-specific parameters.
|
|
835
|
-
* @param signal - An
|
|
836
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
836
837
|
* @returns Referral information for a user.
|
|
837
838
|
*
|
|
838
839
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -852,7 +853,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
852
853
|
/**
|
|
853
854
|
* Request spot clearinghouse state.
|
|
854
855
|
* @param params - Request-specific parameters.
|
|
855
|
-
* @param signal - An
|
|
856
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
856
857
|
* @returns Account summary for spot trading.
|
|
857
858
|
*
|
|
858
859
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -872,7 +873,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
872
873
|
/**
|
|
873
874
|
* Request spot deploy state.
|
|
874
875
|
* @param params - Request-specific parameters.
|
|
875
|
-
* @param signal - An
|
|
876
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
876
877
|
* @returns Deploy state for spot tokens.
|
|
877
878
|
*
|
|
878
879
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -891,7 +892,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
891
892
|
spotDeployState(params: DeepImmutable<SpotDeployStateParameters>, signal?: AbortSignal): Promise<SpotDeployState>;
|
|
892
893
|
/**
|
|
893
894
|
* Request spot trading metadata.
|
|
894
|
-
* @param signal - An
|
|
895
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
895
896
|
* @returns Metadata for spot assets.
|
|
896
897
|
*
|
|
897
898
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -910,7 +911,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
910
911
|
spotMeta(signal?: AbortSignal): Promise<SpotMeta>;
|
|
911
912
|
/**
|
|
912
913
|
* Request spot metadata and asset contexts.
|
|
913
|
-
* @param signal - An
|
|
914
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
914
915
|
* @returns Metadata and context for spot assets.
|
|
915
916
|
*
|
|
916
917
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -929,7 +930,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
929
930
|
spotMetaAndAssetCtxs(signal?: AbortSignal): Promise<SpotMetaAndAssetCtxs>;
|
|
930
931
|
/**
|
|
931
932
|
* Request for the status of the spot deploy auction.
|
|
932
|
-
* @param signal - An
|
|
933
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
933
934
|
* @returns Status of the spot deploy auction.
|
|
934
935
|
*
|
|
935
936
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -949,7 +950,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
949
950
|
/**
|
|
950
951
|
* Request user sub-accounts.
|
|
951
952
|
* @param params - Request-specific parameters.
|
|
952
|
-
* @param signal - An
|
|
953
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
953
954
|
* @returns Array of user sub-account or null if the user does not have any sub-accounts.
|
|
954
955
|
*
|
|
955
956
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -969,7 +970,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
969
970
|
/**
|
|
970
971
|
* Request token details.
|
|
971
972
|
* @param params - Request-specific parameters.
|
|
972
|
-
* @param signal - An
|
|
973
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
973
974
|
* @returns Details of a token.
|
|
974
975
|
*
|
|
975
976
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -989,7 +990,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
989
990
|
/**
|
|
990
991
|
* Request twap history of a user.
|
|
991
992
|
* @param params - Request-specific parameters.
|
|
992
|
-
* @param signal - An
|
|
993
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
993
994
|
* @returns Array of user's TWAP history.
|
|
994
995
|
*
|
|
995
996
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1009,7 +1010,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1009
1010
|
/**
|
|
1010
1011
|
* Request transaction details by transaction hash.
|
|
1011
1012
|
* @param params - Request-specific parameters.
|
|
1012
|
-
* @param signal - An
|
|
1013
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1013
1014
|
* @returns Transaction details.
|
|
1014
1015
|
*
|
|
1015
1016
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1031,7 +1032,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1031
1032
|
/**
|
|
1032
1033
|
* Request user details by user's address.
|
|
1033
1034
|
* @param params - Request-specific parameters.
|
|
1034
|
-
* @param signal - An
|
|
1035
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1035
1036
|
* @returns User details.
|
|
1036
1037
|
*
|
|
1037
1038
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1053,7 +1054,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1053
1054
|
/**
|
|
1054
1055
|
* Request user fees.
|
|
1055
1056
|
* @param params - Request-specific parameters.
|
|
1056
|
-
* @param signal - An
|
|
1057
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1057
1058
|
* @returns User fees.
|
|
1058
1059
|
*
|
|
1059
1060
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1073,7 +1074,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1073
1074
|
/**
|
|
1074
1075
|
* Request user fills.
|
|
1075
1076
|
* @param params - Request-specific parameters.
|
|
1076
|
-
* @param signal - An
|
|
1077
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1077
1078
|
* @returns Array of user's trade fill.
|
|
1078
1079
|
*
|
|
1079
1080
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1093,7 +1094,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1093
1094
|
/**
|
|
1094
1095
|
* Request user fills by time.
|
|
1095
1096
|
* @param params - Request-specific parameters.
|
|
1096
|
-
* @param signal - An
|
|
1097
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1097
1098
|
* @returns Array of user's trade fill.
|
|
1098
1099
|
*
|
|
1099
1100
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1116,7 +1117,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1116
1117
|
/**
|
|
1117
1118
|
* Request user funding.
|
|
1118
1119
|
* @param params - Request-specific parameters.
|
|
1119
|
-
* @param signal - An
|
|
1120
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1120
1121
|
* @returns Array of user's funding ledger update.
|
|
1121
1122
|
*
|
|
1122
1123
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1139,7 +1140,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1139
1140
|
/**
|
|
1140
1141
|
* Request user non-funding ledger updates.
|
|
1141
1142
|
* @param params - Request-specific parameters.
|
|
1142
|
-
* @param signal - An
|
|
1143
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1143
1144
|
* @returns Array of user's non-funding ledger update.
|
|
1144
1145
|
*
|
|
1145
1146
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1162,7 +1163,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1162
1163
|
/**
|
|
1163
1164
|
* Request user rate limits.
|
|
1164
1165
|
* @param params - Request-specific parameters.
|
|
1165
|
-
* @param signal - An
|
|
1166
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1166
1167
|
* @returns User's rate limits.
|
|
1167
1168
|
*
|
|
1168
1169
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1182,7 +1183,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1182
1183
|
/**
|
|
1183
1184
|
* Request user role.
|
|
1184
1185
|
* @param params - Request-specific parameters.
|
|
1185
|
-
* @param signal - An
|
|
1186
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1186
1187
|
* @returns User's role.
|
|
1187
1188
|
*
|
|
1188
1189
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1202,7 +1203,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1202
1203
|
/**
|
|
1203
1204
|
* Request multi-sig signers for a user.
|
|
1204
1205
|
* @param params - Request-specific parameters.
|
|
1205
|
-
* @param signal - An
|
|
1206
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1206
1207
|
* @returns Multi-sig signers for a user or null if the user does not have any multi-sig signers.
|
|
1207
1208
|
*
|
|
1208
1209
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1222,7 +1223,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1222
1223
|
/**
|
|
1223
1224
|
* Request user twap slice fills.
|
|
1224
1225
|
* @param params - Request-specific parameters.
|
|
1225
|
-
* @param signal - An
|
|
1226
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1226
1227
|
* @returns Array of user's twap slice fill.
|
|
1227
1228
|
*
|
|
1228
1229
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1242,7 +1243,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1242
1243
|
/**
|
|
1243
1244
|
* Request user twap slice fills by time.
|
|
1244
1245
|
* @param params - Request-specific parameters.
|
|
1245
|
-
* @param signal - An
|
|
1246
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1246
1247
|
* @returns Array of user's twap slice fill.
|
|
1247
1248
|
*
|
|
1248
1249
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1265,7 +1266,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1265
1266
|
/**
|
|
1266
1267
|
* Request user vault deposits.
|
|
1267
1268
|
* @param params - Request-specific parameters.
|
|
1268
|
-
* @param signal - An
|
|
1269
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1269
1270
|
* @returns Array of user's vault deposits.
|
|
1270
1271
|
*
|
|
1271
1272
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1284,7 +1285,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1284
1285
|
userVaultEquities(params: DeepImmutable<UserVaultEquitiesParameters>, signal?: AbortSignal): Promise<VaultEquity[]>;
|
|
1285
1286
|
/**
|
|
1286
1287
|
* Request validator L1 votes.
|
|
1287
|
-
* @param signal - An
|
|
1288
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1288
1289
|
* @returns
|
|
1289
1290
|
*
|
|
1290
1291
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1303,7 +1304,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1303
1304
|
validatorL1Votes(signal?: AbortSignal): Promise<ValidatorL1Vote[]>;
|
|
1304
1305
|
/**
|
|
1305
1306
|
* Request validator summaries.
|
|
1306
|
-
* @param signal - An
|
|
1307
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1307
1308
|
* @returns Array of validator summaries.
|
|
1308
1309
|
*
|
|
1309
1310
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1323,7 +1324,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1323
1324
|
/**
|
|
1324
1325
|
* Request details of a vault.
|
|
1325
1326
|
* @param params - Request-specific parameters.
|
|
1326
|
-
* @param signal - An
|
|
1327
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1327
1328
|
* @returns Details of a vault or null if the vault does not exist.
|
|
1328
1329
|
*
|
|
1329
1330
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1342,7 +1343,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1342
1343
|
vaultDetails(params: DeepImmutable<VaultDetailsParameters>, signal?: AbortSignal): Promise<VaultDetails | null>;
|
|
1343
1344
|
/**
|
|
1344
1345
|
* Request a list of vaults less than 2 hours old.
|
|
1345
|
-
* @param signal - An
|
|
1346
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1346
1347
|
* @returns Array of vault summaries.
|
|
1347
1348
|
*
|
|
1348
1349
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1362,7 +1363,7 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1362
1363
|
/**
|
|
1363
1364
|
* Request comprehensive user and market data.
|
|
1364
1365
|
* @param params - Request-specific parameters.
|
|
1365
|
-
* @param signal - An
|
|
1366
|
+
* @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
|
1366
1367
|
* @returns Comprehensive user and market data.
|
|
1367
1368
|
*
|
|
1368
1369
|
* @throws {TransportError} When the transport layer throws an error.
|
|
@@ -1379,7 +1380,6 @@ export declare class InfoClient<T extends IRequestTransport = IRequestTransport>
|
|
|
1379
1380
|
* ```
|
|
1380
1381
|
*/
|
|
1381
1382
|
webData2(params: DeepImmutable<WebData2Parameters>, signal?: AbortSignal): Promise<WebData2>;
|
|
1382
|
-
[Symbol.asyncDispose](): Promise<void>;
|
|
1383
1383
|
}
|
|
1384
1384
|
export {};
|
|
1385
1385
|
//# sourceMappingURL=info.d.ts.map
|