@nktkas/hyperliquid 0.24.3 → 0.25.0-beta.2

package/esm/src/schemas/mod.d.ts

@@ -0,0 +1,101 @@
+/**
+ * This module provides valibot schemas for validating, formatting, and inferring types for data used in the Hyperliquid API.
+ *
+ * @example
+ * ```ts
+ * import { OrderRequest, parser } from "@nktkas/hyperliquid/schemas";
+ * //       ^^^^^^^^^^^^
+ * //       both a Valibot schema and a TypeScript type
+ *
+ * const action = {
+ *   type: "order",
+ *   orders: [{
+ *       a: 0,
+ *       b: true,
+ *       p: "50000",
+ *       s: "0.1",
+ *       r: false,
+ *       t: { limit: { tif: "Gtc" } },
+ *   }],
+ *   grouping: "na",
+ * } satisfies OrderRequest["action"]; // can be used as type
+ *
+ * //                             or as valibot schema
+ * //                             ⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄
+ * const validatedAction = parser(OrderRequest.entries.action)(action);
+ * //                      ^^^^^^
+ * //                      validates, formats, sorts object keys for correct signature generation
+ * //                      and returns typed data
+ * ```
+ *
+ * Also valibot schema can be converted to JSON Schema:
+ *
+ * @example
+ * ```ts
+ * import { OrderRequest } from "@nktkas/hyperliquid/schemas";
+ * import { toJsonSchema } from "npm:@valibot/to-json-schema";
+ *
+ * const schema = toJsonSchema(OrderRequest, { errorMode: "ignore" });
+ *
+ * console.log(JSON.stringify(schema, null, 2));
+ * // {
+ * //   "$schema": "http://json-schema.org/draft-07/schema#",
+ * //   "type": "object",
+ * //   "properties": {
+ * //     "action": {
+ * //       "type": "object",
+ * //       "properties": {
+ * //         "type": { "const": "order" },
+ * //         "orders": { "type": "array", "items": {...} },
+ * //         "grouping": { "anyOf": [...] },
+ * //         "builder": { "type": "object", ... }
+ * //       },
+ * //       "required": ["type", "orders", "grouping"]
+ * //     },
+ * //     "nonce": { "type": "number" },
+ * //     "signature": {
+ * //       "type": "object",
+ * //       "properties": {
+ * //         "r": { "type": "string", ... },
+ * //         "s": { "type": "string", ... },
+ * //         "v": { "anyOf": [{"const": 27}, {"const": 28}] }
+ * //       },
+ * //       "required": ["r", "s", "v"]
+ * //     },
+ * //     "vaultAddress": { "type": "string", ... },
+ * //     "expiresAfter": { "type": "number" }
+ * //   },
+ * //   "required": ["action", "nonce", "signature"]
+ * // }
+ * ```
+ *
+ * @module
+ */
+import * as v from "valibot";
+import { HyperliquidError } from "../errors.js";
+/** Thrown when a schema validation error occurs.  */
+export declare class SchemaError extends HyperliquidError {
+    constructor(message: string);
+}
+/**
+ * Creates a valibot parser with summarized error messages.
+ * Used for validating, formatting, and sorting object keys for correct signature generation.
+ * @param schema - The valibot schema to validate against.
+ * @returns A parser function that validates input against the schema.
+ */
+export declare function parser<TSchema extends v.GenericSchema>(schema: TSchema): v.Parser<TSchema, undefined>;
+export { Hex } from "./_base.js";
+export * from "./exchange/requests.js";
+export * from "./exchange/responses.js";
+export * from "./explorer/requests.js";
+export * from "./explorer/responses.js";
+export * from "./info/accounts.js";
+export * from "./info/assets.js";
+export * from "./info/markets.js";
+export * from "./info/orders.js";
+export * from "./info/requests.js";
+export * from "./info/validators.js";
+export * from "./info/vaults.js";
+export * from "./subscriptions/responses.js";
+export * from "./subscriptions/requests.js";
+//# sourceMappingURL=mod.d.ts.map

