@nktkas/hyperliquid 0.30.2 → 0.31.0

package/src/src/api/info/_methods/candleSnapshot.ts

@@ -11,42 +11,21 @@ import { UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
  */
 export const CandleSnapshotRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("candleSnapshot"),
-        v.description("Type of request."),
-      ),
-      /** Request parameters. */
-      req: v.pipe(
-        v.object({
-          /** Asset symbol (e.g., BTC). */
-          coin: v.pipe(
-            v.string(),
-            v.description("Asset symbol (e.g., BTC)."),
-          ),
-          /** Time interval. */
-          interval: v.pipe(
-            v.picklist(["1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "8h", "12h", "1d", "3d", "1w", "1M"]),
-            v.description("Time interval."),
-          ),
-          /** Start time (in ms since epoch). */
-          startTime: v.pipe(
-            UnsignedInteger,
-            v.description("Start time (in ms since epoch)."),
-          ),
-          /** End time (in ms since epoch). */
-          endTime: v.pipe(
-            v.nullish(UnsignedInteger),
-            v.description("End time (in ms since epoch)."),
-          ),
-        }),
-        v.description("Request parameters."),
-      ),
+  return v.object({
+    /** Type of request. */
+    type: v.literal("candleSnapshot"),
+    /** Request parameters. */
+    req: v.object({
+      /** Asset symbol (e.g., BTC). */
+      coin: v.string(),
+      /** Time interval. */
+      interval: v.picklist(["1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "8h", "12h", "1d", "3d", "1w", "1M"]),
+      /** Start time (in ms since epoch). */
+      startTime: UnsignedInteger,
+      /** End time (in ms since epoch). */
+      endTime: v.nullish(UnsignedInteger),
     }),
-    v.description("Request candlestick snapshots."),
-  );
+  });
 })();
 export type CandleSnapshotRequest = v.InferOutput<typeof CandleSnapshotRequest>;
 
@@ -55,62 +34,29 @@ export type CandleSnapshotRequest = v.InferOutput<typeof CandleSnapshotRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
  */
 export const CandleSnapshotResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      v.object({
-        /** Opening timestamp (ms since epoch). */
-        t: v.pipe(
-          UnsignedInteger,
-          v.description("Opening timestamp (ms since epoch)."),
-        ),
-        /** Closing timestamp (ms since epoch). */
-        T: v.pipe(
-          UnsignedInteger,
-          v.description("Closing timestamp (ms since epoch)."),
-        ),
-        /** Asset symbol. */
-        s: v.pipe(
-          v.string(),
-          v.description("Asset symbol."),
-        ),
-        /** Time interval. */
-        i: v.pipe(
-          v.picklist(["1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "8h", "12h", "1d", "3d", "1w", "1M"]),
-          v.description("Time interval."),
-        ),
-        /** Opening price. */
-        o: v.pipe(
-          UnsignedDecimal,
-          v.description("Opening price."),
-        ),
-        /** Closing price. */
-        c: v.pipe(
-          UnsignedDecimal,
-          v.description("Closing price."),
-        ),
-        /** Highest price. */
-        h: v.pipe(
-          UnsignedDecimal,
-          v.description("Highest price."),
-        ),
-        /** Lowest price. */
-        l: v.pipe(
-          UnsignedDecimal,
-          v.description("Lowest price."),
-        ),
-        /** Total volume traded in base currency. */
-        v: v.pipe(
-          UnsignedDecimal,
-          v.description("Total volume traded in base currency."),
-        ),
-        /** Number of trades executed. */
-        n: v.pipe(
-          UnsignedInteger,
-          v.description("Number of trades executed."),
-        ),
-      }),
-    ),
-    v.description("Array of candlestick data points."),
+  return v.array(
+    v.object({
+      /** Opening timestamp (ms since epoch). */
+      t: UnsignedInteger,
+      /** Closing timestamp (ms since epoch). */
+      T: UnsignedInteger,
+      /** Asset symbol. */
+      s: v.string(),
+      /** Time interval. */
+      i: v.picklist(["1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "8h", "12h", "1d", "3d", "1w", "1M"]),
+      /** Opening price. */
+      o: UnsignedDecimal,
+      /** Closing price. */
+      c: UnsignedDecimal,
+      /** Highest price. */
+      h: UnsignedDecimal,
+      /** Lowest price. */
+      l: UnsignedDecimal,
+      /** Total volume traded in base currency. */
+      v: UnsignedDecimal,
+      /** Number of trades executed. */
+      n: UnsignedInteger,
+    }),
   );
 })();
 export type CandleSnapshotResponse = v.InferOutput<typeof CandleSnapshotResponse>;

package/src/src/api/info/_methods/clearinghouseState.ts

@@ -11,26 +11,14 @@ import { Address, Decimal, UnsignedDecimal, UnsignedInteger } from "../../_schem
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
  */
 export const ClearinghouseStateRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("clearinghouseState"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** DEX name (empty string for main dex). */
-      dex: v.pipe(
-        v.optional(v.string()),
-        v.description("DEX name (empty string for main dex)."),
-      ),
-    }),
-    v.description("Request clearinghouse state."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("clearinghouseState"),
+    /** User address. */
+    user: Address,
+    /** DEX name (empty string for main dex). */
+    dex: v.optional(v.string()),
+  });
 })();
 export type ClearinghouseStateRequest = v.InferOutput<typeof ClearinghouseStateRequest>;
 
