@nktkas/hyperliquid 0.22.1 → 0.23.0

package/esm/src/clients/info.js

@@ -32,9 +32,11 @@ export class InfoClient {
      * Block details by block height.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns Block details response.
+     * @returns Block details.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -59,6 +61,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of candlestick data points.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
      * @example
      * ```ts
@@ -87,6 +91,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Account summary for perpetual trading.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
      * @example
      * ```ts
@@ -111,6 +117,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's delegations to validators.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
      * @example
      * ```ts
@@ -135,6 +143,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's staking updates.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
      * @example
      * ```ts
@@ -159,6 +169,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's staking rewards.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-rewards
      * @example
      * ```ts
@@ -183,6 +195,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Summary of a user's staking delegations.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
      * @example
      * ```ts
@@ -207,7 +221,9 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns User's extra agents.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -231,6 +247,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of open orders with additional frontend information.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
      * @example
      * ```ts
@@ -255,6 +273,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of historical funding rate data for an asset.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
      * @example
      * ```ts
@@ -282,6 +302,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's historical orders.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
      * @example
      * ```ts
@@ -306,7 +328,9 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Boolean indicating user's VIP status.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -330,6 +354,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns L2 order book snapshot.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
      * @example
      * ```ts
@@ -354,7 +380,9 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Legal verification status for a user.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -378,6 +406,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Maximum builder fee approval.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
      * @example
      * ```ts
@@ -408,7 +438,9 @@ export class InfoClient {
     /**
      * Request metadata and asset contexts.
      * @param signal - An optional abort signal.
-     * @returns Metadata and context information for each perpetual asset.
+     * @returns Metadata and context for perpetual assets.
+     *
+     * @throws {TransportError} When the transport layer throws an error.
      *
      * @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
      * @example
@@ -433,6 +465,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of open order.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
      * @example
      * ```ts
@@ -457,6 +491,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Result of an order status lookup.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
      * @example
      * ```ts
@@ -480,6 +516,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Status of the perpetual deploy auction.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
      * @example
      * ```ts
@@ -500,7 +538,9 @@ export class InfoClient {
     /**
      * Request all perpetual dexs.
      * @param signal - An optional abort signal.
-     * @returns Array of perpetual dexes.
+     * @returns Array of perpetual dexes (null is main dex).
+     *
+     * @throws {TransportError} When the transport layer throws an error.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
      * @example
@@ -525,6 +565,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of perpetuals at open interest caps.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
      * @example
      * ```ts
@@ -543,10 +585,12 @@ export class InfoClient {
         return this.transport.request("info", request, signal);
     }
     /**
-     * Request portfolio.
+     * Request user portfolio.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns Portfolio of a user.
+     * @returns Portfolio metrics grouped by time periods.
+     *
+     * @throws {TransportError} When the transport layer throws an error.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
      * @example
@@ -571,6 +615,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of predicted funding rates.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
      * @example
      * ```ts
@@ -594,7 +640,9 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Pre-transfer user existence check result.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -618,6 +666,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Referral information for a user.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
      * @example
      * ```ts
@@ -640,7 +690,9 @@ export class InfoClient {
      * Request spot clearinghouse state.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns Balances for spot tokens.
+     * @returns Account summary for spot trading.
+     *
+     * @throws {TransportError} When the transport layer throws an error.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
      * @example
@@ -664,7 +716,9 @@ export class InfoClient {
      * Request spot deploy state.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns The deploy state of a user.
+     * @returns Deploy state for spot tokens.
+     *
+     * @throws {TransportError} When the transport layer throws an error.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
      * @example
@@ -689,6 +743,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Metadata for spot assets.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
      * @example
      * ```ts
@@ -709,7 +765,9 @@ export class InfoClient {
     /**
      * Request spot metadata and asset contexts.
      * @param signal - An optional abort signal.
-     * @returns Metadata and context information for each spot asset.
+     * @returns Metadata and context for spot assets.
+     *
+     * @throws {TransportError} When the transport layer throws an error.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
      * @example
@@ -734,6 +792,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user sub-account or null if the user does not have any sub-accounts.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
      * @example
      * ```ts
@@ -756,7 +816,9 @@ export class InfoClient {
      * Request token details.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns The details of a token.
+     * @returns Details of a token.
+     *
+     * @throws {TransportError} When the transport layer throws an error.
      *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
      * @example
@@ -780,9 +842,11 @@ export class InfoClient {
      * Request twap history of a user.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns The twap history of a user.
+     * @returns Array of user's TWAP history.
+     *
+     * @throws {TransportError} When the transport layer throws an error.
      *
-     * @see null - no documentation
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -801,12 +865,14 @@ export class InfoClient {
         return this.transport.request("info", request, signal);
     }
     /**
-     * Transaction details by transaction hash.
+     * Request transaction details by transaction hash.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns Transaction details response.
+     * @returns Transaction details.
+     *
+     * @throws {TransportError} When the transport layer throws an error.
      *
-     * @see null - no documentation
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -826,12 +892,14 @@ export class InfoClient {
         return tx;
     }
     /**
-     * User details by user's address.
+     * Request user details by user's address.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns User details response.
+     * @returns User details.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -856,7 +924,9 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns User fees.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -880,6 +950,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's trade fill.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
      * @example
      * ```ts
@@ -904,6 +976,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's trade fill.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
      * @example
      * ```ts
@@ -931,6 +1005,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's funding ledger update.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
      * @example
      * ```ts
@@ -958,6 +1034,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's non-funding ledger update.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
      * @example
      * ```ts
@@ -985,6 +1063,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns User's rate limits.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
      * @example
      * ```ts
@@ -1009,6 +1089,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns User's role.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
      * @example
      * ```ts
@@ -1033,7 +1115,9 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Multi-sig signers for a user or null if the user does not have any multi-sig signers.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -1057,6 +1141,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's twap slice fill.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
      * @example
      * ```ts
@@ -1081,7 +1167,9 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's twap slice fill.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -1108,6 +1196,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of user's vault deposits.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
      * @example
      * ```ts
@@ -1116,7 +1206,7 @@ export class InfoClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const infoClient = new hl.InfoClient({ transport });
      *
-     * const data = await infoClient.userVaultDeposits({ user: "0x..." });
+     * const data = await infoClient.userVaultEquities({ user: "0x..." });
      * ```
      */
     userVaultEquities(args, signal) {
@@ -1131,7 +1221,9 @@ export class InfoClient {
      * @param args - The parameters for the request.
      * @returns Array of validator summaries.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -1154,6 +1246,8 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Details of a vault or null if the vault does not exist.
      *
+     * @throws {TransportError} When the transport layer throws an error.
+     *
      * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
      * @example
      * ```ts
@@ -1178,7 +1272,9 @@ export class InfoClient {
      * @param signal - An optional abort signal.
      * @returns Array of vault summaries.
      *
-     * @see null - no documentation
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @see null
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";