@drift-labs/sdk 2.36.1-beta.4 → 2.36.1-beta.5

package/VERSION

@@ -1 +1 @@
-2.36.1-beta.4
+2.36.1-beta.5

package/lib/user.d.ts

@@ -188,6 +188,12 @@ export declare class User {
     };
     getTotalLiabilityValue(marginCategory?: MarginCategory): BN;
     getTotalAssetValue(marginCategory?: MarginCategory): BN;
+    /**
+     * Calculates the all time P&L of the user.
+     *
+     * Net withdraws + Net spot market value + Net unrealized P&L -
+     */
+    getTotalAllTimePnl(): BN;
     /**
      * calculates max allowable leverage exceeding hitting requirement category
      * for large sizes where imf factor activates, result is a lower bound

package/lib/user.js

@@ -815,6 +815,20 @@ class User {
     getTotalAssetValue(marginCategory) {
         return this.getSpotMarketAssetValue(undefined, marginCategory, true).add(this.getUnrealizedPNL(true, undefined, marginCategory));
     }
+    /**
+     * Calculates the all time P&L of the user.
+     *
+     * Net withdraws + Net spot market value + Net unrealized P&L -
+     */
+    getTotalAllTimePnl() {
+        const netBankValue = this.getNetSpotMarketValue();
+        const unrealizedPnl = this.getUnrealizedPNL(true, undefined, undefined);
+        const netUsdValue = netBankValue.add(unrealizedPnl);
+        const totalDeposits = this.getUserAccount().totalDeposits;
+        const totalWithdraws = this.getUserAccount().totalWithdraws;
+        const totalPnl = netUsdValue.add(totalWithdraws).sub(totalDeposits);
+        return totalPnl;
+    }
     /**
      * calculates max allowable leverage exceeding hitting requirement category
      * for large sizes where imf factor activates, result is a lower bound

package/package.json

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

package/src/user.ts

@@ -1487,6 +1487,24 @@ export class User {
 		);
 	}
 
+	/**
+	 * Calculates the all time P&L of the user.
+	 *
+	 * Net withdraws + Net spot market value + Net unrealized P&L -
+	 */
+	getTotalAllTimePnl(): BN {
+		const netBankValue = this.getNetSpotMarketValue();
+		const unrealizedPnl = this.getUnrealizedPNL(true, undefined, undefined);
+
+		const netUsdValue = netBankValue.add(unrealizedPnl);
+		const totalDeposits = this.getUserAccount().totalDeposits;
+		const totalWithdraws = this.getUserAccount().totalWithdraws;
+
+		const totalPnl = netUsdValue.add(totalWithdraws).sub(totalDeposits);
+
+		return totalPnl;
+	}
+
 	/**
 	 * calculates max allowable leverage exceeding hitting requirement category
 	 * for large sizes where imf factor activates, result is a lower bound