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

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

@@ -39,33 +39,29 @@ export const UserFeesResponse = /* @__PURE__ */ (() => {
       /** Daily user volume metrics. */
       dailyUserVlm: v.pipe(
         v.array(
-          /** Daily user volume metrics record. */
-          v.pipe(
-            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."),
-              ),
-            }),
-            v.description("Daily user volume metrics record."),
-          ),
+          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."),
+            ),
+          }),
         ),
         v.description("Daily user volume metrics."),
       ),
@@ -98,59 +94,51 @@ export const UserFeesResponse = /* @__PURE__ */ (() => {
               /** Array of VIP fee tiers. */
               vip: v.pipe(
                 v.array(
-                  /** VIP fee tier. */
-                  v.pipe(
-                    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("VIP fee tier."),
-                  ),
+                  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(
-                  /** Market maker fee tier. */
-                  v.pipe(
-                    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("Market maker fee tier."),
-                  ),
+                  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."),
               ),
@@ -165,27 +153,23 @@ export const UserFeesResponse = /* @__PURE__ */ (() => {
           /** Array of staking discount tiers. */
           stakingDiscountTiers: v.pipe(
             v.array(
-              /** Staking discount tier. */
-              v.pipe(
-                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("Staking discount tier."),
-              ),
+              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("Staking discount tiers details."),
+            v.description("Array of staking discount tiers."),
           ),
         }),
-        v.description("Array of staking discount tiers."),
+        v.description("Fee schedule information."),
       ),
       /** User cross-trade rate. */
       userCrossRate: v.pipe(
@@ -258,15 +242,17 @@ export const UserFeesResponse = /* @__PURE__ */ (() => {
               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",
+                  "\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.",
               ),
             ),
           }),
         ),
         v.description(
-          "Permanent link between staking and trading accounts. Staking user gains full control of trading account funds. Staking user forfeits own fee discounts.",
+          "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. */
@@ -295,7 +281,7 @@ export type UserFeesResponse = v.InferOutput<typeof UserFeesResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userFees} function. */
 export type UserFeesParameters = Omit<v.InferInput<typeof UserFeesRequest>, "type">;
@@ -305,7 +291,7 @@ export type UserFeesParameters = Omit<v.InferInput<typeof UserFeesRequest>, "typ
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns User fees.
  *

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

@@ -4,7 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Address, Decimal, Hex, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+import { Address, Cloid, UnsignedDecimal } from "../../_schemas.js";
+import { UserFillSchema } from "./_base/commonSchemas.js";
 
 /**
  * Request array of user fills.
@@ -41,76 +42,12 @@ export type UserFillsRequest = v.InferOutput<typeof UserFillsRequest>;
 export const UserFillsResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      v.pipe(
+      v.intersect([
+        UserFillSchema,
         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.picklist(["B", "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.optional(Cloid),
             v.description("Client Order ID."),
           ),
           /** Liquidation details. */
@@ -136,19 +73,8 @@ export const UserFillsResponse = /* @__PURE__ */ (() => {
             ),
             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.nullable(UnsignedInteger),
-            v.description("ID of the TWAP."),
-          ),
         }),
-        v.description("Order fill record."),
-      ),
+      ]),
     ),
     v.description("Array of user trade fills."),
   );
@@ -159,7 +85,7 @@ export type UserFillsResponse = v.InferOutput<typeof UserFillsResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userFills} function. */
 export type UserFillsParameters = Omit<v.InferInput<typeof UserFillsRequest>, "type">;
@@ -169,7 +95,7 @@ export type UserFillsParameters = Omit<v.InferInput<typeof UserFillsRequest>, "t
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Array of user trade fills.
  *

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

@@ -61,7 +61,7 @@ export type UserFillsByTimeResponse = v.InferOutput<typeof UserFillsByTimeRespon
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userFillsByTime} function. */
 export type UserFillsByTimeParameters = Omit<v.InferInput<typeof UserFillsByTimeRequest>, "type">;
@@ -71,7 +71,7 @@ export type UserFillsByTimeParameters = Omit<v.InferInput<typeof UserFillsByTime
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Array of user trade fills by time.
  *

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

@@ -25,7 +25,7 @@ export const UserFundingRequest = /* @__PURE__ */ (() => {
       ),
       /** Start time (in ms since epoch). */
       startTime: v.pipe(
-        UnsignedInteger,
+        v.nullish(UnsignedInteger),
         v.description("Start time (in ms since epoch)."),
       ),
       /** End time (in ms since epoch). */
@@ -46,58 +46,55 @@ export type UserFundingRequest = v.InferOutput<typeof UserFundingRequest>;
 export const UserFundingResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** User funding ledger update. */
-      v.pipe(
-        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(
-            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."),
-          ),
-        }),
-        v.description("User funding ledger update."),
-      ),
+      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."),
+        ),
+      }),
     ),
     v.description("Array of user funding ledger updates."),
   );
@@ -108,7 +105,7 @@ export type UserFundingResponse = v.InferOutput<typeof UserFundingResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userFunding} function. */
 export type UserFundingParameters = Omit<v.InferInput<typeof UserFundingRequest>, "type">;
@@ -118,7 +115,7 @@ export type UserFundingParameters = Omit<v.InferInput<typeof UserFundingRequest>
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Array of user funding ledger updates.
  *
@@ -134,7 +131,7 @@ export type UserFundingParameters = Omit<v.InferInput<typeof UserFundingRequest>
  *
  * const data = await userFunding(
  *   { transport },
- *   { user: "0x...", startTime: Date.now() - 1000 * 60 * 60 * 24 },
+ *   { user: "0x..." },
  * );
  * ```
  *