@nktkas/hyperliquid 0.25.8 → 0.26.0

package/src/src/api/subscription/userNonFundingLedgerUpdates.ts

@@ -1,95 +0,0 @@
-import * as v from "valibot";
-import { Address, type DeepImmutable, parser } from "../_base.js";
-import type { SubscriptionRequestConfig } from "./_types.js";
-import type { Subscription } from "../../transport/base.js";
-
-import { UserNonFundingLedgerUpdatesResponse } from "../info/userNonFundingLedgerUpdates.js";
-
-// -------------------- Schemas --------------------
-
-/** Subscription to user non-funding ledger updates for a specific user. */
-export const UserNonFundingLedgerUpdatesRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("userNonFundingLedgerUpdates"),
-        v.description("Type of subscription."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Subscription to user non-funding ledger updates for a specific user."),
-  );
-})();
-export type UserNonFundingLedgerUpdatesRequest = v.InferOutput<typeof UserNonFundingLedgerUpdatesRequest>;
-
-/** Event of user non-funding ledger updates. */
-export const UserNonFundingLedgerUpdatesEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Array of user's non-funding ledger update. */
-      nonFundingLedgerUpdates: UserNonFundingLedgerUpdatesResponse,
-      /** 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 non-funding ledger updates."),
-  );
-})();
-export type UserNonFundingLedgerUpdatesEvent = v.InferOutput<typeof UserNonFundingLedgerUpdatesEvent>;
-
-// -------------------- Function --------------------
-
-/** Request parameters for the {@linkcode userNonFundingLedgerUpdates} function. */
-export type UserNonFundingLedgerUpdatesParameters = Omit<
-  v.InferInput<typeof UserNonFundingLedgerUpdatesRequest>,
-  "type"
->;
-
-/**
- * Subscribe to non-funding ledger 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 Subscription} object to manage the subscription lifecycle.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { userNonFundingLedgerUpdates } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport();
- *
- * const sub = await userNonFundingLedgerUpdates(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- */
-export function userNonFundingLedgerUpdates(
-  config: SubscriptionRequestConfig,
-  params: DeepImmutable<UserNonFundingLedgerUpdatesParameters>,
-  listener: (data: UserNonFundingLedgerUpdatesEvent) => void,
-): Promise<Subscription> {
-  const payload = parser(UserNonFundingLedgerUpdatesRequest)({ type: "userNonFundingLedgerUpdates", ...params });
-  return config.transport.subscribe<UserNonFundingLedgerUpdatesEvent>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user) {
-      listener(e.detail);
-    }
-  });
-}

package/src/src/api/subscription/userTwapHistory.ts

@@ -1,116 +0,0 @@
-import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
-import type { SubscriptionRequestConfig } from "./_types.js";
-import type { Subscription } from "../../transport/base.js";
-
-import { TwapStateSchema, TwapStatusSchema } from "../_common_schemas.js";
-
-// -------------------- Schemas --------------------
-
-/** Subscription to user TWAP history events for a specific user. */
-export const UserTwapHistoryRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("userTwapHistory"),
-        v.description("Type of subscription."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Subscription to user TWAP history events for a specific user."),
-  );
-})();
-export type UserTwapHistoryRequest = v.InferOutput<typeof UserTwapHistoryRequest>;
-
-/** Event of user TWAP history. */
-export const UserTwapHistoryEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Array of user's TWAP history. */
-      history: v.pipe(
-        v.array(
-          /** TWAP history record. */
-          v.pipe(
-            v.object({
-              /** Creation time of the history record (in seconds since epoch). */
-              time: v.pipe(
-                UnsignedInteger,
-                v.description("Creation time of the history record (in seconds since epoch)."),
-              ),
-              /** State of the TWAP order. */
-              state: TwapStateSchema,
-              /** Current status of the TWAP order. */
-              status: TwapStatusSchema,
-              /** ID of the TWAP. */
-              twapId: v.pipe(
-                v.optional(UnsignedInteger),
-                v.description("ID of the TWAP."),
-              ),
-            }),
-            v.description("TWAP history record."),
-          ),
-        ),
-        v.description("Array of user's TWAP history."),
-      ),
-      /** 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 TWAP history."),
-  );
-})();
-export type UserTwapHistoryEvent = v.InferOutput<typeof UserTwapHistoryEvent>;
-
-// -------------------- Function --------------------
-
-/** Request parameters for the {@linkcode userTwapHistory} function. */
-export type UserTwapHistoryParameters = Omit<v.InferInput<typeof UserTwapHistoryRequest>, "type">;
-
-/**
- * Subscribe to TWAP order history 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 Subscription} object to manage the subscription lifecycle.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { userTwapHistory } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport();
- *
- * const sub = await userTwapHistory(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- */
-export function userTwapHistory(
-  config: SubscriptionRequestConfig,
-  params: DeepImmutable<UserTwapHistoryParameters>,
-  listener: (data: UserTwapHistoryEvent) => void,
-): Promise<Subscription> {
-  const payload = parser(UserTwapHistoryRequest)({ type: "userTwapHistory", ...params });
-  return config.transport.subscribe<UserTwapHistoryEvent>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user) {
-      listener(e.detail);
-    }
-  });
-}

