@lifi/perps-types 0.2.0-alpha.0 → 1.0.0

package/src/providers/hyperliquid/mappers/order.ts

@@ -1,169 +0,0 @@
-import {
-  OrderSide,
-  OrderStatus,
-  OrderType,
-  TimeInForce,
-} from '../../../enums.js'
-import type { OpenOrder, TriggerOrder } from '../../../account.js'
-import type { Order } from '../../../action.js'
-import type { HlFrontendOpenOrder, HlOrderDetail } from '../types.js'
-import { deriveMarket } from './_market.js'
-
-/** Map a Hyperliquid orderType string to the OrderType enum. */
-export const mapOrderType = (orderType: string): OrderType => {
-  switch (orderType) {
-    case 'Take Profit Market':
-      return OrderType.TAKE_PROFIT_MARKET
-    case 'Take Profit Limit':
-      return OrderType.TAKE_PROFIT_LIMIT
-    case 'Stop Market':
-      return OrderType.STOP_MARKET
-    case 'Stop Limit':
-      return OrderType.STOP_LIMIT
-    case 'Market':
-      return OrderType.MARKET
-    default:
-      return OrderType.LIMIT
-  }
-}
-
-export const isTriggerType = (type: OrderType): boolean =>
-  type === OrderType.TAKE_PROFIT_MARKET ||
-  type === OrderType.TAKE_PROFIT_LIMIT ||
-  type === OrderType.STOP_MARKET ||
-  type === OrderType.STOP_LIMIT
-
-export const mapOpenOrder = (o: HlFrontendOpenOrder): OpenOrder => ({
-  id: String(o.oid),
-  asset: {
-    assetId: o.coin,
-    market: deriveMarket(o.coin),
-    displaySymbol: o.coin,
-    displayQuote: null,
-  },
-  side: o.side === 'B' ? OrderSide.BUY : OrderSide.SELL,
-  type: mapOrderType(o.orderType),
-  size: o.sz,
-  price: o.limitPx,
-  filledSize: o.origSz
-    ? (parseFloat(o.origSz) - parseFloat(o.sz)).toString()
-    : '0',
-  reduceOnly: o.reduceOnly ?? false,
-  label: o.isTrigger ? o.triggerCondition : undefined,
-  createdAt: new Date(o.timestamp).toISOString(),
-})
-
-export const mapTriggerOrder = (o: HlFrontendOpenOrder): TriggerOrder => {
-  const type = mapOrderType(o.orderType)
-  const isLimit =
-    type === OrderType.TAKE_PROFIT_LIMIT || type === OrderType.STOP_LIMIT
-  return {
-    id: String(o.oid),
-    asset: {
-      assetId: o.coin,
-      market: deriveMarket(o.coin),
-      displaySymbol: o.coin,
-      displayQuote: null,
-    },
-    type,
-    size: o.sz,
-    triggerPrice: o.triggerPx,
-    ...(isLimit ? { limitPrice: o.limitPx } : {}),
-    label: o.triggerCondition,
-    createdAt: new Date(o.timestamp).toISOString(),
-  }
-}
-
-const mapOrderStatus = (status: string): OrderStatus => {
-  switch (status) {
-    case 'open':
-    case 'resting':
-      return OrderStatus.OPEN
-    case 'filled':
-      return OrderStatus.FILLED
-    case 'canceled':
-    case 'cancelled':
-      return OrderStatus.CANCELLED
-    case 'rejected':
-      return OrderStatus.REJECTED
-    case 'triggered':
-      return OrderStatus.TRIGGERED
-    case 'marginCanceled':
-      return OrderStatus.CANCELLED
-    default:
-      return OrderStatus.PENDING
-  }
-}
-
-/**
- * Map a raw Hyperliquid order status to a short English sentence
- * describing *why* the order ended in a terminal non-FILLED state. Bare
- * `canceled`/`cancelled`/`rejected` carry no actionable detail and
- * return `undefined`; so do non-terminal and unknown values.
- */
-export const mapStatusReason = (status: string): string | undefined => {
-  switch (status) {
-    case 'iocCanceled':
-      return 'Order cancelled: not enough liquidity to fill immediately.'
-    case 'reduceOnlyCanceled':
-      return 'Order cancelled: would not reduce your position.'
-    case 'marginCanceled':
-      return 'Order cancelled: insufficient margin.'
-    case 'liquidatedCanceled':
-      return 'Order cancelled: account was liquidated.'
-    case 'siblingFilledCanceled':
-      return 'Order cancelled: sibling OCO order filled first.'
-    case 'selfTradeCanceled':
-      return 'Order cancelled: would self-trade against your own resting order.'
-    case 'tickRejected':
-      return 'Order rejected: price did not match the tick size.'
-    case 'minTradeNtlRejected':
-      return 'Order rejected: notional value below the minimum trade size.'
-    case 'delistedRejected':
-      return 'Order rejected: market has been delisted.'
-    default:
-      return undefined
-  }
-}
-
-const mapTimeInForce = (tif: string | undefined): TimeInForce | undefined => {
-  switch (tif) {
-    case 'Gtc':
-      return TimeInForce.GTC
-    case 'Ioc':
-      return TimeInForce.IOC
-    case 'Alo':
-      return TimeInForce.POST_ONLY
-    default:
-      return undefined
-  }
-}
-
-export const mapOrder = (detail: HlOrderDetail): Order => {
-  const o = detail.order
-  const filled = parseFloat(o.origSz) - parseFloat(o.sz)
-
-  return {
-    orderId: String(o.oid),
-    asset: {
-      assetId: o.coin,
-      market: deriveMarket(o.coin),
-      displaySymbol: o.coin,
-      displayQuote: null,
-    },
-    side: o.side === 'B' ? OrderSide.BUY : OrderSide.SELL,
-    type: mapOrderType(o.orderType),
-    price: o.limitPx,
-    originalSize: o.origSz,
-    remainingSize: o.sz,
-    filledSize: filled.toString(),
-    timeInForce: mapTimeInForce(o.tif ?? undefined),
-    reduceOnly: o.reduceOnly ?? undefined,
-    isTrigger: o.triggerCondition !== undefined && o.triggerCondition !== 'N/A',
-    triggerPrice: o.triggerPx ?? undefined,
-    status: mapOrderStatus(detail.status),
-    statusReason: mapStatusReason(detail.status),
-    createdAt: new Date(o.timestamp).toISOString(),
-    updatedAt: new Date(detail.statusTimestamp).toISOString(),
-  }
-}

