@nktkas/hyperliquid 0.25.1 → 0.25.3

package/src/src/api/info/subAccounts.ts

@@ -1,6 +1,9 @@
 import * as v from "valibot";
-import { Address, Decimal, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+import { ClearinghouseStateResponse } from "./clearinghouseState.js";
+import { SpotClearinghouseStateResponse } from "./spotClearinghouseState.js";
 
 // -------------------- Schemas --------------------
 
@@ -55,277 +58,9 @@ export const SubAccountsResponse = /* @__PURE__ */ (() => {
               v.description("Master account address."),
             ),
             /** Perpetual trading clearinghouse state summary. */
-            clearinghouseState: v.pipe(
-              v.object({
-                /** Margin summary details. */
-                marginSummary: v.pipe(
-                  v.object({
-                    /** Total account value. */
-                    accountValue: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Total account value."),
-                    ),
-                    /** Total notional position value. */
-                    totalNtlPos: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Total notional position value."),
-                    ),
-                    /** Total raw USD value. */
-                    totalRawUsd: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Total raw USD value."),
-                    ),
-                    /** Total margin used. */
-                    totalMarginUsed: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Total margin used."),
-                    ),
-                  }),
-                  v.description("Margin summary details."),
-                ),
-                /** Cross-margin summary details. */
-                crossMarginSummary: v.pipe(
-                  v.object({
-                    /** Total account value. */
-                    accountValue: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Total account value."),
-                    ),
-                    /** Total notional position value. */
-                    totalNtlPos: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Total notional position value."),
-                    ),
-                    /** Total raw USD value. */
-                    totalRawUsd: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Total raw USD value."),
-                    ),
-                    /** Total margin used. */
-                    totalMarginUsed: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Total margin used."),
-                    ),
-                  }),
-                  v.description("Cross-margin summary details."),
-                ),
-                /** Maintenance margin used for cross-margin positions. */
-                crossMaintenanceMarginUsed: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Maintenance margin used for cross-margin positions."),
-                ),
-                /** Amount available for withdrawal. */
-                withdrawable: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Amount available for withdrawal."),
-                ),
-                /** Array of asset positions. */
-                assetPositions: v.pipe(
-                  v.array(
-                    /** Position for a specific asset. */
-                    v.pipe(
-                      v.object({
-                        /** Position type. */
-                        type: v.pipe(
-                          v.literal("oneWay"),
-                          v.description("Position type."),
-                        ),
-                        /** Position details. */
-                        position: v.pipe(
-                          v.object({
-                            /** Asset symbol. */
-                            coin: v.pipe(
-                              v.string(),
-                              v.description("Asset symbol."),
-                            ),
-                            /** Signed position size. */
-                            szi: v.pipe(
-                              Decimal,
-                              v.description("Signed position size."),
-                            ),
-                            /** Leverage details. */
-                            leverage: v.pipe(
-                              v.union([
-                                v.object({
-                                  /** Leverage type. */
-                                  type: v.pipe(
-                                    v.literal("isolated"),
-                                    v.description("Leverage type."),
-                                  ),
-                                  /** Leverage value used. */
-                                  value: v.pipe(
-                                    UnsignedInteger,
-                                    v.minValue(1),
-                                    v.description("Leverage value used."),
-                                  ),
-                                  /** Amount of USD used (1 = 1$). */
-                                  rawUsd: v.pipe(
-                                    UnsignedDecimal,
-                                    v.description("Amount of USD used (1 = 1$)."),
-                                  ),
-                                }),
-                                v.object({
-                                  /** Leverage type. */
-                                  type: v.pipe(
-                                    v.literal("cross"),
-                                    v.description("Leverage type."),
-                                  ),
-                                  /** Leverage value used. */
-                                  value: v.pipe(
-                                    UnsignedInteger,
-                                    v.minValue(1),
-                                    v.description("Leverage value used."),
-                                  ),
-                                }),
-                              ]),
-                              v.description("Leverage details."),
-                            ),
-                            /** Average entry price. */
-                            entryPx: v.pipe(
-                              UnsignedDecimal,
-                              v.description("Average entry price."),
-                            ),
-                            /** Position value. */
-                            positionValue: v.pipe(
-                              UnsignedDecimal,
-                              v.description("Position value."),
-                            ),
-                            /** Unrealized profit and loss. */
-                            unrealizedPnl: v.pipe(
-                              Decimal,
-                              v.description("Unrealized profit and loss."),
-                            ),
-                            /** Return on equity. */
-                            returnOnEquity: v.pipe(
-                              Decimal,
-                              v.description("Return on equity."),
-                            ),
-                            /** Liquidation price. */
-                            liquidationPx: v.pipe(
-                              v.union([UnsignedDecimal, v.null()]),
-                              v.description("Liquidation price."),
-                            ),
-                            /** Margin used. */
-                            marginUsed: v.pipe(
-                              UnsignedDecimal,
-                              v.description("Margin used."),
-                            ),
-                            /** Maximum allowed leverage. */
-                            maxLeverage: v.pipe(
-                              UnsignedInteger,
-                              v.minValue(1),
-                              v.description("Maximum allowed leverage."),
-                            ),
-                            /** Cumulative funding details. */
-                            cumFunding: v.pipe(
-                              v.object({
-                                /** Total funding paid or received since account opening. */
-                                allTime: v.pipe(
-                                  Decimal,
-                                  v.description("Total funding paid or received since account opening."),
-                                ),
-                                /** Funding accumulated since the position was opened. */
-                                sinceOpen: v.pipe(
-                                  Decimal,
-                                  v.description("Funding accumulated since the position was opened."),
-                                ),
-                                /** Funding accumulated since the last change in position size. */
-                                sinceChange: v.pipe(
-                                  Decimal,
-                                  v.description("Funding accumulated since the last change in position size."),
-                                ),
-                              }),
-                              v.description("Cumulative funding details."),
-                            ),
-                          }),
-                          v.description("Position details."),
-                        ),
-                      }),
-                      v.description("Position for a specific asset."),
-                    ),
-                  ),
-                  v.description("Array of asset positions."),
-                ),
-                /** Timestamp when data was retrieved (in ms since epoch). */
-                time: v.pipe(
-                  UnsignedInteger,
-                  v.description("Timestamp when data was retrieved (in ms since epoch)."),
-                ),
-              }),
-              v.description("Perpetual trading clearinghouse state summary."),
-            ),
+            clearinghouseState: ClearinghouseStateResponse,
             /** Spot tokens clearinghouse state. */
