@nktkas/hyperliquid 0.13.0 → 0.13.2

package/esm/src/clients/public.js

@@ -1,3 +1,4 @@
+// ——————————————— Client ———————————————
 /**
  * Public client for interacting with the Hyperliquid API.
  * @typeParam T - The type of transport used to connect to the Hyperliquid API.
@@ -25,13 +26,13 @@ export class PublicClient {
         });
         this.transport = args.transport;
     }
-    // ———————————————Info API———————————————
+    // ——————————————— Info API ———————————————
     /**
      * Request mid coin prices.
      * @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";
@@ -51,7 +52,7 @@ export class PublicClient {
      * @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";
@@ -59,7 +60,7 @@ export class PublicClient {
      * 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
@@ -75,7 +76,7 @@ export class PublicClient {
      * @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";
@@ -83,18 +84,99 @@ export class PublicClient {
      * 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, signal) {
         return this.transport.request("info", { type: "clearinghouseState", ...args }, signal);
     }
+    /**
+     * 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, signal) {
+        return this.transport.request("info", { type: "delegations", ...args }, signal);
+    }
+    /**
+     * 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, signal) {
+        return this.transport.request("info", { type: "delegatorHistory", ...args }, signal);
+    }
+    /**
+     * 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, signal) {
+        return this.transport.request("info", { type: "delegatorRewards", ...args }, signal);
+    }
+    /**
+     * 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, signal) {
+        return this.transport.request("info", { type: "delegatorSummary", ...args }, signal);
+    }
     /**
      * 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";
@@ -114,7 +196,7 @@ export class PublicClient {
      * @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";
@@ -122,7 +204,7 @@ export class PublicClient {
      * 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, signal) {
@@ -134,7 +216,7 @@ export class PublicClient {
      * @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";
@@ -142,7 +224,7 @@ export class PublicClient {
      * 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
      * });
@@ -157,7 +239,7 @@ export class PublicClient {
      * @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";
@@ -165,7 +247,7 @@ export class PublicClient {
      * 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, signal) {
@@ -177,7 +259,7 @@ export class PublicClient {
      * @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";
@@ -185,7 +267,7 @@ export class PublicClient {
      * 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, signal) {
@@ -197,7 +279,7 @@ export class PublicClient {
      * @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";
@@ -216,7 +298,7 @@ export class PublicClient {
      * @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";
@@ -235,7 +317,7 @@ export class PublicClient {
      * @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";
@@ -255,7 +337,7 @@ export class PublicClient {
      * @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";
@@ -263,7 +345,7 @@ export class PublicClient {
      * 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, signal) {
@@ -275,7 +357,7 @@ export class PublicClient {
      * @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";
@@ -283,18 +365,58 @@ export class PublicClient {
      * 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, signal) {
         return this.transport.request("info", { type: "orderStatus", ...args }, signal);
     }
+    /**
+     * 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, signal) {
+        return this.transport.request("info", { type: "portfolio", ...args }, signal);
+    }
+    /**
+     * 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) {
+        return this.transport.request("info", { type: "perpsAtOpenInterestCap" }, signal);
+    }
     /**
      * 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";
@@ -314,6 +436,7 @@ export class PublicClient {
      * @param signal - An optional abort signal.
      * @returns Referral information for a user.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -333,7 +456,7 @@ export class PublicClient {
      * @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";
@@ -341,7 +464,7 @@ export class PublicClient {
      * 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, signal) {
@@ -353,7 +476,16 @@ export class PublicClient {
      * @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, signal) {
         return this.transport.request("info", { type: "spotDeployState", ...args }, signal);
@@ -363,7 +495,7 @@ export class PublicClient {
      * @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";
@@ -371,7 +503,7 @@ export class PublicClient {
      * 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) {
@@ -382,7 +514,7 @@ export class PublicClient {
      * @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";
@@ -390,7 +522,7 @@ export class PublicClient {
      * 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) {
@@ -402,7 +534,7 @@ export class PublicClient {
      * @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";
@@ -422,7 +554,7 @@ export class PublicClient {
      * @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";
@@ -430,7 +562,7 @@ export class PublicClient {
      * 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, signal) {
@@ -442,6 +574,7 @@ export class PublicClient {
      * @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";
@@ -461,6 +594,7 @@ export class PublicClient {
      * @param signal - An optional abort signal.
      * @returns User fees.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -468,7 +602,7 @@ export class PublicClient {
      * 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, signal) {
@@ -480,7 +614,7 @@ export class PublicClient {
      * @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";
@@ -500,7 +634,7 @@ export class PublicClient {
      * @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";
@@ -523,7 +657,7 @@ export class PublicClient {
      * @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";
@@ -546,7 +680,7 @@ export class PublicClient {
      * @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";
@@ -554,7 +688,7 @@ export class PublicClient {
      * 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
      * });
@@ -569,7 +703,7 @@ export class PublicClient {
      * @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";
@@ -583,13 +717,33 @@ export class PublicClient {
     userRateLimit(args, signal) {
         return this.transport.request("info", { type: "userRateLimit", ...args }, signal);
     }
+    /**
+     * 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, signal) {
+        return this.transport.request("info", { type: "userRole", ...args }, signal);
+    }
     /**
      * 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";
@@ -597,7 +751,7 @@ export class PublicClient {
      * 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, signal) {
@@ -609,7 +763,7 @@ export class PublicClient {
      * @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";
@@ -617,19 +771,38 @@ export class PublicClient {
      * 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, signal) {
         return this.transport.request("info", { type: "userVaultEquities", ...args }, signal);
     }
+    /**
+     * 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) {
+        return this.transport.request("info", { type: "validatorSummaries" }, signal);
+    }
     /**
      * 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";
@@ -637,7 +810,7 @@ export class PublicClient {
      * 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, signal) {
@@ -649,6 +822,7 @@ export class PublicClient {
      * @param signal - An optional abort signal.
      * @returns Array of vault summaries.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -656,19 +830,20 @@ export class PublicClient {
      * 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) {
         return this.transport.request("info", { type: "vaultSummaries" }, signal);
     }
-    // ———————————————Explorer API———————————————
+    // ——————————————— Explorer API ———————————————
     /**
      * Gets the details of a block.
      * @param args - The parameters for the request.
      * @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";
@@ -688,6 +863,7 @@ export class PublicClient {
      * @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";
@@ -701,4 +877,24 @@ export class PublicClient {
     txDetails(args, signal) {
         return this.transport.request("explorer", { type: "txDetails", ...args }, signal);
     }
+    /**
+     * 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, signal) {
+        return this.transport.request("explorer", { type: "userDetails", ...args }, signal);
+    }
 }