package/esm/src/schemas/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/src/schemas/mod.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AAEH,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,qDAAqD;AACrD,qBAAa,WAAY,SAAQ,gBAAgB;gBACjC,OAAO,EAAE,MAAM;CAI9B;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,OAAO,SAAS,CAAC,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAUrG;AAED,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AAExC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AAExC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,6BAA6B,CAAC"}

package/esm/src/schemas/mod.js

@@ -0,0 +1,115 @@
+/**
+ * This module provides valibot schemas for validating, formatting, and inferring types for data used in the Hyperliquid API.
+ *
+ * @example
+ * ```ts
+ * import { OrderRequest, parser } from "@nktkas/hyperliquid/schemas";
+ * //       ^^^^^^^^^^^^
+ * //       both a Valibot schema and a TypeScript type
+ *
+ * const action = {
+ *   type: "order",
+ *   orders: [{
+ *       a: 0,
+ *       b: true,
+ *       p: "50000",
+ *       s: "0.1",
+ *       r: false,
+ *       t: { limit: { tif: "Gtc" } },
+ *   }],
+ *   grouping: "na",
+ * } satisfies OrderRequest["action"]; // can be used as type
+ *
+ * //                             or as valibot schema
+ * //                             ⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄⌄
+ * const validatedAction = parser(OrderRequest.entries.action)(action);
+ * //                      ^^^^^^
+ * //                      validates, formats, sorts object keys for correct signature generation
+ * //                      and returns typed data
+ * ```
+ *
+ * Also valibot schema can be converted to JSON Schema:
+ *
+ * @example
+ * ```ts
+ * import { OrderRequest } from "@nktkas/hyperliquid/schemas";
+ * import { toJsonSchema } from "npm:@valibot/to-json-schema";
+ *
+ * const schema = toJsonSchema(OrderRequest, { errorMode: "ignore" });
+ *
+ * console.log(JSON.stringify(schema, null, 2));
+ * // {
+ * //   "$schema": "http://json-schema.org/draft-07/schema#",
+ * //   "type": "object",
+ * //   "properties": {
+ * //     "action": {
+ * //       "type": "object",
+ * //       "properties": {
+ * //         "type": { "const": "order" },
+ * //         "orders": { "type": "array", "items": {...} },
+ * //         "grouping": { "anyOf": [...] },
+ * //         "builder": { "type": "object", ... }
+ * //       },
+ * //       "required": ["type", "orders", "grouping"]
+ * //     },
+ * //     "nonce": { "type": "number" },
+ * //     "signature": {
+ * //       "type": "object",
+ * //       "properties": {
+ * //         "r": { "type": "string", ... },
+ * //         "s": { "type": "string", ... },
+ * //         "v": { "anyOf": [{"const": 27}, {"const": 28}] }
+ * //       },
+ * //       "required": ["r", "s", "v"]
+ * //     },
+ * //     "vaultAddress": { "type": "string", ... },
+ * //     "expiresAfter": { "type": "number" }
+ * //   },
+ * //   "required": ["action", "nonce", "signature"]
+ * // }
+ * ```
+ *
+ * @module
+ */
+import * as v from "valibot";
+import { HyperliquidError } from "../errors.js";
+/** Thrown when a schema validation error occurs.  */
+export class SchemaError extends HyperliquidError {
+    constructor(message) {
+        super(message);
+        this.name = "SchemaError";
+    }
+}
+/**
+ * Creates a valibot parser with summarized error messages.
+ * Used for validating, formatting, and sorting object keys for correct signature generation.
+ * @param schema - The valibot schema to validate against.
+ * @returns A parser function that validates input against the schema.
+ */
+export function parser(schema) {
+    const safeParser = v.safeParser(schema);
+    const parser = (input) => {
+        const result = safeParser(input);
+        if (result.issues)
+            throw new SchemaError("\n" + v.summarize(result.issues));
+        return result.output;
+    };
+    parser.schema = schema;
+    parser.config = undefined;
+    return parser;
+}
+export { Hex } from "./_base.js";
+export * from "./exchange/requests.js";
+export * from "./exchange/responses.js";
+export * from "./explorer/requests.js";
+export * from "./explorer/responses.js";
+export * from "./info/accounts.js";
+export * from "./info/assets.js";
+export * from "./info/markets.js";
+export * from "./info/orders.js";
+export * from "./info/requests.js";
+export * from "./info/validators.js";
+export * from "./info/vaults.js";
+export * from "./subscriptions/responses.js";
+export * from "./subscriptions/requests.js";
+//# sourceMappingURL=mod.js.map

