@nktkas/hyperliquid 0.24.2 → 0.24.3

package/esm/src/clients/info.js

@@ -12,7 +12,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      * ```
      */
@@ -32,7 +32,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.activeAssetData({ user: "0x...", coin: "ETH" });
@@ -85,7 +85,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.candleSnapshot({
@@ -112,7 +112,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.clearinghouseState({ user: "0x..." });
@@ -135,7 +135,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.delegations({ user: "0x..." });
@@ -158,7 +158,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.delegatorHistory({ user: "0x..." });
@@ -181,7 +181,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.delegatorRewards({ user: "0x..." });
@@ -204,7 +204,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.delegatorSummary({ user: "0x..." });
@@ -226,7 +226,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.exchangeStatus();
@@ -249,7 +249,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.extraAgents({ user: "0x..." });
@@ -272,7 +272,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.frontendOpenOrders({ user: "0x..." });
@@ -295,7 +295,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.fundingHistory({
@@ -321,7 +321,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.historicalOrders({ user: "0x..." });
@@ -344,7 +344,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.isVip({ user: "0x..." });
@@ -367,7 +367,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.l2Book({ coin: "ETH", nSigFigs: 2 });
@@ -390,7 +390,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.leadingVaults({ user: "0x..." });
@@ -413,7 +413,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.legalCheck({ user: "0x..." });
@@ -435,7 +435,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.liquidatable();
@@ -458,7 +458,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.marginTable({ id: 1 });
@@ -481,7 +481,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.maxBuilderFee({ user: "0x...", builder: "0x..." });
@@ -503,7 +503,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.maxMarketOrderNtls();
@@ -519,26 +519,10 @@ export class InfoClient {
         const request = { type: "meta", ...params };
         return this.transport.request("info", request, signal);
     }
-    /**
-     * Request metadata and asset contexts.
-     * @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
-     * @returns Metadata and context for perpetual assets.
-     *
-     * @throws {TransportError} When the transport layer throws an error.
-     *
-     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc
-     * @example
-     * ```ts
-     * import * as hl from "@nktkas/hyperliquid";
-     *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const infoClient = new hl.InfoClient({ transport });
-     *
-     * const data = await infoClient.metaAndAssetCtxs();
-     * ```
-     */
-    metaAndAssetCtxs(signal) {
-        const request = { type: "metaAndAssetCtxs" };
+    metaAndAssetCtxs(params_or_signal, maybeSignal) {
+        const params = params_or_signal instanceof AbortSignal ? {} : params_or_signal;
+        const signal = params_or_signal instanceof AbortSignal ? params_or_signal : maybeSignal;
+        const request = { type: "metaAndAssetCtxs", ...params };
         return this.transport.request("info", request, signal);
     }
     /**
@@ -554,7 +538,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.openOrders({ user: "0x..." });
@@ -577,7 +561,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.orderStatus({ user: "0x...", oid: 12345 });
@@ -599,7 +583,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.perpDeployAuctionStatus();
@@ -621,7 +605,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.perpDexs();
@@ -631,26 +615,10 @@ export class InfoClient {
         const request = { type: "perpDexs" };
         return this.transport.request("info", request, signal);
     }
-    /**
-     * Request perpetuals at open interest cap.
-     * @param signal - An {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}. If this option is set, the request can be canceled by calling {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort | abort()} on the corresponding {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}.
-     * @returns Array of perpetuals at open interest caps.
-     *
-     * @throws {TransportError} When the transport layer throws an error.
-     *
-     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
-     * @example
-     * ```ts
-     * import * as hl from "@nktkas/hyperliquid";
-     *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
-     * const infoClient = new hl.InfoClient({ transport });
-     *
-     * const data = await infoClient.perpsAtOpenInterestCap();
-     * ```
-     */
-    perpsAtOpenInterestCap(signal) {
-        const request = { type: "perpsAtOpenInterestCap" };
+    perpsAtOpenInterestCap(params_or_signal, maybeSignal) {
+        const params = params_or_signal instanceof AbortSignal ? {} : params_or_signal;
+        const signal = params_or_signal instanceof AbortSignal ? params_or_signal : maybeSignal;
+        const request = { type: "perpsAtOpenInterestCap", ...params };
         return this.transport.request("info", request, signal);
     }
     /**
@@ -666,7 +634,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.portfolio({ user: "0x..." });
@@ -688,7 +656,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.predictedFundings();
@@ -711,7 +679,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.preTransferCheck({ user: "0x...", source: "0x..." });
@@ -734,7 +702,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.referral({ user: "0x..." });
@@ -757,7 +725,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.spotClearinghouseState({ user: "0x..." });
@@ -780,7 +748,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.spotDeployState({ user: "0x..." });
@@ -802,7 +770,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.spotPairDeployAuctionStatus();
@@ -824,7 +792,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.spotMeta();
@@ -846,7 +814,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.spotMetaAndAssetCtxs();
@@ -869,7 +837,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.subAccounts({ user: "0x..." });
@@ -892,7 +860,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.tokenDetails({ tokenId: "0x..." });
@@ -915,7 +883,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.twapHistory({ user: "0x..." });
@@ -986,7 +954,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userFees({ user: "0x..." });
@@ -1009,7 +977,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userFills({ user: "0x..." });
@@ -1032,7 +1000,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userFillsByTime({
@@ -1058,7 +1026,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userFunding({
@@ -1084,7 +1052,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userNonFundingLedgerUpdates({
@@ -1110,7 +1078,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userRateLimit({ user: "0x..." });
@@ -1133,7 +1101,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userRole({ user: "0x..." });
@@ -1156,7 +1124,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userToMultiSigSigners({ user: "0x..." });
@@ -1179,7 +1147,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userTwapSliceFills({ user: "0x..." });
@@ -1202,7 +1170,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userTwapSliceFillsByTime({
@@ -1228,7 +1196,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.userVaultEquities({ user: "0x..." });
@@ -1250,7 +1218,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.validatorL1Votes();
@@ -1272,7 +1240,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.validatorSummaries();
@@ -1295,7 +1263,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.vaultDetails({ vaultAddress: "0x..." });
@@ -1317,7 +1285,7 @@ export class InfoClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
      * const infoClient = new hl.InfoClient({ transport });
      *
      * const data = await infoClient.vaultSummaries();