@nktkas/hyperliquid 0.23.0 → 0.24.0

package/README.md

@@ -6,16 +6,16 @@
 [![bundlephobia](https://img.shields.io/bundlephobia/minzip/@nktkas/hyperliquid?style=flat-square)](https://bundlephobia.com/package/@nktkas/hyperliquid)
 
 Unofficial [Hyperliquid API](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api) SDK for all major JS
-runtimes, written in TypeScript and provided with tests.
+runtimes, written in TypeScript.
 
 ## Features
 
 - 🖋️ **Typed**: Source code is 100% TypeScript.
-- 🧪 **Tested**: Good code coverage and type-safe API responses.
+- 🧪 **Tested**: Good code coverage and type relevance.
 - 📦 **Minimal dependencies**: A few small trusted dependencies.
 - 🌐 **Cross-Environment Support**: Compatible with all major JS runtimes.
-- 🔧 **Integratable**: Easy to use with [viem](https://github.com/wevm/viem),
-  [ethers](https://github.com/ethers-io/ethers.js) and other wallet libraries.
+- 🔧 **Integratable**: Easy to use with wallet providers ([viem](https://github.com/wevm/viem),
+  [ethers](https://github.com/ethers-io/ethers.js), private key directly).
 - 📚 **Documented**: JSDoc annotations with usage examples in source code.
 
 ## Installation
@@ -53,9 +53,10 @@ deno add jsr:@nktkas/hyperliquid
 <summary>For React Native, you need to import polyfills before importing the SDK:</summary>
 
 ```js
-// React Native v0.76.3 / Expo v52
+// React Native 0.76.3 / Expo v52
 // Issues:
-// - signing: does not support private keys directly, use viem or ethers
+// - signing: does not support private keys directly, use `viem` or `ethers`
+
 import { Event, EventTarget } from "event-target-shim";
 
 if (!globalThis.EventTarget || !globalThis.Event) {
@@ -90,48 +91,40 @@ if (!Promise.withResolvers) {
         return { promise, resolve, reject };
     };
 }
-
-if (!ArrayBuffer.prototype.transfer) {
-    ArrayBuffer.prototype.transfer = function (newByteLength) {
-        const length = newByteLength ?? this.byteLength;
-        const newBuffer = new ArrayBuffer(length);
-        const oldView = new Uint8Array(this);
-        const newView = new Uint8Array(newBuffer);
-
-        newView.set(oldView.subarray(0, Math.min(oldView.length, length)));
-
-        Object.defineProperty(this, "byteLength", { value: 0 });
-
-        return newBuffer;
-    };
-}
 ```
 
 </details>
 
 ## Quick Start
 
-#### Info endpoint
+### [Info endpoint](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint)
 
 ```ts
+// 1. Import module
 import * as hl from "@nktkas/hyperliquid";
 
-const transport = new hl.HttpTransport();
-const infoClient = new hl.InfoClient({ transport });
+// 1. Set up client with transport
+const infoClient = new hl.InfoClient({
+    transport: new hl.HttpTransport(), // or `WebSocketTransport`
+});
 
+// 3. Query data
 const openOrders = await infoClient.openOrders({ user: "0x..." });
 ```
 
-#### Exchange endpoint
+### [Exchange endpoint](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint)
 
 ```ts
+// 1. Import module
 import * as hl from "@nktkas/hyperliquid";
 
-const privateKey = "0x..."; // or `viem`, `ethers`
-
-const transport = new hl.HttpTransport();
-const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
+// 2. Set up client with wallet and transport
+const exchClient = new hl.ExchangeClient({
+    wallet: "0x...", // `viem`, `ethers`, or private key directly
+    transport: new hl.HttpTransport(), // or `WebSocketTransport`
+});
 
+// 3. Execute an action
 const result = await exchClient.order({
     orders: [{
         a: 0,
@@ -149,38 +142,41 @@ const result = await exchClient.order({
 });
 ```
 
-#### Subscription
+### [Subscription](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions)
 
 ```ts
+// 1. Import module
 import * as hl from "@nktkas/hyperliquid";
 
-const transport = new hl.WebSocketTransport();
-const subsClient = new hl.SubscriptionClient({ transport });
+// 2. Set up client with transport
+const subsClient = new hl.SubscriptionClient({
+    transport: new hl.WebSocketTransport(),
+});
 
+// 3. Subscribe to events
 const sub = await subsClient.allMids((event) => {
     console.log(event);
 });
-
-await sub.unsubscribe(); // unsubscribe from the event
+await sub.unsubscribe();
 ```
 
-#### Multi-Sign
+### [Multi-Sign](https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/multi-sig)
 
 ```ts
+// 1. Import module
 import * as hl from "@nktkas/hyperliquid";
 
-const multiSignAddress = "0x...";
-const signers = [
-    "0x...", // Private key; or any other wallet libraries
-] as const;
-
-const transport = new hl.HttpTransport();
-const multiSignClient = new hl.MultiSignClient({ transport, multiSignAddress, signers }); // extends `ExchangeClient`
-
-const data = await multiSignClient.approveAgent({ // same API as `ExchangeClient`
-    agentAddress: "0x...",
-    agentName: "agentName",
+// 2. Set up client with
+const multiSignClient = new hl.MultiSignClient({
+    transport: new hl.HttpTransport(), // or `WebSocketTransport`
+    multiSignAddress: "0x...",
+    signers: [
+        "0x...", // `viem`, `ethers`, or private key directly
+    ],
 });
+
+// 3. Execute an action
+const data = await multiSignClient.approveAgent({ agentAddress: "0x..." });
 ```
 
 ## Usage
@@ -193,26 +189,27 @@ First, choose and configure your transport layer (more details in the [API Refer
 import * as hl from "@nktkas/hyperliquid";
 
 // 1. HTTP Transport: suitable for one-time requests or serverless environments
-const httpTransport = new hl.HttpTransport(); // Accepts optional parameters (e.g. isTestnet, timeout, etc.)
+const httpTransport = new hl.HttpTransport({...}); // Accepts optional parameters (e.g. isTestnet, timeout, etc.)
 
 // 2. WebSocket Transport: has better network latency than HTTP transport
-const wsTransport = new hl.WebSocketTransport(); // Accepts optional parameters (e.g. url, timeout, reconnect, etc.)
+const wsTransport = new hl.WebSocketTransport({...}); // Accepts optional parameters (e.g. url, timeout, reconnect, etc.)
 ```
 
 ### 2) Initialize Client
 
 Next, initialize a client with the transport layer (more details in the [API Reference](#clients)):
 
-#### Create InfoClient
+#### Create [InfoClient](#infoclient)
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
 
-const transport = new hl.HttpTransport(); // or `WebSocketTransport`
-const infoClient = new hl.InfoClient({ transport });
+const infoClient = new hl.InfoClient({
+    transport: new hl.HttpTransport(), // or `WebSocketTransport`
+});
 ```
 
-#### Create ExchangeClient
+#### Create [ExchangeClient](#exchangeclient)
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
@@ -230,7 +227,7 @@ const exchClient_privateKey = new hl.ExchangeClient({ wallet: privateKey, transp
 const viemAccount = privateKeyToAccount("0x...");
 const exchClient_viem = new hl.ExchangeClient({ wallet: viemAccount, transport });
 
-// 3. Using Ethers (or Ethers V5)
+// 3. Using Ethers (V5 or V6)
 const ethersWallet = new ethers.Wallet("0x...");
 const exchClient_ethers = new hl.ExchangeClient({ wallet: ethersWallet, transport });
 
@@ -238,70 +235,69 @@ const exchClient_ethers = new hl.ExchangeClient({ wallet: ethersWallet, transpor
 const [account] = await window.ethereum.request({ method: "eth_requestAccounts" });
 const externalWallet = createWalletClient({ account, transport: custom(window.ethereum) });
 const exchClient_viemMetamask = new hl.ExchangeClient({ wallet: externalWallet, transport });
-
-// 5. Using external wallet (e.g. MetaMask) via `window.ethereum`
-const exchClient_windowMetamask = new hl.ExchangeClient({ wallet: window.ethereum, transport });
 ```
 
-#### Create SubscriptionClient
+#### Create [SubscriptionClient](#subscriptionclient)
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
 
-const transport = new hl.WebSocketTransport(); // only `WebSocketTransport`
-const subsClient = new hl.SubscriptionClient({ transport });
+const subsClient = new hl.SubscriptionClient({
+    transport: new hl.WebSocketTransport(),
+});
 ```
 
-#### Create MultiSignClient
+#### Create [MultiSignClient](#multisignclient)
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
 import { privateKeyToAccount } from "viem/accounts";
 import { ethers } from "ethers";
 
-const multiSignAddress = "0x...";
-const signers = [
-    privateKeyToAccount("0x..."), // first is leader for multi-sign transaction, must contain own address
-    new ethers.Wallet("0x..."),
-    { // can be a custom async wallet
-        async signTypedData(params: {
-            domain: {
-                name: string;
-                version: string;
-                chainId: number;
-                verifyingContract: Hex;
-            };
-            types: {
-                [key: string]: {
+const multiSignClient = new hl.MultiSignClient({
+    transport: new hl.HttpTransport(), // or `WebSocketTransport`
+    multiSignAddress: "0x...",
+    signers: [
+        privateKeyToAccount("0x..."), // first is leader for multi-sign transaction (signs transaction 2 times)
+        new ethers.Wallet("0x..."),
+        { // can be a custom async wallet
+            async signTypedData(params: {
+                domain: {
                     name: string;
-                    type: string;
-                }[];
-            };
-            primaryType: string;
-            message: Record<string, unknown>;
-        }): Promise<Hex> {
-            // Custom signer logic
-            return "0x..."; // return hex signature
+                    version: string;
+                    chainId: number;
+                    verifyingContract: `0x${string}`;
+                };
+                types: {
+                    [key: string]: {
+                        name: string;
+                        type: string;
+                    }[];
+                };
+                primaryType: string;
+                message: Record<string, unknown>;
+            }): Promise<`0x${string}`> {
+                // Custom signer logic
+                return "0x..."; // return hex signature
+            },
         },
-    },
-    "0x...", // private key directly
-];
-
-const transport = new hl.HttpTransport();
-const multiSignClient = new hl.MultiSignClient({ transport, multiSignAddress, signers }); // extends `ExchangeClient`
+        "0x...", // private key directly
+    ],
+});
 ```
 
 ### 3) Use Client
 
 Finally, use client methods to interact with the Hyperliquid API (more details in the [API Reference](#clients)):
 
-#### Example of using an InfoClient
+#### Example of using an [InfoClient](#infoclient)
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
 
-const transport = new hl.HttpTransport();
-const infoClient = new hl.InfoClient({ transport });
+const infoClient = new hl.InfoClient({
+    transport: new hl.HttpTransport(), // or `WebSocketTransport`
+});
 
 // L2 Book
 const l2Book = await infoClient.l2Book({ coin: "BTC" });
@@ -313,15 +309,15 @@ const clearinghouseState = await infoClient.clearinghouseState({ user: "0x..." }
 const openOrders = await infoClient.openOrders({ user: "0x..." });
 ```
 
-#### Example of using an ExchangeClient
+#### Example of using an [ExchangeClient](#exchangeclient)
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
 
-const privateKey = "0x..."; // or `viem`, `ethers`
-
-const transport = new hl.HttpTransport();
-const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
+const exchClient = new hl.ExchangeClient({
+    wallet: "0x...", // `viem`, `ethers`, or private key directly
+    transport: new hl.HttpTransport(), // or `WebSocketTransport`
+});
 
 // Place an orders
 const result = await exchClient.order({
@@ -341,25 +337,20 @@ const result = await exchClient.order({
 });
 
 // Approve an agent
-const result = await exchClient.approveAgent({
-    agentAddress: "0x...",
-    agentName: "agentName",
-});
+const result = await exchClient.approveAgent({ agentAddress: "0x..." });
 
 // Withdraw funds
-const result = await exchClient.withdraw3({
-    destination: account.address,
-    amount: "100",
-});
+const result = await exchClient.withdraw3({ destination: "0x...", amount: "100" });
 ```
 
-#### Example of using a SubscriptionClient
+#### Example of using a [SubscriptionClient](#subscriptionclient)
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
 
-const transport = new hl.WebSocketTransport();
-const subsClient = new hl.SubscriptionClient({ transport });
+const subsClient = new hl.SubscriptionClient({
+    transport: new hl.WebSocketTransport(),
+});
 
 // L2 Book updates
 await subsClient.l2Book({ coin: "BTC" }, (data) => {
@@ -372,54 +363,25 @@ await subsClient.userFills({ user: "0x..." }, (data) => {
 });
 
 // Candle updates
-const sub = await subsClient.candle({ coin: "BTC", interval: "1h" }, (data) => {
+await subsClient.candle({ coin: "BTC", interval: "1h" }, (data) => {
     console.log(data);
 });
 ```
 
-#### Example of using a MultiSignClient
+#### Example of using a [MultiSignClient](#multisignclient)
 
 ```ts
 import * as hl from "@nktkas/hyperliquid";
 
-const multiSignAddress = "0x...";
-const signers = [
-    "0x...", // Private keys
-] as const;
-
-const transport = new hl.HttpTransport();
-const multiSignClient = new hl.MultiSignClient({ transport, multiSignAddress, signers });
-
-// Interaction is the same as with `ExchangeClient`
-
-// Place an orders
-const result = await multiSignClient.order({
-    orders: [{
-        a: 0,
-        b: true,
-        p: "30000",
-        s: "0.1",
-        r: false,
-        t: {
-            limit: {
-                tif: "Gtc",
-            },
-        },
-    }],
-    grouping: "na",
-});
-
-// Approve an agent
-const result = await multiSignClient.approveAgent({
-    agentAddress: "0x...",
-    agentName: "agentName",
+const multiSignClient = new hl.MultiSignClient({
+    transport: new hl.HttpTransport(), // or `WebSocketTransport`
+    multiSignAddress: "0x...",
+    signers: [
+        "0x...", // `viem`, `ethers`, or private key directly
+    ],
 });
 
-// Withdraw funds
-const result = await multiSignClient.withdraw3({
-    destination: account.address,
-    amount: "100",
-});
+// Interaction is the same as with `ExchangeClient`
 ```
 
 ## API Reference
@@ -428,9 +390,6 @@ const result = await multiSignClient.withdraw3({
 
 A client is an interface through which you can interact with the Hyperliquid API.
 
-The client is responsible for formatting an action, creating a signature correctly, sending a request, and validating a
-response.
-
 #### InfoClient
 
 ```ts
@@ -444,6 +403,9 @@ class InfoClient {
     candleSnapshot(args: CandleSnapshotParameters): Promise<Candle[]>;
     fundingHistory(args: FundingHistoryParameters): Promise<FundingHistory[]>;
     l2Book(args: L2BookParameters): Promise<Book>;
+    liquidatable(): Promise<unknown[]>;
+    marginTable(args: MarginTableParameters): Promise<MarginTable>;
+    maxMarketOrderNtls(): Promise<[number, string][]>;
     meta(): Promise<PerpsMeta>;
     metaAndAssetCtxs(): Promise<PerpsMetaAndAssetCtxs>;
     perpDeployAuctionStatus(): Promise<DeployAuctionStatus>;
@@ -484,18 +446,23 @@ class InfoClient {
     userTwapSliceFills(args: UserTwapSliceFillsParameters): Promise<TwapSliceFill[]>;
     userTwapSliceFillsByTime(args: UserTwapSliceFillsByTimeParameters): Promise<TwapSliceFill[]>;
 
-    // Staking
+    // Validator
     delegations(args: DelegationsParameters): Promise<Delegation[]>;
     delegatorHistory(args: DelegatorHistoryParameters): Promise<DelegatorUpdate[]>;
     delegatorRewards(args: DelegatorRewardsParameters): Promise<DelegatorReward[]>;
     delegatorSummary(args: DelegatorSummaryParameters): Promise<DelegatorSummary>;
+    validatorL1Votes(): Promise<unknown[]>;
     validatorSummaries(): Promise<ValidatorSummary[]>;
 
     // Vault
+    leadingVaults(args: LeadingVaultsParameters): Promise<VaultLeading[]>;
     userVaultEquities(args: UserVaultEquitiesParameters): Promise<VaultEquity[]>;
     vaultDetails(args: VaultDetailsParameters): Promise<VaultDetails | null>;
     vaultSummaries(): Promise<VaultSummary[]>;
 
+    // Server
+    exchangeStatus(): Promise<ExchangeStatus>;
+
     // Explorer (RPC endpoint)
     blockDetails(args: BlockDetailsParameters): Promise<BlockDetails>;
     txDetails(args: TxDetailsParameters): Promise<TxDetails>;
@@ -509,16 +476,11 @@ class InfoClient {
 class ExchangeClient {
     constructor(args: {
         transport: HttpTransport | WebSocketTransport;
-        wallet:
-            | Hex // Private key directly
-            | AbstractViemWalletClient // viem
-            | AbstractEthersSigner // ethers
-            | AbstractEthersV5Signer // ethers v5
-            | AbstractWindowEthereum; // window.ethereum (EIP-1193)
+        wallet: AbstractWallet; // `viem`, `ethers` (v5 or v6), or private key directly
         isTestnet?: boolean; // Whether to use testnet (default: false)
-        defaultVaultAddress?: Hex; // Vault address used by default if not provided in method call
-        signatureChainId?: Hex | (() => MaybePromise<Hex>); // Chain ID used for signing (default: trying to guess based on wallet and isTestnet)
-        nonceManager?: () => MaybePromise<number>; // Function to get the next nonce (default: auto-incrementing Date.now())
+        defaultVaultAddress?: `0x${string}`; // Vault address used by default if not provided in method call
+        signatureChainId?: `0x${string}` | (() => MaybePromise<`0x${string}`>); // Chain ID used for signing (default: get chain id from wallet otherwise `0x1`)
+        nonceManager?: () => MaybePromise<number>; // Function to get the next nonce (default: monotonically incrementing `Date.now()`)
     });
 
     // Order
@@ -537,18 +499,16 @@ class ExchangeClient {
     approveAgent(args: ApproveAgentParameters): Promise<SuccessResponse>;
     approveBuilderFee(args: ApproveBuilderFeeParameters): Promise<SuccessResponse>;
     claimRewards(): Promise<SuccessResponse>;
-    convertToMultiSigUser(args: ConvertToMultiSigUserParameters): Promise<SuccessResponse>;
     createSubAccount(args: CreateSubAccountParameters): Promise<CreateSubAccountResponse>;
     evmUserModify(args: EvmUserModifyParameters): Promise<SuccessResponse>;
     registerReferrer(args: RegisterReferrerParameters): Promise<SuccessResponse>;
     reserveRequestWeight(args: ReserveRequestWeightParameters): Promise<SuccessResponse>;
     setDisplayName(args: SetDisplayNameParameters): Promise<SuccessResponse>;
     setReferrer(args: SetReferrerParameters): Promise<SuccessResponse>;
+    subAccountModify(args: SubAccountModifyParameters): Promise<SuccessResponse>;
     spotUser(args: SpotUserParameters): Promise<SuccessResponse>;
 
     // Transfer
-    perpDexClassTransfer(args: PerpDexClassTransferParameters): Promise<SuccessResponse>;
-    perpDexTransfer(args: PerpDexTransferParameters): Promise<SuccessResponse>;
     spotSend(args: SpotSendParameters): Promise<SuccessResponse>;
     subAccountSpotTransfer(args: SubAccountSpotTransferParameters): Promise<SuccessResponse>;
     subAccountTransfer(args: SubAccountTransferParameters): Promise<SuccessResponse>;
@@ -572,6 +532,7 @@ class ExchangeClient {
     vaultTransfer(args: VaultTransferParameters): Promise<SuccessResponse>;
 
     // Multi-Sign
+    convertToMultiSigUser(args: ConvertToMultiSigUserParameters): Promise<SuccessResponse>;
     multiSig(args: MultiSigParameters): Promise<BaseExchangeResponse>;
 
     // Validator
@@ -591,7 +552,7 @@ class SubscriptionClient {
 
     // Market
     activeAssetCtx(args: EventActiveAssetCtxParameters, listener: (data: WsActiveAssetCtx | WsActiveSpotAssetCtx) => void): Promise<Subscription>;
-    activeAssetData(args: EventActiveAssetDataParameters, listener: (data: WsActiveAssetData) => void): Promise<Subscription>;
+    activeAssetData(args: EventActiveAssetDataParameters, listener: (data: ActiveAssetData) => void): Promise<Subscription>;
     allMids(listener: (data: WsAllMids) => void): Promise<Subscription>;
     bbo(args: EventBboParameters, listener: (data: WsBbo) => void): Promise<Subscription>;
     candle(args: EventCandleParameters, listener: (data: Candle) => void): Promise<Subscription>;
@@ -611,7 +572,7 @@ class SubscriptionClient {
     userTwapHistory(args: EventUserTwapHistory, listener: (data: WsUserTwapHistory) => void): Promise<Subscription>;
     userTwapSliceFills(args: EventUserTwapSliceFills, listener: (data: WsUserTwapSliceFills) => void): Promise<Subscription>;
 
-    // Explorer
+    // Explorer (RPC endpoint)
     explorerBlock(listener: (data: WsBlockDetails[]) => void): Promise<Subscription>;
     explorerTxs(listener: (data: TxDetails[]) => void): Promise<Subscription>;
 }
@@ -624,13 +585,10 @@ class SubscriptionClient {
 class MultiSignClient extends ExchangeClient {
     constructor(
         args:
-            & Omit<ExchangeClientParameters, "wallet"> // Instead of `wallet`, you should specify the following parameters:
+            & Omit<ExchangeClientParameters, "wallet"> // instead of `wallet`, you should specify the following parameters:
             & {
-                multiSignAddress: Hex; // Multi-signature address
-                signers: [ // Array of signers
-                    AbstractWalletWithAddress, // First signer is the leader of a multi-sign transaction
-                    ...AbstractWallet[], // Any number of additional signers
-                ];
+                multiSignAddress: `0x${string}`;
+                signers: [AbstractWallet, ...AbstractWallet[]];
             },
     );
 
@@ -644,7 +602,11 @@ Transport acts as a layer between class requests and Hyperliquid servers.
 
 #### HTTP Transport
 
-HTTP transport is suitable for one-off requests or serverless environments.
+**Features:**
+
+- Uses [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) for requests. Can be configured using
+  [`fetchOptions`](https://developer.mozilla.org/en-US/docs/Web/API/RequestInit).
+- Automatically determines the target URL based on the request + `isTestnet` flag.
 
 ```ts
 class HttpTransport {
@@ -664,7 +626,20 @@ class HttpTransport {
 
 #### WebSocket Transport
 
-WebSocket transport has better network latency than HTTP transport.
+**Features:**
+
+- Uses [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) for requests.
+- Supports [subscriptions](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions)
+  and [post requests](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/post-requests).
+- Automatically restores connection after loss and resubscribes to previous subscriptions.
+- Smart keep alive (pings only when idle).
+- Lazy initialization with message buffering during connection establishment.
+
+**Limitations:**
+
+- Cannot mix api/explorer endpoints or mainnet/testnet in single connection. Need to create separate instances for
+  different endpoints.
+- Cannot send explorer post-requests via WebSocket. Use [HTTP transport](#http-transport).
 
 ```ts
 class WebSocketTransport {
@@ -707,27 +682,23 @@ The import point gives access to functions that generate signatures for Hyperliq
 ```ts
 import { actionSorter, signL1Action } from "@nktkas/hyperliquid/signing";
 
-const privateKey = "0x..."; // or `viem`, `ethers`
+const privateKey = "0x..."; // `viem`, `ethers`, or private key directly
 
-const nonce = Date.now();
-const action = {
+const action = actionSorter.cancel({
     type: "cancel",
     cancels: [
         { a: 0, o: 12345 },
     ],
-} as const;
-
-const signature = await signL1Action({
-    wallet: privateKey,
-    action: actionSorter[action.type](action),
-    nonce,
 });
+const nonce = Date.now();
+
+const signature = await signL1Action({ wallet: privateKey, action, nonce });
 
 // Send the signed action to the Hyperliquid API
 const response = await fetch("https://api.hyperliquid.xyz/exchange", {
     method: "POST",
     headers: { "Content-Type": "application/json" },
-    body: JSON.stringify({ action, signature, nonce }),
+    body: JSON.stringify({ action, signature, nonce }), // recommended to send the same formatted action
 });
 const body = await response.json();
 ```
@@ -735,18 +706,18 @@ const body = await response.json();
 #### Approve agent yourself
 
 ```ts
-import { signUserSignedAction, userSignedActionEip712Types } from "@nktkas/hyperliquid/signing";
+import { actionSorter, signUserSignedAction, userSignedActionEip712Types } from "@nktkas/hyperliquid/signing";
 
-const privateKey = "0x..."; // or `viem`, `ethers`
+const privateKey = "0x..."; // `viem`, `ethers`, or private key directly
 
-const action = {
+const action = actionSorter.approveAgent({
     type: "approveAgent",
     signatureChainId: "0x66eee",
     hyperliquidChain: "Mainnet",
     agentAddress: "0x...",
     agentName: "Agent",
     nonce: Date.now(),
-} as const;
+});
 
 const signature = await signUserSignedAction({
     wallet: privateKey,
@@ -758,11 +729,38 @@ const signature = await signUserSignedAction({
 const response = await fetch("https://api.hyperliquid.xyz/exchange", {
     method: "POST",
     headers: { "Content-Type": "application/json" },
-    body: JSON.stringify({ action, signature, nonce: action.nonce }),
+    body: JSON.stringify({ action, signature, nonce: action.nonce }), // recommended to send the same formatted action
 });
 const body = await response.json();
 ```
 
+## FAQ
+
+### How to execute an L1 action via an external wallet (e.g. MetaMask)?
+
+Hyperliquid requires chain `1337` for L1 actions (open order, change leverage, etc.). There are two ways to execute an
+L1 action through an external wallet:
+
+- (recommended) Create an
+  [Agent Wallet](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/nonces-and-api-wallets#api-wallets)
+  and execute all L1 actions through it
+- Change the user's chain to `1337`, however, the user will sign unreadable data
+
+### How to create a market order?
+
+Hyperliquid doesn't have traditional market orders, but you can achieve market-like execution by placing limit order
+with `tif: "Ioc"` and price that guarantee immediate execution:
+
+- For buys: set limit price >= current best ask
+- For sells: set limit price <= current best bid
+
+### How to use the [Agent Wallet](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/nonces-and-api-wallets#api-wallets) / [Vault](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#subaccounts-and-vaults) / [Sub-Account](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#subaccounts-and-vaults) in `ExchangeClient`?
+
+**Agent Wallet**: Use agent's private key in constructor instead of master account's private key.
+
+**Vault and Sub-Account**: Pass vault or sub-account address via `vaultAddress` options to methods or set
+`defaultVaultAddress` in constructor.
+
 ## Contributing
 
 We appreciate your help! To contribute, please read the [contributing instructions](CONTRIBUTING.md).