@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

package/src/src/api/info/userNonFundingLedgerUpdates.ts

@@ -0,0 +1,537 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, Decimal, Hex, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+
+/**
+ * Request user non-funding ledger updates.
+ * @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 UserNonFundingLedgerUpdatesRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("userNonFundingLedgerUpdates"),
+        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)."),
+      ),
+    }),
+    v.description("Request user non-funding ledger updates."),
+  );
+})();
+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>;
+
+/**
+ * Array of user's non-funding ledger update.
+ * @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 UserNonFundingLedgerUpdatesResponse = /* @__PURE__ */ (() => {
+  return 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.variant("type", [
+              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."),
+  );
+})();
+export type UserNonFundingLedgerUpdatesResponse = v.InferOutput<typeof UserNonFundingLedgerUpdatesResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode userNonFundingLedgerUpdates} function. */
+export type UserNonFundingLedgerUpdatesParameters = Omit<
+  v.InferInput<typeof UserNonFundingLedgerUpdatesRequest>,
+  "type"
+>;
+
+/**
+ * Request user non-funding ledger updates.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of user's non-funding ledger update.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userNonFundingLedgerUpdates } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userNonFundingLedgerUpdates(
+ *   { transport },
+ *   { user: "0x...", startTime: Date.now() - 1000 * 60 * 60 * 24 },
+ * );
+ * ```
+ */
+export function userNonFundingLedgerUpdates(
+  config: InfoRequestConfig,
+  params: DeepImmutable<UserNonFundingLedgerUpdatesParameters>,
+  signal?: AbortSignal,
+): Promise<UserNonFundingLedgerUpdatesResponse> {
+  const request = parser(UserNonFundingLedgerUpdatesRequest)({
+    type: "userNonFundingLedgerUpdates",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/userRateLimit.ts

@@ -0,0 +1,107 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+
+/**
+ * Request user rate limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+ */
+export const UserRateLimitRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("userRateLimit"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request user rate limits."),
+  );
+})();
+export type UserRateLimitRequest = v.InferOutput<typeof UserRateLimitRequest>;
+
+/**
+ * User rate limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+ */
+export const UserRateLimitResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Cumulative trading volume. */
+      cumVlm: v.pipe(
+        UnsignedDecimal,
+        v.description("Cumulative trading volume."),
+      ),
+      /** Number of API requests used. */
+      nRequestsUsed: v.pipe(
+        UnsignedInteger,
+        v.description("Number of API requests used."),
+      ),
+      /** Maximum allowed API requests. */
+      nRequestsCap: v.pipe(
+        UnsignedInteger,
+        v.description("Maximum allowed API requests."),
+      ),
+      /** Number of surplus API requests. */
+      nRequestsSurplus: v.pipe(
+        UnsignedInteger,
+        v.description("Number of surplus API requests."),
+      ),
+    }),
+    v.description("User rate limits."),
+  );
+})();
+export type UserRateLimitResponse = v.InferOutput<typeof UserRateLimitResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode userRateLimit} function. */
+export type UserRateLimitParameters = Omit<v.InferInput<typeof UserRateLimitRequest>, "type">;
+
+/**
+ * Request user rate limits.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns User rate limits.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userRateLimit } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userRateLimit(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function userRateLimit(
+  config: InfoRequestConfig,
+  params: DeepImmutable<UserRateLimitParameters>,
+  signal?: AbortSignal,
+): Promise<UserRateLimitResponse> {
+  const request = parser(UserRateLimitRequest)({
+    type: "userRateLimit",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}