@nktkas/hyperliquid 0.30.3 → 0.32.0

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

@@ -1,75 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { SpotAssetCtxSchema } from "../../info/_methods/_base/commonSchemas.js";
-
-/** Subscription to context events for all spot assets. */
-export const SpotAssetCtxsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("spotAssetCtxs"),
-        v.description("Type of subscription."),
-      ),
-    }),
-    v.description("Subscription to context events for all spot assets."),
-  );
-})();
-export type SpotAssetCtxsRequest = v.InferOutput<typeof SpotAssetCtxsRequest>;
-
-/** Event of spot asset contexts. */
-export const SpotAssetCtxsEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(SpotAssetCtxSchema),
-    v.description("Event of spot asset contexts."),
-  );
-})();
-export type SpotAssetCtxsEvent = v.InferOutput<typeof SpotAssetCtxsEvent>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { SubscriptionConfig } from "./_types.js";
-import type { ISubscription } from "../../../transport/mod.js";
-
-/**
- * Subscribe to context updates for all spot assets.
- *
- * @param config - General configuration for Subscription API subscriptions.
- * @param params - Parameters specific to the API subscription.
- * @param listener - A callback function to be called when the event is received.
- *
- * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { spotAssetCtxs } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport(); // only `WebSocketTransport`
- *
- * const sub = await spotAssetCtxs(
- *   { transport },
- *   (data) => console.log(data),
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- */
-export function spotAssetCtxs(
-  config: SubscriptionConfig,
-  listener: (data: SpotAssetCtxsEvent) => void,
-): Promise<ISubscription> {
-  const payload = v.parse(SpotAssetCtxsRequest, { type: "spotAssetCtxs" });
-  return config.transport.subscribe<SpotAssetCtxsEvent>(payload.type, payload, (e) => {
-    listener(e.detail);
-  });
-}

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

@@ -1,104 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address } from "../../_schemas.js";
-import { SpotClearinghouseStateResponse } from "../../info/_methods/spotClearinghouseState.js";
-
-/** Subscription to spot state events for a specific user. */
-export const SpotStateRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("spotState"),
-        v.description("Type of subscription."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Whether to ignore portfolio margin calculations. */
-      ignorePortfolioMargin: v.pipe(
-        v.optional(v.boolean(), false),
-        v.description("Whether to ignore portfolio margin calculations."),
-      ),
-    }),
-    v.description("Subscription to spot state events for a specific user."),
-  );
-})();
-export type SpotStateRequest = v.InferOutput<typeof SpotStateRequest>;
-
-/** Event of user spot state. */
-export const SpotStateEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Account summary for spot trading. */
-      spotState: v.pipe(
-        SpotClearinghouseStateResponse,
-        v.description("Account summary for spot trading."),
-      ),
-    }),
-    v.description("Event of user spot state."),
-  );
-})();
-export type SpotStateEvent = v.InferOutput<typeof SpotStateEvent>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { SubscriptionConfig } from "./_types.js";
-import type { ISubscription } from "../../../transport/mod.js";
-
-/** Request parameters for the {@linkcode spotState} function. */
-export type SpotStateParameters = Omit<v.InferInput<typeof SpotStateRequest>, "type">;
-
-/**
- * Subscribe to spot state updates for a specific user.
- *
- * @param config - General configuration for Subscription API subscriptions.
- * @param params - Parameters specific to the API subscription.
- * @param listener - A callback function to be called when the event is received.
- *
- * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { spotState } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport(); // only `WebSocketTransport`
- *
- * const sub = await spotState(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- */
-export function spotState(
-  config: SubscriptionConfig,
-  params: SpotStateParameters,
-  listener: (data: SpotStateEvent) => void,
-): Promise<ISubscription> {
-  const payload = v.parse(SpotStateRequest, { type: "spotState", user: params.user });
-  return config.transport.subscribe<SpotStateEvent>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user) {
-      listener(e.detail);
-    }
-  });
-}

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

