@luxfi/dex 1.2.1 → 2.0.0

package/src/precompile/addresses.ts

@@ -0,0 +1,153 @@
+/**
+ * LX Precompile Addresses (LP-Aligned)
+ * Native Go implementation at EVM level
+ *
+ * LX is the umbrella name for the Lux DEX stack:
+ * - AMM (Lux v4-style)
+ * - CLOB (Hyperliquid-style)
+ * - Vaults, Feeds, Routing
+ *
+ * LP-Aligned Address Format (LP-9015):
+ * - Address = 0x0000000000000000000000000000000000LPNUM
+ * - LP number directly visible as trailing hex digits
+ * - Example: LP-9010 → 0x0000...009010
+ *
+ * @see LP-9015 (Precompile Registry) for canonical spec
+ * @see ~/work/lux/precompile/dex/module.go for Go implementation
+ * @see ~/work/lux/lps/LPs/lp-9015-precompile-registry.md
+ */
+import type { Address } from 'viem'
+
+/**
+ * LX Precompile addresses (LP-9xxx range)
+ * LX prefix naming convention for developer-facing contracts
+ * Address format: 0x0000000000000000000000000000000000LPNUM
+ */
+export const LX = {
+  /**
+   * LXPool (LP-9010)
+   * v4 PoolManager-compatible core AMM
+   * - Initialize pools
+   * - Execute swaps
+   * - Modify liquidity
+   * - Flash accounting settlement
+   */
+  LX_POOL: '0x0000000000000000000000000000000000009010' as Address,
+
+  /**
+   * LXOracle (LP-9011)
+   * Multi-source price aggregation
+   * - Chainlink, Pyth, TWAP aggregation
+   * - Price feed validation
+   */
+  LX_ORACLE: '0x0000000000000000000000000000000000009011' as Address,
+
+  /**
+   * LXRouter (LP-9012)
+   * Optimized swap routing
+   * - exactInputSingle / exactOutputSingle
+   * - Multi-hop swaps
+   * - Native LUX support
+   */
+  LX_ROUTER: '0x0000000000000000000000000000000000009012' as Address,
+
+  /**
+   * LXHooks (LP-9013)
+   * Hook contract registry
+   * - Register hook contracts
+   * - Query hook permissions
+   */
+  LX_HOOKS: '0x0000000000000000000000000000000000009013' as Address,
+
+  /**
+   * LXFlash (LP-9014)
+   * Flash loan facility
+   * - Borrow any token
+   * - Repay in same transaction
+   */
+  LX_FLASH: '0x0000000000000000000000000000000000009014' as Address,
+
+  /**
+   * LXBook (LP-9020)
+   * Permissionless orderbooks + matching + advanced orders
+   * - Market factory (createMarket)
+   * - Order lifecycle (place/cancel/modify)
+   * - Advanced orders (trigger, TWAP)
+   * - Book views (L1, order info)
+   */
+  LX_BOOK: '0x0000000000000000000000000000000000009020' as Address,
+
+  /**
+   * LXVault (LP-9030)
+   * Balances, margin, collateral, liquidations
+   * - Token custody
+   * - Margin requirements
+   * - Position liquidations
+   */
+  LX_VAULT: '0x0000000000000000000000000000000000009030' as Address,
+
+  /**
+   * LXFeed (LP-9040)
+   * Price feed aggregator
+   */
+  LX_FEED: '0x0000000000000000000000000000000000009040' as Address,
+
+  /**
+   * Teleport Bridge (LP-6010)
+   * Cross-chain asset teleportation
+   */
+  TELEPORT: '0x0000000000000000000000000000000000006010' as Address,
+} as const
+
+/**
+ * Backwards compatibility - old naming convention
+ * @deprecated Use LX export instead
+ */
+export const DEX_PRECOMPILES = {
+  POOL_MANAGER: LX.LX_POOL,
+  ORACLE_HUB: LX.LX_ORACLE,
+  SWAP_ROUTER: LX.LX_ROUTER,
+  HOOKS_REGISTRY: LX.LX_HOOKS,
+  FLASH_LOAN: LX.LX_FLASH,
+  CLOB: LX.LX_BOOK,
+  VAULT: LX.LX_VAULT,
+  PRICE_FEED: LX.LX_FEED,
+  TELEPORT: LX.TELEPORT,
+} as const
+
+export type LxdexPrecompile = keyof typeof LX
+export type DexPrecompile = keyof typeof DEX_PRECOMPILES
+
+/**
+ * Generate precompile address from LP number
+ * @param lpNumber - The LP number (e.g., 9010)
+ * @returns The precompile address
+ */
+export function fromLP(lpNumber: number): Address {
+  return `0x${lpNumber.toString(16).padStart(40, '0')}` as Address
+}
+
+/**
+ * Extract LP number from precompile address
+ * @param address - The precompile address
+ * @returns The LP number
+ */
+export function toLP(address: Address): number {
+  return parseInt(address.slice(-4), 16)
+}
+
+/**
+ * Check if address is a DEX precompile (LP-9xxx range)
+ */
+export function isDEXPrecompile(address: Address): boolean {
+  const lp = toLP(address)
+  return lp >= 9000 && lp < 10000
+}
+
+/**
+ * Check if address is a Bridge precompile (LP-6xxx range)
+ */
+export function isBridgePrecompile(address: Address): boolean {
+  const lp = toLP(address)
+  return lp >= 6000 && lp < 7000
+}

