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

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

@@ -106,127 +106,123 @@ export const ClearinghouseStateResponse = /* @__PURE__ */ (() => {
       /** Array of asset positions. */
       assetPositions: v.pipe(
         v.array(
-          /** Position for a specific asset. */
-          v.pipe(
-            v.object({
-              /** Position type. */
-              type: v.pipe(
-                v.literal("oneWay"),
-                v.description("Position type."),
-              ),
-              /** Position details. */
-              position: v.pipe(
-                v.object({
-                  /** Asset symbol. */
-                  coin: v.pipe(
-                    v.string(),
-                    v.description("Asset symbol."),
-                  ),
-                  /** Signed position size. */
-                  szi: v.pipe(
-                    Decimal,
-                    v.description("Signed position size."),
-                  ),
-                  /** Leverage details. */
-                  leverage: v.pipe(
-                    v.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({
+            /** 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({
-                      /** Total funding paid or received since account opening. */
-                      allTime: v.pipe(
-                        Decimal,
-                        v.description("Total funding paid or received since account opening."),
+                      /** Leverage type. */
+                      type: v.pipe(
+                        v.literal("isolated"),
+                        v.description("Leverage type."),
                       ),
-                      /** Funding accumulated since the position was opened. */
-                      sinceOpen: v.pipe(
-                        Decimal,
-                        v.description("Funding accumulated since the position was opened."),
+                      /** Leverage value used. */
+                      value: v.pipe(
+                        UnsignedInteger,
+                        v.minValue(1),
+                        v.description("Leverage value used."),
                       ),
-                      /** Funding accumulated since the last change in position size. */
-                      sinceChange: v.pipe(
-                        Decimal,
-                        v.description("Funding accumulated since the last change in position size."),
+                      /** Amount of USD used (1 = $1). */
+                      rawUsd: v.pipe(
+                        UnsignedDecimal,
+                        v.description("Amount of USD used (1 = $1)."),
                       ),
                     }),
-                    v.description("Cumulative funding details."),
-                  ),
-                }),
-                v.description("Position details."),
-              ),
-            }),
-            v.description("Position for a specific asset."),
-          ),
+                    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."),
       ),
@@ -245,7 +241,7 @@ export type ClearinghouseStateResponse = v.InferOutput<typeof ClearinghouseState
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode clearinghouseState} function. */
 export type ClearinghouseStateParameters = Omit<v.InferInput<typeof ClearinghouseStateRequest>, "type">;
@@ -255,7 +251,7 @@ export type ClearinghouseStateParameters = Omit<v.InferInput<typeof Clearinghous
  *
  * @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 Account summary for perpetual trading.
  *

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

@@ -36,27 +36,23 @@ export type DelegationsRequest = v.InferOutput<typeof DelegationsRequest>;
 export const DelegationsResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** User delegation to a validator. */
-      v.pipe(
-        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("User delegation to a validator."),
-      ),
+      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."),
   );
@@ -67,7 +63,7 @@ export type DelegationsResponse = v.InferOutput<typeof DelegationsResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode delegations} function. */
 export type DelegationsParameters = Omit<v.InferInput<typeof DelegationsRequest>, "type">;
@@ -77,7 +73,7 @@ export type DelegationsParameters = Omit<v.InferInput<typeof DelegationsRequest>
  *
  * @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's delegations to validators.
  *

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

@@ -36,82 +36,79 @@ export type DelegatorHistoryRequest = v.InferOutput<typeof DelegatorHistoryReque
 export const DelegatorHistoryResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** Record of a staking event by a delegator. */
-      v.pipe(
-        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(
-            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("Record of a staking event by a delegator."),
-      ),
+      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."),
   );
@@ -122,7 +119,7 @@ export type DelegatorHistoryResponse = v.InferOutput<typeof DelegatorHistoryResp
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode delegatorHistory} function. */
 export type DelegatorHistoryParameters = Omit<v.InferInput<typeof DelegatorHistoryRequest>, "type">;
@@ -132,7 +129,7 @@ export type DelegatorHistoryParameters = Omit<v.InferInput<typeof DelegatorHisto
  *
  * @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 records of staking events by a delegator.
  *

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

@@ -36,27 +36,23 @@ export type DelegatorRewardsRequest = v.InferOutput<typeof DelegatorRewardsReque
 export const DelegatorRewardsResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** Reward received from staking activities. */
-      v.pipe(
-        v.object({
-          /** Timestamp when the reward was received (in ms since epoch). */
-          time: v.pipe(
-            UnsignedInteger,
-            v.description("Timestamp when the reward was received (in ms since epoch)."),
-          ),
-          /** Source of the reward. */
-          source: v.pipe(
-            v.picklist(["delegation", "commission"]),
-            v.description("Source of the reward."),
-          ),
-          /** Total reward amount. */
-          totalAmount: v.pipe(
-            UnsignedDecimal,
-            v.description("Total reward amount."),
-          ),
-        }),
-        v.description("Reward received from staking activities."),
-      ),
+      v.object({
+        /** Timestamp when the reward was received (in ms since epoch). */
+        time: v.pipe(
+          UnsignedInteger,
+          v.description("Timestamp when the reward was received (in ms since epoch)."),
+        ),
+        /** Source of the reward. */
+        source: v.pipe(
+          v.picklist(["delegation", "commission"]),
+          v.description("Source of the reward."),
+        ),
+        /** Total reward amount. */
+        totalAmount: v.pipe(
+          UnsignedDecimal,
+          v.description("Total reward amount."),
+        ),
+      }),
     ),
     v.description("Array of rewards received from staking activities."),
   );
@@ -67,7 +63,7 @@ export type DelegatorRewardsResponse = v.InferOutput<typeof DelegatorRewardsResp
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode delegatorRewards} function. */
 export type DelegatorRewardsParameters = Omit<v.InferInput<typeof DelegatorRewardsRequest>, "type">;
@@ -77,7 +73,7 @@ export type DelegatorRewardsParameters = Omit<v.InferInput<typeof DelegatorRewar
  *
  * @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 rewards received from staking activities.
  *

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

@@ -66,7 +66,7 @@ export type DelegatorSummaryResponse = v.InferOutput<typeof DelegatorSummaryResp
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode delegatorSummary} function. */
 export type DelegatorSummaryParameters = Omit<v.InferInput<typeof DelegatorSummaryRequest>, "type">;
@@ -76,7 +76,7 @@ export type DelegatorSummaryParameters = Omit<v.InferInput<typeof DelegatorSumma
  *
  * @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's staking summary.
  *

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

@@ -34,8 +34,10 @@ export const ExchangeStatusResponse = /* @__PURE__ */ (() => {
         UnsignedInteger,
         v.description("Server time (in ms since epoch)."),
       ),
+      /** Special statuses of the exchange system. */
       specialStatuses: v.pipe(
         v.nullable(v.unknown()),
+        v.description("Special statuses of the exchange system."),
       ),
     }),
     v.description("Exchange system status information."),
@@ -47,13 +49,13 @@ export type ExchangeStatusResponse = v.InferOutput<typeof ExchangeStatusResponse
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /**
  * Request exchange system status information.
  *
  * @param config - General configuration for Info API requests.
- * @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 Exchange system status information.
  *