@nktkas/hyperliquid 0.30.2 → 0.31.0

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

@@ -11,55 +11,28 @@ import { UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
  */
 export const L2BookRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("l2Book"),
-        v.description("Type of request."),
-      ),
-      /** Asset symbol (e.g., BTC). */
-      coin: v.pipe(
-        v.string(),
-        v.description("Asset symbol (e.g., BTC)."),
-      ),
-      /** Number of significant figures. */
-      nSigFigs: v.pipe(
-        v.nullish(v.picklist([2, 3, 4, 5])),
-        v.description("Number of significant figures."),
-      ),
-      /** Mantissa for aggregation (if `nSigFigs` is 5). */
-      mantissa: v.pipe(
-        v.nullish(v.picklist([2, 5])),
-        v.description("Mantissa for aggregation (if `nSigFigs` is 5)."),
-      ),
-    }),
-    v.description("Request L2 order book."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("l2Book"),
+    /** Asset symbol (e.g., BTC). */
+    coin: v.string(),
+    /** Number of significant figures. */
+    nSigFigs: v.nullish(v.picklist([2, 3, 4, 5])),
+    /** Mantissa for aggregation (if `nSigFigs` is 5). */
+    mantissa: v.nullish(v.picklist([2, 5])),
+  });
 })();
 export type L2BookRequest = v.InferOutput<typeof L2BookRequest>;
 
 const L2BookLevelSchema = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Price. */
-      px: v.pipe(
-        UnsignedDecimal,
-        v.description("Price."),
-      ),
-      /** Total size. */
-      sz: v.pipe(
-        UnsignedDecimal,
-        v.description("Total size."),
-      ),
-      /** Number of individual orders. */
-      n: v.pipe(
-        UnsignedInteger,
-        v.description("Number of individual orders."),
-      ),
-    }),
-    v.description("L2 order book level."),
-  );
+  return v.object({
+    /** Price. */
+    px: UnsignedDecimal,
+    /** Total size. */
+    sz: UnsignedDecimal,
+    /** Number of individual orders. */
+    n: UnsignedInteger,
+  });
 })();
 
 /**
@@ -67,27 +40,17 @@ const L2BookLevelSchema = /* @__PURE__ */ (() => {
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
  */
 export const L2BookResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.nullable(
-      v.object({
-        /** Asset symbol. */
-        coin: v.pipe(
-          v.string(),
-          v.description("Asset symbol."),
-        ),
-        /** Timestamp of the snapshot (in ms since epoch). */
-        time: v.pipe(
-          UnsignedInteger,
-          v.description("Timestamp of the snapshot (in ms since epoch)."),
-        ),
-        /** Bid and ask levels (index 0 = bids, index 1 = asks). */
-        levels: v.pipe(
-          v.tuple([v.array(L2BookLevelSchema), v.array(L2BookLevelSchema)]),
-          v.description("Bid and ask levels (index 0 = bids, index 1 = asks)."),
-        ),
-      }),
-    ),
-    v.description("L2 order book snapshot or `null` if the market does not exist."),
+  return v.nullable(
+    v.object({
+      /** Asset symbol. */
+      coin: v.string(),
+      /** Timestamp of the snapshot (in ms since epoch). */
+      time: UnsignedInteger,
+      /** Bid and ask levels (index 0 = bids, index 1 = asks). */
+      levels: v.tuple([v.array(L2BookLevelSchema), v.array(L2BookLevelSchema)]),
+      /** Spread (only present when `nSigFigs` is non-null). */
+      spread: v.optional(UnsignedDecimal),
+    }),
   );
 })();
 export type L2BookResponse = v.InferOutput<typeof L2BookResponse>;

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

@@ -10,21 +10,12 @@ import { Address } from "../../_schemas.js";
  * Request leading vaults for a user.
  */
 export const LeadingVaultsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("leadingVaults"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request leading vaults for a user."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("leadingVaults"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type LeadingVaultsRequest = v.InferOutput<typeof LeadingVaultsRequest>;
 
@@ -32,22 +23,13 @@ export type LeadingVaultsRequest = v.InferOutput<typeof LeadingVaultsRequest>;
  * Array of leading vaults for a user.
  */
 export const LeadingVaultsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      v.object({
-        /** Vault address. */
-        address: v.pipe(
-          Address,
-          v.description("Vault address."),
-        ),
-        /** Vault name. */
-        name: v.pipe(
-          v.string(),
-          v.description("Vault name."),
-        ),
-      }),
-    ),
-    v.description("Array of leading vaults for a user."),
+  return v.array(
+    v.object({
+      /** Vault address. */
+      address: Address,
+      /** Vault name. */
+      name: v.string(),
+    }),
   );
 })();
 export type LeadingVaultsResponse = v.InferOutput<typeof LeadingVaultsResponse>;

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

