@drift-labs/sdk 2.31.1-beta.3 → 2.31.1-beta.5

package/VERSION

@@ -1 +1 @@
-2.31.1-beta.3
+2.31.1-beta.5

package/lib/idl/drift.json

@@ -1,5 +1,5 @@
 {
-    "version": "2.31.1-beta.2",
+    "version": "2.31.1-beta.4",
     "name": "drift",
     "instructions": [
         {

package/lib/math/tiers.d.ts

@@ -0,0 +1,4 @@
+import { PerpMarketAccount, SpotMarketAccount } from '../types';
+export declare function getPerpMarketTierNumber(perpMarket: PerpMarketAccount): number;
+export declare function getSpotMarketTierNumber(spotMarket: SpotMarketAccount): number;
+export declare function perpTierIsAsSafeAs(perpTier: number, otherPerpTier: number, otherSpotTier: number): boolean;

package/lib/math/tiers.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.perpTierIsAsSafeAs = exports.getSpotMarketTierNumber = exports.getPerpMarketTierNumber = void 0;
+const types_1 = require("../types");
+function getPerpMarketTierNumber(perpMarket) {
+    if ((0, types_1.isVariant)(perpMarket.contractTier, 'a')) {
+        return 0;
+    }
+    else if ((0, types_1.isVariant)(perpMarket.contractTier, 'b')) {
+        return 1;
+    }
+    else if ((0, types_1.isVariant)(perpMarket.contractTier, 'c')) {
+        return 2;
+    }
+    else if ((0, types_1.isVariant)(perpMarket.contractTier, 'speculative')) {
+        return 3;
+    }
+    else if ((0, types_1.isVariant)(perpMarket.contractTier, 'isolated')) {
+        return 4;
+    }
+    else {
+        return 5;
+    }
+}
+exports.getPerpMarketTierNumber = getPerpMarketTierNumber;
+function getSpotMarketTierNumber(spotMarket) {
+    if ((0, types_1.isVariant)(spotMarket.assetTier, 'collateral')) {
+        return 0;
+    }
+    else if ((0, types_1.isVariant)(spotMarket.assetTier, 'protected')) {
+        return 1;
+    }
+    else if ((0, types_1.isVariant)(spotMarket.assetTier, 'cross')) {
+        return 2;
+    }
+    else if ((0, types_1.isVariant)(spotMarket.assetTier, 'isolated')) {
+        return 3;
+    }
+    else if ((0, types_1.isVariant)(spotMarket.assetTier, 'unlisted')) {
+        return 4;
+    }
+    else {
+        return 5;
+    }
+}
+exports.getSpotMarketTierNumber = getSpotMarketTierNumber;
+function perpTierIsAsSafeAs(perpTier, otherPerpTier, otherSpotTier) {
+    const asSafeAsPerp = perpTier <= otherPerpTier;
+    const asSafeAsSpot = otherSpotTier === 4 || (otherSpotTier >= 2 && perpTier <= 2);
+    return asSafeAsSpot && asSafeAsPerp;
+}
+exports.perpTierIsAsSafeAs = perpTierIsAsSafeAs;

package/lib/user.d.ts

@@ -107,6 +107,7 @@ export declare class User {
      */
     getMaintenanceMarginRequirement(liquidationBuffer?: BN): BN;
     getActivePerpPositions(): PerpPosition[];
+    getActiveSpotPositions(): SpotPosition[];
     /**
      * calculates unrealized position price pnl
      * @returns : Precision QUOTE_PRECISION
@@ -185,7 +186,11 @@ export declare class User {
      * @returns : Precision TEN_THOUSAND
      */
     getMarginRatio(): BN;
-    canBeLiquidated(): boolean;
+    canBeLiquidated(): {
+        canBeLiquidated: boolean;
+        marginRequirement: BN;
+        totalCollateral: BN;
+    };
     isBeingLiquidated(): boolean;
     isBankrupt(): boolean;
     /**
@@ -277,6 +282,10 @@ export declare class User {
         maxDepositAmount: BN;
     };
     canMakeIdle(slot: BN, slotsBeforeIdle: BN): boolean;
+    getSafestTiers(): {
+        perpTier: number;
+        spotTier: number;
+    };
     /**
      * Get the total position value, excluding any position coming from the given target market
      * @param marketToIgnore

package/lib/user.js

@@ -12,6 +12,7 @@ const pollingUserAccountSubscriber_1 = require("./accounts/pollingUserAccountSub
 const webSocketUserAccountSubscriber_1 = require("./accounts/webSocketUserAccountSubscriber");
 const spotPosition_1 = require("./math/spotPosition");
 const oracles_1 = require("./math/oracles");
+const tiers_1 = require("./math/tiers");
 class User {
     get isSubscribed() {
         return this._isSubscribed && this.accountSubscriber.isSubscribed;
@@ -308,6 +309,9 @@ class User {
             !(pos.openOrders == 0) ||
             !pos.lpShares.eq(numericConstants_1.ZERO));
     }
+    getActiveSpotPositions() {
+        return this.getUserAccount().spotPositions.filter((pos) => !(0, spotPosition_1.isSpotPositionAvailable)(pos));
+    }
     /**
      * calculates unrealized position price pnl
      * @returns : Precision QUOTE_PRECISION
@@ -778,12 +782,16 @@ class User {
         const totalCollateral = this.getTotalCollateral('Maintenance');
         // if user being liq'd, can continue to be liq'd until total collateral above the margin requirement plus buffer
         let liquidationBuffer = undefined;
-        const isBeingLiquidated = (0, types_1.isVariant)(this.getUserAccount().status, 'beingLiquidated');
-        if (isBeingLiquidated) {
+        if (this.isBeingLiquidated()) {
             liquidationBuffer = new _1.BN(this.driftClient.getStateAccount().liquidationMarginBufferRatio);
         }
-        const maintenanceRequirement = this.getMaintenanceMarginRequirement(liquidationBuffer);
-        return totalCollateral.lt(maintenanceRequirement);
+        const marginRequirement = this.getMaintenanceMarginRequirement(liquidationBuffer);
+        const canBeLiquidated = totalCollateral.lt(marginRequirement);
+        return {
+            canBeLiquidated,
+            marginRequirement,
+            totalCollateral,
+        };
     }
     isBeingLiquidated() {
         return (0, types_1.isOneOfVariant)(this.getUserAccount().status, [
@@ -1284,6 +1292,23 @@ class User {
         }
         return true;
     }
+    getSafestTiers() {
+        let safestPerpTier = 4;
+        let safestSpotTier = 4;
+        for (const perpPosition of this.getActivePerpPositions()) {
+            safestPerpTier = Math.min(safestPerpTier, (0, tiers_1.getPerpMarketTierNumber)(this.driftClient.getPerpMarketAccount(perpPosition.marketIndex)));
+        }
+        for (const spotPosition of this.getActiveSpotPositions()) {
+            if ((0, types_1.isVariant)(spotPosition.balanceType, 'deposit')) {
+                continue;
+            }
+            safestSpotTier = Math.min(safestSpotTier, (0, tiers_1.getSpotMarketTierNumber)(this.driftClient.getSpotMarketAccount(spotPosition.marketIndex)));
+        }
+        return {
+            perpTier: safestPerpTier,
+            spotTier: safestSpotTier,
+        };
+    }
     /**
      * Get the total position value, excluding any position coming from the given target market
      * @param marketToIgnore

package/lib/userStats.js

@@ -7,12 +7,15 @@ const webSocketUserStatsAccountSubsriber_1 = require("./accounts/webSocketUserSt
 const pda_1 = require("./addresses/pda");
 class UserStats {
     constructor(config) {
-        var _a;
+        var _a, _b;
         this.driftClient = config.driftClient;
         this.userStatsAccountPublicKey = config.userStatsAccountPublicKey;
         if (((_a = config.accountSubscription) === null || _a === void 0 ? void 0 : _a.type) === 'polling') {
             this.accountSubscriber = new pollingUserStatsAccountSubscriber_1.PollingUserStatsAccountSubscriber(config.driftClient.program, config.userStatsAccountPublicKey, config.accountSubscription.accountLoader);
         }
+        else if (((_b = config.accountSubscription) === null || _b === void 0 ? void 0 : _b.type) === 'custom') {
+            throw new Error('Custom account subscription not yet implemented for user stats');
+        }
         else {
             this.accountSubscriber = new webSocketUserStatsAccountSubsriber_1.WebSocketUserStatsAccountSubscriber(config.driftClient.program, config.userStatsAccountPublicKey);
         }

package/lib/userStatsConfig.d.ts

@@ -11,4 +11,6 @@ export type UserStatsSubscriptionConfig = {
 } | {
     type: 'polling';
     accountLoader: BulkAccountLoader;
+} | {
+    type: 'custom';
 };

package/package.json

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

package/src/idl/drift.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.31.1-beta.3",
+  "version": "2.31.1-beta.5",
   "name": "drift",
   "instructions": [
     {

package/src/math/tiers.ts

@@ -0,0 +1,44 @@
+import { isVariant, PerpMarketAccount, SpotMarketAccount } from '../types';
+
+export function getPerpMarketTierNumber(perpMarket: PerpMarketAccount): number {
+	if (isVariant(perpMarket.contractTier, 'a')) {
+		return 0;
+	} else if (isVariant(perpMarket.contractTier, 'b')) {
+		return 1;
+	} else if (isVariant(perpMarket.contractTier, 'c')) {
+		return 2;
+	} else if (isVariant(perpMarket.contractTier, 'speculative')) {
+		return 3;
+	} else if (isVariant(perpMarket.contractTier, 'isolated')) {
+		return 4;
+	} else {
+		return 5;
+	}
+}
+
+export function getSpotMarketTierNumber(spotMarket: SpotMarketAccount): number {
+	if (isVariant(spotMarket.assetTier, 'collateral')) {
+		return 0;
+	} else if (isVariant(spotMarket.assetTier, 'protected')) {
+		return 1;
+	} else if (isVariant(spotMarket.assetTier, 'cross')) {
+		return 2;
+	} else if (isVariant(spotMarket.assetTier, 'isolated')) {
+		return 3;
+	} else if (isVariant(spotMarket.assetTier, 'unlisted')) {
+		return 4;
+	} else {
+		return 5;
+	}
+}
+
+export function perpTierIsAsSafeAs(
+	perpTier: number,
+	otherPerpTier: number,
+	otherSpotTier: number
+): boolean {
+	const asSafeAsPerp = perpTier <= otherPerpTier;
+	const asSafeAsSpot =
+		otherSpotTier === 4 || (otherSpotTier >= 2 && perpTier <= 2);
+	return asSafeAsSpot && asSafeAsPerp;
+}

package/src/user.ts

@@ -72,6 +72,7 @@ import {
 } from './math/spotPosition';
 
 import { calculateLiveOracleTwap } from './math/oracles';
+import { getPerpMarketTierNumber, getSpotMarketTierNumber } from './math/tiers';
 
 export class User {
 	driftClient: DriftClient;
@@ -492,6 +493,12 @@ export class User {
 		);
 	}
 
+	public getActiveSpotPositions(): SpotPosition[] {
+		return this.getUserAccount().spotPositions.filter(
+			(pos) => !isSpotPositionAvailable(pos)
+		);
+	}
+
 	/**
 	 * calculates unrealized position price pnl
 	 * @returns : Precision QUOTE_PRECISION
@@ -1437,24 +1444,29 @@ export class User {
 		return netAssetValue.mul(TEN_THOUSAND).div(totalLiabilityValue);
 	}
 
-	public canBeLiquidated(): boolean {
+	public canBeLiquidated(): {
+		canBeLiquidated: boolean;
+		marginRequirement: BN;
+		totalCollateral: BN;
+	} {
 		const totalCollateral = this.getTotalCollateral('Maintenance');
 
 		// if user being liq'd, can continue to be liq'd until total collateral above the margin requirement plus buffer
 		let liquidationBuffer = undefined;
-		const isBeingLiquidated = isVariant(
-			this.getUserAccount().status,
-			'beingLiquidated'
-		);
-
-		if (isBeingLiquidated) {
+		if (this.isBeingLiquidated()) {
 			liquidationBuffer = new BN(
 				this.driftClient.getStateAccount().liquidationMarginBufferRatio
 			);
 		}
-		const maintenanceRequirement =
+		const marginRequirement =
 			this.getMaintenanceMarginRequirement(liquidationBuffer);
-		return totalCollateral.lt(maintenanceRequirement);
+		const canBeLiquidated = totalCollateral.lt(marginRequirement);
+
+		return {
+			canBeLiquidated,
+			marginRequirement,
+			totalCollateral,
+		};
 	}
 
 	public isBeingLiquidated(): boolean {
@@ -2306,6 +2318,38 @@ export class User {
 		return true;
 	}
 
+	public getSafestTiers(): { perpTier: number; spotTier: number } {
+		let safestPerpTier = 4;
+		let safestSpotTier = 4;
+
+		for (const perpPosition of this.getActivePerpPositions()) {
+			safestPerpTier = Math.min(
+				safestPerpTier,
+				getPerpMarketTierNumber(
+					this.driftClient.getPerpMarketAccount(perpPosition.marketIndex)
+				)
+			);
+		}
+
+		for (const spotPosition of this.getActiveSpotPositions()) {
+			if (isVariant(spotPosition.balanceType, 'deposit')) {
+				continue;
+			}
+
+			safestSpotTier = Math.min(
+				safestSpotTier,
+				getSpotMarketTierNumber(
+					this.driftClient.getSpotMarketAccount(spotPosition.marketIndex)
+				)
+			);
+		}
+
+		return {
+			perpTier: safestPerpTier,
+			spotTier: safestSpotTier,
+		};
+	}
+
 	/**
 	 * Get the total position value, excluding any position coming from the given target market
 	 * @param marketToIgnore
@@ -2347,6 +2391,7 @@ export class User {
 
 		return oracleData;
 	}
+
 	private getOracleDataForSpotMarket(marketIndex: number): OraclePriceData {
 		const oracleKey = this.driftClient.getSpotMarketAccount(marketIndex).oracle;
 

package/src/userStats.ts

@@ -25,6 +25,10 @@ export class UserStats {
 				config.userStatsAccountPublicKey,
 				config.accountSubscription.accountLoader
 			);
+		} else if (config.accountSubscription?.type === 'custom') {
+			throw new Error(
+				'Custom account subscription not yet implemented for user stats'
+			);
 		} else {
 			this.accountSubscriber = new WebSocketUserStatsAccountSubscriber(
 				config.driftClient.program,

package/src/userStatsConfig.ts

@@ -15,4 +15,7 @@ export type UserStatsSubscriptionConfig =
 	| {
 			type: 'polling';
 			accountLoader: BulkAccountLoader;
+	  }
+	| {
+			type: 'custom';
 	  };