@luxfi/dex 1.3.0 → 2.0.1

package/src/hooks/use-lxvault.ts

@@ -0,0 +1,318 @@
+/**
+ * LXVault Hooks (LP-9030)
+ * React hooks for custody, margin, and positions via LXVault precompile
+ */
+import { useCallback } from 'react'
+import { useReadContract, useWriteContract, useWaitForTransactionReceipt, useAccount } from 'wagmi'
+import type { Address } from 'viem'
+import { LX } from '../precompile/addresses'
+import { LX_VAULT_ABI } from '../precompile/abis'
+import type { LXAccount, LXPosition, LXMarginInfo } from '../precompile/types'
+
+/**
+ * Build account tuple from address and subaccount
+ */
+function buildAccount(main: Address, subaccountId: number = 0): LXAccount {
+  return { main, subaccountId }
+}
+
+/**
+ * Hook to get token balance in vault
+ */
+export function useLXVaultBalance(token: Address, subaccountId: number = 0): any {
+  const { address } = useAccount()
+
+  const { data, isLoading, error, refetch } = useReadContract({
+    address: LX.LX_VAULT,
+    abi: LX_VAULT_ABI,
+    functionName: 'getBalance',
+    args: address ? [buildAccount(address, subaccountId), token] : undefined,
+    query: { enabled: !!address },
+  })
+
+  return {
+    balance: data as bigint | undefined,
+    isLoading,
+    error,
+    refetch,
+  }
+}
+
+/**
+ * Hook to get position for a market
+ */
+export function useLXVaultPosition(marketId: number, subaccountId: number = 0): any {
+  const { address } = useAccount()
+
+  const { data, isLoading, error, refetch } = useReadContract({
+    address: LX.LX_VAULT,
+    abi: LX_VAULT_ABI,
+    functionName: 'getPosition',
+    args: address ? [buildAccount(address, subaccountId), marketId] : undefined,
+    query: { enabled: !!address },
+  })
+
+  return {
+    position: data as LXPosition | undefined,
+    isLoading,
+    error,
+    refetch,
+  }
+}
+
+/**
+ * Hook to get margin info (free margin, used margin, etc.)
+ */
+export function useLXVaultMargin(subaccountId: number = 0): any {
+  const { address } = useAccount()
+
+  const { data, isLoading, error, refetch } = useReadContract({
+    address: LX.LX_VAULT,
+    abi: LX_VAULT_ABI,
+    functionName: 'getMargin',
+    args: address ? [buildAccount(address, subaccountId)] : undefined,
+    query: { enabled: !!address },
+  })
+
+  return {
+    margin: data as LXMarginInfo | undefined,
+    isLoading,
+    error,
+    refetch,
+  }
+}
+
+/**
+ * Hook to check if account is liquidatable
+ */
+export function useLXVaultLiquidatable(account?: Address, subaccountId: number = 0): any {
+  const { address: connectedAddress } = useAccount()
+  const targetAddress = account ?? connectedAddress
+
+  const { data, isLoading, error, refetch } = useReadContract({
+    address: LX.LX_VAULT,
+    abi: LX_VAULT_ABI,
+    functionName: 'isLiquidatable',
+    args: targetAddress ? [buildAccount(targetAddress, subaccountId)] : undefined,
+    query: { enabled: !!targetAddress },
+  })
+
+  const result = data as [boolean, bigint] | undefined
+
+  return {
+    liquidatable: result?.[0],
+    shortfall: result?.[1],
+    isLoading,
+    error,
+    refetch,
+  }
+}
+
+/**
+ * Hook to get funding rate for a market
+ */
+export function useLXVaultFundingRate(marketId: number): any {
+  const { data, isLoading, error, refetch } = useReadContract({
+    address: LX.LX_VAULT,
+    abi: LX_VAULT_ABI,
+    functionName: 'getFundingRate',
+    args: [marketId],
+  })
+
+  const result = data as [bigint, bigint] | undefined
+
+  return {
+    rateX18: result?.[0],
+    nextFundingTime: result?.[1],
+    isLoading,
+    error,
+    refetch,
+  }
+}
+
+interface UseLXVaultDepositResult {
+  deposit: (token: Address, amount: bigint, subaccountId?: number) => void
+  hash: `0x${string}` | undefined
+  isPending: boolean
+  isConfirming: boolean
+  isSuccess: boolean
+  error: Error | null
+}
+
+/**
+ * Hook for depositing tokens into vault
+ */
+export function useLXVaultDeposit(): UseLXVaultDepositResult {
+  const { writeContract, data: hash, isPending, error } = useWriteContract()
+  const { isLoading: isConfirming, isSuccess } = useWaitForTransactionReceipt({ hash })
+
+  const deposit = useCallback(
+    (token: Address, amount: bigint, subaccountId: number = 0) => {
+      writeContract({
+        address: LX.LX_VAULT,
+        abi: LX_VAULT_ABI,
+        functionName: 'deposit',
+        args: [token, amount, subaccountId],
+      })
+    },
+    [writeContract]
+  )
+
+  return {
+    deposit,
+    hash,
+    isPending,
+    isConfirming,
+    isSuccess,
+    error,
+  }
+}
+
+interface UseLXVaultWithdrawResult {
+  withdraw: (token: Address, amount: bigint, subaccountId?: number) => void
+  hash: `0x${string}` | undefined
+  isPending: boolean
+  isConfirming: boolean
+  isSuccess: boolean
+  error: Error | null
+}
+
+/**
+ * Hook for withdrawing tokens from vault
+ */
+export function useLXVaultWithdraw(): UseLXVaultWithdrawResult {
+  const { writeContract, data: hash, isPending, error } = useWriteContract()
+  const { isLoading: isConfirming, isSuccess } = useWaitForTransactionReceipt({ hash })
+
+  const withdraw = useCallback(
+    (token: Address, amount: bigint, subaccountId: number = 0) => {
+      writeContract({
+        address: LX.LX_VAULT,
+        abi: LX_VAULT_ABI,
+        functionName: 'withdraw',
+        args: [token, amount, subaccountId],
+      })
+    },
+    [writeContract]
+  )
+
+  return {
+    withdraw,
+    hash,
+    isPending,
+    isConfirming,
+    isSuccess,
+    error,
+  }
+}
+
+interface UseLXVaultTransferResult {
+  transfer: (token: Address, amount: bigint, fromSubaccount: number, toSubaccount: number) => void
+  hash: `0x${string}` | undefined
+  isPending: boolean
+  isConfirming: boolean
+  isSuccess: boolean
+  error: Error | null
+}
+
+/**
+ * Hook for transferring between subaccounts
+ */
+export function useLXVaultTransfer(): UseLXVaultTransferResult {
+  const { writeContract, data: hash, isPending, error } = useWriteContract()
+  const { isLoading: isConfirming, isSuccess } = useWaitForTransactionReceipt({ hash })
+
+  const transfer = useCallback(
+    (
+      token: Address,
+      amount: bigint,
+      fromSubaccount: number,
+      toSubaccount: number
+    ) => {
+      writeContract({
+        address: LX.LX_VAULT,
+        abi: LX_VAULT_ABI,
+        functionName: 'transfer',
+        args: [token, amount, fromSubaccount, toSubaccount],
+      })
+    },
+    [writeContract]
+  )
+
+  return {
+    transfer,
+    hash,
+    isPending,
+    isConfirming,
+    isSuccess,
+    error,
+  }
+}
+
+interface UseLXVaultLiquidateResult {
+  liquidate: (targetAccount: Address, targetSubaccount: number, marketId: number, sizeX18: bigint) => void
+  hash: `0x${string}` | undefined
+  isPending: boolean
+  isConfirming: boolean
+  isSuccess: boolean
+  error: Error | null
+}
+
+/**
+ * Hook for liquidating underwater positions
+ */
+export function useLXVaultLiquidate(): UseLXVaultLiquidateResult {
+  const { writeContract, data: hash, isPending, error } = useWriteContract()
+  const { isLoading: isConfirming, isSuccess } = useWaitForTransactionReceipt({ hash })
+
+  const liquidate = useCallback(
+    (
+      targetAccount: Address,
+      targetSubaccount: number,
+      marketId: number,
+      sizeX18: bigint
+    ) => {
+      writeContract({
+        address: LX.LX_VAULT,
+        abi: LX_VAULT_ABI,
+        functionName: 'liquidate',
+        args: [buildAccount(targetAccount, targetSubaccount), marketId, sizeX18],
+      })
+    },
+    [writeContract]
+  )
+
+  return {
+    liquidate,
+    hash,
+    isPending,
+    isConfirming,
+    isSuccess,
+    error,
+  }
+}
+
+/**
+ * Combined hook for common vault operations
+ */
+export function useLXVault(subaccountId: number = 0): any {
+  const { address } = useAccount()
+  const margin = useLXVaultMargin(subaccountId)
+  const { deposit, isPending: isDepositing } = useLXVaultDeposit()
+  const { withdraw, isPending: isWithdrawing } = useLXVaultWithdraw()
+  const { transfer, isPending: isTransferring } = useLXVaultTransfer()
+
+  return {
+    address,
+    subaccountId,
+    margin: margin.margin,
+    isLoadingMargin: margin.isLoading,
+    deposit,
+    withdraw,
+    transfer,
+    isDepositing,
+    isWithdrawing,
+    isTransferring,
+    refetchMargin: margin.refetch,
+  }
+}