package/esm/src/schemas/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../../src/src/schemas/mod.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AAEH,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,qDAAqD;AACrD,MAAM,OAAO,WAAY,SAAQ,gBAAgB;IAC7C,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC9B,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAkC,MAAe;IACnE,MAAM,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,CAAC,KAAc,EAAE,EAAE;QAC9B,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,MAAM,CAAC,MAAM;YAAE,MAAM,IAAI,WAAW,CAAC,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC,MAAM,CAAC;IACzB,CAAC,CAAC;IACF,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC;IAC1B,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AAExC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AAExC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,6BAA6B,CAAC"}

package/esm/src/schemas/subscriptions/requests.d.ts

@@ -0,0 +1,332 @@
+import * as v from "valibot";
+/**
+ * Subscription to context events for a specific perpetual asset.
+ * @returns {WsActiveAssetCtx | WsActiveSpotAssetCtx}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsActiveAssetCtxRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"activeAssetCtx", undefined>, v.DescriptionAction<"activeAssetCtx", "Type of subscription.">]>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "activeAssetCtx";
+    coin: string;
+}, "Subscription to context events for a specific perpetual asset.">]>;
+export type WsActiveAssetCtxRequest = v.InferOutput<typeof WsActiveAssetCtxRequest>;
+/**
+ * Subscription to active asset data events for a specific user and coin.
+ * @returns {ActiveAssetData}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-active-asset-data
+ */
+export declare const WsActiveAssetDataRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"activeAssetData", undefined>, v.DescriptionAction<"activeAssetData", "Type of subscription.">]>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "activeAssetData";
+    coin: string;
+    user: `0x${string}`;
+}, "Subscription to active asset data events for a specific user and coin.">]>;
+export type WsActiveAssetDataRequest = v.InferOutput<typeof WsActiveAssetDataRequest>;
+/**
+ * Subscription to mid price events for all coins.
+ * @returns {AllMids}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
+ */
+export declare const WsAllMidsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"allMids", undefined>, v.DescriptionAction<"allMids", "Type of subscription.">]>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "allMids";
+    dex?: string | undefined;
+}, "Subscription to mid price events for all coins.">]>;
+export type WsAllMidsRequest = v.InferOutput<typeof WsAllMidsRequest>;
+/**
+ * Subscription to context events for all perpetual assets.
+ * @returns {WsAssetCtx[]}
+ * @see null
+ */
+export declare const WsAssetCtxsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"assetCtxs", undefined>, v.DescriptionAction<"assetCtxs", "Type of subscription.">]>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "assetCtxs";
+    dex?: string | undefined;
+}, "Subscription to context events for all perpetual assets.">]>;
+export type WsAssetCtxsRequest = v.InferOutput<typeof WsAssetCtxsRequest>;
+/**
+ * Subscription to best bid and offer events for a specific asset.
+ * @returns {WsBbo}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsBboRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"bbo", undefined>, v.DescriptionAction<"bbo", "Type of subscription.">]>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "bbo";
+    coin: string;
+}, "Subscription to best bid and offer events for a specific asset.">]>;
+export type WsBboRequest = v.InferOutput<typeof WsBboRequest>;
+/**
+ * Subscription to candlestick events for a specific asset and time interval.
+ * @returns {Candle}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsCandleRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"candle", undefined>, v.DescriptionAction<"candle", "Type of subscription.">]>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+    /** Time interval. */
+    readonly interval: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"1m", undefined>, v.LiteralSchema<"3m", undefined>, v.LiteralSchema<"5m", undefined>, v.LiteralSchema<"15m", undefined>, v.LiteralSchema<"30m", undefined>, v.LiteralSchema<"1h", undefined>, v.LiteralSchema<"2h", undefined>, v.LiteralSchema<"4h", undefined>, v.LiteralSchema<"8h", undefined>, v.LiteralSchema<"12h", undefined>, v.LiteralSchema<"1d", undefined>, v.LiteralSchema<"3d", undefined>, v.LiteralSchema<"1w", undefined>, v.LiteralSchema<"1M", undefined>], undefined>, v.DescriptionAction<"1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M", "Time interval.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "candle";
+    coin: string;
+    interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M";
+}, "Subscription to candlestick events for a specific asset and time interval.">]>;
+export type WsCandleRequest = v.InferOutput<typeof WsCandleRequest>;
+/**
+ * Subscription to clearinghouse state events for a specific user.
+ * @returns {PerpsClearinghouseState}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
+ */
+export declare const WsClearinghouseStateRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"clearinghouseState", undefined>, v.DescriptionAction<"clearinghouseState", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "clearinghouseState";
+    user: `0x${string}`;
+    dex?: string | undefined;
+}, "Subscription to clearinghouse state events for a specific user.">]>;
+export type WsClearinghouseStateRequest = v.InferOutput<typeof WsClearinghouseStateRequest>;
+/**
+ * Subscription to L2 order book events for a specific asset.
+ * @returns {Book}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
+ */
+export declare const WsL2BookRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"l2Book", undefined>, v.DescriptionAction<"l2Book", "Type of subscription.">]>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+    /** Number of significant figures. */
+    readonly nSigFigs: v.SchemaWithPipe<readonly [v.NullishSchema<v.UnionSchema<[v.LiteralSchema<2, undefined>, v.LiteralSchema<3, undefined>, v.LiteralSchema<4, undefined>, v.LiteralSchema<5, undefined>], undefined>, undefined>, v.DescriptionAction<3 | 2 | 4 | 5 | null | undefined, "Number of significant figures.">]>;
+    /** Mantissa for aggregation (if `nSigFigs` is 5). */
+    readonly mantissa: v.SchemaWithPipe<readonly [v.NullishSchema<v.UnionSchema<[v.LiteralSchema<2, undefined>, v.LiteralSchema<5, undefined>], undefined>, undefined>, v.DescriptionAction<2 | 5 | null | undefined, "Mantissa for aggregation (if `nSigFigs` is 5).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "l2Book";
+    coin: string;
+    nSigFigs?: 3 | 2 | 4 | 5 | null | undefined;
+    mantissa?: 2 | 5 | null | undefined;
+}, "Subscription to L2 order book events for a specific asset.">]>;
+export type WsL2BookRequest = v.InferOutput<typeof WsL2BookRequest>;
+/**
+ * Subscription to explorer block events.
+ * @returns {WsBlockDetails[]}
+ * @see null
+ */
+export declare const WsExplorerBlockRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"explorerBlock", undefined>, v.DescriptionAction<"explorerBlock", "Type of subscription.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "explorerBlock";
+}, "Subscription to explorer block events.">]>;
+export type WsExplorerBlockRequest = v.InferOutput<typeof WsExplorerBlockRequest>;
+/**
+ * Subscription to explorer transaction events.
+ * @returns {TxDetails[]}
+ * @see null
+ */
+export declare const WsExplorerTxsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"explorerTxs", undefined>, v.DescriptionAction<"explorerTxs", "Type of subscription.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "explorerTxs";
+}, "Subscription to explorer transaction events.">]>;
+export type WsExplorerTxsRequest = v.InferOutput<typeof WsExplorerTxsRequest>;
+/**
+ * Subscription to notification events for a specific user.
+ * @returns {WsNotification}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsNotificationRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"notification", undefined>, v.DescriptionAction<"notification", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "notification";
+    user: `0x${string}`;
+}, "Subscription to notification events for a specific user.">]>;
+export type WsNotificationRequest = v.InferOutput<typeof WsNotificationRequest>;
+/**
+ * Subscription to open order events for a specific user.
+ * @returns {Order[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
+ */
+export declare const WsOpenOrdersRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"openOrders", undefined>, v.DescriptionAction<"openOrders", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "openOrders";
+    user: `0x${string}`;
+    dex?: string | undefined;
+}, "Subscription to open order events for a specific user.">]>;
+export type WsOpenOrdersRequest = v.InferOutput<typeof WsOpenOrdersRequest>;
+/**
+ * Subscription to order updates for a specific user.
+ * @returns {OrderStatus>[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsOrderUpdatesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"orderUpdates", undefined>, v.DescriptionAction<"orderUpdates", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "orderUpdates";
+    user: `0x${string}`;
+}, "Subscription to order updates for a specific user.">]>;
+export type WsOrderUpdatesRequest = v.InferOutput<typeof WsOrderUpdatesRequest>;
+/**
+ * Subscription to trade events for a specific asset.
+ * @returns {WsTrade[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsTradesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"trades", undefined>, v.DescriptionAction<"trades", "Type of subscription.">]>;
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "trades";
+    coin: string;
+}, "Subscription to trade events for a specific asset.">]>;
+export type WsTradesRequest = v.InferOutput<typeof WsTradesRequest>;
+/**
+ * Subscription to user events for a specific user.
+ * @returns {WsUserEvent}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsUserEventsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userEvents", undefined>, v.DescriptionAction<"userEvents", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "userEvents";
+    user: `0x${string}`;
+}, "Subscription to user events for a specific user.">]>;
+export type WsUserEventsRequest = v.InferOutput<typeof WsUserEventsRequest>;
+/**
+ * Subscription to user fill events for a specific user.
+ * @returns {Fill[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
+ */
+export declare const WsUserFillsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFills", undefined>, v.DescriptionAction<"userFills", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+    /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
+    readonly aggregateByTime: v.SchemaWithPipe<readonly [v.OptionalSchema<v.BooleanSchema<undefined>, undefined>, v.DescriptionAction<boolean | undefined, "If true, partial fills are aggregated when a crossing order fills multiple resting orders.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "userFills";
+    user: `0x${string}`;
+    aggregateByTime?: boolean | undefined;
+}, "Subscription to user fill events for a specific user.">]>;
+export type WsUserFillsRequest = v.InferOutput<typeof WsUserFillsRequest>;
+/**
+ * Subscription to user funding events for a specific user.
+ * @returns {WsUserFundings}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsUserFundingsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFundings", undefined>, v.DescriptionAction<"userFundings", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "userFundings";
+    user: `0x${string}`;
+}, "Subscription to user funding events for a specific user.">]>;
+export type WsUserFundingsRequest = v.InferOutput<typeof WsUserFundingsRequest>;
+/**
+ * Subscription to user non-funding ledger updates for a specific user.
+ * @returns {WsUserNonFundingLedgerUpdates}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsUserNonFundingLedgerUpdatesRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userNonFundingLedgerUpdates", undefined>, v.DescriptionAction<"userNonFundingLedgerUpdates", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "userNonFundingLedgerUpdates";
+    user: `0x${string}`;
+}, "Subscription to user non-funding ledger updates for a specific user.">]>;
+export type WsUserNonFundingLedgerUpdatesRequest = v.InferOutput<typeof WsUserNonFundingLedgerUpdatesRequest>;
+/**
+ * Subscription to user TWAP history events for a specific user.
+ * @returns {WsUserTwapHistory}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsUserTwapHistoryRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userTwapHistory", undefined>, v.DescriptionAction<"userTwapHistory", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "userTwapHistory";
+    user: `0x${string}`;
+}, "Subscription to user TWAP history events for a specific user.">]>;
+export type WsUserTwapHistoryRequest = v.InferOutput<typeof WsUserTwapHistoryRequest>;
+/**
+ * Subscription to user TWAP slice fill events for a specific user.
+ * @returns {TwapSliceFill[]}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
+ */
+export declare const WsUserTwapSliceFillsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userTwapSliceFills", undefined>, v.DescriptionAction<"userTwapSliceFills", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "userTwapSliceFills";
+    user: `0x${string}`;
+}, "Subscription to user TWAP slice fill events for a specific user.">]>;
+export type WsUserTwapSliceFillsRequest = v.InferOutput<typeof WsUserTwapSliceFillsRequest>;
+/**
+ * Subscription to comprehensive user and market data events.
+ * @returns {WsWebData2}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ */
+export declare const WsWebData2Request: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"webData2", undefined>, v.DescriptionAction<"webData2", "Type of subscription.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "webData2";
+    user: `0x${string}`;
+}, "Subscription to comprehensive user and market data events.">]>;
+export type WsWebData2Request = v.InferOutput<typeof WsWebData2Request>;
+//# sourceMappingURL=requests.d.ts.map