package/src/src/api/subscription/userTwapSliceFills.ts

@@ -1,105 +0,0 @@
-import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
-import type { SubscriptionRequestConfig } from "./_types.js";
-import type { Subscription } from "../../transport/base.js";
-
-import { TwapFillSchema } from "../_common_schemas.js";
-
-// -------------------- Schemas --------------------
-
-/** Subscription to user TWAP slice fill events for a specific user. */
-export const UserTwapSliceFillsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("userTwapSliceFills"),
-        v.description("Type of subscription."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Subscription to user TWAP slice fill events for a specific user."),
-  );
-})();
-export type UserTwapSliceFillsRequest = v.InferOutput<typeof UserTwapSliceFillsRequest>;
-
-/** Event of user TWAP slice fill. */
-export const UserTwapSliceFillsEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Array of TWAP slice fills. */
-      twapSliceFills: v.pipe(
-        v.array(
-          v.object({
-            /** Fill details for the TWAP slice. */
-            fill: TwapFillSchema,
-            /** ID of the TWAP. */
-            twapId: v.pipe(
-              UnsignedInteger,
-              v.description("ID of the TWAP."),
-            ),
-          }),
-        ),
-        v.description("Array of TWAP slice 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 TWAP slice fill."),
-  );
-})();
-export type UserTwapSliceFillsEvent = v.InferOutput<typeof UserTwapSliceFillsEvent>;
-
-// -------------------- Function --------------------
-
-/** Request parameters for the {@linkcode userTwapSliceFills} function. */
-export type UserTwapSliceFillsParameters = Omit<v.InferInput<typeof UserTwapSliceFillsRequest>, "type">;
-
-/**
- * Subscribe to TWAP execution 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 Subscription} object to manage the subscription lifecycle.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { userTwapSliceFills } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport();
- *
- * const sub = await userTwapSliceFills(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- */
-export function userTwapSliceFills(
-  config: SubscriptionRequestConfig,
-  params: DeepImmutable<UserTwapSliceFillsParameters>,
-  listener: (data: UserTwapSliceFillsEvent) => void,
-): Promise<Subscription> {
-  const payload = parser(UserTwapSliceFillsRequest)({ type: "userTwapSliceFills", ...params });
-  return config.transport.subscribe<UserTwapSliceFillsEvent>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user) {
-      listener(e.detail);
-    }
-  });
-}

package/src/src/api/subscription/webData2.ts