@@ -1,87 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { RecentTradesResponse } from "../../info/_methods/recentTrades.js";
-
-/** Subscription to trade events for a specific asset. */
-export const TradesRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("trades"),
-        v.description("Type of subscription."),
-      ),
-      /** Asset symbol (e.g., BTC). */
-      coin: v.pipe(
-        v.string(),
-        v.description("Asset symbol (e.g., BTC)."),
-      ),
-    }),
-    v.description("Subscription to trade events for a specific asset."),
-  );
-})();
-export type TradesRequest = v.InferOutput<typeof TradesRequest>;
-
-/** Event of array of trades for a specific asset. */
-export const TradesEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    RecentTradesResponse,
-    v.description("Event of array of trades for a specific asset."),
-  );
-})();
-export type TradesEvent = v.InferOutput<typeof TradesEvent>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { SubscriptionConfig } from "./_types.js";
-import type { ISubscription } from "../../../transport/mod.js";
-
-/** Request parameters for the {@linkcode trades} function. */
-export type TradesParameters = Omit<v.InferInput<typeof TradesRequest>, "type">;
-
-/**
- * Subscribe to real-time trade updates for a specific asset.
- *
- * @param config - General configuration for Subscription API subscriptions.
- * @param params - Parameters specific to the API subscription.
- * @param listener - A callback function to be called when the event is received.
- *
- * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { trades } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport(); // only `WebSocketTransport`
- *
- * const sub = await trades(
- *   { transport },
- *   { coin: "ETH" },
- *   (data) => console.log(data),
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- */
-export function trades(
-  config: SubscriptionConfig,
-  params: TradesParameters,
-  listener: (data: TradesEvent) => void,
-): Promise<ISubscription> {
-  const payload = v.parse(TradesRequest, { type: "trades", ...params });
-  return config.transport.subscribe<TradesEvent>(payload.type, payload, (e) => {
-    if (e.detail[0]?.coin === payload.coin) {
-      listener(e.detail);
-    }
-  });
-}

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

@@ -1,113 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address, UnsignedInteger } from "../../_schemas.js";
-import { TwapStateSchema } from "../../info/_methods/_base/commonSchemas.js";
-
-/** Subscribe to TWAP states updates for a specific user. */
-export const TwapStatesRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("twapStates"),
-        v.description("Type of subscription."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** DEX name (empty string for main dex). */
-      dex: v.pipe(
-        v.optional(v.string()),
-        v.description("DEX name (empty string for main dex)."),
-      ),
-    }),
-    v.description("Subscribe to TWAP states updates for a specific user."),
-  );
-})();
-export type TwapStatesRequest = v.InferOutput<typeof TwapStatesRequest>;
-
-/** Event of user TWAP states. */
-export const TwapStatesEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** DEX name (empty string for main dex). */
-      dex: v.pipe(
-        v.string(),
-        v.description("DEX name (empty string for main dex)."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Array of tuples of TWAP ID and TWAP state. */
-      states: v.pipe(
-        v.array(v.tuple([UnsignedInteger, TwapStateSchema])),
-        v.description("Array of tuples of TWAP ID and TWAP state."),
-      ),
-    }),
-    v.description("Event of user TWAP states."),
-  );
-})();
-export type TwapStatesEvent = v.InferOutput<typeof TwapStatesEvent>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { SubscriptionConfig } from "./_types.js";
-import type { ISubscription } from "../../../transport/mod.js";
-
-/** Request parameters for the {@linkcode twapStates} function. */
-export type TwapStatesParameters = Omit<v.InferInput<typeof TwapStatesRequest>, "type">;
-
-/**
- * Subscribe to TWAP states updates for a specific user.
- *
- * @param config - General configuration for Subscription API subscriptions.
- * @param params - Parameters specific to the API subscription.
- * @param listener - A callback function to be called when the event is received.
- *
- * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { twapStates } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport(); // only `WebSocketTransport`
- *
- * const sub = await twapStates(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- */
-export function twapStates(
-  config: SubscriptionConfig,
-  params: TwapStatesParameters,
-  listener: (data: TwapStatesEvent) => void,
-): Promise<ISubscription> {
-  const payload = v.parse(TwapStatesRequest, {
-    type: "twapStates",
-    ...params,
-    dex: params.dex ?? "", // same value as in response
-  });
-  return config.transport.subscribe<TwapStatesEvent>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user && e.detail.dex === payload.dex) {
-      listener(e.detail);
-    }
-  });
-}

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

