@nktkas/hyperliquid 0.25.0 → 0.25.2

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

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { type DeepImmutable } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { type DeepImmutable } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 /** Subscription to comprehensive user and market data events. */
 export declare const WebData2Request: v.SchemaWithPipe<readonly [v.ObjectSchema<{
@@ -17,15 +17,10 @@ export type WebData2Request = v.InferOutput<typeof WebData2Request>;
 export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     /** Account summary for perpetual trading. */
     readonly clearinghouseState: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-        /** Margin summary details. */
         readonly marginSummary: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-            /** Total account value. */
             readonly accountValue: 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, "Total account value.">]>;
-            /** Total notional position value. */
             readonly totalNtlPos: 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, "Total notional position value.">]>;
-            /** Total raw USD value. */
             readonly totalRawUsd: 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, "Total raw USD value.">]>;
-            /** Total margin used. */
             readonly totalMarginUsed: 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, "Total margin used.">]>;
         }, undefined>, v.DescriptionAction<{
             accountValue: string;
@@ -33,15 +28,10 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             totalRawUsd: string;
             totalMarginUsed: string;
         }, "Margin summary details.">]>;
-        /** Cross-margin summary details. */
         readonly crossMarginSummary: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-            /** Total account value. */
             readonly accountValue: 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, "Total account value.">]>;
-            /** Total notional position value. */
             readonly totalNtlPos: 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, "Total notional position value.">]>;
-            /** Total raw USD value. */
             readonly totalRawUsd: 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, "Total raw USD value.">]>;
-            /** Total margin used. */
             readonly totalMarginUsed: 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, "Total margin used.">]>;
         }, undefined>, v.DescriptionAction<{
             accountValue: string;
@@ -49,32 +39,19 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             totalRawUsd: string;
             totalMarginUsed: string;
         }, "Cross-margin summary details.">]>;
-        /** Maintenance margin used for cross-margin positions. */
         readonly crossMaintenanceMarginUsed: 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, "Maintenance margin used for cross-margin positions.">]>;
-        /** Amount available for withdrawal. */
         readonly withdrawable: 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, "Amount available for withdrawal.">]>;
-        /** Array of asset positions. */
         readonly assetPositions: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-            /** Position type. */
             readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"oneWay", undefined>, v.DescriptionAction<"oneWay", "Position type.">]>;
-            /** Position details. */
             readonly position: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-                /** Asset symbol. */
                 readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
-                /** 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.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Signed position size.">]>;
-                /** Leverage details. */
-                readonly leverage: v.SchemaWithPipe<readonly [v.UnionSchema<[v.ObjectSchema<{
-                    /** Leverage type. */
+                readonly leverage: v.SchemaWithPipe<readonly [v.VariantSchema<"type", [v.ObjectSchema<{
                     readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"isolated", undefined>, v.DescriptionAction<"isolated", "Leverage type.">]>;
-                    /** Leverage value used. */
                     readonly value: 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.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Leverage value used.">]>;
-                    /** Amount of USD used (1 = 1$). */
                     readonly rawUsd: 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, "Amount of USD used (1 = 1$).">]>;
                 }, undefined>, v.ObjectSchema<{
-                    /** Leverage type. */
                     readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"cross", undefined>, v.DescriptionAction<"cross", "Leverage type.">]>;
-                    /** Leverage value used. */
                     readonly value: 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.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Leverage value used.">]>;
                 }, undefined>], undefined>, v.DescriptionAction<{
                     type: "isolated";
@@ -84,27 +61,16 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
                     type: "cross";
                     value: number;
                 }, "Leverage details.">]>;
-                /** Average entry price. */
                 readonly entryPx: 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, "Average entry price.">]>;
-                /** Position value. */
                 readonly positionValue: 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, "Position value.">]>;
-                /** Unrealized profit and loss. */
                 readonly unrealizedPnl: 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, "Unrealized profit and loss.">]>;
