@nktkas/hyperliquid 0.20.0 → 0.21.0

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

@@ -1,8 +1,8 @@
 /**
- * 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.
  */
-export class PublicClient {
+export class InfoClient {
     transport;
     /**
      * Initialises a new instance.
@@ -13,7 +13,7 @@ export class PublicClient {
      * 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) {
@@ -40,7 +40,7 @@ export class PublicClient {
      * 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 });
      * ```
@@ -64,7 +64,7 @@ export class PublicClient {
      * 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",
@@ -92,7 +92,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -116,7 +116,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -140,7 +140,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -164,7 +164,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -188,7 +188,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -212,7 +212,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -236,7 +236,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -260,7 +260,7 @@ export class PublicClient {
      * 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",
@@ -287,7 +287,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -311,7 +311,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -335,7 +335,7 @@ export class PublicClient {
      * 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 });
      * ```
@@ -359,7 +359,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -383,7 +383,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -415,7 +415,7 @@ export class PublicClient {
      * 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();
      * ```
@@ -438,7 +438,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -462,7 +462,7 @@ export class PublicClient {
      * 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 });
      * ```
@@ -485,7 +485,7 @@ export class PublicClient {
      * 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();
      * ```
@@ -507,7 +507,7 @@ export class PublicClient {
      * 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();
      * ```
@@ -530,7 +530,7 @@ export class PublicClient {
      * 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();
      * ```
@@ -553,7 +553,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -576,7 +576,7 @@ export class PublicClient {
      * 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();
      * ```
@@ -599,7 +599,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -623,7 +623,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -647,7 +647,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -671,7 +671,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -694,7 +694,7 @@ export class PublicClient {
      * 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();
      * ```
@@ -716,7 +716,7 @@ export class PublicClient {
      * 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();
      * ```
@@ -739,7 +739,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -763,7 +763,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -787,7 +787,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -811,7 +811,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -835,7 +835,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -859,7 +859,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -883,7 +883,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -907,7 +907,7 @@ export class PublicClient {
      * 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...",
@@ -934,7 +934,7 @@ export class PublicClient {
      * 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...",
@@ -961,7 +961,7 @@ export class PublicClient {
      * 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...",
@@ -988,7 +988,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -1012,7 +1012,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -1036,7 +1036,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -1060,7 +1060,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -1084,7 +1084,7 @@ export class PublicClient {
      * 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...",
@@ -1111,7 +1111,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -1134,7 +1134,7 @@ export class PublicClient {
      * 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();
      * ```
@@ -1157,7 +1157,7 @@ export class PublicClient {
      * 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..." });
      * ```
@@ -1181,7 +1181,7 @@ export class PublicClient {
      * 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();
      * ```