@@ -1,203 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address, Decimal, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
-import { UserTwapSliceFillsResponse } from "../../info/_methods/userTwapSliceFills.js";
-import { UserFillsResponse } from "../../info/_methods/userFills.js";
-import { TwapHistoryResponse } from "../../info/_methods/twapHistory.js";
-
-/** Subscription to user events for a specific user. */
-export const UserEventsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("userEvents"),
-        v.description("Type of subscription."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Subscription to user events for a specific user."),
-  );
-})();
-export type UserEventsRequest = v.InferOutput<typeof UserEventsRequest>;
-
-/** Event of one of possible user events. */
-export const UserEventsEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.union([
-      /** Event of array of user trade fills. */
-      v.object({
-        /** Array of user trade fills. */
-        fills: v.pipe(
-          UserFillsResponse,
-          v.description("Array of user trade fills."),
-        ),
-      }),
-      /** Event of user funding update. */
-      v.object({
-        /** Funding update details. */
-        funding: v.pipe(
-          v.object({
-            /** Asset symbol. */
-            coin: v.pipe(
-              v.string(),
-              v.description("Asset symbol."),
-            ),
-            /** Amount transferred in USDC. */
-            usdc: v.pipe(
-              Decimal,
-              v.description("Amount transferred in USDC."),
-            ),
-            /** Signed position size. */
-            szi: v.pipe(
-              Decimal,
-              v.description("Signed position size."),
-            ),
-            /** Applied funding rate. */
-            fundingRate: v.pipe(
-              Decimal,
-              v.description("Applied funding rate."),
-            ),
-            /** Number of samples. */
-            nSamples: v.pipe(
-              v.nullable(UnsignedInteger),
-              v.description("Number of samples."),
-            ),
-          }),
-          v.description("Funding update details."),
-        ),
-      }),
-      /** Event of user liquidation. */
-      v.object({
-        /** Liquidation details. */
-        liquidation: v.pipe(
-          v.object({
-            /** Unique liquidation ID. */
-            lid: v.pipe(
-              UnsignedInteger,
-              v.description("Unique liquidation ID."),
-            ),
-            /** Address of the liquidator. */
-            liquidator: v.pipe(
-              Address,
-              v.description("Address of the liquidator."),
-            ),
-            /** Address of the liquidated user. */
-            liquidated_user: v.pipe(
-              Address,
-              v.description("Address of the liquidated user."),
-            ),
-            /** Notional position size that was liquidated. */
-            liquidated_ntl_pos: v.pipe(
-              UnsignedDecimal,
-              v.description("Notional position size that was liquidated."),
-            ),
-            /** Account value at time of liquidation. */
-            liquidated_account_value: v.pipe(
-              UnsignedDecimal,
-              v.description("Account value at time of liquidation."),
-            ),
-          }),
-          v.description("Liquidation details."),
-        ),
-      }),
-      /** Event of array of non-user initiated order cancellations. */
-      v.object({
-        /** Array of non-user initiated order cancellations. */
-        nonUserCancel: v.pipe(
-          v.array(
-            /** Cancelled order not initiated by the user. */
-            v.object({
-              /** Asset symbol (e.g., BTC). */
-              coin: v.pipe(
-                v.string(),
-                v.description("Asset symbol (e.g., BTC)."),
-              ),
-              /** Order ID. */
-              oid: v.pipe(
-                UnsignedInteger,
-                v.description("Order ID."),
-              ),
-            }),
-          ),
-          v.description("Array of non-user initiated order cancellations."),
-        ),
-      }),
-      /** Event of a TWAP history entry. */
-      v.object({
-        /** Array of user's TWAP history. */
-        twapHistory: v.pipe(
-          TwapHistoryResponse,
-          v.description("Array of user's TWAP history."),
-        ),
-      }),
-      /** Event of TWAP slice fills. */
-      v.object({
-        /** Array of user's twap slice fills. */
-        twapSliceFills: v.pipe(
-          UserTwapSliceFillsResponse,
-          v.description("Array of user's twap slice fills."),
-        ),
-      }),
-    ]),
-    v.description("Event of one of possible user events."),
-  );
-})();
-export type UserEventsEvent = v.InferOutput<typeof UserEventsEvent>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { SubscriptionConfig } from "./_types.js";
-import type { ISubscription } from "../../../transport/mod.js";
-
-/** Request parameters for the {@linkcode userEvents} function. */
-export type UserEventsParameters = Omit<v.InferInput<typeof UserEventsRequest>, "type">;
-
-/**
- * Subscribe to non-order events for a specific user.
- *
- * @param config - General configuration for Subscription API subscriptions.
- * @param params - Parameters specific to the API subscription.
- * @param listener - A callback function to be called when the event is received.
- *
- * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { userEvents } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport(); // only `WebSocketTransport`
- *
- * const sub = await userEvents(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- */
-export function userEvents(
-  config: SubscriptionConfig,
-  params: UserEventsParameters,
-  listener: (data: UserEventsEvent) => void,
-): Promise<ISubscription> {
-  const payload = v.parse(UserEventsRequest, { type: "userEvents", ...params });
-  return config.transport.subscribe<UserEventsEvent>("user", payload, (e) => {
-    listener(e.detail);
-  });
-}

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