-            spotState: v.pipe(
-              v.object({
-                /** Balance for each token. */
-                balances: v.pipe(
-                  v.array(
-                    /** Balance for a specific spot token. */
-                    v.pipe(
-                      v.object({
-                        /** Asset symbol. */
-                        coin: v.pipe(
-                          v.string(),
-                          v.description("Asset symbol."),
-                        ),
-                        /** Unique identifier for the token. */
-                        token: v.pipe(
-                          UnsignedInteger,
-                          v.description("Unique identifier for the token."),
-                        ),
-                        /** Total balance. */
-                        total: v.pipe(
-                          UnsignedDecimal,
-                          v.description("Total balance."),
-                        ),
-                        /** Amount on hold. */
-                        hold: v.pipe(
-                          UnsignedDecimal,
-                          v.description("Amount on hold."),
-                        ),
-                        /** Entry notional value. */
-                        entryNtl: v.pipe(
-                          UnsignedDecimal,
-                          v.description("Entry notional value."),
-                        ),
-                      }),
-                      v.description("Balance for a specific spot token."),
-                    ),
-                  ),
-                  v.description("Balance for each token."),
-                ),
-                /** Escrowed balances. */
-                evmEscrows: v.pipe(
-                  v.optional(
-                    v.array(
-                      /** Escrowed balance for a specific asset. */
-                      v.pipe(
-                        v.object({
-                          /** Asset symbol. */
-                          coin: v.pipe(
-                            v.string(),
-                            v.description("Asset symbol."),
-                          ),
-                          /** Unique identifier for the token. */
-                          token: v.pipe(
-                            UnsignedInteger,
-                            v.description("Unique identifier for the token."),
-                          ),
-                          /** Total balance. */
-                          total: v.pipe(
-                            UnsignedDecimal,
-                            v.description("Total balance."),
-                          ),
-                        }),
-                        v.description("Escrowed balance for a specific asset."),
-                      ),
-                    ),
-                  ),
-                  v.description("Escrowed balances."),
-                ),
-              }),
-              v.description("Spot tokens clearinghouse state."),
-            ),
+            spotState: SpotClearinghouseStateResponse,
           }),
           v.description("Sub-account details for a user."),
         ),

