@nktkas/hyperliquid 0.25.2 → 0.25.4

package/src/src/api/exchange/~client.ts

@@ -4,6 +4,7 @@ import type { IRequestTransport } from "../../transport/base.js";
 import type { AbstractWallet } from "../../signing/mod.js";
 import { PrivateKeyEIP712Signer } from "../../utils/minimalEIP712Signer.js";
 
+import { agentEnableDexAbstraction } from "./agentEnableDexAbstraction.js";
 import { approveAgent } from "./approveAgent.js";
 import { approveBuilderFee } from "./approveBuilderFee.js";
 import { batchModify } from "./batchModify.js";
@@ -42,51 +43,56 @@ import { updateIsolatedMargin } from "./updateIsolatedMargin.js";
 import { updateLeverage } from "./updateLeverage.js";
 import { usdClassTransfer } from "./usdClassTransfer.js";
 import { usdSend } from "./usdSend.js";
+import { userDexAbstraction } from "./userDexAbstraction.js";
 import { vaultDistribute } from "./vaultDistribute.js";
 import { vaultModify } from "./vaultModify.js";
 import { vaultTransfer } from "./vaultTransfer.js";
 import { withdraw3 } from "./withdraw3.js";
 
-export type { ApproveAgentParameters } from "./approveAgent.js";
-export type { ApproveBuilderFeeParameters } from "./approveBuilderFee.js";
-export type { BatchModifyParameters } from "./batchModify.js";
-export type { CancelParameters } from "./cancel.js";
-export type { CancelByCloidParameters } from "./cancelByCloid.js";
-export type { CDepositParameters } from "./cDeposit.js";
-export type { ConvertToMultiSigUserParameters } from "./convertToMultiSigUser.js";
-export type { CreateSubAccountParameters } from "./createSubAccount.js";
-export type { CreateVaultParameters } from "./createVault.js";
-export type { CSignerActionParameters } from "./cSignerAction.js";
-export type { CValidatorActionParameters } from "./cValidatorAction.js";
-export type { CWithdrawParameters } from "./cWithdraw.js";
-export type { EvmUserModifyParameters } from "./evmUserModify.js";
-export type { ModifyParameters } from "./modify.js";
-export type { MultiSigParameters } from "./multiSig.js";
-export type { OrderParameters } from "./order.js";
-export type { PerpDeployParameters } from "./perpDeploy.js";
-export type { RegisterReferrerParameters } from "./registerReferrer.js";
-export type { ReserveRequestWeightParameters } from "./reserveRequestWeight.js";
-export type { ScheduleCancelParameters } from "./scheduleCancel.js";
-export type { SendAssetParameters } from "./sendAsset.js";
-export type { SetDisplayNameParameters } from "./setDisplayName.js";
-export type { SetReferrerParameters } from "./setReferrer.js";
-export type { SpotDeployParameters } from "./spotDeploy.js";
-export type { SpotSendParameters } from "./spotSend.js";
-export type { SpotUserParameters } from "./spotUser.js";
-export type { SubAccountModifyParameters } from "./subAccountModify.js";
-export type { SubAccountSpotTransferParameters } from "./subAccountSpotTransfer.js";
-export type { SubAccountTransferParameters } from "./subAccountTransfer.js";
-export type { TokenDelegateParameters } from "./tokenDelegate.js";
-export type { TwapCancelParameters } from "./twapCancel.js";
-export type { TwapOrderParameters } from "./twapOrder.js";
-export type { UpdateIsolatedMarginParameters } from "./updateIsolatedMargin.js";
-export type { UpdateLeverageParameters } from "./updateLeverage.js";
-export type { UsdClassTransferParameters } from "./usdClassTransfer.js";
-export type { UsdSendParameters } from "./usdSend.js";
-export type { VaultDistributeParameters } from "./vaultDistribute.js";
-export type { VaultModifyParameters } from "./vaultModify.js";
-export type { VaultTransferParameters } from "./vaultTransfer.js";
-export type { Withdraw3Parameters } from "./withdraw3.js";
+export type { AgentEnableDexAbstractionOptions } from "./agentEnableDexAbstraction.js";
+export type { ApproveAgentOptions, ApproveAgentParameters } from "./approveAgent.js";
+export type { ApproveBuilderFeeOptions, ApproveBuilderFeeParameters } from "./approveBuilderFee.js";
+export type { BatchModifyOptions, BatchModifyParameters } from "./batchModify.js";
+export type { CancelOptions, CancelParameters } from "./cancel.js";
+export type { CancelByCloidOptions, CancelByCloidParameters } from "./cancelByCloid.js";
+export type { CDepositOptions, CDepositParameters } from "./cDeposit.js";
+export type { ClaimRewardsOptions } from "./claimRewards.js";
+export type { ConvertToMultiSigUserOptions, ConvertToMultiSigUserParameters } from "./convertToMultiSigUser.js";
+export type { CreateSubAccountOptions, CreateSubAccountParameters } from "./createSubAccount.js";
+export type { CreateVaultOptions, CreateVaultParameters } from "./createVault.js";
+export type { CSignerActionOptions, CSignerActionParameters } from "./cSignerAction.js";
+export type { CValidatorActionOptions, CValidatorActionParameters } from "./cValidatorAction.js";
+export type { CWithdrawOptions, CWithdrawParameters } from "./cWithdraw.js";
+export type { EvmUserModifyOptions, EvmUserModifyParameters } from "./evmUserModify.js";
+export type { ModifyOptions, ModifyParameters } from "./modify.js";
+export type { MultiSigOptions, MultiSigParameters } from "./multiSig.js";
+export type { OrderOptions, OrderParameters } from "./order.js";
+export type { NoopOptions } from "./noop.js";
+export type { PerpDeployOptions, PerpDeployParameters } from "./perpDeploy.js";
+export type { RegisterReferrerOptions, RegisterReferrerParameters } from "./registerReferrer.js";
+export type { ReserveRequestWeightOptions, ReserveRequestWeightParameters } from "./reserveRequestWeight.js";
+export type { ScheduleCancelOptions, ScheduleCancelParameters } from "./scheduleCancel.js";
+export type { SendAssetOptions, SendAssetParameters } from "./sendAsset.js";
+export type { SetDisplayNameOptions, SetDisplayNameParameters } from "./setDisplayName.js";
+export type { SetReferrerOptions, SetReferrerParameters } from "./setReferrer.js";
+export type { SpotDeployOptions, SpotDeployParameters } from "./spotDeploy.js";
+export type { SpotSendOptions, SpotSendParameters } from "./spotSend.js";
+export type { SpotUserOptions, SpotUserParameters } from "./spotUser.js";
+export type { SubAccountModifyOptions, SubAccountModifyParameters } from "./subAccountModify.js";
+export type { SubAccountSpotTransferOptions, SubAccountSpotTransferParameters } from "./subAccountSpotTransfer.js";
+export type { SubAccountTransferOptions, SubAccountTransferParameters } from "./subAccountTransfer.js";
+export type { TokenDelegateOptions, TokenDelegateParameters } from "./tokenDelegate.js";
+export type { TwapCancelOptions, TwapCancelParameters } from "./twapCancel.js";
+export type { TwapOrderOptions, TwapOrderParameters } from "./twapOrder.js";
+export type { UpdateIsolatedMarginOptions, UpdateIsolatedMarginParameters } from "./updateIsolatedMargin.js";
+export type { UpdateLeverageOptions, UpdateLeverageParameters } from "./updateLeverage.js";
+export type { UsdClassTransferOptions, UsdClassTransferParameters } from "./usdClassTransfer.js";
+export type { UsdSendOptions, UsdSendParameters } from "./usdSend.js";
+export type { UserDexAbstractionExchangeOptions, UserDexAbstractionExchangeParameters } from "./userDexAbstraction.js";
+export type { VaultDistributeOptions, VaultDistributeParameters } from "./vaultDistribute.js";
+export type { VaultModifyOptions, VaultModifyParameters } from "./vaultModify.js";
+export type { VaultTransferOptions, VaultTransferParameters } from "./vaultTransfer.js";
+export type { Withdraw3Options, Withdraw3Parameters } from "./withdraw3.js";
 
 export type { CancelSuccessResponse } from "./cancel.js";
 export type { CreateSubAccountResponse } from "./createSubAccount.js";