package/src/precompile/index.ts

@@ -0,0 +1,18 @@
+/**
+ * LX Precompile Exports (LP-Aligned)
+ *
+ * Native precompiles 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
+ *
+ * Address format: 0x0000000000000000000000000000000000LPNUM
+ */
+export * from './types'
+export * from './abis'
+export * from './addresses'

package/src/precompile/types.ts

@@ -0,0 +1,295 @@
+/**
+ * DEX Precompile Types
+ * Native Lux v4-style AMM implementation
+ */
+import type { Address } from 'viem'
+
+/**
+ * Currency type - address(0) = native LUX
+ */
+export interface Currency {
+  address: Address
+}
+
+/**
+ * Pool key uniquely identifies a pool
+ */
+export interface PoolKey {
+  currency0: Address // Lower address token (sorted)
+  currency1: Address // Higher address token (sorted)
+  fee: number // Fee in basis points (3000 = 0.30%)
+  tickSpacing: number // Tick spacing for concentrated liquidity
+  hooks: Address // Hook contract (address(0) = no hooks)
+}
+
+/**
+ * Balance delta from swap/liquidity operations
+ * Positive = user owes pool, Negative = pool owes user
+ */
+export interface BalanceDelta {
+  amount0: bigint
+  amount1: bigint
+}
+
+/**
+ * Swap parameters
+ */
+export interface SwapParams {
+  zeroForOne: boolean // true = swap token0 for token1
+  amountSpecified: bigint // Positive = exact input, Negative = exact output
+  sqrtPriceLimitX96: bigint // Price limit (0 = no limit)
+}
+
+/**
+ * Modify liquidity parameters
+ */
+export interface ModifyLiquidityParams {
+  tickLower: number
+  tickUpper: number
+  liquidityDelta: bigint
+  salt: `0x${string}`
+}
+
+/**
+ * Pool state
+ */
+export interface PoolState {
+  sqrtPriceX96: bigint
+  tick: number
+  protocolFee: number
+  lpFee: number
+}
+
+/**
+ * Position info
+ */
+export interface Position {
+  liquidity: bigint
+  feeGrowthInside0LastX128: bigint
+  feeGrowthInside1LastX128: bigint
+}
+
+/**
+ * Native LUX currency constant
+ */
+export const NATIVE_LUX: Address = '0x0000000000000000000000000000000000000000'
+
+/**
+ * Sort currencies for pool key creation
+ */
+export function sortCurrencies(a: Address, b: Address): [Address, Address] {
+  return a.toLowerCase() < b.toLowerCase() ? [a, b] : [b, a]
+}
+
+/**
+ * Create a pool key from two currencies
+ */
+export function createPoolKey(
+  tokenA: Address,
+  tokenB: Address,
+  fee: number = 3000,
+  tickSpacing: number = 60,
+  hooks: Address = '0x0000000000000000000000000000000000000000'
+): PoolKey {
+  const [currency0, currency1] = sortCurrencies(tokenA, tokenB)
+  return { currency0, currency1, fee, tickSpacing, hooks }
+}
+
+// ============================================================================
+// LXBook Types (LP-9020) - CLOB Matching Engine
+// ============================================================================
+
+/**
+ * Order time-in-force
+ */
+export enum TIF {
+  GTC = 0, // Good-til-canceled (resting)
+  IOC = 1, // Immediate-or-cancel
+  ALO = 2, // Add-liquidity-only (post-only)
+}
+
+/**
+ * Order kind
+ */
+export enum OrderKind {
+  LIMIT = 0,
+  MARKET = 1,
+  STOP_MARKET = 2,
+  STOP_LIMIT = 3,
+  TAKE_MARKET = 4,
+  TAKE_LIMIT = 5,
+}
+
+/**
+ * Order group type
+ */
+export enum GroupType {
+  NONE = 0,
+  OCO = 1, // One-cancels-other
+  BRACKET = 2, // Bracket order
+}
+
+/**
+ * Action type for execute() endpoint
+ */
+export enum ActionType {
+  PLACE = 0,
+  CANCEL = 1,
+  CANCEL_BY_CLOID = 2,
+  MODIFY = 3,
+  TWAP_CREATE = 4,
+  TWAP_CANCEL = 5,
+  SCHEDULE_CANCEL = 6,
+  NOOP = 7,
+  RESERVE_WEIGHT = 8,
+}
+
+/**
+ * LXBook Order (LP-9020)
+ */
+export interface LXOrder {
+  marketId: number
+  isBuy: boolean
+  kind: OrderKind
+  sizeX18: bigint
+  limitPxX18: bigint
+  triggerPxX18: bigint
+  reduceOnly: boolean
+  tif: TIF
+  cloid: `0x${string}`
+  groupId: `0x${string}`
+  groupType: GroupType
+}
+
+/**
+ * LXBook Action (execute() payload)
+ */
+export interface LXAction {
+  actionType: ActionType
+  nonce: bigint
+  expiresAfter: bigint
+  data: `0x${string}`
+}
+
+/**
+ * LXBook PlaceResult
+ */
+export interface LXPlaceResult {
+  oid: bigint
+  status: number // 0=rejected, 1=filled, 2=resting, 3=partial
+  filledSizeX18: bigint
+  avgPxX18: bigint
+}
+
+/**
+ * LXBook L1 (best bid/ask)
+ */
+export interface LXL1 {
+  bestBidPxX18: bigint
+  bestBidSzX18: bigint
+  bestAskPxX18: bigint
+  bestAskSzX18: bigint
+  lastTradePxX18: bigint
+}
+
+// ============================================================================
+// LXVault Types (LP-9030) - Custody and Risk Engine
+// ============================================================================
+
+/**
+ * Margin mode
+ */
+export enum MarginMode {
+  CROSS = 0,
+  ISOLATED = 1,
+}
+
+/**
+ * Position side
+ */
+export enum PositionSide {
+  LONG = 0,
+  SHORT = 1,
+}
+
+/**
+ * LXVault Account identifier
+ */
+export interface LXAccount {
+  main: Address
+  subaccountId: number
+}
+
+/**
+ * LXVault Position (LP-9030)
+ */
+export interface LXPosition {
+  marketId: number
+  side: PositionSide
+  sizeX18: bigint
+  entryPxX18: bigint
+  unrealizedPnlX18: bigint
+  accumulatedFundingX18: bigint
+  lastFundingTime: bigint
+}
+
+/**
+ * LXVault MarginInfo
+ */
+export interface LXMarginInfo {
+  totalCollateralX18: bigint
+  usedMarginX18: bigint
+  freeMarginX18: bigint
+  marginRatioX18: bigint
+  maintenanceMarginX18: bigint
+  liquidatable: boolean
+}
+
+/**
+ * LXVault Settlement (LXBook → LXVault)
+ */
+export interface LXSettlement {
+  maker: LXAccount
+  taker: LXAccount
+  marketId: number
+  takerIsBuy: boolean
+  sizeX18: bigint
+  priceX18: bigint
+  makerFeeX18: bigint
+  takerFeeX18: bigint
+}
+
+/**
+ * LXVault LiquidationResult
+ */
+export interface LXLiquidationResult {
+  liquidated: LXAccount
+  liquidator: LXAccount
+  marketId: number
+  sizeX18: bigint
+  priceX18: bigint
+  penaltyX18: bigint
+  adlTriggered: boolean
+}
+
+// ============================================================================
+// LXFeed Types (LP-9040) - Price Feeds
+// ============================================================================
+
+/**
+ * LXFeed Mark price
+ */
+export interface LXMarkPrice {
+  indexPxX18: bigint
+  markPxX18: bigint
+  premiumX18: bigint
+  timestamp: bigint
+}
+
+/**
+ * LXFeed Funding rate
+ */
+export interface LXFundingRate {
+  rateX18: bigint
+  nextFundingTime: bigint
+}

package/src/router/index.ts

@@ -0,0 +1,6 @@
+/**
+ * Router Exports
+ * Omnichain routing between CLOB and AMM
+ */
+export * from './types'
+export * from './router'