@nktkas/hyperliquid 0.30.2 → 0.31.0

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

@@ -11,21 +11,12 @@ import { Address, Decimal, UnsignedDecimal } from "../../_schemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
  */
 export const UserFeesRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("userFees"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request user fees."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userFees"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type UserFeesRequest = v.InferOutput<typeof UserFeesRequest>;
 
@@ -34,246 +25,115 @@ export type UserFeesRequest = v.InferOutput<typeof UserFeesRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees
  */
 export const UserFeesResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Daily user volume metrics. */
-      dailyUserVlm: v.pipe(
-        v.array(
+  return v.object({
+    /** Daily user volume metrics. */
+    dailyUserVlm: v.array(
+      v.object({
+        /** Date in YYYY-M-D format. */
+        date: v.pipe(v.string(), v.isoDate()),
+        /** User cross-trade volume. */
+        userCross: UnsignedDecimal,
+        /** User add-liquidity volume. */
+        userAdd: UnsignedDecimal,
+        /** Exchange total volume. */
+        exchange: UnsignedDecimal,
+      }),
+    ),
+    /** Fee schedule information. */
+    feeSchedule: v.object({
+      /** Cross-trade fee rate. */
+      cross: UnsignedDecimal,
+      /** Add-liquidity fee rate. */
+      add: UnsignedDecimal,
+      /** Spot cross-trade fee rate. */
+      spotCross: UnsignedDecimal,
+      /** Spot add-liquidity fee rate. */
+      spotAdd: UnsignedDecimal,
+      /** Fee tiers details. */
+      tiers: v.object({
+        /** Array of VIP fee tiers. */
+        vip: v.array(
           v.object({
-            /** Date in YYYY-M-D format. */
-            date: v.pipe(
-              v.string(),
-              v.isoDate(),
-              v.description("Date in YYYY-M-D format."),
-            ),
-            /** User cross-trade volume. */
-            userCross: v.pipe(
-              UnsignedDecimal,
-              v.description("User cross-trade volume."),
-            ),
-            /** User add-liquidity volume. */
-            userAdd: v.pipe(
-              UnsignedDecimal,
-              v.description("User add-liquidity volume."),
-            ),
-            /** Exchange total volume. */
-            exchange: v.pipe(
-              UnsignedDecimal,
-              v.description("Exchange total volume."),
-            ),
+            /** Notional volume cutoff. */
+            ntlCutoff: UnsignedDecimal,
+            /** Cross-trade fee rate. */
+            cross: UnsignedDecimal,
+            /** Add-liquidity fee rate. */
+            add: UnsignedDecimal,
+            /** Spot cross-trade fee rate. */
+            spotCross: UnsignedDecimal,
+            /** Spot add-liquidity fee rate. */
+            spotAdd: UnsignedDecimal,
           }),
         ),
-        v.description("Daily user volume metrics."),
-      ),
-      /** Fee schedule information. */
-      feeSchedule: v.pipe(
-        v.object({
-          /** Cross-trade fee rate. */
-          cross: v.pipe(
-            UnsignedDecimal,
-            v.description("Cross-trade fee rate."),
-          ),
-          /** Add-liquidity fee rate. */
-          add: v.pipe(
-            UnsignedDecimal,
-            v.description("Add-liquidity fee rate."),
-          ),
-          /** Spot cross-trade fee rate. */
-          spotCross: v.pipe(
-            UnsignedDecimal,
-            v.description("Spot cross-trade fee rate."),
-          ),
-          /** Spot add-liquidity fee rate. */
-          spotAdd: v.pipe(
-            UnsignedDecimal,
-            v.description("Spot add-liquidity fee rate."),
-          ),
-          /** Fee tiers details. */
-          tiers: v.pipe(
-            v.object({
-              /** Array of VIP fee tiers. */
-              vip: v.pipe(
-                v.array(
-                  v.object({
-                    /** Notional volume cutoff. */
-                    ntlCutoff: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Notional volume cutoff."),
-                    ),
-                    /** Cross-trade fee rate. */
-                    cross: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Cross-trade fee rate."),
-                    ),
-                    /** Add-liquidity fee rate. */
-                    add: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Add-liquidity fee rate."),
-                    ),
-                    /** Spot cross-trade fee rate. */
-                    spotCross: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Spot cross-trade fee rate."),
-                    ),
-                    /** Spot add-liquidity fee rate. */
-                    spotAdd: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Spot add-liquidity fee rate."),
-                    ),
-                  }),
-                ),
-                v.description("Array of VIP fee tiers."),
-              ),
-              /** Array of market maker fee tiers. */
-              mm: v.pipe(
-                v.array(
-                  v.object({
-                    /** Maker fraction cutoff. */
-                    makerFractionCutoff: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Maker fraction cutoff."),
-                    ),
-                    /** Add-liquidity fee rate. */
-                    add: v.pipe(
-                      Decimal,
-                      v.description("Add-liquidity fee rate."),
-                    ),
-                  }),
-                ),
-                v.description("Array of market maker fee tiers."),
-              ),
-            }),
-            v.description("Fee tiers details."),
-          ),
-          /** Referral discount rate. */
-          referralDiscount: v.pipe(
-            UnsignedDecimal,
-            v.description("Referral discount rate."),
-          ),
-          /** Array of staking discount tiers. */
-          stakingDiscountTiers: v.pipe(
-            v.array(
-              v.object({
-                /** Basis points of maximum supply. */
-                bpsOfMaxSupply: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Basis points of maximum supply."),
-                ),
-                /** Discount rate applied. */
-                discount: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Discount rate applied."),
-                ),
-              }),
-            ),
-            v.description("Array of staking discount tiers."),
-          ),
-        }),
-        v.description("Fee schedule information."),
-      ),
-      /** User cross-trade rate. */
-      userCrossRate: v.pipe(
-        UnsignedDecimal,
-        v.description("User cross-trade rate."),
-      ),
-      /** User add-liquidity rate. */
-      userAddRate: v.pipe(
-        UnsignedDecimal,
-        v.description("User add-liquidity rate."),
-      ),
-      /** User spot cross-trade rate. */
-      userSpotCrossRate: v.pipe(
-        UnsignedDecimal,
-        v.description("User spot cross-trade rate."),
-      ),
-      /** User spot add-liquidity rate. */
-      userSpotAddRate: v.pipe(
-        UnsignedDecimal,
-        v.description("User spot add-liquidity rate."),
-      ),
-      /** Active referral discount rate. */
-      activeReferralDiscount: v.pipe(
-        UnsignedDecimal,
-        v.description("Active referral discount rate."),
-      ),
-      /** Trial details. */
-      trial: v.pipe(
-        v.nullable(v.unknown()),
-        v.description("Trial details."),
-      ),
-      /** Fee trial escrow amount. */
-      feeTrialEscrow: v.pipe(
-        UnsignedDecimal,
-        v.description("Fee trial escrow amount."),
-      ),
-      /** Timestamp when next trial becomes available. */
-      nextTrialAvailableTimestamp: v.pipe(
-        v.nullable(v.unknown()),
-        v.description("Timestamp when next trial becomes available."),
-      ),
-      /**
-       * Permanent link between staking and trading accounts.
-       * Staking user gains full control of trading account funds.
-       * Staking user forfeits own fee discounts.
-       */
-      stakingLink: v.pipe(
-        v.nullable(
+        /** Array of market maker fee tiers. */
+        mm: v.array(
           v.object({
-            /**
-             * Linked account address:
-             * - When queried by staking account: contains trading account address.
-             * - When queried by trading account: contains staking account address.
-             */
-            stakingUser: v.pipe(
-              Address,
-              v.description(
-                "Linked account address:" +
-                  "\n- When queried by staking account: contains trading account address." +
-                  "\n- When queried by trading account: contains staking account address.",
-              ),
-            ),
-            /**
-             * Link status:
-             * - `requested` = link initiated by trading user, awaiting staking user confirmation.
-             * - `stakingUser` = response queried by staking account.
-             * - `tradingUser` = response queried by trading account.
-             */
-            type: v.pipe(
-              v.picklist(["requested", "stakingUser", "tradingUser"]),
-              v.description(
-                "Link status:" +
-                  "\n- `requested` = link initiated by trading user, awaiting staking user confirmation." +
-                  "\n- `stakingUser` = response queried by staking account." +
-                  "\n- `tradingUser` = response queried by trading account.",
-              ),
-            ),
+            /** Maker fraction cutoff. */
+            makerFractionCutoff: UnsignedDecimal,
+            /** Add-liquidity fee rate. */
+            add: Decimal,
           }),
         ),
-        v.description(
-          "Permanent link between staking and trading accounts." +
-            "\nStaking user gains full control of trading account funds." +
-            "\nStaking user forfeits own fee discounts.",
-        ),
-      ),
-      /** Active staking discount details. */
-      activeStakingDiscount: v.pipe(
+      }),
+      /** Referral discount rate. */
+      referralDiscount: UnsignedDecimal,
+      /** Array of staking discount tiers. */
+      stakingDiscountTiers: v.array(
         v.object({
           /** Basis points of maximum supply. */
-          bpsOfMaxSupply: v.pipe(
-            UnsignedDecimal,
-            v.description("Basis points of maximum supply."),
-          ),
+          bpsOfMaxSupply: UnsignedDecimal,
           /** Discount rate applied. */
-          discount: v.pipe(
-            UnsignedDecimal,
-            v.description("Discount rate applied."),
-          ),
+          discount: UnsignedDecimal,
         }),
-        v.description("Active staking discount details."),
       ),
     }),
