Margin Calculations

calculateSizePremiumLiabilityWeight(
  size: BN,
  imfFactor: BN,
  liabilityWeight: BN,
  precision: BN,
  isBounded?: boolean
): BN

import { calculateSizePremiumLiabilityWeight } from '@drift-labs/sdk';
import { AMM_RESERVE_PRECISION } from '@drift-labs/sdk';

const size = new BN(1000).mul(AMM_RESERVE_PRECISION);
const imfFactor = market.imfFactor;
const liabilityWeight = market.marginRatioInitial;

const adjustedWeight = calculateSizePremiumLiabilityWeight(
  size,
  imfFactor,
  liabilityWeight,
  AMM_RESERVE_PRECISION,
  true
);

calculateSizeDiscountAssetWeight(
  size: BN,
  imfFactor: BN,
  assetWeight: BN
): BN

calculateOraclePriceForPerpMargin(
  perpPosition: PerpPosition,
  market: PerpMarketAccount,
  oraclePriceData: OraclePriceData
): BN

import { calculateOraclePriceForPerpMargin } from '@drift-labs/sdk';

const position = user.getPerpPosition(0);
const market = driftClient.getPerpMarketAccount(0);
const oracleData = driftClient.getOracleDataForPerpMarket(0);

const marginPrice = calculateOraclePriceForPerpMargin(
  position,
  market,
  oracleData
);

console.log('Margin price:', convertToNumber(marginPrice, PRICE_PRECISION));

calculateBaseAssetValueWithOracle(
  market: PerpMarketAccount,
  perpPosition: PerpPosition,
  oraclePriceData: Pick<OraclePriceData, 'price'>,
  includeOpenOrders?: boolean
): BN

import { calculateBaseAssetValueWithOracle } from '@drift-labs/sdk';

const market = driftClient.getPerpMarketAccount(0);
const position = user.getPerpPosition(0);
const oracleData = driftClient.getOracleDataForPerpMarket(0);

// Without open orders
const value = calculateBaseAssetValueWithOracle(
  market,
  position,
  oracleData
);

// With open orders
const worstCaseValue = calculateBaseAssetValueWithOracle(
  market,
  position,
  oracleData,
  true
);

calculateWorstCaseBaseAssetAmount(
  perpPosition: PerpPosition,
  perpMarket: PerpMarketAccount,
  oraclePrice: BN
): BN

calculateWorstCasePerpLiabilityValue(
  perpPosition: PerpPosition,
  perpMarket: PerpMarketAccount,
  oraclePrice: BN,
  includeOpenOrders?: boolean
): { worstCaseBaseAssetAmount: BN; worstCaseLiabilityValue: BN }

calculatePerpLiabilityValue(
  baseAssetAmount: BN,
  price: BN,
  isPredictionMarket: boolean
): BN

calculateMarginUSDCRequiredForTrade(
  driftClient: DriftClient,
  targetMarketIndex: number,
  baseSize: BN,
  userMaxMarginRatio?: number,
  userHighLeverageMode?: boolean,
  entryPrice?: BN
): BN

import { calculateMarginUSDCRequiredForTrade } from '@drift-labs/sdk';
import { BASE_PRECISION } from '@drift-labs/sdk';

const marketIndex = 0; // SOL-PERP
const baseSize = new BN(10).mul(BASE_PRECISION); // 10 SOL

const marginRequired = calculateMarginUSDCRequiredForTrade(
  driftClient,
  marketIndex,
  baseSize
);

console.log('Margin required:', convertToNumber(marginRequired, QUOTE_PRECISION), 'USDC');

calculateCollateralDepositRequiredForTrade(
  driftClient: DriftClient,
  targetMarketIndex: number,
  baseSize: BN,
  collateralIndex: number,
  userMaxMarginRatio?: number,
  userHighLeverageMode?: boolean,
  estEntryPrice?: BN
): BN

calculateCollateralValueOfDeposit(
  driftClient: DriftClient,
  collateralIndex: number,
  baseSize: BN
): BN

calculateLiquidationPrice(
  freeCollateral: BN,
  freeCollateralDelta: BN,
  oraclePrice: BN
): BN

import { calculateLiquidationPrice } from '@drift-labs/sdk';

const freeCollateral = user.getFreeCollateral();
const freeCollateralDelta = calculateFreeCollateralDelta(user, position);
const oraclePrice = driftClient.getOracleDataForPerpMarket(0).price;

const liqPrice = calculateLiquidationPrice(
  freeCollateral,
  freeCollateralDelta,
  oraclePrice
);

if (liqPrice.gt(new BN(0))) {
  console.log('Liquidation price:', convertToNumber(liqPrice, PRICE_PRECISION));
} else {
  console.log('No liquidation risk');
}

calculateUserMaxPerpOrderSize(
  driftClient: DriftClient,
  userAccountKey: PublicKey,
  userAccount: UserAccount,
  targetMarketIndex: number,
  tradeSide: PositionDirection
): { tradeSize: BN; oppositeSideTradeSize: BN }

calcHighLeverageModeInitialMarginRatioFromSize(
  preSizeAdjMarginRatio: BN,
  sizeAdjMarginRatio: BN,
  defaultMarginRatio: BN
): BN