@nktkas/hyperliquid 0.25.8 → 0.26.0

package/dist/src/api/subscription/userEvents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userEvents.d.ts","sourceRoot":"","sources":["../../../../src/api/subscription/userEvents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAoB,KAAK,aAAa,EAA4C,MAAM,aAAa,CAAC;AAC7G,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAM5D,uDAAuD;AACvD,eAAO,MAAM,iBAAiB;IAGxB,4BAA4B;;IAK5B,oBAAoB;;;;;wDAQtB,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAExE,0CAA0C;AAC1C,eAAO,MAAM,SAAS;IAGhB,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2CAQnC,CAAC;AACL,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,SAAS,CAAC,CAAC;AAExD,oCAAoC;AACpC,eAAO,MAAM,YAAY;IAGnB,8BAA8B;;QAG1B,oBAAoB;;QAKpB,kCAAkC;;QAKlC,4BAA4B;;QAK5B,4BAA4B;;QAK5B,yBAAyB;;;;;;;;;;;;;;;;;qCAW/B,CAAC;AACL,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,YAAY,CAAC,CAAC;AAE9D,iCAAiC;AACjC,eAAO,MAAM,gBAAgB;IAGvB,2BAA2B;;QAGvB,6BAA6B;;QAK7B,iCAAiC;;QAKjC,sCAAsC;;QAKtC,kDAAkD;;QAKlD,4CAA4C;;;;;;;;;;;;;;;;;kCAWlD,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE,gEAAgE;AAChE,eAAO,MAAM,kBAAkB;IAGzB,uDAAuD;;QAM/C,gCAAgC;;QAKhC,gBAAgB;;;;;;;;;;;;;;iEAc1B,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E,qCAAqC;AACrC,eAAO,MAAM,gBAAgB;IAGvB,oCAAoC;;QAM5B,oEAAoE;;QAKpE,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;QAE/B,wCAAwC;;;;;;;;;;;;QAExC,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sCAczB,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE,iCAAiC;AACjC,eAAO,MAAM,mBAAmB;IAG1B,iCAAiC;;QAI3B,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAEvC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAY9B,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E,4CAA4C;AAC5C,eAAO,MAAM,eAAe;IA3LtB,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAejC,8BAA8B;;QAG1B,oBAAoB;;QAKpB,kCAAkC;;QAKlC,4BAA4B;;QAK5B,4BAA4B;;QAK5B,yBAAyB;;;;;;;;;;;;;;;;;;IAkB7B,2BAA2B;;QAGvB,6BAA6B;;QAK7B,iCAAiC;;QAKjC,sCAAsC;;QAKtC,kDAAkD;;QAKlD,4CAA4C;;;;;;;;;;;;;;;;;;IAkBhD,uDAAuD;;QAM/C,gCAAgC;;QAKhC,gBAAgB;;;;;;;;;;;;;;;IAqBxB,oCAAoC;;QAM5B,oEAAoE;;QAKpE,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;QAE/B,wCAAwC;;;;;;;;;;;;QAExC,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAqBvB,iCAAiC;;QAI3B,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAEvC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6CA4B9B,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAIpE,kEAAkE;AAClE,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC;AAExF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,oBAAoB,CAAC,EAC3C,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,GACxC,OAAO,CAAC,YAAY,CAAC,CAKvB"}

package/dist/src/api/subscription/userEvents.js