-    v.description("User fees."),
-  );
+    /** User cross-trade rate. */
+    userCrossRate: UnsignedDecimal,
+    /** User add-liquidity rate. */
+    userAddRate: UnsignedDecimal,
+    /** User spot cross-trade rate. */
+    userSpotCrossRate: UnsignedDecimal,
+    /** User spot add-liquidity rate. */
+    userSpotAddRate: UnsignedDecimal,
+    /** Active referral discount rate. */
+    activeReferralDiscount: UnsignedDecimal,
+    /** Trial details. */
+    trial: v.nullable(v.unknown()),
+    /** Fee trial escrow amount. */
+    feeTrialEscrow: UnsignedDecimal,
+    /** Timestamp when next trial becomes available. */
+    nextTrialAvailableTimestamp: v.nullable(v.unknown()),
+    /**
+     * Permanent link between staking and trading accounts.
+     * Staking user gains full control of trading account funds.
+     * Staking user forfeits own fee discounts.
+     */
+    stakingLink: v.nullable(
+      v.object({
+        /**
+         * Linked account address:
+         * - When queried by staking account: contains trading account address.
+         * - When queried by trading account: contains staking account address.
+         */
+        stakingUser: Address,
+        /**
+         * Link status:
+         * - `requested` = link initiated by trading user, awaiting staking user confirmation.
+         * - `stakingUser` = response queried by staking account.
+         * - `tradingUser` = response queried by trading account.
+         */
+        type: v.picklist(["requested", "stakingUser", "tradingUser"]),
+      }),
+    ),
+    /** Active staking discount details. */
+    activeStakingDiscount: v.object({
+      /** Basis points of maximum supply. */
+      bpsOfMaxSupply: UnsignedDecimal,
+      /** Discount rate applied. */
+      discount: UnsignedDecimal,
+    }),
+  });
 })();
 export type UserFeesResponse = v.InferOutput<typeof UserFeesResponse>;
 

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

