sdk: high leverage mode updates (#1605)

* sdk: high leverage mode updates

* add optional param for fee calc

* update changelog

Author: lowkeynicc

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Features
 
+- sdk: fees and max perp trade size calculation functions allow an optional parameter for a user using bitFlags to enter high leverage mode
+
 ### Fixes
 
 ### Breaking

sdk/src/driftClient.ts

@@ -4429,6 +4429,16 @@ export class DriftClient {
 			useMarketLastSlotCache: true,
 		});
 
+		for (const param of params) {
+			if (isUpdateHighLeverageMode(param.bitFlags)) {
+				remainingAccounts.push({
+					pubkey: getHighLeverageModeConfigPublicKey(this.program.programId),
+					isWritable: true,
+					isSigner: false,
+				});
+			}
+		}
+
 		const formattedParams = params.map((item) => getOrderParams(item));
 
 		return await this.program.instruction.placeOrders(formattedParams, {
@@ -9008,7 +9018,8 @@ export class DriftClient {
 	public getMarketFees(
 		marketType: MarketType,
 		marketIndex?: number,
-		user?: User
+		user?: User,
+		enteringHighLeverageMode?: boolean
 	) {
 		let feeTier;
 		if (user) {
@@ -9033,7 +9044,7 @@ export class DriftClient {
 			}
 
 			takerFee += (takerFee * marketAccount.feeAdjustment) / 100;
-			if (user && user.isHighLeverageMode()) {
+			if (user && (user.isHighLeverageMode() || enteringHighLeverageMode)) {
 				takerFee *= 2;
 			}
 			makerFee += (makerFee * marketAccount.feeAdjustment) / 100;

sdk/src/user.ts

@@ -655,7 +655,11 @@ export class User {
 	 * calculates Buying Power = free collateral / initial margin ratio
 	 * @returns : Precision QUOTE_PRECISION
 	 */
-	public getPerpBuyingPower(marketIndex: number, collateralBuffer = ZERO): BN {
+	public getPerpBuyingPower(
+		marketIndex: number,
+		collateralBuffer = ZERO,
+		enterHighLeverageMode = false
+	): BN {
 		const perpPosition = this.getPerpPositionWithLPSettle(
 			marketIndex,
 			undefined,
@@ -677,21 +681,23 @@ export class User {
 		return this.getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(
 			marketIndex,
 			freeCollateral,
-			worstCaseBaseAssetAmount
+			worstCaseBaseAssetAmount,
+			enterHighLeverageMode
 		);
 	}
 
 	getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(
 		marketIndex: number,
 		freeCollateral: BN,
-		baseAssetAmount: BN
+		baseAssetAmount: BN,
+		enterHighLeverageMode = false
 	): BN {
 		const marginRatio = calculateMarketMarginRatio(
 			this.driftClient.getPerpMarketAccount(marketIndex),
 			baseAssetAmount,
 			'Initial',
 			this.getUserAccount().maxMarginRatio,
-			this.isHighLeverageMode()
+			enterHighLeverageMode || this.isHighLeverageMode()
 		);
 
 		return freeCollateral.mul(MARGIN_PRECISION).div(new BN(marginRatio));
@@ -1860,12 +1866,14 @@ export class User {
 	 * for large sizes where imf factor activates, result is a lower bound
 	 * @param marginCategory {Initial, Maintenance}
 	 * @param isLp if calculating max leveraging for adding lp, need to add buffer
+	 * @param enterHighLeverageMode can pass this as true to calculate max leverage if the user was to enter high leverage mode
 	 * @returns : Precision TEN_THOUSAND
 	 */
 	public getMaxLeverageForPerp(
 		perpMarketIndex: number,
 		marginCategory: MarginCategory = 'Initial',
-		isLp = false
+		isLp = false,
+		enterHighLeverageMode = false
 	): BN {
 		const market = this.driftClient.getPerpMarketAccount(perpMarketIndex);
 		const marketPrice =
@@ -1923,7 +1931,7 @@ export class User {
 			maxSize,
 			marginCategory,
 			this.getUserAccount().maxMarginRatio,
-			this.isHighLeverageMode()
+			enterHighLeverageMode || this.isHighLeverageMode()
 		);
 
 		// use more fesible size since imf factor activated
@@ -1945,7 +1953,7 @@ export class User {
 				targetSize,
 				marginCategory,
 				this.getUserAccount().maxMarginRatio,
-				this.isHighLeverageMode()
+				enterHighLeverageMode || this.isHighLeverageMode()
 			);
 			attempts += 1;
 		}
@@ -2633,7 +2641,8 @@ export class User {
 	public getMaxTradeSizeUSDCForPerp(
 		targetMarketIndex: number,
 		tradeSide: PositionDirection,
-		isLp = false
+		isLp = false,
+		enterHighLeverageMode = false
 	): { tradeSize: BN; oppositeSideTradeSize: BN } {
 		let tradeSize = ZERO;
 		let oppositeSideTradeSize = ZERO;
@@ -2673,7 +2682,8 @@ export class User {
 
 		const maxPositionSize = this.getPerpBuyingPower(
 			targetMarketIndex,
-			lpBuffer
+			lpBuffer,
+			enterHighLeverageMode
 		);
 
 		if (maxPositionSize.gte(ZERO)) {
@@ -3491,12 +3501,17 @@ export class User {
 	 * @param quoteAmount
 	 * @returns feeForQuote : Precision QUOTE_PRECISION
 	 */
-	public calculateFeeForQuoteAmount(quoteAmount: BN, marketIndex?: number): BN {
+	public calculateFeeForQuoteAmount(
+		quoteAmount: BN,
+		marketIndex?: number,
+		enteringHighLeverageMode?: boolean
+	): BN {
 		if (marketIndex !== undefined) {
 			const takerFeeMultiplier = this.driftClient.getMarketFees(
 				MarketType.PERP,
 				marketIndex,
-				this
+				this,
+				enteringHighLeverageMode
 			).takerFee;
 			const feeAmountNum =
 				BigNum.from(quoteAmount, QUOTE_PRECISION_EXP).toNum() *