package/src/providers/hyperliquid/mappers/position.ts

@@ -1,33 +0,0 @@
-import { MarginMode, PositionSide } from '../../../enums.js'
-import type { Position } from '../../../account.js'
-import type { HlAssetPosition } from '../types.js'
-import { deriveMarket } from './_market.js'
-
-export const mapPosition = (ap: HlAssetPosition): Position => {
-  const pos = ap.position
-  const szi = parseFloat(pos.szi)
-
-  return {
-    asset: {
-      assetId: pos.coin,
-      market: deriveMarket(pos.coin),
-      displaySymbol: pos.coin,
-      displayQuote: null,
-    },
-    side: szi >= 0 ? PositionSide.LONG : PositionSide.SHORT,
-    size: Math.abs(szi).toString(),
-    entryPrice: pos.entryPx ?? '0',
-    markPrice:
-      pos.positionValue && szi !== 0
-        ? (parseFloat(pos.positionValue) / Math.abs(szi)).toString()
-        : '0',
-    liquidationPrice: pos.liquidationPx ?? '0',
-    unrealizedPnl: pos.unrealizedPnl,
-    leverage: ap.position.leverage.value,
-    marginUsed: pos.marginUsed,
-    marginMode:
-      ap.position.leverage.type === 'cross'
-        ? MarginMode.CROSS
-        : MarginMode.ISOLATED,
-  }
-}

package/src/providers/hyperliquid/types.ts

