@nktkas/hyperliquid 0.17.0 → 0.17.2

package/esm/src/clients/wallet.js

@@ -1,6 +1,5 @@
 import { HyperliquidError } from "../base.js";
 import { isAbstractEthersSigner, isAbstractEthersV5Signer, isAbstractViemWalletClient, isAbstractWindowEthereum, signL1Action, signUserSignedAction, } from "../signing.js";
-// ——————————————— Errors ———————————————
 /** Error thrown when the API returns an error response. */
 export class ApiRequestError extends HyperliquidError {
     constructor(response) {
@@ -39,7 +38,6 @@ export class ApiRequestError extends HyperliquidError {
         this.name = "ApiRequestError";
     }
 }
-// ——————————————— Client ———————————————
 /** Nonce manager for generating unique nonces for signing transactions. */
 class NonceManager {
     constructor() {
@@ -171,9 +169,8 @@ export class WalletClient {
         this.signatureChainId = args.signatureChainId ?? this._guessSignatureChainId;
         this.nonceManager = args.nonceManager ?? new NonceManager().getNonce;
     }
-    // ——————————————— Exchange API ———————————————
     /**
-     * Approve an agent to sign on behalf of the master or sub-accounts.
+     * Approve an agent to sign on behalf of the master account.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal
      * @returns Successful response without specific data.
@@ -189,10 +186,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.approveAgent({
-     *   agentAddress: "0x...",
-     *   agentName: "agentName",
-     * });
+     * const result = await client.approveAgent({ agentAddress: "0x...", agentName: "agentName" });
      * ```
      */
     async approveAgent(args, signal) {
@@ -228,7 +222,7 @@ export class WalletClient {
         return response;
     }
     /**
-     * Approve a max fee rate for a builder address.
+     * Approve a maximum fee rate for a builder.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns Successful response without specific data.
@@ -244,10 +238,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.approveBuilderFee({
-     *   maxFeeRate: "0.01%",
-     *   builder: "0x...",
-     * });
+     * const result = await client.approveBuilderFee({ maxFeeRate: "0.01%", builder: "0x..." });
      * ```
      */
     async approveBuilderFee(args, signal) {
@@ -301,7 +292,7 @@ export class WalletClient {
      *
      * const result = await client.batchModify({
      *   modifies: [{
-     *     oid: 123, // Order ID
+     *     oid: 123,
      *     order: {
      *       a: 0, // Asset index
      *       b: true, // Buy order
@@ -441,10 +432,9 @@ export class WalletClient {
      * const client = new hl.WalletClient({ wallet, transport });
      *
      * const result = await client.cancelByCloid({
-     *   cancels: [{
-     *     asset: 0,
-     *     cloid: "0x...", // Client Order ID
-     *   }],
+     *   cancels: [
+     *     { asset: 0, cloid: "0x..." },
+     *   ],
      * });
      * ```
      */
@@ -476,7 +466,7 @@ export class WalletClient {
         return response;
     }
     /**
-     * Deposit into staking balance.
+     * Transfer native token from the user's spot account into staking for delegating to validators.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns Successful response without specific data.
@@ -654,7 +644,7 @@ export class WalletClient {
         return response;
     }
     /**
-     * Withdraw from staking balance.
+     * Transfer native token from staking into the user's spot account.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns Successful response without specific data.
@@ -763,7 +753,7 @@ export class WalletClient {
      * const client = new hl.WalletClient({ wallet, transport });
      *
      * const result = await client.modify({
-     *   oid: 123, // Order ID
+     *   oid: 123,
      *   order: {
      *     a: 0, // Asset index
      *     b: true, // Buy order
@@ -920,11 +910,52 @@ export class WalletClient {
         this._validateResponse(response);
         return response;
     }
+    /**
+     * Create a referral code.
+     * @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 null - no documentation
+     * @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.registerReferrer({ code: "TEST" });
+     * ```
+     */
+    async registerReferrer(args, signal) {
+        // Construct an action
+        const nonce = await this.nonceManager();
+        const action = {
+            type: "registerReferrer",
+            code: args.code,
+        };
+        // Sign the action
+        const signature = await signL1Action({
+            wallet: this.wallet,
+            action,
+            nonce,
+            isTestnet: this.isTestnet,
+        });
+        // Send a request
+        const request = { action, signature, nonce };
+        const response = await this.transport.request("exchange", request, signal);
+        // Validate a response
+        this._validateResponse(response);
+        return response;
+    }
     /**
      * Reserve additional rate-limited actions for a fee.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
-     * @returns Successful response indicating the weight reservation.
+     * @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#reserve-additional-actions
@@ -962,7 +993,7 @@ export class WalletClient {
         return response;
     }
     /**
-     * Schedule a time to cancel all open orders.
+     * Schedule a cancel-all operation at a future time.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns Successful response without specific data.
@@ -1107,7 +1138,6 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * // Unknown what the successful response will be
      * const result = await client.spotDeploy({
      *   registerToken2: {
      *     spec: {
@@ -1193,13 +1223,13 @@ export class WalletClient {
         return response;
     }
     /**
-     * Transfer a spot asset on L1 to another address.
+     * Send spot assets to another address.
      * @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#l1-spot-transfer
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#core-spot-transfer
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -1266,9 +1296,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.spotUser({
-     *   toggleSpotDusting: { optOut: false },
-     * });
+     * const result = await client.spotUser({ toggleSpotDusting: { optOut: false } });
      * ```
      */
     async spotUser(args, signal) {
@@ -1391,7 +1419,7 @@ export class WalletClient {
         return response;
     }
     /**
-     * Delegate or undelegate stake from a validator.
+     * Delegate or undelegate native tokens to or from a validator.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns Successful response without specific data.
@@ -1554,7 +1582,7 @@ export class WalletClient {
         return response;
     }
     /**
-     * Update isolated margin for a position.
+     * Add or remove margin from isolated position.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns Successful response without specific data.
@@ -1570,11 +1598,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.updateIsolatedMargin({
-     *   asset: 0,
-     *   isBuy: true, // Add to long position
-     *   ntli: 1, // Add 1 USD margin (integer only)
-     * });
+     * const result = await client.updateIsolatedMargin({ asset: 0, isBuy: true, ntli: 1 * 1e6 });
      * ```
      */
     async updateIsolatedMargin(args, signal) {
@@ -1604,7 +1628,7 @@ export class WalletClient {
         return response;
     }
     /**
-     * Update leverage for cross or isolated margin.
+     * Update cross or isolated leverage on a coin.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns Successful response without specific data.
@@ -1620,11 +1644,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.updateLeverage({
-     *   asset: 0,
-     *   isCross: true,
-     *   leverage: 5,
-     * });
+     * const result = await client.updateLeverage({ asset: 0, isCross: true, leverage: 5 });
      * ```
      */
     async updateLeverage(args, signal) {
@@ -1670,10 +1690,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.usdClassTransfer({
-     *   amount: "1",
-     *   toPerp: true, // Transfer from Spot to Perp
-     * });
+     * const result = await client.usdClassTransfer({ amount: "1", toPerp: true });
      * ```
      */
     async usdClassTransfer(args, signal) {
@@ -1709,13 +1726,13 @@ export class WalletClient {
         return response;
     }
     /**
-     * Transfer USDC on L1 to another address.
+     * Send usd to another address.
      * @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#l1-usdc-transfer
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#core-usdc-transfer
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -1725,10 +1742,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.usdSend({
-     *   destination: "0x...",
-     *   amount: "1",
-     * });
+     * const result = await client.usdSend({ destination: "0x...", amount: "1" });
      * ```
      */
     async usdSend(args, signal) {
@@ -1780,10 +1794,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.vaultDistribute({
-     *   vaultAddress: "0x...",
-     *   usd: 10 * 1e6,
-     * });
+     * const result = await client.vaultDistribute({ vaultAddress: "0x...", usd: 10 * 1e6 });
      * ```
      */
     async vaultDistribute(args, signal) {
@@ -1856,7 +1867,7 @@ export class WalletClient {
         return response;
     }
     /**
-     * Add or remove funds from a vault.
+     * Deposit or withdraw from a vault.
      * @param args - The parameters for the request.
      * @param signal - An optional abort signal.
      * @returns Successful response without specific data.
@@ -1919,10 +1930,7 @@ export class WalletClient {
      * const transport = new hl.HttpTransport(); // or WebSocketTransport
      * const client = new hl.WalletClient({ wallet, transport });
      *
-     * const result = await client.withdraw3({
-     *   destination: "0x...",
-     *   amount: "1",
-     * });
+     * const result = await client.withdraw3({ destination: "0x...", amount: "1" });
      * ```
      */
     async withdraw3(args, signal) {
@@ -1957,7 +1965,6 @@ export class WalletClient {
         this._validateResponse(response);
         return response;
     }
-    // ——————————————— Private methods ———————————————
     /** Formats a decimal number as a string, removing trailing zeros. */
     _formatDecimal(numStr) {
         if (!numStr.includes("."))

package/esm/src/signing.d.ts

@@ -1,6 +1,50 @@
 /**
  * This module contains functions for generating Hyperliquid transaction signatures
  * and interfaces to various wallet implementations.
+ * @example
+ * ```ts
+ * import { signL1Action } from "@nktkas/hyperliquid/signing";
+ *
+ * const action = {
+ *   type: "cancel",
+ *   cancels: [{ a: 0, o: 12345 }],
+ * };
+ * const nonce = Date.now();
+ *
+ * const signature = await signL1Action({
+ *   wallet,
+ *   action,
+ *   nonce,
+ *   isTestnet: true, // Change to false for mainnet
+ * });
+ * ```
+ * @example
+ * ```ts
+ * import { signUserSignedAction } from "@nktkas/hyperliquid/signing";
+ *
+ * const action = {
+ *   type: "approveAgent",
+ *   hyperliquidChain: "Testnet", // "Mainnet" or "Testnet"
+ *   signatureChainId: "0x66eee",
+ *   nonce: Date.now(),
+ *   agentAddress: "0x...",
+ *   agentName: "Agent",
+ * };
+ *
+ * const signature = await signUserSignedAction({
+ *   wallet,
+ *   action,
+ *   types: {
+ *     "HyperliquidTransaction:ApproveAgent": [
+ *       { name: "hyperliquidChain", type: "string" },
+ *       { name: "agentAddress", type: "address" },
+ *       { name: "agentName", type: "string" },
+ *       { name: "nonce", type: "uint64" },
+ *     ],
+ *   },
+ *   chainId: parseInt(action.signatureChainId, 16),
+ * });
+ * ```
  * @module
  */
 import { type ValueMap, type ValueType } from "../deps/jsr.io/@std/msgpack/1.0.3/encode.js";

package/esm/src/signing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signing.d.ts","sourceRoot":"","sources":["../../src/src/signing.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAU,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,6CAA6C,CAAC;AAEpG,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAErC,YAAY,EAAE,GAAG,EAAE,CAAC;AACpB,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;AAEpC,mFAAmF;AACnF,MAAM,WAAW,wBAAwB;IACrC,aAAa,CAAC,MAAM,EAAE;QAClB,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;YAChB,iBAAiB,EAAE,GAAG,CAAC;SAC1B,CAAC;QACF,KAAK,EAAE;YACH,CAAC,GAAG,EAAE,MAAM,GAAG;gBACX,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;aAChB,EAAE,CAAC;SACP,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACpB;AAED,sGAAsG;AACtG,MAAM,WAAW,oBAAoB;IACjC,aAAa,CACT,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,EACD,KAAK,EAAE;QACH,CAAC,GAAG,EAAE,MAAM,GAAG;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SAChB,EAAE,CAAC;KACP,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,yGAAyG;AACzG,MAAM,WAAW,sBAAsB;IACnC,cAAc,CACV,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,EACD,KAAK,EAAE;QACH,CAAC,GAAG,EAAE,MAAM,GAAG;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SAChB,EAAE,CAAC;KACP,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,gNAAgN;AAChN,MAAM,WAAW,gCAAgC;IAC7C,aAAa,CACT,MAAM,EAAE;QACJ,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;YAChB,iBAAiB,EAAE,GAAG,CAAC;SAC1B,CAAC;QACF,KAAK,EAAE;YACH,CAAC,GAAG,EAAE,MAAM,GAAG;gBACX,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;aAChB,EAAE,CAAC;SACP,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,EACD,OAAO,CAAC,EAAE,OAAO,GAClB,OAAO,CAAC,GAAG,CAAC,CAAC;CACnB;AAED,kGAAkG;AAClG,MAAM,WAAW,sBAAsB;IAEnC,OAAO,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,GAAG,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC7D;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,GAAG,CAqB5F;AA4BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE;IACrC,iCAAiC;IACjC,MAAM,EACA,wBAAwB,GACxB,oBAAoB,GACpB,sBAAsB,GACtB,gCAAgC,GAChC,sBAAsB,CAAC;IAC7B,+BAA+B;IAC/B,MAAM,EAAE,SAAS,CAAC;IAClB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iDAAiD;IACjD,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB,GAAG,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CA8BzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE;IAC7C,iCAAiC;IACjC,MAAM,EACA,wBAAwB,GACxB,oBAAoB,GACpB,sBAAsB,GACtB,gCAAgC,GAChC,sBAAsB,CAAC;IAC7B,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,+BAA+B;IAC/B,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,CAAC;IAC3D,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;CACnB,GAAG,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAYzC;AA6FD,4DAA4D;AAC5D,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,wBAAwB,CAI9F;AAED,8DAA8D;AAC9D,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,oBAAoB,CAItF;AAED,iEAAiE;AACjE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,sBAAsB,CAI1F;AAED,qGAAqG;AACrG,wBAAgB,kCAAkC,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,wBAAwB,CAItG;AAED,yEAAyE;AACzE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,sBAAsB,CAI1F"}
+{"version":3,"file":"signing.d.ts","sourceRoot":"","sources":["../../src/src/signing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AAGH,OAAO,EAAU,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,6CAA6C,CAAC;AAEpG,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAErC,YAAY,EAAE,GAAG,EAAE,CAAC;AACpB,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;AAEpC,mFAAmF;AACnF,MAAM,WAAW,wBAAwB;IACrC,aAAa,CAAC,MAAM,EAAE;QAClB,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;YAChB,iBAAiB,EAAE,GAAG,CAAC;SAC1B,CAAC;QACF,KAAK,EAAE;YACH,CAAC,GAAG,EAAE,MAAM,GAAG;gBACX,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;aAChB,EAAE,CAAC;SACP,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACpB;AAED,sGAAsG;AACtG,MAAM,WAAW,oBAAoB;IACjC,aAAa,CACT,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,EACD,KAAK,EAAE;QACH,CAAC,GAAG,EAAE,MAAM,GAAG;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SAChB,EAAE,CAAC;KACP,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,yGAAyG;AACzG,MAAM,WAAW,sBAAsB;IACnC,cAAc,CACV,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,EACD,KAAK,EAAE;QACH,CAAC,GAAG,EAAE,MAAM,GAAG;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SAChB,EAAE,CAAC;KACP,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,gNAAgN;AAChN,MAAM,WAAW,gCAAgC;IAC7C,aAAa,CACT,MAAM,EAAE;QACJ,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;YAChB,iBAAiB,EAAE,GAAG,CAAC;SAC1B,CAAC;QACF,KAAK,EAAE;YACH,CAAC,GAAG,EAAE,MAAM,GAAG;gBACX,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;aAChB,EAAE,CAAC;SACP,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,EACD,OAAO,CAAC,EAAE,OAAO,GAClB,OAAO,CAAC,GAAG,CAAC,CAAC;CACnB;AAED,kGAAkG;AAClG,MAAM,WAAW,sBAAsB;IAEnC,OAAO,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,GAAG,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC7D;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,GAAG,CAqB5F;AA4BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE;IACrC,iCAAiC;IACjC,MAAM,EACA,wBAAwB,GACxB,oBAAoB,GACpB,sBAAsB,GACtB,gCAAgC,GAChC,sBAAsB,CAAC;IAC7B,+BAA+B;IAC/B,MAAM,EAAE,SAAS,CAAC;IAClB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iDAAiD;IACjD,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB,GAAG,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CA8BzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE;IAC7C,iCAAiC;IACjC,MAAM,EACA,wBAAwB,GACxB,oBAAoB,GACpB,sBAAsB,GACtB,gCAAgC,GAChC,sBAAsB,CAAC;IAC7B,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,+BAA+B;IAC/B,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,CAAC;IAC3D,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;CACnB,GAAG,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAYzC;AA6FD,4DAA4D;AAC5D,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,wBAAwB,CAI9F;AAED,8DAA8D;AAC9D,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,oBAAoB,CAItF;AAED,iEAAiE;AACjE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,sBAAsB,CAI1F;AAED,qGAAqG;AACrG,wBAAgB,kCAAkC,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,wBAAwB,CAItG;AAED,yEAAyE;AACzE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,sBAAsB,CAI1F"}

package/esm/src/signing.js

@@ -1,11 +1,55 @@
 /**
  * This module contains functions for generating Hyperliquid transaction signatures
  * and interfaces to various wallet implementations.
+ * @example
+ * ```ts
+ * import { signL1Action } from "@nktkas/hyperliquid/signing";
+ *
+ * const action = {
+ *   type: "cancel",
+ *   cancels: [{ a: 0, o: 12345 }],
+ * };
+ * const nonce = Date.now();
+ *
+ * const signature = await signL1Action({
+ *   wallet,
+ *   action,
+ *   nonce,
+ *   isTestnet: true, // Change to false for mainnet
+ * });
+ * ```
+ * @example
+ * ```ts
+ * import { signUserSignedAction } from "@nktkas/hyperliquid/signing";
+ *
+ * const action = {
+ *   type: "approveAgent",
+ *   hyperliquidChain: "Testnet", // "Mainnet" or "Testnet"
+ *   signatureChainId: "0x66eee",
+ *   nonce: Date.now(),
+ *   agentAddress: "0x...",
+ *   agentName: "Agent",
+ * };
+ *
+ * const signature = await signUserSignedAction({
+ *   wallet,
+ *   action,
+ *   types: {
+ *     "HyperliquidTransaction:ApproveAgent": [
+ *       { name: "hyperliquidChain", type: "string" },
+ *       { name: "agentAddress", type: "address" },
+ *       { name: "agentName", type: "string" },
+ *       { name: "nonce", type: "uint64" },
+ *     ],
+ *   },
+ *   chainId: parseInt(action.signatureChainId, 16),
+ * });
+ * ```
  * @module
  */
 import { keccak_256 } from "../deps/jsr.io/@noble/hashes/1.7.1/src/sha3.js";
 import { encode } from "../deps/jsr.io/@std/msgpack/1.0.3/encode.js";
-import { decodeHex, encodeHex } from "../deps/jsr.io/@std/encoding/1.0.7/hex.js";
+import { decodeHex, encodeHex } from "../deps/jsr.io/@std/encoding/1.0.8/hex.js";
 /**
  * Create a hash of the L1 action.
  *