@@ -1,180 +0,0 @@
-import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_base.js";
-import type { SubscriptionRequestConfig } from "./_types.js";
-import type { Subscription } from "../../transport/base.js";
-
-import { DetailedOrderSchema, TwapStateSchema } from "../_common_schemas.js";
-import { MetaAndAssetCtxsResponse } from "../info/metaAndAssetCtxs.js";
-import { ClearinghouseStateResponse } from "../info/clearinghouseState.js";
-import { SpotClearinghouseStateResponse } from "../info/spotClearinghouseState.js";
-import { SpotMetaAndAssetCtxsResponse } from "../info/spotMetaAndAssetCtxs.js";
-
-// -------------------- Schemas --------------------
-
-/** Subscription to comprehensive user and market data events. */
-export const WebData2Request = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("webData2"),
-        v.description("Type of subscription."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Subscription to comprehensive user and market data events."),
-  );
-})();
-export type WebData2Request = v.InferOutput<typeof WebData2Request>;
-
-/** Event of comprehensive user and market data. */
-export const WebData2Event = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Account summary for perpetual trading. */
-      clearinghouseState: ClearinghouseStateResponse,
-      /** Array of leading vaults. */
-      leadingVaults: v.pipe(
-        v.array(
-          /** Vault that a user is leading. */
-          v.pipe(
-            v.object({
-              /** Address of the vault. */
-              address: v.pipe(
-                Address,
-                v.description("Address of the vault."),
-              ),
-              /** Name of the vault. */
-              name: v.pipe(
-                v.string(),
-                v.description("Name of the vault."),
-              ),
-            }),
-            v.description("Vault that a user is leading."),
-          ),
-        ),
-        v.description("Array of leading vaults."),
-      ),
-      /** Total equity in vaults. */
-      totalVaultEquity: v.pipe(
-        UnsignedDecimal,
-        v.description("Total equity in vaults."),
-      ),
-      /** Array of user open orders with frontend information. */
-      openOrders: v.pipe(
-        v.array(DetailedOrderSchema),
-        v.description("User open orders with frontend information."),
-      ),
-      /** Agent address if one exists. */
-      agentAddress: v.pipe(
-        v.nullable(Address),
-        v.description("Agent address if one exists."),
-      ),
-      /** Timestamp until which the agent is valid. */
-      agentValidUntil: v.pipe(
-        v.nullable(UnsignedInteger),
-        v.description("Timestamp until which the agent is valid."),
-      ),
-      /** Cumulative ledger value. */
-      cumLedger: v.pipe(
-        UnsignedDecimal,
-        v.description("Cumulative ledger value."),
-      ),
-      /** Metadata for perpetual assets. */
-      meta: MetaAndAssetCtxsResponse.items[0],
-      /** Context for each perpetual asset. */
-      assetCtxs: MetaAndAssetCtxsResponse.items[1],
-      /** Server timestamp (in ms since epoch). */
-      serverTime: v.pipe(
-        UnsignedInteger,
-        v.description("Server timestamp (in ms since epoch)."),
-      ),
-      /** Whether this account is a vault. */
-      isVault: v.pipe(
-        v.boolean(),
-        v.description("Whether this account is a vault."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Array of TWAP states. */
-      twapStates: v.pipe(
-        v.array(
-          /** TWAP ID and state. */
-          v.pipe(
-            v.tuple([
-              UnsignedInteger,
-              TwapStateSchema,
-            ]),
-            v.description("TWAP ID and state."),
-          ),
-        ),
-        v.description("Array of TWAP states."),
-      ),
-      /** Account summary for spot trading. */
-      spotState: v.optional(SpotClearinghouseStateResponse),
-      /** Context for each spot asset. */
-      spotAssetCtxs: SpotMetaAndAssetCtxsResponse.items[1],
-      /** Whether the user has opted out of spot dusting. */
-      optOutOfSpotDusting: v.pipe(
-        v.optional(v.literal(true)),
-        v.description("Whether the user has opted out of spot dusting."),
-      ),
-      /** Assets currently at their open interest cap. */
-      perpsAtOpenInterestCap: v.pipe(
-        v.optional(v.array(v.string())),
-        v.description("Assets currently at their open interest cap."),
-      ),
-    }),
-    v.description("Comprehensive user and market data."),
-  );
-})();
-export type WebData2Event = v.InferOutput<typeof WebData2Event>;
-
-// -------------------- Function --------------------
-
-/** Request parameters for the {@linkcode webData2} function. */
-export type WebData2Parameters = Omit<v.InferInput<typeof WebData2Request>, "type">;
-
-/**
- * Subscribe to comprehensive user and market data updates.
- * @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 Subscription} object to manage the subscription lifecycle.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { webData2 } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport();
- *
- * const sub = await webData2(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- */
-export function webData2(
-  config: SubscriptionRequestConfig,
-  params: DeepImmutable<WebData2Parameters>,
-  listener: (data: WebData2Event) => void,
-): Promise<Subscription> {
-  const payload = parser(WebData2Request)({ type: "webData2", ...params });
-  return config.transport.subscribe<WebData2Event>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user) {
-      listener(e.detail);
-    }
-  });
-}

package/src/src/api/subscription/webData3.ts