-                /** Return on equity. */
                 readonly returnOnEquity: 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, "Return on equity.">]>;
-                /** Liquidation price. */
-                readonly liquidationPx: v.SchemaWithPipe<readonly [v.UnionSchema<[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.NullSchema<undefined>], undefined>, v.DescriptionAction<string | null, "Liquidation price.">]>;
-                /** Margin used. */
+                readonly liquidationPx: v.SchemaWithPipe<readonly [v.NullableSchema<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>]>, undefined>, v.DescriptionAction<string | null, "Liquidation price.">]>;
                 readonly marginUsed: 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, "Margin used.">]>;
-                /** Maximum allowed leverage. */
                 readonly maxLeverage: 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.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Maximum allowed leverage.">]>;
-                /** Cumulative funding details. */
                 readonly cumFunding: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-                    /** Total funding paid or received since account opening. */
                     readonly allTime: 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, "Total funding paid or received since account opening.">]>;
-                    /** Funding accumulated since the position was opened. */
                     readonly sinceOpen: 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, "Funding accumulated since the position was opened.">]>;
-                    /** Funding accumulated since the last change in position size. */
                     readonly sinceChange: 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, "Funding accumulated since the last change in position size.">]>;
                 }, undefined>, v.DescriptionAction<{
                     allTime: string;
@@ -161,7 +127,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
                     sinceChange: string;
                 };
             };
-        }, "Asset position.">]>, undefined>, v.DescriptionAction<{
+        }, "Position for a specific asset.">]>, undefined>, v.DescriptionAction<{
             type: "oneWay";
             position: {
                 coin: string;
@@ -188,7 +154,6 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
                 };
             };
         }[], "Array of asset positions.">]>;
-        /** Timestamp when data was retrieved (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 data was retrieved (in ms since epoch).">]>;
     }, undefined>, v.DescriptionAction<{
         marginSummary: {
@@ -251,54 +216,22 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     readonly totalVaultEquity: 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, "Total equity in vaults.">]>;
     /** Array of user open orders with frontend information. */
     readonly openOrders: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-        /** Asset symbol. */
         readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
-        /** 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).">]>;
-        /** Limit price. */
         readonly limitPx: 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, "Limit 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 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.">]>;
-        /** Timestamp when the order was placed (in ms since epoch). */
         readonly timestamp: 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 order was placed (in ms since epoch).">]>;
-        /** Original size at order placement. */
         readonly origSz: 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, "Original size at order placement.">]>;
-        /** Condition for triggering the order. */
         readonly triggerCondition: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Condition for triggering the order.">]>;
-        /** Indicates if the order is a trigger order. */
         readonly isTrigger: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the order is a trigger order.">]>;
-        /** Trigger price. */
         readonly triggerPx: 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, "Trigger price.">]>;
-        /** Child orders associated with this order. */
-        readonly children: v.SchemaWithPipe<readonly [v.LazySchema<any>, v.DescriptionAction<any, "Child orders associated with this order.">]>;
-        /** Indicates if the order is a position TP/SL order. */
+        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.">]>;
-        /** Indicates whether the order is reduce-only. */
         readonly reduceOnly: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates whether the order is reduce-only.">]>;
-        /**
-         * Order type for market execution.
-         * - `"Market"`: Executes immediately at the market price.
-         * - `"Limit"`: Executes at the specified limit price or better.
-         * - `"Stop Market"`: Activates as a market order when a stop price is reached.
-         * - `"Stop Limit"`: Activates as a limit order when a stop price is reached.
-         * - `"Take Profit Market"`: Executes as a market order when a take profit price is reached.
-         * - `"Take Profit Limit"`: Executes as a limit order when a take profit price is reached.
-         * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/order-types
-         */
         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>]>;