@@ -0,0 +1,143 @@
+import * as v from "valibot";
+import { Address, Decimal, parser, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import { FillSchema, TwapFillSchema, TwapStateSchema, TwapStatusSchema } from "../_common_schemas.js";
+// -------------------- Schemas --------------------
+/** Subscription to user events for a specific user. */
+export const UserEventsRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("userEvents"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Subscription to user events for a specific user."));
+})();
+/** Event of array of user trade fills. */
+export const FillEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Array of user trade fills. */
+        fills: v.pipe(v.array(FillSchema), v.description("Array of user trade fills.")),
+    }), v.description("Event of array of user trade fills."));
+})();
+/** Event of user funding update. */
+export const FundingEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Funding update details. */
+        funding: v.pipe(v.object({
+            /** Asset symbol. */
+            coin: v.pipe(v.string(), v.description("Asset symbol.")),
+            /** Amount transferred in USDC. */
+            usdc: v.pipe(Decimal, v.description("Amount transferred in USDC.")),
+            /** Signed position size. */
+            szi: v.pipe(Decimal, v.description("Signed position size.")),
+            /** Applied funding rate. */
+            fundingRate: v.pipe(Decimal, v.description("Applied funding rate.")),
+            /** Number of samples. */
+            nSamples: v.pipe(v.nullable(UnsignedInteger), v.description("Number of samples.")),
+        }), v.description("Funding update details.")),
+    }), v.description("Event of user funding update."));
+})();
+/** Event of user liquidation. */
+export const LiquidationEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Liquidation details. */
+        liquidation: v.pipe(v.object({
+            /** Unique liquidation ID. */
+            lid: v.pipe(UnsignedInteger, v.description("Unique liquidation ID.")),
+            /** Address of the liquidator. */
+            liquidator: v.pipe(Address, v.description("Address of the liquidator.")),
+            /** Address of the liquidated user. */
+            liquidated_user: v.pipe(Address, v.description("Address of the liquidated user.")),
+            /** Notional position size that was liquidated. */
+            liquidated_ntl_pos: v.pipe(UnsignedDecimal, v.description("Notional position size that was liquidated.")),
+            /** Account value at time of liquidation. */
+            liquidated_account_value: v.pipe(UnsignedDecimal, v.description("Account value at time of liquidation.")),
+        }), v.description("Liquidation details.")),
+    }), v.description("Event of user liquidation."));
+})();
+/** Event of array of non-user initiated order cancellations. */
+export const NonUserCancelEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Array of non-user initiated order cancellations. */
+        nonUserCancel: v.pipe(v.array(
+        /** Cancelled order not initiated by the user. */
+        v.pipe(v.object({
+            /** Asset symbol (e.g., BTC). */
+            coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+            /** Order ID. */
+            oid: v.pipe(UnsignedInteger, v.description("Order ID.")),
+        }), v.description("Cancelled order not initiated by the user."))), v.description("Array of non-user initiated order cancellations.")),
+    }), v.description("Event of array of non-user initiated order cancellations."));
+})();
+/** Event of a TWAP history entry. */
+export const TwapHistoryEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Array of user's TWAP history. */
+        twapHistory: 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,
+            /** TWAP ID. */
+            twapId: v.pipe(UnsignedInteger, v.description("TWAP ID.")),
+        }), v.description("TWAP history record."))), v.description("Array of user's TWAP history.")),
+    }), v.description("Event of a TWAP history entry."));
+})();
+/** Event of TWAP slice fills. */
+export const TwapSliceFillsEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** 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.")),
+    }), v.description("Event of TWAP slice fills."));
+})();
+/** Event of one of possible user events. */
+export const UserEventsEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.union([
+        FillEvent,
+        FundingEvent,
+        LiquidationEvent,
+        NonUserCancelEvent,
+        TwapHistoryEvent,
+        TwapSliceFillsEvent,
+    ]), v.description("Event of one of possible user events."));
+})();
+/**
+ * Subscribe to non-order events for a specific user.
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ * @note Different subscriptions cannot be distinguished from each other.
+ *
+ * @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 { userEvents } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await userEvents(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export function userEvents(config, params, listener) {
+    const payload = parser(UserEventsRequest)({ type: "userEvents", ...params });
+    return config.transport.subscribe("user", payload, (e) => {
+        listener(e.detail);
+    });
+}
+//# sourceMappingURL=userEvents.js.map

package/dist/src/api/subscription/userEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userEvents.js","sourceRoot":"","sources":["../../../../src/api/subscription/userEvents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAI7G,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEtG,oDAAoD;AAEpD,uDAAuD;AACvD,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACrD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EACvB,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,kDAAkD,CAAC,CAClE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,0CAA0C;AAC1C,MAAM,CAAC,MAAM,SAAS,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC7C,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,iCAAiC;QACjC,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,oCAAoC;AACpC,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAChD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,8BAA8B;QAC9B,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,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,kCAAkC;YAClC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;YACD,4BAA4B;YAC5B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;YACD,4BAA4B;YAC5B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;YACD,yBAAyB;YACzB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,iCAAiC;AACjC,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,2BAA2B;QAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,MAAM,CAAC;YACP,6BAA6B;YAC7B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;YACD,iCAAiC;YACjC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;YACD,sCAAsC;YACtC,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;YACD,kDAAkD;YAClD,kBAAkB,EAAE,CAAC,CAAC,IAAI,CACxB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;YACD,4CAA4C;YAC5C,wBAAwB,EAAE,CAAC,CAAC,IAAI,CAC9B,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,gEAAgE;AAChE,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uDAAuD;QACvD,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,CAAC,CAAC,KAAK;QACL,iDAAiD;QACjD,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,gCAAgC;YAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;YACD,gBAAgB;YAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAC5D,CACF,EACD,CAAC,CAAC,WAAW,CAAC,kDAAkD,CAAC,CAClE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2DAA2D,CAAC,CAC3E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,qCAAqC;AACrC,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,oCAAoC;QACpC,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,KAAK;QACL,2BAA2B;QAC3B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,oEAAoE;YACpE,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,+DAA+D,CAAC,CAC/E;YACD,+BAA+B;YAC/B,KAAK,EAAE,eAAe;YACtB,wCAAwC;YACxC,MAAM,EAAE,gBAAgB;YACxB,eAAe;YACf,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,CAC1B;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,iCAAiC;AACjC,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,iCAAiC;QACjC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;YACP,uCAAuC;YACvC,IAAI,EAAE,cAAc;YACpB,sBAAsB;YACtB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;SACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,4CAA4C;AAC5C,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACnD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC;QACN,SAAS;QACT,YAAY;QACZ,gBAAgB;QAChB,kBAAkB;QAClB,gBAAgB;QAChB,mBAAmB;KACpB,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,UAAU,CACxB,MAAiC,EACjC,MAA2C,EAC3C,QAAyC;IAEzC,MAAM,OAAO,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC7E,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAkB,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACxE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/src/api/subscription/userFills.d.ts

@@ -0,0 +1,152 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_base.ts";
+import type { SubscriptionRequestConfig } from "./_types.ts";
+import type { Subscription } from "../../transport/base.ts";
+/** Subscription to user fill events for a specific user. */
+export declare const UserFillsRequest: 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 UserFillsRequest = v.InferOutput<typeof UserFillsRequest>;
+/** Event of user trade fill. */
+export declare const UserFillsEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** 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.">]>;
+    /** Array of user trade fills. */
+    readonly fills: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+        readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Price.">]>;
+        readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Size.">]>;
+        readonly side: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"B", undefined>, v.LiteralSchema<"A", undefined>], undefined>, v.DescriptionAction<"B" | "A", "Order side (\"B\" = Bid/Buy, \"A\" = Ask/Sell).">]>;
+        readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Timestamp when the trade occurred (in ms since epoch).">]>;
+        readonly startPosition: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Start position size.">]>;
+        readonly dir: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Direction indicator for frontend display.">]>;
+        readonly closedPnl: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Realized PnL.">]>;
+        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}`, "L1 transaction hash.">]>;
+        readonly oid: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Order ID.">]>;
+        readonly crossed: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the fill was a taker order.">]>;
+        readonly fee: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Fee charged or rebate received (negative indicates rebate).">]>;
+        readonly tid: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique transaction identifier for a partial fill of an order.">]>;
+        readonly cloid: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 34, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | undefined, "Client Order ID.">]>;
+        readonly liquidation: v.SchemaWithPipe<readonly [v.OptionalSchema<v.ObjectSchema<{
+            readonly liquidatedUser: 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}`, "Address of the liquidated user.">]>;
+            readonly markPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Mark price at the time of liquidation.">]>;
+            readonly method: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"market", undefined>, v.LiteralSchema<"backstop", undefined>], undefined>, v.DescriptionAction<"market" | "backstop", "Liquidation method.">]>;
+        }, undefined>, undefined>, v.DescriptionAction<{
+            liquidatedUser: `0x${string}`;
+            markPx: string;
+            method: "market" | "backstop";
+        } | undefined, "Liquidation details.">]>;
+        readonly feeToken: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Token in which the fee is denominated (e.g., \"USDC\").">]>;
+        readonly twapId: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null, "ID of the TWAP.">]>;
+    }, undefined>, v.DescriptionAction<{
+        coin: string;
+        px: string;
+        sz: string;
+        side: "B" | "A";
+        time: number;
+        startPosition: string;
+        dir: string;
+        closedPnl: string;
+        hash: `0x${string}`;
+        oid: number;
+        crossed: boolean;
+        fee: string;
+        tid: number;
+        cloid?: `0x${string}` | undefined;
+        liquidation?: {
+            liquidatedUser: `0x${string}`;
+            markPx: string;
+            method: "market" | "backstop";
+        } | undefined;
+        feeToken: string;
+        twapId: number | null;
+    }, "Order fill record.">]>, undefined>, v.DescriptionAction<{
+        coin: string;
+        px: string;
+        sz: string;
+        side: "B" | "A";
+        time: number;
+        startPosition: string;
+        dir: string;
+        closedPnl: string;
+        hash: `0x${string}`;
+        oid: number;
+        crossed: boolean;
+        fee: string;
+        tid: number;
+        cloid?: `0x${string}` | undefined;
+        liquidation?: {
+            liquidatedUser: `0x${string}`;
+            markPx: string;
+            method: "market" | "backstop";
+        } | undefined;
+        feeToken: string;
+        twapId: number | null;
+    }[], "Array of user trade fills.">]>;
+    /** Whether this is an initial snapshot. */
+    readonly isSnapshot: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Whether this is an initial snapshot.">]>;
+}, undefined>, v.DescriptionAction<{
+    user: `0x${string}`;
+    fills: {
+        coin: string;
+        px: string;
+        sz: string;
+        side: "B" | "A";
+        time: number;
+        startPosition: string;
+        dir: string;
+        closedPnl: string;
+        hash: `0x${string}`;
+        oid: number;
+        crossed: boolean;
+        fee: string;
+        tid: number;
+        cloid?: `0x${string}` | undefined;
+        liquidation?: {
+            liquidatedUser: `0x${string}`;
+            markPx: string;
+            method: "market" | "backstop";
+        } | undefined;
+        feeToken: string;
+        twapId: number | null;
+    }[];
+    isSnapshot?: true | undefined;
+}, "Event of user trade fill.">]>;
+export type UserFillsEvent = v.InferOutput<typeof UserFillsEvent>;
+/** Request parameters for the {@linkcode userFills} function. */
+export type UserFillsParameters = Omit<v.InferInput<typeof UserFillsRequest>, "type">;
+/**
+ * Subscribe to trade fill updates for a specific user.
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ * @returns A request-promise that resolves with a {@link 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 { userFills } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await userFills(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function userFills(config: SubscriptionRequestConfig, params: DeepImmutable<UserFillsParameters>, listener: (data: UserFillsEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=userFills.d.ts.map

package/dist/src/api/subscription/userFills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userFills.d.ts","sourceRoot":"","sources":["../../../../src/api/subscription/userFills.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AAClE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAM5D,4DAA4D;AAC5D,eAAO,MAAM,gBAAgB;IAGvB,4BAA4B;;IAK5B,oBAAoB;;IAKpB,iGAAiG;;;;;;6DAQnG,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE,gCAAgC;AAChC,eAAO,MAAM,cAAc;IAGrB,oBAAoB;;IAKpB,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAKjC,2CAA2C;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAQ7C,CAAC;AACL,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC,CAAC;AAIlE,iEAAiE;AACjE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,mBAAmB,CAAC,EAC1C,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GACvC,OAAO,CAAC,YAAY,CAAC,CAWvB"}

package/dist/src/api/subscription/userFills.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userFills.js","sourceRoot":"","sources":["../../../../src/api/subscription/userFills.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,MAAM,aAAa,CAAC;AAIlE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,oDAAoD;AAEpD,4DAA4D;AAC5D,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EACtB,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;QACD,iGAAiG;QACjG,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EACvB,CAAC,CAAC,WAAW,CAAC,4FAA4F,CAAC,CAC5G;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,uDAAuD,CAAC,CACvE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,gCAAgC;AAChC,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,iCAAiC;QACjC,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;QACD,2CAA2C;QAC3C,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,SAAS,CACvB,MAAiC,EACjC,MAA0C,EAC1C,QAAwC;IAExC,MAAM,OAAO,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACvC,IAAI,EAAE,WAAW;QACjB,GAAG,MAAM;QACT,eAAe,EAAE,MAAM,CAAC,eAAe,IAAI,KAAK;KACjD,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAiB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC7E,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC;YACnC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/src/api/subscription/userFundings.d.ts

@@ -0,0 +1,91 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_base.ts";
+import type { SubscriptionRequestConfig } from "./_types.ts";
+import type { Subscription } from "../../transport/base.ts";
+/** Subscription to user funding events for a specific user. */
+export declare const UserFundingsRequest: 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 UserFundingsRequest = v.InferOutput<typeof UserFundingsRequest>;
+/** Event of user fundings. */
+export declare const UserFundingsEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** 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.">]>;
+    /** Array of funding events. */
+    readonly fundings: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Timestamp of the update (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.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Timestamp of the update (in ms since epoch).">]>;
+        /** Asset symbol. */
+        readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+        /** Amount transferred in USDC. */
+        readonly usdc: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Amount transferred in USDC.">]>;
+        /** Signed position size. */
+        readonly szi: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Signed position size.">]>;
+        /** Applied funding rate. */
+        readonly fundingRate: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Applied funding rate.">]>;
+        /** Number of samples. */
+        readonly nSamples: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null, "Number of samples.">]>;
+    }, undefined>, v.DescriptionAction<{
+        time: number;
+        coin: string;
+        usdc: string;
+        szi: string;
+        fundingRate: string;
+        nSamples: number | null;
+    }, "Funding event.">]>, undefined>, v.DescriptionAction<{
+        time: number;
+        coin: string;
+        usdc: string;
+        szi: string;
+        fundingRate: string;
+        nSamples: number | null;
+    }[], "Array of funding events.">]>;
+    /** Whether this is an initial snapshot. */
+    readonly isSnapshot: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Whether this is an initial snapshot.">]>;
+}, undefined>, v.DescriptionAction<{
+    user: `0x${string}`;
+    fundings: {
+        time: number;
+        coin: string;
+        usdc: string;
+        szi: string;
+        fundingRate: string;
+        nSamples: number | null;
+    }[];
+    isSnapshot?: true | undefined;
+}, "Event of user fundings.">]>;
+export type UserFundingsEvent = v.InferOutput<typeof UserFundingsEvent>;
+/** Request parameters for the {@linkcode userFundings} function. */
+export type UserFundingsParameters = Omit<v.InferInput<typeof UserFundingsRequest>, "type">;
+/**
+ * Subscribe to funding payment 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 { userFundings } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await userFundings(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function userFundings(config: SubscriptionRequestConfig, params: DeepImmutable<UserFundingsParameters>, listener: (data: UserFundingsEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=userFundings.d.ts.map

package/dist/src/api/subscription/userFundings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userFundings.d.ts","sourceRoot":"","sources":["../../../../src/api/subscription/userFundings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAoB,KAAK,aAAa,EAA2B,MAAM,aAAa,CAAC;AAC5F,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,+DAA+D;AAC/D,eAAO,MAAM,mBAAmB;IAG1B,4BAA4B;;IAK5B,oBAAoB;;;;;gEAQtB,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E,8BAA8B;AAC9B,eAAO,MAAM,iBAAiB;IAGxB,oBAAoB;;IAKpB,+BAA+B;;QAMvB,mDAAmD;;QAKnD,oBAAoB;;QAKpB,kCAAkC;;QAKlC,4BAA4B;;QAK5B,4BAA4B;;QAK5B,yBAAyB;;;;;;;;;;;;;;;;;IAWjC,2CAA2C;;;;;;;;;;;;;+BAQ7C,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAIxE,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,mBAAmB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,sBAAsB,CAAC,EAC7C,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAC1C,OAAO,CAAC,YAAY,CAAC,CAOvB"}

package/dist/src/api/subscription/userFundings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userFundings.js","sourceRoot":"","sources":["../../../../src/api/subscription/userFundings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAI5F,oDAAoD;AAEpD,+DAA+D;AAC/D,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,0DAA0D,CAAC,CAC1E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,8BAA8B;AAC9B,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACrD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,+BAA+B;QAC/B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,KAAK;QACL,qBAAqB;QACrB,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,mDAAmD;YACnD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAC9D;YACD,oBAAoB;YACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,kCAAkC;YAClC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;YACD,4BAA4B;YAC5B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;YACD,4BAA4B;YAC5B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;YACD,yBAAyB;YACzB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,2CAA2C;QAC3C,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC,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,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC;YACnC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/src/api/subscription/userHistoricalOrders.d.ts

@@ -0,0 +1,161 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_base.ts";
+import type { SubscriptionRequestConfig } from "./_types.ts";
+import type { Subscription } from "../../transport/base.ts";
+/** Subscription to user historical orders for a specific user. */
+export declare const UserHistoricalOrdersRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of subscription. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userHistoricalOrders", undefined>, v.DescriptionAction<"userHistoricalOrders", "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: "userHistoricalOrders";
+    user: `0x${string}`;
+}, "Subscription to user historical orders for a specific user.">]>;
+export type UserHistoricalOrdersRequest = v.InferOutput<typeof UserHistoricalOrdersRequest>;
+/** Event of user historical orders. */
+export declare const UserHistoricalOrdersEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** 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.">]>;
+    /** Array of frontend orders with current processing status. */
+    readonly orderHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Order details. */
+        readonly order: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+            readonly side: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"B", undefined>, v.LiteralSchema<"A", undefined>], undefined>, v.DescriptionAction<"B" | "A", "Order side (\"B\" = Bid/Buy, \"A\" = Ask/Sell).">]>;
+            readonly limitPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Limit price.">]>;
+            readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Size.">]>;
+            readonly oid: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Order ID.">]>;
+            readonly timestamp: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Timestamp when the order was placed (in ms since epoch).">]>;
+            readonly origSz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Original size at order placement.">]>;
+            readonly triggerCondition: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Condition for triggering the order.">]>;
+            readonly isTrigger: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the order is a trigger order.">]>;
+            readonly triggerPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Trigger price.">]>;
+            readonly children: v.SchemaWithPipe<readonly [v.ArraySchema<v.LazySchema<any>, undefined>, v.DescriptionAction<any[], "Child orders associated with this order.">]>;
+            readonly isPositionTpsl: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the order is a position TP/SL order.">]>;
+            readonly reduceOnly: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates whether the order is reduce-only.">]>;
+            readonly orderType: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"Market", undefined>, v.LiteralSchema<"Limit", undefined>, v.LiteralSchema<"Stop Market", undefined>, v.LiteralSchema<"Stop Limit", undefined>, v.LiteralSchema<"Take Profit Market", undefined>, v.LiteralSchema<"Take Profit Limit", undefined>], undefined>, v.DescriptionAction<"Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit", string>]>;
+            readonly tif: v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"Gtc", undefined>, v.LiteralSchema<"Ioc", undefined>, v.LiteralSchema<"Alo", undefined>, v.LiteralSchema<"FrontendMarket", undefined>, v.LiteralSchema<"LiquidationMarket", undefined>], undefined>, v.DescriptionAction<"Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket", string>]>, undefined>;
+            readonly cloid: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 34, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | null, "Client Order ID.">]>;
+        }, undefined>, v.DescriptionAction<{
+            coin: string;
+            side: "B" | "A";
+            limitPx: string;
+            sz: string;
+            oid: number;
+            timestamp: number;
+            origSz: string;
+            triggerCondition: string;
+            isTrigger: boolean;
+            triggerPx: string;
+            children: any[];
+            isPositionTpsl: boolean;
+            reduceOnly: boolean;
+            orderType: "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
+            tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null;
+            cloid: `0x${string}` | null;
+        }, "Open order with additional display information.">]>;
+        /** Order processing status. */
+        readonly status: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"open", undefined>, v.LiteralSchema<"filled", undefined>, v.LiteralSchema<"canceled", undefined>, v.LiteralSchema<"triggered", undefined>, v.LiteralSchema<"rejected", undefined>, v.LiteralSchema<"marginCanceled", undefined>, v.LiteralSchema<"vaultWithdrawalCanceled", undefined>, v.LiteralSchema<"openInterestCapCanceled", undefined>, v.LiteralSchema<"selfTradeCanceled", undefined>, v.LiteralSchema<"reduceOnlyCanceled", undefined>, v.LiteralSchema<"siblingFilledCanceled", undefined>, v.LiteralSchema<"delistedCanceled", undefined>, v.LiteralSchema<"liquidatedCanceled", undefined>, v.LiteralSchema<"scheduledCancel", undefined>, v.LiteralSchema<"tickRejected", undefined>, v.LiteralSchema<"minTradeNtlRejected", undefined>, v.LiteralSchema<"perpMarginRejected", undefined>, v.LiteralSchema<"reduceOnlyRejected", undefined>, v.LiteralSchema<"badAloPxRejected", undefined>, v.LiteralSchema<"iocCancelRejected", undefined>, v.LiteralSchema<"badTriggerPxRejected", undefined>, v.LiteralSchema<"marketOrderNoLiquidityRejected", undefined>, v.LiteralSchema<"positionIncreaseAtOpenInterestCapRejected", undefined>, v.LiteralSchema<"positionFlipAtOpenInterestCapRejected", undefined>, v.LiteralSchema<"tooAggressiveAtOpenInterestCapRejected", undefined>, v.LiteralSchema<"openInterestIncreaseRejected", undefined>, v.LiteralSchema<"insufficientSpotBalanceRejected", undefined>, v.LiteralSchema<"oracleRejected", undefined>, v.LiteralSchema<"perpMaxPositionRejected", undefined>], undefined>, v.DescriptionAction<"open" | "canceled" | "rejected" | "filled" | "triggered" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "tickRejected" | "minTradeNtlRejected" | "perpMarginRejected" | "reduceOnlyRejected" | "badAloPxRejected" | "iocCancelRejected" | "badTriggerPxRejected" | "marketOrderNoLiquidityRejected" | "positionIncreaseAtOpenInterestCapRejected" | "positionFlipAtOpenInterestCapRejected" | "tooAggressiveAtOpenInterestCapRejected" | "openInterestIncreaseRejected" | "insufficientSpotBalanceRejected" | "oracleRejected" | "perpMaxPositionRejected", string>]>;
+        /** Timestamp when the status was last updated (in ms since epoch). */
+        readonly statusTimestamp: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Timestamp when the status was last updated (in ms since epoch).">]>;
+    }, undefined>, v.DescriptionAction<{
+        order: {
+            coin: string;
+            side: "B" | "A";
+            limitPx: string;
+            sz: string;
+            oid: number;
+            timestamp: number;
+            origSz: string;
+            triggerCondition: string;
+            isTrigger: boolean;
+            triggerPx: string;
+            children: any[];
+            isPositionTpsl: boolean;
+            reduceOnly: boolean;
+            orderType: "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
+            tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null;
+            cloid: `0x${string}` | null;
+        };
+        status: "open" | "canceled" | "rejected" | "filled" | "triggered" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "tickRejected" | "minTradeNtlRejected" | "perpMarginRejected" | "reduceOnlyRejected" | "badAloPxRejected" | "iocCancelRejected" | "badTriggerPxRejected" | "marketOrderNoLiquidityRejected" | "positionIncreaseAtOpenInterestCapRejected" | "positionFlipAtOpenInterestCapRejected" | "tooAggressiveAtOpenInterestCapRejected" | "openInterestIncreaseRejected" | "insufficientSpotBalanceRejected" | "oracleRejected" | "perpMaxPositionRejected";
+        statusTimestamp: number;
+    }, "Frontend order with current processing status.">]>, undefined>, v.DescriptionAction<{
+        order: {
+            coin: string;
+            side: "B" | "A";
+            limitPx: string;
+            sz: string;
+            oid: number;
+            timestamp: number;
+            origSz: string;
+            triggerCondition: string;
+            isTrigger: boolean;
+            triggerPx: string;
+            children: any[];
+            isPositionTpsl: boolean;
+            reduceOnly: boolean;
+            orderType: "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
+            tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null;
+            cloid: `0x${string}` | null;
+        };
+        status: "open" | "canceled" | "rejected" | "filled" | "triggered" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "tickRejected" | "minTradeNtlRejected" | "perpMarginRejected" | "reduceOnlyRejected" | "badAloPxRejected" | "iocCancelRejected" | "badTriggerPxRejected" | "marketOrderNoLiquidityRejected" | "positionIncreaseAtOpenInterestCapRejected" | "positionFlipAtOpenInterestCapRejected" | "tooAggressiveAtOpenInterestCapRejected" | "openInterestIncreaseRejected" | "insufficientSpotBalanceRejected" | "oracleRejected" | "perpMaxPositionRejected";
+        statusTimestamp: number;
+    }[], "Array of frontend orders with current processing status.">]>;
+    /** Whether this is an initial snapshot. */
+    readonly isSnapshot: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Whether this is an initial snapshot.">]>;
+}, undefined>, v.DescriptionAction<{
+    user: `0x${string}`;
+    orderHistory: {
+        order: {
+            coin: string;
+            side: "B" | "A";
+            limitPx: string;
+            sz: string;
+            oid: number;
+            timestamp: number;
+            origSz: string;
+            triggerCondition: string;
+            isTrigger: boolean;
+            triggerPx: string;
+            children: any[];
+            isPositionTpsl: boolean;
+            reduceOnly: boolean;
+            orderType: "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
+            tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null;
+            cloid: `0x${string}` | null;
+        };
+        status: "open" | "canceled" | "rejected" | "filled" | "triggered" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "tickRejected" | "minTradeNtlRejected" | "perpMarginRejected" | "reduceOnlyRejected" | "badAloPxRejected" | "iocCancelRejected" | "badTriggerPxRejected" | "marketOrderNoLiquidityRejected" | "positionIncreaseAtOpenInterestCapRejected" | "positionFlipAtOpenInterestCapRejected" | "tooAggressiveAtOpenInterestCapRejected" | "openInterestIncreaseRejected" | "insufficientSpotBalanceRejected" | "oracleRejected" | "perpMaxPositionRejected";
+        statusTimestamp: number;
+    }[];
+    isSnapshot?: true | undefined;
+}, "Event of user historical orders.">]>;
+export type UserHistoricalOrdersEvent = v.InferOutput<typeof UserHistoricalOrdersEvent>;
+/** Request parameters for the {@linkcode userHistoricalOrders} function. */
+export type UserHistoricalOrdersParameters = Omit<v.InferInput<typeof UserHistoricalOrdersRequest>, "type">;
+/**
+ * Subscribe to historical order 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 { userHistoricalOrders } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await userHistoricalOrders(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function userHistoricalOrders(config: SubscriptionRequestConfig, params: DeepImmutable<UserHistoricalOrdersParameters>, listener: (data: UserHistoricalOrdersEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=userHistoricalOrders.d.ts.map

package/dist/src/api/subscription/userHistoricalOrders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userHistoricalOrders.d.ts","sourceRoot":"","sources":["../../../../src/api/subscription/userHistoricalOrders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAA2B,MAAM,aAAa,CAAC;AACnF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAM5D,kEAAkE;AAClE,eAAO,MAAM,2BAA2B;IAGlC,4BAA4B;;IAK5B,oBAAoB;;;;;mEAQtB,CAAC;AACL,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAE5F,uCAAuC;AACvC,eAAO,MAAM,yBAAyB;IAGhC,oBAAoB;;IAKpB,+DAA+D;;QAMvD,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAErB,+BAA+B;;QAE/B,sEAAsE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAW9E,2CAA2C;;;;;;;;;;;;;;;;;;;;;;;;;;;wCAQ7C,CAAC;AACL,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAIxF,4EAA4E;AAC5E,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,2BAA2B,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5G;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,8BAA8B,CAAC,EACrD,QAAQ,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,IAAI,GAClD,OAAO,CAAC,YAAY,CAAC,CAOvB"}