package/src/src/api/info/tokenDetails.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
 
 // -------------------- Schemas --------------------
 

package/src/src/api/info/twapHistory.ts

@@ -1,6 +1,8 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+import { TwapStateSchema, TwapStatusSchema } from "../_common_schemas.js";
 
 // -------------------- Schemas --------------------
 
@@ -43,101 +45,13 @@ export const TwapHistoryResponse = /* @__PURE__ */ (() => {
             v.description("Creation time of the history record (in seconds since epoch)."),
           ),
           /** State of the TWAP order. */
-          state: v.pipe(
-            v.object({
-              /** Asset symbol. */
-              coin: v.pipe(
-                v.string(),
-                v.description("Asset symbol."),
-              ),
-              /** Executed notional value. */
-              executedNtl: v.pipe(
-                UnsignedDecimal,
-                v.description("Executed notional value."),
-              ),
-              /** Executed size. */
-              executedSz: v.pipe(
-                UnsignedDecimal,
-                v.description("Executed size."),
-              ),
-              /** Duration in minutes. */
-              minutes: v.pipe(
-                UnsignedInteger,
-                v.description("Duration in minutes."),
-              ),
-              /** Indicates if the TWAP randomizes execution. */
-              randomize: v.pipe(
-                v.boolean(),
-                v.description("Indicates if the TWAP randomizes execution."),
-              ),
-              /** Indicates if the order is reduce-only. */
-              reduceOnly: v.pipe(
-                v.boolean(),
-                v.description("Indicates if the order is reduce-only."),
-              ),
-              /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
-              side: v.pipe(
-                v.union([v.literal("B"), v.literal("A")]),
-                v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).'),
-              ),
-              /** Order size. */
-              sz: v.pipe(
-                UnsignedDecimal,
-                v.description("Order size."),
-              ),
-              /** Start time of the TWAP order (in ms since epoch). */
-              timestamp: v.pipe(
-                UnsignedInteger,
-                v.description("Start time of the TWAP order (in ms since epoch)."),
-              ),
-              /** User address. */
-              user: v.pipe(
-                Address,
-                v.description("User address."),
-              ),
-            }),
-            v.description("State of the TWAP order."),
-          ),
-          /**
-           * Current status of the TWAP order.
-           * - `"finished"`: Fully executed.
-           * - `"activated"`: Active and executing.
-           * - `"terminated"`: Terminated.
-           * - `"error"`: An error occurred.
-           */
-          status: v.pipe(
-            v.union([
-              v.object({
-                /** Status of the TWAP order. */
-                status: v.pipe(
-                  v.union([
-                    v.literal("finished"),
-                    v.literal("activated"),
-                    v.literal("terminated"),
-                  ]),
-                  v.description("Status of the TWAP order."),
-                ),
-              }),
-              v.object({
-                /** Status of the TWAP order. */
-                status: v.pipe(
-                  v.literal("error"),
-                  v.description("Status of the TWAP order."),
-                ),
-                /** Error message. */
-                description: v.pipe(
-                  v.string(),
-                  v.description("Error message."),
-                ),
-              }),
-            ]),
-            v.description(
-              "Current status of the TWAP order." +
-                '\n- `"finished"`: Fully executed. ' +
-                '\n- `"activated"`: Active and executing. ' +
-                '\n- `"terminated"`: Terminated. ' +
-                '\n- `"error"`: An error occurred.',
-            ),
+          state: TwapStateSchema,
+          /** Current status of the TWAP order. */
+          status: TwapStatusSchema,
+          /** ID of the TWAP. */
+          twapId: v.pipe(
+            v.optional(UnsignedInteger),
+            v.description("ID of the TWAP."),
           ),
         }),
         v.description("TWAP history record."),