@@ -12,26 +12,14 @@ import { UserFillSchema } from "./_base/commonSchemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
  */
 export const UserFillsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("userFills"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
-      aggregateByTime: v.pipe(
-        v.optional(v.boolean()),
-        v.description("If true, partial fills are aggregated when a crossing order fills multiple resting orders."),
-      ),
-    }),
-    v.description("Request array of user fills."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userFills"),
+    /** User address. */
+    user: Address,
+    /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
+    aggregateByTime: v.optional(v.boolean()),
+  });
 })();
 export type UserFillsRequest = v.InferOutput<typeof UserFillsRequest>;
 
@@ -40,43 +28,25 @@ export type UserFillsRequest = v.InferOutput<typeof UserFillsRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
  */
 export const UserFillsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      v.intersect([
-        UserFillSchema,
-        v.object({
-          /** Client Order ID. */
-          cloid: v.pipe(
-            v.optional(Cloid),
-            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.picklist(["market", "backstop"]),
-                  v.description("Liquidation method."),
-                ),
-              }),
-            ),
-            v.description("Liquidation details."),
-          ),
-        }),
-      ]),
-    ),
-    v.description("Array of user trade fills."),
+  return v.array(
+    v.intersect([
+      UserFillSchema,
+      v.object({
+        /** Client Order ID. */
+        cloid: v.optional(Cloid),
+        /** Liquidation details. */
+        liquidation: v.optional(
+          v.object({
+            /** Address of the liquidated user. */
+            liquidatedUser: Address,
+            /** Mark price at the time of liquidation. */
+            markPx: UnsignedDecimal,
+            /** Liquidation method. */
+            method: v.picklist(["market", "backstop"]),
+          }),
+        ),
+      }),
+    ]),
   );
 })();
 export type UserFillsResponse = v.InferOutput<typeof UserFillsResponse>;

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