package/esm/src/schemas/subscriptions/requests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/src/schemas/subscriptions/requests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAG7B;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;IAE5B,4BAA4B;;IAK5B,gCAAgC;;;;;sEAOvC,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAEpF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;IAE7B,4BAA4B;;IAK5B,gCAAgC;;IAKhC,oBAAoB;;;;;;8EAO3B,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAEtF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;IAErB,4BAA4B;;IAK5B,4CAA4C;;;;;uDAOnD,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;IAEvB,4BAA4B;;IAK5B,4CAA4C;;;;;gEAOnD,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,YAAY;IAEjB,4BAA4B;;IAK5B,gCAAgC;;;;;uEAOvC,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,YAAY,CAAC,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,eAAe;IAEpB,4BAA4B;;IAK5B,gCAAgC;;IAKhC,qBAAqB;;;;;;kFAsB5B,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;IAEhC,4BAA4B;;IAK5B,oBAAoB;;IAKpB,4CAA4C;;;;;;uEAOnD,CAAC;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAE5F;;;;GAIG;AACH,eAAO,MAAM,eAAe;IAEpB,4BAA4B;;IAK5B,gCAAgC;;IAKhC,qCAAqC;;IAKrC,qDAAqD;;;;;;;kEAO5D,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,sBAAsB;IAE3B,4BAA4B;;;;8CAOnC,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAElF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;IAEzB,4BAA4B;;;;oDAOnC,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE9E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;IAE1B,4BAA4B;;IAK5B,oBAAoB;;;;;gEAO3B,CAAC;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEhF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;IAExB,4BAA4B;;IAK5B,oBAAoB;;IAKpB,4CAA4C;;;;;;8DAOnD,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;IAE1B,4BAA4B;;IAK5B,oBAAoB;;;;;0DAO3B,CAAC;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEhF;;;;GAIG;AACH,eAAO,MAAM,eAAe;IAEpB,4BAA4B;;IAK5B,gCAAgC;;;;;0DAOvC,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;IAExB,4BAA4B;;IAK5B,oBAAoB;;;;;wDAO3B,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;IAEvB,4BAA4B;;IAK5B,oBAAoB;;IAKpB,iGAAiG;;;;;;6DAOxG,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;IAE1B,4BAA4B;;IAK5B,oBAAoB;;;;;gEAO3B,CAAC;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEhF;;;;GAIG;AACH,eAAO,MAAM,oCAAoC;IAEzC,4BAA4B;;IAK5B,oBAAoB;;;;;4EAO3B,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oCAAoC,CAAC,CAAC;AAE9G;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;IAE7B,4BAA4B;;IAK5B,oBAAoB;;;;;qEAO3B,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAEtF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;IAEhC,4BAA4B;;IAK5B,oBAAoB;;;;;wEAO3B,CAAC;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAE5F;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;IAEtB,4BAA4B;;IAK5B,oBAAoB;;;;;kEAO3B,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC"}