@@ -1,179 +0,0 @@
-import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_base.js";
-import type { SubscriptionRequestConfig } from "./_types.js";
-import type { Subscription } from "../../transport/base.js";
-
-import { DetailedOrderSchema } from "../_common_schemas.js";
-import { MetaAndAssetCtxsResponse } from "../info/metaAndAssetCtxs.js";
-import { ClearinghouseStateResponse } from "../info/clearinghouseState.js";
-
-// -------------------- Schemas --------------------
-
-/** Subscription to comprehensive user and market data events. */
-export const WebData3Request = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of subscription. */
-      type: v.pipe(
-        v.literal("webData3"),
-        v.description("Type of subscription."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Subscription to comprehensive user and market data events."),
-  );
-})();
-export type WebData3Request = v.InferOutput<typeof WebData3Request>;
-
-/** Event of comprehensive user and market data. */
-export const WebData3Event = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** User state information. */
-      userState: v.pipe(
-        v.object({
-          /** Agent address if one exists. */
-          agentAddress: v.pipe(
-            v.nullable(Address),
-            v.description("Agent address if one exists."),
-          ),
-          /** Timestamp until which the agent is valid. */
-          agentValidUntil: v.pipe(
-            v.nullable(UnsignedInteger),
-            v.description("Timestamp until which the agent is valid."),
-          ),
-          /** Cumulative ledger value. */
-          cumLedger: v.pipe(
-            UnsignedDecimal,
-            v.description("Cumulative ledger value."),
-          ),
-          /** Server timestamp (in ms since epoch). */
-          serverTime: v.pipe(
-            UnsignedInteger,
-            v.description("Server timestamp (in ms since epoch)."),
-          ),
-          /** Whether this account is a vault. */
-          isVault: v.pipe(
-            v.boolean(),
-            v.description("Whether this account is a vault."),
-          ),
-          /** User address. */
-          user: v.pipe(
-            Address,
-            v.description("User address."),
-          ),
-          /** Whether the user has opted out of spot dusting. */
-          optOutOfSpotDusting: v.pipe(
-            v.optional(v.literal(true)),
-            v.description("Whether the user has opted out of spot dusting."),
-          ),
-          /** Whether DEX abstraction is enabled. */
-          dexAbstractionEnabled: v.pipe(
-            v.optional(v.boolean()),
-            v.description("Whether DEX abstraction is enabled."),
-          ),
-        }),
-        v.description("User state information."),
-      ),
-      /** Array of perpetual DEX states. */
-      perpDexStates: v.pipe(
-        v.array(
-          v.object({
-            /** Account summary for perpetual trading. */
-            clearinghouseState: ClearinghouseStateResponse,
-            /** Total equity in vaults. */
-            totalVaultEquity: v.pipe(
-              UnsignedDecimal,
-              v.description("Total equity in vaults."),
-            ),
-            /** Array of user open orders with frontend information. */
-            openOrders: v.pipe(
-              v.optional(v.array(DetailedOrderSchema)),
-              v.description("User open orders with frontend information."),
-            ),
-            /** Context for each perpetual asset. */
-            assetCtxs: MetaAndAssetCtxsResponse.items[1],
-            /** Assets currently at their open interest cap. */
-            perpsAtOpenInterestCap: v.pipe(
-              v.optional(v.array(v.string())),
-              v.description("Assets currently at their open interest cap."),
-            ),
-            /** Array of leading vaults. */
-            leadingVaults: v.pipe(
-              v.optional(
-                v.array(
-                  /** Vault that a user is leading. */
-                  v.pipe(
-                    v.object({
-                      /** Address of the vault. */
-                      address: v.pipe(
-                        Address,
-                        v.description("Address of the vault."),
-                      ),
-                      /** Name of the vault. */
-                      name: v.pipe(
-                        v.string(),
-                        v.description("Name of the vault."),
-                      ),
-                    }),
-                    v.description("Vault that a user is leading."),
-                  ),
-                ),
-              ),
-              v.description("Array of leading vaults."),
-            ),
-          }),
-        ),
-        v.description("Array of perpetual DEX states."),
-      ),
-    }),
-    v.description("Comprehensive user and market data."),
-  );
-})();
-export type WebData3Event = v.InferOutput<typeof WebData3Event>;
-
-// -------------------- Function --------------------
-
-/** Request parameters for the {@linkcode webData3} function. */
-export type WebData3Parameters = Omit<v.InferInput<typeof WebData3Request>, "type">;
-
-/**
- * Subscribe to comprehensive user and market data updates.
- * @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 Subscription} object to manage the subscription lifecycle.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { webData3 } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport();
- *
- * const sub = await webData3(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- */
-export function webData3(
-  config: SubscriptionRequestConfig,
-  params: DeepImmutable<WebData3Parameters>,
-  listener: (data: WebData3Event) => void,
-): Promise<Subscription> {
-  const payload = parser(WebData3Request)({ type: "webData3", ...params });
-  return config.transport.subscribe<WebData3Event>(payload.type, payload, (e) => {
-    if (e.detail.userState.user === payload.user) {
-      listener(e.detail);
-    }
-  });
-}