@drift-labs/sdk 2.60.0-beta.11 → 2.60.0-beta.13

package/VERSION

@@ -1 +1 @@
-2.60.0-beta.11
+2.60.0-beta.13

package/lib/user.d.ts

@@ -111,7 +111,7 @@ export declare class User {
     /**
      * @returns The margin requirement of a certain type (Initial or Maintenance) in USDC. : QUOTE_PRECISION
      */
-    getMarginRequirement(marginCategory: MarginCategory, liquidationBuffer?: BN, strict?: boolean): BN;
+    getMarginRequirement(marginCategory: MarginCategory, liquidationBuffer?: BN, strict?: boolean, includeOpenOrders?: boolean): BN;
     /**
      * @returns The initial margin requirement in USDC. : QUOTE_PRECISION
      */
@@ -246,12 +246,13 @@ export declare class User {
      * Calculate the liquidation price of a perp position, with optional parameter to calculate the liquidation price after a trade
      * @param marketIndex
      * @param positionBaseSizeChange // change in position size to calculate liquidation price for : Precision 10^13
+     * @param marginCategory // allow Initial to be passed in if we are trying to calculate price for DLP de-risking
      * @returns Precision : PRICE_PRECISION
      */
-    liquidationPrice(marketIndex: number, positionBaseSizeChange?: BN, estimatedEntryPrice?: BN): BN;
+    liquidationPrice(marketIndex: number, positionBaseSizeChange?: BN, estimatedEntryPrice?: BN, marginCategory?: MarginCategory): BN;
     calculateEntriesEffectOnFreeCollateral(market: PerpMarketAccount, oraclePrice: BN, perpPosition: PerpPosition, positionBaseSizeChange: BN, estimatedEntryPrice: BN): BN;
-    calculateFreeCollateralDeltaForPerp(market: PerpMarketAccount, perpPosition: PerpPosition, positionBaseSizeChange: BN): BN | undefined;
-    calculateFreeCollateralDeltaForSpot(market: SpotMarketAccount, signedTokenAmount: BN): BN;
+    calculateFreeCollateralDeltaForPerp(market: PerpMarketAccount, perpPosition: PerpPosition, positionBaseSizeChange: BN, marginCategory?: MarginCategory): BN | undefined;
+    calculateFreeCollateralDeltaForSpot(market: SpotMarketAccount, signedTokenAmount: BN, marginCategory?: MarginCategory): BN;
     /**
      * Calculates the estimated liquidation price for a position after closing a quote amount of the position.
      * @param positionMarketIndex

package/lib/user.js

@@ -432,8 +432,8 @@ class User {
     /**
      * @returns The margin requirement of a certain type (Initial or Maintenance) in USDC. : QUOTE_PRECISION
      */
-    getMarginRequirement(marginCategory, liquidationBuffer, strict = false) {
-        return this.getTotalPerpPositionValue(marginCategory, liquidationBuffer, true, strict).add(this.getSpotMarketLiabilityValue(undefined, marginCategory, liquidationBuffer, true, strict));
+    getMarginRequirement(marginCategory, liquidationBuffer, strict = false, includeOpenOrders = true) {
+        return this.getTotalPerpPositionValue(marginCategory, liquidationBuffer, includeOpenOrders, strict).add(this.getSpotMarketLiabilityValue(undefined, marginCategory, liquidationBuffer, includeOpenOrders, strict));
     }
     /**
      * @returns The initial margin requirement in USDC. : QUOTE_PRECISION
@@ -1080,12 +1080,13 @@ class User {
      * Calculate the liquidation price of a perp position, with optional parameter to calculate the liquidation price after a trade
      * @param marketIndex
      * @param positionBaseSizeChange // change in position size to calculate liquidation price for : Precision 10^13
+     * @param marginCategory // allow Initial to be passed in if we are trying to calculate price for DLP de-risking
      * @returns Precision : PRICE_PRECISION
      */
-    liquidationPrice(marketIndex, positionBaseSizeChange = numericConstants_1.ZERO, estimatedEntryPrice = numericConstants_1.ZERO) {
-        const totalCollateral = this.getTotalCollateral('Maintenance');
-        const maintenanceMarginRequirement = this.getMaintenanceMarginRequirement();
-        let freeCollateral = _1.BN.max(numericConstants_1.ZERO, totalCollateral.sub(maintenanceMarginRequirement));
+    liquidationPrice(marketIndex, positionBaseSizeChange = numericConstants_1.ZERO, estimatedEntryPrice = numericConstants_1.ZERO, marginCategory = 'Maintenance') {
+        const totalCollateral = this.getTotalCollateral(marginCategory);
+        const marginRequirement = this.getMarginRequirement(marginCategory, undefined, false);
+        let freeCollateral = _1.BN.max(numericConstants_1.ZERO, totalCollateral.sub(marginRequirement));
         const oracle = this.driftClient.getPerpMarketAccount(marketIndex).amm.oracle;
         const oraclePrice = this.driftClient.getOracleDataForPerpMarket(marketIndex).price;
         const market = this.driftClient.getPerpMarketAccount(marketIndex);
@@ -1094,7 +1095,7 @@ class User {
         positionBaseSizeChange = (0, _1.standardizeBaseAssetAmount)(positionBaseSizeChange, market.amm.orderStepSize);
         const freeCollateralChangeFromNewPosition = this.calculateEntriesEffectOnFreeCollateral(market, oraclePrice, currentPerpPosition, positionBaseSizeChange, estimatedEntryPrice);
         freeCollateral = freeCollateral.add(freeCollateralChangeFromNewPosition);
-        let freeCollateralDelta = this.calculateFreeCollateralDeltaForPerp(market, currentPerpPosition, positionBaseSizeChange);
+        let freeCollateralDelta = this.calculateFreeCollateralDeltaForPerp(market, currentPerpPosition, positionBaseSizeChange, marginCategory);
         if (!freeCollateralDelta) {
             return new _1.BN(-1);
         }
@@ -1105,7 +1106,7 @@ class User {
             const spotPosition = this.getSpotPosition(spotMarketWithSameOracle.marketIndex);
             if (spotPosition) {
                 const signedTokenAmount = (0, _1.getSignedTokenAmount)((0, spotBalance_1.getTokenAmount)(spotPosition.scaledBalance, spotMarketWithSameOracle, spotPosition.balanceType), spotPosition.balanceType);
-                const spotFreeCollateralDelta = this.calculateFreeCollateralDeltaForSpot(spotMarketWithSameOracle, signedTokenAmount);
+                const spotFreeCollateralDelta = this.calculateFreeCollateralDeltaForSpot(spotMarketWithSameOracle, signedTokenAmount, marginCategory);
                 freeCollateralDelta = freeCollateralDelta.add(spotFreeCollateralDelta || numericConstants_1.ZERO);
             }
         }
@@ -1135,6 +1136,8 @@ class User {
                 freeCollateralChange = costBasis.sub(newPositionValue);
             }
             else {
+                console.log('newPositionValue', newPositionValue.toString());
+                console.log('costBasis', costBasis.toString());
                 freeCollateralChange = newPositionValue.sub(costBasis);
             }
             // assume worst fee tier
@@ -1145,30 +1148,25 @@ class User {
             freeCollateralChange = freeCollateralChange.sub(takerFee);
         }
         const worstCaseBaseAssetAmount = (0, margin_1.calculateWorstCaseBaseAssetAmount)(perpPosition);
-        const marginRatioBefore = (0, _1.calculateMarketMarginRatio)(market, worstCaseBaseAssetAmount.abs(), 'Maintenance');
         const newWorstCaseBaseAssetAmount = worstCaseBaseAssetAmount.add(positionBaseSizeChange);
         const newMarginRatio = (0, _1.calculateMarketMarginRatio)(market, newWorstCaseBaseAssetAmount.abs(), 'Maintenance');
-        // update free collateral to account for change in margin ratio from position change
-        freeCollateralChange = freeCollateralChange.sub(worstCaseBaseAssetAmount
-            .mul(oraclePrice)
-            .div(numericConstants_1.BASE_PRECISION)
-            .mul(new _1.BN(newMarginRatio - marginRatioBefore))
-            .div(numericConstants_1.MARGIN_PRECISION));
         // update free collateral to account for new margin requirement from position change
-        freeCollateralChange = freeCollateralChange.sub(positionBaseSizeChange
+        freeCollateralChange = freeCollateralChange.sub(newWorstCaseBaseAssetAmount
+            .abs()
+            .sub(worstCaseBaseAssetAmount.abs())
             .mul(oraclePrice)
             .div(numericConstants_1.BASE_PRECISION)
             .mul(new _1.BN(newMarginRatio))
             .div(numericConstants_1.MARGIN_PRECISION));
         return freeCollateralChange;
     }
-    calculateFreeCollateralDeltaForPerp(market, perpPosition, positionBaseSizeChange) {
+    calculateFreeCollateralDeltaForPerp(market, perpPosition, positionBaseSizeChange, marginCategory = 'Maintenance') {
         const currentBaseAssetAmount = perpPosition.baseAssetAmount;
         const worstCaseBaseAssetAmount = (0, margin_1.calculateWorstCaseBaseAssetAmount)(perpPosition);
         const orderBaseAssetAmount = worstCaseBaseAssetAmount.sub(currentBaseAssetAmount);
         const proposedBaseAssetAmount = currentBaseAssetAmount.add(positionBaseSizeChange);
         const proposedWorstCaseBaseAssetAmount = worstCaseBaseAssetAmount.add(positionBaseSizeChange);
-        const marginRatio = (0, _1.calculateMarketMarginRatio)(market, proposedWorstCaseBaseAssetAmount.abs(), 'Maintenance');
+        const marginRatio = (0, _1.calculateMarketMarginRatio)(market, proposedWorstCaseBaseAssetAmount.abs(), marginCategory, this.getUserAccount().maxMarginRatio);
         const marginRatioQuotePrecision = new _1.BN(marginRatio)
             .mul(numericConstants_1.QUOTE_PRECISION)
             .div(numericConstants_1.MARGIN_PRECISION);
@@ -1194,17 +1192,17 @@ class User {
         }
         return freeCollateralDelta;
     }
-    calculateFreeCollateralDeltaForSpot(market, signedTokenAmount) {
+    calculateFreeCollateralDeltaForSpot(market, signedTokenAmount, marginCategory = 'Maintenance') {
         const tokenPrecision = new _1.BN(Math.pow(10, market.decimals));
         if (signedTokenAmount.gt(numericConstants_1.ZERO)) {
-            const assetWeight = (0, spotBalance_1.calculateAssetWeight)(signedTokenAmount, this.driftClient.getOraclePriceDataAndSlot(market.oracle).data.price, market, 'Maintenance');
+            const assetWeight = (0, spotBalance_1.calculateAssetWeight)(signedTokenAmount, this.driftClient.getOraclePriceDataAndSlot(market.oracle).data.price, market, marginCategory);
             return numericConstants_1.QUOTE_PRECISION.mul(assetWeight)
                 .div(numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION)
                 .mul(signedTokenAmount)
                 .div(tokenPrecision);
         }
         else {
-            const liabilityWeight = (0, spotBalance_1.calculateLiabilityWeight)(signedTokenAmount.abs(), market, 'Maintenance');
+            const liabilityWeight = (0, spotBalance_1.calculateLiabilityWeight)(signedTokenAmount.abs(), market, marginCategory);
             return numericConstants_1.QUOTE_PRECISION.neg()
                 .mul(liabilityWeight)
                 .div(numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@drift-labs/sdk",
-	"version": "2.60.0-beta.11",
+	"version": "2.60.0-beta.13",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"author": "crispheaney",

package/src/user.ts

@@ -674,19 +674,20 @@ export class User {
 	public getMarginRequirement(
 		marginCategory: MarginCategory,
 		liquidationBuffer?: BN,
-		strict = false
+		strict = false,
+		includeOpenOrders = true
 	): BN {
 		return this.getTotalPerpPositionValue(
 			marginCategory,
 			liquidationBuffer,
-			true,
+			includeOpenOrders,
 			strict
 		).add(
 			this.getSpotMarketLiabilityValue(
 				undefined,
 				marginCategory,
 				liquidationBuffer,
-				true,
+				includeOpenOrders,
 				strict
 			)
 		);
@@ -1970,19 +1971,22 @@ export class User {
 	 * Calculate the liquidation price of a perp position, with optional parameter to calculate the liquidation price after a trade
 	 * @param marketIndex
 	 * @param positionBaseSizeChange // change in position size to calculate liquidation price for : Precision 10^13
+	 * @param marginCategory // allow Initial to be passed in if we are trying to calculate price for DLP de-risking
 	 * @returns Precision : PRICE_PRECISION
 	 */
 	public liquidationPrice(
 		marketIndex: number,
 		positionBaseSizeChange: BN = ZERO,
-		estimatedEntryPrice: BN = ZERO
+		estimatedEntryPrice: BN = ZERO,
+		marginCategory: MarginCategory = 'Maintenance'
 	): BN {
-		const totalCollateral = this.getTotalCollateral('Maintenance');
-		const maintenanceMarginRequirement = this.getMaintenanceMarginRequirement();
-		let freeCollateral = BN.max(
-			ZERO,
-			totalCollateral.sub(maintenanceMarginRequirement)
+		const totalCollateral = this.getTotalCollateral(marginCategory);
+		const marginRequirement = this.getMarginRequirement(
+			marginCategory,
+			undefined,
+			false
 		);
+		let freeCollateral = BN.max(ZERO, totalCollateral.sub(marginRequirement));
 
 		const oracle =
 			this.driftClient.getPerpMarketAccount(marketIndex).amm.oracle;
@@ -2014,7 +2018,8 @@ export class User {
 		let freeCollateralDelta = this.calculateFreeCollateralDeltaForPerp(
 			market,
 			currentPerpPosition,
-			positionBaseSizeChange
+			positionBaseSizeChange,
+			marginCategory
 		);
 
 		if (!freeCollateralDelta) {
@@ -2041,7 +2046,8 @@ export class User {
 				const spotFreeCollateralDelta =
 					this.calculateFreeCollateralDeltaForSpot(
 						spotMarketWithSameOracle,
-						signedTokenAmount
+						signedTokenAmount,
+						marginCategory
 					);
 				freeCollateralDelta = freeCollateralDelta.add(
 					spotFreeCollateralDelta || ZERO
@@ -2086,6 +2092,8 @@ export class User {
 			if (positionBaseSizeChange.gt(ZERO)) {
 				freeCollateralChange = costBasis.sub(newPositionValue);
 			} else {
+				console.log('newPositionValue', newPositionValue.toString());
+				console.log('costBasis', costBasis.toString());
 				freeCollateralChange = newPositionValue.sub(costBasis);
 			}
 
@@ -2101,12 +2109,6 @@ export class User {
 		const worstCaseBaseAssetAmount =
 			calculateWorstCaseBaseAssetAmount(perpPosition);
 
-		const marginRatioBefore = calculateMarketMarginRatio(
-			market,
-			worstCaseBaseAssetAmount.abs(),
-			'Maintenance'
-		);
-
 		const newWorstCaseBaseAssetAmount = worstCaseBaseAssetAmount.add(
 			positionBaseSizeChange
 		);
@@ -2117,18 +2119,11 @@ export class User {
 			'Maintenance'
 		);
 
-		// update free collateral to account for change in margin ratio from position change
-		freeCollateralChange = freeCollateralChange.sub(
-			worstCaseBaseAssetAmount
-				.mul(oraclePrice)
-				.div(BASE_PRECISION)
-				.mul(new BN(newMarginRatio - marginRatioBefore))
-				.div(MARGIN_PRECISION)
-		);
-
 		// update free collateral to account for new margin requirement from position change
 		freeCollateralChange = freeCollateralChange.sub(
-			positionBaseSizeChange
+			newWorstCaseBaseAssetAmount
+				.abs()
+				.sub(worstCaseBaseAssetAmount.abs())
 				.mul(oraclePrice)
 				.div(BASE_PRECISION)
 				.mul(new BN(newMarginRatio))
@@ -2141,7 +2136,8 @@ export class User {
 	calculateFreeCollateralDeltaForPerp(
 		market: PerpMarketAccount,
 		perpPosition: PerpPosition,
-		positionBaseSizeChange: BN
+		positionBaseSizeChange: BN,
+		marginCategory: MarginCategory = 'Maintenance'
 	): BN | undefined {
 		const currentBaseAssetAmount = perpPosition.baseAssetAmount;
 
@@ -2160,7 +2156,8 @@ export class User {
 		const marginRatio = calculateMarketMarginRatio(
 			market,
 			proposedWorstCaseBaseAssetAmount.abs(),
-			'Maintenance'
+			marginCategory,
+			this.getUserAccount().maxMarginRatio
 		);
 		const marginRatioQuotePrecision = new BN(marginRatio)
 			.mul(QUOTE_PRECISION)
@@ -2195,7 +2192,8 @@ export class User {
 
 	calculateFreeCollateralDeltaForSpot(
 		market: SpotMarketAccount,
-		signedTokenAmount: BN
+		signedTokenAmount: BN,
+		marginCategory: MarginCategory = 'Maintenance'
 	): BN {
 		const tokenPrecision = new BN(Math.pow(10, market.decimals));
 
@@ -2204,7 +2202,7 @@ export class User {
 				signedTokenAmount,
 				this.driftClient.getOraclePriceDataAndSlot(market.oracle).data.price,
 				market,
-				'Maintenance'
+				marginCategory
 			);
 
 			return QUOTE_PRECISION.mul(assetWeight)
@@ -2215,7 +2213,7 @@ export class User {
 			const liabilityWeight = calculateLiabilityWeight(
 				signedTokenAmount.abs(),
 				market,
-				'Maintenance'
+				marginCategory
 			);
 
 			return QUOTE_PRECISION.neg()