@drift-labs/sdk 2.35.0 → 2.35.1-beta.1

package/VERSION

@@ -1 +1 @@
-2.34.1-beta.9
+2.35.1-beta.1

package/lib/math/position.d.ts

@@ -25,7 +25,7 @@ export declare function calculateClaimablePnl(market: PerpMarketAccount, spotMar
  *
  * @param market
  * @param PerpPosition
- * @returns // TODO-PRECISION
+ * @returns // QUOTE_PRECISION
  */
 export declare function calculatePositionFundingPNL(market: PerpMarketAccount, perpPosition: PerpPosition): BN;
 export declare function positionIsAvailable(position: PerpPosition): boolean;

package/lib/math/position.js

@@ -96,7 +96,7 @@ exports.calculateClaimablePnl = calculateClaimablePnl;
  *
  * @param market
  * @param PerpPosition
- * @returns // TODO-PRECISION
+ * @returns // QUOTE_PRECISION
  */
 function calculatePositionFundingPNL(market, perpPosition) {
     if (perpPosition.baseAssetAmount.eq(numericConstants_1.ZERO)) {

package/lib/user.d.ts

@@ -93,7 +93,7 @@ export declare class User {
      * @returns : the dust base asset amount (ie, < stepsize)
      * @returns : pnl from settle
      */
-    getPerpPositionWithLPSettle(marketIndex: number, originalPosition?: PerpPosition): [PerpPosition, BN, BN];
+    getPerpPositionWithLPSettle(marketIndex: number, originalPosition?: PerpPosition, burnLpShares?: boolean): [PerpPosition, BN, BN];
     /**
      * calculates Buying Power = free collateral / initial margin ratio
      * @returns : Precision QUOTE_PRECISION

package/lib/user.js

@@ -249,7 +249,7 @@ class User {
      * @returns : the dust base asset amount (ie, < stepsize)
      * @returns : pnl from settle
      */
-    getPerpPositionWithLPSettle(marketIndex, originalPosition) {
+    getPerpPositionWithLPSettle(marketIndex, originalPosition, burnLpShares = false) {
         var _a;
         originalPosition =
             (_a = originalPosition !== null && originalPosition !== void 0 ? originalPosition : this.getPerpPosition(marketIndex)) !== null && _a !== void 0 ? _a : this.getEmptyPosition(marketIndex);
@@ -259,6 +259,8 @@ class User {
         const position = this.getClonedPosition(originalPosition);
         const market = this.driftClient.getPerpMarketAccount(position.marketIndex);
         const nShares = position.lpShares;
+        // incorp unsettled funding on pre settled position
+        const quoteFundingPnl = (0, _1.calculatePositionFundingPNL)(market, position);
         const deltaBaa = market.amm.baseAssetAmountPerLp
             .sub(position.lastBaseAssetAmountPerLp)
             .mul(nShares)
@@ -284,6 +286,14 @@ class User {
                 position.baseAssetAmount.add(newStandardizedBaa);
             position.remainderBaseAssetAmount = newRemainderBaa.toNumber();
         }
+        let dustBaseAssetValue = numericConstants_1.ZERO;
+        if (burnLpShares && position.remainderBaseAssetAmount != 0) {
+            const oraclePriceData = this.driftClient.getOracleDataForPerpMarket(position.marketIndex);
+            dustBaseAssetValue = _1.BN.abs(position.remainderBaseAssetAmount)
+                .mul(oraclePriceData.price)
+                .div(numericConstants_1.AMM_RESERVE_PRECISION)
+                .add(numericConstants_1.ONE);
+        }
         let updateType;
         if (position.baseAssetAmount.eq(numericConstants_1.ZERO)) {
             updateType = 'open';
@@ -318,7 +328,25 @@ class User {
         }
         position.quoteEntryAmount = newQuoteEntry;
         position.baseAssetAmount = position.baseAssetAmount.add(standardizedBaa);
-        position.quoteAssetAmount = position.quoteAssetAmount.add(deltaQaa);
+        position.quoteAssetAmount = position.quoteAssetAmount
+            .add(deltaQaa)
+            .add(quoteFundingPnl)
+            .sub(dustBaseAssetValue);
+        position.quoteBreakEvenAmount = position.quoteBreakEvenAmount
+            .add(deltaQaa)
+            .add(quoteFundingPnl)
+            .sub(dustBaseAssetValue);
+        // update open bids/asks
+        const [marketOpenBids, marketOpenAsks] = (0, amm_1.calculateMarketOpenBidAsk)(market.amm.baseAssetReserve, market.amm.minBaseAssetReserve, market.amm.maxBaseAssetReserve, market.amm.orderStepSize);
+        const lpOpenBids = marketOpenBids
+            .mul(position.lpShares)
+            .div(market.amm.sqrtK);
+        const lpOpenAsks = marketOpenAsks
+            .mul(position.lpShares)
+            .div(market.amm.sqrtK);
+        position.openBids = lpOpenBids.add(position.openBids);
+        position.openAsks = lpOpenAsks.add(position.openAsks);
+        // eliminate counting funding on settled position
         if (position.baseAssetAmount.gt(numericConstants_1.ZERO)) {
             position.lastCumulativeFundingRate = market.amm.cumulativeFundingRateLong;
         }
@@ -336,7 +364,7 @@ class User {
      * @returns : Precision QUOTE_PRECISION
      */
     getPerpBuyingPower(marketIndex) {
-        const perpPosition = this.getPerpPosition(marketIndex);
+        const perpPosition = this.getPerpPositionWithLPSettle(marketIndex, undefined, true)[0];
         const worstCaseBaseAssetAmount = perpPosition
             ? (0, margin_1.calculateWorstCaseBaseAssetAmount)(perpPosition)
             : numericConstants_1.ZERO;
@@ -421,7 +449,7 @@ class User {
             const quoteSpotMarket = this.driftClient.getSpotMarketAccount(market.quoteSpotMarketIndex);
             const quoteOraclePriceData = this.getOracleDataForSpotMarket(market.quoteSpotMarketIndex);
             if (perpPosition.lpShares.gt(numericConstants_1.ZERO)) {
-                perpPosition = this.getPerpPositionWithLPSettle(perpPosition.marketIndex)[0];
+                perpPosition = this.getPerpPositionWithLPSettle(perpPosition.marketIndex, undefined, !!withWeightMarginCategory)[0];
             }
             let positionUnrealizedPnl = (0, _1.calculatePositionPNL)(market, perpPosition, withFunding, oraclePriceData);
             let quotePrice;
@@ -640,17 +668,8 @@ class User {
         return this.getActivePerpPositions().reduce((totalPerpValue, perpPosition) => {
             const market = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
             if (perpPosition.lpShares.gt(numericConstants_1.ZERO)) {
-                // is an lp
-                // clone so we dont mutate the position
-                perpPosition = this.getClonedPosition(perpPosition);
-                // settle position
-                const [settledPosition, dustBaa, _] = this.getPerpPositionWithLPSettle(market.marketIndex);
-                perpPosition.baseAssetAmount =
-                    settledPosition.baseAssetAmount.add(dustBaa);
-                perpPosition.quoteAssetAmount = settledPosition.quoteAssetAmount;
-                const [totalOpenBids, totalOpenAsks] = this.getPerpBidAsks(market.marketIndex);
-                perpPosition.openAsks = totalOpenAsks;
-                perpPosition.openBids = totalOpenBids;
+                // is an lp, clone so we dont mutate the position
+                perpPosition = this.getPerpPositionWithLPSettle(market.marketIndex, this.getClonedPosition(perpPosition), !!marginCategory)[0];
             }
             let valuationPrice = this.getOracleDataForPerpMarket(market.marketIndex).price;
             if ((0, types_1.isVariant)(market.status, 'settlement')) {
@@ -972,7 +991,7 @@ class User {
             .getPerpMarketAccounts()
             .find((market) => market.amm.oracle.equals(oracle));
         if (perpMarketWithSameOracle) {
-            const perpPosition = this.getPerpPosition(perpMarketWithSameOracle.marketIndex);
+            const perpPosition = this.getPerpPositionWithLPSettle(perpMarketWithSameOracle.marketIndex, undefined, true)[0];
             if (perpPosition) {
                 const freeCollateralDeltaForPerp = this.calculateFreeCollateralDeltaForPerp(perpMarketWithSameOracle, perpPosition, numericConstants_1.ZERO);
                 freeCollateralDelta = freeCollateralDelta.add(freeCollateralDeltaForPerp || numericConstants_1.ZERO);
@@ -1002,7 +1021,8 @@ class User {
         const maintenanceMarginRequirement = this.getMaintenanceMarginRequirement();
         const freeCollateral = _1.BN.max(numericConstants_1.ZERO, totalCollateral.sub(maintenanceMarginRequirement));
         const market = this.driftClient.getPerpMarketAccount(marketIndex);
-        const currentPerpPosition = this.getPerpPosition(marketIndex) || this.getEmptyPosition(marketIndex);
+        const currentPerpPosition = this.getPerpPositionWithLPSettle(marketIndex, undefined, true)[0] ||
+            this.getEmptyPosition(marketIndex);
         let freeCollateralDelta = this.calculateFreeCollateralDeltaForPerp(market, currentPerpPosition, positionBaseSizeChange);
         if (!freeCollateralDelta) {
             return new _1.BN(-1);
@@ -1087,8 +1107,7 @@ class User {
      * @returns : Precision PRICE_PRECISION
      */
     liquidationPriceAfterClose(positionMarketIndex, closeQuoteAmount) {
-        const currentPosition = this.getPerpPosition(positionMarketIndex) ||
-            this.getEmptyPosition(positionMarketIndex);
+        const currentPosition = this.getPerpPositionWithLPSettle(positionMarketIndex, undefined, true)[0] || this.getEmptyPosition(positionMarketIndex);
         const closeBaseAmount = currentPosition.baseAssetAmount
             .mul(closeQuoteAmount)
             .div(currentPosition.quoteAssetAmount.abs())
@@ -1120,7 +1139,7 @@ class User {
      * @returns tradeSizeAllowed : Precision QUOTE_PRECISION
      */
     getMaxTradeSizeUSDCForPerp(targetMarketIndex, tradeSide) {
-        const currentPosition = this.getPerpPosition(targetMarketIndex) ||
+        const currentPosition = this.getPerpPositionWithLPSettle(targetMarketIndex, undefined, true)[0] ||
             this.getEmptyPosition(targetMarketIndex);
         const targetSide = (0, types_1.isVariant)(tradeSide, 'short') ? 'short' : 'long';
         const currentPositionSide = (currentPosition === null || currentPosition === void 0 ? void 0 : currentPosition.baseAssetAmount.isNeg())
@@ -1478,7 +1497,7 @@ class User {
                 .div(netAssetValueAfterTrade);
             return newLeverage;
         }
-        const currentPosition = this.getPerpPosition(targetMarketIndex) ||
+        const currentPosition = this.getPerpPositionWithLPSettle(targetMarketIndex)[0] ||
             this.getEmptyPosition(targetMarketIndex);
         const oracleData = this.getOracleDataForPerpMarket(targetMarketIndex);
         let currentPositionQuoteAmount = this.getPerpPositionValue(targetMarketIndex, oracleData, includeOpenOrders);
@@ -1656,8 +1675,7 @@ class User {
      * @returns positionValue : Precision QUOTE_PRECISION
      */
     getTotalPerpPositionValueExcludingMarket(marketToIgnore, marginCategory, liquidationBuffer, includeOpenOrders) {
-        const currentPerpPosition = this.getPerpPosition(marketToIgnore) ||
-            this.getEmptyPosition(marketToIgnore);
+        const currentPerpPosition = this.getPerpPositionWithLPSettle(marketToIgnore, undefined, !!marginCategory)[0] || this.getEmptyPosition(marketToIgnore);
         const oracleData = this.getOracleDataForPerpMarket(marketToIgnore);
         let currentPerpPositionValueUSDC = numericConstants_1.ZERO;
         if (currentPerpPosition) {

package/package.json

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

package/src/math/position.ts

@@ -162,7 +162,7 @@ export function calculateClaimablePnl(
  *
  * @param market
  * @param PerpPosition
- * @returns // TODO-PRECISION
+ * @returns // QUOTE_PRECISION
  */
 export function calculatePositionFundingPNL(
 	market: PerpMarketAccount,

package/src/user.ts

@@ -413,7 +413,8 @@ export class User {
 	 */
 	public getPerpPositionWithLPSettle(
 		marketIndex: number,
-		originalPosition?: PerpPosition
+		originalPosition?: PerpPosition,
+		burnLpShares = false
 	): [PerpPosition, BN, BN] {
 		originalPosition =
 			originalPosition ??
@@ -429,6 +430,9 @@ export class User {
 		const market = this.driftClient.getPerpMarketAccount(position.marketIndex);
 		const nShares = position.lpShares;
 
+		// incorp unsettled funding on pre settled position
+		const quoteFundingPnl = calculatePositionFundingPNL(market, position);
+
 		const deltaBaa = market.amm.baseAssetAmountPerLp
 			.sub(position.lastBaseAssetAmountPerLp)
 			.mul(nShares)
@@ -468,6 +472,17 @@ export class User {
 			position.remainderBaseAssetAmount = newRemainderBaa.toNumber();
 		}
 
+		let dustBaseAssetValue = ZERO;
+		if (burnLpShares && position.remainderBaseAssetAmount != 0) {
+			const oraclePriceData = this.driftClient.getOracleDataForPerpMarket(
+				position.marketIndex
+			);
+			dustBaseAssetValue = BN.abs(position.remainderBaseAssetAmount)
+				.mul(oraclePriceData.price)
+				.div(AMM_RESERVE_PRECISION)
+				.add(ONE);
+		}
+
 		let updateType;
 		if (position.baseAssetAmount.eq(ZERO)) {
 			updateType = 'open';
@@ -501,8 +516,32 @@ export class User {
 		}
 		position.quoteEntryAmount = newQuoteEntry;
 		position.baseAssetAmount = position.baseAssetAmount.add(standardizedBaa);
-		position.quoteAssetAmount = position.quoteAssetAmount.add(deltaQaa);
+		position.quoteAssetAmount = position.quoteAssetAmount
+			.add(deltaQaa)
+			.add(quoteFundingPnl)
+			.sub(dustBaseAssetValue);
+		position.quoteBreakEvenAmount = position.quoteBreakEvenAmount
+			.add(deltaQaa)
+			.add(quoteFundingPnl)
+			.sub(dustBaseAssetValue);
+
+		// update open bids/asks
+		const [marketOpenBids, marketOpenAsks] = calculateMarketOpenBidAsk(
+			market.amm.baseAssetReserve,
+			market.amm.minBaseAssetReserve,
+			market.amm.maxBaseAssetReserve,
+			market.amm.orderStepSize
+		);
+		const lpOpenBids = marketOpenBids
+			.mul(position.lpShares)
+			.div(market.amm.sqrtK);
+		const lpOpenAsks = marketOpenAsks
+			.mul(position.lpShares)
+			.div(market.amm.sqrtK);
+		position.openBids = lpOpenBids.add(position.openBids);
+		position.openAsks = lpOpenAsks.add(position.openAsks);
 
+		// eliminate counting funding on settled position
 		if (position.baseAssetAmount.gt(ZERO)) {
 			position.lastCumulativeFundingRate = market.amm.cumulativeFundingRateLong;
 		} else if (position.baseAssetAmount.lt(ZERO)) {
@@ -520,7 +559,11 @@ export class User {
 	 * @returns : Precision QUOTE_PRECISION
 	 */
 	public getPerpBuyingPower(marketIndex: number): BN {
-		const perpPosition = this.getPerpPosition(marketIndex);
+		const perpPosition = this.getPerpPositionWithLPSettle(
+			marketIndex,
+			undefined,
+			true
+		)[0];
 		const worstCaseBaseAssetAmount = perpPosition
 			? calculateWorstCaseBaseAssetAmount(perpPosition)
 			: ZERO;
@@ -676,7 +719,9 @@ export class User {
 
 				if (perpPosition.lpShares.gt(ZERO)) {
 					perpPosition = this.getPerpPositionWithLPSettle(
-						perpPosition.marketIndex
+						perpPosition.marketIndex,
+						undefined,
+						!!withWeightMarginCategory
 					)[0];
 				}
 
@@ -1168,23 +1213,12 @@ export class User {
 				);
 
 				if (perpPosition.lpShares.gt(ZERO)) {
-					// is an lp
-					// clone so we dont mutate the position
-					perpPosition = this.getClonedPosition(perpPosition);
-
-					// settle position
-					const [settledPosition, dustBaa, _] =
-						this.getPerpPositionWithLPSettle(market.marketIndex);
-					perpPosition.baseAssetAmount =
-						settledPosition.baseAssetAmount.add(dustBaa);
-					perpPosition.quoteAssetAmount = settledPosition.quoteAssetAmount;
-
-					const [totalOpenBids, totalOpenAsks] = this.getPerpBidAsks(
-						market.marketIndex
-					);
-
-					perpPosition.openAsks = totalOpenAsks;
-					perpPosition.openBids = totalOpenBids;
+					// is an lp, clone so we dont mutate the position
+					perpPosition = this.getPerpPositionWithLPSettle(
+						market.marketIndex,
+						this.getClonedPosition(perpPosition),
+						!!marginCategory
+					)[0];
 				}
 
 				let valuationPrice = this.getOracleDataForPerpMarket(
@@ -1757,9 +1791,11 @@ export class User {
 			.getPerpMarketAccounts()
 			.find((market) => market.amm.oracle.equals(oracle));
 		if (perpMarketWithSameOracle) {
-			const perpPosition = this.getPerpPosition(
-				perpMarketWithSameOracle.marketIndex
-			);
+			const perpPosition = this.getPerpPositionWithLPSettle(
+				perpMarketWithSameOracle.marketIndex,
+				undefined,
+				true
+			)[0];
 			if (perpPosition) {
 				const freeCollateralDeltaForPerp =
 					this.calculateFreeCollateralDeltaForPerp(
@@ -1812,7 +1848,8 @@ export class User {
 
 		const market = this.driftClient.getPerpMarketAccount(marketIndex);
 		const currentPerpPosition =
-			this.getPerpPosition(marketIndex) || this.getEmptyPosition(marketIndex);
+			this.getPerpPositionWithLPSettle(marketIndex, undefined, true)[0] ||
+			this.getEmptyPosition(marketIndex);
 
 		let freeCollateralDelta = this.calculateFreeCollateralDeltaForPerp(
 			market,
@@ -1967,8 +2004,11 @@ export class User {
 		closeQuoteAmount: BN
 	): BN {
 		const currentPosition =
-			this.getPerpPosition(positionMarketIndex) ||
-			this.getEmptyPosition(positionMarketIndex);
+			this.getPerpPositionWithLPSettle(
+				positionMarketIndex,
+				undefined,
+				true
+			)[0] || this.getEmptyPosition(positionMarketIndex);
 
 		const closeBaseAmount = currentPosition.baseAssetAmount
 			.mul(closeQuoteAmount)
@@ -2009,7 +2049,7 @@ export class User {
 		tradeSide: PositionDirection
 	): BN {
 		const currentPosition =
-			this.getPerpPosition(targetMarketIndex) ||
+			this.getPerpPositionWithLPSettle(targetMarketIndex, undefined, true)[0] ||
 			this.getEmptyPosition(targetMarketIndex);
 
 		const targetSide = isVariant(tradeSide, 'short') ? 'short' : 'long';
@@ -2703,7 +2743,7 @@ export class User {
 		}
 
 		const currentPosition =
-			this.getPerpPosition(targetMarketIndex) ||
+			this.getPerpPositionWithLPSettle(targetMarketIndex)[0] ||
 			this.getEmptyPosition(targetMarketIndex);
 
 		const oracleData = this.getOracleDataForPerpMarket(targetMarketIndex);
@@ -2989,8 +3029,11 @@ export class User {
 		includeOpenOrders?: boolean
 	): BN {
 		const currentPerpPosition =
-			this.getPerpPosition(marketToIgnore) ||
-			this.getEmptyPosition(marketToIgnore);
+			this.getPerpPositionWithLPSettle(
+				marketToIgnore,
+				undefined,
+				!!marginCategory
+			)[0] || this.getEmptyPosition(marketToIgnore);
 
 		const oracleData = this.getOracleDataForPerpMarket(marketToIgnore);