@@ -1,379 +0,0 @@
-import type { Address } from 'viem'
-
-// ---------------------------------------------------------------------------
-// Hyperliquid /info response types
-// ---------------------------------------------------------------------------
-
-// -- metaAndAssetCtxs -------------------------------------------------------
-
-export type HlUniverseItem = {
-  name: string
-  szDecimals: number
-  maxLeverage: number
-  onlyIsolated?: boolean
-  isDelisted?: boolean
-}
-
-export type HlMeta = {
-  universe: HlUniverseItem[]
-}
-
-export type HlAssetCtx = {
-  funding: string
-  openInterest: string
-  dayNtlVlm: string
-  prevDayPx: string
-  markPx: string
-}
-
-export type HlMetaAndAssetCtxs = [HlMeta, HlAssetCtx[]]
-
-export type HlUniverse = HlMeta['universe']
-
-// -- allMids ----------------------------------------------------------------
-
-export type HlAllMids = Record<string, string>
-
-// -- candleSnapshot ---------------------------------------------------------
-
-export type HlCandle = {
-  t: number
-  o: string
-  h: string
-  l: string
-  c: string
-  v: string
-}
-
-export type HlCandleSnapshot = HlCandle[]
-
-// -- l2Book -----------------------------------------------------------------
-
-export type HlLevel = {
-  px: string
-  sz: string
-  n: number
-}
-
-export type HlL2Book = {
-  levels: [HlLevel[], HlLevel[]]
-  time: number
-}
-
-// -- clearinghouseState -----------------------------------------------------
-
-export type HlPosition = {
-  coin: string
-  szi: string
-  entryPx: string
-  positionValue: string
-  liquidationPx: string
-  unrealizedPnl: string
-  marginUsed: string
-  leverage: {
-    type: string
-    value: number
-  }
-}
-
-export type HlAssetPosition = {
-  position: HlPosition
-}
-
-export type HlClearinghouseState = {
-  assetPositions: HlAssetPosition[]
-  marginSummary: {
-    accountValue: string
-    totalMarginUsed: string
-  }
-  crossMarginSummary: {
-    accountValue: string
-    totalMarginUsed: string
-  }
-}
-
-// -- spotClearinghouseState -------------------------------------------------
-
-export type HlSpotBalance = {
-  coin: string
-  token: number
-  total: string
-  hold: string
-  entryNtl: string
-}
-
-export type HlSpotClearinghouseState = {
-  balances: HlSpotBalance[]
-}
-
-// -- userFees ---------------------------------------------------------------
-
-export type HlUserFees = {
-  userAddRate: string
-  userCrossRate: string
-  activeReferralDiscount: string
-}
-
-// -- frontendOpenOrders -----------------------------------------------------
-
-export type HlFrontendOpenOrder = {
-  oid: number
-  coin: string
-  side: string
-  sz: string
-  limitPx: string
-  orderType: string
-  origSz: string
-  reduceOnly: boolean
-  timestamp: number
-  isTrigger: boolean
-  isPositionTpsl: boolean
-  triggerCondition: string
-  triggerPx: string
-  children: HlFrontendOpenOrder[]
-  tif: string | null
-  cloid: string | null
-}
-
-export type HlFrontendOpenOrders = HlFrontendOpenOrder[]
-
-// -- extraAgents ------------------------------------------------------------
-
-export type HlExtraAgents = Record<string, unknown>[]
-
-// -- userFills / userFillsByTime --------------------------------------------
-
-export type HlUserFill = {
-  tid: number
-  oid: number
-  coin: string
-  side: string
-  sz: string
-  px: string
-  dir: string
-  fee: string
-  closedPnl: string
-  crossed: boolean
-  time: number
-  startPosition: string
-}
-
-export type HlUserFills = HlUserFill[]
-
-export type HlUserFillsByTime = HlUserFill[]
-
-// -- orderStatus ------------------------------------------------------------
-
-export type HlOrderDetail = {
-  order: {
-    oid: number
-    coin: string
-    side: string
-    sz: string
-    limitPx: string
-    orderType: string
-    origSz: string
-    reduceOnly: boolean
-    timestamp: number
-    tif: string | null
-    cloid: string | null
-    triggerCondition: string
-    triggerPx: string | null
-  }
-  status: string
-  statusTimestamp: number
-}
-
-export type HlOrderStatusFound = {
-  status: 'order'
-  order: HlOrderDetail
-}
-
-export type HlOrderStatusResponse =
-  | HlOrderStatusFound
-  | { status: 'unknownOid' }
-
-// -- userNonFundingLedgerUpdates --------------------------------------------
-
-/**
- * Hyperliquid `spotTransfer` ledger delta. Emitted for transfers of spot
- * tokens between Hyperliquid accounts. `user` is the sender, `destination`
- * the recipient; direction is derived at the call site from the queried
- * address.
- */
-export type HlSpotTransferDelta = {
-  type: 'spotTransfer'
-  token: string
-  amount: string
-  usdcValue: string
-  user: Address
-  destination: Address
-  fee?: string
-  nativeTokenFee?: string
-  nonce?: number
-}
-
-/**
- * Hyperliquid ledger delta emitted for the `sendAsset` exchange action. The
- * wire `type` literal is `'send'` (NOT `'sendAsset'`); the TS name retains
- * the `SendAsset` prefix to match `HL_PRIMARY_TYPE_SEND_ASSET`.
- *
- * - `user` is the sender, `destination` the recipient. For same-user dex
- *   moves both equal the queried address.
- * - `sourceDex` / `destinationDex` use `""` for the main USDC perp DEX,
- *   `"spot"` for spot, or the perp DEX name otherwise.
- * - `token` is a wire token identifier (e.g. `"USDC"` or `"TOKEN:0x..."`).
- * - `nonce` is the wire nonce (ms timestamp); always present on `send`
- *   deltas, unlike `spotTransfer` where it may be null.
- */
-export type HlSendAssetDelta = {
-  type: 'send'
-  user: Address
-  destination: Address
-  sourceDex: string
-  destinationDex: string
-  token: string
-  amount: string
-  usdcValue: string
-  fee: string
-  nativeTokenFee: string
-  nonce: number
-  feeToken: string
-}
-
-export type HlLedgerDelta =
-  | HlSpotTransferDelta
-  | HlSendAssetDelta
-  | {
-      type: string
-      usdc?: string
-      [key: string]: unknown
-    }
-
-/**
- * Type guard for `HlSpotTransferDelta` — TypeScript cannot narrow off the
- * `type` discriminant alone because the catch-all arm of `HlLedgerDelta` has
- * `type: string` (a supertype of the literal `'spotTransfer'`). Use this at
- * call sites that need the strongly-typed shape.
- */
-export const isSpotTransferDelta = (
-  delta: HlLedgerDelta
-): delta is HlSpotTransferDelta => delta.type === 'spotTransfer'
-
-/**
- * Type guard for `HlSendAssetDelta`. The wire `type` literal is `'send'`;
- * see `HlSendAssetDelta` for the naming-vs-wire-format rationale. Same
- * catch-all-arm caveat as `isSpotTransferDelta`.
- */
-export const isSendAssetDelta = (
-  delta: HlLedgerDelta
-): delta is HlSendAssetDelta => delta.type === 'send'
-
-export type HlLedgerUpdate = {
-  time: number
-  hash: string
-  delta: HlLedgerDelta
-}
-
-export type HlUserNonFundingLedgerUpdates = HlLedgerUpdate[]
-
-// -- userFunding ------------------------------------------------------------
-
-export type HlFundingDelta = {
-  type: 'funding'
-  coin: string
-  usdc: string
-  szi: string
-  fundingRate: string
-}
-
-export type HlFundingUpdate = {
-  time: number
-  hash: string
-  delta: HlFundingDelta
-}
-
-export type HlUserFunding = HlFundingUpdate[]
-
-// -- abstraction mode -------------------------------------------------------
-
-/**
- * Possible values returned by the `userAbstraction` info endpoint.
- * `null` means abstraction has never been set (standard mode).
- */
-export const HlAbstractionMode = {
-  DISABLED: 'disabled',
-  UNIFIED_ACCOUNT: 'unifiedAccount',
-  PORTFOLIO_MARGIN: 'portfolioMargin',
-  DEX_ABSTRACTION: 'dexAbstraction',
-} as const
-
-export type HlAbstractionMode =
-  (typeof HlAbstractionMode)[keyof typeof HlAbstractionMode]
-
-// -- perpDexs ---------------------------------------------------------------
-
-export type HlPerpDexs = (null | { name: string })[]
-
-// ---------------------------------------------------------------------------
-// Exchange request / response types
-// ---------------------------------------------------------------------------
-
-export type HlExchangeRequest = {
-  action: Record<string, unknown>
-  signature: {
-    r: string
-    s: string
-    v: number
-  }
-  nonce: number
-  vaultAddress?: string | null
-}
-
-export type HlExchangeResponse = {
-  status: string
-  response?:
-    | string
-    | {
-        type: string
-        data?: {
-          statuses?: (
-            | string
-            | { filled: { totalSz: string; avgPx: string; oid: number } }
-            | { resting: { oid: number } }
-            | { waitingForFill: { oid: number } }
-            | { waitingForTrigger: { oid: number } }
-            | { success: true }
-            | { error: string }
-          )[]
-          status?: unknown
-        }
-      }
-}
-
-// ---------------------------------------------------------------------------
-// Hyperliquid EIP-712 primary type constants
-// ---------------------------------------------------------------------------
-
-export const HL_PRIMARY_TYPE_APPROVE_AGENT =
-  'HyperliquidTransaction:ApproveAgent' as const
-export const HL_PRIMARY_TYPE_APPROVE_BUILDER_FEE =
-  'HyperliquidTransaction:ApproveBuilderFee' as const
-export const HL_PRIMARY_TYPE_USER_SET_ABSTRACTION =
-  'HyperliquidTransaction:UserSetAbstraction' as const
-export const HL_PRIMARY_TYPE_AGENT_SET_ABSTRACTION =
-  'HyperliquidTransaction:AgentSetAbstraction' as const
-export const HL_PRIMARY_TYPE_WITHDRAW =
-  'HyperliquidTransaction:Withdraw' as const
-export const HL_PRIMARY_TYPE_SEND_ASSET =
-  'HyperliquidTransaction:SendAsset' as const
-export const HL_PRIMARY_TYPE_AGENT = 'Agent' as const
-
-export type HlPrimaryType =
-  | typeof HL_PRIMARY_TYPE_APPROVE_AGENT
-  | typeof HL_PRIMARY_TYPE_APPROVE_BUILDER_FEE
-  | typeof HL_PRIMARY_TYPE_USER_SET_ABSTRACTION
-  | typeof HL_PRIMARY_TYPE_AGENT_SET_ABSTRACTION
-  | typeof HL_PRIMARY_TYPE_WITHDRAW
-  | typeof HL_PRIMARY_TYPE_SEND_ASSET
-  | typeof HL_PRIMARY_TYPE_AGENT

