clodds 1.1.0

package/dist/exchanges/hyperliquid/index.d.ts

@@ -0,0 +1,594 @@
+/**
+ * Hyperliquid L1 Integration
+ *
+ * Full support for the dominant perps DEX (69% market share).
+ * Uses official SDK for proper signing.
+ *
+ * @see https://github.com/nomeida/hyperliquid
+ */
+import { EventEmitter } from 'events';
+declare const API_URL = "https://api.hyperliquid.xyz";
+declare const WS_URL = "wss://api.hyperliquid.xyz/ws";
+declare const HLP_VAULT = "0x010461C14e146ac35fE42271BDC1134EE31C703B";
+export interface HyperliquidConfig {
+    walletAddress: string;
+    privateKey: string;
+    testnet?: boolean;
+    vaultAddress?: string;
+    dryRun?: boolean;
+}
+export interface SpotMeta {
+    tokens: Array<{
+        name: string;
+        szDecimals: number;
+        weiDecimals: number;
+        index: number;
+        tokenId: string;
+        isCanonical: boolean;
+    }>;
+    universe: Array<{
+        name: string;
+        tokens: [number, number];
+        index: number;
+    }>;
+}
+export interface PerpMeta {
+    universe: Array<{
+        name: string;
+        szDecimals: number;
+        maxLeverage: number;
+    }>;
+}
+export interface OrderbookLevel {
+    price: number;
+    size: number;
+    numOrders: number;
+}
+export interface Orderbook {
+    coin: string;
+    levels: [OrderbookLevel[], OrderbookLevel[]];
+    time: number;
+}
+export interface SpotBalance {
+    coin: string;
+    hold: string;
+    total: string;
+    entryNtl: string;
+}
+export interface HlpStats {
+    tvl: number;
+    apr24h: number;
+    apr7d: number;
+    apr30d: number;
+    volume24h: number;
+    pnl24h: number;
+}
+export interface PointsData {
+    total: number;
+    daily: number;
+    rank: number;
+    breakdown: {
+        trading: number;
+        referrals: number;
+        hlp: number;
+        staking: number;
+    };
+}
+export interface SpotOrder {
+    coin: string;
+    side: 'BUY' | 'SELL';
+    price: number;
+    size: number;
+    type: 'LIMIT' | 'MARKET';
+    reduceOnly?: boolean;
+    postOnly?: boolean;
+    clientOrderId?: string;
+}
+export interface PerpOrder {
+    coin: string;
+    side: 'BUY' | 'SELL';
+    size: number;
+    price?: number;
+    type?: 'LIMIT' | 'MARKET';
+    reduceOnly?: boolean;
+    postOnly?: boolean;
+    clientOrderId?: string;
+}
+export interface TwapOrder {
+    coin: string;
+    side: 'BUY' | 'SELL';
+    size: number;
+    durationMinutes: number;
+    randomize?: boolean;
+    reduceOnly?: boolean;
+}
+export interface UserFills {
+    closedPnl: string;
+    coin: string;
+    crossed: boolean;
+    dir: string;
+    hash: string;
+    oid: number;
+    px: string;
+    side: string;
+    startPosition: string;
+    sz: string;
+    time: number;
+    fee: string;
+}
+export interface OrderResult {
+    success: boolean;
+    orderId?: number;
+    error?: string;
+}
+export declare function getPerpMeta(): Promise<PerpMeta>;
+export declare function getSpotMeta(): Promise<SpotMeta>;
+export declare function getAllMids(): Promise<Record<string, string>>;
+export declare function getOrderbook(coin: string): Promise<Orderbook>;
+export declare function getFundingRates(): Promise<Array<{
+    coin: string;
+    funding: string;
+    premium: string;
+    openInterest: string;
+}>>;
+export declare function getHlpStats(): Promise<HlpStats>;
+export declare function getLeaderboard(timeframe?: 'day' | 'week' | 'month' | 'allTime'): Promise<Array<{
+    address: string;
+    pnl: number;
+    roi: number;
+    volume: number;
+}>>;
+export declare function getCandles(coin: string, interval: '1m' | '5m' | '15m' | '1h' | '4h' | '1d', startTime?: number, endTime?: number): Promise<Array<{
+    time: number;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume: number;
+}>>;
+export declare function getUserState(userAddress: string): Promise<{
+    marginSummary: {
+        accountValue: string;
+        totalMarginUsed: string;
+    };
+    assetPositions: Array<{
+        position: {
+            coin: string;
+            szi: string;
+            entryPx: string;
+            unrealizedPnl: string;
+            liquidationPx: string;
+            leverage: {
+                type: string;
+                value: number;
+                rawUsd: string;
+            };
+            marginUsed: string;
+        };
+    }>;
+}>;
+export declare function getSpotBalances(userAddress: string): Promise<SpotBalance[]>;
+export declare function getUserFills(userAddress: string): Promise<UserFills[]>;
+export declare function getOpenOrders(userAddress: string): Promise<Array<{
+    coin: string;
+    oid: number;
+    side: string;
+    limitPx: string;
+    sz: string;
+    timestamp: number;
+}>>;
+export declare function getUserPoints(userAddress: string): Promise<PointsData>;
+export declare function getUserRateLimit(userAddress: string): Promise<{
+    cumVlm: number;
+    nRequestsUsed: number;
+    nRequestsCap: number;
+}>;
+export declare function getHistoricalOrders(userAddress: string): Promise<Array<{
+    coin: string;
+    side: string;
+    limitPx: string;
+    sz: string;
+    oid: number;
+    timestamp: number;
+    status: string;
+}>>;
+export declare function getUserFees(userAddress: string): Promise<{
+    makerRate: number;
+    takerRate: number;
+    volume30d: number;
+}>;
+export declare function getBorrowLendState(userAddress: string): Promise<{
+    deposits: Array<{
+        token: string;
+        amount: string;
+        apy: string;
+    }>;
+    borrows: Array<{
+        token: string;
+        amount: string;
+        apy: string;
+    }>;
+    healthFactor: number;
+}>;
+export declare function getAllBorrowLendReserves(): Promise<Array<{
+    token: string;
+    totalDeposits: string;
+    totalBorrows: string;
+    depositApy: string;
+    borrowApy: string;
+    utilizationRate: string;
+}>>;
+/**
+ * Get order status by order ID
+ */
+export declare function getOrderStatus(userAddress: string, oid: number | string): Promise<{
+    order: {
+        coin: string;
+        side: string;
+        limitPx: string;
+        sz: string;
+        oid: number;
+        timestamp: number;
+        origSz: string;
+    };
+    status: string;
+    statusTimestamp: number;
+} | null>;
+/**
+ * Get frontend-enriched open orders
+ */
+export declare function getFrontendOpenOrders(userAddress: string): Promise<Array<{
+    coin: string;
+    oid: number;
+    side: string;
+    limitPx: string;
+    sz: string;
+    origSz: string;
+    timestamp: number;
+    cloid?: string;
+    reduceOnly: boolean;
+    orderType: string;
+    triggerPx?: string;
+    triggerCondition?: string;
+}>>;
+/**
+ * Get user fills filtered by time range
+ */
+export declare function getUserFillsByTime(userAddress: string, startTime: number, endTime?: number, aggregateByTime?: boolean): Promise<UserFills[]>;
+/**
+ * Get funding history for a coin
+ */
+export declare function getFundingHistory(coin: string, startTime: number, endTime?: number): Promise<Array<{
+    coin: string;
+    fundingRate: string;
+    premium: string;
+    time: number;
+}>>;
+/**
+ * Get predicted funding rates across venues
+ */
+export declare function getPredictedFundings(): Promise<Array<{
+    coin: string;
+    venue: string;
+    predictedFunding: string;
+}>>;
+/**
+ * Get user funding history
+ */
+export declare function getUserFunding(userAddress: string, startTime: number, endTime?: number): Promise<Array<{
+    time: number;
+    coin: string;
+    usdc: string;
+    szi: string;
+    fundingRate: string;
+}>>;
+/**
+ * Get user non-funding ledger updates (deposits, withdrawals, transfers)
+ */
+export declare function getUserNonFundingLedgerUpdates(userAddress: string, startTime: number, endTime?: number): Promise<Array<{
+    time: number;
+    hash: string;
+    delta: {
+        type: 'deposit' | 'withdraw' | 'transfer' | 'liquidation';
+        usdc: string;
+    };
+}>>;
+/**
+ * Get user portfolio
+ */
+export declare function getUserPortfolio(userAddress: string): Promise<{
+    accountValue: string;
+    pnl: {
+        allTime: string;
+        day: string;
+        week: string;
+        month: string;
+    };
+    vlm: {
+        allTime: string;
+        day: string;
+        week: string;
+        month: string;
+    };
+}>;
+/**
+ * Get user subaccounts
+ */
+export declare function getSubAccounts(userAddress: string): Promise<Array<{
+    subAccountUser: string;
+    name: string;
+    clearinghouseState: unknown;
+}>>;
+/**
+ * Get user vault equities
+ */
+export declare function getUserVaultEquities(userAddress: string): Promise<Array<{
+    vaultAddress: string;
+    vaultName: string;
+    equity: string;
+}>>;
+/**
+ * Get user referral info
+ */
+export declare function getUserReferral(userAddress: string): Promise<{
+    referredBy?: string;
+    cumReferrerRebate: string;
+    cumRefereeDiscount: string;
+    unclaimedRewards: string;
+    referralCode?: string;
+}>;
+/**
+ * Get TWAP slice fills
+ */
+export declare function getUserTwapSliceFills(userAddress: string): Promise<Array<{
+    twapId: number;
+    coin: string;
+    side: string;
+    sz: string;
+    px: string;
+    time: number;
+    fee: string;
+}>>;
+/**
+ * Get token details
+ */
+export declare function getTokenDetails(tokenId: string): Promise<{
+    name: string;
+    szDecimals: number;
+    weiDecimals: number;
+    fullName?: string;
+    totalSupply?: string;
+    circulatingSupply?: string;
+    markPx?: string;
+} | null>;
+/**
+ * Get spot metadata with asset contexts
+ */
+export declare function getSpotMetaAndAssetCtxs(): Promise<[
+    SpotMeta,
+    Array<{
+        coin: string;
+        markPx: string;
+        midPx: string;
+        prevDayPx: string;
+        dayNtlVlm: string;
+        circulatingSupply: string;
+    }>
+]>;
+/**
+ * Get perps at open interest cap
+ */
+export declare function getPerpsAtOpenInterestCap(): Promise<string[]>;
+/**
+ * Get active asset data (user's leverage and sizing for a coin)
+ */
+export declare function getActiveAssetData(userAddress: string, coin: string): Promise<{
+    leverage: {
+        type: string;
+        value: number;
+        rawUsd: string;
+    };
+    maxTradeSzs: [string, string];
+}>;
+/**
+ * Get user staking delegations
+ */
+export declare function getDelegations(userAddress: string): Promise<Array<{
+    validator: string;
+    amount: string;
+    lockedUntil?: number;
+}>>;
+/**
+ * Get delegator summary
+ */
+export declare function getDelegatorSummary(userAddress: string): Promise<{
+    totalDelegated: string;
+    pendingUnlock: string;
+    rewards: string;
+}>;
+/**
+ * Get delegator rewards
+ */
+export declare function getDelegatorRewards(userAddress: string): Promise<Array<{
+    time: number;
+    amount: string;
+    validator: string;
+}>>;
+/**
+ * Place a perp order
+ */
+export declare function placePerpOrder(config: HyperliquidConfig, order: PerpOrder): Promise<OrderResult>;
+/**
+ * Place a spot order
+ */
+export declare function placeSpotOrder(config: HyperliquidConfig, order: SpotOrder): Promise<OrderResult>;
+/**
+ * Cancel order by ID
+ */
+export declare function cancelOrder(config: HyperliquidConfig, coin: string, oid: number): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Cancel order by client order ID (cloid)
+ */
+export declare function cancelOrderByCloid(config: HyperliquidConfig, coin: string, cloid: string): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Modify an existing order
+ */
+export declare function modifyOrder(config: HyperliquidConfig, oid: number, order: PerpOrder): Promise<OrderResult>;
+/**
+ * Batch modify multiple orders
+ */
+export declare function batchModifyOrders(config: HyperliquidConfig, modifications: Array<{
+    oid: number;
+    order: PerpOrder;
+}>): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Cancel all orders for a coin
+ */
+export declare function cancelAllOrders(config: HyperliquidConfig, coin?: string): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Update leverage
+ */
+export declare function updateLeverage(config: HyperliquidConfig, coin: string, leverage: number, isCross?: boolean): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Update isolated margin for a position
+ * @param ntli - Amount in USDC (positive to add, negative to remove)
+ */
+export declare function updateIsolatedMargin(config: HyperliquidConfig, coin: string, isBuy: boolean, ntli: number): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Schedule automatic cancellation of all orders (dead man's switch)
+ * @param time - Unix timestamp in ms (at least 5 seconds in future), or undefined to cancel scheduled
+ */
+export declare function scheduleCancel(config: HyperliquidConfig, time?: number): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Transfer between spot and perp accounts
+ */
+export declare function transferBetweenSpotAndPerp(config: HyperliquidConfig, amount: number, toPerp: boolean): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Deposit to HLP vault
+ */
+export declare function depositToHlp(config: HyperliquidConfig, amount: number): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Withdraw from HLP vault
+ */
+export declare function withdrawFromHlp(config: HyperliquidConfig, amount: number): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Place TWAP order
+ */
+export declare function placeTwapOrder(config: HyperliquidConfig, order: TwapOrder): Promise<{
+    success: boolean;
+    twapId?: string;
+    error?: string;
+}>;
+/**
+ * Cancel TWAP order
+ */
+export declare function cancelTwap(config: HyperliquidConfig, coin: string, twapId: string): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Transfer USDC to another wallet on Hyperliquid L1
+ */
+export declare function usdTransfer(config: HyperliquidConfig, destination: string, amount: number): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Transfer spot tokens to another wallet
+ */
+export declare function spotTransfer(config: HyperliquidConfig, destination: string, token: string, amount: string): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Withdraw USDC to L1 (Arbitrum)
+ */
+export declare function withdrawToL1(config: HyperliquidConfig, destination: string, amount: number): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Approve an agent wallet for API trading
+ */
+export declare function approveAgent(config: HyperliquidConfig, agentAddress: string, agentName?: string): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Set maximum builder fee rate
+ */
+export declare function approveBuilderFee(config: HyperliquidConfig, builder: string, maxFeeRate: string): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Set referrer code
+ */
+export declare function setReferrer(config: HyperliquidConfig, code: string): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+/**
+ * Create a subaccount
+ */
+export declare function createSubAccount(config: HyperliquidConfig, name: string): Promise<{
+    success: boolean;
+    subAccountUser?: string;
+    error?: string;
+}>;
+/**
+ * Claim referral rewards
+ */
+export declare function claimRewards(config: HyperliquidConfig): Promise<{
+    success: boolean;
+    error?: string;
+}>;
+export declare class HyperliquidWebSocket extends EventEmitter {
+    private sdk;
+    private config;
+    constructor(config?: HyperliquidConfig);
+    connect(): Promise<void>;
+    subscribeOrderbook(coin: string): Promise<void>;
+    subscribeTrades(coin: string): Promise<void>;
+    subscribeUser(): Promise<void>;
+    subscribeOrderUpdates(): Promise<void>;
+    subscribeUserEvents(): Promise<void>;
+    subscribeUserFundings(): Promise<void>;
+    subscribeCandle(coin: string, interval: string): Promise<void>;
+    subscribeBbo(coin: string): Promise<void>;
+    subscribeActiveAssetCtx(coin: string): Promise<void>;
+    subscribeTwapHistory(): Promise<void>;
+    subscribeTwapSliceFills(): Promise<void>;
+    disconnect(): void;
+}
+export { HLP_VAULT, API_URL, WS_URL, };