@nktkas/hyperliquid 0.25.1 → 0.25.2

package/src/src/api/subscription/userNonFundingLedgerUpdates.ts

@@ -1,8 +1,10 @@
 import * as v from "valibot";
-import { Address, Decimal, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
+import { UserNonFundingLedgerUpdatesResponse } from "../info/userNonFundingLedgerUpdates.js";
+
 // -------------------- Schemas --------------------
 
 /** Subscription to user non-funding ledger updates for a specific user. */
@@ -25,409 +27,6 @@ export const UserNonFundingLedgerUpdatesRequest = /* @__PURE__ */ (() => {
 })();
 export type UserNonFundingLedgerUpdatesRequest = v.InferOutput<typeof UserNonFundingLedgerUpdatesRequest>;
 
-/** Transfer between spot and perpetual accounts. */
-export const AccountClassTransferUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("accountClassTransfer"),
-        v.description("Update type."),
-      ),
-      /** Amount transferred in USDC. */
-      usdc: v.pipe(
-        UnsignedDecimal,
-        v.description("Amount transferred in USDC."),
-      ),
-      /** Indicates if the transfer is to the perpetual account. */
-      toPerp: v.pipe(
-        v.boolean(),
-        v.description("Indicates if the transfer is to the perpetual account."),
-      ),
-    }),
-    v.description("Transfer between spot and perpetual accounts."),
-  );
-})();
-export type AccountClassTransferUpdate = v.InferOutput<typeof AccountClassTransferUpdate>;
-
-/** Deposit update to an account. */
-export const DepositUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("deposit"),
-        v.description("Update type."),
-      ),
-      /** Amount deposited in USDC. */
-      usdc: v.pipe(
-        UnsignedDecimal,
-        v.description("Amount deposited in USDC."),
-      ),
-    }),
-    v.description("Deposit update to an account."),
-  );
-})();
-export type DepositUpdate = v.InferOutput<typeof DepositUpdate>;
-
-/** Internal transfer between accounts. */
-export const InternalTransferUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("internalTransfer"),
-        v.description("Update type."),
-      ),
-      /** Amount transferred in USDC. */
-      usdc: v.pipe(
-        UnsignedDecimal,
-        v.description("Amount transferred in USDC."),
-      ),
-      /** Initiator address. */
-      user: v.pipe(
-        Address,
-        v.description("Initiator address."),
-      ),
-      /** Destination address. */
-      destination: v.pipe(
-        Address,
-        v.description("Destination address."),
-      ),
-      /** Transfer fee. */
-      fee: v.pipe(
-        UnsignedDecimal,
-        v.description("Transfer fee."),
-      ),
-    }),
-    v.description("Internal transfer between accounts."),
-  );
-})();
-export type InternalTransferUpdate = v.InferOutput<typeof InternalTransferUpdate>;
-
-/** Liquidation event update. */
-export const LiquidationUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("liquidation"),
-        v.description("Update type."),
-      ),
-      /** Total notional value of liquidated positions. */
-      liquidatedNtlPos: v.pipe(
-        UnsignedDecimal,
-        v.description("Total notional value of liquidated positions."),
-      ),
-      /** Account value at liquidation time. */
-      accountValue: v.pipe(
-        UnsignedDecimal,
-        v.description("Account value at liquidation time."),
-      ),
-      /** Leverage type for liquidated positions. */
-      leverageType: v.pipe(
-        v.union([v.literal("Cross"), v.literal("Isolated")]),
-        v.description("Leverage type for liquidated positions."),
-      ),
-      /** Details of each liquidated position. */
-      liquidatedPositions: v.pipe(
-        v.array(
-          /** Liquidated position. */
-          v.pipe(
-            v.object({
-              /** Asset symbol of the liquidated position. */
-              coin: v.pipe(
-                v.string(),
-                v.description("Asset symbol of the liquidated position."),
-              ),
-              /** Signed position size liquidated. */
-              szi: v.pipe(
-                Decimal,
-                v.description("Signed position size liquidated."),
-              ),
-            }),
-            v.description("Liquidated position."),
-          ),
-        ),
-        v.description("Details of each liquidated position."),
-      ),
-    }),
-    v.description("Liquidation event update."),
-  );
-})();
-export type LiquidationUpdate = v.InferOutput<typeof LiquidationUpdate>;
-
-/** Rewards claim event update. */
-export const RewardsClaimUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("rewardsClaim"),
-        v.description("Update type."),
-      ),
-      /** Amount of rewards claimed. */
-      amount: v.pipe(
-        UnsignedDecimal,
-        v.description("Amount of rewards claimed."),
-      ),
-      /** Token symbol. */
-      token: v.pipe(
-        v.string(),
-        v.description("Token symbol."),
-      ),
-    }),
-    v.description("Rewards claim event update."),
-  );
-})();
-export type RewardsClaimUpdate = v.InferOutput<typeof RewardsClaimUpdate>;
-
-/** Spot transfer update between accounts. */
-export const SpotTransferUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("spotTransfer"),
-        v.description("Update type."),
-      ),
-      /** Token symbol. */
-      token: v.pipe(
-        v.string(),
-        v.description("Token symbol."),
-      ),
-      /** Amount transferred. */
-      amount: v.pipe(
-        UnsignedDecimal,
-        v.description("Amount transferred."),
-      ),
-      /** Equivalent USDC value. */
-      usdcValue: v.pipe(
-        UnsignedDecimal,
-        v.description("Equivalent USDC value."),
-      ),
-      /** Initiator address. */
-      user: v.pipe(
-        Address,
-        v.description("Initiator address."),
-      ),
-      /** Destination address. */
-      destination: v.pipe(
-        Address,
-        v.description("Destination address."),
-      ),
-      /** Transfer fee. */
-      fee: v.pipe(
-        UnsignedDecimal,
-        v.description("Transfer fee."),
-      ),
-      /** Fee in native token. */
-      nativeTokenFee: v.pipe(
-        UnsignedDecimal,
-        v.description("Fee in native token."),
-      ),
-      nonce: v.null(),
-      /** 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").'),
-      ),
-    }),
-    v.description("Spot transfer update between accounts."),
-  );
-})();
-export type SpotTransferUpdate = v.InferOutput<typeof SpotTransferUpdate>;
-
-/** Transfer update between sub-accounts. */
-export const SubAccountTransferUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("subAccountTransfer"),
-        v.description("Update type."),
-      ),
-      /** Amount transferred in USDC. */
-      usdc: v.pipe(
-        UnsignedDecimal,
-        v.description("Amount transferred in USDC."),
-      ),
-      /** Initiator address. */
-      user: v.pipe(
-        Address,
-        v.description("Initiator address."),
-      ),
-      /** Destination address. */
-      destination: v.pipe(
-        Address,
-        v.description("Destination address."),
-      ),
-    }),
-    v.description("Transfer update between sub-accounts."),
-  );
-})();
-export type SubAccountTransferUpdate = v.InferOutput<typeof SubAccountTransferUpdate>;
-
-/** Vault creation update. */
-export const VaultCreateUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("vaultCreate"),
-        v.description("Update type."),
-      ),
-      /** Address of the created vault. */
-      vault: v.pipe(
-        Address,
-        v.description("Address of the created vault."),
-      ),
-      /** Initial allocated amount in USDC. */
-      usdc: v.pipe(
-        UnsignedDecimal,
-        v.description("Initial allocated amount in USDC."),
-      ),
-      /** Vault creation fee. */
-      fee: v.pipe(
-        UnsignedDecimal,
-        v.description("Vault creation fee."),
-      ),
-    }),
-    v.description("Vault creation update."),
-  );
-})();
-export type VaultCreateUpdate = v.InferOutput<typeof VaultCreateUpdate>;
-
-/** Vault deposit update. */
-export const VaultDepositUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("vaultDeposit"),
-        v.description("Update type."),
-      ),
-      /** Address of the target vault. */
-      vault: v.pipe(
-        Address,
-        v.description("Address of the target vault."),
-      ),
-      /** Amount deposited in USDC. */
-      usdc: v.pipe(
-        UnsignedDecimal,
-        v.description("Amount deposited in USDC."),
-      ),
-    }),
-    v.description("Vault deposit update."),
-  );
-})();
-export type VaultDepositUpdate = v.InferOutput<typeof VaultDepositUpdate>;
-
-/** Vault distribution update. */
-export const VaultDistributionUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("vaultDistribution"),
-        v.description("Update type."),
-      ),
-      /** Address of the vault distributing funds. */
-      vault: v.pipe(
-        Address,
-        v.description("Address of the vault distributing funds."),
-      ),
-      /** Amount distributed in USDC. */
-      usdc: v.pipe(
-        UnsignedDecimal,
-        v.description("Amount distributed in USDC."),
-      ),
-    }),
-    v.description("Vault distribution update."),
-  );
-})();
-export type VaultDistributionUpdate = v.InferOutput<typeof VaultDistributionUpdate>;
-
-/** Vault withdrawal event update. */
-export const VaultWithdrawUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("vaultWithdraw"),
-        v.description("Update type."),
-      ),
-      /** Vault address. */
-      vault: v.pipe(
-        Address,
-        v.description("Vault address."),
-      ),
-      /** Address of the user withdrawing funds. */
-      user: v.pipe(
-        Address,
-        v.description("Address of the user withdrawing funds."),
-      ),
-      /** Withdrawal request amount in USD. */
-      requestedUsd: v.pipe(
-        UnsignedDecimal,
-        v.description("Withdrawal request amount in USD."),
-      ),
-      /** Withdrawal commission fee. */
-      commission: v.pipe(
-        UnsignedDecimal,
-        v.description("Withdrawal commission fee."),
-      ),
-      /** Closing cost associated with positions. */
-      closingCost: v.pipe(
-        UnsignedDecimal,
-        v.description("Closing cost associated with positions."),
-      ),
-      /** Basis value for withdrawal calculation. */
-      basis: v.pipe(
-        UnsignedDecimal,
-        v.description("Basis value for withdrawal calculation."),
-      ),
-      /** Net withdrawn amount in USD after fees and costs. */
-      netWithdrawnUsd: v.pipe(
-        UnsignedDecimal,
-        v.description("Net withdrawn amount in USD after fees and costs."),
-      ),
-    }),
-    v.description("Vault withdrawal event update."),
-  );
-})();
-export type VaultWithdrawUpdate = v.InferOutput<typeof VaultWithdrawUpdate>;
-
-/** Withdrawal update from an account. */
-export const WithdrawUpdate = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Update type. */
-      type: v.pipe(
-        v.literal("withdraw"),
-        v.description("Update type."),
-      ),
-      /** Amount withdrawn in USDC. */
-      usdc: v.pipe(
-        UnsignedDecimal,
-        v.description("Amount withdrawn in USDC."),
-      ),
-      /** Unique nonce for the withdrawal request. */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Unique nonce for the withdrawal request."),
-      ),
-      /** Withdrawal fee. */
-      fee: v.pipe(
-        UnsignedDecimal,
-        v.description("Withdrawal fee."),
-      ),
-    }),
-    v.description("Withdrawal update from an account."),
-  );
-})();
-export type WithdrawUpdate = v.InferOutput<typeof WithdrawUpdate>;
-
 /** Event of user non-funding ledger updates. */
 export const UserNonFundingLedgerUpdatesEvent = /* @__PURE__ */ (() => {
   return v.pipe(
@@ -438,45 +37,7 @@ export const UserNonFundingLedgerUpdatesEvent = /* @__PURE__ */ (() => {
         v.description("User address."),
       ),
       /** Array of user's non-funding ledger update. */
-      nonFundingLedgerUpdates: v.pipe(
-        v.array(
-          /** User's non-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.union([
-                  AccountClassTransferUpdate,
-                  DepositUpdate,
-                  InternalTransferUpdate,
-                  LiquidationUpdate,
-                  RewardsClaimUpdate,
-                  SpotTransferUpdate,
-                  SubAccountTransferUpdate,
-                  VaultCreateUpdate,
-                  VaultDepositUpdate,
-                  VaultDistributionUpdate,
-                  VaultWithdrawUpdate,
-                  WithdrawUpdate,
-                ]),
-                v.description("Update details."),
-              ),
-            }),
-            v.description("User's non-funding ledger update."),
-          ),
-        ),
-        v.description("Array of user's non-funding ledger update."),
-      ),
+      nonFundingLedgerUpdates: UserNonFundingLedgerUpdatesResponse,
       /** Whether this is an initial snapshot. */
       isSnapshot: v.pipe(
         v.optional(v.literal(true)),
@@ -527,7 +88,7 @@ export function userNonFundingLedgerUpdates(
 ): Promise<Subscription> {
   const payload = parser(UserNonFundingLedgerUpdatesRequest)({ type: "userNonFundingLedgerUpdates", ...params });
   return config.transport.subscribe<UserNonFundingLedgerUpdatesEvent>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user.toLowerCase()) {
+    if (e.detail.user === payload.user) {
       listener(e.detail);
     }
   });

package/src/src/api/subscription/userTwapHistory.ts

@@ -1,8 +1,10 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
+import { TwapStateSchema, TwapStatusSchema } from "../_common_schemas.js";
+
 // -------------------- Schemas --------------------
 
 /** Subscription to user TWAP history events for a specific user. */
@@ -46,102 +48,9 @@ export const UserTwapHistoryEvent = /* @__PURE__ */ (() => {
                 v.description("Creation time of the history record (in seconds since epoch)."),
               ),
               /** State of the TWAP order. */
-              state: v.pipe(
-                v.object({
-                  /** Asset symbol. */
-                  coin: v.pipe(
-                    v.string(),
-                    v.description("Asset symbol."),
-                  ),
-                  /** Executed notional value. */
-                  executedNtl: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Executed notional value."),
-                  ),
-                  /** Executed size. */
-                  executedSz: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Executed size."),
-                  ),
-                  /** Duration in minutes. */
-                  minutes: v.pipe(
-                    UnsignedInteger,
-                    v.description("Duration in minutes."),
-                  ),
-                  /** Indicates if the TWAP randomizes execution. */
-                  randomize: v.pipe(
-                    v.boolean(),
-                    v.description("Indicates if the TWAP randomizes execution."),
-                  ),
-                  /** Indicates if the order is reduce-only. */
-                  reduceOnly: v.pipe(
-                    v.boolean(),
-                    v.description("Indicates if the order is reduce-only."),
-                  ),
-                  /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
-                  side: v.pipe(
-                    v.union([v.literal("B"), v.literal("A")]),
-                    v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).'),
-                  ),
-                  /** Order size. */
-                  sz: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Order size."),
-                  ),
-                  /** Start time of the TWAP order (in ms since epoch). */
-                  timestamp: v.pipe(
-                    UnsignedInteger,
-                    v.description("Start time of the TWAP order (in ms since epoch)."),
-                  ),
-                  /** User address. */
-                  user: v.pipe(
-                    Address,
-                    v.description("User address."),
-                  ),
-                }),
-                v.description("State of the TWAP order."),
-              ),
-              /**
-               * Current status of the TWAP order.
-               * - `"finished"`: Fully executed.
-               * - `"activated"`: Active and executing.
-               * - `"terminated"`: Terminated.
-               * - `"error"`: An error occurred.
-               */
-              status: v.pipe(
-                v.union([
-                  v.object({
-                    /** Status of the TWAP order. */
-                    status: v.pipe(
-                      v.union([
-                        v.literal("finished"),
-                        v.literal("activated"),
-                        v.literal("terminated"),
-                      ]),
-                      v.description("Status of the TWAP order."),
-                    ),
-                  }),
-                  v.object({
-                    /** Status of the TWAP order. */
-                    status: v.pipe(
-                      v.literal("error"),
-                      v.description("Status of the TWAP order."),
-                    ),
-                    /** Error message. */
-                    description: v.pipe(
-                      v.string(),
-                      v.description("Error message."),
-                    ),
-                  }),
-                ]),
-                v.description(
-                  "Current status of the TWAP order." +
-                    '\n- `"finished"`: Fully executed. ' +
-                    '\n- `"activated"`: Active and executing. ' +
-                    '\n- `"terminated"`: Terminated. ' +
-                    '\n- `"error"`: An error occurred.',
-                ),
-              ),
+              state: TwapStateSchema,
+              /** Current status of the TWAP order. */
+              status: TwapStatusSchema,
             }),
             v.description("TWAP history record."),
           ),
@@ -195,7 +104,7 @@ export function userTwapHistory(
 ): Promise<Subscription> {
   const payload = parser(UserTwapHistoryRequest)({ type: "userTwapHistory", ...params });
   return config.transport.subscribe<UserTwapHistoryEvent>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user.toLowerCase()) {
+    if (e.detail.user === payload.user) {
       listener(e.detail);
     }
   });