perp-cli 0.3.3

package/dist/exchanges/hyperliquid.d.ts

@@ -0,0 +1,212 @@
+import { Hyperliquid } from "hyperliquid";
+import type { ExchangeAdapter, ExchangeMarketInfo, ExchangePosition, ExchangeOrder, ExchangeBalance, ExchangeTrade, ExchangeFundingPayment, ExchangeKline } from "./interface.js";
+export declare class HyperliquidAdapter implements ExchangeAdapter {
+    readonly name = "hyperliquid";
+    private sdk;
+    private _address;
+    private _privateKey;
+    private _testnet;
+    private _assetMap;
+    private _assetMapReverse;
+    /** HIP-3 deployed perp dex name. Empty string = native (validator) perps. */
+    private _dex;
+    constructor(privateKey: string, testnet?: boolean);
+    /** Set the HIP-3 deployed perp dex to query/trade on. */
+    setDex(dex: string): void;
+    get dex(): string;
+    get client(): Hyperliquid;
+    get address(): string;
+    get isTestnet(): boolean;
+    init(): Promise<void>;
+    /** Load asset index map — supports native and HIP-3 dex. */
+    private _loadAssetMap;
+    getAssetIndex(symbol: string): number;
+    getMarkets(): Promise<ExchangeMarketInfo[]>;
+    getOrderbook(symbol: string): Promise<{
+        bids: [string, string][];
+        asks: [string, string][];
+    }>;
+    /** Always fetches live clearinghouseState, writes result to shared cache for dashboard */
+    private _getClearinghouseState;
+    getBalance(): Promise<ExchangeBalance>;
+    getPositions(): Promise<ExchangePosition[]>;
+    getOpenOrders(): Promise<ExchangeOrder[]>;
+    private _invalidateAccountCache;
+    marketOrder(symbol: string, side: "buy" | "sell", size: string): Promise<any>;
+    /**
+     * Place a market order on a HIP-3 deployed dex.
+     * Bypasses SDK's symbolConversion (which only knows native perps)
+     * and constructs + signs the order action directly.
+     */
+    private _dexMarketOrder;
+    /**
+     * Place an order via raw exchange API with EIP-712 signing.
+     * This bypasses the SDK's symbolConversion and supports dex-specific orders.
+     */
+    private _rawPlaceOrder;
+    limitOrder(symbol: string, side: "buy" | "sell", price: string, size: string, opts?: {
+        reduceOnly?: boolean;
+        tif?: string;
+    }): Promise<any>;
+    cancelOrder(symbol: string, orderId: string): Promise<import("hyperliquid").CancelOrderResponse>;
+    cancelAllOrders(symbol?: string): Promise<import("hyperliquid").CancelOrderResponse[]>;
+    editOrder(symbol: string, orderId: string, price: string, size: string): Promise<unknown>;
+    setLeverage(symbol: string, leverage: number, marginMode?: "cross" | "isolated"): Promise<unknown>;
+    stopOrder(symbol: string, side: "buy" | "sell", size: string, triggerPrice: string, opts?: {
+        limitPrice?: string;
+        reduceOnly?: boolean;
+    }): Promise<unknown>;
+    getRecentTrades(symbol: string, limit?: number): Promise<ExchangeTrade[]>;
+    getKlines(symbol: string, interval: string, startTime: number, endTime: number): Promise<ExchangeKline[]>;
+    getOrderHistory(limit?: number): Promise<ExchangeOrder[]>;
+    getTradeHistory(limit?: number): Promise<ExchangeTrade[]>;
+    getFundingPayments(limit?: number): Promise<ExchangeFundingPayment[]>;
+    getFundingHistory(symbol: string, limit?: number): Promise<{
+        time: number;
+        rate: string;
+        price: string;
+    }[]>;
+    /**
+     * Place a trigger order (stop loss / take profit).
+     * Python SDK: order() with trigger type {"trigger": {triggerPx, isMarket, tpsl: "tp"|"sl"}}
+     */
+    triggerOrder(symbol: string, side: "buy" | "sell", size: string, triggerPrice: string, tpsl: "tp" | "sl", opts?: {
+        isMarket?: boolean;
+        reduceOnly?: boolean;
+        grouping?: string;
+    }): Promise<unknown>;
+    /**
+     * Place a TWAP order.
+     * Python SDK: not available in old SDK, available via raw exchange action.
+     * nktkas TS SDK: twapOrder({twap: {a, b, s, r, m, t}})
+     */
+    twapOrder(symbol: string, side: "buy" | "sell", size: string, durationMinutes: number, opts?: {
+        reduceOnly?: boolean;
+        randomize?: boolean;
+    }): Promise<unknown>;
+    /**
+     * Cancel a TWAP order.
+     */
+    twapCancel(symbol: string, twapId: number): Promise<unknown>;
+    /**
+     * Update leverage for a symbol.
+     * Python SDK: update_leverage(leverage, name, is_cross)
+     */
+    updateLeverage(symbol: string, leverage: number, isCross?: boolean): Promise<unknown>;
+    /**
+     * Update isolated margin for a position.
+     * amount > 0 to add margin, amount < 0 to remove
+     */
+    updateIsolatedMargin(symbol: string, amount: number): Promise<unknown>;
+    /**
+     * Withdraw from Hyperliquid L1 bridge.
+     * Python SDK: withdraw_from_bridge(amount, destination) → action type "withdraw3"
+     */
+    withdraw(amount: string, destination: string): Promise<any>;
+    /**
+     * Transfer USD between accounts on Hyperliquid L1.
+     * Python SDK: usd_transfer(amount, destination)
+     */
+    usdTransfer(amount: number, destination: string): Promise<any>;
+    /**
+     * Create a sub-account.
+     */
+    createSubAccount(name: string): Promise<unknown>;
+    /**
+     * Transfer USD between main and sub-account.
+     */
+    subAccountTransfer(subAccountUser: string, isDeposit: boolean, amount: number): Promise<unknown>;
+    /**
+     * Modify an existing order.
+     */
+    modifyOrder(symbol: string, orderId: number, newSide: "buy" | "sell", newPrice: string, newSize: string, opts?: {
+        reduceOnly?: boolean;
+    }): Promise<unknown>;
+    /**
+     * Schedule cancel: cancel all orders at a future time.
+     * Max 10 triggers per day.
+     */
+    scheduleCancel(timeMs?: number): Promise<unknown>;
+    /**
+     * Set referral code. Silent — does not throw.
+     */
+    autoSetReferrer(code?: string): Promise<void>;
+    /**
+     * Get funding history for a symbol.
+     */
+    getFundingHistoryRaw(symbol: string, startTime: number, endTime?: number): Promise<any>;
+    /**
+     * Get user trade fills.
+     */
+    getUserFills(startTime?: number, endTime?: number): Promise<any>;
+    /**
+     * Get user portfolio analytics.
+     */
+    getPortfolio(): Promise<any>;
+    /**
+     * Query a specific order by OID.
+     */
+    queryOrder(orderId: number): Promise<any>;
+    /**
+     * Approve a builder fee.
+     * Action type: approveBuilderFee
+     */
+    approveBuilderFee(builder: string, maxFeeRate: string): Promise<unknown>;
+    /**
+     * Vault deposit/withdraw.
+     */
+    vaultTransfer(vaultAddress: string, isDeposit: boolean, usd: number): Promise<unknown>;
+    /**
+     * Delegate/undelegate tokens for staking.
+     */
+    tokenDelegate(validator: string, wei: string, isUndelegate?: boolean): Promise<unknown>;
+    /**
+     * Claim staking rewards.
+     */
+    claimRewards(): Promise<unknown>;
+    /**
+     * List all available HIP-3 deployed perp dexes.
+     */
+    listDeployedDexes(): Promise<{
+        name: string;
+        deployer: string;
+        assets: string[];
+    }[]>;
+    /**
+     * Get referral info.
+     */
+    getReferralInfo(): Promise<unknown>;
+    /**
+     * Get fee info.
+     */
+    getUserFees(): Promise<unknown>;
+    /**
+     * Get sub-accounts.
+     */
+    getSubAccounts(): Promise<unknown>;
+    /**
+     * Get historical orders (up to 2000).
+     */
+    getHistoricalOrders(): Promise<unknown>;
+    /**
+     * Get approved builders.
+     */
+    getApprovedBuilders(): Promise<unknown>;
+    /**
+     * Get vault details.
+     */
+    getVaultDetails(vaultAddress: string): Promise<unknown>;
+    /**
+     * Get delegations (staking).
+     */
+    getDelegations(): Promise<unknown>;
+    /**
+     * POST to /info endpoint.
+     */
+    private _infoPost;
+    /**
+     * Send a raw exchange action through the SDK.
+     * Used for methods not directly exposed by the SDK.
+     */
+    private _sendExchangeAction;
+}