@@ -1,113 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address } from "../../_schemas.js";
-import { UserFillsResponse } from "../../info/_methods/userFills.js";
-
-/** Subscription to user fill events for a specific user. */
-export const UserFillsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("userFills"),
-        v.description("Type of subscription."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
-      aggregateByTime: v.pipe(
-        v.optional(v.boolean()),
-        v.description("If true, partial fills are aggregated when a crossing order fills multiple resting orders."),
-      ),
-    }),
-    v.description("Subscription to user fill events for a specific user."),
-  );
-})();
-export type UserFillsRequest = v.InferOutput<typeof UserFillsRequest>;
-
-/** Event of user trade fill. */
-export const UserFillsEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Array of user trade fills. */
-      fills: v.pipe(
-        UserFillsResponse,
-        v.description("Array of user trade fills."),
-      ),
-      /** Whether this is an initial snapshot. */
-      isSnapshot: v.pipe(
-        v.optional(v.literal(true)),
-        v.description("Whether this is an initial snapshot."),
-      ),
-    }),
-    v.description("Event of user trade fill."),
-  );
-})();
-export type UserFillsEvent = v.InferOutput<typeof UserFillsEvent>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { SubscriptionConfig } from "./_types.js";
-import type { ISubscription } from "../../../transport/mod.js";
-
-/** Request parameters for the {@linkcode userFills} function. */
-export type UserFillsParameters = Omit<v.InferInput<typeof UserFillsRequest>, "type">;
-
-/**
- * Subscribe to trade fill updates for a specific user.
- *
- * @param config - General configuration for Subscription API subscriptions.
- * @param params - Parameters specific to the API subscription.
- * @param listener - A callback function to be called when the event is received.
- *
- * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { userFills } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport(); // only `WebSocketTransport`
- *
- * const sub = await userFills(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- */
-export function userFills(
-  config: SubscriptionConfig,
-  params: UserFillsParameters,
-  listener: (data: UserFillsEvent) => void,
-): Promise<ISubscription> {
-  const payload = v.parse(UserFillsRequest, {
-    type: "userFills",
-    ...params,
-    aggregateByTime: params.aggregateByTime ?? false,
-  });
-  return config.transport.subscribe<UserFillsEvent>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user) {
-      listener(e.detail);
-    }
-  });
-}