package/src/index.ts

@@ -1,36 +1,56 @@
 /**
  * @luxfi/dex
  *
- * DEX Integration Package
+ * LX Integration Package
  *
- * Provides routing between:
- * - CLOB (Central Limit Order Book) via ~/work/lux/dex
- * - AMM Precompiles (0x0400-0x0403) for native swaps
+ * Native precompile integration for Lux DEX stack:
+ * - LXPool (LP-9010): v4-style AMM PoolManager
+ * - LXOracle (LP-9011): Multi-source price aggregation
+ * - LXRouter (LP-9012): Optimized swap routing
+ * - LXHooks (LP-9013): Hook contract registry
+ * - LXFlash (LP-9014): Flash loan facility
+ * - LXBook (LP-9020): CLOB matching engine
+ * - LXVault (LP-9030): Custody and margin engine
+ * - LXFeed (LP-9040): Mark price and funding feeds
  *
  * Architecture:
  * ```
- * ┌────────────────────────────────────────┐
- * │           Omnichain Router             │
- * │  Best execution between CLOB & AMM     │
- * └─────────────────┬──────────────────────┘
- *                   │
- *     ┌─────────────┴─────────────┐
- *     │                           │
- *     ▼                           ▼
- * ┌─────────┐              ┌───────────────┐
- * │  CLOB   │              │ AMM Precompile│
- * │ Client  │              │   (0x0400)    │
- * │         │              │               │
- * │ • Limit │              │ • Swap        │
- * │ • HFT   │              │ • Liquidity   │
- * │ • Perps │              │ • Flash       │
- * └─────────┘              └───────────────┘
+ * ┌─────────────────────────────────────────────────────────────┐
+ * │                    Omnichain Router                         │
+ * │           Best execution between CLOB & AMM                 │
+ * └─────────────────────────┬───────────────────────────────────┘
+ *                           │
+ *       ┌───────────────────┼───────────────────┐
+ *       │                   │                   │
+ *       ▼                   ▼                   ▼
+ * ┌───────────┐      ┌───────────┐       ┌───────────┐
+ * │  LXBook   │      │  LXPool   │       │  LXVault  │
+ * │ (LP-9020) │      │ (LP-9010) │       │ (LP-9030) │
+ * │           │      │           │       │           │
+ * │ • Orders  │      │ • Swaps   │       │ • Custody │
+ * │ • CLOB    │      │ • AMM     │       │ • Margin  │
+ * │ • Perps   │      │ • Flash   │       │ • Liq.    │
+ * └───────────┘      └───────────┘       └───────────┘
+ *       │                   │                   │
+ *       └───────────────────┴───────────────────┘
+ *                           │
+ *                    ┌──────┴──────┐
+ *                    │   LXFeed    │
+ *                    │  (LP-9040)  │
+ *                    │             │
+ *                    │ • Mark Px   │
+ *                    │ • Index Px  │
+ *                    │ • Funding   │
+ *                    └─────────────┘
  * ```
  */
 
