@nktkas/hyperliquid 0.30.3 → 0.32.0

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

@@ -1,171 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address, UnsignedInteger } from "../../_schemas.js";
-import { FrontendOpenOrderSchema, OrderProcessingStatusSchema } from "./_base/commonSchemas.js";
-
-/**
- * Request user historical orders.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
- */
-export const HistoricalOrdersRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("historicalOrders"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request user historical orders."),
-  );
-})();
-export type HistoricalOrdersRequest = v.InferOutput<typeof HistoricalOrdersRequest>;
-
-/**
- * Array of frontend orders with current processing status.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
- */
-export const HistoricalOrdersResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      v.object({
-        /** Open order with additional display information. */
-        order: v.pipe(
-          FrontendOpenOrderSchema,
-          v.description("Open order with additional display information."),
-        ),
-        /**
-         * Order processing status.
-         * - `"open"`: Order active and waiting to be filled.
-         * - `"filled"`: Order fully executed.
-         * - `"canceled"`: Order canceled by the user.
-         * - `"triggered"`: Order triggered and awaiting execution.
-         * - `"rejected"`: Order rejected by the system.
-         * - `"marginCanceled"`: Order canceled due to insufficient margin.
-         * - `"vaultWithdrawalCanceled"`: Canceled due to a user withdrawal from vault.
-         * - `"openInterestCapCanceled"`: Canceled due to order being too aggressive when open interest was at cap.
-         * - `"selfTradeCanceled"`: Canceled due to self-trade prevention.
-         * - `"reduceOnlyCanceled"`: Canceled reduced-only order that does not reduce position.
-         * - `"siblingFilledCanceled"`: Canceled due to sibling ordering being filled.
-         * - `"delistedCanceled"`: Canceled due to asset delisting.
-         * - `"liquidatedCanceled"`: Canceled due to liquidation.
-         * - `"scheduledCancel"`: Canceled due to exceeding scheduled cancel deadline (dead man's switch).
-         * - `"tickRejected"`: Rejected due to invalid tick price.
-         * - `"minTradeNtlRejected"`: Rejected due to order notional below minimum.
-         * - `"perpMarginRejected"`: Rejected due to insufficient margin.
-         * - `"reduceOnlyRejected"`: Rejected due to reduce only.
-         * - `"badAloPxRejected"`: Rejected due to post-only immediate match.
-         * - `"iocCancelRejected"`: Rejected due to IOC not able to match.
-         * - `"badTriggerPxRejected"`: Rejected due to invalid TP/SL price.
-         * - `"marketOrderNoLiquidityRejected"`: Rejected due to lack of liquidity for market order.
-         * - `"positionIncreaseAtOpenInterestCapRejected"`: Rejected due to open interest cap.
-         * - `"positionFlipAtOpenInterestCapRejected"`: Rejected due to open interest cap.
-         * - `"tooAggressiveAtOpenInterestCapRejected"`: Rejected due to price too aggressive at open interest cap.
-         * - `"openInterestIncreaseRejected"`: Rejected due to open interest cap.
-         * - `"insufficientSpotBalanceRejected"`: Rejected due to insufficient spot balance.
-         * - `"oracleRejected"`: Rejected due to price too far from oracle.
-         * - `"perpMaxPositionRejected"`: Rejected due to exceeding margin tier limit at current leverage.
-         */
-        status: v.pipe(
-          OrderProcessingStatusSchema,
-          v.description(
-            "Order processing status." +
-              '\n- `"open"`: Order active and waiting to be filled.' +
-              '\n- `"filled"`: Order fully executed.' +
-              '\n- `"canceled"`: Order canceled by the user.' +
-              '\n- `"triggered"`: Order triggered and awaiting execution.' +
-              '\n- `"rejected"`: Order rejected by the system.' +
-              '\n- `"marginCanceled"`: Order canceled due to insufficient margin.' +
-              '\n- `"vaultWithdrawalCanceled"`: Canceled due to a user withdrawal from vault.' +
-              '\n- `"openInterestCapCanceled"`: Canceled due to order being too aggressive when open interest was at cap.' +
-              '\n- `"selfTradeCanceled"`: Canceled due to self-trade prevention.' +
-              '\n- `"reduceOnlyCanceled"`: Canceled reduced-only order that does not reduce position.' +
-              '\n- `"siblingFilledCanceled"`: Canceled due to sibling ordering being filled.' +
-              '\n- `"delistedCanceled"`: Canceled due to asset delisting.' +
-              '\n- `"liquidatedCanceled"`: Canceled due to liquidation.' +
-              '\n- `"scheduledCancel"`: Canceled due to exceeding scheduled cancel deadline (dead man\'s switch).' +
-              '\n- `"tickRejected"`: Rejected due to invalid tick price.' +
-              '\n- `"minTradeNtlRejected"`: Rejected due to order notional below minimum.' +
-              '\n- `"perpMarginRejected"`: Rejected due to insufficient margin.' +
-              '\n- `"reduceOnlyRejected"`: Rejected due to reduce only.' +
-              '\n- `"badAloPxRejected"`: Rejected due to post-only immediate match.' +
-              '\n- `"iocCancelRejected"`: Rejected due to IOC not able to match.' +
-              '\n- `"badTriggerPxRejected"`: Rejected due to invalid TP/SL price.' +
-              '\n- `"marketOrderNoLiquidityRejected"`: Rejected due to lack of liquidity for market order.' +
-              '\n- `"positionIncreaseAtOpenInterestCapRejected"`: Rejected due to open interest cap.' +
-              '\n- `"positionFlipAtOpenInterestCapRejected"`: Rejected due to open interest cap.' +
-              '\n- `"tooAggressiveAtOpenInterestCapRejected"`: Rejected due to price too aggressive at open interest cap.' +
-              '\n- `"openInterestIncreaseRejected"`: Rejected due to open interest cap.' +
-              '\n- `"insufficientSpotBalanceRejected"`: Rejected due to insufficient spot balance.' +
-              '\n- `"oracleRejected"`: Rejected due to price too far from oracle.' +
-              '\n- `"perpMaxPositionRejected"`: Rejected due to exceeding margin tier limit at current leverage.',
-          ),
-        ),
-        /** Timestamp when the status was last updated (in ms since epoch). */
-        statusTimestamp: v.pipe(
-          UnsignedInteger,
-          v.description("Timestamp when the status was last updated (in ms since epoch)."),
-        ),
-      }),
-    ),
-    v.description("Array of frontend orders with current processing status."),
-  );
-})();
-export type HistoricalOrdersResponse = v.InferOutput<typeof HistoricalOrdersResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/types.js";
-
-/** Request parameters for the {@linkcode historicalOrders} function. */
-export type HistoricalOrdersParameters = Omit<v.InferInput<typeof HistoricalOrdersRequest>, "type">;
-
-/**
- * Request user historical orders.
- *
- * @param config - General configuration for Info API requests.
- * @param params - Parameters specific to the API request.
- * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
- *
- * @returns Array of frontend orders with current processing status.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { historicalOrders } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await historicalOrders(
- *   { transport },
- *   { user: "0x..." },
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
- */
-export function historicalOrders(
-  config: InfoConfig,
-  params: HistoricalOrdersParameters,
-  signal?: AbortSignal,
-): Promise<HistoricalOrdersResponse> {
-  const request = v.parse(HistoricalOrdersRequest, {
-    type: "historicalOrders",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}

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

@@ -1,86 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address } from "../../_schemas.js";
-
-/**
- * Request to check if a user is a VIP.
- */
-export const IsVipRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("isVip"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request to check if a user is a VIP."),
-  );
-})();
-export type IsVipRequest = v.InferOutput<typeof IsVipRequest>;
-
-/**
- * Boolean indicating user's VIP status.
- */
-export const IsVipResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.nullable(v.boolean()),
-    v.description("Boolean indicating user's VIP status."),
-  );
-})();
-export type IsVipResponse = v.InferOutput<typeof IsVipResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/types.js";
-
-/** Request parameters for the {@linkcode isVip} function. */
-export type IsVipParameters = Omit<v.InferInput<typeof IsVipRequest>, "type">;
-
-/**
- * Request to check if a user is a VIP.
- *
- * @param config - General configuration for Info API requests.
- * @param params - Parameters specific to the API request.
- * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
- *
- * @returns Boolean indicating user's VIP status.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { isVip } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await isVip(
- *   { transport },
- *   { user: "0x..." },
- * );
- * ```
- */
-export function isVip(
-  config: InfoConfig,
-  params: IsVipParameters,
-  signal?: AbortSignal,
-): Promise<IsVipResponse> {
-  const request = v.parse(IsVipRequest, {
-    type: "isVip",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}

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

@@ -1,141 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
-
-/**
- * Request L2 order book.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
- */
-export const L2BookRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("l2Book"),
-        v.description("Type of request."),
-      ),
-      /** Asset symbol (e.g., BTC). */
-      coin: v.pipe(
-        v.string(),
-        v.description("Asset symbol (e.g., BTC)."),
-      ),
-      /** Number of significant figures. */
-      nSigFigs: v.pipe(
-        v.nullish(v.picklist([2, 3, 4, 5])),
-        v.description("Number of significant figures."),
-      ),
-      /** Mantissa for aggregation (if `nSigFigs` is 5). */
-      mantissa: v.pipe(
-        v.nullish(v.picklist([2, 5])),
-        v.description("Mantissa for aggregation (if `nSigFigs` is 5)."),
-      ),
-    }),
-    v.description("Request L2 order book."),
-  );
-})();
-export type L2BookRequest = v.InferOutput<typeof L2BookRequest>;
-
-const L2BookLevelSchema = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Price. */
-      px: v.pipe(
-        UnsignedDecimal,
-        v.description("Price."),
-      ),
-      /** Total size. */
-      sz: v.pipe(
-        UnsignedDecimal,
-        v.description("Total size."),
-      ),
-      /** Number of individual orders. */
-      n: v.pipe(
-        UnsignedInteger,
-        v.description("Number of individual orders."),
-      ),
-    }),
-    v.description("L2 order book level."),
-  );
-})();
-
-/**
- * L2 order book snapshot or `null` if the market does not exist.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
- */
-export const L2BookResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.nullable(
-      v.object({
-        /** Asset symbol. */
-        coin: v.pipe(
-          v.string(),
-          v.description("Asset symbol."),
-        ),
-        /** Timestamp of the snapshot (in ms since epoch). */
-        time: v.pipe(
-          UnsignedInteger,
-          v.description("Timestamp of the snapshot (in ms since epoch)."),
-        ),
-        /** Bid and ask levels (index 0 = bids, index 1 = asks). */
-        levels: v.pipe(
-          v.tuple([v.array(L2BookLevelSchema), v.array(L2BookLevelSchema)]),
-          v.description("Bid and ask levels (index 0 = bids, index 1 = asks)."),
-        ),
-      }),
-    ),
-    v.description("L2 order book snapshot or `null` if the market does not exist."),
-  );
-})();
-export type L2BookResponse = v.InferOutput<typeof L2BookResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/types.js";
-
-/** Request parameters for the {@linkcode l2Book} function. */
-export type L2BookParameters = Omit<v.InferInput<typeof L2BookRequest>, "type">;
-
-/**
- * Request L2 order book.
- *
- * @param config - General configuration for Info API requests.
- * @param params - Parameters specific to the API request.
- * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
- *
- * @returns L2 order book snapshot.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { l2Book } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await l2Book(
- *   { transport },
- *   { coin: "ETH", nSigFigs: 2 },
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
- */
-export function l2Book(
-  config: InfoConfig,
-  params: L2BookParameters,
-  signal?: AbortSignal,
-): Promise<L2BookResponse> {
-  const request = v.parse(L2BookRequest, {
-    type: "l2Book",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}

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

@@ -1,99 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address } from "../../_schemas.js";
-
-/**
- * Request leading vaults for a user.
- */
-export const LeadingVaultsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("leadingVaults"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request leading vaults for a user."),
-  );
-})();
-export type LeadingVaultsRequest = v.InferOutput<typeof LeadingVaultsRequest>;
-
-/**
- * Array of leading vaults for a user.
- */
-export const LeadingVaultsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      v.object({
-        /** Vault address. */
-        address: v.pipe(
-          Address,
-          v.description("Vault address."),
-        ),
-        /** Vault name. */
-        name: v.pipe(
-          v.string(),
-          v.description("Vault name."),
-        ),
-      }),
-    ),
-    v.description("Array of leading vaults for a user."),
-  );
-})();
-export type LeadingVaultsResponse = v.InferOutput<typeof LeadingVaultsResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/types.js";
-
-/** Request parameters for the {@linkcode leadingVaults} function. */
-export type LeadingVaultsParameters = Omit<v.InferInput<typeof LeadingVaultsRequest>, "type">;
-
-/**
- * Request leading vaults for a user.
- *
- * @param config - General configuration for Info API requests.
- * @param params - Parameters specific to the API request.
- * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
- *
- * @returns Array of leading vaults for a user.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { leadingVaults } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await leadingVaults(
- *   { transport },
- *   { user: "0x..." },
- * );
- * ```
- */
-export function leadingVaults(
-  config: InfoConfig,
-  params: LeadingVaultsParameters,
-  signal?: AbortSignal,
-): Promise<LeadingVaultsResponse> {
-  const request = v.parse(LeadingVaultsRequest, {
-    type: "leadingVaults",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}

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

@@ -1,102 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address } from "../../_schemas.js";
-
-/**
- * Request legal verification status of a user.
- */
-export const LegalCheckRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("legalCheck"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request legal verification status of a user."),
-  );
-})();
-export type LegalCheckRequest = v.InferOutput<typeof LegalCheckRequest>;
-
-/**
- * Legal verification status for a user.
- */
-export const LegalCheckResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Whether the user IP address is allowed. */
-      ipAllowed: v.pipe(
-        v.boolean(),
-        v.description("Whether the user IP address is allowed."),
-      ),
-      /** Whether the user has accepted the terms of service. */
-      acceptedTerms: v.pipe(
-        v.boolean(),
-        v.description("Whether the user has accepted the terms of service."),
-      ),
-      /** Whether the user is allowed to use the platform. */
-      userAllowed: v.pipe(
-        v.boolean(),
-        v.description("Whether the user is allowed to use the platform."),
-      ),
-    }),
-    v.description("Legal verification status for a user."),
-  );
-})();
-export type LegalCheckResponse = v.InferOutput<typeof LegalCheckResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/types.js";
-
-/** Request parameters for the {@linkcode legalCheck} function. */
-export type LegalCheckParameters = Omit<v.InferInput<typeof LegalCheckRequest>, "type">;
-
-/**
- * Request legal verification status of a user.
- *
- * @param config - General configuration for Info API requests.
- * @param params - Parameters specific to the API request.
- * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
- *
- * @returns Legal verification status for a user.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { legalCheck } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await legalCheck(
- *   { transport },
- *   { user: "0x..." },
- * );
- * ```
- */
-export function legalCheck(
-  config: InfoConfig,
-  params: LegalCheckParameters,
-  signal?: AbortSignal,
-): Promise<LegalCheckResponse> {
-  const request = v.parse(LegalCheckRequest, {
-    type: "legalCheck",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}

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

@@ -1,70 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-/**
- * Request liquidatable.
- */
-export const LiquidatableRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("liquidatable"),
-        v.description("Type of request."),
-      ),
-    }),
-    v.description("Request liquidatable."),
-  );
-})();
-export type LiquidatableRequest = v.InferOutput<typeof LiquidatableRequest>;
-
-/**
- * Response for liquidatable request.
- */
-export const LiquidatableResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(v.unknown()),
-    v.description("Response for liquidatable request."),
-  );
-})();
-export type LiquidatableResponse = v.InferOutput<typeof LiquidatableResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/types.js";
-
-/**
- * Request liquidatable.
- *
- * @param config - General configuration for Info API requests.
- * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
- *
- * @returns unknown
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { liquidatable } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await liquidatable({ transport });
- * ```
- */
-export function liquidatable(
-  config: InfoConfig,
-  signal?: AbortSignal,
-): Promise<LiquidatableResponse> {
-  const request = v.parse(LiquidatableRequest, {
-    type: "liquidatable",
-  });
-  return config.transport.request("info", request, signal);
-}