@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/script/src/api/subscription/userTwapHistory.js

@@ -0,0 +1,148 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserTwapHistoryEvent = exports.UserTwapHistoryRequest = void 0;
+exports.userTwapHistory = userTwapHistory;
+const v = __importStar(require("valibot"));
+const _common_js_1 = require("../_common.js");
+// -------------------- Schemas --------------------
+/** Subscription to user TWAP history events for a specific user. */
+exports.UserTwapHistoryRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("userTwapHistory"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(_common_js_1.Address, v.description("User address.")),
+    }), v.description("Subscription to user TWAP history events for a specific user."));
+})();
+/** Event of user TWAP history. */
+exports.UserTwapHistoryEvent = (() => {
+    return v.pipe(v.object({
+        /** User address. */
+        user: v.pipe(_common_js_1.Address, v.description("User address.")),
+        /** Array of user's TWAP history. */
+        history: v.pipe(v.array(
+        /** TWAP history record. */
+        v.pipe(v.object({
+            /** Creation time of the history record (in seconds since epoch). */
+            time: v.pipe(_common_js_1.UnsignedInteger, v.description("Creation time of the history record (in seconds since epoch).")),
+            /** State of the TWAP order. */
+            state: v.pipe(v.object({
+                /** Asset symbol. */
+                coin: v.pipe(v.string(), v.description("Asset symbol.")),
+                /** Executed notional value. */
+                executedNtl: v.pipe(_common_js_1.UnsignedDecimal, v.description("Executed notional value.")),
+                /** Executed size. */
+                executedSz: v.pipe(_common_js_1.UnsignedDecimal, v.description("Executed size.")),
+                /** Duration in minutes. */
+                minutes: v.pipe(_common_js_1.UnsignedInteger, v.description("Duration in minutes.")),
+                /** Indicates if the TWAP randomizes execution. */
+                randomize: v.pipe(v.boolean(), v.description("Indicates if the TWAP randomizes execution.")),
+                /** Indicates if the order is reduce-only. */
+                reduceOnly: v.pipe(v.boolean(), v.description("Indicates if the order is reduce-only.")),
+                /** 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).')),
+                /** Order size. */
+                sz: v.pipe(_common_js_1.UnsignedDecimal, v.description("Order size.")),
+                /** Start time of the TWAP order (in ms since epoch). */
+                timestamp: v.pipe(_common_js_1.UnsignedInteger, v.description("Start time of the TWAP order (in ms since epoch).")),
+                /** User address. */
+                user: v.pipe(_common_js_1.Address, v.description("User address.")),
+            }), v.description("State of the TWAP order.")),
+            /**
+             * Current status of the TWAP order.
+             * - `"finished"`: Fully executed.
+             * - `"activated"`: Active and executing.
+             * - `"terminated"`: Terminated.
+             * - `"error"`: An error occurred.
+             */
+            status: v.pipe(v.union([
+                v.object({
+                    /** Status of the TWAP order. */
+                    status: v.pipe(v.union([
+                        v.literal("finished"),
+                        v.literal("activated"),
+                        v.literal("terminated"),
+                    ]), v.description("Status of the TWAP order.")),
+                }),
+                v.object({
+                    /** Status of the TWAP order. */
+                    status: v.pipe(v.literal("error"), v.description("Status of the TWAP order.")),
+                    /** Error message. */
+                    description: v.pipe(v.string(), v.description("Error message.")),
+                }),
+            ]), v.description("Current status of the TWAP order." +
+                '\n- `"finished"`: Fully executed. ' +
+                '\n- `"activated"`: Active and executing. ' +
+                '\n- `"terminated"`: Terminated. ' +
+                '\n- `"error"`: An error occurred.')),
+        }), v.description("TWAP history record."))), v.description("Array of user's TWAP history.")),
+        /** Whether this is an initial snapshot. */
+        isSnapshot: v.pipe(v.optional(v.literal(true)), v.description("Whether this is an initial snapshot.")),
+    }), v.description("Event of user TWAP history."));
+})();
+/**
+ * Subscribe to TWAP order history updates for a specific user.
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { userTwapHistory } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await userTwapHistory(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+function userTwapHistory(config, params, listener) {
+    const payload = (0, _common_js_1.parser)(exports.UserTwapHistoryRequest)({ type: "userTwapHistory", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.user === payload.user.toLowerCase()) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=userTwapHistory.js.map

package/script/src/api/subscription/userTwapHistory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userTwapHistory.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/userTwapHistory.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8LA,0CAWC;AAzMD,2CAA6B;AAC7B,8CAAsG;AAItG,oDAAoD;AAEpD,oEAAoE;AACvD,QAAA,sBAAsB,GAAmB,CAAC,GAAG,EAAE;IAC1D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAC5B,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,+DAA+D,CAAC,CAC/E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,kCAAkC;AACrB,QAAA,oBAAoB,GAAmB,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,oCAAoC;QACpC,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,KAAK;QACL,2BAA2B;QAC3B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,oEAAoE;YACpE,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,+DAA+D,CAAC,CAC/E;YACD,+BAA+B;YAC/B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;gBACP,oBAAoB;gBACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;gBACD,+BAA+B;gBAC/B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;gBACD,qBAAqB;gBACrB,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;gBACD,2BAA2B;gBAC3B,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;gBACD,kDAAkD;gBAClD,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;gBACD,6CAA6C;gBAC7C,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD;gBACD,kDAAkD;gBAClD,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;gBACD,kBAAkB;gBAClB,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;gBACD,wDAAwD;gBACxD,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE;gBACD,oBAAoB;gBACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;YACD;;;;;;eAMG;YACH,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC;gBACN,CAAC,CAAC,MAAM,CAAC;oBACP,gCAAgC;oBAChC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC;wBACN,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;wBACrB,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;wBACtB,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;qBACxB,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;iBACF,CAAC;gBACF,CAAC,CAAC,MAAM,CAAC;oBACP,gCAAgC;oBAChC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAClB,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;oBACD,qBAAqB;oBACrB,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;iBACF,CAAC;aACH,CAAC,EACF,CAAC,CAAC,WAAW,CACX,mCAAmC;gBACjC,oCAAoC;gBACpC,2CAA2C;gBAC3C,kCAAkC;gBAClC,mCAAmC,CACtC,CACF;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;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,6BAA6B,CAAC,CAC7C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,eAAe,CAC7B,MAAiC,EACjC,MAAgD,EAChD,QAA8C;IAE9C,MAAM,OAAO,GAAG,IAAA,mBAAM,EAAC,8BAAsB,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACvF,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAuB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACnF,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACjD,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,147 @@
+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 user TWAP slice fill events for a specific user. */
+export declare const UserTwapSliceFillsRequest: 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 UserTwapSliceFillsRequest = v.InferOutput<typeof UserTwapSliceFillsRequest>;
+/** Event of user TWAP slice fill. */
+export declare const UserTwapSliceFillsEvent: 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 TWAP slice fills. */
+    readonly twapSliceFills: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
+        /** Fill details for the TWAP slice. */
+        readonly fill: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Asset symbol. */
+            readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+            /** 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, "Price.">]>;
+            /** 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, "Size.">]>;
+            /** Order 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", "Order side (\"B\" = Bid/Buy, \"A\" = Ask/Sell).">]>;
+            /** Timestamp when the trade occurred (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, "Timestamp when the trade occurred (in ms since epoch).">]>;
+            /** Start position size. */
+            readonly startPosition: 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, "Start position size.">]>;
+            /** Direction indicator for frontend display. */
+            readonly dir: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Direction indicator for frontend display.">]>;
+            /** Realized PnL. */
+            readonly closedPnl: 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, "Realized PnL.">]>;
+            /** L1 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}`, "L1 transaction hash.">]>;
+            /** Order ID. */
+            readonly oid: 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, "Order ID.">]>;
+            /** Indicates if the fill was a taker order. */
+            readonly crossed: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the fill was a taker order.">]>;
+            /** Fee charged or rebate received (negative indicates rebate). */
+            readonly fee: 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, "Fee charged or rebate received (negative indicates rebate).">]>;
+            /** Unique transaction identifier for a partial fill of an order. */
+            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, "Unique transaction identifier for a partial fill of an order.">]>;
+            /** Token in which the fee is denominated (e.g., "USDC"). */
+            readonly feeToken: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Token in which the fee is denominated (e.g., \"USDC\").">]>;
+            /** ID of the TWAP. */
+            readonly twapId: v.SchemaWithPipe<readonly [v.UnionSchema<[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.NullSchema<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;
+            feeToken: string;
+            twapId: number | null;
+        }, "Fill details for the TWAP slice.">]>;
+        /** ID of the TWAP. */
+        readonly twapId: 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, "ID of the TWAP.">]>;
+    }, undefined>, undefined>, v.DescriptionAction<{
+        fill: {
+            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;
+            feeToken: string;
+            twapId: number | null;
+        };
+        twapId: number;
+    }[], "Array of TWAP slice 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}`;
+    twapSliceFills: {
+        fill: {
+            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;
+            feeToken: string;
+            twapId: number | null;
+        };
+        twapId: number;
+    }[];
+    isSnapshot?: true | undefined;
+}, "Event of user TWAP slice fill.">]>;
+export type UserTwapSliceFillsEvent = v.InferOutput<typeof UserTwapSliceFillsEvent>;
+/** Request parameters for the {@linkcode userTwapSliceFills} function. */
+export type UserTwapSliceFillsParameters = Omit<v.InferInput<typeof UserTwapSliceFillsRequest>, "type">;
+/**
+ * Subscribe to TWAP execution updates for a specific user.
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { userTwapSliceFills } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await userTwapSliceFills(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export declare function userTwapSliceFills(config: SubscriptionRequestConfig, params: DeepImmutable<UserTwapSliceFillsParameters>, listener: (data: UserTwapSliceFillsEvent) => void): Promise<Subscription>;
+//# sourceMappingURL=userTwapSliceFills.d.ts.map

package/script/src/api/subscription/userTwapSliceFills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userTwapSliceFills.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/userTwapSliceFills.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAoB,KAAK,aAAa,EAAiD,MAAM,eAAe,CAAC;AACpH,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,uEAAuE;AACvE,eAAO,MAAM,yBAAyB;IAGhC,4BAA4B;;IAK5B,oBAAoB;;;;;wEAQtB,CAAC;AACL,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAExF,qCAAqC;AACrC,eAAO,MAAM,uBAAuB;IAG9B,oBAAoB;;IAKpB,iCAAiC;;QAI3B,uCAAuC;;YAGnC,oBAAoB;;YAKpB,aAAa;;YAKb,YAAY;;YAKZ,kDAAkD;;YAKlD,6DAA6D;;YAK7D,2BAA2B;;YAK3B,gDAAgD;;YAKhD,oBAAoB;;YAKpB,2BAA2B;;YAK3B,gBAAgB;;YAKhB,+CAA+C;;YAK/C,kEAAkE;;YAKlE,oEAAoE;;YAKpE,4DAA4D;;YAK5D,sBAAsB;;;;;;;;;;;;;;;;;;;QAQ1B,sBAAsB;;;;;;;;;;;;;;;;;;;;;;IAS5B,2CAA2C;;;;;;;;;;;;;;;;;;;;;;;;;sCAQ7C,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAIpF,0EAA0E;AAC1E,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,yBAAyB,CAAC,EAAE,MAAM,CAAC,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,4BAA4B,CAAC,EACnD,QAAQ,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,GAChD,OAAO,CAAC,YAAY,CAAC,CAOvB"}

package/script/src/api/subscription/userTwapSliceFills.js

@@ -0,0 +1,129 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserTwapSliceFillsEvent = exports.UserTwapSliceFillsRequest = void 0;
+exports.userTwapSliceFills = userTwapSliceFills;
+const v = __importStar(require("valibot"));
+const _common_js_1 = require("../_common.js");
+// -------------------- Schemas --------------------
+/** Subscription to user TWAP slice fill events for a specific user. */
+exports.UserTwapSliceFillsRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("userTwapSliceFills"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(_common_js_1.Address, v.description("User address.")),
+    }), v.description("Subscription to user TWAP slice fill events for a specific user."));
+})();
+/** Event of user TWAP slice fill. */
+exports.UserTwapSliceFillsEvent = (() => {
+    return v.pipe(v.object({
+        /** User address. */
+        user: v.pipe(_common_js_1.Address, v.description("User address.")),
+        /** Array of TWAP slice fills. */
+        twapSliceFills: v.pipe(v.array(v.object({
+            /** Fill details for the TWAP slice. */
+            fill: v.pipe(v.object({
+                /** Asset symbol. */
+                coin: v.pipe(v.string(), v.description("Asset symbol.")),
+                /** Price. */
+                px: v.pipe(_common_js_1.UnsignedDecimal, v.description("Price.")),
+                /** Size. */
+                sz: v.pipe(_common_js_1.UnsignedDecimal, v.description("Size.")),
+                /** 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).')),
+                /** Timestamp when the trade occurred (in ms since epoch). */
+                time: v.pipe(_common_js_1.UnsignedInteger, v.description("Timestamp when the trade occurred (in ms since epoch).")),
+                /** Start position size. */
+                startPosition: v.pipe(_common_js_1.Decimal, v.description("Start position size.")),
+                /** Direction indicator for frontend display. */
+                dir: v.pipe(v.string(), v.description("Direction indicator for frontend display.")),
+                /** Realized PnL. */
+                closedPnl: v.pipe(_common_js_1.Decimal, v.description("Realized PnL.")),
+                /** L1 transaction hash. */
+                hash: v.pipe(v.pipe(_common_js_1.Hex, v.length(66)), v.description("L1 transaction hash.")),
+                /** Order ID. */
+                oid: v.pipe(_common_js_1.UnsignedInteger, v.description("Order ID.")),
+                /** Indicates if the fill was a taker order. */
+                crossed: v.pipe(v.boolean(), v.description("Indicates if the fill was a taker order.")),
+                /** Fee charged or rebate received (negative indicates rebate). */
+                fee: v.pipe(_common_js_1.Decimal, v.description("Fee charged or rebate received (negative indicates rebate).")),
+                /** Unique transaction identifier for a partial fill of an order. */
+                tid: v.pipe(_common_js_1.UnsignedInteger, v.description("Unique transaction identifier for a partial fill of an order.")),
+                /** Token in which the fee is denominated (e.g., "USDC"). */
+                feeToken: v.pipe(v.string(), v.description('Token in which the fee is denominated (e.g., "USDC").')),
+                /** ID of the TWAP. */
+                twapId: v.pipe(v.union([_common_js_1.UnsignedInteger, v.null()]), v.description("ID of the TWAP.")),
+            }), v.description("Fill details for the TWAP slice.")),
+            /** ID of the TWAP. */
+            twapId: v.pipe(_common_js_1.UnsignedInteger, v.description("ID of the TWAP.")),
+        })), v.description("Array of TWAP slice fills.")),
+        /** Whether this is an initial snapshot. */
+        isSnapshot: v.pipe(v.optional(v.literal(true)), v.description("Whether this is an initial snapshot.")),
+    }), v.description("Event of user TWAP slice fill."));
+})();
+/**
+ * Subscribe to TWAP execution updates for a specific user.
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { userTwapSliceFills } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await userTwapSliceFills(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+function userTwapSliceFills(config, params, listener) {
+    const payload = (0, _common_js_1.parser)(exports.UserTwapSliceFillsRequest)({ type: "userTwapSliceFills", ...params });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.user === payload.user.toLowerCase()) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=userTwapSliceFills.js.map

package/script/src/api/subscription/userTwapSliceFills.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userTwapSliceFills.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/userTwapSliceFills.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0KA,gDAWC;AArLD,2CAA6B;AAC7B,8CAAoH;AAIpH,oDAAoD;AAEpD,uEAAuE;AAC1D,QAAA,yBAAyB,GAAmB,CAAC,GAAG,EAAE;IAC7D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC/B,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kEAAkE,CAAC,CAClF,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,qCAAqC;AACxB,QAAA,uBAAuB,GAAmB,CAAC,GAAG,EAAE;IAC3D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,iCAAiC;QACjC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;YACP,uCAAuC;YACvC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,CAAC;gBACP,oBAAoB;gBACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;gBACD,aAAa;gBACb,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CACxB;gBACD,YAAY;gBACZ,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CACvB;gBACD,kDAAkD;gBAClD,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;gBACD,6DAA6D;gBAC7D,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE;gBACD,2BAA2B;gBAC3B,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;gBACD,gDAAgD;gBAChD,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D;gBACD,oBAAoB;gBACpB,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;gBACD,2BAA2B;gBAC3B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,IAAI,CAAC,gBAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;gBACD,gBAAgB;gBAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;gBACD,+CAA+C;gBAC/C,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAC1D;gBACD,kEAAkE;gBAClE,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,6DAA6D,CAAC,CAC7E;gBACD,oEAAoE;gBACpE,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,+DAA+D,CAAC,CAC/E;gBACD,4DAA4D;gBAC5D,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uDAAuD,CAAC,CACvE;gBACD,sBAAsB;gBACtB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC,CAAC,4BAAe,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EACpC,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;YACD,sBAAsB;YACtB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;SACF,CAAC,CACH,EACD,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,gCAAgC,CAAC,CAChD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,kBAAkB,CAChC,MAAiC,EACjC,MAAmD,EACnD,QAAiD;IAEjD,MAAM,OAAO,GAAG,IAAA,mBAAM,EAAC,iCAAyB,CAAC,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC7F,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAA0B,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACtF,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACjD,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}