@hfunlabs/hyperliquid 0.29.1-hfunlabs.1 → 0.30.2-hfunlabs.2

package/script/src/api/info/_methods/_base/commonSchemas.d.ts

@@ -0,0 +1,343 @@
+import * as v from "valibot";
+/** Perpetual asset context. */
+export declare const PerpAssetCtxSchema: 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Daily volume in base currency.">]>;
+}, undefined>, v.DescriptionAction<{
+    prevDayPx: string;
+    dayNtlVlm: string;
+    markPx: string;
+    midPx: string | null;
+    funding: string;
+    openInterest: string;
+    premium: string | null;
+    oraclePx: string;
+    impactPxs: string[] | null;
+    dayBaseVlm: string;
+}, "Perpetual asset context.">]>;
+export type PerpAssetCtxSchema = v.InferOutput<typeof PerpAssetCtxSchema>;
+/** Spot asset context. */
+export declare const SpotAssetCtxSchema: 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Daily volume in base currency.">]>;
+}, undefined>, v.DescriptionAction<{
+    prevDayPx: string;
+    dayNtlVlm: string;
+    markPx: string;
+    midPx: string | null;
+    circulatingSupply: string;
+    coin: string;
+    totalSupply: string;
+    dayBaseVlm: string;
+}, "Spot asset context.">]>;
+export type SpotAssetCtxSchema = v.InferOutput<typeof SpotAssetCtxSchema>;
+/** Open order with additional display information. */
+export declare const FrontendOpenOrderSchema: 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.PicklistSchema<["B", "A"], undefined>, v.DescriptionAction<"A" | "B", "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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Limit price.">]>;
+    /** Size. */
+    readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Size.">]>;
+    /** Order ID. */
+    readonly oid: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, 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.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Trigger price.">]>;
+    /** Child orders associated with this order. */
+    readonly children: v.SchemaWithPipe<readonly [v.ArraySchema<v.UnknownSchema, undefined>, v.DescriptionAction<unknown[], "Child orders associated with this order.">]>;
+    /** Indicates if the order is a position TP/SL 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.PicklistSchema<["Market", "Limit", "Stop Market", "Stop Limit", "Take Profit Market", "Take Profit Limit"], undefined>, v.DescriptionAction<"Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit", string>]>;
+    /**
+     * Time-in-force:
+     * - `"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.NullableSchema<v.PicklistSchema<["Gtc", "Ioc", "Alo", "FrontendMarket", "LiquidationMarket"], undefined>, undefined>, v.DescriptionAction<"Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null, string>]>;
+    /** Client Order ID. */
+    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: "A" | "B";
+    limitPx: string;
+    sz: string;
+    oid: number;
+    timestamp: number;
+    origSz: string;
+    triggerCondition: string;
+    isTrigger: boolean;
+    triggerPx: string;
+    children: unknown[];
+    isPositionTpsl: boolean;
+    reduceOnly: boolean;
+    orderType: "Market" | "Limit" | "Stop Market" | "Stop Limit" | "Take Profit Market" | "Take Profit Limit";
+    tif: "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket" | null;
+    cloid: `0x${string}` | null;
+}, "Open order with additional display information.">]>;
+export type FrontendOpenOrderSchema = v.InferOutput<typeof FrontendOpenOrderSchema>;
+/** Open order. */
+export declare const OpenOrderSchema: 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.PicklistSchema<["B", "A"], undefined>, v.DescriptionAction<"A" | "B", "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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Limit price.">]>;
+    /** Size. */
+    readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Size.">]>;
+    /** Order ID. */
+    readonly oid: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, 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.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Original size at order placement.">]>;
+    /** Client Order ID. */
+    readonly cloid: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 34, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | undefined, "Client Order ID.">]>;
+    /** Indicates if the order is reduce-only. */
+    readonly reduceOnly: v.SchemaWithPipe<readonly [v.OptionalSchema<v.LiteralSchema<true, undefined>, undefined>, v.DescriptionAction<true | undefined, "Indicates if the order is reduce-only.">]>;
+}, undefined>, v.DescriptionAction<{
+    coin: string;
+    side: "A" | "B";
+    limitPx: string;
+    sz: string;
+    oid: number;
+    timestamp: number;
+    origSz: string;
+    cloid?: `0x${string}` | undefined;
+    reduceOnly?: true | undefined;
+}, "Open order.">]>;
+export type OpenOrderSchema = v.InferOutput<typeof OpenOrderSchema>;
+/** TWAP order state. */
+export declare const TwapStateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Asset symbol. */
+    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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, 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.PicklistSchema<["B", "A"], undefined>, v.DescriptionAction<"A" | "B", "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.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, 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.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, 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>, v.DescriptionAction<{
+    coin: string;
+    executedNtl: string;
+    executedSz: string;
+    minutes: number;
+    randomize: boolean;
+    reduceOnly: boolean;
+    side: "A" | "B";
+    sz: string;
+    timestamp: number;
+    user: `0x${string}`;
+}, "TWAP order state.">]>;
+export type TwapStateSchema = v.InferOutput<typeof TwapStateSchema>;
+/** Vault relationship type. */
+export declare const VaultRelationshipSchema: v.SchemaWithPipe<readonly [v.VariantSchema<"type", [v.ObjectSchema<{
+    /** Relationship type. */
+    readonly type: v.SchemaWithPipe<readonly [v.PicklistSchema<["normal", "child"], undefined>, v.DescriptionAction<"normal" | "child", "Relationship type.">]>;
+}, undefined>, v.ObjectSchema<{
+    /** Relationship type. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"parent", undefined>, v.DescriptionAction<"parent", "Relationship type.">]>;
+    /** Child vault information. */
+    readonly data: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Child vault addresses. */
+        readonly childAddresses: v.SchemaWithPipe<readonly [v.ArraySchema<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}`[], "Child vault addresses.">]>;
+    }, undefined>, v.DescriptionAction<{
+        childAddresses: `0x${string}`[];
+    }, "Child vault information.">]>;
+}, undefined>], undefined>, v.DescriptionAction<{
+    type: "normal" | "child";
+} | {
+    type: "parent";
+    data: {
+        childAddresses: `0x${string}`[];
+    };
+}, "Vault relationship type.">]>;
+export type VaultRelationshipSchema = v.InferOutput<typeof VaultRelationshipSchema>;
+/** Explorer transaction. */
+export declare const ExplorerTransactionSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Action performed in transaction. */
+    readonly action: v.SchemaWithPipe<readonly [v.LooseObjectSchema<{
+        /** Action type. */
+        readonly type: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Action type.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: string;
+    } & {
+        [key: string]: unknown;
+    }, "Action performed in transaction.">]>;
+    /** Block number where transaction was included. */
+    readonly block: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Block number where transaction was included.">]>;
+    /** Error message if transaction failed. */
+    readonly error: v.SchemaWithPipe<readonly [v.NullableSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | null, "Error message if transaction failed.">]>;
+    /** Transaction hash. */
+    readonly hash: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>, v.DescriptionAction<`0x${string}`, "Transaction hash.">]>;
+    /** Transaction creation timestamp. */
+    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Transaction creation timestamp.">]>;
+    /** Creator's 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}`, "Creator's address.">]>;
+}, undefined>, v.DescriptionAction<{
+    action: {
+        type: string;
+    } & {
+        [key: string]: unknown;
+    };
+    block: number;
+    error: string | null;
+    hash: `0x${string}`;
+    time: number;
+    user: `0x${string}`;
+}, "Explorer transaction.">]>;
+export type ExplorerTransactionSchema = v.InferOutput<typeof ExplorerTransactionSchema>;
+/** User fill. */
+export declare const UserFillSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Asset symbol. */
+    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+    /** Price. */
+    readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Price.">]>;
+    /** Size. */
+    readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Size.">]>;
+    /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+    readonly side: v.SchemaWithPipe<readonly [v.PicklistSchema<["B", "A"], undefined>, v.DescriptionAction<"A" | "B", "Order side (\"B\" = Bid/Buy, \"A\" = Ask/Sell).">]>;
+    /** Timestamp when the trade occurred (in ms since epoch). */
+    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Timestamp when the trade occurred (in ms since epoch).">]>;
+    /** Start position size. */
+    readonly startPosition: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Start position size.">]>;
+    /** Direction indicator for frontend display. */
+    readonly dir: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Direction indicator for frontend display.">]>;
+    /** Realized PnL. */
+    readonly closedPnl: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Realized PnL.">]>;
+    /** L1 transaction hash. */
+    readonly hash: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>, v.DescriptionAction<`0x${string}`, "L1 transaction hash.">]>;
+    /** Order ID. */
+    readonly oid: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Order ID.">]>;
+    /** Indicates if the fill was a taker order. */
+    readonly crossed: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the fill was a taker order.">]>;
+    /** Fee charged or rebate received (negative indicates rebate). */
+    readonly fee: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Fee charged or rebate received (negative indicates rebate).">]>;
+    /** Unique transaction identifier for a partial fill of an order. */
+    readonly tid: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique transaction identifier for a partial fill of an order.">]>;
+    /** Token in which the fee is denominated (e.g., "USDC"). */
+    readonly feeToken: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Token in which the fee is denominated (e.g., \"USDC\").">]>;
+    /** ID of the TWAP. */
+    readonly twapId: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null, "ID of the TWAP.">]>;
+}, undefined>, v.DescriptionAction<{
+    coin: string;
+    px: string;
+    sz: string;
+    side: "A" | "B";
+    time: number;
+    startPosition: string;
+    dir: string;
+    closedPnl: string;
+    hash: `0x${string}`;
+    oid: number;
+    crossed: boolean;
+    fee: string;
+    tid: number;
+    feeToken: string;
+    twapId: number | null;
+}, "User fill.">]>;
+export type UserFillSchema = v.InferOutput<typeof UserFillSchema>;
+/**
+ * Order processing status:
+ * - `"open"`: Order active and waiting to be filled.
+ * - `"filled"`: Order fully executed.
+ * - `"canceled"`: Order canceled by the user.
+ * - `"triggered"`: Order triggered and awaiting execution.
+ * - `"rejected"`: Order rejected by the system.
+ * - `"marginCanceled"`: Order canceled due to insufficient margin.
+ * - `"vaultWithdrawalCanceled"`: Canceled due to a user withdrawal from vault.
+ * - `"openInterestCapCanceled"`: Canceled due to order being too aggressive when open interest was at cap.
+ * - `"selfTradeCanceled"`: Canceled due to self-trade prevention.
+ * - `"reduceOnlyCanceled"`: Canceled reduced-only order that does not reduce position.
+ * - `"siblingFilledCanceled"`: Canceled due to sibling ordering being filled.
+ * - `"delistedCanceled"`: Canceled due to asset delisting.
+ * - `"liquidatedCanceled"`: Canceled due to liquidation.
+ * - `"scheduledCancel"`: Canceled due to exceeding scheduled cancel deadline (dead man's switch).
+ * - `"tickRejected"`: Rejected due to invalid tick price.
+ * - `"minTradeNtlRejected"`: Rejected due to order notional below minimum.
+ * - `"perpMarginRejected"`: Rejected due to insufficient margin.
+ * - `"reduceOnlyRejected"`: Rejected due to reduce only.
+ * - `"badAloPxRejected"`: Rejected due to post-only immediate match.
+ * - `"iocCancelRejected"`: Rejected due to IOC not able to match.
+ * - `"badTriggerPxRejected"`: Rejected due to invalid TP/SL price.
+ * - `"marketOrderNoLiquidityRejected"`: Rejected due to lack of liquidity for market order.
+ * - `"positionIncreaseAtOpenInterestCapRejected"`: Rejected due to open interest cap.
+ * - `"positionFlipAtOpenInterestCapRejected"`: Rejected due to open interest cap.
+ * - `"tooAggressiveAtOpenInterestCapRejected"`: Rejected due to price too aggressive at open interest cap.
+ * - `"openInterestIncreaseRejected"`: Rejected due to open interest cap.
+ * - `"insufficientSpotBalanceRejected"`: Rejected due to insufficient spot balance.
+ * - `"oracleRejected"`: Rejected due to price too far from oracle.
+ * - `"perpMaxPositionRejected"`: Rejected due to exceeding margin tier limit at current leverage.
+ */
+export declare const OrderProcessingStatusSchema: v.SchemaWithPipe<readonly [v.PicklistSchema<["open", "filled", "canceled", "triggered", "rejected", "marginCanceled", "vaultWithdrawalCanceled", "openInterestCapCanceled", "selfTradeCanceled", "reduceOnlyCanceled", "siblingFilledCanceled", "delistedCanceled", "liquidatedCanceled", "scheduledCancel", "tickRejected", "minTradeNtlRejected", "perpMarginRejected", "reduceOnlyRejected", "badAloPxRejected", "iocCancelRejected", "badTriggerPxRejected", "marketOrderNoLiquidityRejected", "positionIncreaseAtOpenInterestCapRejected", "positionFlipAtOpenInterestCapRejected", "tooAggressiveAtOpenInterestCapRejected", "openInterestIncreaseRejected", "insufficientSpotBalanceRejected", "oracleRejected", "perpMaxPositionRejected"], undefined>, v.DescriptionAction<"open" | "filled" | "canceled" | "triggered" | "rejected" | "marginCanceled" | "vaultWithdrawalCanceled" | "openInterestCapCanceled" | "selfTradeCanceled" | "reduceOnlyCanceled" | "siblingFilledCanceled" | "delistedCanceled" | "liquidatedCanceled" | "scheduledCancel" | "tickRejected" | "minTradeNtlRejected" | "perpMarginRejected" | "reduceOnlyRejected" | "badAloPxRejected" | "iocCancelRejected" | "badTriggerPxRejected" | "marketOrderNoLiquidityRejected" | "positionIncreaseAtOpenInterestCapRejected" | "positionFlipAtOpenInterestCapRejected" | "tooAggressiveAtOpenInterestCapRejected" | "openInterestIncreaseRejected" | "insufficientSpotBalanceRejected" | "oracleRejected" | "perpMaxPositionRejected", string>]>;
+export type OrderProcessingStatusSchema = v.InferOutput<typeof OrderProcessingStatusSchema>;
+//# sourceMappingURL=commonSchemas.d.ts.map

