@lifi/perps-types 0.1.1-alpha.0

package/src/market.ts

@@ -0,0 +1,96 @@
+export interface AuthorizationParam {
+  name: string
+  type: 'string' | 'number' | 'boolean'
+  required: boolean
+}
+
+export interface Authorization {
+  key: string
+  name: string
+  params?: AuthorizationParam[]
+}
+
+export interface Dex {
+  key: string
+  name: string
+  logoURI: string
+  authorizations: Authorization[]
+  extraData?: Record<string, unknown>
+}
+
+export interface DexesResponse {
+  dexes: Dex[]
+}
+
+export interface FundingInfo {
+  rate: string
+  nextFundingTime: number
+}
+
+export interface Market {
+  symbol: string
+  name: string
+  logoURI: string
+  assetId: number
+  dex: string
+  szDecimals: number
+  maxLeverage: number
+  onlyIsolated: boolean
+  funding: FundingInfo
+  openInterest?: string
+  volume24h?: string
+  markPrice: string
+}
+
+export interface MarketsResponse {
+  markets: Market[]
+}
+
+export interface PricesResponse {
+  prices: Record<string, string>
+}
+
+export interface Candle {
+  t: number
+  o: string
+  h: string
+  l: string
+  c: string
+  v: string
+}
+
+export interface OhlcvResponse {
+  dex: string
+  symbol: string
+  interval: string
+  candles: Candle[]
+}
+
+export type OhlcvInterval =
+  | '1m'
+  | '3m'
+  | '5m'
+  | '15m'
+  | '30m'
+  | '1h'
+  | '2h'
+  | '4h'
+  | '8h'
+  | '12h'
+  | '1d'
+  | '3d'
+  | '1w'
+  | '1M'
+
+export interface OrderbookLevel {
+  price: string
+  size: string
+}
+
+export interface OrderbookResponse {
+  dex: string
+  symbol: string
+  bids: OrderbookLevel[]
+  asks: OrderbookLevel[]
+  timestamp: number
+}

package/src/trading.ts

@@ -0,0 +1,99 @@
+import type { Address, Hex, PerpsTypedData } from './typedData.js'
+import type {
+  OrderActionType,
+  OrderSide,
+  OrderStatus,
+  OrderType,
+  TimeInForce,
+  TriggerCondition,
+} from './enums.js'
+
+export interface TriggerOrderInput {
+  triggerPrice: string
+  limitPrice?: string
+}
+
+export interface CreateOrderRequest {
+  dex: string
+  address: Address
+  signerAddress?: Address
+  clientOrderId?: string
+  symbol: string
+  side: OrderSide
+  type: OrderType
+  size: string
+  price: string
+  leverage?: number
+  reduceOnly?: boolean
+  timeInForce?: TimeInForce
+  expiresAt?: string
+  takeProfit?: TriggerOrderInput
+  stopLoss?: TriggerOrderInput
+}
+
+export interface OrderAction {
+  action: OrderActionType
+  description?: string
+  typedData: PerpsTypedData
+}
+
+export interface CreateOrderResponse {
+  actions: OrderAction[]
+}
+
+export interface CancelOrderRequest {
+  dex: string
+  address: Address
+  signerAddress?: Address
+  ids: string[]
+}
+
+export interface CancelOrderPayloadResponse {
+  actions: OrderAction[]
+}
+
+export interface SignedOrderAction {
+  action: OrderActionType
+  typedData: PerpsTypedData
+  signature: Hex
+}
+
+export interface SubmitOrderRequest {
+  dex: string
+  address: Address
+  signerAddress?: Address
+  actions: SignedOrderAction[]
+}
+
+export interface OrderActionResult {
+  action: OrderActionType
+  success: boolean
+  orderId?: string
+  error?: string
+}
+
+export interface SubmitOrderResponse {
+  results: OrderActionResult[]
+}
+
+export interface Order {
+  orderId: string
+  clientOrderId?: string
+  symbol: string
+  side: OrderSide
+  type: OrderType
+  price?: string
+  originalSize: string
+  remainingSize: string
+  filledSize: string
+  timeInForce?: TimeInForce
+  expiresAt?: string
+  reduceOnly?: boolean
+  isTrigger?: boolean
+  triggerPrice?: string
+  triggerCondition?: TriggerCondition
+  status: OrderStatus
+  averagePrice?: string
+  createdAt: string
+  updatedAt: string
+}

package/src/typedData.ts

@@ -0,0 +1,19 @@
+import type { TypedData, SignedTypedData } from '@lifi/types'
+import type { Address, Hex, TypedDataDomain, TypedDataParameter } from 'viem'
+
+export type PerpsTypedDataPrimaryType =
+  | 'HyperliquidTransaction:ApproveAgent'
+  | 'HyperliquidTransaction:ApproveBuilderFee'
+  | 'HyperliquidTransaction:UserSetAbstraction'
+  | 'Agent'
+
+export type PerpsTypedData = Omit<TypedData, 'primaryType'> & {
+  primaryType: PerpsTypedDataPrimaryType
+}
+
+export type PerpsSignedTypedData = Omit<SignedTypedData, 'primaryType'> & {
+  primaryType: PerpsTypedDataPrimaryType
+}
+
+// Re-export viem primitives used across perps types
+export type { Address, Hex, TypedDataDomain, TypedDataParameter }