@nktkas/hyperliquid 0.20.0 → 0.21.0

package/script/src/clients/{public.js → info.js}

@@ -9,12 +9,12 @@
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.PublicClient = void 0;
+    exports.InfoClient = void 0;
     /**
-     * Public client for interacting with the Hyperliquid API.
+     * Info client for interacting with the Hyperliquid API.
      * @typeParam T The type of transport used to connect to the Hyperliquid API.
      */
-    class PublicClient {
+    class InfoClient {
         transport;
         /**
          * Initialises a new instance.
@@ -25,7 +25,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          * ```
          */
         constructor(args) {
@@ -52,7 +52,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const { blockDetails } = await client.blockDetails({ height: 123 });
          * ```
@@ -76,7 +76,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const candleSnapshot = await client.candleSnapshot({
          *   coin: "ETH",
@@ -104,7 +104,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const clearinghouseState = await client.clearinghouseState({ user: "0x..." });
          * ```
@@ -128,7 +128,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const delegations = await client.delegations({ user: "0x..." });
          * ```
@@ -152,7 +152,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const delegatorHistory = await client.delegatorHistory({ user: "0x..." });
          * ```
@@ -176,7 +176,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const delegatorRewards = await client.delegatorRewards({ user: "0x..." });
          * ```
@@ -200,7 +200,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const delegatorSummary = await client.delegatorSummary({ user: "0x..." });
          * ```
@@ -224,7 +224,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const extraAgents = await client.extraAgents({ user: "0x..." });
          * ```
@@ -248,7 +248,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const frontendOpenOrders = await client.frontendOpenOrders({ user: "0x..." });
          * ```
@@ -272,7 +272,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const fundingHistory = await client.fundingHistory({
          *   coin: "ETH",
@@ -299,7 +299,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const historicalOrders = await client.historicalOrders({ user: "0x..." });
          * ```
@@ -323,7 +323,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const isVip = await client.isVip({ user: "0x..." });
          * ```
@@ -347,7 +347,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const l2Book = await client.l2Book({ coin: "ETH", nSigFigs: 2 });
          * ```
@@ -371,7 +371,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const legalCheck = await client.legalCheck({ user: "0x..." });
          * ```
@@ -395,7 +395,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const maxBuilderFee = await client.maxBuilderFee({ user: "0x...", builder: "0x..." });
          * ```
@@ -427,7 +427,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const [meta, assetCtxs] = await client.metaAndAssetCtxs();
          * ```
@@ -450,7 +450,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const openOrders = await client.openOrders({ user: "0x..." });
          * ```
@@ -474,7 +474,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const orderStatus = await client.orderStatus({ user: "0x...", oid: 12345 });
          * ```
@@ -497,7 +497,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const auctionStatus = await client.perpDeployAuctionStatus();
          * ```
@@ -519,7 +519,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const perpDexs = await client.perpDexs();
          * ```
@@ -542,7 +542,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const perpsAtOpenInterestCap = await client.perpsAtOpenInterestCap();
          * ```
@@ -565,7 +565,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const portfolio = await client.portfolio({ user: "0x..." });
          * ```
@@ -588,7 +588,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const predictedFundings = await client.predictedFundings();
          * ```
@@ -611,7 +611,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const preTransferCheck = await client.preTransferCheck({ user: "0x...", source: "0x..." });
          * ```
@@ -635,7 +635,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const referral = await client.referral({ user: "0x..." });
          * ```
@@ -659,7 +659,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const spotClearinghouseState = await client.spotClearinghouseState({ user: "0x..." });
          * ```
@@ -683,7 +683,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const spotDeployState = await client.spotDeployState({ user: "0x..." });
          * ```
@@ -706,7 +706,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const spotMeta = await client.spotMeta();
          * ```
@@ -728,7 +728,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const [spotMeta, spotAssetCtxs] = await client.spotMetaAndAssetCtxs();
          * ```
@@ -751,7 +751,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const subAccounts = await client.subAccounts({ user: "0x..." });
          * ```
@@ -775,7 +775,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const tokenDetails = await client.tokenDetails({ tokenId: "0x..." });
          * ```
@@ -799,7 +799,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const twapHistory = await client.twapHistory({ user: "0x..." });
          * ```
@@ -823,7 +823,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const { tx } = await client.txDetails({ hash: "0x..." });
          * ```
@@ -847,7 +847,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const { txs } = await client.userDetails({ user: "0x..." });
          * ```
@@ -871,7 +871,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const fees = await client.userFees({ user: "0x..." });
          * ```
@@ -895,7 +895,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const fills = await client.userFills({ user: "0x..." });
          * ```
@@ -919,7 +919,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const fills = await client.userFillsByTime({
          *   user: "0x...",
@@ -946,7 +946,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const funding = await client.userFunding({
          *   user: "0x...",
@@ -973,7 +973,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const nonFundingLedgerUpdates = await client.userNonFundingLedgerUpdates({
          *   user: "0x...",
@@ -1000,7 +1000,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const rateLimit = await client.userRateLimit({ user: "0x..." });
          * ```
@@ -1024,7 +1024,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const userRole = await client.userRole({ user: "0x..." });
          * ```
@@ -1048,7 +1048,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const multiSigSigners = await client.userToMultiSigSigners({ user: "0x..." });
          * ```
@@ -1072,7 +1072,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const twapSliceFills = await client.userTwapSliceFills({ user: "0x..." });
          * ```
@@ -1096,7 +1096,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const twapSliceFillsByTime = await client.userTwapSliceFillsByTime({
          *   user: "0x...",
@@ -1123,7 +1123,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const userVaultEquities = await client.userVaultDeposits({ user: "0x..." });
          * ```
@@ -1146,7 +1146,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const validatorSummaries = await client.validatorSummaries();
          * ```
@@ -1169,7 +1169,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const vaultDetails = await client.vaultDetails({ vaultAddress: "0x..." });
          * ```
@@ -1193,7 +1193,7 @@
          * import * as hl from "@nktkas/hyperliquid";
          *
          * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.PublicClient({ transport });
+         * const infoClient = new hl.InfoClient({ transport });
          *
          * const vaultSummaries = await client.vaultSummaries();
          * ```
@@ -1208,5 +1208,5 @@
             await this.transport[Symbol.asyncDispose]?.();
         }
     }
-    exports.PublicClient = PublicClient;
+    exports.InfoClient = InfoClient;
 });