@drift-labs/sdk 2.97.0-beta.34 → 2.97.0-beta.35

package/VERSION

@@ -1 +1 @@
-2.97.0-beta.34
+2.97.0-beta.35

package/lib/browser/math/position.d.ts

@@ -23,11 +23,27 @@ export declare function calculateBaseAssetValue(market: PerpMarketAccount, userP
 export declare function calculatePositionPNL(market: PerpMarketAccount, perpPosition: PerpPosition, withFunding: boolean, oraclePriceData: OraclePriceData): BN;
 export declare function calculateClaimablePnl(market: PerpMarketAccount, spotMarket: SpotMarketAccount, perpPosition: PerpPosition, oraclePriceData: OraclePriceData): BN;
 /**
+ * Returns total fees and funding pnl for a position
+ *
+ * @param market
+ * @param PerpPosition
+ * @param includeUnsettled include unsettled funding in return value (default: true)
+ * @returns — // QUOTE_PRECISION
+ */
+export declare function calculateFeesAndFundingPnl(market: PerpMarketAccount, perpPosition: PerpPosition, includeUnsettled?: boolean): BN;
+/**
+ * Returns unsettled funding pnl for the position
+ *
+ * To calculate all fees and funding pnl including settled, use calculateFeesAndFundingPnl
  *
  * @param market
  * @param PerpPosition
  * @returns // QUOTE_PRECISION
  */
+export declare function calculateUnsettledFundingPnl(market: PerpMarketAccount, perpPosition: PerpPosition): BN;
+/**
+ * @deprecated use calculateUnsettledFundingPnl or calculateFeesAndFundingPnl instead
+ */
 export declare function calculatePositionFundingPNL(market: PerpMarketAccount, perpPosition: PerpPosition): BN;
 export declare function positionIsAvailable(position: PerpPosition): boolean;
 /**

package/lib/browser/math/position.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasOpenOrders = exports.isEmptyPosition = exports.positionCurrentDirection = exports.findDirectionToClose = exports.calculateCostBasis = exports.calculateEntryPrice = exports.calculateBreakEvenPrice = exports.positionIsAvailable = exports.calculatePositionFundingPNL = exports.calculateClaimablePnl = exports.calculatePositionPNL = exports.calculateBaseAssetValue = void 0;
+exports.hasOpenOrders = exports.isEmptyPosition = exports.positionCurrentDirection = exports.findDirectionToClose = exports.calculateCostBasis = exports.calculateEntryPrice = exports.calculateBreakEvenPrice = exports.positionIsAvailable = exports.calculatePositionFundingPNL = exports.calculateUnsettledFundingPnl = exports.calculateFeesAndFundingPnl = exports.calculateClaimablePnl = exports.calculatePositionPNL = exports.calculateBaseAssetValue = void 0;
 const __1 = require("../");
 const numericConstants_1 = require("../constants/numericConstants");
 const types_1 = require("../types");
@@ -75,7 +75,7 @@ function calculatePositionPNL(market, perpPosition, withFunding = false, oracleP
         .mul(baseAssetValueSign)
         .add(perpPosition.quoteAssetAmount);
     if (withFunding) {
-        const fundingRatePnL = calculatePositionFundingPNL(market, perpPosition);
+        const fundingRatePnL = calculateUnsettledFundingPnl(market, perpPosition);
         pnl = pnl.add(fundingRatePnL);
     }
     return pnl;
@@ -93,12 +93,32 @@ function calculateClaimablePnl(market, spotMarket, perpPosition, oraclePriceData
 }
 exports.calculateClaimablePnl = calculateClaimablePnl;
 /**
+ * Returns total fees and funding pnl for a position
+ *
+ * @param market
+ * @param PerpPosition
+ * @param includeUnsettled include unsettled funding in return value (default: true)
+ * @returns — // QUOTE_PRECISION
+ */
+function calculateFeesAndFundingPnl(market, perpPosition, includeUnsettled = true) {
+    const settledFundingAndFeesPnl = perpPosition.quoteBreakEvenAmount.sub(perpPosition.quoteEntryAmount);
+    if (!includeUnsettled) {
+        return settledFundingAndFeesPnl;
+    }
+    const unsettledFundingPnl = calculateUnsettledFundingPnl(market, perpPosition);
+    return settledFundingAndFeesPnl.add(unsettledFundingPnl);
+}
+exports.calculateFeesAndFundingPnl = calculateFeesAndFundingPnl;
+/**
+ * Returns unsettled funding pnl for the position
+ *
+ * To calculate all fees and funding pnl including settled, use calculateFeesAndFundingPnl
  *
  * @param market
  * @param PerpPosition
  * @returns // QUOTE_PRECISION
  */
-function calculatePositionFundingPNL(market, perpPosition) {
+function calculateUnsettledFundingPnl(market, perpPosition) {
     if (perpPosition.baseAssetAmount.eq(numericConstants_1.ZERO)) {
         return numericConstants_1.ZERO;
     }
@@ -117,6 +137,13 @@ function calculatePositionFundingPNL(market, perpPosition) {
         .mul(new __1.BN(-1));
     return perPositionFundingRate;
 }
+exports.calculateUnsettledFundingPnl = calculateUnsettledFundingPnl;
+/**
+ * @deprecated use calculateUnsettledFundingPnl or calculateFeesAndFundingPnl instead
+ */
+function calculatePositionFundingPNL(market, perpPosition) {
+    return calculateUnsettledFundingPnl(market, perpPosition);
+}
 exports.calculatePositionFundingPNL = calculatePositionFundingPNL;
 function positionIsAvailable(position) {
     return (position.baseAssetAmount.eq(numericConstants_1.ZERO) &&

package/lib/browser/user.js

@@ -289,7 +289,7 @@ class User {
         }
         const nShares = position.lpShares;
         // incorp unsettled funding on pre settled position
-        const quoteFundingPnl = (0, _1.calculatePositionFundingPNL)(market, position);
+        const quoteFundingPnl = (0, position_1.calculateUnsettledFundingPnl)(market, position);
         let baseUnit = numericConstants_1.AMM_RESERVE_PRECISION;
         if (market.amm.perLpBase == position.perLpBase) {
             if (position.perLpBase >= 0 &&
@@ -546,7 +546,7 @@ class User {
             .perpPositions.filter((pos) => marketIndex !== undefined ? pos.marketIndex === marketIndex : true)
             .reduce((pnl, perpPosition) => {
             const market = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
-            return pnl.add((0, _1.calculatePositionFundingPNL)(market, perpPosition));
+            return pnl.add((0, position_1.calculateUnsettledFundingPnl)(market, perpPosition));
         }, numericConstants_1.ZERO);
     }
     getFuelBonus(now, includeSettled = true, includeUnsettled = true) {

package/lib/node/math/position.d.ts

@@ -23,11 +23,27 @@ export declare function calculateBaseAssetValue(market: PerpMarketAccount, userP
 export declare function calculatePositionPNL(market: PerpMarketAccount, perpPosition: PerpPosition, withFunding: boolean, oraclePriceData: OraclePriceData): BN;
 export declare function calculateClaimablePnl(market: PerpMarketAccount, spotMarket: SpotMarketAccount, perpPosition: PerpPosition, oraclePriceData: OraclePriceData): BN;
 /**
+ * Returns total fees and funding pnl for a position
+ *
+ * @param market
+ * @param PerpPosition
+ * @param includeUnsettled include unsettled funding in return value (default: true)
+ * @returns — // QUOTE_PRECISION
+ */
+export declare function calculateFeesAndFundingPnl(market: PerpMarketAccount, perpPosition: PerpPosition, includeUnsettled?: boolean): BN;
+/**
+ * Returns unsettled funding pnl for the position
+ *
+ * To calculate all fees and funding pnl including settled, use calculateFeesAndFundingPnl
  *
  * @param market
  * @param PerpPosition
  * @returns // QUOTE_PRECISION
  */
+export declare function calculateUnsettledFundingPnl(market: PerpMarketAccount, perpPosition: PerpPosition): BN;
+/**
+ * @deprecated use calculateUnsettledFundingPnl or calculateFeesAndFundingPnl instead
+ */
 export declare function calculatePositionFundingPNL(market: PerpMarketAccount, perpPosition: PerpPosition): BN;
 export declare function positionIsAvailable(position: PerpPosition): boolean;
 /**

package/lib/node/math/position.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasOpenOrders = exports.isEmptyPosition = exports.positionCurrentDirection = exports.findDirectionToClose = exports.calculateCostBasis = exports.calculateEntryPrice = exports.calculateBreakEvenPrice = exports.positionIsAvailable = exports.calculatePositionFundingPNL = exports.calculateClaimablePnl = exports.calculatePositionPNL = exports.calculateBaseAssetValue = void 0;
+exports.hasOpenOrders = exports.isEmptyPosition = exports.positionCurrentDirection = exports.findDirectionToClose = exports.calculateCostBasis = exports.calculateEntryPrice = exports.calculateBreakEvenPrice = exports.positionIsAvailable = exports.calculatePositionFundingPNL = exports.calculateUnsettledFundingPnl = exports.calculateFeesAndFundingPnl = exports.calculateClaimablePnl = exports.calculatePositionPNL = exports.calculateBaseAssetValue = void 0;
 const __1 = require("../");
 const numericConstants_1 = require("../constants/numericConstants");
 const types_1 = require("../types");
@@ -75,7 +75,7 @@ function calculatePositionPNL(market, perpPosition, withFunding = false, oracleP
         .mul(baseAssetValueSign)
         .add(perpPosition.quoteAssetAmount);
     if (withFunding) {
-        const fundingRatePnL = calculatePositionFundingPNL(market, perpPosition);
+        const fundingRatePnL = calculateUnsettledFundingPnl(market, perpPosition);
         pnl = pnl.add(fundingRatePnL);
     }
     return pnl;
@@ -93,12 +93,32 @@ function calculateClaimablePnl(market, spotMarket, perpPosition, oraclePriceData
 }
 exports.calculateClaimablePnl = calculateClaimablePnl;
 /**
+ * Returns total fees and funding pnl for a position
+ *
+ * @param market
+ * @param PerpPosition
+ * @param includeUnsettled include unsettled funding in return value (default: true)
+ * @returns — // QUOTE_PRECISION
+ */
+function calculateFeesAndFundingPnl(market, perpPosition, includeUnsettled = true) {
+    const settledFundingAndFeesPnl = perpPosition.quoteBreakEvenAmount.sub(perpPosition.quoteEntryAmount);
+    if (!includeUnsettled) {
+        return settledFundingAndFeesPnl;
+    }
+    const unsettledFundingPnl = calculateUnsettledFundingPnl(market, perpPosition);
+    return settledFundingAndFeesPnl.add(unsettledFundingPnl);
+}
+exports.calculateFeesAndFundingPnl = calculateFeesAndFundingPnl;
+/**
+ * Returns unsettled funding pnl for the position
+ *
+ * To calculate all fees and funding pnl including settled, use calculateFeesAndFundingPnl
  *
  * @param market
  * @param PerpPosition
  * @returns // QUOTE_PRECISION
  */
-function calculatePositionFundingPNL(market, perpPosition) {
+function calculateUnsettledFundingPnl(market, perpPosition) {
     if (perpPosition.baseAssetAmount.eq(numericConstants_1.ZERO)) {
         return numericConstants_1.ZERO;
     }
@@ -117,6 +137,13 @@ function calculatePositionFundingPNL(market, perpPosition) {
         .mul(new __1.BN(-1));
     return perPositionFundingRate;
 }
+exports.calculateUnsettledFundingPnl = calculateUnsettledFundingPnl;
+/**
+ * @deprecated use calculateUnsettledFundingPnl or calculateFeesAndFundingPnl instead
+ */
+function calculatePositionFundingPNL(market, perpPosition) {
+    return calculateUnsettledFundingPnl(market, perpPosition);
+}
 exports.calculatePositionFundingPNL = calculatePositionFundingPNL;
 function positionIsAvailable(position) {
     return (position.baseAssetAmount.eq(numericConstants_1.ZERO) &&

package/lib/node/user.js

@@ -289,7 +289,7 @@ class User {
         }
         const nShares = position.lpShares;
         // incorp unsettled funding on pre settled position
-        const quoteFundingPnl = (0, _1.calculatePositionFundingPNL)(market, position);
+        const quoteFundingPnl = (0, position_1.calculateUnsettledFundingPnl)(market, position);
         let baseUnit = numericConstants_1.AMM_RESERVE_PRECISION;
         if (market.amm.perLpBase == position.perLpBase) {
             if (position.perLpBase >= 0 &&
@@ -546,7 +546,7 @@ class User {
             .perpPositions.filter((pos) => marketIndex !== undefined ? pos.marketIndex === marketIndex : true)
             .reduce((pnl, perpPosition) => {
             const market = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
-            return pnl.add((0, _1.calculatePositionFundingPNL)(market, perpPosition));
+            return pnl.add((0, position_1.calculateUnsettledFundingPnl)(market, perpPosition));
         }, numericConstants_1.ZERO);
     }
     getFuelBonus(now, includeSettled = true, includeUnsettled = true) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@drift-labs/sdk",
-	"version": "2.97.0-beta.34",
+	"version": "2.97.0-beta.35",
 	"main": "lib/node/index.js",
 	"types": "lib/node/index.d.ts",
 	"browser": "./lib/browser/index.js",

package/src/math/position.ts

@@ -118,7 +118,7 @@ export function calculatePositionPNL(
 		.add(perpPosition.quoteAssetAmount);
 
 	if (withFunding) {
-		const fundingRatePnL = calculatePositionFundingPNL(market, perpPosition);
+		const fundingRatePnL = calculateUnsettledFundingPnl(market, perpPosition);
 
 		pnl = pnl.add(fundingRatePnL);
 	}
@@ -159,12 +159,44 @@ export function calculateClaimablePnl(
 }
 
 /**
+ * Returns total fees and funding pnl for a position
+ *
+ * @param market
+ * @param PerpPosition
+ * @param includeUnsettled include unsettled funding in return value (default: true)
+ * @returns — // QUOTE_PRECISION
+ */
+export function calculateFeesAndFundingPnl(
+	market: PerpMarketAccount,
+	perpPosition: PerpPosition,
+	includeUnsettled = true
+): BN {
+	const settledFundingAndFeesPnl = perpPosition.quoteBreakEvenAmount.sub(
+		perpPosition.quoteEntryAmount
+	);
+
+	if (!includeUnsettled) {
+		return settledFundingAndFeesPnl;
+	}
+
+	const unsettledFundingPnl = calculateUnsettledFundingPnl(
+		market,
+		perpPosition
+	);
+
+	return settledFundingAndFeesPnl.add(unsettledFundingPnl);
+}
+
+/**
+ * Returns unsettled funding pnl for the position
+ *
+ * To calculate all fees and funding pnl including settled, use calculateFeesAndFundingPnl
  *
  * @param market
  * @param PerpPosition
  * @returns // QUOTE_PRECISION
  */
-export function calculatePositionFundingPNL(
+export function calculateUnsettledFundingPnl(
 	market: PerpMarketAccount,
 	perpPosition: PerpPosition
 ): BN {
@@ -189,6 +221,16 @@ export function calculatePositionFundingPNL(
 	return perPositionFundingRate;
 }
 
+/**
+ * @deprecated use calculateUnsettledFundingPnl or calculateFeesAndFundingPnl instead
+ */
+export function calculatePositionFundingPNL(
+	market: PerpMarketAccount,
+	perpPosition: PerpPosition
+): BN {
+	return calculateUnsettledFundingPnl(market, perpPosition);
+}
+
 export function positionIsAvailable(position: PerpPosition): boolean {
 	return (
 		position.baseAssetAmount.eq(ZERO) &&

package/src/user.ts

@@ -15,7 +15,11 @@ import {
 	UserStatus,
 	UserStatsAccount,
 } from './types';
-import { calculateEntryPrice, positionIsAvailable } from './math/position';
+import {
+	calculateEntryPrice,
+	calculateUnsettledFundingPnl,
+	positionIsAvailable,
+} from './math/position';
 import {
 	AMM_RESERVE_PRECISION,
 	AMM_RESERVE_PRECISION_EXP,
@@ -50,7 +54,6 @@ import {
 	calculateBaseAssetValue,
 	calculateMarketMarginRatio,
 	calculatePerpLiabilityValue,
-	calculatePositionFundingPNL,
 	calculatePositionPNL,
 	calculateReservePrice,
 	calculateSpotMarketMarginRatio,
@@ -495,7 +498,7 @@ export class User {
 		const nShares = position.lpShares;
 
 		// incorp unsettled funding on pre settled position
-		const quoteFundingPnl = calculatePositionFundingPNL(market, position);
+		const quoteFundingPnl = calculateUnsettledFundingPnl(market, position);
 
 		let baseUnit = AMM_RESERVE_PRECISION;
 		if (market.amm.perLpBase == position.perLpBase) {
@@ -901,7 +904,7 @@ export class User {
 				const market = this.driftClient.getPerpMarketAccount(
 					perpPosition.marketIndex
 				);
-				return pnl.add(calculatePositionFundingPNL(market, perpPosition));
+				return pnl.add(calculateUnsettledFundingPnl(market, perpPosition));
 			}, ZERO);
 	}