@nktkas/hyperliquid 0.27.0 → 0.27.1

package/CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing to @nktkas/hyperliquid
+
+Welcome, and thank you for taking time in contributing to SDK! You can contribute to SDK in different ways:
+
+- Submit new features
+- Report bugs
+- Review code
+
+## Dev Environment Setup
+
+If you want to read or modify the SDK code, set up your development environment as follows:
+
+1. Install [Deno](https://deno.com).
+2. Use [VSCode Deno LSP](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno) or a
+   [similar extension](https://docs.deno.com/runtime/getting_started/setup_your_environment/) if you are using a
+   different editor.
+
+## Testing
+
+```bash
+deno test -A
+```
+
+Optional: Set `PRIVATE_KEY` env for complete tests. Required testnet balance: ~100 usdc-perps, ~3 usdc-spot, ~0.0000001
+hype-spot.
+
+## Coding Guidelines
+
+- **Style**: After making all changes, run: [`deno fmt`](https://docs.deno.com/runtime/reference/cli/fmt/) >
+  [`deno lint`](https://docs.deno.com/runtime/reference/cli/lint/) >
+  [`deno check`](https://docs.deno.com/runtime/reference/cli/check/)
+- **Dependencies**: Use small and easily auditable dependencies (e.g.
+  [@noble/hashes](https://www.npmjs.com/package/@noble/hashes) or [@std](https://jsr.io/@std)).
+- **Testing**: Write tests for any new functionality.
+- **Docs**: Update or add JSDoc comments where appropriate.
+
+## Common Tasks
+
+### Add a new API method
+
+1. Create a file with the method name in the appropriate directory:
+   `src/api/[exchange|info|subscription]/[methodName].ts`
+2. Implement the logic related to the new API (using ready-made patterns from other method files).
+3. Update the `~client.ts` file to include the new method.
+4. Add the raw function export to `~mod.ts`.
+5. Create a test (use patterns from other tests) and run the test.
+6. Update docs:
+   - Update the [`API Reference`](/README.md#api-reference) section in [`README.md`](/README.md)
+   - Update the helper message (function `printHelp`) in [`bin/cli.ts`](/bin/cli.ts).
+
+### Update API schemas/types
+
+1. Go to `src/api/[exchange|info|subscription]/[methodName].ts`
+2. Update the [valibot](https://valibot.dev/) schemas in the "Schemas" section (types are inferred from schemas).
+3. Run the test at `tests/api/[exchange|info|subscription]/[methodName].ts` to check the schemas against the actual API
+   response.

package/README.md

@@ -1,12 +1,10 @@
 # Hyperliquid API TypeScript SDK
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
 [![npm](https://img.shields.io/npm/v/@nktkas/hyperliquid?color=blue)](https://www.npmjs.com/package/@nktkas/hyperliquid)
 [![jsr](https://jsr.io/badges/@nktkas/hyperliquid)](https://jsr.io/@nktkas/hyperliquid)
 [![Downloads](https://img.shields.io/npm/dm/@nktkas/hyperliquid.svg)](https://www.npmjs.com/package/@nktkas/hyperliquid)
 [![coveralls](https://img.shields.io/coverallsCoverage/github/nktkas/hyperliquid)](https://coveralls.io/github/nktkas/hyperliquid)
 [![bundlejs](https://img.shields.io/bundlejs/size/@nktkas/hyperliquid)](https://bundlejs.com/?q=@nktkas/hyperliquid)
-[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/nktkas/hyperliquid)
 
 Unofficial [Hyperliquid API](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api) SDK for all major JS
 runtimes, written in TypeScript.

package/esm/bin/_utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_utils.d.ts","sourceRoot":"","sources":["../../src/bin/_utils.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACnC,GAAG;IACF,CAAC,EAAE,MAAM,EAAE,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CA8BzE;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,OAAO,CAAC,CAAC;IAC9D;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,QAAQ,CAAC,CAAC;IAC/E;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,QAAQ,CAAC,CAAC;IAC/E;;;;OAIG;IACH,GAAG,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,QAAQ,GAAG,QAAQ,CAAC,CAAC;IAClF;;;;OAIG;IACH,aAAa,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,QAAQ,GAAG,QAAQ,CAAC,CAAC;IAC5F;;;;OAIG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,QAAQ,GAAG,QAAQ,CAAC,CAAC;IACrF;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,QAAQ,GAAG,QAAQ,CAAC,CAAC;CACpF;AAED,MAAM,WAAW,IAAI;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,CAAC;IACtF,CAAC,EAAE,MAAM,EAAE,CAAC;CACb;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAmE7E"}

package/esm/bin/_utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_utils.js","sourceRoot":"","sources":["../../src/bin/_utils.ts"],"names":[],"mappings":"AAcA;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,IAAc,EAAE,OAAsB;IAC9D,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,EAAwB,CAAC;IAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAuB,CAAC;QAElD,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK;gBAAE,SAAS,CAAC,wBAAwB;YAErE,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,IAAI,KAAyB,CAAC;YAC9B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAErC,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC;gBACnB,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;gBACvC,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC1C,CAAC;iBAAM,IACL,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,wDAAwD;gBAC9F,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EACxF,CAAC;gBACD,KAAK,GAAG,OAAO,CAAC;gBAChB,CAAC,EAAE,CAAC,CAAC,0DAA0D;YACjE,CAAC;YACD,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAoDD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAAC,IAAa,EAAE,OAA0B;IACrE,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,QAAQ;QACb,aAAa,EAAE,QAAQ;QACvB,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,QAAQ;QACd,GAAG,OAAO;KACF,CAAC;IAEX,MAAM,MAAM,GAAS,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;IACnC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,GAAG;YAAE,SAAS,CAAC,iCAAiC;QAE5D,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QAExB,uBAAuB;QACvB,IAAI,gBAA8B,CAAC;QAEnC,OAAO;QACP,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5E,gBAAgB,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QACtD,CAAC,CAAC,OAAO;aACJ,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACnF,gBAAgB,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QACtD,CAAC,CAAC,UAAU;aACP,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE,CAAC;YAC3E,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACnF,gBAAgB,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;QAChF,CAAC,CAAC,MAAM;aACH,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3F,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YAChF,gBAAgB,GAAG,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACvE,CAAC,CAAC,iBAAiB;aACd,IACH,KAAK,CAAC,WAAW,EAAE,KAAK,UAAU,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,WAAW;YACzE,KAAK,CAAC,WAAW,EAAE,KAAK,KAAK,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,EAC/D,CAAC;YACD,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,aAAa,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;YAC9G,gBAAgB,GAAG,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjE,CAAC,CAAC,SAAS;aACN,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YACzF,gBAAgB,GAAG,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACjE,CAAC,CAAC,oBAAoB;aACjB,IACH,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC9C,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAC9C,CAAC;YACD,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACnF,IAAI,CAAC;gBACH,gBAAgB,GAAG,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAwC,CAAC,CAAC,CAAC,KAAK,CAAC;YAC5G,CAAC;YAAC,MAAM,CAAC;gBACP,gBAAgB,GAAG,KAAK,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC,mBAAmB;aAChB,CAAC;YACJ,gBAAgB,GAAG,KAAK,CAAC;QAC3B,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC;IACjC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/esm/bin/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/bin/cli.ts"],"names":[],"mappings":""}

package/esm/bin/cli.js

@@ -0,0 +1,300 @@
+#!/usr/bin/env node
+// @ts-ignore: Ignore missing TS types when building npm
+import process from "node:process";
+import * as v from "valibot";
+import * as hl from "../src/mod.js";
+import { parseArgs, transformArgs } from "./_utils.js";
+function transformParams(method, params) {
+    switch (method) {
+        case "spotUser": {
+            return { toggleSpotDusting: { ...params } };
+        }
+        case "twapOrder": {
+            return { twap: { ...params } };
+        }
+        default: {
+            return params;
+        }
+    }
+}
+class EchoTransport {
+    isTestnet;
+    constructor(isTestnet) {
+        this.isTestnet = isTestnet;
+    }
+    request(_, payload) {
+        return new Promise((resolve) => resolve({ status: "ok", response: payload }));
+    }
+}
+async function executeEndpointMethod(endpoint, method, args) {
+    const isTestnet = "testnet" in args;
+    const timeout = Number(args.timeout) || undefined;
+    const isOffline = "offline" in args;
+    const transport = isOffline ? new EchoTransport(isTestnet) : new hl.HttpTransport({ isTestnet, timeout });
+    let client;
+    if (endpoint === "info") {
+        client = new hl.InfoClient({ transport });
+        if (!(method in client)) {
+            throw new Error(`CLI does not support the "${method}" method in the "${endpoint}" endpoint`);
+        }
+    }
+    else if (endpoint === "exchange") {
+        const pk = v.parse(v.pipe(v.string(), v.hexadecimal()), args["private-key"], { message: 'Invalid format "private-key": Expected 32-byte hexadecimal string' });
+        delete args["private-key"]; // just in case
+        const defaultVaultAddress = v.parse(v.optional(v.pipe(v.string(), v.hexadecimal())), args.vault, { message: 'Invalid format "vault": Expected 20-byte hexadecimal string OR nothing' });
+        client = new hl.ExchangeClient({ transport, wallet: pk, defaultVaultAddress });
+        if (!(method in client)) {
+            throw new Error(`CLI does not support the "${method}" method in the "${endpoint}" endpoint`);
+        }
+    }
+    else {
+        throw new Error(`Invalid endpoint "${endpoint}". Use "info" or "exchange"`);
+    }
+    if (isOffline) {
+        // @ts-ignore - dynamic method access
+        const response = await client[method](transformParams(method, args));
+        return response.response;
+    }
+    else {
+        // @ts-ignore - dynamic method access
+        return await client[method](transformParams(method, args));
+    }
+}
+// ──────────────────── Main ────────────────────
+function printHelp() {
+    console.log(`Hyperliquid CLI
+
+Usage:
+  npx @nktkas/hyperliquid <endpoint> <method> [options]
+
+Endpoints:
+  info      - Query blockchain and market information
+  exchange  - Execute trading operations (requires --private-key)
+
+Common Options:
+  --testnet               Use testnet instead of mainnet
+  --timeout <number>      Request timeout in milliseconds (default: 10000)
+  --help, -h              Show this help message
+  --offline               Generate transactions offline without broadcasting
+
+Exchange Options:
+  --private-key <key>     Private key for exchange operations (required)
+  --vault <address>       Vault address for operations
+
+=============================================================================
+INFO ENDPOINT METHODS
+=============================================================================
+
+Market Data:
+  alignedQuoteTokenInfo   --token <number>
+  allMids                 [--dex <string>]
+  allPerpMetas            (no params)
+  candleSnapshot          --coin <string> --interval <1m|3m|5m|15m|30m|1h|2h|4h|8h|12h|1d|3d|1w|1M>
+                          --startTime <number> [--endTime <number>]
+  fundingHistory          --coin <string> --startTime <number> [--endTime <number>]
+  l2Book                  --coin <string> [--nSigFigs <2|3|4|5>] [--mantissa <2|5>]
+  liquidatable            (no params)
+  marginTable             --id <number>
+  maxMarketOrderNtls      (no params)
+  meta                    [--dex <string>]
+  metaAndAssetCtxs        [--dex <string>]
+  perpDexLimits           --dex <string>
+  perpDexs                (no params)
+  perpsAtOpenInterestCap  [--dex <string>]
+  predictedFundings       (no params)
+  recentTrades            --coin <string>
+  spotMeta                (no params)
+  spotMetaAndAssetCtxs    (no params)
+
+User Account:
+  activeAssetData         --user <address> --coin <string>
+  clearinghouseState      --user <address> [--dex <string>]
+  extraAgents             --user <address>
+  isVip                   --user <address>
+  legalCheck              --user <address>
+  maxBuilderFee           --user <address> --builder <address>
+  portfolio               --user <address>
+  preTransferCheck        --user <address> --source <address>
+  referral                --user <address>
+  spotClearinghouseState  --user <address> [--dex <string>]
+  subAccounts             --user <address>
+  subAccounts2            --user <address>
+  userDexAbstraction      --user <address>
+  userFees                --user <address>
+  userFunding             --user <address> --startTime <number> [--endTime <number>]
+  userNonFundingLedgerUpdates  --user <address> --startTime <number> [--endTime <number>]
+  userRateLimit           --user <address>
+  userRole                --user <address>
+  userToMultiSigSigners   --user <address>
+  webData2                --user <address>
+
+Orders & TWAP & Position:
+  frontendOpenOrders      --user <address> [--dex <string>]
+  historicalOrders        --user <address>
+  openOrders              --user <address> [--dex <string>]
+  orderStatus             --user <address> --oid <number|hex>
+  twapHistory             --user <address>
+  userFills               --user <address> [--aggregateByTime <bool>]
+  userFillsByTime         --user <address> --startTime <number>
+                          [--endTime <number>] [--aggregateByTime <bool>]
+  userTwapSliceFills           --user <address>
+  userTwapSliceFillsByTime     --user <address> --startTime <number>
+                               [--endTime <number>] [--aggregateByTime <bool>]
+
+Delegation & Validators:
+  delegations             --user <address>
+  delegatorHistory        --user <address>
+  delegatorRewards        --user <address>
+  delegatorSummary        --user <address>
+  gossipRootIps           (no params)
+  validatorL1Votes        (no params)
+  validatorSummaries      (no params)
+
+Vault:
+  leadingVaults           --user <address>
+  userVaultEquities       --user <address>
+  vaultDetails            --vaultAddress <address> [--user <address>]
+  vaultSummaries          (no params)
+
+Deploy Market:
+  perpDeployAuctionStatus      (no params)
+  spotDeployState              --user <address>
+  spotPairDeployAuctionStatus  (no params)
+
+Other:
+  exchangeStatus          (no params)
+
+Transaction & Block Details:
+  blockDetails            --height <number>
+  tokenDetails            --tokenId <hex>
+  txDetails               --hash <hex>
+  userDetails             --user <address>
+
+=============================================================================
+EXCHANGE ENDPOINT METHODS
+=============================================================================
+
+Order & TWAP & Position:
+  batchModify             --modifies <json>
+  cancel                  --cancels <json>
+  cancelByCloid           --cancels <json>
+  modify                  --oid <number|hex> --order <json>
+  order                   --orders <json> [--grouping <na|normalTpsl|positionTpsl>] [--builder <json>]
+  scheduleCancel          [--time <number>]
+  twapCancel              --a <number> --t <number>
+  twapOrder               --a <number> --b <bool> --s <number> --r <bool> --m <number> --t <bool>
+  updateIsolatedMargin    --asset <number> --isBuy <bool> --ntli <number>
+  updateLeverage          --asset <number> --isCross <bool> --leverage <number>
+
+Account:
+  agentEnableDexAbstraction  (no params)
+  approveAgent            --agentAddress <address> [--agentName <string>]
+  approveBuilderFee       --maxFeeRate <number> --builder <address>
+  evmUserModify           --usingBigBlocks <bool>
+  noop                    (no params)
+  reserveRequestWeight    --weight <number>
+  setDisplayName          --displayName <string>
+  spotUser                --optOut <bool>
+  userDexAbstraction      --user <address> --enabled <bool>
+
+Fund Transfers:
+  sendAsset               --destination <address> --token <name:address> --amount <number>
+                          --sourceDex <string> --destinationDex <string> [--fromSubAccount <address>]
+  spotSend                --destination <address> --token <name:address> --amount <number>
+  usdClassTransfer        --amount <number> --toPerp <bool>
+  usdSend                 --destination <address> --amount <number>
+  withdraw3               --destination <address> --amount <number>
+
+Sub-Account:
+  createSubAccount        --name <string>
+  subAccountModify        --subAccountUser <address> --name <string>
+  subAccountSpotTransfer  --subAccountUser <address> --isDeposit <bool>
+                          --token <name:address> --amount <number>
+  subAccountTransfer      --subAccountUser <address> --isDeposit <bool> --usd <number>
+
+Referrer:
+  claimRewards            (no params)
+  registerReferrer        --code <string>
+  setReferrer             --code <string>
+
+Staking & Delegation:
+  cDeposit                --wei <number>
+  cWithdraw               --wei <number>
+  linkStakingUser         --user <address> --isFinalize <bool>
+  tokenDelegate           --validator <address> --wei <number> --isUndelegate <bool>
+
+Vault:
+  createVault             --name <string> --description <string> --initialUsd <number>
+  vaultDistribute         --vaultAddress <address> --usd <number>
+  vaultModify             --vaultAddress <address> [--allowDeposits <bool>]
+                          [--alwaysCloseOnWithdraw <bool>]
+  vaultTransfer           --vaultAddress <address> --isDeposit <bool> --usd <number>
+
+Deploy Market:
+  perpDeploy              --registerAsset <json> | --setOracle <json> | --setFundingMultipliers <json> |
+                          --haltTrading <json> | --setMarginTableIds <json> | --setFeeRecipient <json> |
+                          --setOpenInterestCaps <json> | --setSubDeployers <json> | --setFeeScale <json>
+  spotDeploy              --genesis <json> | --registerHyperliquidity <json> | --registerSpot <json> |
+                          --registerToken2 <json> | --setDeployerTradingFeeShare <json> | --userGenesis <json> |
+                          --enableQuoteToken <json>
+
+Validator Actions:
+  cSignerAction           --jailSelf null | --unjailSelf null
+  cValidatorAction        --changeProfile <json> | --register <json> | --unregister null
+  validatorL1Stream       --riskFreeRate <number>
+
+Other:
+  convertToMultiSigUser   --authorizedUsers <json> --threshold <number>
+
+=============================================================================
+
+Examples:
+  # Get all mid prices
+  npx @nktkas/hyperliquid info allMids
+
+  # Get ETH order book with 3 significant figures
+  npx @nktkas/hyperliquid info l2Book --coin ETH --nSigFigs 3
+
+  # Get user's portfolio
+  npx @nktkas/hyperliquid info portfolio --user 0x...
+
+  # Get candle data for BTC
+  npx @nktkas/hyperliquid info candleSnapshot --coin BTC --interval 1h --startTime 1700000000000
+
+  # Place a limit order
+  npx @nktkas/hyperliquid exchange order --private-key 0x... --orders '[{\\"a\\":0,\\"b\\":true,\\"p\\":30000,\\"s\\":0.1,\\"r\\":false,\\"t\\":{\\"limit\\":{\\"tif\\":\\"Gtc\\"}}}]'
+
+  # Modify an existing order
+  npx @nktkas/hyperliquid exchange modify --private-key 0x... --oid 12345 --order '{\\"a\\":0,\\"b\\":true,\\"p\\":31000,\\"s\\":0.1,\\"r\\":false,\\"t\\":{\\"limit\\":{\\"tif\\":\\"Gtc\\"}}}'
+
+  # Cancel orders
+  npx @nktkas/hyperliquid exchange cancel --private-key 0x... --cancels '[{\\"a\\":0,\\"o\\":12345}]'
+
+  # Update leverage
+  npx @nktkas/hyperliquid exchange updateLeverage --private-key 0x... --asset 0 --isCross true --leverage 5
+
+  # Withdraw funds
+  npx @nktkas/hyperliquid exchange withdraw3 --private-key 0x... --destination 0x... --amount 100.5
+
+  # Send USD to another user
+  npx @nktkas/hyperliquid exchange usdSend --private-key 0x... --destination 0x... --amount 50
+
+  # Create a vault
+  npx @nktkas/hyperliquid exchange createVault --private-key 0x... --name "My Vault" --description "Test vault" --initialUsd 1000`);
+}
+const rawArgs = parseArgs(process.argv.slice(2), {
+    flags: ["testnet", "help", "h", "offline"],
+});
+const args = transformArgs(rawArgs, {
+    number: "string",
+});
+const [endpoint, method] = args._;
+if (args.help || args.h || !endpoint || !method) {
+    printHelp();
+}
+else {
+    executeEndpointMethod(endpoint, method, args)
+        .then((result) => console.log(JSON.stringify(result)))
+        .catch((error) => console.error("Error:", error instanceof Error ? error.message : String(error)));
+}
+//# sourceMappingURL=cli.js.map

package/esm/bin/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/bin/cli.ts"],"names":[],"mappings":";AACA,wDAAwD;AACxD,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAa,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAElE,SAAS,eAAe,CAAC,MAAc,EAAE,MAAY;IACnD,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,OAAO,EAAE,iBAAiB,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC;QAC9C,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC;QACjC,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,aAAa;IACjB,SAAS,CAAU;IACnB,YAAY,SAAkB;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IACD,OAAO,CAAI,CAAmC,EAAE,OAAgB;QAC9D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAO,CAAC,CAAC,CAAC;IACrF,CAAC;CACF;AACD,KAAK,UAAU,qBAAqB,CAClC,QAAgB,EAChB,MAAc,EACd,IAAU;IAEV,MAAM,SAAS,GAAG,SAAS,IAAI,IAAI,CAAC;IACpC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC;IAClD,MAAM,SAAS,GAAG,SAAS,IAAI,IAAI,CAAC;IAEpC,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1G,IAAI,MAAyC,CAAC;IAE9C,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QACxB,MAAM,GAAG,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QAE1C,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,oBAAoB,QAAQ,YAAY,CAAC,CAAC;QAC/F,CAAC;IACH,CAAC;SAAM,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;QACnC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAChB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,EACnC,IAAI,CAAC,aAAa,CAAC,EACnB,EAAE,OAAO,EAAE,mEAAmE,EAAE,CACjF,CAAC;QACF,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,eAAe;QAE3C,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CACjC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,EAC/C,IAAI,CAAC,KAAK,EACV,EAAE,OAAO,EAAE,wEAAwE,EAAE,CACtF,CAAC;QAEF,MAAM,GAAG,IAAI,EAAE,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,mBAAmB,EAAE,CAAC,CAAC;QAE/E,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,oBAAoB,QAAQ,YAAY,CAAC,CAAC;QAC/F,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,qBAAqB,QAAQ,6BAA6B,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,qCAAqC;QACrC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QACrE,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,qCAAqC;QACrC,OAAO,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC;AAED,iDAAiD;AAEjD,SAAS,SAAS;IAChB,OAAO,CAAC,GAAG,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kIA0NoH,CAAC,CAAC;AACpI,CAAC;AAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;IAC/C,KAAK,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,CAAC;CAC3C,CAAC,CAAC;AACH,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,EAAE;IAClC,MAAM,EAAE,QAAQ;CACjB,CAAC,CAAC;AACH,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;AAElC,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;IAChD,SAAS,EAAE,CAAC;AACd,CAAC;KAAM,CAAC;IACN,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC;SAC1C,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;SACrD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACvG,CAAC"}

package/esm/deps/jsr.io/@std/bytes/1.0.6/_types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Proxy type of {@code Uint8Array<ArrayBuffer} or {@code Uint8Array} in TypeScript 5.7 or below respectively.
+ *
+ * This type is internal utility type and should not be used directly.
+ *
+ * @internal @private
+ */
+export type Uint8Array_ = ReturnType<Uint8Array["slice"]>;
+//# sourceMappingURL=_types.d.ts.map

package/esm/deps/jsr.io/@std/bytes/1.0.6/_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_types.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/bytes/1.0.6/_types.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AAEH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC"}

package/esm/deps/jsr.io/@std/bytes/1.0.6/_types.js

@@ -0,0 +1,3 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+export {};
+//# sourceMappingURL=_types.js.map

package/esm/deps/jsr.io/@std/bytes/1.0.6/_types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_types.js","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/bytes/1.0.6/_types.ts"],"names":[],"mappings":"AAAA,qDAAqD"}

package/esm/deps/jsr.io/@std/bytes/1.0.6/concat.d.ts

@@ -0,0 +1,21 @@
+import type { Uint8Array_ } from "./_types.js";
+export type { Uint8Array_ };
+/**
+ * Concatenate an array of byte slices into a single slice.
+ *
+ * @param buffers Array of byte slices to concatenate.
+ * @returns A new byte slice containing all the input slices concatenated.
+ *
+ * @example Basic usage
+ * ```ts
+ * import { concat } from "@std/bytes/concat";
+ * import { assertEquals } from "@std/assert";
+ *
+ * const a = new Uint8Array([0, 1, 2]);
+ * const b = new Uint8Array([3, 4, 5]);
+ *
+ * assertEquals(concat([a, b]), new Uint8Array([0, 1, 2, 3, 4, 5]));
+ * ```
+ */
+export declare function concat(buffers: readonly Uint8Array[]): Uint8Array_;
+//# sourceMappingURL=concat.d.ts.map

package/esm/deps/jsr.io/@std/bytes/1.0.6/concat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"concat.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/bytes/1.0.6/concat.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,YAAY,EAAE,WAAW,EAAE,CAAC;AAE5B;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,GAAG,WAAW,CAalE"}

package/esm/deps/jsr.io/@std/bytes/1.0.6/concat.js

@@ -0,0 +1,33 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+/**
+ * Concatenate an array of byte slices into a single slice.
+ *
+ * @param buffers Array of byte slices to concatenate.
+ * @returns A new byte slice containing all the input slices concatenated.
+ *
+ * @example Basic usage
+ * ```ts
+ * import { concat } from "@std/bytes/concat";
+ * import { assertEquals } from "@std/assert";
+ *
+ * const a = new Uint8Array([0, 1, 2]);
+ * const b = new Uint8Array([3, 4, 5]);
+ *
+ * assertEquals(concat([a, b]), new Uint8Array([0, 1, 2, 3, 4, 5]));
+ * ```
+ */
+export function concat(buffers) {
+    let length = 0;
+    for (const buffer of buffers) {
+        length += buffer.length;
+    }
+    const output = new Uint8Array(length);
+    let index = 0;
+    for (const buffer of buffers) {
+        output.set(buffer, index);
+        index += buffer.length;
+    }
+    return output;
+}
+//# sourceMappingURL=concat.js.map

package/esm/deps/jsr.io/@std/bytes/1.0.6/concat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"concat.js","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/bytes/1.0.6/concat.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,qCAAqC;AAKrC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,MAAM,CAAC,OAA8B;IACnD,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC;IAC1B,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC1B,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Proxy type of {@code Uint8Array<ArrayBuffer} or {@code Uint8Array} in TypeScript 5.7 or below respectively.
+ *
+ * This type is internal utility type and should not be used directly.
+ *
+ * @internal @private
+ */
+export type Uint8Array_ = ReturnType<Uint8Array["slice"]>;
+//# sourceMappingURL=_types.d.ts.map

package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_types.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/msgpack/1.0.3/_types.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AAEH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC"}

package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.js

@@ -0,0 +1,3 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+export {};
+//# sourceMappingURL=_types.js.map

package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_types.js","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/msgpack/1.0.3/_types.ts"],"names":[],"mappings":"AAAA,qDAAqD"}

package/esm/deps/jsr.io/@std/msgpack/1.0.3/decode.d.ts

@@ -0,0 +1,21 @@
+import type { ValueType } from "./encode.js";
+/**
+ * Decode a value from the {@link https://msgpack.org/ | MessagePack} binary format.
+ *
+ * If the input is not in valid message pack format, an error will be thrown.
+ *
+ * @example Usage
+ * ```ts
+ * import { decode } from "@std/msgpack/decode";
+ * import { assertEquals } from "@std/assert";
+ *
+ * const encoded = new Uint8Array([163, 72, 105, 33]);
+ *
+ * assertEquals(decode(encoded), "Hi!");
+ * ```
+ *
+ * @param data MessagePack binary data.
+ * @returns Decoded value from the MessagePack binary data.
+ */
+export declare function decode(data: Uint8Array): ValueType;
+//# sourceMappingURL=decode.d.ts.map

package/esm/deps/jsr.io/@std/msgpack/1.0.3/decode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/msgpack/1.0.3/decode.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,CAclD"}