@nktkas/hyperliquid 0.25.7 → 0.25.9

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

@@ -0,0 +1,58 @@
+import * as v from "valibot";
+import { Address, parser } from "../_base.js";
+import { BalanceSchema } from "../_common_schemas.js";
+// -------------------- Schemas --------------------
+/** Subscription to spot state events for a specific user. */
+export const SpotStateRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of subscription. */
+        type: v.pipe(v.literal("spotState"), v.description("Type of subscription.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Subscription to spot state events for a specific user."));
+})();
+/** Event of user spot state. */
+export const SpotStateEvent = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+        /** Spot state of the user. */
+        spotState: v.pipe(v.object({
+            /** Balance for each token. */
+            balances: v.pipe(v.array(BalanceSchema), v.description("Balance for each token.")),
+        }), v.description("Spot state of the user.")),
+    }), v.description("Event of user spot state."));
+})();
+/**
+ * Subscribe to spot state 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 { spotState } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await spotState(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export function spotState(config, params, listener) {
+    const payload = parser(SpotStateRequest)({ type: "spotState", user: params.user });
+    return config.transport.subscribe(payload.type, payload, (e) => {
+        if (e.detail.user === payload.user) {
+            listener(e.detail);
+        }
+    });
+}
+//# sourceMappingURL=spotState.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"spotState.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/spotState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,MAAM,aAAa,CAAC;AAIlE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,oDAAoD;AAEpD,6DAA6D;AAC7D,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;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE,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,8BAA8B;QAC9B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,MAAM,CAAC;YACP,8BAA8B;YAC9B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;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,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACnF,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/esm/src/api/subscription/userEvents.d.ts

@@ -312,72 +312,83 @@ export type TwapHistoryEvent = v.InferOutput<typeof TwapHistoryEvent>;
 /** Event of TWAP slice fills. */
 export declare const TwapSliceFillsEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     /** Array of TWAP slice fills. */
-    readonly twapSliceFills: 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.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.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.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.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.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.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.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.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique transaction identifier for a partial fill of an order.">]>;
-        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.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;
-        feeToken: string;
-        twapId: number | null;
-    }, "TWAP 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;
-        feeToken: string;
-        twapId: number | null;
+    readonly twapSliceFills: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
+        /** Fill details for the TWAP slice. */
+        readonly fill: 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.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.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.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.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.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.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.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.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique transaction identifier for a partial fill of an order.">]>;
+            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.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;
+            feeToken: string;
+            twapId: number | null;
+        }, "TWAP fill record.">]>;
+        /** 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.">]>;
 }, undefined>, v.DescriptionAction<{
     twapSliceFills: {
-        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: {
+            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;
     }[];
 }, "Event of TWAP slice fills.">]>;
 export type TwapSliceFillsEvent = v.InferOutput<typeof TwapSliceFillsEvent>;
@@ -665,72 +676,83 @@ export declare const UserEventsEvent: v.SchemaWithPipe<readonly [v.UnionSchema<[
     }[];
 }, "Event of a TWAP history entry.">]>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
     /** Array of TWAP slice fills. */