-        /**
-         * Time-in-force options.
-         * - `"Gtc"`: Remains active until filled or canceled.
-         * - `"Ioc"`: Fills immediately or cancels any unfilled portion.
-         * - `"Alo"`: Adds liquidity only.
-         * - `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI.
-         * - `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.
-         */
-        readonly tif: v.SchemaWithPipe<readonly [v.UnionSchema<[v.UnionSchema<[v.LiteralSchema<"Gtc", undefined>, v.LiteralSchema<"Ioc", undefined>, v.LiteralSchema<"Alo", undefined>, v.LiteralSchema<"FrontendMarket", undefined>, v.LiteralSchema<"LiquidationMarket", undefined>], undefined>, v.NullSchema<undefined>], undefined>, v.DescriptionAction<"Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null, string>]>;
-        /** Client Order ID. */
-        readonly cloid: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 34, undefined>]>, v.NullSchema<undefined>], undefined>, v.DescriptionAction<`0x${string}` | null, "Client Order ID.">]>;
+        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";
@@ -310,13 +243,13 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         triggerCondition: string;
         isTrigger: boolean;
         triggerPx: string;
-        children: any;
+        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;
-    }, "User open order.">]>, undefined>, v.DescriptionAction<{
+    }, "Open order with additional display information.">]>, undefined>, v.DescriptionAction<{
         coin: string;
         side: "B" | "A";
         limitPx: string;
@@ -327,7 +260,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         triggerCondition: string;
         isTrigger: boolean;
         triggerPx: string;
-        children: any;
+        children: any[];
         isPositionTpsl: boolean;
         reduceOnly: boolean;
         orderType: "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
@@ -335,26 +268,19 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         cloid: `0x${string}` | null;
     }[], "User open orders with frontend information.">]>;
     /** Agent address if one exists. */
