Market Entities

class Market {
  readonly totalLongMargin: BigNumber           // Total long margin
  readonly totalShortMargin: BigNumber          // Total short margin
  readonly longOpenInterest: BigNumber          // Long open interest in mUSD
  readonly shortOpenInterest: BigNumber         // Short open interest in mUSD
  readonly longFundingAccumulated: BigNumber    // Accumulated long funding
  readonly shortFundingAccumulated: BigNumber   // Accumulated short funding
  readonly nextFundingRate: BigNumber           // Next funding rate
  readonly lastFundingRound: Date               // Last funding timestamp
  readonly longCloseOnly: boolean               // Long positions close-only
  readonly shortCloseOnly: boolean              // Short positions close-only
  readonly objectAddress: string                // Market collection address
 
  // Fee Configuration
  readonly minTakerFee: number                  // Minimum taker fee at equal OI
  readonly maxTakerFee: number                  // Maximum taker fee at max OI imbalance
  readonly minMakerFee: number                  // Minimum maker fee at large OI imbalance
  readonly maxMakerFee: number                  // Maximum maker fee at equal OI
 
  // Funding Configuration  
  readonly minFundingRate: number               // Minimum funding rate
  readonly maxFundingRate: number               // Maximum funding rate
  readonly baseFundingRate: number              // Base funding rate
  readonly fundingInterval: BigNumber           // Funding payment interval
 
  // Market Configuration
  readonly maxOpenInterest: BigNumber           // Maximum total OI allowed
  readonly maxOpenInterestImbalance: BigNumber  // Maximum OI imbalance allowed
  readonly maintenanceMargin: number            // Base maintenance margin percentage
  readonly maxLeverage: number                  // Maximum allowed leverage
  readonly minOrderSize: BigNumber              // Minimum order size in mUSD
  readonly maxOrderSize: BigNumber              // Maximum order size in mUSD
}

getOpenCloseFee(
  side: PositionSide,          // Position side (LONG/SHORT)
  isClose: boolean,            // Whether this is a closing operation
  positionSize: BigNumber,     // Size of the position
  perpPrice: BigNumber,        // Current perpetual price
  marginPrice: BigNumber       // Current margin token price
): BigNumber

getSkew(
  perpPrice: BigNumber,        // Current perpetual price
  isClose: boolean            // Whether this is a closing operation
): BigNumber                  // Returns skew amount (positive for long skew)

calculateFee(
  skew: BigNumber,            // Current market skew
  is_taker: boolean          // Whether the order is a taker order
): BigNumber                  // Returns calculated fee amount

class Position {
  readonly tokenId: bigint                          // Position token ID
  readonly market: Market                      // Associated market
  readonly side: PositionSide                  // Position side
  readonly openingPrice: BigNumber             // Opening price
  readonly margin: BigNumber                   // Position margin
  readonly positionSize: BigNumber             // Position size
  readonly fundingAccrued: BigNumber           // Accrued funding
  readonly maintenanceMargin: BigNumber        // Maintenance margin
  readonly strategyAddresses: string[]         // Strategy addresses
  readonly feesPaid: BigNumber                 // Total fees paid
  readonly fundingPaid: BigNumber              // Total funding paid
  readonly tradePnl: BigNumber                 // Trade PnL
  readonly realizedPnl: BigNumber              // Realized PnL
  readonly leverage: BigNumber                 // Position leverage
  readonly objectAddress: string               // Position object address
}

isOpen(): boolean            // Returns true if position is open

getLiquidationPrice(
  perpPrice: BigNumber,      // Current perpetual price
  marginPrice: BigNumber     // Current margin token price
): BigNumber                 // Returns liquidation price

getPositionMaintenanceMarginMUSD(
  perpPrice: BigNumber,      // Current perpetual price
  marginPrice: BigNumber     // Current margin token price
): BigNumber                 // Returns maintenance margin in mUSD

static getLeverage(
  position: Position,        // Position to calculate leverage for
  perpetualPrice: number,    // Current perpetual price
  marginPrice: number        // Current margin token price
): number                    // Returns leverage ratio (e.g., 2 for 2x leverage)

static estimatePnl(
  position: Position,        // Position to estimate PnL for
  perpetualPrice: number,    // Current perpetual price
  marginPrice: number        // Current margin token price
): number                    // Returns estimated PnL in margin tokens

static estimatePercentPnl(
  position: Position,        // Position to calculate percent PnL for
  perpetualPrice: number,    // Current perpetual price
  marginPrice: number        // Current margin token price
): number                    // Returns PnL as a percentage

type LimitOrderData = {
  is_decrease_only: boolean
  position_size: string
  is_long: boolean
  trigger_price: BigNumber
  triggers_above: boolean
  max_price_slippage: string
  expiration: string
}

class LimitOrder {
  readonly side: PositionSide                 // Order side
  readonly isDecreaseOnly: boolean            // Decrease-only flag
  readonly positionSize: BigNumber            // Order size
  readonly margin: BigNumber                  // Order margin
  readonly triggerPrice: BigNumber            // Trigger price
  readonly triggersAbove: boolean             // Trigger direction
  readonly maxPriceSlippage: BigNumber        // Maximum price slippage
  readonly expiration: bigint                 // Order expiration
  readonly marketObjectAddress: string        // Market object address
  readonly positionObjectAddress: string      // Position object address
  readonly objectAddress: string              // Order object address
}

static gtcExpiration(): bigint     // Returns U64_MAX

isGtc(): boolean                   // Returns true if order is GTC

static percentSlippageToPriceSlippage(
  triggerPrice: BigNumber,         // Base trigger price
  percentSlippage: number          // Slippage percentage in basis points
): BigNumber                       // Returns price slippage amount

// Get market resources
const marketAddr = "0x123..."
const marketResources = await aptosClient.getAccountResources({
  accountAddress: marketAddr
})
 
// Create market instance using client
const market = mirageClient.marketEntities.createMarket(
  marketResources,
  marketAddr
)

// Get position resources
const positionAddr = "0x456..."
const positionResources = await aptosClient.getAccountResources({
  accountAddress: positionAddr
})
 
// Create position instance using client
const position = mirageClient.marketEntities.createPosition(
  positionResources,
  market,  // Requires previously created market instance
  positionAddr
)

// Get limit order resources
const orderAddr = "0x789..."
const limitOrderResources = await aptosClient.getAccountResources({
  accountAddress: orderAddr
})
 
// Create limit order instance using client
const limitOrder = mirageClient.marketEntities.createLimitOrder(
  limitOrderResources,
  orderAddr
)