package/script/src/api/info/_methods/_base/commonSchemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commonSchemas.d.ts","sourceRoot":"","sources":["../../../../../../src/src/api/info/_methods/_base/commonSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAG7B,+BAA+B;AAC/B,eAAO,MAAM,kBAAkB;IAGzB,oCAAoC;;IAKpC,6BAA6B;;IAK7B,kBAAkB;;IAKlB,iBAAiB;;IAKjB,oBAAoB;;IAKpB,2BAA2B;;IAK3B,qBAAqB;;IAKrB,oBAAoB;;IAKpB,8BAA8B;;IAK9B,qCAAqC;;;;;;;;;;;;;gCAQvC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E,0BAA0B;AAC1B,eAAO,MAAM,kBAAkB;IAGzB,oCAAoC;;IAKpC,6BAA6B;;IAK7B,kBAAkB;;IAKlB,iBAAiB;;IAKjB,0BAA0B;;IAK1B,oBAAoB;;IAKpB,oBAAoB;;IAKpB,qCAAqC;;;;;;;;;;;2BAQvC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E,sDAAsD;AACtD,eAAO,MAAM,uBAAuB;IAG9B,oBAAoB;;IAKpB,kDAAkD;;IAKlD,mBAAmB;;IAKnB,YAAY;;IAKZ,gBAAgB;;IAKhB,+DAA+D;;IAK/D,wCAAwC;;IAKxC,0CAA0C;;IAK1C,iDAAiD;;IAKjD,qBAAqB;;IAKrB,+CAA+C;;IAK/C,wDAAwD;;IAKxD,kDAAkD;;IAKlD;;;;;;;;;OASG;;IAoBH;;;;;;;OAOG;;IAkBH,uBAAuB;;;;;;;;;;;;;;;;;;;uDAQzB,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAEpF,kBAAkB;AAClB,eAAO,MAAM,eAAe;IAGtB,oBAAoB;;IAKpB,kDAAkD;;IAKlD,mBAAmB;;IAKnB,YAAY;;IAKZ,gBAAgB;;IAKhB,+DAA+D;;IAK/D,wCAAwC;;IAKxC,uBAAuB;;IAKvB,6CAA6C;;;;;;;;;;;;mBAQ/C,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE,wBAAwB;AACxB,eAAO,MAAM,eAAe;IAGtB,oBAAoB;;IAKpB,+BAA+B;;IAK/B,qBAAqB;;IAKrB,2BAA2B;;IAK3B,kDAAkD;;IAKlD,6CAA6C;;IAK7C,kDAAkD;;IAKlD,kBAAkB;;IAKlB,wDAAwD;;IAKxD,oBAAoB;;;;;;;;;;;;;yBAQtB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE,+BAA+B;AAC/B,eAAO,MAAM,uBAAuB;IAI5B,yBAAyB;;;IAOzB,yBAAyB;;IAKzB,+BAA+B;;QAG3B,6BAA6B;;;;;;;;;;;;gCAYrC,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAEpF,4BAA4B;AAC5B,eAAO,MAAM,yBAAyB;IAGhC,uCAAuC;;QAGnC,mBAAmB;;;;;;;IAQvB,mDAAmD;;IAKnD,2CAA2C;;IAK3C,wBAAwB;;IAMxB,sCAAsC;;IAKtC,yBAAyB;;;;;;;;;;;;;6BAQ3B,CAAC;AACL,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAExF,iBAAiB;AACjB,eAAO,MAAM,cAAc;IAGrB,oBAAoB;;IAKpB,aAAa;;IAKb,YAAY;;IAKZ,kDAAkD;;IAKlD,6DAA6D;;IAK7D,2BAA2B;;IAK3B,gDAAgD;;IAKhD,oBAAoB;;IAKpB,2BAA2B;;IAM3B,gBAAgB;;IAKhB,+CAA+C;;IAK/C,kEAAkE;;IAKlE,oEAAoE;;IAKpE,4DAA4D;;IAK5D,sBAAsB;;;;;;;;;;;;;;;;;;kBAQxB,CAAC;AACL,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,2BAA2B,i8CAkEpC,CAAC;AACL,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,2BAA2B,CAAC,CAAC"}