package/src/src/api/info/txDetails.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
 import type { IRequestTransport } from "../../transport/base.js";
 
 // -------------------- Schemas --------------------

package/src/src/api/info/userDetails.ts

@@ -1,8 +1,10 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
 import type { IRequestTransport } from "../../transport/base.js";
 
+import { TxDetailsResponse } from "./txDetails.js";
+
 // -------------------- Schemas --------------------
 
 /**
@@ -42,50 +44,7 @@ export const UserDetailsResponse = /* @__PURE__ */ (() => {
       ),
       /** Array of user transaction details. */
       txs: v.pipe(
-        v.array(
-          /** Transaction details. */
-          v.pipe(
-            v.object({
-              /** Action performed in transaction. */
-              action: v.pipe(
-                v.looseObject({
-                  /** Action type. */
-                  type: v.pipe(
-                    v.string(),
-                    v.description("Action type."),
-                  ),
-                }),
-                v.description("Action performed in transaction."),
-              ),
-              /** Block number where transaction was included. */
-              block: v.pipe(
-                UnsignedInteger,
-                v.description("Block number where transaction was included."),
-              ),
-              /** Error message if transaction failed. */
-              error: v.pipe(
-                v.nullable(v.string()),
-                v.description("Error message if transaction failed."),
-              ),
-              /** Transaction hash. */
-              hash: v.pipe(
-                v.pipe(Hex, v.length(66)),
-                v.description("Transaction hash."),
-              ),
-              /** Transaction creation timestamp. */
-              time: v.pipe(
-                UnsignedInteger,
-                v.description("Transaction creation timestamp."),
-              ),
-              /** Creator's address. */
-              user: v.pipe(
-                Address,
-                v.description("Creator's address."),
-              ),
-            }),
-            v.description("Transaction details."),
-          ),
-        ),
+        v.array(TxDetailsResponse.entries.tx),
         v.description("Array of user transaction details."),
       ),
     }),

package/src/src/api/info/userFees.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { Address, Decimal, type DeepImmutable, parser, UnsignedDecimal } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, Decimal, type DeepImmutable, parser, UnsignedDecimal } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
 
 // -------------------- Schemas --------------------
 
