@nktkas/hyperliquid 0.13.0 → 0.13.2

package/esm/src/clients/public.d.ts

@@ -1,11 +1,12 @@
 import type { IRequestTransport } from "../transports/base.js";
-import type { BlockDetailsRequest, TxDetailsRequest } from "../types/explorer/requests";
-import type { BlockDetailsResponse, TxDetailsResponse } from "../types/explorer/responses";
-import type { ExtraAgent, PerpsClearinghouseState, Referral, SpotClearinghouseState, SubAccount, UserFees, UserFundingUpdate, UserNonFundingLedgerUpdate, UserRateLimit } from "../types/info/accounts";
-import type { AllMids, Candle, FundingHistory, PerpsMeta, PerpsMetaAndAssetCtxs, PredictedFunding, SpotDeployState, SpotMeta, SpotMetaAndAssetCtxs, TokenDetails } from "../types/info/assets";
-import type { Book, Fill, FrontendOrder, Order, OrderLookup, OrderStatus, TwapHistory, TwapSliceFill } from "../types/info/orders";
-import type { CandleSnapshotRequest, ClearinghouseStateRequest, ExtraAgentsRequest, FrontendOpenOrdersRequest, FundingHistoryRequest, HistoricalOrdersRequest, L2BookRequest, MaxBuilderFeeRequest, OpenOrdersRequest, OrderStatusRequest, ReferralRequest, SpotClearinghouseStateRequest, SpotDeployStateRequest, SubAccountsRequest, TokenDetailsRequest, TwapHistoryRequest, UserFeesRequest, UserFillsByTimeRequest, UserFillsRequest, UserFundingRequest, UserNonFundingLedgerUpdatesRequest, UserRateLimitRequest, UserTwapSliceFillsRequest, UserVaultEquitiesRequest, VaultDetailsRequest } from "../types/info/requests";
-import type { VaultDetails, VaultEquity, VaultSummary } from "../types/info/vaults";
+import type { BlockDetailsRequest, TxDetailsRequest, UserDetailsRequest } from "../types/explorer/requests.js";
+import type { BlockDetailsResponse, TxDetailsResponse, UserDetailsResponse } from "../types/explorer/responses.js";
+import type { ExtraAgent, PerpsClearinghouseState, PortfolioPeriods, Referral, SpotClearinghouseState, SubAccount, UserFees, UserFundingUpdate, UserNonFundingLedgerUpdate, UserRateLimit, UserRole } from "../types/info/accounts.js";
+import type { AllMids, Candle, FundingHistory, PerpsMeta, PerpsMetaAndAssetCtxs, PredictedFunding, SpotDeployState, SpotMeta, SpotMetaAndAssetCtxs, TokenDetails } from "../types/info/assets.js";
+import type { Delegation, DelegatorReward, DelegatorSummary, DelegatorUpdate, ValidatorSummary } from "../types/info/delegations.js";
+import type { Book, Fill, FrontendOrder, Order, OrderLookup, OrderStatus, TwapHistory, TwapSliceFill } from "../types/info/orders.js";
+import type { CandleSnapshotRequest, ClearinghouseStateRequest, DelegationsRequest, DelegatorHistoryRequest, DelegatorRewardsRequest, DelegatorSummaryRequest, ExtraAgentsRequest, FrontendOpenOrdersRequest, FundingHistoryRequest, HistoricalOrdersRequest, L2BookRequest, MaxBuilderFeeRequest, OpenOrdersRequest, OrderStatusRequest, PortfolioRequest, ReferralRequest, SpotClearinghouseStateRequest, SpotDeployStateRequest, SubAccountsRequest, TokenDetailsRequest, TwapHistoryRequest, UserFeesRequest, UserFillsByTimeRequest, UserFillsRequest, UserFundingRequest, UserNonFundingLedgerUpdatesRequest, UserRateLimitRequest, UserRoleRequest, UserTwapSliceFillsRequest, UserVaultEquitiesRequest, VaultDetailsRequest } from "../types/info/requests.js";
+import type { VaultDetails, VaultEquity, VaultSummary } from "../types/info/vaults.js";
 /** Parameters for the {@linkcode PublicClient} constructor. */
 export interface PublicClientParameters<T extends IRequestTransport = IRequestTransport> {
     /** The transport used to connect to the Hyperliquid API. */
@@ -15,6 +16,14 @@ export interface PublicClientParameters<T extends IRequestTransport = IRequestTr
 export type CandleSnapshotParameters = CandleSnapshotRequest["req"];
 /** Parameters for the {@linkcode PublicClient.clearinghouseState} method. */
 export type ClearinghouseStateParameters = Omit<ClearinghouseStateRequest, "type">;
+/** Parameters for the {@linkcode PublicClient.delegations} method. */
+export type DelegationsParameters = Omit<DelegationsRequest, "type">;
+/** Parameters for the {@linkcode PublicClient.delegatorHistory} method. */
+export type DelegatorHistoryParameters = Omit<DelegatorHistoryRequest, "type">;
+/** Parameters for the {@linkcode PublicClient.delegatorRewards} method. */
+export type DelegatorRewardsParameters = Omit<DelegatorRewardsRequest, "type">;
+/** Parameters for the {@linkcode PublicClient.delegatorSummary} method. */
+export type DelegatorSummaryParameters = Omit<DelegatorSummaryRequest, "type">;
 /** Parameters for the {@linkcode PublicClient.extraAgents} method. */
 export type ExtraAgentsParameters = Omit<ExtraAgentsRequest, "type">;
 /** Parameters for the {@linkcode PublicClient.frontendOpenOrders} method. */
@@ -31,6 +40,8 @@ export type MaxBuilderFeeParameters = Omit<MaxBuilderFeeRequest, "type">;
 export type OpenOrdersParameters = Omit<OpenOrdersRequest, "type">;
 /** Parameters for the {@linkcode PublicClient.orderStatus} method. */
 export type OrderStatusParameters = Omit<OrderStatusRequest, "type">;
+/** Parameters for the {@linkcode PublicClient.portfolio} method. */
+export type PortfolioParameters = Omit<PortfolioRequest, "type">;
 /** Parameters for the {@linkcode PublicClient.referral} method. */
 export type ReferralParameters = Omit<ReferralRequest, "type">;
 /** Parameters for the {@linkcode PublicClient.spotClearinghouseState} method. */
@@ -55,6 +66,8 @@ export type UserFundingParameters = Omit<UserFundingRequest, "type">;
 export type UserNonFundingLedgerUpdatesParameters = Omit<UserNonFundingLedgerUpdatesRequest, "type">;
 /** Parameters for the {@linkcode PublicClient.userRateLimit} method. */
 export type UserRateLimitParameters = Omit<UserRateLimitRequest, "type">;
+/** Parameters for the {@linkcode PublicClient.userRole} method. */
+export type UserRoleParameters = Omit<UserRoleRequest, "type">;
 /** Parameters for the {@linkcode PublicClient.userTwapSliceFills} method. */
 export type UserTwapSliceFillsParameters = Omit<UserTwapSliceFillsRequest, "type">;
 /** Parameters for the {@linkcode PublicClient.userVaultEquities} method. */
@@ -65,6 +78,8 @@ export type VaultDetailsParameters = Omit<VaultDetailsRequest, "type">;
 export type BlockDetailsParameters = Omit<BlockDetailsRequest, "type">;
 /** Parameters for the {@linkcode PublicClient.txDetails} method. */
 export type TxDetailsParameters = Omit<TxDetailsRequest, "type">;
+/** Parameters for the {@linkcode PublicClient.userDetails} method. */
+export type UserDetailsParameters = Omit<UserDetailsRequest, "type">;
 /**
  * Public client for interacting with the Hyperliquid API.
  * @typeParam T - The type of transport used to connect to the Hyperliquid API.
@@ -90,7 +105,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Mid coin prices.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -108,7 +123,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of candlestick data points.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -116,7 +131,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const candles = await client.candleSnapshot({
+     * const candleSnapshot = await client.candleSnapshot({
      *   coin: "ETH",
      *   interval: "1h",
      *   startTime: Date.now() - 1000 * 60 * 60 * 24
@@ -130,7 +145,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Account summary for perpetual trading.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -138,16 +153,89 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const state = await client.clearinghouseState({ user: "0x..." });
+     * const clearinghouseState = await client.clearinghouseState({ user: "0x..." });
      * ```
      */
     clearinghouseState(args: ClearinghouseStateParameters, signal?: AbortSignal): Promise<PerpsClearinghouseState>;
+    /**
+     * Request user staking delegations.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Array of user's delegations to validators.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-delegations
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const delegations = await client.delegations({ user: "0x..." });
+     * ```
+     */
+    delegations(args: DelegationsParameters, signal?: AbortSignal): Promise<Delegation[]>;
+    /**
+     * Request user staking history.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Array of user's staking updates.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-history
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const delegatorHistory = await client.delegatorHistory({ user: "0x..." });
+     * ```
+     */
+    delegatorHistory(args: DelegatorHistoryParameters, signal?: AbortSignal): Promise<DelegatorUpdate[]>;
+    /**
+     * Request user staking rewards.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Array of user's staking rewards.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-rewards
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const delegatorRewards = await client.delegatorRewards({ user: "0x..." });
+     * ```
+     */
+    delegatorRewards(args: DelegatorRewardsParameters, signal?: AbortSignal): Promise<DelegatorReward[]>;
+    /**
+     * Request user staking summary.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Summary of a user's staking delegations.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-staking-summary
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const delegatorSummary = await client.delegatorSummary({ user: "0x..." });
+     * ```
+     */
+    delegatorSummary(args: DelegatorSummaryParameters, signal?: AbortSignal): Promise<DelegatorSummary>;
     /**
      * Request user's extra agents.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns User's extra agents.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -165,7 +253,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of open orders with additional frontend information.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -173,7 +261,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const orders = await client.frontendOpenOrders({ user: "0x..." });
+     * const frontendOpenOrders = await client.frontendOpenOrders({ user: "0x..." });
      * ```
      */
     frontendOpenOrders(args: FrontendOpenOrdersParameters, signal?: AbortSignal): Promise<FrontendOrder[]>;
@@ -183,7 +271,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of historical funding rate data for an asset.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -191,7 +279,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const funding = await client.fundingHistory({
+     * const fundingHistory = await client.fundingHistory({
      *   coin: "ETH",
      *   startTime: Date.now() - 1000 * 60 * 60 * 24
      * });
@@ -204,7 +292,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of user's historical orders.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -212,7 +300,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const orders = await client.historicalOrders({ user: "0x..." });
+     * const historicalOrders = await client.historicalOrders({ user: "0x..." });
      * ```
      */
     historicalOrders(args: HistoricalOrdersParameters, signal?: AbortSignal): Promise<OrderStatus<FrontendOrder>[]>;
@@ -222,7 +310,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns L2 order book snapshot.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -230,7 +318,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const book = await client.l2Book({ coin: "ETH", nSigFigs: 2 });
+     * const l2Book = await client.l2Book({ coin: "ETH", nSigFigs: 2 });
      * ```
      */
     l2Book(args: L2BookParameters, signal?: AbortSignal): Promise<Book>;
@@ -240,7 +328,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Maximum builder fee approval.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -257,7 +345,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Metadata for perpetual assets.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -274,7 +362,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Metadata and context information for each perpetual asset.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc | Hyperliquid GitBook}
+     * @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
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -292,7 +380,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of open order.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -300,7 +388,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const orders = await client.openOrders({ user: "0x..." });
+     * const openOrders = await client.openOrders({ user: "0x..." });
      * ```
      */
     openOrders(args: OpenOrdersParameters, signal?: AbortSignal): Promise<Order[]>;
@@ -310,7 +398,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Result of an order status lookup.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -318,16 +406,52 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const status = await client.orderStatus({ user: "0x...", oid: 12345 });
+     * const orderStatus = await client.orderStatus({ user: "0x...", oid: 12345 });
      * ```
      */
     orderStatus(args: OrderStatusParameters, signal?: AbortSignal): Promise<OrderLookup>;
+    /**
+     * Request portfolio.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Portfolio of a user.
+     *
+     * @see null - no documentation
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const portfolio = await client.portfolio({ user: "0x..." });
+     * ```
+     */
+    portfolio(args: PortfolioParameters, signal?: AbortSignal): Promise<PortfolioPeriods>;
+    /**
+     * Request perpetuals at open interest cap.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Array of perpetuals at open interest caps.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const perpsAtOpenInterestCap = await client.perpsAtOpenInterestCap();
+     * ```
+     */
+    perpsAtOpenInterestCap(signal?: AbortSignal): Promise<string[]>;
     /**
      * Request predicted funding rates.
      * @param signal - An optional abort signal.
      * @returns Array of predicted funding rates.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -345,6 +469,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Referral information for a user.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -362,7 +487,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Balances for spot tokens.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -370,7 +495,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const state = await client.spotClearinghouseState({ user: "0x..." });
+     * const spotClearinghouseState = await client.spotClearinghouseState({ user: "0x..." });
      * ```
      */
     spotClearinghouseState(args: SpotClearinghouseStateParameters, signal?: AbortSignal): Promise<SpotClearinghouseState>;
@@ -380,7 +505,16 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns The deploy state of a user.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const spotDeployState = await client.spotDeployState({ user: "0x..." });
+     * ```
      */
     spotDeployState(args: SpotDeployStateParameters, signal?: AbortSignal): Promise<SpotDeployState>;
     /**
@@ -388,7 +522,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Metadata for spot assets.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -396,7 +530,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const meta = await client.spotMeta();
+     * const spotMeta = await client.spotMeta();
      * ```
      */
     spotMeta(signal?: AbortSignal): Promise<SpotMeta>;
@@ -405,7 +539,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Metadata and context information for each spot asset.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -413,7 +547,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const [meta, assetCtxs] = await client.spotMetaAndAssetCtxs();
+     * const [spotMeta, spotAssetCtxs] = await client.spotMetaAndAssetCtxs();
      * ```
      */
     spotMetaAndAssetCtxs(signal?: AbortSignal): Promise<SpotMetaAndAssetCtxs>;
@@ -423,7 +557,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of user sub-account.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -441,7 +575,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns The details of a token.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -449,7 +583,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const details = await client.tokenDetails({ tokenId: "0x..." });
+     * const tokenDetails = await client.tokenDetails({ tokenId: "0x..." });
      * ```
      */
     tokenDetails(args: TokenDetailsParameters, signal?: AbortSignal): Promise<TokenDetails>;
@@ -459,6 +593,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns The twap history of a user.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -476,6 +611,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns User fees.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -483,7 +619,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const userFees = await client.userFees({ user: "0x..." });
+     * const fees = await client.userFees({ user: "0x..." });
      * ```
      */
     userFees(args: UserFeesParameters, signal?: AbortSignal): Promise<UserFees>;
@@ -493,7 +629,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of user's trade fill.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -511,7 +647,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of user's trade fill.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -532,7 +668,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of user's funding ledger update.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates | Hyperliquid GitBook}
+     * @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
      * import * as hl from "@nktkas/hyperliquid";
@@ -553,7 +689,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of user's non-funding ledger update.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates | Hyperliquid GitBook}
+     * @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
      * import * as hl from "@nktkas/hyperliquid";
@@ -561,7 +697,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const funding = await client.userNonFundingLedgerUpdates({
+     * const nonFundingLedgerUpdates = await client.userNonFundingLedgerUpdates({
      *   user: "0x...",
      *   startTime: Date.now() - 1000 * 60 * 60 * 24
      * });
@@ -574,7 +710,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns User's rate limits.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -586,13 +722,31 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * ```
      */
     userRateLimit(args: UserRateLimitParameters, signal?: AbortSignal): Promise<UserRateLimit>;
+    /**
+     * Request user role.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns User's role.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const userRole = await client.userRole({ user: "0x..." });
+     * ```
+     */
+    userRole(args: UserRoleParameters, signal?: AbortSignal): Promise<UserRole>;
     /**
      * Request user twap slice fills.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns Array of user's twap slice fill.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -600,7 +754,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const fills = await client.userTwapSliceFills({ user: "0x..." });
+     * const twapSliceFills = await client.userTwapSliceFills({ user: "0x..." });
      * ```
      */
     userTwapSliceFills(args: UserTwapSliceFillsParameters, signal?: AbortSignal): Promise<TwapSliceFill[]>;
@@ -610,7 +764,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of user's vault deposits.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -618,17 +772,34 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const deposits = await client.userVaultDeposits({ user: "0x..." });
+     * const userVaultEquities = await client.userVaultDeposits({ user: "0x..." });
      * ```
      */
     userVaultEquities(args: UserVaultEquitiesParameters, signal?: AbortSignal): Promise<VaultEquity[]>;
+    /**
+     * Request validator summaries.
+     * @param args - The parameters for the request.
+     * @returns Array of validator summaries.
+     *
+     * @see null - no documentation
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const validatorSummaries = await client.validatorSummaries();
+     * ```
+     */
+    validatorSummaries(signal?: AbortSignal): Promise<ValidatorSummary[]>;
     /**
      * Request details of a vault.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns Details of a vault.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -636,7 +807,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const vault = await client.vaultDetails({ vaultAddress: "0x..." });
+     * const vaultDetails = await client.vaultDetails({ vaultAddress: "0x..." });
      * ```
      */
     vaultDetails(args: VaultDetailsParameters, signal?: AbortSignal): Promise<VaultDetails | null>;
@@ -646,6 +817,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns Array of vault summaries.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -653,7 +825,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.PublicClient({ transport });
      *
-     * const vaults = await client.vaultSummaries();
+     * const vaultSummaries = await client.vaultSummaries();
      * ```
      */
     vaultSummaries(signal?: AbortSignal): Promise<VaultSummary[]>;
@@ -663,6 +835,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns A promise that resolves with the details of the block.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -680,6 +853,7 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * @param signal - An optional abort signal.
      * @returns A promise that resolves with the details of the transaction.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -691,5 +865,23 @@ export declare class PublicClient<T extends IRequestTransport = IRequestTranspor
      * ```
      */
     txDetails(args: TxDetailsParameters, signal?: AbortSignal): Promise<TxDetailsResponse>;
+    /**
+     * Request user details.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns User details.
+     *
+     * @see null - no documentation
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const { txs } = await client.userDetails({ user: "0x..." });
+     * ```
+     */
+    userDetails(args: UserDetailsParameters, signal?: AbortSignal): Promise<UserDetailsResponse>;
 }
 //# sourceMappingURL=public.d.ts.map