@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/esm/src/api/subscription/orderUpdates.js

@@ -0,0 +1,121 @@
+import * as v from "valibot";
+import { Address, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/** Subscription to order updates for a specific user. */
+export const OrderUpdatesRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("orderUpdates"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Subscription to order updates for a specific user."));
+})();
+/** Event of array of orders with their current processing status. */
+export const OrderUpdatesEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.array(
+    /** Order with its current processing status. */
+    v.pipe(v.object({
+        /** Order details. */
+        order: v.pipe(v.object({
+            /** Asset symbol. */
+            coin: v.pipe(v.string(), v.description("Asset symbol.")),
+            /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+            side: v.pipe(v.union([v.literal("B"), v.literal("A")]), v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).')),
+            /** Limit price. */
+            limitPx: v.pipe(UnsignedDecimal, v.description("Limit price.")),
+            /** Size. */
+            sz: v.pipe(UnsignedDecimal, v.description("Size.")),
+            /** Order ID. */
+            oid: v.pipe(UnsignedInteger, v.description("Order ID.")),
+            /** Timestamp when the order was placed (in ms since epoch). */
+            timestamp: v.pipe(UnsignedInteger, v.description("Timestamp when the order was placed (in ms since epoch).")),
+            /** Original size at order placement. */
+            origSz: v.pipe(UnsignedDecimal, v.description("Original size at order placement.")),
+            /** Indicates whether the order is reduce-only. */
+            reduceOnly: v.pipe(v.optional(v.literal(true)), v.description("Indicates whether the order is reduce-only.")),
+            /** Client Order ID. */
+            cloid: v.pipe(v.optional(v.pipe(Hex, v.length(34))), v.description("Client Order ID.")),
+        }), v.description("Order details.")),
+        /**
+         * 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).
+         */
+        status: v.pipe(v.union([
+            v.literal("open"),
+            v.literal("filled"),
+            v.literal("canceled"),
+            v.literal("triggered"),
+            v.literal("rejected"),
+            v.literal("marginCanceled"),
+            v.literal("vaultWithdrawalCanceled"),
+            v.literal("openInterestCapCanceled"),
+            v.literal("selfTradeCanceled"),
+            v.literal("reduceOnlyCanceled"),
+            v.literal("siblingFilledCanceled"),
+            v.literal("delistedCanceled"),
+            v.literal("liquidatedCanceled"),
+            v.literal("scheduledCancel"),
+            v.literal("reduceOnlyRejected"),
+        ]), 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).')),
+        /** 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("Order with its current processing status."))), v.description("Event of array of orders with their current processing status."));
+})();
+/**
+ * Subscribe to order status 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 { orderUpdates } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await orderUpdates(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export function orderUpdates(config, params, listener) {
+    const payload = parser(OrderUpdatesRequest)({ type: "orderUpdates", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        listener(e.detail);
+    });
+}
+//# sourceMappingURL=orderUpdates.js.map

package/esm/src/api/subscription/orderUpdates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orderUpdates.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/orderUpdates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAI3G,oDAAoD;AAEpD,yDAAyD;AACzD,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oDAAoD,CAAC,CACpE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACrD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,gDAAgD;IAChD,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,qBAAqB;QACrB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;YACP,oBAAoB;YACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,kDAAkD;YAClD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EACzC,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;YACD,mBAAmB;YACnB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;YACD,YAAY;YACZ,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CACvB;YACD,gBAAgB;YAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;YACD,+DAA+D;YAC/D,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,0DAA0D,CAAC,CAC1E;YACD,wCAAwC;YACxC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD;YACD,kDAAkD;YAClD,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;YACD,uBAAuB;YACvB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EACrC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;QACD;;;;;;;;;;;;;;;;WAgBG;QACH,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC;YACN,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;YACjB,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;YACnB,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;YACrB,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;YACtB,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;YACrB,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;YAC3B,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC;YACpC,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC;YACpC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;YAC9B,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;YAC/B,CAAC,CAAC,OAAO,CAAC,uBAAuB,CAAC;YAClC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YAC7B,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;YAC/B,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;YAC5B,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;SAChC,CAAC,EACF,CAAC,CAAC,WAAW,CACX,0BAA0B;YACxB,uDAAuD;YACvD,wCAAwC;YACxC,gDAAgD;YAChD,6DAA6D;YAC7D,kDAAkD;YAClD,qEAAqE;YACrE,iFAAiF;YACjF,6GAA6G;YAC7G,oEAAoE;YACpE,yFAAyF;YACzF,gFAAgF;YAChF,6DAA6D;YAC7D,2DAA2D;YAC3D,oGAAoG,CACvG,CACF;QACD,sEAAsE;QACtE,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iEAAiE,CAAC,CACjF;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D,CACF,EACD,CAAC,CAAC,WAAW,CAAC,gEAAgE,CAAC,CAChF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAiC,EACjC,MAA6C,EAC7C,QAA2C;IAE3C,MAAM,OAAO,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACjF,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAoB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAChF,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/esm/src/api/subscription/trades.d.ts

@@ -0,0 +1,81 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { SubscriptionRequestConfig } from "./_common.js";
+import type { Subscription } from "../../transport/base.js";
+/** Subscription to trade events for a specific asset. */
+export declare const TradesRequest: 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 TradesRequest = v.InferOutput<typeof TradesRequest>;
+/** Event of array of trades for a specific asset. */
+export declare const TradesEvent: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Asset symbol (e.g., BTC). */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
+    /** Trade side ("B" = Bid/Buy, "A" = Ask/Sell). */
+    readonly side: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"B", undefined>, v.LiteralSchema<"A", undefined>], undefined>, v.DescriptionAction<"B" | "A", "Trade side (\"B\" = Bid/Buy, \"A\" = Ask/Sell).">]>;
+    /** Trade price. */
+    readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Trade price.">]>;
+    /** Trade size. */
+    readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Trade size.">]>;
+    /** Trade timestamp (in ms since epoch). */
+    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Trade timestamp (in ms since epoch).">]>;
+    /** Transaction hash. */
+    readonly hash: 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}`, 66, undefined>]>, v.DescriptionAction<`0x${string}`, "Transaction hash.">]>;
+    /** Trade ID. */
+    readonly tid: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Trade ID.">]>;
+    /** Addresses of users involved in the trade [Maker, Taker]. */
+    readonly users: v.SchemaWithPipe<readonly [v.TupleSchema<[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.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>], undefined>, v.DescriptionAction<[`0x${string}`, `0x${string}`], "Addresses of users involved in the trade [Maker, Taker].">]>;
+}, undefined>, v.DescriptionAction<{
+    coin: string;
+    side: "B" | "A";
+    px: string;
+    sz: string;
+    time: number;
+    hash: `0x${string}`;
+    tid: number;
+    users: [`0x${string}`, `0x${string}`];
+}, "Trade for a specific asset.">]>, undefined>, v.DescriptionAction<{
+    coin: string;
+    side: "B" | "A";
+    px: string;
+    sz: string;
+    time: number;
+    hash: `0x${string}`;
+    tid: number;
+    users: [`0x${string}`, `0x${string}`];
+}[], "Event of array of trades for a specific asset.">]>;
+export type TradesEvent = v.InferOutput<typeof TradesEvent>;
+/** 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 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 { trades } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await trades(
+ *   { transport },
+ *   { coin: "ETH" },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function trades(config: SubscriptionRequestConfig, params: DeepImmutable<TradesParameters>, listener: (data: TradesEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=trades.d.ts.map

package/esm/src/api/subscription/trades.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trades.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/trades.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAAiD,MAAM,eAAe,CAAC;AAC3G,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,yDAAyD;AACzD,eAAO,MAAM,aAAa;IAGpB,4BAA4B;;IAK5B,gCAAgC;;;;;0DAQlC,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAEhE,qDAAqD;AACrD,eAAO,MAAM,WAAW;IAMd,gCAAgC;;IAKhC,kDAAkD;;IAKlD,mBAAmB;;IAKnB,kBAAkB;;IAKlB,2CAA2C;;IAK3C,wBAAwB;;IAKxB,gBAAgB;;IAKhB,+DAA+D;;;;;;;;;;;;;;;;;;;;wDAWrE,CAAC;AACL,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,WAAW,CAAC,CAAC;AAI5D,8DAA8D;AAC9D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,MAAM,CACpB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,gBAAgB,CAAC,EACvC,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,YAAY,CAAC,CAOvB"}

package/esm/src/api/subscription/trades.js

@@ -0,0 +1,68 @@
+import * as v from "valibot";
+import { Address, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/** 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."));
+})();
+/** Event of array of trades for a specific asset. */
+export const TradesEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.array(
+    /** Trade for a specific asset. */
+    v.pipe(v.object({
+        /** Asset symbol (e.g., BTC). */
+        coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+        /** Trade side ("B" = Bid/Buy, "A" = Ask/Sell). */
+        side: v.pipe(v.union([v.literal("B"), v.literal("A")]), v.description('Trade side ("B" = Bid/Buy, "A" = Ask/Sell).')),
+        /** Trade price. */
+        px: v.pipe(UnsignedDecimal, v.description("Trade price.")),
+        /** Trade size. */
+        sz: v.pipe(UnsignedDecimal, v.description("Trade size.")),
+        /** Trade timestamp (in ms since epoch). */
+        time: v.pipe(UnsignedInteger, v.description("Trade timestamp (in ms since epoch).")),
+        /** Transaction hash. */
+        hash: v.pipe(v.pipe(Hex, v.length(66)), v.description("Transaction hash.")),
+        /** Trade ID. */
+        tid: v.pipe(UnsignedInteger, v.description("Trade ID.")),
+        /** Addresses of users involved in the trade [Maker, Taker]. */
+        users: v.pipe(v.tuple([Address, Address]), v.description("Addresses of users involved in the trade [Maker, Taker].")),
+    }), v.description("Trade for a specific asset."))), v.description("Event of array of trades for a specific asset."));
+})();
+/**
+ * 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 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 { trades } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await trades(
+ *   { transport },
+ *   { coin: "ETH" },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export function trades(config, params, listener) {
+    const payload = parser(TradesRequest)({ type: "trades", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail[0]?.coin === payload.coin) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=trades.js.map

package/esm/src/api/subscription/trades.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trades.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/trades.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAI3G,oDAAoD;AAEpD,yDAAyD;AACzD,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACjD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oDAAoD,CAAC,CACpE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,qDAAqD;AACrD,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC/C,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,kCAAkC;IAClC,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,kDAAkD;QAClD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EACzC,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;QACD,mBAAmB;QACnB,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;QACD,kBAAkB;QAClB,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,2CAA2C;QAC3C,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;QACD,wBAAwB;QACxB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;QACD,gBAAgB;QAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;QACD,+DAA+D;QAC/D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,0DAA0D,CAAC,CAC1E;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C,CACF,EACD,CAAC,CAAC,WAAW,CAAC,gDAAgD,CAAC,CAChE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,MAAM,CACpB,MAAiC,EACjC,MAAuC,EACvC,QAAqC;IAErC,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACrE,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAc,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC1E,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC;YACvC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}