@@ -178,6 +184,31 @@ export class ExchangeClient<
     this.nonceManager = args.nonceManager;
   }
 
+  /**
+   * Enable HIP-3 DEX abstraction.
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   * @returns Successful response without specific data.
+   *
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see null
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const pk = "0x..."; // viem, ethers or private key
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   *
+   * const client = new hl.ExchangeClient({ transport, wallet: pk });
+   * await client.agentEnableDexAbstraction();
+   * ```
+   */
+  agentEnableDexAbstraction(...args: OmitFirst<OverloadedParameters<typeof agentEnableDexAbstraction>>) {
+    return agentEnableDexAbstraction(this, ...args);
+  }
+
   /**
    * Approve an agent to sign on behalf of the master account.
    * @param params - Parameters specific to the API request.
@@ -1315,6 +1346,31 @@ export class ExchangeClient<
     return usdSend(this, ...args);
   }
 
+  /**
+   * Enable/disable HIP-3 DEX abstraction.
+   * @param params - Parameters specific to the API request.
+   * @param opts - Request execution options.
+   * @returns Successful response without specific data.
+   *
+   * @throws {ApiRequestError} When the API returns an unsuccessful response.
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see null
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const pk = "0x..."; // viem, ethers or private key
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   *
+   * const client = new hl.ExchangeClient({ transport, wallet: pk });
+   * await client.userDexAbstraction({ user: "0x...", enabled: true });
+   * ```
+   */
+  userDexAbstraction(...args: OmitFirst<OverloadedParameters<typeof userDexAbstraction>>) {
+    return userDexAbstraction(this, ...args);
+  }
+
   /**
    * Distribute funds from a vault between followers.
    * @param params - Parameters specific to the API request.

package/src/src/api/exchange/~mod.ts

@@ -40,6 +40,7 @@
 export { parser, SchemaError } from "../_base.js";
 export type { ExchangeRequestConfig } from "./_base.js";
 
+export * from "./agentEnableDexAbstraction.js";
 export * from "./approveAgent.js";
 export * from "./approveBuilderFee.js";
 export * from "./batchModify.js";
@@ -78,6 +79,7 @@ export * from "./updateIsolatedMargin.js";
 export * from "./updateLeverage.js";
 export * from "./usdClassTransfer.js";
 export * from "./usdSend.js";
+export * from "./userDexAbstraction.js";
 export * from "./vaultDistribute.js";
 export * from "./vaultModify.js";
 export * from "./vaultTransfer.js";

package/src/src/api/info/activeAssetData.ts

@@ -64,10 +64,10 @@ export const ActiveAssetDataResponse = /* @__PURE__ */ (() => {
               v.minValue(1),
               v.description("Leverage value used."),
             ),
-            /** Amount of USD used (1 = 1$). */
+            /** Amount of USD used (1 = $1). */
             rawUsd: v.pipe(
               UnsignedDecimal,
-              v.description("Amount of USD used (1 = 1$)."),
+              v.description("Amount of USD used (1 = $1)."),
             ),
           }),
           v.object({

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

@@ -140,10 +140,10 @@ export const ClearinghouseStateResponse = /* @__PURE__ */ (() => {
                           v.minValue(1),
                           v.description("Leverage value used."),
                         ),
-                        /** Amount of USD used (1 = 1$). */
+                        /** Amount of USD used (1 = $1). */
                         rawUsd: v.pipe(
                           UnsignedDecimal,
-                          v.description("Amount of USD used (1 = 1$)."),
+                          v.description("Amount of USD used (1 = $1)."),
                         ),
                       }),
                       v.object({

package/src/src/api/info/twapHistory.ts

@@ -48,6 +48,11 @@ export const TwapHistoryResponse = /* @__PURE__ */ (() => {
           state: TwapStateSchema,
           /** Current status of the TWAP order. */
           status: TwapStatusSchema,
+          /** ID of the TWAP. */
+          twapId: v.pipe(
+            v.optional(UnsignedInteger),
+            v.description("ID of the TWAP."),
+          ),
         }),
         v.description("TWAP history record."),
       ),

package/src/src/api/info/userDexAbstraction.ts

@@ -0,0 +1,79 @@
+import * as v from "valibot";
+import { Address, type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request user HIP-3 DEX abstraction state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-hip-3-dex-abstraction-state
+ */
+export const UserDexAbstractionInfoRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("userDexAbstraction"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request user referral."),
+  );
+})();
+export type UserDexAbstractionInfoRequest = v.InferOutput<typeof UserDexAbstractionInfoRequest>;
+
+/**
+ * User HIP-3 DEX abstraction state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-hip-3-dex-abstraction-state
+ */
+export const UserDexAbstractionInfoResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.nullable(v.boolean()),
+    v.description("User HIP-3 DEX abstraction state."),
+  );
+})();
+export type UserDexAbstractionInfoResponse = v.InferOutput<typeof UserDexAbstractionInfoResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode userDexAbstraction} function. */
+export type UserDexAbstractionInfoParameters = Omit<v.InferInput<typeof UserDexAbstractionInfoRequest>, "type">;
+
+/**
+ * Request user HIP-3 DEX abstraction state.
+ * @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 HIP-3 DEX abstraction state.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-hip-3-dex-abstraction-state
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userDexAbstraction } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userDexAbstraction(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function userDexAbstraction(
+  config: InfoRequestConfig,
+  params: DeepImmutable<UserDexAbstractionInfoParameters>,
+  signal?: AbortSignal,
+): Promise<UserDexAbstractionInfoResponse> {
+  const request = parser(UserDexAbstractionInfoRequest)({
+    type: "userDexAbstraction",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/~client.ts

@@ -49,6 +49,7 @@ import { tokenDetails } from "./tokenDetails.js";
 import { twapHistory } from "./twapHistory.js";
 import { txDetails } from "./txDetails.js";
 import { userDetails } from "./userDetails.js";
+import { userDexAbstraction } from "./userDexAbstraction.js";
 import { userFees } from "./userFees.js";
 import { userFills } from "./userFills.js";
 import { userFillsByTime } from "./userFillsByTime.js";
@@ -113,6 +114,7 @@ export type { TokenDetailsParameters, TokenDetailsResponse } from "./tokenDetail
 export type { TwapHistoryParameters, TwapHistoryResponse } from "./twapHistory.js";
 export type { TxDetailsParameters, TxDetailsResponse } from "./txDetails.js";
 export type { UserDetailsParameters, UserDetailsResponse } from "./userDetails.js";
+export type { UserDexAbstractionInfoParameters, UserDexAbstractionInfoResponse } from "./userDexAbstraction.js";
 export type { UserFeesParameters, UserFeesResponse } from "./userFees.js";
 export type { UserFillsParameters, UserFillsResponse } from "./userFills.js";
 export type { UserFillsByTimeParameters, UserFillsByTimeResponse } from "./userFillsByTime.js";
@@ -1261,6 +1263,29 @@ export class InfoClient<T extends IRequestTransport = IRequestTransport> impleme
     return userDetails(this, ...args);
   }
 
+  /**
+   * Request user HIP-3 DEX abstraction state.
+   * @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 HIP-3 DEX abstraction state.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-hip-3-dex-abstraction-state
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.HttpTransport(); // only `HttpTransport` supports this API
+   *
+   * const client = new hl.InfoClient({ transport });
+   * const data = await client.userDexAbstraction({ user: "0x..." });
+   * ```
+   */
+  userDexAbstraction(...args: OmitFirst<OverloadedParameters<typeof userDexAbstraction>>) {
+    return userDexAbstraction(this, ...args);
+  }
+
   /**
    * Request user fees.
    * @param params - Parameters specific to the API request.

package/src/src/api/info/~mod.ts

@@ -71,6 +71,7 @@ export * from "./tokenDetails.js";
 export * from "./twapHistory.js";
 export * from "./txDetails.js";
 export * from "./userDetails.js";
+export * from "./userDexAbstraction.js";
 export * from "./userFees.js";
 export * from "./userFills.js";
 export * from "./userFillsByTime.js";

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

@@ -51,6 +51,11 @@ export const UserTwapHistoryEvent = /* @__PURE__ */ (() => {
               state: TwapStateSchema,
               /** Current status of the TWAP order. */
               status: TwapStatusSchema,
+              /** ID of the TWAP. */
+              twapId: v.pipe(
+                v.optional(UnsignedInteger),
+                v.description("ID of the TWAP."),
+              ),
             }),
             v.description("TWAP history record."),
           ),