@reefclaw/connect 0.1.12 → 0.1.14

package/assets/plugin/venues/hyperliquid/hl-private.js

@@ -0,0 +1,357 @@
+// Hyperliquid signed-action client — the HL mirror of `ccxt/binance-private.ts`.
+//
+// CONTRACTS THIS FILE INHERITS FROM THE BINANCE SIDE (non-negotiable — the shared
+// adapter-contract suite runs against both):
+//   ★ null ≠ empty. EVERY read returns `null` on a FAILED fetch, never `[]`.
+//     `[]` means "the exchange said: nothing". Callers make destructive decisions
+//     (cancel a bracket, close a position, trust a snapshot) on that difference.
+//   ★ Reads are pre-gated (`assertNotLimited`), order/cancel paths are NOT (an
+//     exit must never be blocked by our own pacer) but every path arms the gate
+//     via `noteError`.
+//
+// HYPERLIQUID-SPECIFIC LANDMINES (all verified live on testnet 2026-07-12):
+//   ★ ccxt AUTO-MONETIZES an authed HL client — `initializeClient()` enrolls
+//     CCXT's own builder fee (1bp/order) + referral code on the first signed call.
+//     `options.{builderFee:false, refSet:true}` disables both. A test pins this.
+//   ★ Market orders REQUIRE a reference price (ccxt derives the slippage cap from
+//     it) — `createOrder(sym,'market',side,size)` with no price THROWS client-side.
+//     There is no native market order on HL: it is an IOC limit at a bounded price.
+//   ★ Signed actions carry a NONCE (epoch ms) and HL keeps only the 100 highest
+//     per signer. Two actions signed in the same millisecond can collide → every
+//     signed action goes through a monotonic-nonce MUTEX (one in-flight at a time,
+//     strictly increasing ms). This is why `submitOrders` batches a bracket pair
+//     into ONE action rather than firing two.
+//   ★ Agent (API) wallets can only TRADE. `usdClassTransfer`/withdraw are
+//     user-signed actions and fail with "Must deposit before performing actions"
+//     when signed by an agent. We never call them.
+import { createRequire } from 'node:module';
+import { logger } from '../../logger.js';
+import { toCcxtSymbol } from '../symbols.js';
+import { assertNotLimited, noteError, noteSuccess, exchangeIpWeight, updateAddressBudget, } from './hl-rate-gate.js';
+import { isValidHlCloid } from './hl-cloid.js';
+// ccxt via CJS require — OpenClaw's ESM loader yields the wrong module shape
+// (same rationale as binance-private.ts / hl-public.ts).
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+let ccxtCjs;
+try {
+    const _require = createRequire(import.meta.url);
+    ccxtCjs = _require('ccxt');
+}
+catch {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    ccxtCjs = require('ccxt');
+}
+const TAG = 'hl-private';
+/** The CCXT options that MUST be present on every authed HL client. Exported so
+ *  `hl-private.test.ts` can assert them — if a future ccxt bump changes the
+ *  option names, the test fails rather than the users paying a silent 1bp. */
+export const HL_REQUIRED_OPTIONS = {
+    builderFee: false,
+    refSet: true,
+};
+/**
+ * Serializes every signed action behind a monotonic nonce.
+ *
+ * HL keeps the 100 highest nonces per signer and rejects repeats; two actions
+ * signed inside the same millisecond can therefore collide and one is silently
+ * lost. Rather than hand-rolling nonces (ccxt owns that), we guarantee that no
+ * two signed actions are ever *issued* in the same millisecond from this process:
+ * each waits for the previous to settle AND for the clock to advance.
+ */
+class NonceMutex {
+    chain = Promise.resolve();
+    lastIssuedMs = 0;
+    run(fn) {
+        const next = this.chain.then(async () => {
+            const now = Date.now();
+            if (now <= this.lastIssuedMs) {
+                // Same-ms collision guard: wait out the millisecond.
+                await new Promise((r) => setTimeout(r, this.lastIssuedMs - now + 1));
+            }
+            this.lastIssuedMs = Date.now();
+            return fn();
+        });
+        // Keep the chain alive even when a link rejects (otherwise one failed action
+        // would poison every later one).
+        this.chain = next.then(() => undefined, () => undefined);
+        return next;
+    }
+}
+export class HyperliquidPrivateApi {
+    creds;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    exchange;
+    mutex = new NonceMutex();
+    marketsLoaded = false;
+    constructor(creds) {
+        this.creds = creds;
+        if (!creds.walletAddress || !creds.agentPrivateKey) {
+            throw new Error('HyperliquidPrivateApi requires walletAddress + agentPrivateKey');
+        }
+        this.exchange = new ccxtCjs.hyperliquid({
+            walletAddress: creds.walletAddress,
+            privateKey: creds.agentPrivateKey,
+            options: { ...HL_REQUIRED_OPTIONS },
+            enableRateLimit: true,
+        });
+        if (creds.testnet) {
+            this.exchange.setSandboxMode(true);
+            const url = JSON.stringify(this.exchange.urls?.api ?? '');
+            if (!url.includes('testnet')) {
+                throw new Error(`HL testnet requested but sandbox URL is not testnet: ${url.slice(0, 80)}`);
+            }
+        }
+        logger.info(TAG, `Hyperliquid private API initialized (${creds.testnet ? 'TESTNET' : 'MAINNET'}, master ${creds.walletAddress.slice(0, 8)}…)`);
+    }
+    /** Exposed for the options-pin test + diagnostics. */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    getExchange() {
+        return this.exchange;
+    }
+    async loadMarkets() {
+        try {
+            assertNotLimited('meta');
+            await this.exchange.loadMarkets();
+            noteSuccess('meta');
+            this.marketsLoaded = true;
+            return true;
+        }
+        catch (err) {
+            noteError(err, 'loadMarkets');
+            logger.error(TAG, `loadMarkets failed: ${msg(err)}`);
+            return false;
+        }
+    }
+    // ---- Reads (null on failure — NEVER []) ----
+    /** Positions for the MASTER account. `null` = fetch failed (state unknown);
+     *  `[]` = the exchange confirmed flat. */
+    async fetchPositions(symbol) {
+        try {
+            assertNotLimited('clearinghouseState');
+            const symbols = symbol ? [toCcxtSymbol('hyperliquid', symbol)] : undefined;
+            const raw = await this.exchange.fetchPositions(symbols);
+            noteSuccess('clearinghouseState');
+            if (!Array.isArray(raw))
+                return null;
+            return raw.filter((p) => Math.abs(Number(p.contracts ?? 0)) > 0);
+        }
+        catch (err) {
+            noteError(err, 'fetchPositions');
+            logger.error(TAG, `fetchPositions failed: ${msg(err)}`);
+            return null;
+        }
+    }
+    /** Open orders INCLUDING trigger/TPSL legs. CCXT's HL `fetchOpenOrders`
+     *  defaults to `frontendOpenOrders`, which is the only endpoint that returns
+     *  trigger orders (plan §3.6) — the analog of Binance's merged algo endpoints. */
+    async fetchOpenOrders(symbol) {
+        try {
+            assertNotLimited('frontendOpenOrders');
+            const s = symbol ? toCcxtSymbol('hyperliquid', symbol) : undefined;
+            const raw = await this.exchange.fetchOpenOrders(s);
+            noteSuccess('frontendOpenOrders');
+            return Array.isArray(raw) ? raw : null;
+        }
+        catch (err) {
+            noteError(err, 'fetchOpenOrders');
+            logger.error(TAG, `fetchOpenOrders failed: ${msg(err)}`);
+            return null;
+        }
+    }
+    async fetchBalance() {
+        try {
+            assertNotLimited('clearinghouseState');
+            const raw = await this.exchange.fetchBalance();
+            noteSuccess('clearinghouseState');
+            return raw ?? null;
+        }
+        catch (err) {
+            noteError(err, 'fetchBalance');
+            logger.error(TAG, `fetchBalance failed: ${msg(err)}`);
+            return null;
+        }
+    }
+    /** Per-order status — the liveness resolver's REST tier (Tier 2 of the
+     *  3-tier rule). Weight 2. `null` = lookup FAILED (unknown), which callers
+     *  must treat as "do not act", NOT as "gone". */
+    async fetchOrder(orderId, symbol) {
+        try {
+            assertNotLimited('orderStatus');
+            const s = symbol ? toCcxtSymbol('hyperliquid', symbol) : undefined;
+            const raw = await this.exchange.fetchOrder(orderId, s);
+            noteSuccess('orderStatus');
+            return raw ?? null;
+        }
+        catch (err) {
+            noteError(err, 'fetchOrder');
+            logger.warn(TAG, `fetchOrder(${orderId}) failed: ${msg(err)}`);
+            return null;
+        }
+    }
+    /** Own fills. WS is the authoritative ingress (plan + the audit-trail rule);
+     *  this is the gap-fill/truth-check path. NOTE: only the 10,000 most recent
+     *  fills exist server-side — deep history is NOT queryable on HL, which is why
+     *  the `trades` table must be WS-first. */
+    async fetchMyTrades(symbol, since, limit = 100) {
+        try {
+            assertNotLimited('userFills');
+            const s = symbol ? toCcxtSymbol('hyperliquid', symbol) : undefined;
+            const raw = await this.exchange.fetchMyTrades(s, since, limit);
+            noteSuccess('userFills');
+            return Array.isArray(raw) ? raw : null;
+        }
+        catch (err) {
+            noteError(err, 'fetchMyTrades');
+            logger.error(TAG, `fetchMyTrades failed: ${msg(err)}`);
+            return null;
+        }
+    }
+    /** Refresh the ADDRESS action budget (the starvation guard). Weight 20 — call
+     *  every ~5 min, never per-heartbeat. */
+    async refreshAddressBudget() {
+        try {
+            assertNotLimited('userRateLimit');
+            const res = await this.rawInfo({ type: 'userRateLimit', user: this.creds.walletAddress });
+            noteSuccess('userRateLimit');
+            const used = Number(res?.nRequestsUsed);
+            const cap = Number(res?.nRequestsCap);
+            if (Number.isFinite(used) && Number.isFinite(cap)) {
+                updateAddressBudget({ nRequestsUsed: used, nRequestsCap: cap });
+            }
+        }
+        catch (err) {
+            noteError(err, 'userRateLimit');
+            logger.warn(TAG, `refreshAddressBudget failed: ${msg(err)}`);
+        }
+    }
+    /** Raw `POST /info` — for the handful of reads CCXT doesn't expose
+     *  (userRateLimit, userNonFundingLedgerUpdates, portfolio). Never used for
+     *  signed actions. */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async rawInfo(body) {
+        const base = this.creds.testnet
+            ? 'https://api.hyperliquid-testnet.xyz'
+            : 'https://api.hyperliquid.xyz';
+        const res = await fetch(`${base}/info`, {
+            method: 'POST',
+            headers: { 'content-type': 'application/json' },
+            body: JSON.stringify(body),
+            signal: AbortSignal.timeout(15_000),
+        });
+        if (!res.ok)
+            throw new Error(`POST /info ${String(body.type)} → ${res.status}`);
+        return res.json();
+    }
+    // ---- Signed actions (NEVER pre-gated; always nonce-serialized) ----
+    /** Submit one order. Market orders are IOC-limit emulated — `price` is
+     *  MANDATORY (ccxt throws without it) and the caller must already have applied
+     *  the slippage bound + HL rounding (hl-precision). */
+    async submitOrder(req) {
+        if (req.cloid && !isValidHlCloid(req.cloid)) {
+            throw new Error(`Invalid HL cloid ${req.cloid} — must be 0x + 32 hex chars`);
+        }
+        return this.mutex.run(async () => {
+            try {
+                const params = this.buildParams(req);
+                const order = await this.exchange.createOrder(toCcxtSymbol('hyperliquid', req.symbol), req.type === 'market' ? 'market' : 'limit', req.side, req.amount, req.price, // ★ always passed — ccxt needs it even for 'market'
+                params);
+                noteSuccess('exchange', { ipWeight: exchangeIpWeight(1), addressActions: 1 });
+                return order ?? null;
+            }
+            catch (err) {
+                noteError(err, 'submitOrder');
+                // Order paths RETHROW (the caller must see a rejection) — unlike reads,
+                // which collapse to null.
+                throw err;
+            }
+        });
+    }
+    /** Submit N orders as ONE signed action (one nonce, one `/exchange` call).
+     *  This is how a bracket pair (SL+TP) is placed: atomic-ish, and it costs 1 IP
+     *  weight unit but N address actions. */
+    async submitOrders(reqs) {
+        if (reqs.length === 0)
+            return [];
+        for (const r of reqs) {
+            if (r.cloid && !isValidHlCloid(r.cloid)) {
+                throw new Error(`Invalid HL cloid ${r.cloid} — must be 0x + 32 hex chars`);
+            }
+        }
+        return this.mutex.run(async () => {
+            try {
+                const ccxtReqs = reqs.map((r) => ({
+                    symbol: toCcxtSymbol('hyperliquid', r.symbol),
+                    type: r.type === 'market' ? 'market' : 'limit',
+                    side: r.side,
+                    amount: r.amount,
+                    price: r.price,
+                    params: this.buildParams(r),
+                }));
+                const orders = await this.exchange.createOrders(ccxtReqs);
+                noteSuccess('exchange', {
+                    ipWeight: exchangeIpWeight(reqs.length),
+                    addressActions: reqs.length, // ★ batches cost n against the ADDRESS budget
+                });
+                return Array.isArray(orders) ? orders : null;
+            }
+            catch (err) {
+                noteError(err, 'submitOrders');
+                throw err;
+            }
+        });
+    }
+    async cancelOrder(orderId, symbol) {
+        return this.mutex.run(async () => {
+            try {
+                const res = await this.exchange.cancelOrder(orderId, toCcxtSymbol('hyperliquid', symbol));
+                noteSuccess('exchange', { ipWeight: exchangeIpWeight(1), addressActions: 1 });
+                return res ?? null;
+            }
+            catch (err) {
+                noteError(err, 'cancelOrder');
+                throw err;
+            }
+        });
+    }
+    /** Cancel by cloid — the bracket path's cancel (we always know our own cloid,
+     *  and it survives a restart because it is derived, not stored). */
+    async cancelOrderByCloid(cloid, symbol) {
+        return this.mutex.run(async () => {
+            try {
+                const res = await this.exchange.cancelOrder(cloid, toCcxtSymbol('hyperliquid', symbol), { clientOrderId: cloid });
+                noteSuccess('exchange', { ipWeight: exchangeIpWeight(1), addressActions: 1 });
+                return res ?? null;
+            }
+            catch (err) {
+                noteError(err, 'cancelOrderByCloid');
+                throw err;
+            }
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    buildParams(req) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const params = {};
+        if (req.reduceOnly)
+            params.reduceOnly = true;
+        if (req.postOnly)
+            params.postOnly = true; // → ALO
+        if (req.cloid)
+            params.clientOrderId = req.cloid;
+        if (req.trigger) {
+            // HL trigger orders fire on MARK price only (no workingType choice).
+            params.triggerPrice = req.trigger.triggerPrice;
+            if (req.trigger.tpsl === 'tp')
+                params.takeProfitPrice = req.trigger.triggerPrice;
+            else
+                params.stopLossPrice = req.trigger.triggerPrice;
+        }
+        return params;
+    }
+    get isMarketsLoaded() {
+        return this.marketsLoaded;
+    }
+}
+function msg(err) {
+    return err instanceof Error ? err.message : String(err);
+}

package/assets/plugin/venues/hyperliquid/hl-public.d.ts

@@ -0,0 +1,79 @@
+import type { CcxtTicker, CcxtOHLCV } from '../../types.js';
+import type { OrderBookDepth } from '../../simulator/types.js';
+import type { PublicMarketDataApi } from '../../ccxt/public-market-data-api.js';
+export interface HyperliquidPublicApiOptions {
+    testnet?: boolean;
+    /** Test seam — injected ccxt exchange instance. */
+    exchange?: any;
+    fetchImpl?: typeof fetch;
+}
+export declare class HyperliquidPublicApi implements PublicMarketDataApi {
+    private exchange;
+    private readonly testnet;
+    private readonly fetchImpl;
+    private readonly tickerTtlMs;
+    /** One upstream fetchTickers call serves every symbol within the TTL. */
+    private tickersCache;
+    private tickersInflight;
+    /** Coin → mid from one weight-2 allMids call (fetchTicker's price source). */
+    private midsCache;
+    private midsInflight;
+    constructor(opts?: HyperliquidPublicApiOptions);
+    private baseUrl;
+    /** Canonical/ccxt symbol → this venue's ccxt symbol, or null (logged) when
+     *  the symbol isn't a Hyperliquid USDC perp — a caller bug we surface
+     *  loudly rather than silently translating quote assets. */
+    private venueSymbol;
+    /** Fetch-all-tickers with a short TTL + inflight dedup. Returns a map keyed
+     *  by ccxt symbol, or null on failure. */
+    private getTickers;
+    /** Coin → mid price from one weight-2 `allMids` call (TTL-cached, inflight-
+     *  deduped; docs: hyperliquid.gitbook.io → Info endpoint → "Retrieve mids
+     *  for all coins"). Null on ANY failure — callers fall back to the full
+     *  snapshot path. Spot entries (`@<idx>` keys) parse fine and are simply
+     *  never looked up (we key by perp coin name). */
+    private getMids;
+    /** Fire-and-forget full-snapshot refresh once it ages past
+     *  FULL_SNAPSHOT_REFRESH_MS — fetchTicker must never block on the heavy
+     *  fetchTickers call when a fresh mid is available. getTickers' own
+     *  inflight dedup + error handling make this safe to kick repeatedly. */
+    private maybeRefreshSnapshot;
+    fetchTickerRaw(symbol: string): Promise<Record<string, any> | null>;
+    /** Price from the weight-2 allMids fast path; volume/change context from
+     *  the last full snapshot (background-refreshed). Hyperliquid's asset
+     *  contexts carry mark/mid rather than a trade-tape bid/ask; absent fields
+     *  fall back to `last` with zero modeled spread — the paper fill engine
+     *  models slippage itself (same convention as IntelPublicApi). Falls back
+     *  to the original blocking full-snapshot path when allMids fails. */
+    fetchTicker(symbol: string): Promise<CcxtTicker | null>;
+    fetchFundingRate(symbol: string): Promise<Record<string, any> | null>;
+    fetchOpenInterest(symbol: string): Promise<Record<string, any> | null>;
+    /** l2Book — Hyperliquid serves at most 20 levels/side (plan §3.6). */
+    fetchOrderBook(symbol: string, limit?: number): Promise<OrderBookDepth | null>;
+    /** candleSnapshot — only the most recent 5000 candles exist per (coin,
+     *  interval) (plan §3.6); requests inside that window behave like Binance. */
+    fetchOHLCV(symbol: string, timeframe?: string, limit?: number): Promise<CcxtOHLCV[] | null>;
+    /** Probe Hyperliquid reachability from this host — the readiness gate's
+     *  venue signal, mirroring BinancePublicApi.probeReachability's outcome
+     *  shape. Hand-rolled POST /info `exchangeStatus` (weight 2) so the probe
+     *  has zero ccxt-method-shape dependence; the response's `time` field
+     *  (verified live 2026-07-11: `{"specialStatuses":null,"time":…}`) doubles
+     *  as the clock-drift source. Geo classification is best-effort — HL's
+     *  API-level geo behavior is UNVERIFIED (plan §3.9); a 403/451 maps to
+     *  geo_blocked, anything else non-2xx/network maps to unreachable. */
+    probeReachability(): Promise<{
+        outcome: 'reachable' | 'geo_blocked' | 'unreachable' | 'unknown';
+        driftMs: number | null;
+    }>;
+    /** `meta` — the asset universe (szDecimals, maxLeverage, positional assetIndex).
+     *  Keyless info read, weight 20. Feeds HyperliquidInfoCache. Returns null on any
+     *  failure (never a partial universe — a half-loaded rules table would silently
+     *  reject orders). */
+    fetchMeta(): Promise<any | null>;
+    /** ★ MARK price — the price HL trigger orders fire on (there is no workingType
+     *  choice on this venue). Stop-distance validation and every trigger MUST use
+     *  this, never `last`: the mark is a CEX-composite median that can diverge from
+     *  HL's own last trade. Sourced from `metaAndAssetCtxs` (one weight-20 call
+     *  covers every asset). Returns null on failure — never a stale guess. */
+    fetchMarkPrice(symbol: string): Promise<number | null>;
+}