@@ -39,201 +27,90 @@ export type ClearinghouseStateRequest = v.InferOutput<typeof ClearinghouseStateR
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
  */
 export const ClearinghouseStateResponse = /* @__PURE__ */ (() => {
-  return 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(
-          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.variant("type", [
-                    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.nullable(UnsignedDecimal),
-                  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("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)."),
-      ),
+  return v.object({
+    /** Margin summary details. */
+    marginSummary: v.object({
+      /** Total account value. */
+      accountValue: UnsignedDecimal,
+      /** Total notional position value. */
+      totalNtlPos: UnsignedDecimal,
+      /** Total raw USD value. */
+      totalRawUsd: Decimal,
+      /** Total margin used. */
+      totalMarginUsed: UnsignedDecimal,
     }),
-    v.description("Account summary for perpetual trading."),
-  );
+    /** Cross-margin summary details. */
+    crossMarginSummary: v.object({
+      /** Total account value. */
+      accountValue: UnsignedDecimal,
+      /** Total notional position value. */
+      totalNtlPos: UnsignedDecimal,
+      /** Total raw USD value. */
+      totalRawUsd: Decimal,
+      /** Total margin used. */
+      totalMarginUsed: UnsignedDecimal,
+    }),
+    /** Maintenance margin used for cross-margin positions. */
+    crossMaintenanceMarginUsed: UnsignedDecimal,
+    /** Amount available for withdrawal. */
+    withdrawable: UnsignedDecimal,
+    /** Array of asset positions. */
+    assetPositions: v.array(
+      v.object({
+        /** Position type. */
+        type: v.literal("oneWay"),
+        /** Position details. */
+        position: v.object({
+          /** Asset symbol. */
+          coin: v.string(),
+          /** Signed position size. */
+          szi: Decimal,
+          /** Leverage details. */
+          leverage: v.variant("type", [
+            v.object({
+              /** Leverage type. */
+              type: v.literal("isolated"),
+              /** Leverage value used. */
+              value: v.pipe(UnsignedInteger, v.minValue(1)),
+              /** Amount of USD used (1 = $1). */
+              rawUsd: Decimal,
+            }),
+            v.object({
+              /** Leverage type. */
+              type: v.literal("cross"),
+              /** Leverage value used. */
+              value: v.pipe(UnsignedInteger, v.minValue(1)),
+            }),
+          ]),
+          /** Average entry price. */
+          entryPx: UnsignedDecimal,
+          /** Position value. */
+          positionValue: UnsignedDecimal,
+          /** Unrealized profit and loss. */
+          unrealizedPnl: Decimal,
+          /** Return on equity. */
+          returnOnEquity: Decimal,
+          /** Liquidation price. */
+          liquidationPx: v.nullable(UnsignedDecimal),
+          /** Margin used. */
+          marginUsed: UnsignedDecimal,
+          /** Maximum allowed leverage. */
+          maxLeverage: v.pipe(UnsignedInteger, v.minValue(1)),
+          /** Cumulative funding details. */
+          cumFunding: v.object({
+            /** Total funding paid or received since account opening. */
+            allTime: Decimal,
+            /** Funding accumulated since the position was opened. */
+            sinceOpen: Decimal,
+            /** Funding accumulated since the last change in position size. */
+            sinceChange: Decimal,
+          }),
+        }),
+      }),
+    ),
+    /** Timestamp when data was retrieved (in ms since epoch). */
+    time: UnsignedInteger,
+  });
 })();
 export type ClearinghouseStateResponse = v.InferOutput<typeof ClearinghouseStateResponse>;
 

package/src/src/api/info/_methods/delegations.ts

@@ -11,21 +11,12 @@ import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
  */
 export const DelegationsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("delegations"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request user staking delegations."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("delegations"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type DelegationsRequest = v.InferOutput<typeof DelegationsRequest>;
 
@@ -34,27 +25,15 @@ export type DelegationsRequest = v.InferOutput<typeof DelegationsRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
  */
 export const DelegationsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      v.object({
-        /** Validator address. */
-        validator: v.pipe(
-          Address,
-          v.description("Validator address."),
-        ),
-        /** Amount of tokens delegated to the validator. */
-        amount: v.pipe(
-          UnsignedDecimal,
-          v.description("Amount of tokens delegated to the validator."),
-        ),
-        /** Locked until timestamp (in ms since epoch). */
-        lockedUntilTimestamp: v.pipe(
-          UnsignedInteger,
-          v.description("Locked until timestamp (in ms since epoch)."),
-        ),
-      }),
-    ),
-    v.description("Array of user's delegations to validators."),
+  return v.array(
+    v.object({
+      /** Validator address. */
+      validator: Address,
+      /** Amount of tokens delegated to the validator. */
+      amount: UnsignedDecimal,
+      /** Locked until timestamp (in ms since epoch). */
+      lockedUntilTimestamp: UnsignedInteger,
+    }),
   );
 })();
 export type DelegationsResponse = v.InferOutput<typeof DelegationsResponse>;