-// Precompile types and ABIs (AMM)
+// =============================================================================
+// Precompile Types, ABIs, and Addresses
+// =============================================================================
+
 export {
-  // Types
+  // AMM Types (LP-9010)
   type Currency,
   type PoolKey,
   type BalanceDelta,
@@ -41,17 +61,57 @@ export {
   NATIVE_LUX,
   sortCurrencies,
   createPoolKey,
-  // ABIs
+
+  // LXBook Types (LP-9020)
+  TIF,
+  OrderKind,
+  GroupType,
+  ActionType,
+  type LXOrder,
+  type LXAction,
+  type LXPlaceResult,
+  type LXL1,
+
+  // LXVault Types (LP-9030)
+  MarginMode,
+  PositionSide,
+  type LXAccount,
+  type LXPosition,
+  type LXMarginInfo,
+  type LXSettlement,
+  type LXLiquidationResult,
+
+  // LXFeed Types (LP-9040)
+  type LXMarkPrice,
+  type LXFundingRate,
+
+  // AMM ABIs
   POOL_MANAGER_ABI,
   SWAP_ROUTER_ABI,
   HOOKS_REGISTRY_ABI,
   FLASH_LOAN_ABI,
+
+  // LX* ABIs
+  LX_BOOK_ABI,
+  LX_VAULT_ABI,
+  LX_FEED_ABI,
+  LX_ORACLE_ABI,
+
   // Addresses
+  LX,
   DEX_PRECOMPILES,
+  type LxdexPrecompile,
   type DexPrecompile,
+  fromLP,
+  toLP,
+  isDEXPrecompile,
+  isBridgePrecompile,
 } from './precompile'
 
-// CLOB client (exports Position as CLOBPosition to avoid conflict)
+// =============================================================================
+// CLOB Client (External ~/work/lux/dex integration)
+// =============================================================================
+
 export {
   type OrderSide,
   type OrderType,
@@ -69,8 +129,14 @@ export {
   createCLOBClient,
 } from './client'
 
-// Omnichain router
+// =============================================================================
+// Omnichain Router
+// =============================================================================
+
 export * from './router'
 
-// React hooks
+// =============================================================================
+// React Hooks
+// =============================================================================
+
 export * from './hooks'