package/src/providers/lighter/apiTypes.ts

@@ -1,87 +0,0 @@
-// ---------------------------------------------------------------------------
-// Lighter raw API response types — shared between backend (REST) and SDK (WS)
-// ---------------------------------------------------------------------------
-
-export type LtAccountPosition = {
-  market_id: number
-  symbol: string
-  initial_margin_fraction: string
-  open_order_count: number
-  pending_order_count: number
-  position_tied_order_count: number
-  sign: number
-  position: string
-  avg_entry_price: string
-  position_value: string
-  unrealized_pnl: string
-  realized_pnl: string
-  liquidation_price: string
-  total_funding_paid_out: string
-  margin_mode: number
-  allocated_margin: string
-  total_discount: string
-}
-
-export type LtAccountAsset = {
-  symbol: string
-  asset_id: number
-  balance: string
-  locked_balance: string
-}
-
-export type LtTrade = {
-  trade_id: number
-  tx_hash: string
-  type: string
-  market_id: number
-  size: string
-  price: string
-  usd_amount: string
-  ask_id: number
-  bid_id: number
-  ask_account_id: number
-  bid_account_id: number
-  is_maker_ask: boolean
-  block_height: number
-  timestamp: number
-  // Lighter's OpenAPI spec marks these as required `StrictInt`, but the live
-  // /api/v1/trades endpoint omits them on some `type: "trade"` rows (observed
-  // on older trades) — keep optional and let the mapper emit `undefined`.
-  taker_fee?: number
-  maker_fee?: number
-  transaction_time: number
-  // Per-counterparty position snapshot BEFORE the trade is applied. Signed
-  // strings: positive = long, negative = short, "0" / "0.00000" = flat.
-  taker_position_size_before: string
-  maker_position_size_before: string
-}
-
-export type LtOrder = {
-  order_index: number
-  client_order_index: number
-  order_id: string
-  client_order_id: string
-  market_index: number
-  owner_account_index: number
-  initial_base_amount: string
-  price: string
-  nonce: number
-  remaining_base_amount: string
-  is_ask: boolean
-  filled_base_amount: string
-  filled_quote_amount: string
-  side: string
-  type: string
-  time_in_force: string
-  reduce_only: boolean
-  trigger_price: string
-  order_expiry: number
-  status: string
-  trigger_status: string
-  trigger_time: number
-  block_height: number
-  timestamp: number
-  created_at: number
-  updated_at: number
-  transaction_time: number
-}

package/src/providers/lighter/index.ts

@@ -1,3 +0,0 @@
-export * from './types.js'
-export * from './apiTypes.js'
-export * from './mappers/index.js'