@@ -212,20 +212,20 @@ export const UserFeesResponse = /* @__PURE__ */ (() => {
       ),
       /** Trial details. */
       trial: v.pipe(
-        v.union([v.unknown(), v.null()]),
+        v.nullable(v.unknown()),
         v.description("Trial details."),
       ),
-      /** Fee trial reward amount. */
-      feeTrialReward: v.pipe(
+      /** Fee trial escrow amount. */
+      feeTrialEscrow: v.pipe(
         UnsignedDecimal,
-        v.description("Fee trial reward amount."),
+        v.description("Fee trial escrow amount."),
       ),
       /** Timestamp when next trial becomes available. */
       nextTrialAvailableTimestamp: v.pipe(
-        v.union([v.unknown(), v.null()]),
+        v.nullable(v.unknown()),
         v.description("Timestamp when next trial becomes available."),
       ),
-      stakingLink: v.union([v.unknown(), v.null()]),
+      stakingLink: v.nullable(v.unknown()),
       /** Active staking discount details. */
       activeStakingDiscount: v.pipe(
         v.object({

package/src/src/api/info/userFills.ts

@@ -1,6 +1,8 @@
 import * as v from "valibot";
-import { Address, Decimal, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+import { FillSchema } from "../_common_schemas.js";
 
 // -------------------- Schemas --------------------
 
@@ -38,117 +40,7 @@ export type UserFillsRequest = v.InferOutput<typeof UserFillsRequest>;
  */
 export const UserFillsResponse = /* @__PURE__ */ (() => {
   return v.pipe(
-    v.array(
-      /** Trade fill record. */
-      v.pipe(
-        v.object({
-          /** Asset symbol. */
-          coin: v.pipe(
-            v.string(),
-            v.description("Asset symbol."),
-          ),
-          /** Price. */
-          px: v.pipe(
-            UnsignedDecimal,
-            v.description("Price."),
-          ),
-          /** Size. */
-          sz: v.pipe(
-            UnsignedDecimal,
-            v.description("Size."),
-          ),
-          /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
-          side: v.pipe(
-            v.union([v.literal("B"), v.literal("A")]),
-            v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).'),
-          ),
-          /** Timestamp when the trade occurred (in ms since epoch). */
-          time: v.pipe(
-            UnsignedInteger,
-            v.description("Timestamp when the trade occurred (in ms since epoch)."),
-          ),
-          /** Start position size. */
-          startPosition: v.pipe(
-            Decimal,
-            v.description("Start position size."),
-          ),
-          /** Direction indicator for frontend display. */
-          dir: v.pipe(
-            v.string(),
-            v.description("Direction indicator for frontend display."),
-          ),
-          /** Realized PnL. */
-          closedPnl: v.pipe(
-            Decimal,
-            v.description("Realized PnL."),
-          ),
-          /** L1 transaction hash. */
-          hash: v.pipe(
-            v.pipe(Hex, v.length(66)),
-            v.description("L1 transaction hash."),
-          ),
-          /** Order ID. */
-          oid: v.pipe(
-            UnsignedInteger,
-            v.description("Order ID."),
-          ),
-          /** Indicates if the fill was a taker order. */
-          crossed: v.pipe(
-            v.boolean(),
-            v.description("Indicates if the fill was a taker order."),
-          ),
-          /** Fee charged or rebate received (negative indicates rebate). */
-          fee: v.pipe(
-            Decimal,
-            v.description("Fee charged or rebate received (negative indicates rebate)."),
-          ),
-          /** Unique transaction identifier for a partial fill of an order. */
-          tid: v.pipe(
-            UnsignedInteger,
-            v.description("Unique transaction identifier for a partial fill of an order."),
-          ),
-          /** Client Order ID. */
-          cloid: v.pipe(
-            v.optional(v.pipe(Hex, v.length(34))),
-            v.description("Client Order ID."),
-          ),
-          /** Liquidation details. */
-          liquidation: v.pipe(
-            v.optional(
-              v.object({
-                /** Address of the liquidated user. */
-                liquidatedUser: v.pipe(
-                  Address,
-                  v.description("Address of the liquidated user."),
-                ),
-                /** Mark price at the time of liquidation. */
-                markPx: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Mark price at the time of liquidation."),
-                ),
-                /** Liquidation method. */
-                method: v.pipe(
-                  v.union([v.literal("market"), v.literal("backstop")]),
-                  v.description("Liquidation method."),
-                ),
-              }),
-            ),
-            v.description("Liquidation details."),
-          ),
-          /** Token in which the fee is denominated (e.g., "USDC"). */
-          feeToken: v.pipe(
-            v.string(),
-            v.description('Token in which the fee is denominated (e.g., "USDC").'),
-          ),
-          /** ID of the TWAP. */
-          twapId: v.pipe(
-            v.union([UnsignedInteger, v.null()]),
-            v.description("ID of the TWAP."),
-          ),
-        }),
-        v.description("Trade fill record."),
-      ),
-    ),
+    v.array(FillSchema),
     v.description("Array of user trade fills."),
   );
 })();