@nktkas/hyperliquid 0.24.2 → 0.24.3

package/script/src/clients/info.js

@@ -15,7 +15,7 @@ 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 });
      * ```
      */
@@ -35,7 +35,7 @@ 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" });
@@ -88,7 +88,7 @@ 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({
@@ -115,7 +115,7 @@ 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..." });
@@ -138,7 +138,7 @@ 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..." });
@@ -161,7 +161,7 @@ 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..." });
@@ -184,7 +184,7 @@ 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..." });
@@ -207,7 +207,7 @@ 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..." });
@@ -229,7 +229,7 @@ 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();
@@ -252,7 +252,7 @@ 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..." });
@@ -275,7 +275,7 @@ 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..." });
@@ -298,7 +298,7 @@ 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({
@@ -324,7 +324,7 @@ 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..." });
@@ -347,7 +347,7 @@ 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..." });
@@ -370,7 +370,7 @@ 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 });
@@ -393,7 +393,7 @@ 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..." });
@@ -416,7 +416,7 @@ 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..." });
@@ -438,7 +438,7 @@ 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();
@@ -461,7 +461,7 @@ 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 });
@@ -484,7 +484,7 @@ 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..." });
@@ -506,7 +506,7 @@ 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();
@@ -522,26 +522,10 @@ 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);
     }
     /**
@@ -557,7 +541,7 @@ 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..." });
@@ -580,7 +564,7 @@ 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 });
@@ -602,7 +586,7 @@ 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();
@@ -624,7 +608,7 @@ 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();
@@ -634,26 +618,10 @@ 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);
     }
     /**
@@ -669,7 +637,7 @@ 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..." });
@@ -691,7 +659,7 @@ 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();
@@ -714,7 +682,7 @@ 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..." });
@@ -737,7 +705,7 @@ 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..." });
@@ -760,7 +728,7 @@ 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..." });
@@ -783,7 +751,7 @@ 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..." });
@@ -805,7 +773,7 @@ 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();
@@ -827,7 +795,7 @@ 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();
@@ -849,7 +817,7 @@ 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();
@@ -872,7 +840,7 @@ 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..." });
@@ -895,7 +863,7 @@ 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..." });
@@ -918,7 +886,7 @@ 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..." });
@@ -989,7 +957,7 @@ 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..." });
@@ -1012,7 +980,7 @@ 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..." });
@@ -1035,7 +1003,7 @@ 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({
@@ -1061,7 +1029,7 @@ 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({
@@ -1087,7 +1055,7 @@ 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({
@@ -1113,7 +1081,7 @@ 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..." });
@@ -1136,7 +1104,7 @@ 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..." });
@@ -1159,7 +1127,7 @@ 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..." });
@@ -1182,7 +1150,7 @@ 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..." });
@@ -1205,7 +1173,7 @@ 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({
@@ -1231,7 +1199,7 @@ 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..." });
@@ -1253,7 +1221,7 @@ 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();
@@ -1275,7 +1243,7 @@ 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();
@@ -1298,7 +1266,7 @@ 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..." });
@@ -1320,7 +1288,7 @@ 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();