@@ -10,21 +10,12 @@ import { Address } from "../../_schemas.js";
  * Request legal verification status of a user.
  */
 export const LegalCheckRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("legalCheck"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request legal verification status of a user."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("legalCheck"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type LegalCheckRequest = v.InferOutput<typeof LegalCheckRequest>;
 
@@ -32,26 +23,14 @@ export type LegalCheckRequest = v.InferOutput<typeof LegalCheckRequest>;
  * Legal verification status for a user.
  */
 export const LegalCheckResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Whether the user IP address is allowed. */
-      ipAllowed: v.pipe(
-        v.boolean(),
-        v.description("Whether the user IP address is allowed."),
-      ),
-      /** Whether the user has accepted the terms of service. */
-      acceptedTerms: v.pipe(
-        v.boolean(),
-        v.description("Whether the user has accepted the terms of service."),
-      ),
-      /** Whether the user is allowed to use the platform. */
-      userAllowed: v.pipe(
-        v.boolean(),
-        v.description("Whether the user is allowed to use the platform."),
-      ),
-    }),
-    v.description("Legal verification status for a user."),
-  );
+  return v.object({
+    /** Whether the user IP address is allowed. */
+    ipAllowed: v.boolean(),
+    /** Whether the user has accepted the terms of service. */
+    acceptedTerms: v.boolean(),
+    /** Whether the user is allowed to use the platform. */
+    userAllowed: v.boolean(),
+  });
 })();
 export type LegalCheckResponse = v.InferOutput<typeof LegalCheckResponse>;
 

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

@@ -8,16 +8,10 @@ import * as v from "valibot";
  * Request liquidatable.
  */
 export const LiquidatableRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("liquidatable"),
-        v.description("Type of request."),
-      ),
-    }),
-    v.description("Request liquidatable."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("liquidatable"),
+  });
 })();
 export type LiquidatableRequest = v.InferOutput<typeof LiquidatableRequest>;
 
@@ -25,10 +19,7 @@ export type LiquidatableRequest = v.InferOutput<typeof LiquidatableRequest>;
  * Response for liquidatable request.
  */
 export const LiquidatableResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(v.unknown()),
-    v.description("Response for liquidatable request."),
-  );
+  return v.array(v.unknown());
 })();
 export type LiquidatableResponse = v.InferOutput<typeof LiquidatableResponse>;
 

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

@@ -10,21 +10,12 @@ import { UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
  * Request margin table data.
  */
 export const MarginTableRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("marginTable"),
-        v.description("Type of request."),
-      ),
-      /** Margin requirements table. */
-      id: v.pipe(
-        UnsignedInteger,
-        v.description("Margin requirements table."),
-      ),
-    }),
-    v.description("Request margin table data."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("marginTable"),
+    /** Margin requirements table. */
+    id: UnsignedInteger,
+  });
 })();
 
 export type MarginTableRequest = v.InferOutput<typeof MarginTableRequest>;
@@ -33,35 +24,19 @@ export type MarginTableRequest = v.InferOutput<typeof MarginTableRequest>;
  * Margin requirements table with multiple tiers.
  */
 export const MarginTableResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Description of the margin table. */
-      description: v.pipe(
-        v.string(),
-        v.description("Description of the margin table."),
-      ),
-      /** Array of margin tiers defining leverage limits. */
-      marginTiers: v.pipe(
-        v.array(
-          v.object({
-            /** Lower position size boundary for this tier. */
-            lowerBound: v.pipe(
-              UnsignedDecimal,
-              v.description("Lower position size boundary for this tier."),
-            ),
-            /** Maximum allowed leverage for this tier. */
-            maxLeverage: v.pipe(
-              UnsignedInteger,
-              v.minValue(1),
-              v.description("Maximum allowed leverage for this tier."),
-            ),
-          }),
-        ),
-        v.description("Array of margin tiers defining leverage limits."),
-      ),
-    }),
-    v.description("Margin requirements table with multiple tiers."),
-  );
+  return v.object({
+    /** Description of the margin table. */
+    description: v.string(),
+    /** Array of margin tiers defining leverage limits. */
+    marginTiers: v.array(
+      v.object({
+        /** Lower position size boundary for this tier. */
+        lowerBound: UnsignedDecimal,
+        /** Maximum allowed leverage for this tier. */
+        maxLeverage: v.pipe(UnsignedInteger, v.minValue(1)),
+      }),
+    ),
+  });
 })();
 
 export type MarginTableResponse = v.InferOutput<typeof MarginTableResponse>;

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

