@nktkas/hyperliquid 0.30.3 → 0.31.0

package/esm/src/api/info/client.js

@@ -99,15 +99,78 @@ export class InfoClient {
     constructor(config) {
         this.config_ = config;
     }
-    /** @see {@link activeAssetData} */
+    /**
+     * Request user active asset data.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns User active asset data.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.activeAssetData({ user: "0x...", coin: "ETH" });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-active-asset-data
+     */
     activeAssetData(params, signal) {
         return activeAssetData(this.config_, params, signal);
     }
-    /** @see {@link alignedQuoteTokenInfo} */
+    /**
+     * Request supply, rate, and pending payment information for an aligned quote token.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Supply, rate, and pending payment information for an aligned quote token.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.alignedQuoteTokenInfo({ token: 1328 });
+     * ```
+     */
     alignedQuoteTokenInfo(params, signal) {
         return alignedQuoteTokenInfo(this.config_, params, signal);
     }
-    /** @see {@link allBorrowLendReserveStates} */
+    /**
+     * Request all borrow/lend reserve states.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of tuples of reserve IDs and their borrow/lend reserve state.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.allBorrowLendReserveStates();
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-all-borrow-lend-reserve-states
+     */
     allBorrowLendReserveStates(signal) {
         return allBorrowLendReserveStates(this.config_, signal);
     }
@@ -116,99 +179,600 @@ export class InfoClient {
         const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
         return allMids(this.config_, params, signal);
     }
-    /** @see {@link allPerpMetas} */
+    /**
+     * Request trading metadata for all DEXes.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Metadata for perpetual assets across all DEXes.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.allPerpMetas();
+     * ```
+     */
     allPerpMetas(signal) {
         return allPerpMetas(this.config_, signal);
     }
-    /** @see {@link blockDetails} */
+    /**
+     * Request block details by block height.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Response containing block information.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.blockDetails({ height: 123 });
+     * ```
+     */
     blockDetails(params, signal) {
         return blockDetails(this.config_, params, signal);
     }
-    /** @see {@link borrowLendReserveState} */
+    /**
+     * Request borrow/lend reserve state.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Borrow/lend reserve state.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.borrowLendReserveState({ token: 0 });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-reserve-state
+     */
     borrowLendReserveState(params, signal) {
         return borrowLendReserveState(this.config_, params, signal);
     }
-    /** @see {@link borrowLendUserState} */
+    /**
+     * Request borrow/lend user state.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns User's borrow/lend state.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.borrowLendUserState({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-user-state
+     */
     borrowLendUserState(params, signal) {
         return borrowLendUserState(this.config_, params, signal);
     }
-    /** @see {@link candleSnapshot} */
+    /**
+     * Request candlestick snapshots.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of candlestick data points.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.candleSnapshot({ coin: "ETH", interval: "1h", startTime: Date.now() - 1000 * 60 * 60 * 24 });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
+     */
     candleSnapshot(params, signal) {
         return candleSnapshot(this.config_, params, signal);
     }
-    /** @see {@link clearinghouseState} */
+    /**
+     * Request clearinghouse state.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Account summary for perpetual trading.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.clearinghouseState({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
+     */
     clearinghouseState(params, signal) {
         return clearinghouseState(this.config_, params, signal);
     }
-    /** @see {@link delegations} */
+    /**
+     * Request user staking delegations.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user's delegations to validators.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.delegations({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
+     */
     delegations(params, signal) {
         return delegations(this.config_, params, signal);
     }
-    /** @see {@link delegatorHistory} */
+    /**
+     * Request user staking history.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of records of staking events by a delegator.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.delegatorHistory({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
+     */
     delegatorHistory(params, signal) {
         return delegatorHistory(this.config_, params, signal);
     }
-    /** @see {@link delegatorRewards} */
+    /**
+     * Request user staking rewards.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of rewards received from staking activities.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.delegatorRewards({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-rewards
+     */
     delegatorRewards(params, signal) {
         return delegatorRewards(this.config_, params, signal);
     }
-    /** @see {@link delegatorSummary} */
+    /**
+     * Request user's staking summary.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns User's staking summary.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.delegatorSummary({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
+     */
     delegatorSummary(params, signal) {
         return delegatorSummary(this.config_, params, signal);
     }
-    /** @see {@link exchangeStatus} */
+    /**
+     * Request exchange system status information.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Exchange system status information.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.exchangeStatus();
+     * ```
+     */
     exchangeStatus(signal) {
         return exchangeStatus(this.config_, signal);
     }
-    /** @see {@link extraAgents} */
+    /**
+     * Request user extra agents.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of extra agent details for a user.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.extraAgents({ user: "0x..." });
+     * ```
+     */
     extraAgents(params, signal) {
         return extraAgents(this.config_, params, signal);
     }
-    /** @see {@link frontendOpenOrders} */
+    /**
+     * Request frontend open orders.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of open orders with additional display information.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.frontendOpenOrders({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
+     */
     frontendOpenOrders(params, signal) {
         return frontendOpenOrders(this.config_, params, signal);
     }
-    /** @see {@link fundingHistory} */
+    /**
+     * Request funding history.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of historical funding rate records for an asset.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.fundingHistory({ coin: "ETH", startTime: Date.now() - 1000 * 60 * 60 * 24 });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
+     */
     fundingHistory(params, signal) {
         return fundingHistory(this.config_, params, signal);
     }
-    /** @see {@link gossipRootIps} */
+    /**
+     * Request gossip root IPs.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of gossip root IPs.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.gossipRootIps();
+     * ```
+     */
     gossipRootIps(signal) {
         return gossipRootIps(this.config_, signal);
     }
-    /** @see {@link historicalOrders} */
-    historicalOrders(params, signal) {
-        return historicalOrders(this.config_, params, signal);
-    }
-    /** @see {@link isVip} */
-    isVip(params, signal) {
-        return isVip(this.config_, params, signal);
-    }
-    /** @see {@link l2Book} */
-    l2Book(params, signal) {
-        return l2Book(this.config_, params, signal);
-    }
-    /** @see {@link leadingVaults} */
-    leadingVaults(params, signal) {
+    /**
+     * Request user historical orders.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of frontend orders with current processing status.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.historicalOrders({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
+     */
+    historicalOrders(params, signal) {
+        return historicalOrders(this.config_, params, signal);
+    }
+    /**
+     * Request to check if a user is a VIP.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Boolean indicating user's VIP status.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.isVip({ user: "0x..." });
+     * ```
+     */
+    isVip(params, signal) {
+        return isVip(this.config_, params, signal);
+    }
+    /**
+     * Request L2 order book.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns L2 order book snapshot.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.l2Book({ coin: "ETH", nSigFigs: 2 });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
+     */
+    l2Book(params, signal) {
+        return l2Book(this.config_, params, signal);
+    }
+    /**
+     * Request leading vaults for a user.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of leading vaults for a user.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.leadingVaults({ user: "0x..." });
+     * ```
+     */
+    leadingVaults(params, signal) {
         return leadingVaults(this.config_, params, signal);
     }
-    /** @see {@link legalCheck} */
+    /**
+     * Request legal verification status of a user.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Legal verification status for a user.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.legalCheck({ user: "0x..." });
+     * ```
+     */
     legalCheck(params, signal) {
         return legalCheck(this.config_, params, signal);
     }
-    /** @see {@link liquidatable} */
+    /**
+     * Request liquidatable.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns unknown
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.liquidatable();
+     * ```
+     */
     liquidatable(signal) {
         return liquidatable(this.config_, signal);
     }
-    /** @see {@link marginTable} */
+    /**
+     * Request margin table data.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Margin requirements table with multiple tiers.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.marginTable({ id: 1 });
+     * ```
+     */
     marginTable(params, signal) {
         return marginTable(this.config_, params, signal);
     }
-    /** @see {@link maxBuilderFee} */
+    /**
+     * Request builder fee approval.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Maximum builder fee approval.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.maxBuilderFee({ user: "0x...", builder: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
+     */
     maxBuilderFee(params, signal) {
         return maxBuilderFee(this.config_, params, signal);
     }
-    /** @see {@link maxMarketOrderNtls} */
+    /**
+     * Request maximum market order notionals.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Maximum market order notionals.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.maxMarketOrderNtls();
+     * ```
+     */
     maxMarketOrderNtls(signal) {
         return maxMarketOrderNtls(this.config_, signal);
     }
@@ -222,27 +786,157 @@ export class InfoClient {
         const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
         return metaAndAssetCtxs(this.config_, params, signal);
     }
-    /** @see {@link openOrders} */
+    /**
+     * Request open orders.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of open orders.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.openOrders({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
+     */
     openOrders(params, signal) {
         return openOrders(this.config_, params, signal);
     }
-    /** @see {@link orderStatus} */
+    /**
+     * Request order status.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Order status response.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.orderStatus({ user: "0x...", oid: 12345 });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
+     */
     orderStatus(params, signal) {
         return orderStatus(this.config_, params, signal);
     }
-    /** @see {@link perpDeployAuctionStatus} */
+    /**
+     * Request for the status of the perpetual deploy auction.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Status of the perpetual deploy auction.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.perpDeployAuctionStatus();
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+     */
     perpDeployAuctionStatus(signal) {
         return perpDeployAuctionStatus(this.config_, signal);
     }
-    /** @see {@link perpDexLimits} */
+    /**
+     * Request builder deployed perpetual market limits.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Builder deployed perpetual market limits.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.perpDexLimits({ dex: "test" });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+     */
     perpDexLimits(params, signal) {
         return perpDexLimits(this.config_, params, signal);
     }
-    /** @see {@link perpDexs} */
+    /**
+     * Request all perpetual dexs.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of perpetual dexes (null is main dex).
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.perpDexs();
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+     */
     perpDexs(signal) {
         return perpDexs(this.config_, signal);
     }
-    /** @see {@link perpDexStatus} */
+    /**
+     * Request perp DEX status.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - An {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} can be used to cancel the request.
+     *
+     * @returns Status of a perp DEX.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.perpDexStatus({ dex: "test" });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#get-perp-market-status
+     */
     perpDexStatus(params, signal) {
         return perpDexStatus(this.config_, params, signal);
     }
@@ -251,139 +945,856 @@ export class InfoClient {
         const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
         return perpsAtOpenInterestCap(this.config_, params, signal);
     }
-    /** @see {@link portfolio} */
+    /**
+     * Request user portfolio.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Portfolio metrics grouped by time periods.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.portfolio({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+     */
     portfolio(params, signal) {
         return portfolio(this.config_, params, signal);
     }
-    /** @see {@link predictedFundings} */
+    /**
+     * Request predicted funding rates.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of predicted funding rates.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.predictedFundings();
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
+     */
     predictedFundings(signal) {
         return predictedFundings(this.config_, signal);
     }
-    /** @see {@link preTransferCheck} */
+    /**
+     * Request user existence check before transfer.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Pre-transfer user existence check result.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.preTransferCheck({ user: "0x...", source: "0x..." });
+     * ```
+     */
     preTransferCheck(params, signal) {
         return preTransferCheck(this.config_, params, signal);
     }
-    /** @see {@link recentTrades} */
-    recentTrades(params, signal) {
+    /**
+     * Request recent trades.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of recent trades.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.recentTrades({ coin: "ETH" });
+     * ```
+     */
+    recentTrades(params, signal) {
         return recentTrades(this.config_, params, signal);
     }
-    /** @see {@link referral} */
+    /**
+     * Request user referral.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Referral details for a user.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.referral({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
+     */
     referral(params, signal) {
         return referral(this.config_, params, signal);
     }
-    /** @see {@link spotClearinghouseState} */
+    /**
+     * Request spot clearinghouse state.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Account summary for spot trading.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.spotClearinghouseState({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
+     */
     spotClearinghouseState(params, signal) {
         return spotClearinghouseState(this.config_, params, signal);
     }
-    /** @see {@link spotDeployState} */
+    /**
+     * Request spot deploy state.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Deploy state for spot tokens.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.spotDeployState({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
+     */
     spotDeployState(params, signal) {
         return spotDeployState(this.config_, params, signal);
     }
-    /** @see {@link spotMeta} */
+    /**
+     * Request spot trading metadata.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Metadata for spot assets.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.spotMeta();
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
+     */
     spotMeta(signal) {
         return spotMeta(this.config_, signal);
     }
-    /** @see {@link spotMetaAndAssetCtxs} */
+    /**
+     * Request spot metadata and asset contexts.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Metadata and context for spot assets.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.spotMetaAndAssetCtxs();
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
+     */
     spotMetaAndAssetCtxs(signal) {
         return spotMetaAndAssetCtxs(this.config_, signal);
     }
-    /** @see {@link spotPairDeployAuctionStatus} */
+    /**
+     * Request for the status of the spot deploy auction.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Status of the spot deploy auction.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.spotPairDeployAuctionStatus();
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-pair-deploy-auction
+     */
     spotPairDeployAuctionStatus(signal) {
         return spotPairDeployAuctionStatus(this.config_, signal);
     }
-    /** @see {@link subAccounts} */
+    /**
+     * Request user sub-accounts.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user sub-account or null if the user does not have any sub-accounts.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.subAccounts({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
+     */
     subAccounts(params, signal) {
         return subAccounts(this.config_, params, signal);
     }
-    /** @see {@link subAccounts2} */
+    /**
+     * Request user sub-accounts V2.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user sub-account or null if the user does not have any sub-accounts.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.subAccounts2({ user: "0x..." });
+     * ```
+     */
     subAccounts2(params, signal) {
         return subAccounts2(this.config_, params, signal);
     }
-    /** @see {@link tokenDetails} */
+    /**
+     * Request token details.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Details of a token.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.tokenDetails({ tokenId: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
+     */
     tokenDetails(params, signal) {
         return tokenDetails(this.config_, params, signal);
     }
-    /** @see {@link twapHistory} */
+    /**
+     * Request twap history of a user.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user's TWAP history.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.twapHistory({ user: "0x..." });
+     * ```
+     */
     twapHistory(params, signal) {
         return twapHistory(this.config_, params, signal);
     }
-    /** @see {@link txDetails} */
+    /**
+     * Request transaction details by transaction hash.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Transaction details.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.txDetails({ hash: "0x..." });
+     * ```
+     */
     txDetails(params, signal) {
         return txDetails(this.config_, params, signal);
     }
-    /** @see {@link userBorrowLendInterest} */
+    /**
+     * Request borrow/lend user interest.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns User's borrow/lend interest.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userBorrowLendInterest({ user: "0x...", startTime: 1725991229384 });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-user-state
+     */
     userBorrowLendInterest(params, signal) {
         return userBorrowLendInterest(this.config_, params, signal);
     }
-    /** @see {@link userDetails} */
+    /**
+     * Request array of user transaction details.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user transaction details.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userDetails({ user: "0x..." });
+     * ```
+     */
     userDetails(params, signal) {
         return userDetails(this.config_, params, signal);
     }
-    /** @see {@link userDexAbstraction} */
+    /**
+     * Request user HIP-3 DEX abstraction state.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns User HIP-3 DEX abstraction state.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userDexAbstraction({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-hip-3-dex-abstraction-state
+     */
     userDexAbstraction(params, signal) {
         return userDexAbstraction(this.config_, params, signal);
     }
-    /** @see {@link userFees} */
+    /**
+     * Request user fees.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns User fees.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userFees({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
+     */
     userFees(params, signal) {
         return userFees(this.config_, params, signal);
     }
-    /** @see {@link userFills} */
+    /**
+     * Request array of user fills.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user trade fills.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userFills({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
+     */
     userFills(params, signal) {
         return userFills(this.config_, params, signal);
     }
-    /** @see {@link userFillsByTime} */
+    /**
+     * Request array of user fills by time.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user trade fills by time.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userFillsByTime({ user: "0x...", startTime: Date.now() - 1000 * 60 * 60 * 24 });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
+     */
     userFillsByTime(params, signal) {
         return userFillsByTime(this.config_, params, signal);
     }
-    /** @see {@link userFunding} */
+    /**
+     * Request array of user funding ledger updates.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user funding ledger updates.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userFunding({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
+     */
     userFunding(params, signal) {
         return userFunding(this.config_, params, signal);
     }
-    /** @see {@link userNonFundingLedgerUpdates} */
+    /**
+     * Request user non-funding ledger updates.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user's non-funding ledger update.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userNonFundingLedgerUpdates({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
+     */
     userNonFundingLedgerUpdates(params, signal) {
         return userNonFundingLedgerUpdates(this.config_, params, signal);
     }
-    /** @see {@link userRateLimit} */
+    /**
+     * Request user rate limits.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns User rate limits.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userRateLimit({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+     */
     userRateLimit(params, signal) {
         return userRateLimit(this.config_, params, signal);
     }
-    /** @see {@link userRole} */
+    /**
+     * Request user role.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns User role.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userRole({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
+     */
     userRole(params, signal) {
         return userRole(this.config_, params, signal);
     }
-    /** @see {@link userToMultiSigSigners} */
+    /**
+     * Request multi-sig signers for a user.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Multi-sig signers for a user or null if the user does not have any multi-sig signers.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userToMultiSigSigners({ user: "0x..." });
+     * ```
+     */
     userToMultiSigSigners(params, signal) {
         return userToMultiSigSigners(this.config_, params, signal);
     }
-    /** @see {@link userTwapSliceFills} */
+    /**
+     * Request user TWAP slice fills.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user's twap slice fills.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userTwapSliceFills({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
+     */
     userTwapSliceFills(params, signal) {
         return userTwapSliceFills(this.config_, params, signal);
     }
-    /** @see {@link userTwapSliceFillsByTime} */
+    /**
+     * Request user TWAP slice fills by time.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user's twap slice fill by time.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userTwapSliceFillsByTime({ user: "0x...", startTime: Date.now() - 1000 * 60 * 60 * 24 });
+     * ```
+     */
     userTwapSliceFillsByTime(params, signal) {
         return userTwapSliceFillsByTime(this.config_, params, signal);
     }
-    /** @see {@link userVaultEquities} */
+    /**
+     * Request user vault deposits.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of user's vault deposits.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.userVaultEquities({ user: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
+     */
     userVaultEquities(params, signal) {
         return userVaultEquities(this.config_, params, signal);
     }
-    /** @see {@link validatorL1Votes} */
+    /**
+     * Request validator L1 votes.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of L1 governance votes cast by validators.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.validatorL1Votes();
+     * ```
+     */
     validatorL1Votes(signal) {
         return validatorL1Votes(this.config_, signal);
     }
-    /** @see {@link validatorSummaries} */
+    /**
+     * Request validator summaries.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of validator performance statistics.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.validatorSummaries();
+     * ```
+     */
     validatorSummaries(signal) {
         return validatorSummaries(this.config_, signal);
     }
-    /** @see {@link vaultDetails} */
+    /**
+     * Request details of a vault.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Details of a vault or null if the vault does not exist.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.vaultDetails({ vaultAddress: "0x..." });
+     * ```
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
+     */
     vaultDetails(params, signal) {
         return vaultDetails(this.config_, params, signal);
     }
-    /** @see {@link vaultSummaries} */
+    /**
+     * Request a list of vaults less than 2 hours old.
+     *
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Array of vaults less than 2 hours old.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.vaultSummaries();
+     * ```
+     */
     vaultSummaries(signal) {
         return vaultSummaries(this.config_, signal);
     }
-    /** @see {@link webData2} */
+    /**
+     * Request comprehensive user and market data.
+     *
+     * @param params - Parameters specific to the API request.
+     * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+     *
+     * @returns Comprehensive user and market data.
+     *
+     * @throws {ValiError} When the request parameters fail validation (before sending).
+     * @throws {TransportError} When the transport layer throws an error.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+     * const client = new hl.InfoClient({ transport });
+     *
+     * const data = await client.webData2({ user: "0x..." });
+     * ```
+     */
     webData2(params, signal) {
         return webData2(this.config_, params, signal);
     }