@nktkas/hyperliquid 0.13.1 → 0.13.2

package/esm/src/clients/wallet.js

@@ -1,6 +1,6 @@
 import { sorters } from "../utils/key_sort.js";
 import { signL1Action, signUserSignedAction, } from "../utils/signing.js";
-// ———————————————Errors———————————————
+// ——————————————— Errors ———————————————
 /** Error thrown when the API returns an error response. */
 export class ApiRequestError extends Error {
     constructor(response) {
@@ -37,7 +37,7 @@ export class ApiRequestError extends Error {
         this.name = "ApiRequestError";
     }
 }
-// ———————————————Client———————————————
+// ——————————————— Client ———————————————
 /**
  * Wallet client for interacting with the Hyperliquid API.
  * @typeParam T - The transport used to connect to the Hyperliquid API.
@@ -74,10 +74,9 @@ export class WalletClient {
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      * import { createWalletClient, custom } from "viem";
-     * import { arbitrum } from "viem/chains";
      *
      * const [account] = await window.ethereum.request({ method: "eth_requestAccounts" });
-     * const wallet = createWalletClient({ account, chain: arbitrum, transport: custom(window.ethereum) });
+     * const wallet = createWalletClient({ account, transport: custom(window.ethereum) });
      *
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
@@ -122,10 +121,10 @@ export class WalletClient {
      * Approve an agent to sign on behalf of the master or sub-accounts.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-an-api-wallet | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-an-api-wallet
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -145,7 +144,7 @@ export class WalletClient {
             ...args,
             type: "approveAgent",
             hyperliquidChain: this.isTestnet ? "Testnet" : "Mainnet",
-            signatureChainId: args.signatureChainId ?? this.isTestnet ? "0x66eee" : "0xa4b1",
+            signatureChainId: args.signatureChainId ?? (this.isTestnet ? "0x66eee" : "0xa4b1"),
             nonce: args.nonce ?? Date.now(),
         };
         const signature = await signUserSignedAction(this.wallet, action, {
@@ -169,10 +168,10 @@ export class WalletClient {
      * Approve a max fee rate for a builder address.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-a-builder-fee | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-a-builder-fee
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -192,7 +191,7 @@ export class WalletClient {
             ...args,
             type: "approveBuilderFee",
             hyperliquidChain: this.isTestnet ? "Testnet" : "Mainnet",
-            signatureChainId: args.signatureChainId ?? this.isTestnet ? "0x66eee" : "0xa4b1",
+            signatureChainId: args.signatureChainId ?? (this.isTestnet ? "0x66eee" : "0xa4b1"),
             nonce: args.nonce ?? Date.now(),
         };
         const signature = await signUserSignedAction(this.wallet, action, {
@@ -216,10 +215,10 @@ export class WalletClient {
      * Modify multiple orders.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {OrderResponseSuccess} Successful variant of {@link OrderResponse} without error statuses.
+     * @returns Successful variant of {@link OrderResponse} without error statuses.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -267,10 +266,10 @@ export class WalletClient {
      * Cancel order(s).
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {CancelResponseSuccess} Successful variant of {@link CancelResponse} without error statuses.
+     * @returns Successful variant of {@link CancelResponse} without error statuses.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -303,13 +302,57 @@ export class WalletClient {
         return response;
     }
     /**
-     * Cancel order(s) by Client Order ID.
+     * Deposit into staking balance.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {CancelResponseSuccess} Successful variant of {@link CancelResponse} without error statuses.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-into-staking
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.cDeposit({ wei: 100000000 });
+     * ```
+     */
+    async cDeposit(args, signal) {
+        const action = {
+            ...args,
+            type: "cDeposit",
+            hyperliquidChain: this.isTestnet ? "Testnet" : "Mainnet",
+            signatureChainId: args.signatureChainId ?? (this.isTestnet ? "0x66eee" : "0xa4b1"),
+            nonce: args.nonce ?? Date.now(),
+        };
+        const signature = await signUserSignedAction(this.wallet, action, {
+            "HyperliquidTransaction:CDeposit": [
+                { name: "hyperliquidChain", type: "string" },
+                { name: "wei", type: "uint64" },
+                { name: "nonce", type: "uint64" },
+            ],
+        }, parseInt(action.signatureChainId, 16));
+        const request = {
+            action,
+            signature,
+            nonce: action.nonce,
+        };
+        const response = await this.transport.request("action", request, signal);
+        this._validateResponse(response);
+        return response;
+    }
+    /**
+     * Cancel order(s) by cloid.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful variant of {@link CancelResponse} without error statuses.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -341,13 +384,58 @@ export class WalletClient {
         this._validateResponse(response);
         return response;
     }
+    /**
+     * Withdraw from staking balance.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#withdraw-from-staking
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.cWithdraw({ wei: 100000000 });
+     * ```
+     */
+    async cWithdraw(args, signal) {
+        const action = {
+            ...args,
+            type: "cWithdraw",
+            hyperliquidChain: this.isTestnet ? "Testnet" : "Mainnet",
+            signatureChainId: args.signatureChainId ?? (this.isTestnet ? "0x66eee" : "0xa4b1"),
+            nonce: args.nonce ?? Date.now(),
+        };
+        const signature = await signUserSignedAction(this.wallet, action, {
+            "HyperliquidTransaction:CWithdraw": [
+                { name: "hyperliquidChain", type: "string" },
+                { name: "wei", type: "uint64" },
+                { name: "nonce", type: "uint64" },
+            ],
+        }, parseInt(action.signatureChainId, 16));
+        const request = {
+            action,
+            signature,
+            nonce: action.nonce,
+        };
+        const response = await this.transport.request("action", request, signal);
+        this._validateResponse(response);
+        return response;
+    }
     /**
      * Create a sub-account.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {CreateSubAccountResponse} Response for creating a sub-account.
+     * @returns Response for creating a sub-account.
      * @throws {ApiRequestError} When the API returns an error response.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -357,9 +445,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.createSubAccount({
-     *   name: "subAccountName",
-     * });
+     * const result = await client.createSubAccount({ name: "subAccountName" });
      * ```
      */
     async createSubAccount(args, signal) {
@@ -379,10 +465,10 @@ export class WalletClient {
      * Modify an order.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -428,10 +514,10 @@ export class WalletClient {
      * Place an order(s).
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {OrderResponseSuccess} Successful variant of {@link OrderResponse} without error statuses.
+     * @returns Successful variant of {@link OrderResponse} without error statuses.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -480,10 +566,10 @@ export class WalletClient {
      * Schedule a time to cancel all open orders.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#schedule-cancel-dead-mans-switch | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#schedule-cancel-dead-mans-switch
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -493,9 +579,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.scheduleCancel({
-     *   time: Date.now() + 3600000, // Schedule cancellation 1 hour from now
-     * });
+     * const result = await client.scheduleCancel({ time: Date.now() + 3600000 });
      * ```
      */
     async scheduleCancel(args = {}, signal) {
@@ -516,9 +600,10 @@ export class WalletClient {
      * Set a referral code.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -528,9 +613,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.setReferrer({
-     *   code: "TEST",
-     * });
+     * const result = await client.setReferrer({ code: "TEST" });
      * ```
      */
     async setReferrer(args, signal) {
@@ -550,10 +633,10 @@ export class WalletClient {
      * Transfer a spot asset on L1 to another address.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#l1-spot-transfer | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#l1-spot-transfer
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -575,7 +658,7 @@ export class WalletClient {
             ...args,
             type: "spotSend",
             hyperliquidChain: this.isTestnet ? "Testnet" : "Mainnet",
-            signatureChainId: args.signatureChainId ?? this.isTestnet ? "0x66eee" : "0xa4b1",
+            signatureChainId: args.signatureChainId ?? (this.isTestnet ? "0x66eee" : "0xa4b1"),
             time: args.time ?? Date.now(),
         };
         const signature = await signUserSignedAction(this.wallet, action, {
@@ -600,9 +683,10 @@ export class WalletClient {
      * Transfer between sub-accounts.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
+     * @see null - no documentation
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -632,14 +716,64 @@ export class WalletClient {
         this._validateResponse(response);
         return response;
     }
+    /**
+     * Delegate or undelegate stake from a validator.
+     * @param args - The parameters for the request.
+     * @param signal - An optional abort signal.
+     * @returns Successful response without specific data.
+     * @throws {ApiRequestError} When the API returns an error response.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#delegate-or-undelegate-stake-from-validator
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     * import { privateKeyToAccount } from "viem/accounts";
+     *
+     * const wallet = privateKeyToAccount("0x...");
+     * const transport = new hl.HttpTransport(); // or WebSocketTransport
+     * const client = new hl.WalletClient({ wallet, transport });
+     *
+     * const result = await client.tokenDelegate({
+     *   validator: "0x...",
+     *   isUndelegate: true,
+     *   wei: 100000000,
+     * });
+     * ```
+     */
+    async tokenDelegate(args, signal) {
+        const action = {
+            ...args,
+            type: "tokenDelegate",
+            hyperliquidChain: this.isTestnet ? "Testnet" : "Mainnet",
+            signatureChainId: args.signatureChainId ?? (this.isTestnet ? "0x66eee" : "0xa4b1"),
+            nonce: args.nonce ?? Date.now(),
+        };
+        const signature = await signUserSignedAction(this.wallet, action, {
+            "HyperliquidTransaction:TokenDelegate": [
+                { name: "hyperliquidChain", type: "string" },
+                { name: "validator", type: "address" },
+                { name: "wei", type: "uint64" },
+                { name: "isUndelegate", type: "bool" },
+                { name: "nonce", type: "uint64" },
+            ],
+        }, parseInt(action.signatureChainId, 16));
+        const request = {
+            action,
+            signature,
+            nonce: action.nonce,
+        };
+        const response = await this.transport.request("action", request, signal);
+        this._validateResponse(response);
+        return response;
+    }
     /**
      * Cancel a TWAP order.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {TwapCancelResponseSuccess} Successful variant of {@link TwapCancelResponse} without error status.
+     * @returns Successful variant of {@link TwapCancelResponse} without error status.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-a-twap-order | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-a-twap-order
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -673,10 +807,10 @@ export class WalletClient {
      * Place a TWAP order.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {TwapOrderResponseSuccess} Successful variant of {@link TwapOrderResponse} without error status.
+     * @returns Successful variant of {@link TwapOrderResponse} without error status.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-a-twap-order | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-a-twap-order
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -714,10 +848,10 @@ export class WalletClient {
      * Update isolated margin for a position.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-isolated-margin | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-isolated-margin
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -752,10 +886,10 @@ export class WalletClient {
      * Update leverage for cross or isolated margin.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-leverage | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-leverage
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -790,10 +924,10 @@ export class WalletClient {
      * Transfer funds between Spot and Perp accounts.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#transfer-from-spot-account-to-perp-account-and-vice-versa | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#transfer-from-spot-account-to-perp-account-and-vice-versa
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -814,7 +948,7 @@ export class WalletClient {
             ...args,
             type: "usdClassTransfer",
             hyperliquidChain: this.isTestnet ? "Testnet" : "Mainnet",
-            signatureChainId: args.signatureChainId ?? this.isTestnet ? "0x66eee" : "0xa4b1",
+            signatureChainId: args.signatureChainId ?? (this.isTestnet ? "0x66eee" : "0xa4b1"),
             nonce: args.nonce ?? Date.now(),
         };
         const signature = await signUserSignedAction(this.wallet, action, {
@@ -838,10 +972,10 @@ export class WalletClient {
      * Transfer USDC on L1 to another address.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#l1-usdc-transfer | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#l1-usdc-transfer
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -862,7 +996,7 @@ export class WalletClient {
             ...args,
             type: "usdSend",
             hyperliquidChain: this.isTestnet ? "Testnet" : "Mainnet",
-            signatureChainId: args.signatureChainId ?? this.isTestnet ? "0x66eee" : "0xa4b1",
+            signatureChainId: args.signatureChainId ?? (this.isTestnet ? "0x66eee" : "0xa4b1"),
             time: args.time ?? Date.now(),
         };
         const signature = await signUserSignedAction(this.wallet, action, {
@@ -883,13 +1017,13 @@ export class WalletClient {
         return response;
     }
     /**
-     * Transfer funds to/from a vault.
+     * Add or remove funds from a vault.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-or-withdraw-from-a-vault | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-or-withdraw-from-a-vault
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -923,10 +1057,10 @@ export class WalletClient {
      * Initiate a withdrawal request.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns {SuccessResponse} Successful response without specific data.
+     * @returns Successful response without specific data.
      * @throws {ApiRequestError} When the API returns an error response.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#initiate-a-withdrawal-request | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#initiate-a-withdrawal-request
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -947,7 +1081,7 @@ export class WalletClient {
             ...args,
             type: "withdraw3",
             hyperliquidChain: this.isTestnet ? "Testnet" : "Mainnet",
-            signatureChainId: args.signatureChainId ?? this.isTestnet ? "0x66eee" : "0xa4b1",
+            signatureChainId: args.signatureChainId ?? (this.isTestnet ? "0x66eee" : "0xa4b1"),
             time: args.time ?? Date.now(),
         };
         const signature = await signUserSignedAction(this.wallet, action, {

package/esm/src/transports/websocket/hyperliquid_event_target.d.ts

@@ -1,56 +1,62 @@
 import { TypedEventTarget } from "../../../deps/jsr.io/@derzade/typescript-event-target/1.1.1/mod.js";
+import type { TxDetails } from "../../types/explorer/common.js";
+import type { WsBlockDetails } from "../../types/subscriptions/common.js";
 /**
  * Base system events and dynamic channel events for Hyperliquid WebSocket API.
  */
 export interface HyperliquidEventMap {
-    /** Subscription created/removed event */
+    /** Subscription created/removed event. */
     subscriptionResponse: CustomEvent<{
-        /** Type of subscription operation */
+        /** Type of subscription operation. */
         method: "subscribe" | "unsubscribe";
-        /** Original subscription request */
+        /** Original subscription request. */
         subscription: unknown;
     }>;
-    /** Response to post request event */
+    /** Response to post request event. */
     post: CustomEvent<{
-        /** Unique request identifier */
+        /** Unique request identifier. */
         id: number;
-        /** Server response */
+        /** Server response. */
         response: 
-        /** Response containing requested information */
+        /** Response containing requested information. */
         {
-            /** Indicates that this is an informational response */
+            /** Indicates that this is an informational response. */
             type: "info";
-            /** Contains the information data */
+            /** Contains the information data. */
             payload: {
-                /** Type of information being returned */
+                /** Type of information being returned. */
                 type: string;
-                /** Information specific data */
+                /** Information specific data. */
                 data: unknown;
             };
         }
-        /** Response containing action result */
+        /** Response containing action result. */
          | {
-            /** Indicates that this is an action response */
+            /** Indicates that this is an action response. */
             type: "action";
-            /** Contains the action result data */
+            /** Contains the action result data. */
             payload: {
-                /** Response status indicating success or failure of the action */
+                /** Response status indicating success or failure of the action. */
                 status: "ok" | "err";
-                /** Success data or error message */
+                /** Success data or error message. */
                 response: {
-                    /** Type of operation */
+                    /** Type of operation. */
                     type: string;
-                    /** Specific data for the operation */
+                    /** Specific data for the operation. */
                     data?: unknown;
                 } | string;
             };
         };
     }>;
-    /** Error response for message event */
+    /** Error response for message event. */
     error: CustomEvent<string>;
-    /** Pong response event */
+    /** Pong response event. */
     pong: CustomEvent<undefined>;
-    /** Subscribed channel events */
+    /** Block explorer update event. */
+    _explorerBlock: CustomEvent<WsBlockDetails[]>;
+    /** Transaction explorer update event. */
+    _explorerTxs: CustomEvent<TxDetails[]>;
+    /** Subscribed channel event. */
     [key: string]: CustomEvent<unknown>;
 }
 /**

package/esm/src/transports/websocket/hyperliquid_event_target.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hyperliquid_event_target.d.ts","sourceRoot":"","sources":["../../../../src/src/transports/websocket/hyperliquid_event_target.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oEAAoE,CAAC;AAYtG;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,yCAAyC;IACzC,oBAAoB,EAAE,WAAW,CAAC;QAC9B,qCAAqC;QACrC,MAAM,EAAE,WAAW,GAAG,aAAa,CAAC;QACpC,oCAAoC;QACpC,YAAY,EAAE,OAAO,CAAC;KACzB,CAAC,CAAC;IAEH,qCAAqC;IACrC,IAAI,EAAE,WAAW,CAAC;QACd,gCAAgC;QAChC,EAAE,EAAE,MAAM,CAAC;QACX,sBAAsB;QACtB,QAAQ;QACJ,gDAAgD;QAC9C;YACE,uDAAuD;YACvD,IAAI,EAAE,MAAM,CAAC;YACb,oCAAoC;YACpC,OAAO,EAAE;gBACL,yCAAyC;gBACzC,IAAI,EAAE,MAAM,CAAC;gBACb,gCAAgC;gBAChC,IAAI,EAAE,OAAO,CAAC;aACjB,CAAC;SACL;QACD,wCAAwC;WACtC;YACE,gDAAgD;YAChD,IAAI,EAAE,QAAQ,CAAC;YACf,sCAAsC;YACtC,OAAO,EAAE;gBACL,kEAAkE;gBAClE,MAAM,EAAE,IAAI,GAAG,KAAK,CAAC;gBACrB,oCAAoC;gBACpC,QAAQ,EACF;oBACE,wBAAwB;oBACxB,IAAI,EAAE,MAAM,CAAC;oBACb,sCAAsC;oBACtC,IAAI,CAAC,EAAE,OAAO,CAAC;iBAClB,GACC,MAAM,CAAC;aAChB,CAAC;SACL,CAAC;KACT,CAAC,CAAC;IAEH,uCAAuC;IACvC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAE3B,0BAA0B;IAC1B,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IAE7B,gCAAgC;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB,CAAC,mBAAmB,CAAC;IAC7E;;;OAGG;gBACS,MAAM,EAAE,SAAS;CAahC"}
+{"version":3,"file":"hyperliquid_event_target.d.ts","sourceRoot":"","sources":["../../../../src/src/transports/websocket/hyperliquid_event_target.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oEAAoE,CAAC;AACtG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAY1E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,0CAA0C;IAC1C,oBAAoB,EAAE,WAAW,CAAC;QAC9B,sCAAsC;QACtC,MAAM,EAAE,WAAW,GAAG,aAAa,CAAC;QACpC,qCAAqC;QACrC,YAAY,EAAE,OAAO,CAAC;KACzB,CAAC,CAAC;IAEH,sCAAsC;IACtC,IAAI,EAAE,WAAW,CAAC;QACd,iCAAiC;QACjC,EAAE,EAAE,MAAM,CAAC;QACX,uBAAuB;QACvB,QAAQ;QACJ,iDAAiD;QAC/C;YACE,wDAAwD;YACxD,IAAI,EAAE,MAAM,CAAC;YACb,qCAAqC;YACrC,OAAO,EAAE;gBACL,0CAA0C;gBAC1C,IAAI,EAAE,MAAM,CAAC;gBACb,iCAAiC;gBACjC,IAAI,EAAE,OAAO,CAAC;aACjB,CAAC;SACL;QACD,yCAAyC;WACvC;YACE,iDAAiD;YACjD,IAAI,EAAE,QAAQ,CAAC;YACf,uCAAuC;YACvC,OAAO,EAAE;gBACL,mEAAmE;gBACnE,MAAM,EAAE,IAAI,GAAG,KAAK,CAAC;gBACrB,qCAAqC;gBACrC,QAAQ,EACF;oBACE,yBAAyB;oBACzB,IAAI,EAAE,MAAM,CAAC;oBACb,uCAAuC;oBACvC,IAAI,CAAC,EAAE,OAAO,CAAC;iBAClB,GACC,MAAM,CAAC;aAChB,CAAC;SACL,CAAC;KACT,CAAC,CAAC;IAEH,wCAAwC;IACxC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAE3B,2BAA2B;IAC3B,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IAE7B,mCAAmC;IACnC,cAAc,EAAE,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC;IAE9C,yCAAyC;IACzC,YAAY,EAAE,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC;IAEvC,gCAAgC;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB,CAAC,mBAAmB,CAAC;IAC7E;;;OAGG;gBACS,MAAM,EAAE,SAAS;CAiBhC"}

package/esm/src/transports/websocket/hyperliquid_event_target.js

@@ -15,6 +15,12 @@ export class HyperliquidEventTarget extends TypedEventTarget {
                 if (isHyperliquidMsg(msg)) {
                     this.dispatchEvent(new CustomEvent(msg.channel, { detail: msg.data }));
                 }
+                else if (isExplorerBlockMsg(msg)) {
+                    this.dispatchEvent(new CustomEvent("_explorerBlock", { detail: msg }));
+                }
+                else if (isExplorerTxsMsg(msg)) {
+                    this.dispatchEvent(new CustomEvent("_explorerTxs", { detail: msg }));
+                }
             }
             catch {
                 // Ignore JSON parsing errors
@@ -31,3 +37,34 @@ function isHyperliquidMsg(value) {
     return typeof value === "object" && value !== null &&
         "channel" in value && typeof value.channel === "string";
 }
+/**
+ * Type guard for explorer block messages.
+ * @param value - The value to check.
+ * @returns True if the value is an array of block details.
+ */
+function isExplorerBlockMsg(value) {
+    return Array.isArray(value) && value.length > 0 &&
+        value.every((block) => typeof block === "object" && block !== null && !Array.isArray(block) &&
+            "height" in block && typeof block.height === "number" &&
+            "blockTime" in block && typeof block.blockTime === "number" &&
+            "hash" in block && typeof block.hash === "string" &&
+            "proposer" in block && typeof block.proposer === "string" &&
+            "numTxs" in block && typeof block.numTxs === "number");
+}
+/**
+ * Type guard for explorer transactions messages.
+ * @param value - The value to check.
+ * @returns True if the value is an array of transaction details.
+ */
+function isExplorerTxsMsg(value) {
+    return Array.isArray(value) && value.length > 0 &&
+        value.every((tx) => {
+            return typeof tx === "object" && tx !== null && !Array.isArray(tx) &&
+                "action" in tx && typeof tx.action === "object" && tx.action !== null &&
+                "block" in tx && typeof tx.block === "number" &&
+                "error" in tx && (typeof tx.error === "string" || tx.error === null) &&
+                "hash" in tx && typeof tx.hash === "string" &&
+                "time" in tx && typeof tx.time === "number" &&
+                "user" in tx && typeof tx.user === "string";
+        });
+}