@@ -11,26 +11,14 @@ import { Address } from "../../_schemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
  */
 export const MaxBuilderFeeRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("maxBuilderFee"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Builder address. */
-      builder: v.pipe(
-        Address,
-        v.description("Builder address."),
-      ),
-    }),
-    v.description("Request builder fee approval."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("maxBuilderFee"),
+    /** User address. */
+    user: Address,
+    /** Builder address. */
+    builder: Address,
+  });
 })();
 
 export type MaxBuilderFeeRequest = v.InferOutput<typeof MaxBuilderFeeRequest>;
@@ -40,10 +28,7 @@ export type MaxBuilderFeeRequest = v.InferOutput<typeof MaxBuilderFeeRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
  */
 export const MaxBuilderFeeResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.number(),
-    v.description("Maximum builder fee approval."),
-  );
+  return v.number();
 })();
 
 export type MaxBuilderFeeResponse = v.InferOutput<typeof MaxBuilderFeeResponse>;

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

@@ -4,22 +4,16 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { UnsignedDecimal } from "../../_schemas.js";
+import { UnsignedInteger } from "../../_schemas.js";
 
 /**
  * Request maximum market order notionals.
  */
 export const MaxMarketOrderNtlsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("maxMarketOrderNtls"),
-        v.description("Type of request."),
-      ),
-    }),
-    v.description("Request maximum market order notionals."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("maxMarketOrderNtls"),
+  });
 })();
 export type MaxMarketOrderNtlsRequest = v.InferOutput<typeof MaxMarketOrderNtlsRequest>;
 
@@ -27,12 +21,7 @@ export type MaxMarketOrderNtlsRequest = v.InferOutput<typeof MaxMarketOrderNtlsR
  * Array of tuples containing maximum market order notionals and their corresponding asset symbols.
  */
 export const MaxMarketOrderNtlsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      v.tuple([UnsignedDecimal, v.string()]),
-    ),
-    v.description("Array of tuples containing maximum market order notionals and their corresponding asset symbols."),
-  );
+  return v.array(v.tuple([UnsignedInteger, v.string()]));
 })();
 export type MaxMarketOrderNtlsResponse = v.InferOutput<typeof MaxMarketOrderNtlsResponse>;
 

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

@@ -12,21 +12,12 @@ import { MarginTableResponse } from "./marginTable.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata-universe-and-margin-tables
  */
 export const MetaRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("meta"),
-        v.description("Type of request."),
-      ),
-      /** 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 trading metadata."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("meta"),
+    /** DEX name (empty string for main dex). */
+    dex: v.optional(v.string()),
+  });
 })();
 export type MetaRequest = v.InferOutput<typeof MetaRequest>;
 
@@ -35,80 +26,35 @@ export type MetaRequest = v.InferOutput<typeof MetaRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata-universe-and-margin-tables
  */
 export const MetaResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Trading universes available for perpetual trading. */
