@nktkas/hyperliquid 0.13.0

package/script/src/clients/public.js

@@ -0,0 +1,708 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicClient = void 0;
+/**
+ * Public client for interacting with the Hyperliquid API.
+ * @typeParam T - The type of transport used to connect to the Hyperliquid API.
+ */
+class PublicClient {
+    /**
+     * Initialises a new instance.
+     * @param args - The arguments for initialisation.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     * ```
+     */
+    constructor(args) {
+        /** The transport used to connect to the Hyperliquid API. */
+        Object.defineProperty(this, "transport", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.transport = args.transport;
+    }
+    // ———————————————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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const allMids = await client.allMids();
+     * ```
+     */
+    allMids(signal) {
+        return this.transport.request("info", { type: "allMids" }, signal);
+    }
+    /**
+     * Request candlestick snapshots.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const candles = await client.candleSnapshot({
+     *   coin: "ETH",
+     *   interval: "1h",
+     *   startTime: Date.now() - 1000 * 60 * 60 * 24
+     * });
+     * ```
+     */
+    candleSnapshot(args, signal) {
+        return this.transport.request("info", { type: "candleSnapshot", req: args }, signal);
+    }
+    /**
+     * Request clearinghouse state.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const state = await client.clearinghouseState({ user: "0x..." });
+     * ```
+     */
+    clearinghouseState(args, signal) {
+        return this.transport.request("info", { type: "clearinghouseState", ...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.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const extraAgents = await client.extraAgents({ user: "0x..." });
+     * ```
+     */
+    extraAgents(args, signal) {
+        return this.transport.request("info", { type: "extraAgents", ...args }, signal);
+    }
+    /**
+     * Request frontend open orders.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const orders = await client.frontendOpenOrders({ user: "0x..." });
+     * ```
+     */
+    frontendOpenOrders(args, signal) {
+        return this.transport.request("info", { type: "frontendOpenOrders", ...args }, signal);
+    }
+    /**
+     * Request funding history.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const funding = await client.fundingHistory({
+     *   coin: "ETH",
+     *   startTime: Date.now() - 1000 * 60 * 60 * 24
+     * });
+     * ```
+     */
+    fundingHistory(args, signal) {
+        return this.transport.request("info", { type: "fundingHistory", ...args }, signal);
+    }
+    /**
+     * Request user's historical orders.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const orders = await client.historicalOrders({ user: "0x..." });
+     * ```
+     */
+    historicalOrders(args, signal) {
+        return this.transport.request("info", { type: "historicalOrders", ...args }, signal);
+    }
+    /**
+     * Request L2 order book.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const book = await client.l2Book({ coin: "ETH", nSigFigs: 2 });
+     * ```
+     */
+    l2Book(args, signal) {
+        return this.transport.request("info", { type: "l2Book", ...args }, signal);
+    }
+    /**
+     * Request builder fee approval.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const maxBuilderFee = await client.maxBuilderFee({ user: "0x...", builder: "0x..." });
+     * ```
+     */
+    maxBuilderFee(args, signal) {
+        return this.transport.request("info", { type: "maxBuilderFee", ...args }, signal);
+    }
+    /**
+     * Request trading metadata.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const meta = await client.meta();
+     * ```
+     */
+    meta(signal) {
+        return this.transport.request("info", { type: "meta" }, signal);
+    }
+    /**
+     * Request metadata and asset contexts.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const [meta, assetCtxs] = await client.metaAndAssetCtxs();
+     * ```
+     */
+    metaAndAssetCtxs(signal) {
+        return this.transport.request("info", { type: "metaAndAssetCtxs" }, signal);
+    }
+    /**
+     * Request open orders.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const orders = await client.openOrders({ user: "0x..." });
+     * ```
+     */
+    openOrders(args, signal) {
+        return this.transport.request("info", { type: "openOrders", ...args }, signal);
+    }
+    /**
+     * Request order status.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const status = await client.orderStatus({ user: "0x...", oid: 12345 });
+     * ```
+     */
+    orderStatus(args, signal) {
+        return this.transport.request("info", { type: "orderStatus", ...args }, 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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const predictedFundings = await client.predictedFundings();
+     * ```
+     */
+    predictedFundings(signal) {
+        return this.transport.request("info", { type: "predictedFundings" }, signal);
+    }
+    /**
+     * Request user referral.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Referral information for a user.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const referral = await client.referral({ user: "0x..." });
+     * ```
+     */
+    referral(args, signal) {
+        return this.transport.request("info", { type: "referral", ...args }, signal);
+    }
+    /**
+     * Request spot clearinghouse state.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const state = await client.spotClearinghouseState({ user: "0x..." });
+     * ```
+     */
+    spotClearinghouseState(args, signal) {
+        return this.transport.request("info", { type: "spotClearinghouseState", ...args }, signal);
+    }
+    /**
+     * Request spot deploy state.
+     * @param args - The parameters for the request.
+     * @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}
+     */
+    spotDeployState(args, signal) {
+        return this.transport.request("info", { type: "spotDeployState", ...args }, signal);
+    }
+    /**
+     * Request spot trading metadata.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const meta = await client.spotMeta();
+     * ```
+     */
+    spotMeta(signal) {
+        return this.transport.request("info", { type: "spotMeta" }, signal);
+    }
+    /**
+     * Request spot metadata and asset contexts.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const [meta, assetCtxs] = await client.spotMetaAndAssetCtxs();
+     * ```
+     */
+    spotMetaAndAssetCtxs(signal) {
+        return this.transport.request("info", { type: "spotMetaAndAssetCtxs" }, signal);
+    }
+    /**
+     * Request user sub-accounts.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const subAccounts = await client.subAccounts({ user: "0x..." });
+     * ```
+     */
+    subAccounts(args, signal) {
+        return this.transport.request("info", { type: "subAccounts", ...args }, signal);
+    }
+    /**
+     * Request token details.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const details = await client.tokenDetails({ tokenId: "0x..." });
+     * ```
+     */
+    tokenDetails(args, signal) {
+        return this.transport.request("info", { type: "tokenDetails", ...args }, signal);
+    }
+    /**
+     * Request twap history of a user.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns The twap history of a user.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const twapHistory = await client.twapHistory({ user: "0x..." });
+     * ```
+     */
+    twapHistory(args, signal) {
+        return this.transport.request("info", { type: "twapHistory", ...args }, signal);
+    }
+    /**
+     * Request user fees.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns User fees.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const userFees = await client.userFees({ user: "0x..." });
+     * ```
+     */
+    userFees(args, signal) {
+        return this.transport.request("info", { type: "userFees", ...args }, signal);
+    }
+    /**
+     * Request user fills.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const fills = await client.userFills({ user: "0x..." });
+     * ```
+     */
+    userFills(args, signal) {
+        return this.transport.request("info", { type: "userFills", ...args }, signal);
+    }
+    /**
+     * Request user fills by time.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const fills = await client.userFillsByTime({
+     *   user: "0x...",
+     *   startTime: Date.now() - 1000 * 60 * 60 * 24
+     * });
+     * ```
+     */
+    userFillsByTime(args, signal) {
+        return this.transport.request("info", { type: "userFillsByTime", ...args }, signal);
+    }
+    /**
+     * Request user funding.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const funding = await client.userFunding({
+     *   user: "0x...",
+     *   startTime: Date.now() - 1000 * 60 * 60 * 24
+     * });
+     * ```
+     */
+    userFunding(args, signal) {
+        return this.transport.request("info", { type: "userFunding", ...args }, signal);
+    }
+    /**
+     * Request user non-funding ledger updates.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const funding = await client.userNonFundingLedgerUpdates({
+     *   user: "0x...",
+     *   startTime: Date.now() - 1000 * 60 * 60 * 24
+     * });
+     * ```
+     */
+    userNonFundingLedgerUpdates(args, signal) {
+        return this.transport.request("info", { type: "userNonFundingLedgerUpdates", ...args }, signal);
+    }
+    /**
+     * Request user rate limits.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const rateLimit = await client.userRateLimit({ user: "0x..." });
+     * ```
+     */
+    userRateLimit(args, signal) {
+        return this.transport.request("info", { type: "userRateLimit", ...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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const fills = await client.userTwapSliceFills({ user: "0x..." });
+     * ```
+     */
+    userTwapSliceFills(args, signal) {
+        return this.transport.request("info", { type: "userTwapSliceFills", ...args }, signal);
+    }
+    /**
+     * Request user vault deposits.
+     * @param args - The parameters for the request.
+     * @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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const deposits = await client.userVaultDeposits({ user: "0x..." });
+     * ```
+     */
+    userVaultEquities(args, signal) {
+        return this.transport.request("info", { type: "userVaultEquities", ...args }, 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}
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const vault = await client.vaultDetails({ vaultAddress: "0x..." });
+     * ```
+     */
+    vaultDetails(args, signal) {
+        return this.transport.request("info", { type: "vaultDetails", ...args }, signal);
+    }
+    /**
+     * Request a list of vaults less than 2 hours old.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Array of vault summaries.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const vaults = await client.vaultSummaries();
+     * ```
+     */
+    vaultSummaries(signal) {
+        return this.transport.request("info", { type: "vaultSummaries" }, signal);
+    }
+    // ———————————————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.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const { blockDetails } = await client.blockDetails({ height: 123 });
+     * ```
+     */
+    blockDetails(args, signal) {
+        return this.transport.request("explorer", { type: "blockDetails", ...args }, signal);
+    }
+    /**
+     * Gets the details of a transaction.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns A promise that resolves with the details of the transaction.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.PublicClient({ transport });
+     *
+     * const { tx } = await client.txDetails({ hash: "0x..." });
+     * ```
+     */
+    txDetails(args, signal) {
+        return this.transport.request("explorer", { type: "txDetails", ...args }, signal);
+    }
+}
+exports.PublicClient = PublicClient;