@nktkas/hyperliquid 0.29.1 → 0.30.0

package/src/src/api/info/_methods/vaultDetails.ts

@@ -5,6 +5,7 @@ import * as v from "valibot";
 // ============================================================
 
 import { Address, Decimal, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+import { VaultRelationshipSchema } from "./_base/commonSchemas.js";
 import { PortfolioResponse } from "./portfolio.js";
 
 /**
@@ -72,7 +73,7 @@ export const VaultDetailsResponse = /* @__PURE__ */ (() => {
         v.number(),
         v.description("Annual percentage rate."),
       ),
-      /** Current user follower state */
+      /** Current user follower state. */
       followerState: v.pipe(
         v.nullable(
           v.object({
@@ -113,7 +114,7 @@ export const VaultDetailsResponse = /* @__PURE__ */ (() => {
             ),
           }),
         ),
-        v.description("Current user follower state"),
+        v.description("Current user follower state."),
       ),
       /** Ownership percentage held by leader. */
       leaderFraction: v.pipe(
@@ -128,47 +129,43 @@ export const VaultDetailsResponse = /* @__PURE__ */ (() => {
       /** Array of vault followers. */
       followers: v.pipe(
         v.array(
-          /** Vault follower state. */
-          v.pipe(
-            v.object({
-              /** Follower address or Leader. */
-              user: v.pipe(
-                v.union([Address, v.literal("Leader")]),
-                v.description("Follower address or Leader."),
-              ),
-              /** Follower vault equity. */
-              vaultEquity: v.pipe(
-                UnsignedDecimal,
-                v.description("Follower vault equity."),
-              ),
-              /** Current profit and loss. */
-              pnl: v.pipe(
-                Decimal,
-                v.description("Current profit and loss."),
-              ),
-              /** All-time profit and loss. */
-              allTimePnl: v.pipe(
-                Decimal,
-                v.description("All-time profit and loss."),
-              ),
-              /** Subscription duration in days. */
-              daysFollowing: v.pipe(
-                UnsignedInteger,
-                v.description("Subscription duration in days."),
-              ),
-              /** Vault entry timestamp. */
-              vaultEntryTime: v.pipe(
-                UnsignedInteger,
-                v.description("Vault entry timestamp."),
-              ),
-              /** Timestamp when funds become unlocked. */
-              lockupUntil: v.pipe(
-                UnsignedInteger,
-                v.description("Timestamp when funds become unlocked."),
-              ),
-            }),
-            v.description("Vault follower state."),
-          ),
+          v.object({
+            /** Follower address or Leader. */
+            user: v.pipe(
+              v.union([Address, v.literal("Leader")]),
+              v.description("Follower address or Leader."),
+            ),
+            /** Follower vault equity. */
+            vaultEquity: v.pipe(
+              UnsignedDecimal,
+              v.description("Follower vault equity."),
+            ),
+            /** Current profit and loss. */
+            pnl: v.pipe(
+              Decimal,
+              v.description("Current profit and loss."),
+            ),
+            /** All-time profit and loss. */
+            allTimePnl: v.pipe(
+              Decimal,
+              v.description("All-time profit and loss."),
+            ),
+            /** Subscription duration in days. */
+            daysFollowing: v.pipe(
+              UnsignedInteger,
+              v.description("Subscription duration in days."),
+            ),
+            /** Vault entry timestamp. */
+            vaultEntryTime: v.pipe(
+              UnsignedInteger,
+              v.description("Vault entry timestamp."),
+            ),
+            /** Timestamp when funds become unlocked. */
+            lockupUntil: v.pipe(
+              UnsignedInteger,
+              v.description("Timestamp when funds become unlocked."),
+            ),
+          }),
         ),
         v.description("Array of vault followers."),
       ),
@@ -189,33 +186,7 @@ export const VaultDetailsResponse = /* @__PURE__ */ (() => {
       ),
       /** Vault relationship type. */
       relationship: v.pipe(
-        v.variant("type", [
-          v.object({
-            /** Relationship type. */
-            type: v.pipe(
-              v.picklist(["normal", "child"]),
-              v.description("Relationship type."),
-            ),
-          }),
-          v.object({
-            /** Relationship type. */
-            type: v.pipe(
-              v.literal("parent"),
-              v.description("Relationship type."),
-            ),
-            /** Child vault information. */
-            data: v.pipe(
-              v.object({
-                /** Child vault addresses. */
-                childAddresses: v.pipe(
-                  v.array(Address),
-                  v.description("Child vault addresses."),
-                ),
-              }),
-              v.description("Child vault information."),
-            ),
-          }),
-        ]),
+        VaultRelationshipSchema,
         v.description("Vault relationship type."),
       ),
       /** Deposit permission status. */
@@ -238,7 +209,7 @@ export type VaultDetailsResponse = v.InferOutput<typeof VaultDetailsResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode vaultDetails} function. */
 export type VaultDetailsParameters = Omit<v.InferInput<typeof VaultDetailsRequest>, "type">;
@@ -248,7 +219,7 @@ export type VaultDetailsParameters = Omit<v.InferInput<typeof VaultDetailsReques
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Details of a vault or null if the vault does not exist.
  *

package/src/src/api/info/_methods/vaultSummaries.ts

@@ -5,6 +5,7 @@ import * as v from "valibot";
 // ============================================================
 
 import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+import { VaultRelationshipSchema } from "./_base/commonSchemas.js";
 
 /**
  * Request a list of vaults less than 2 hours old.
@@ -29,73 +30,43 @@ export type VaultSummariesRequest = v.InferOutput<typeof VaultSummariesRequest>;
 export const VaultSummariesResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** Summary of a vault. */
-      v.pipe(
-        v.object({
-          /** Vault name. */
-          name: v.pipe(
-            v.string(),
-            v.description("Vault name."),
-          ),
-          /** Vault address. */
-          vaultAddress: v.pipe(
-            Address,
-            v.description("Vault address."),
-          ),
-          /** Leader address. */
-          leader: v.pipe(
-            Address,
-            v.description("Leader address."),
-          ),
-          /** Total value locked. */
-          tvl: v.pipe(
-            UnsignedDecimal,
-            v.description("Total value locked."),
-          ),
-          /** Vault closure status. */
-          isClosed: v.pipe(
-            v.boolean(),
-            v.description("Vault closure status."),
-          ),
-          /** Vault relationship type. */
-          relationship: v.pipe(
-            v.variant("type", [
-              v.object({
-                /** Relationship type. */
-                type: v.pipe(
-                  v.picklist(["normal", "child"]),
-                  v.description("Relationship type."),
-                ),
-              }),
-              v.object({
-                /** Relationship type. */
-                type: v.pipe(
-                  v.literal("parent"),
-                  v.description("Relationship type."),
-                ),
-                /** Child vault information. */
-                data: v.pipe(
-                  v.object({
-                    /** Child vault addresses. */
-                    childAddresses: v.pipe(
-                      v.array(Address),
-                      v.description("Child vault addresses."),
-                    ),
-                  }),
-                  v.description("Child vault information."),
-                ),
-              }),
-            ]),
-            v.description("Vault relationship type."),
-          ),
-          /** Creation timestamp. */
-          createTimeMillis: v.pipe(
-            UnsignedInteger,
-            v.description("Creation timestamp."),
-          ),
-        }),
-        v.description("Summary of a vault."),
-      ),
+      v.object({
+        /** Vault name. */
+        name: v.pipe(
+          v.string(),
+          v.description("Vault name."),
+        ),
+        /** Vault address. */
+        vaultAddress: v.pipe(
+          Address,
+          v.description("Vault address."),
+        ),
+        /** Leader address. */
+        leader: v.pipe(
+          Address,
+          v.description("Leader address."),
+        ),
+        /** Total value locked. */
+        tvl: v.pipe(
+          UnsignedDecimal,
+          v.description("Total value locked."),
+        ),
+        /** Vault closure status. */
+        isClosed: v.pipe(
+          v.boolean(),
+          v.description("Vault closure status."),
+        ),
+        /** Vault relationship type. */
+        relationship: v.pipe(
+          VaultRelationshipSchema,
+          v.description("Vault relationship type."),
+        ),
+        /** Creation timestamp. */
+        createTimeMillis: v.pipe(
+          UnsignedInteger,
+          v.description("Creation timestamp."),
+        ),
+      }),
     ),
     v.description("Array of vaults less than 2 hours old."),
   );
@@ -106,13 +77,13 @@ export type VaultSummariesResponse = v.InferOutput<typeof VaultSummariesResponse
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /**
  * Request a list of vaults less than 2 hours old.
  *
  * @param config - General configuration for Info API requests.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Array of vaults less than 2 hours old.
  *

package/src/src/api/info/_methods/webData2.ts

@@ -4,7 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Address, Decimal, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+import { PerpAssetCtxSchema, SpotAssetCtxSchema, TwapStateSchema } from "./_base/commonSchemas.js";
 import { ClearinghouseStateResponse } from "./clearinghouseState.js";
 import { MetaResponse } from "./meta.js";
 import { SpotClearinghouseStateResponse } from "./spotClearinghouseState.js";
@@ -41,16 +42,25 @@ export const WebData2Response = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
       /** Account summary for perpetual trading. */
-      clearinghouseState: ClearinghouseStateResponse,
+      clearinghouseState: v.pipe(
+        ClearinghouseStateResponse,
+        v.description("Account summary for perpetual trading."),
+      ),
       /** Array of leading vaults for a user. */
-      leadingVaults: LeadingVaultsResponse,
+      leadingVaults: v.pipe(
+        LeadingVaultsResponse,
+        v.description("Array of leading vaults for a user."),
+      ),
       /** Total equity in vaults. */
       totalVaultEquity: v.pipe(
         UnsignedDecimal,
         v.description("Total equity in vaults."),
       ),
       /** Array of open orders with additional display information. */
-      openOrders: FrontendOpenOrdersResponse,
+      openOrders: v.pipe(
+        FrontendOpenOrdersResponse,
+        v.description("Array of open orders with additional display information."),
+      ),
       /** Agent address if one exists. */
       agentAddress: v.pipe(
         v.nullable(Address),
@@ -67,67 +77,13 @@ export const WebData2Response = /* @__PURE__ */ (() => {
         v.description("Cumulative ledger value."),
       ),
       /** Metadata for perpetual assets. */
-      meta: MetaResponse,
+      meta: v.pipe(
+        MetaResponse,
+        v.description("Metadata for perpetual assets."),
+      ),
       /** Array of contexts for each perpetual asset. */
       assetCtxs: v.pipe(
-        v.array(
-          /** Context for a specific perpetual asset. */
-          v.pipe(
-            v.object({
-              /** Previous day's closing price. */
-              prevDayPx: v.pipe(
-                UnsignedDecimal,
-                v.description("Previous day's closing price."),
-              ),
-              /** Daily notional volume. */
-              dayNtlVlm: v.pipe(
-                UnsignedDecimal,
-                v.description("Daily notional volume."),
-              ),
-              /** Mark price. */
-              markPx: v.pipe(
-                UnsignedDecimal,
-                v.description("Mark price."),
-              ),
-              /** Mid price. */
-              midPx: v.pipe(
-                v.nullable(UnsignedDecimal),
-                v.description("Mid price."),
-              ),
-              /** Funding rate. */
-              funding: v.pipe(
-                Decimal,
-                v.description("Funding rate."),
-              ),
-              /** Total open interest. */
-              openInterest: v.pipe(
-                UnsignedDecimal,
-                v.description("Total open interest."),
-              ),
-              /** Premium price. */
-              premium: v.pipe(
-                v.nullable(Decimal),
-                v.description("Premium price."),
-              ),
-              /** Oracle price. */
-              oraclePx: v.pipe(
-                UnsignedDecimal,
-                v.description("Oracle price."),
-              ),
-              /** Array of impact prices. */
-              impactPxs: v.pipe(
-                v.nullable(v.array(v.string())),
-                v.description("Array of impact prices."),
-              ),
-              /** Daily volume in base currency. */
-              dayBaseVlm: v.pipe(
-                UnsignedDecimal,
-                v.description("Daily volume in base currency."),
-              ),
-            }),
-            v.description("Context for a specific perpetual asset."),
-          ),
-        ),
+        v.array(PerpAssetCtxSchema),
         v.description("Array of contexts for each perpetual asset."),
       ),
       /** Server timestamp (in ms since epoch). */
@@ -145,126 +101,19 @@ export const WebData2Response = /* @__PURE__ */ (() => {
         Address,
         v.description("User address."),
       ),
-      /** Array of TWAP states. */
+      /** Array of tuples containing TWAP order ID and its state. */
       twapStates: v.pipe(
-        v.array(
-          /** TWAP ID and state. */
-          v.pipe(
-            v.tuple([
-              UnsignedInteger,
-              v.pipe(
-                v.object({
-                  /** Asset symbol. */
-                  coin: v.pipe(
-                    v.string(),
-                    v.description("Asset symbol."),
-                  ),
-                  /** Executed notional value. */
-                  executedNtl: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Executed notional value."),
-                  ),
-                  /** Executed size. */
-                  executedSz: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Executed size."),
-                  ),
-                  /** Duration in minutes. */
-                  minutes: v.pipe(
-                    UnsignedInteger,
-                    v.description("Duration in minutes."),
-                  ),
-                  /** Indicates if the TWAP randomizes execution. */
-                  randomize: v.pipe(
-                    v.boolean(),
-                    v.description("Indicates if the TWAP randomizes execution."),
-                  ),
-                  /** Indicates if the order is reduce-only. */
-                  reduceOnly: v.pipe(
-                    v.boolean(),
-                    v.description("Indicates if the order is reduce-only."),
-                  ),
-                  /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
-                  side: v.pipe(
-                    v.picklist(["B", "A"]),
-                    v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).'),
-                  ),
-                  /** Order size. */
-                  sz: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Order size."),
-                  ),
-                  /** Start time of the TWAP order (in ms since epoch). */
-                  timestamp: v.pipe(
-                    UnsignedInteger,
-                    v.description("Start time of the TWAP order (in ms since epoch)."),
-                  ),
-                  /** User address. */
-                  user: v.pipe(
-                    Address,
-                    v.description("User address."),
-                  ),
-                }),
-                v.description("State of the TWAP order."),
-              ),
-            ]),
-            v.description("TWAP ID and state."),
-          ),
-        ),
-        v.description("Array of TWAP states."),
+        v.array(v.tuple([UnsignedInteger, TwapStateSchema])),
+        v.description("Array of tuples containing TWAP order ID and its state."),
       ),
       /** Account summary for spot trading. */
-      spotState: v.optional(SpotClearinghouseStateResponse),
+      spotState: v.pipe(
+        v.optional(SpotClearinghouseStateResponse),
+        v.description("Account summary for spot trading."),
+      ),
       /** Asset context for each spot asset. */
       spotAssetCtxs: v.pipe(
-        v.array(
-          /** Context for a specific spot asset. */
-          v.pipe(
-            v.object({
-              /** Previous day's closing price. */
-              prevDayPx: v.pipe(
-                UnsignedDecimal,
-                v.description("Previous day's closing price."),
-              ),
-              /** Daily notional volume. */
-              dayNtlVlm: v.pipe(
-                UnsignedDecimal,
-                v.description("Daily notional volume."),
-              ),
-              /** Mark price. */
-              markPx: v.pipe(
-                UnsignedDecimal,
-                v.description("Mark price."),
-              ),
-              /** Mid price. */
-              midPx: v.pipe(
-                v.nullable(UnsignedDecimal),
-                v.description("Mid price."),
-              ),
-              /** Circulating supply. */
-              circulatingSupply: v.pipe(
-                UnsignedDecimal,
-                v.description("Circulating supply."),
-              ),
-              /** Asset symbol. */
-              coin: v.pipe(
-                v.string(),
-                v.description("Asset symbol."),
-              ),
-              /** Total supply. */
-              totalSupply: v.pipe(
-                UnsignedDecimal,
-                v.description("Total supply."),
-              ),
-              /** Daily volume in base currency. */
-              dayBaseVlm: v.pipe(
-                UnsignedDecimal,
-                v.description("Daily volume in base currency."),
-              ),
-            }),
-            v.description("Context for a specific spot asset."),
-          ),
-        ),
+        v.array(SpotAssetCtxSchema),
         v.description("Asset context for each spot asset."),
       ),
       /** Whether the user has opted out of spot dusting. */
@@ -287,7 +136,7 @@ export type WebData2Response = v.InferOutput<typeof WebData2Response>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode webData2} function. */
 export type WebData2Parameters = Omit<v.InferInput<typeof WebData2Request>, "type">;
@@ -297,7 +146,7 @@ export type WebData2Parameters = Omit<v.InferInput<typeof WebData2Request>, "typ
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Comprehensive user and market data.
  *

package/src/src/api/info/client.ts

@@ -1,5 +1,4 @@
-import type { InfoConfig } from "./_methods/_types.js";
-import type { HttpTransport } from "../../transport/http/mod.js";
+import type { InfoConfig } from "./_methods/_base/types.js";
 
 // =============================================================
 // Methods Imports
@@ -169,7 +168,9 @@ import { webData2, type WebData2Parameters, type WebData2Response } from "./_met
 // =============================================================
 
 /**
- * A client for interacting with the Hyperliquid Info API.
+ * Read-only access to market data, user state, and other public information.
+ *
+ * Corresponds to the {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint | Info endpoint}.
  */
 export class InfoClient<C extends InfoConfig = InfoConfig> {
   config_: C;
@@ -177,7 +178,7 @@ export class InfoClient<C extends InfoConfig = InfoConfig> {
   /**
    * Creates an instance of the InfoClient.
    *
-   * @param args - Configuration for Info API requests. See {@link InfoConfig}.
+   * @param config - Configuration for Info API requests. See {@link InfoConfig}.
    *
    * @example
    * ```ts
@@ -234,7 +235,6 @@ export class InfoClient<C extends InfoConfig = InfoConfig> {
 
   /** @see {@link blockDetails} */
   blockDetails(
-    this: { config_: { transport: HttpTransport } },
     params: BlockDetailsParameters,
     signal?: AbortSignal,
   ): Promise<BlockDetailsResponse> {
@@ -604,7 +604,6 @@ export class InfoClient<C extends InfoConfig = InfoConfig> {
 
   /** @see {@link txDetails} */
   txDetails(
-    this: { config_: { transport: HttpTransport } },
     params: TxDetailsParameters,
     signal?: AbortSignal,
   ): Promise<TxDetailsResponse> {
@@ -613,7 +612,6 @@ export class InfoClient<C extends InfoConfig = InfoConfig> {
 
   /** @see {@link userDetails} */
   userDetails(
-    this: { config_: { transport: HttpTransport } },
     params: UserDetailsParameters,
     signal?: AbortSignal,
   ): Promise<UserDetailsResponse> {
@@ -758,7 +756,7 @@ export class InfoClient<C extends InfoConfig = InfoConfig> {
 // Type Re-exports
 // =============================================================
 
-export type { InfoConfig } from "./_methods/_types.js";
+export type { InfoConfig } from "./_methods/_base/types.js";
 
 export type { ActiveAssetDataParameters, ActiveAssetDataResponse } from "./_methods/activeAssetData.js";
 export type {

package/src/src/api/info/mod.ts

@@ -2,7 +2,7 @@
  * This module re-exports all info-related API request functions and types.
  *
  * You can use raw functions to maximize tree-shaking in your app,
- * or to access [valibot](https://github.com/fabian-hiller/valibot) schemas Request/Response.
+ * or to access {@link https://github.com/fabian-hiller/valibot | valibot} schemas Request/Response.
  *
  * @example
  * ```ts
@@ -22,7 +22,7 @@
  * @module
  */
 
-export type { InfoConfig } from "./_methods/_types.js";
+export type { InfoConfig } from "./_methods/_base/types.js";
 
 export * from "./_methods/activeAssetData.js";
 export * from "./_methods/alignedQuoteTokenInfo.js";

package/src/src/api/subscription/_methods/_types.ts

@@ -1,7 +1,7 @@
-import type { WebSocketTransport } from "../../../transport/websocket/mod.js";
+import type { ISubscriptionTransport } from "../../../transport/mod.js";
 
 /** Configuration for subscription API requests. */
-export interface SubscriptionConfig<T extends WebSocketTransport = WebSocketTransport> {
+export interface SubscriptionConfig<T extends ISubscriptionTransport = ISubscriptionTransport> {
   /** The transport used to connect to the Hyperliquid API. */
   transport: T;
 }