-    readonly twapSliceFills: 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.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.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.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.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.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.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.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.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique transaction identifier for a partial fill of an order.">]>;
-        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.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;
-        feeToken: string;
-        twapId: number | null;
-    }, "TWAP 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;
-        feeToken: string;
-        twapId: number | null;
+    readonly twapSliceFills: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
+        /** Fill details for the TWAP slice. */
+        readonly fill: 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.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.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.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.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.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.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.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.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique transaction identifier for a partial fill of an order.">]>;
+            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.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;
+            feeToken: string;
+            twapId: number | null;
+        }, "TWAP fill record.">]>;
+        /** 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.">]>;
 }, undefined>, v.DescriptionAction<{
     twapSliceFills: {
-        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: {
+            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;
     }[];
 }, "Event of TWAP slice fills.">]>], undefined>, v.DescriptionAction<{
     fills: {
@@ -802,21 +824,24 @@ export declare const UserEventsEvent: v.SchemaWithPipe<readonly [v.UnionSchema<[
     }[];
 } | {
     twapSliceFills: {
-        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: {
+            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;
     }[];
 }, "Event of one of possible user events.">]>;
 export type UserEventsEvent = v.InferOutput<typeof UserEventsEvent>;

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

@@ -1 +1 @@
-{"version":3,"file":"userEvents.d.ts","sourceRoot":"","sources":["../../../../src/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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAQnC,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E,4CAA4C;AAC5C,eAAO,MAAM,eAAe;IAjLtB,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6CAwBnC,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"}
+{"version":3,"file":"userEvents.d.ts","sourceRoot":"","sources":["../../../../src/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/esm/src/api/subscription/userEvents.js

@@ -90,7 +90,12 @@ export const TwapHistoryEvent = /* @__PURE__ */ (() => {
 export const TwapSliceFillsEvent = /* @__PURE__ */ (() => {
     return v.pipe(v.object({
         /** Array of TWAP slice fills. */
-        twapSliceFills: v.pipe(v.array(TwapFillSchema), v.description("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. */

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

@@ -1 +1 @@
-{"version":3,"file":"userEvents.js","sourceRoot":"","sources":["../../../../src/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,CAAC,cAAc,CAAC,EACvB,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"}
+{"version":3,"file":"userEvents.js","sourceRoot":"","sources":["../../../../src/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/esm/src/api/subscription/webData2.d.ts

@@ -282,6 +282,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             readonly marginTableId: 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 identifier for the margin requirements table.">]>;
             readonly onlyIsolated: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Indicates if only isolated margin trading is allowed.">]>;
             readonly isDelisted: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Indicates if the universe is delisted.">]>;
+            readonly marginMode: v.SchemaWithPipe<readonly [v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"strictIsolated", undefined>, v.LiteralSchema<"noCross", undefined>], undefined>, undefined>, v.DescriptionAction<"strictIsolated" | "noCross" | undefined, "Trading margin mode constraint.">]>;
         }, undefined>, v.DescriptionAction<{
             szDecimals: number;
             name: string;
@@ -289,6 +290,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             marginTableId: number;
             onlyIsolated?: true | undefined;
             isDelisted?: true | undefined;
+            marginMode?: "strictIsolated" | "noCross" | undefined;
         }, "Trading universe parameters for perpetual asset.">]>, undefined>, v.DescriptionAction<{
             szDecimals: number;
             name: string;
@@ -296,6 +298,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             marginTableId: number;
             onlyIsolated?: true | undefined;
             isDelisted?: true | undefined;
+            marginMode?: "strictIsolated" | "noCross" | undefined;
         }[], "Trading universes available for perpetual trading.">]>;
         readonly marginTables: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.TupleSchema<[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.SchemaWithPipe<readonly [v.ObjectSchema<{
             readonly description: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Description of the margin table.">]>;
@@ -337,6 +340,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             marginTableId: number;
             onlyIsolated?: true | undefined;
             isDelisted?: true | undefined;
+            marginMode?: "strictIsolated" | "noCross" | undefined;
         }[];
         marginTables: [number, {
             description: string;
@@ -594,6 +598,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             marginTableId: number;
             onlyIsolated?: true | undefined;
             isDelisted?: true | undefined;
+            marginMode?: "strictIsolated" | "noCross" | undefined;
         }[];
         marginTables: [number, {
             description: string;

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

@@ -1 +1 @@
-{"version":3,"file":"webData2.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/webData2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAA4C,MAAM,aAAa,CAAC;AACpG,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAU5D,iEAAiE;AACjE,eAAO,MAAM,eAAe;IAGtB,4BAA4B;;IAK5B,oBAAoB;;;;;kEAQtB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE,mDAAmD;AACnD,eAAO,MAAM,aAAa;IAGpB,6CAA6C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAE7C,+BAA+B;;QAMvB,4BAA4B;;QAK5B,yBAAyB;;;;;;;;;IAWjC,8BAA8B;;IAK9B,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAK3D,mCAAmC;;IAKnC,gDAAgD;;IAKhD,+BAA+B;;IAK/B,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAErC,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAExC,4CAA4C;;IAK5C,uCAAuC;;IAKvC,oBAAoB;;IAKpB,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAc5B,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAExC,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEnC,sDAAsD;;IAKtD,mDAAmD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2CAQrD,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAIhE,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,kBAAkB,CAAC,EACzC,QAAQ,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,GACtC,OAAO,CAAC,YAAY,CAAC,CAOvB"}
+{"version":3,"file":"webData2.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/webData2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAA4C,MAAM,aAAa,CAAC;AACpG,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAU5D,iEAAiE;AACjE,eAAO,MAAM,eAAe;IAGtB,4BAA4B;;IAK5B,oBAAoB;;;;;kEAQtB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE,mDAAmD;AACnD,eAAO,MAAM,aAAa;IAGpB,6CAA6C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAE7C,+BAA+B;;QAMvB,4BAA4B;;QAK5B,yBAAyB;;;;;;;;;IAWjC,8BAA8B;;IAK9B,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAK3D,mCAAmC;;IAKnC,gDAAgD;;IAKhD,+BAA+B;;IAK/B,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAErC,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAExC,4CAA4C;;IAK5C,uCAAuC;;IAKvC,oBAAoB;;IAKpB,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAc5B,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAExC,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEnC,sDAAsD;;IAKtD,mDAAmD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2CAQrD,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAIhE,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,kBAAkB,CAAC,EACzC,QAAQ,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,GACtC,OAAO,CAAC,YAAY,CAAC,CAOvB"}

package/esm/src/api/subscription/~client.d.ts

@@ -15,6 +15,7 @@ import { l2Book } from "./l2Book.js";
 import { notification } from "./notification.js";
 import { openOrders } from "./openOrders.js";
 import { orderUpdates } from "./orderUpdates.js";
+import { spotState } from "./spotState.js";
 import { trades } from "./trades.js";
 import { userEvents } from "./userEvents.js";
 import { userFills } from "./userFills.js";
@@ -39,6 +40,7 @@ export type { L2BookEvent as WsL2BookEvent, L2BookParameters as WsL2BookParamete
 export type { NotificationEvent as WsNotificationEvent, NotificationParameters as WsNotificationParameters, } from "./notification.js";
 export type { OpenOrdersEvent as WsOpenOrdersEvent, OpenOrdersParameters as WsOpenOrdersParameters, } from "./openOrders.js";
 export type { OrderUpdatesEvent as WsOrderUpdatesEvent, OrderUpdatesParameters as WsOrderUpdatesParameters, } from "./orderUpdates.js";
+export type { SpotStateEvent as WsSpotStateEvent, SpotStateParameters as WsSpotStateParameters } from "./spotState.js";
 export type { TradesEvent as WsTradesEvent, TradesParameters as WsTradesParameters } from "./trades.js";
 export type { UserEventsEvent as WsUserEventsEvent, UserEventsParameters as WsUserEventsParameters, } from "./userEvents.js";
 export type { UserFillsEvent as WsUserFillsEvent, UserFillsParameters as WsUserFillsParameters } from "./userFills.js";
@@ -349,6 +351,26 @@ export declare class SubscriptionClient<T extends ISubscriptionTransport = ISubs
      * ```
      */
     orderUpdates(...args: OmitFirst<OverloadedParameters<typeof orderUpdates>>): Promise<import("../../mod.js").Subscription>;
+    /**
+     * Subscribe to spot state updates for a specific user.
+     * @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 * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     *
+     * const client = new hl.SubscriptionClient({ transport });
+     * const sub = await client.spotState({ user: "0x..." }, (data) => console.log(data));
+     * ```
+     */
+    spotState(...args: OmitFirst<OverloadedParameters<typeof spotState>>): Promise<import("../../mod.js").Subscription>;
     /**
      * Subscribe to real-time trade updates for a specific asset.
      * @param params - Parameters specific to the API subscription.