-    readonly agentAddress: v.SchemaWithPipe<readonly [v.UnionSchema<[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.NullSchema<undefined>], undefined>, v.DescriptionAction<`0x${string}` | null, "Agent address if one exists.">]>;
+    readonly agentAddress: 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}`, 42, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | null, "Agent address if one exists.">]>;
     /** Timestamp until which the agent is valid. */
-    readonly agentValidUntil: 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, "Timestamp until which the agent is valid.">]>;
+    readonly agentValidUntil: 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, "Timestamp until which the agent is valid.">]>;
     /** Cumulative ledger value. */
     readonly cumLedger: 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, "Cumulative ledger value.">]>;
     /** Metadata for perpetual assets. */
     readonly meta: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-        /** Trading universes available for perpetual trading. */
         readonly universe: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-            /** Minimum decimal places for order sizes. */
             readonly szDecimals: 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, "Minimum decimal places for order sizes.">]>;
-            /** Name of the universe. */
             readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Name of the universe.">]>;
-            /** Maximum allowed leverage. */
             readonly maxLeverage: 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.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Maximum allowed leverage.">]>;
-            /** Unique identifier for the margin requirements table. */
             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.">]>;
-            /** Indicates if only isolated margin trading is allowed. */
             readonly onlyIsolated: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Indicates if only isolated margin trading is allowed.">]>;
-            /** Indicates if the universe is delisted. */
             readonly isDelisted: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Indicates if the universe is delisted.">]>;
         }, undefined>, v.DescriptionAction<{
             szDecimals: number;
@@ -363,7 +289,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             marginTableId: number;
             onlyIsolated?: true | undefined;
             isDelisted?: true | undefined;
-        }, "Trading universe.">]>, undefined>, v.DescriptionAction<{
+        }, "Trading universe parameters for perpetual asset.">]>, undefined>, v.DescriptionAction<{
             szDecimals: number;
             name: string;
             maxLeverage: number;
@@ -371,36 +297,38 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             onlyIsolated?: true | undefined;
             isDelisted?: true | undefined;
         }[], "Trading universes available for perpetual trading.">]>;
-        /** Margin requirement tables for different leverage tiers. */
-        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.ObjectSchema<{
-            /** Description of the margin table. */
+        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.">]>;
-            /** Array of margin tiers defining leverage limits. */
             readonly marginTiers: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-                /** Lower position size boundary for this tier. */
                 readonly lowerBound: 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, "Lower position size boundary for this tier.">]>;
-                /** Maximum allowed leverage for this tier. */
                 readonly maxLeverage: 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.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Maximum allowed leverage for this tier.">]>;
             }, undefined>, v.DescriptionAction<{
                 lowerBound: string;
                 maxLeverage: number;
-            }, "Margin tier.">]>, undefined>, v.DescriptionAction<{
+            }, "Individual tier in a margin requirements table.">]>, undefined>, v.DescriptionAction<{
                 lowerBound: string;
                 maxLeverage: number;
             }[], "Array of margin tiers defining leverage limits.">]>;
-        }, undefined>], undefined>, v.DescriptionAction<[number, {
+        }, undefined>, v.DescriptionAction<{
+            description: string;
+            marginTiers: {
+                lowerBound: string;
+                maxLeverage: number;
+            }[];
+        }, "Margin requirements table with multiple tiers.">]>], undefined>, v.DescriptionAction<[number, {
             description: string;
             marginTiers: {
                 lowerBound: string;
                 maxLeverage: number;
             }[];
-        }], "Margin requirement table.">]>, undefined>, v.DescriptionAction<[number, {
+        }], "Tuple of margin table ID and its details.">]>, undefined>, v.DescriptionAction<[number, {
             description: string;
             marginTiers: {
                 lowerBound: string;
                 maxLeverage: number;
             }[];
         }][], "Margin requirement tables for different leverage tiers.">]>;
+        readonly collateralToken: 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, "Collateral token index.">]>;
     }, undefined>, v.DescriptionAction<{
         universe: {
             szDecimals: number;
@@ -417,28 +345,19 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
                 maxLeverage: number;
             }[];
         }][];
+        collateralToken: number;
     }, "Metadata for perpetual assets.">]>;
     /** Context for each perpetual asset. */
     readonly assetCtxs: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-        /** Previous day's closing price. */
         readonly prevDayPx: 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, "Previous day's closing price.">]>;
-        /** Daily notional volume. */
         readonly dayNtlVlm: 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, "Daily notional volume.">]>;
-        /** Mark price. */
         readonly markPx: 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, "Mark price.">]>;
-        /** Mid price. */
         readonly midPx: v.SchemaWithPipe<readonly [v.NullableSchema<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>]>, undefined>, v.DescriptionAction<string | null, "Mid price.">]>;
-        /** Funding rate. */
         readonly funding: 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, "Funding rate.">]>;
-        /** Total open interest. */
         readonly openInterest: 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, "Total open interest.">]>;
-        /** Premium price. */
         readonly premium: v.SchemaWithPipe<readonly [v.NullableSchema<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>]>, undefined>, v.DescriptionAction<string | null, "Premium price.">]>;
-        /** Oracle price. */
         readonly oraclePx: 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, "Oracle price.">]>;
-        /** Array of impact prices. */
         readonly impactPxs: v.SchemaWithPipe<readonly [v.NullableSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>, v.DescriptionAction<string[] | null, "Array of impact prices.">]>;
-        /** Daily volume in base currency. */
         readonly dayBaseVlm: 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, "Daily volume in base currency.">]>;
     }, undefined>, v.DescriptionAction<{
         prevDayPx: string;
@@ -451,7 +370,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         oraclePx: string;
         impactPxs: string[] | null;
         dayBaseVlm: string;
-    }, "Perpetual asset context.">]>, undefined>, v.DescriptionAction<{
+    }, "Context for a specific perpetual asset.">]>, undefined>, v.DescriptionAction<{
         prevDayPx: string;
         dayNtlVlm: string;
         markPx: string;
@@ -462,7 +381,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         oraclePx: string;
         impactPxs: string[] | null;
         dayBaseVlm: string;
-    }[], "Context for each perpetual asset.">]>;
+    }[], "Array of contexts for each perpetual asset.">]>;
     /** Server timestamp (in ms since epoch). */
     readonly serverTime: 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, "Server timestamp (in ms since epoch).">]>;
     /** Whether this account is a vault. */
@@ -470,28 +389,18 @@ export declare const WebData2Event: 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 states. */
-    readonly twapStates: 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.ObjectSchema<{
-        /** Asset symbol. */
+    readonly twapStates: 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 coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
-        /** Executed notional value. */
         readonly executedNtl: 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, "Executed notional value.">]>;
-        /** Executed size. */
         readonly executedSz: 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, "Executed size.">]>;
-        /** Duration in minutes. */
         readonly minutes: 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, "Duration in minutes.">]>;
-        /** Indicates if the TWAP randomizes execution. */
         readonly randomize: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the TWAP randomizes execution.">]>;
-        /** Indicates if the order is reduce-only. */
         readonly reduceOnly: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the order is reduce-only.">]>;
-        /** 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).">]>;
-        /** Order 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, "Order size.">]>;
-        /** Start time of the TWAP order (in ms since epoch). */
         readonly timestamp: 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, "Start time of the TWAP order (in ms since epoch).">]>;
-        /** 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>], undefined>, v.DescriptionAction<[number, {
+    }, undefined>, v.DescriptionAction<{
         coin: string;
         executedNtl: string;
         executedSz: string;
@@ -502,7 +411,18 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         sz: string;
         timestamp: number;
         user: `0x${string}`;
-    }], "TWAP state.">]>, undefined>, v.DescriptionAction<[number, {
+    }, "State of the TWAP order.">]>], undefined>, v.DescriptionAction<[number, {
+        coin: string;
+        executedNtl: string;
+        executedSz: string;
+        minutes: number;
+        randomize: boolean;
+        reduceOnly: boolean;
+        side: "B" | "A";
+        sz: string;
+        timestamp: number;
+        user: `0x${string}`;
+    }], "TWAP ID and state.">]>, undefined>, v.DescriptionAction<[number, {
         coin: string;
         executedNtl: string;
         executedSz: string;
@@ -515,18 +435,12 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         user: `0x${string}`;
     }][], "Array of TWAP states.">]>;
     /** Account summary for spot trading. */
-    readonly spotState: v.SchemaWithPipe<readonly [v.OptionalSchema<v.ObjectSchema<{
-        /** Balance for each token. */
+    readonly spotState: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         readonly balances: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-            /** Asset symbol. */
             readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
-            /** Unique identifier for the token. */
             readonly token: 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 token.">]>;
-            /** Total balance. */
             readonly total: 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, "Total balance.">]>;
-            /** Amount on hold. */
             readonly hold: 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, "Amount on hold.">]>;
-            /** Entry notional value. */
             readonly entryNtl: 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, "Entry notional value.">]>;
         }, undefined>, v.DescriptionAction<{
             coin: string;
@@ -534,31 +448,27 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             total: string;
             hold: string;
             entryNtl: string;
-        }, "Balance for the token.">]>, undefined>, v.DescriptionAction<{
+        }, "Balance for a specific spot token.">]>, undefined>, v.DescriptionAction<{
             coin: string;
             token: number;
             total: string;
             hold: string;
             entryNtl: string;
         }[], "Balance for each token.">]>;
-        /** Escrowed balances. */
         readonly evmEscrows: v.SchemaWithPipe<readonly [v.OptionalSchema<v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-            /** Asset symbol. */
             readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
-            /** Unique identifier for the token. */
             readonly token: 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 token.">]>;
-            /** Total balance. */
             readonly total: 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, "Total balance.">]>;
         }, undefined>, v.DescriptionAction<{
             coin: string;
             token: number;
             total: string;
-        }, "Escrowed balance for the token.">]>, undefined>, undefined>, v.DescriptionAction<{
+        }, "Escrowed balance for a specific asset.">]>, undefined>, undefined>, v.DescriptionAction<{
             coin: string;
             token: number;
             total: string;
         }[] | undefined, "Escrowed balances.">]>;
-    }, undefined>, undefined>, v.DescriptionAction<{
+    }, undefined>, v.DescriptionAction<{
         balances: {
             coin: string;
             token: number;
@@ -571,24 +481,16 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             token: number;
             total: string;
         }[] | undefined;
-    } | undefined, "Account summary for spot trading.">]>;
+    }, "Account summary for spot trading.">]>;
     /** Context for each spot asset. */
     readonly spotAssetCtxs: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-        /** Previous day's closing price. */
         readonly prevDayPx: 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, "Previous day's closing price.">]>;
-        /** Daily notional volume. */
         readonly dayNtlVlm: 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, "Daily notional volume.">]>;
-        /** Mark price. */
         readonly markPx: 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, "Mark price.">]>;
-        /** Mid price. */
         readonly midPx: v.SchemaWithPipe<readonly [v.NullableSchema<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>]>, undefined>, v.DescriptionAction<string | null, "Mid price.">]>;
-        /** Circulating supply. */
         readonly circulatingSupply: 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, "Circulating supply.">]>;
-        /** Asset symbol. */
         readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
-        /** Total supply. */
         readonly totalSupply: 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, "Total supply.">]>;
-        /** Daily volume in base currency. */
         readonly dayBaseVlm: 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, "Daily volume in base currency.">]>;
     }, undefined>, v.DescriptionAction<{
         prevDayPx: string;
@@ -599,7 +501,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         coin: string;
         totalSupply: string;
         dayBaseVlm: string;
-    }, "Spot asset context.">]>, undefined>, v.DescriptionAction<{
+    }, "Context for a specific spot asset.">]>, undefined>, v.DescriptionAction<{
         prevDayPx: string;
         dayNtlVlm: string;
         markPx: string;
@@ -674,7 +576,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         triggerCondition: string;
         isTrigger: boolean;
         triggerPx: string;
-        children: any;
+        children: any[];
         isPositionTpsl: boolean;
         reduceOnly: boolean;
         orderType: "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
@@ -700,6 +602,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
                 maxLeverage: number;
             }[];
         }][];
+        collateralToken: number;
     };
     assetCtxs: {
         prevDayPx: string;
@@ -728,7 +631,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
         timestamp: number;
         user: `0x${string}`;
     }][];
-    spotState?: {
+    spotState: {
         balances: {
             coin: string;
             token: number;
@@ -741,7 +644,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
             token: number;
             total: string;
         }[] | undefined;
-    } | undefined;
+    };
     spotAssetCtxs: {
         prevDayPx: string;
         dayNtlVlm: string;
@@ -754,7 +657,7 @@ export declare const WebData2Event: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     }[];
     optOutOfSpotDusting?: true | undefined;
     perpsAtOpenInterestCap?: string[] | undefined;
-}, "Event of comprehensive user and market data.">]>;
+}, "Comprehensive user and market data.">]>;
 export type WebData2Event = v.InferOutput<typeof WebData2Event>;
 /** Request parameters for the {@linkcode webData2} function. */
 export type WebData2Parameters = Omit<v.InferInput<typeof WebData2Request>, "type">;

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,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,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;;QAGzC,8BAA8B;;YAG1B,2BAA2B;;YAK3B,qCAAqC;;YAKrC,2BAA2B;;YAK3B,yBAAyB;;;;;;;;QAQ7B,oCAAoC;;YAGhC,2BAA2B;;YAK3B,qCAAqC;;YAKrC,2BAA2B;;YAK3B,yBAAyB;;;;;;;;QAQ7B,0DAA0D;;QAK1D,uCAAuC;;QAKvC,gCAAgC;;YAMxB,qBAAqB;;YAKrB,wBAAwB;;gBAGpB,oBAAoB;;gBAKpB,4BAA4B;;gBAK5B,wBAAwB;;oBAIlB,qBAAqB;;oBAKrB,2BAA2B;;oBAM3B,mCAAmC;;;oBAOnC,qBAAqB;;oBAKrB,2BAA2B;;;;;;;;;;gBAUjC,2BAA2B;;gBAK3B,sBAAsB;;gBAKtB,kCAAkC;;gBAKlC,wBAAwB;;gBAKxB,yBAAyB;;gBAKzB,mBAAmB;;gBAKnB,gCAAgC;;gBAMhC,kCAAkC;;oBAG9B,4DAA4D;;oBAK5D,yDAAyD;;oBAKzD,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAiBlF,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAQjE,+BAA+B;;QAMvB,4BAA4B;;QAK5B,yBAAyB;;;;;;;;;IAWjC,8BAA8B;;IAK9B,2DAA2D;;QAMnD,oBAAoB;;QAKpB,kDAAkD;;QAKlD,mBAAmB;;QAKnB,YAAY;;QAKZ,gBAAgB;;QAKhB,+DAA+D;;QAK/D,wCAAwC;;QAKxC,0CAA0C;;QAK1C,iDAAiD;;QAKjD,qBAAqB;;QAKrB,+CAA+C;;QAM/C,wDAAwD;;QAKxD,kDAAkD;;QAKlD;;;;;;;;;WASG;;QAoBH;;;;;;;WAOG;;QAqBH,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAW/B,mCAAmC;;IAKnC,gDAAgD;;IAKhD,+BAA+B;;IAK/B,qCAAqC;;QAGjC,yDAAyD;;YAMjD,8CAA8C;;YAK9C,4BAA4B;;YAK5B,gCAAgC;;YAMhC,2DAA2D;;YAK3D,4DAA4D;;YAK5D,6CAA6C;;;;;;;;;;;;;;;;;QAWrD,8DAA8D;;YAQpD,uCAAuC;;YAKvC,sDAAsD;;gBAM9C,kDAAkD;;gBAKlD,8CAA8C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAsBpE,wCAAwC;;QAMhC,oCAAoC;;QAKpC,6BAA6B;;QAK7B,kBAAkB;;QAKlB,iBAAiB;;QAKjB,oBAAoB;;QAKpB,2BAA2B;;QAK3B,qBAAqB;;QAKrB,oBAAoB;;QAKpB,8BAA8B;;QAK9B,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;IAW7C,4CAA4C;;IAK5C,uCAAuC;;IAKvC,oBAAoB;;IAKpB,4BAA4B;;QAQlB,oBAAoB;;QAKpB,+BAA+B;;QAK/B,qBAAqB;;QAKrB,2BAA2B;;QAK3B,kDAAkD;;QAKlD,6CAA6C;;QAK7C,kDAAkD;;QAKlD,kBAAkB;;QAKlB,wDAAwD;;QAKxD,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;IAY9B,wCAAwC;;QAIlC,8BAA8B;;YAMtB,oBAAoB;;YAKpB,uCAAuC;;YAKvC,qBAAqB;;YAKrB,sBAAsB;;YAKtB,4BAA4B;;;;;;;;;;;;;;;QAWpC,yBAAyB;;YAOf,oBAAoB;;YAKpB,uCAAuC;;YAKvC,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;IAgBrC,mCAAmC;;QAM3B,oCAAoC;;QAKpC,6BAA6B;;QAK7B,kBAAkB;;QAKlB,iBAAiB;;QAKjB,0BAA0B;;QAK1B,oBAAoB;;QAKpB,oBAAoB;;QAKpB,qCAAqC;;;;;;;;;;;;;;;;;;;;;IAW7C,sDAAsD;;IAKtD,mDAAmD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oDAQrD,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,YAAY,CAAC;AAC5D,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"}