package/src/src/api/info/_methods/delegatorHistory.ts

@@ -11,21 +11,12 @@ import { Address, Hex, UnsignedDecimal, UnsignedInteger } from "../../_schemas.j
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
  */
 export const DelegatorHistoryRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("delegatorHistory"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request user staking history."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("delegatorHistory"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type DelegatorHistoryRequest = v.InferOutput<typeof DelegatorHistoryRequest>;
 
@@ -34,83 +25,43 @@ export type DelegatorHistoryRequest = v.InferOutput<typeof DelegatorHistoryReque
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
  */
 export const DelegatorHistoryResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      v.object({
-        /** Timestamp of the delegation event (in ms since epoch). */
-        time: v.pipe(
-          UnsignedInteger,
-          v.description("Timestamp of the delegation event (in ms since epoch)."),
-        ),
-        /** Transaction hash of the delegation event. */
-        hash: v.pipe(
-          Hex,
-          v.length(66),
-          v.description("Transaction hash of the delegation event."),
-        ),
-        /** Details of the update. */
-        delta: v.pipe(
-          v.union([
-            v.object({
-              /** Delegation operation details. */
-              delegate: v.pipe(
-                v.object({
-                  /** Address of the validator receiving or losing delegation. */
-                  validator: v.pipe(
-                    Address,
-                    v.description("Address of the validator receiving or losing delegation."),
-                  ),
-                  /** Amount of tokens being delegated or undelegated. */
-                  amount: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Amount of tokens being delegated or undelegated."),
-                  ),
-                  /** Whether this is an undelegation operation. */
-                  isUndelegate: v.pipe(
-                    v.boolean(),
-                    v.description("Whether this is an undelegation operation."),
-                  ),
-                }),
-                v.description("Delegation operation details."),
-              ),
-            }),
-            v.object({
-              /** Deposit details. */
-              cDeposit: v.pipe(
-                v.object({
-                  /** Amount of tokens being deposited. */
-                  amount: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Amount of tokens being deposited."),
-                  ),
-                }),
-                v.description("Deposit details."),
-              ),
-            }),
-            v.object({
-              /** Withdrawal details. */
-              withdrawal: v.pipe(
-                v.object({
-                  /** Amount of tokens being withdrawn. */
-                  amount: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Amount of tokens being withdrawn."),
-                  ),
-                  /** Phase of the withdrawal process. */
-                  phase: v.pipe(
-                    v.picklist(["initiated", "finalized"]),
-                    v.description("Phase of the withdrawal process."),
-                  ),
-                }),
-                v.description("Withdrawal details."),
-              ),
-            }),
-          ]),
-          v.description("Details of the update."),
-        ),
-      }),
-    ),
-    v.description("Array of records of staking events by a delegator."),
+  return v.array(
+    v.object({
+      /** Timestamp of the delegation event (in ms since epoch). */
+      time: UnsignedInteger,
+      /** Transaction hash of the delegation event. */
+      hash: v.pipe(Hex, v.length(66)),
+      /** Details of the update. */
+      delta: v.union([
+        v.object({
+          /** Delegation operation details. */
+          delegate: v.object({
+            /** Address of the validator receiving or losing delegation. */
+            validator: Address,
+            /** Amount of tokens being delegated or undelegated. */
+            amount: UnsignedDecimal,
+            /** Whether this is an undelegation operation. */
+            isUndelegate: v.boolean(),
+          }),
+        }),
+        v.object({
+          /** Deposit details. */
+          cDeposit: v.object({
+            /** Amount of tokens being deposited. */
+            amount: UnsignedDecimal,
+          }),
+        }),
+        v.object({
+          /** Withdrawal details. */
+          withdrawal: v.object({
+            /** Amount of tokens being withdrawn. */
+            amount: UnsignedDecimal,
+            /** Phase of the withdrawal process. */
+            phase: v.picklist(["initiated", "finalized"]),
+          }),
+        }),
+      ]),
+    }),
   );
 })();
 export type DelegatorHistoryResponse = v.InferOutput<typeof DelegatorHistoryResponse>;