@@ -12,36 +12,18 @@ import { UserFillsResponse } from "./userFills.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
  */
 export const UserFillsByTimeRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("userFillsByTime"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** 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)."),
-      ),
-      /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
-      aggregateByTime: v.pipe(
-        v.optional(v.boolean()),
-        v.description("If true, partial fills are aggregated when a crossing order fills multiple resting orders."),
-      ),
-    }),
-    v.description("Request array of user fills by time."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userFillsByTime"),
+    /** User address. */
+    user: Address,
+    /** Start time (in ms since epoch). */
+    startTime: UnsignedInteger,
+    /** End time (in ms since epoch). */
+    endTime: v.nullish(UnsignedInteger),
+    /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
+    aggregateByTime: v.optional(v.boolean()),
+  });
 })();
 export type UserFillsByTimeRequest = v.InferOutput<typeof UserFillsByTimeRequest>;
 
@@ -50,10 +32,7 @@ export type UserFillsByTimeRequest = v.InferOutput<typeof UserFillsByTimeRequest
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
  */
 export const UserFillsByTimeResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    UserFillsResponse,
-    v.description("Array of user trade fills by time."),
-  );
+  return UserFillsResponse;
 })();
 export type UserFillsByTimeResponse = v.InferOutput<typeof UserFillsByTimeResponse>;
 

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

@@ -11,31 +11,16 @@ import { Address, Decimal, Hex, UnsignedInteger } from "../../_schemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
  */
 export const UserFundingRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("userFunding"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Start time (in ms since epoch). */
-      startTime: v.pipe(
-        v.nullish(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 array of user funding ledger updates."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userFunding"),
+    /** User address. */
+    user: Address,
+    /** Start time (in ms since epoch). */
+    startTime: v.nullish(UnsignedInteger),
+    /** End time (in ms since epoch). */
+    endTime: v.nullish(UnsignedInteger),
+  });
 })();
 export type UserFundingRequest = v.InferOutput<typeof UserFundingRequest>;
 
@@ -44,59 +29,28 @@ export type UserFundingRequest = v.InferOutput<typeof UserFundingRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
  */
 export const UserFundingResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      v.object({
-        /** Timestamp of the update (in ms since epoch). */
-        time: v.pipe(
-          UnsignedInteger,
-          v.description("Timestamp of the update (in ms since epoch)."),
-        ),
-        /** L1 transaction hash. */
-        hash: v.pipe(
-          Hex,
-          v.length(66),
-          v.description("L1 transaction hash."),
-        ),
-        /** Update details. */
-        delta: v.pipe(
-          v.object({
-            /** Update type. */
-            type: v.pipe(
-              v.literal("funding"),
-              v.description("Update type."),
-            ),
-            /** Asset symbol. */
-            coin: v.pipe(
-              v.string(),
-              v.description("Asset symbol."),
-            ),
-            /** Amount transferred in USDC. */
-            usdc: v.pipe(
-              Decimal,
-              v.description("Amount transferred in USDC."),
-            ),
-            /** Signed position size. */
-            szi: v.pipe(
-              Decimal,
-              v.description("Signed position size."),
-            ),
-            /** Applied funding rate. */
-            fundingRate: v.pipe(
-              Decimal,
-              v.description("Applied funding rate."),
-            ),
-            /** Number of samples. */
-            nSamples: v.pipe(
-              v.nullable(UnsignedInteger),
-              v.description("Number of samples."),
-            ),
-          }),
-          v.description("Update details."),
-        ),
+  return v.array(
+    v.object({
+      /** Timestamp of the update (in ms since epoch). */
+      time: UnsignedInteger,
+      /** L1 transaction hash. */
+      hash: v.pipe(Hex, v.length(66)),
+      /** Update details. */
+      delta: v.object({
+        /** Update type. */
+        type: v.literal("funding"),
+        /** Asset symbol. */
+        coin: v.string(),
+        /** Amount transferred in USDC. */
+        usdc: Decimal,
+        /** Signed position size. */
+        szi: Decimal,
+        /** Applied funding rate. */
+        fundingRate: Decimal,
+        /** Number of samples. */
+        nSamples: v.nullable(UnsignedInteger),
       }),
-    ),
-    v.description("Array of user funding ledger updates."),
+    }),
   );
 })();
 export type UserFundingResponse = v.InferOutput<typeof UserFundingResponse>;