-      universe: v.pipe(
-        v.array(
-          v.object({
-            /** Minimum decimal places for order sizes. */
-            szDecimals: v.pipe(
-              UnsignedInteger,
-              v.description("Minimum decimal places for order sizes."),
-            ),
-            /** Name of the universe. */
-            name: v.pipe(
-              v.string(),
-              v.description("Name of the universe."),
-            ),
-            /** Maximum allowed leverage. */
-            maxLeverage: v.pipe(
-              UnsignedInteger,
-              v.minValue(1),
-              v.description("Maximum allowed leverage."),
-            ),
-            /** Unique identifier for the margin requirements table. */
-            marginTableId: v.pipe(
-              UnsignedInteger,
-              v.description("Unique identifier for the margin requirements table."),
-            ),
-            /** Indicates if only isolated margin trading is allowed. */
-            onlyIsolated: v.pipe(
-              v.optional(v.literal(true)),
-              v.description("Indicates if only isolated margin trading is allowed."),
-            ),
-            /** Indicates if the universe is delisted. */
-            isDelisted: v.pipe(
-              v.optional(v.literal(true)),
-              v.description("Indicates if the universe is delisted."),
-            ),
-            /** Trading margin mode constraint. */
-            marginMode: v.pipe(
-              v.optional(v.picklist(["strictIsolated", "noCross"])),
-              v.description("Trading margin mode constraint."),
-            ),
-            /** Indicates if growth mode is enabled. */
-            growthMode: v.pipe(
-              v.optional(v.literal("enabled")),
-              v.description("Indicates if growth mode is enabled."),
-            ),
-            /** Timestamp of the last growth mode change. */
-            lastGrowthModeChangeTime: v.pipe(
-              v.optional(ISO8601WithoutTimezone),
-              v.description("Timestamp of the last growth mode change."),
-            ),
-          }),
-        ),
-        v.description("Trading universes available for perpetual trading."),
-      ),
-      /** Margin requirement tables for different leverage tiers. */
-      marginTables: v.pipe(
-        v.array(
-          v.tuple([
-            UnsignedInteger,
-            MarginTableResponse,
-          ]),
-        ),
-        v.description("Margin requirement tables for different leverage tiers."),
-      ),
-      /** Collateral token index. */
-      collateralToken: v.pipe(
-        UnsignedInteger,
-        v.description("Collateral token index."),
-      ),
-    }),
-    v.description("Metadata for perpetual assets."),
-  );
+  return v.object({
+    /** Trading universes available for perpetual trading. */
+    universe: v.array(
+      v.object({
+        /** Minimum decimal places for order sizes. */
+        szDecimals: UnsignedInteger,
+        /** Name of the universe. */
+        name: v.string(),
+        /** Maximum allowed leverage. */
+        maxLeverage: v.pipe(UnsignedInteger, v.minValue(1)),
+        /** Unique identifier for the margin requirements table. */
+        marginTableId: UnsignedInteger,
+        /** Indicates if only isolated margin trading is allowed. */
+        onlyIsolated: v.optional(v.literal(true)),
+        /** Indicates if the universe is delisted. */
+        isDelisted: v.optional(v.literal(true)),
+        /** Trading margin mode constraint. */
+        marginMode: v.optional(v.picklist(["strictIsolated", "noCross"])),
+        /** Indicates if growth mode is enabled. */
+        growthMode: v.optional(v.literal("enabled")),
+        /** Timestamp of the last growth mode change. */
+        lastGrowthModeChangeTime: v.optional(ISO8601WithoutTimezone),
+      }),
+    ),
+    /** Margin requirement tables for different leverage tiers. */
+    marginTables: v.array(v.tuple([UnsignedInteger, MarginTableResponse])),
+    /** Collateral token index. */
+    collateralToken: UnsignedInteger,
+  });
 })();
 export type MetaResponse = v.InferOutput<typeof MetaResponse>;
 

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

@@ -12,21 +12,12 @@ import { MetaResponse } from "./meta.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc
  */
 export const MetaAndAssetCtxsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("metaAndAssetCtxs"),
-        v.description("Type of request."),
-      ),
-      /** 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 metadata and asset contexts."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("metaAndAssetCtxs"),
+    /** DEX name (empty string for main dex). */
+    dex: v.optional(v.string()),
+  });
 })();
 export type MetaAndAssetCtxsRequest = v.InferOutput<typeof MetaAndAssetCtxsRequest>;
 
@@ -35,13 +26,7 @@ export type MetaAndAssetCtxsRequest = v.InferOutput<typeof MetaAndAssetCtxsReque
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc
  */
 export const MetaAndAssetCtxsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.tuple([
-      MetaResponse,
-      v.array(PerpAssetCtxSchema),
-    ]),
-    v.description("Tuple containing metadata and array of asset contexts."),
-  );
+  return v.tuple([MetaResponse, v.array(PerpAssetCtxSchema)]);
 })();
 export type MetaAndAssetCtxsResponse = v.InferOutput<typeof MetaAndAssetCtxsResponse>;
 

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

@@ -12,26 +12,14 @@ import { OpenOrderSchema } from "./_base/commonSchemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
  */
 export const OpenOrdersRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("openOrders"),
-        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 open orders."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("openOrders"),
+    /** User address. */
+    user: Address,
+    /** DEX name (empty string for main dex). */
+    dex: v.optional(v.string()),
+  });
 })();
 export type OpenOrdersRequest = v.InferOutput<typeof OpenOrdersRequest>;
 
@@ -40,10 +28,7 @@ export type OpenOrdersRequest = v.InferOutput<typeof OpenOrdersRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
  */
 export const OpenOrdersResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(OpenOrderSchema),
-    v.description("Array of open orders."),
-  );
+  return v.array(OpenOrderSchema);
 })();
 export type OpenOrdersResponse = v.InferOutput<typeof OpenOrdersResponse>;