feat: add margin ratio ix to open orders + swift prop (#1864)

* feat: add margin ratio ix to open orders + swift prop

* fix: bug with max lev available calculation

* fix: bug with swift msg encoding + margin ratio

* feat: re-add types for swift non-optional

* rm: unneeded undefined check on swift maxMarginRation

* allow enter HLM on position margin ratio update

* fix margin ratio calc

* updates

* rm logs

---------

Co-authored-by: Nick Caradonna <[email protected]>

Author: LukasDeco

sdk/src/driftClient.ts

@@ -126,6 +126,7 @@ import { TxSender, TxSigAndSlot } from './tx/types';
 import {
 	BASE_PRECISION,
 	GOV_SPOT_MARKET_INDEX,
+	MARGIN_PRECISION,
 	ONE,
 	PERCENTAGE_PRECISION,
 	PRICE_PRECISION,
@@ -1723,11 +1724,11 @@ export class DriftClient {
 	): Promise<TransactionInstruction> {
 		const userAccountPublicKey = getUserAccountPublicKeySync(
 			this.program.programId,
-			this.wallet.publicKey,
+			this.authority,
 			subAccountId
 		);
 
-		await this.addUser(subAccountId, this.wallet.publicKey);
+		await this.addUser(subAccountId, this.authority);
 
 		const ix = this.program.instruction.updateUserPerpPositionCustomMarginRatio(
 			subAccountId,
@@ -1748,14 +1749,21 @@ export class DriftClient {
 		perpMarketIndex: number,
 		marginRatio: number,
 		subAccountId = 0,
-		txParams?: TxParams
+		txParams?: TxParams,
+		enterHighLeverageMode?: boolean
 	): Promise<TransactionSignature> {
-		const ix = await this.getUpdateUserPerpPositionCustomMarginRatioIx(
+		const ixs = [];
+		if (enterHighLeverageMode) {
+			const enableIx = await this.getEnableHighLeverageModeIx(subAccountId);
+			ixs.push(enableIx);
+		}
+		const updateIx = await this.getUpdateUserPerpPositionCustomMarginRatioIx(
 			perpMarketIndex,
 			marginRatio,
 			subAccountId
 		);
-		const tx = await this.buildTransaction(ix, txParams ?? this.txParams);
+		ixs.push(updateIx);
+		const tx = await this.buildTransaction(ixs, txParams ?? this.txParams);
 		const { txSig } = await this.sendTransaction(tx, [], this.opts);
 		return txSig;
 	}
@@ -4292,7 +4300,8 @@ export class DriftClient {
 		bracketOrdersParams = new Array<OptionalOrderParams>(),
 		referrerInfo?: ReferrerInfo,
 		cancelExistingOrders?: boolean,
-		settlePnl?: boolean
+		settlePnl?: boolean,
+		positionMaxLev?: number
 	): Promise<{
 		cancelExistingOrdersTx?: Transaction | VersionedTransaction;
 		settlePnlTx?: Transaction | VersionedTransaction;
@@ -4308,7 +4317,10 @@ export class DriftClient {
 		const marketIndex = orderParams.marketIndex;
 		const orderId = userAccount.nextOrderId;
 
-		const ixPromisesForTxs: Record<TxKeys, Promise<TransactionInstruction>> = {
+		const ixPromisesForTxs: Record<
+			TxKeys,
+			Promise<TransactionInstruction | TransactionInstruction[]>
+		> = {
 			cancelExistingOrdersTx: undefined,
 			settlePnlTx: undefined,
 			fillTx: undefined,
@@ -4317,10 +4329,18 @@ export class DriftClient {
 
 		const txKeys = Object.keys(ixPromisesForTxs);
 
-		ixPromisesForTxs.marketOrderTx = this.getPlaceOrdersIx(
-			[orderParams, ...bracketOrdersParams],
-			userAccount.subAccountId
-		);
+		const marketOrderTxIxs = positionMaxLev
+			? this.getPlaceOrdersAndSetPositionMaxLevIx(
+					[orderParams, ...bracketOrdersParams],
+					positionMaxLev,
+					userAccount.subAccountId
+			  )
+			: this.getPlaceOrdersIx(
+					[orderParams, ...bracketOrdersParams],
+					userAccount.subAccountId
+			  );
+
+		ixPromisesForTxs.marketOrderTx = marketOrderTxIxs;
 
 		/* Cancel open orders in market if requested */
 		if (cancelExistingOrders && isVariant(orderParams.marketType, 'perp')) {
@@ -4361,7 +4381,10 @@ export class DriftClient {
 		const ixsMap = ixs.reduce((acc, ix, i) => {
 			acc[txKeys[i]] = ix;
 			return acc;
-		}, {}) as MappedRecord<typeof ixPromisesForTxs, TransactionInstruction>;
+		}, {}) as MappedRecord<
+			typeof ixPromisesForTxs,
+			TransactionInstruction | TransactionInstruction[]
+		>;
 
 		const txsMap = (await this.buildTransactionsMap(
 			ixsMap,
@@ -4945,6 +4968,73 @@ export class DriftClient {
 		});
 	}
 
+	public async getPlaceOrdersAndSetPositionMaxLevIx(
+		params: OptionalOrderParams[],
+		positionMaxLev: number,
+		subAccountId?: number
+	): Promise<TransactionInstruction[]> {
+		const user = await this.getUserAccountPublicKey(subAccountId);
+
+		const readablePerpMarketIndex: number[] = [];
+		const readableSpotMarketIndexes: number[] = [];
+		for (const param of params) {
+			if (!param.marketType) {
+				throw new Error('must set param.marketType');
+			}
+			if (isVariant(param.marketType, 'perp')) {
+				readablePerpMarketIndex.push(param.marketIndex);
+			} else {
+				readableSpotMarketIndexes.push(param.marketIndex);
+			}
+		}
+
+		const remainingAccounts = this.getRemainingAccounts({
+			userAccounts: [this.getUserAccount(subAccountId)],
+			readablePerpMarketIndex,
+			readableSpotMarketIndexes,
+			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));
+
+		const placeOrdersIxs = await this.program.instruction.placeOrders(
+			formattedParams,
+			{
+				accounts: {
+					state: await this.getStatePublicKey(),
+					user,
+					userStats: this.getUserStatsAccountPublicKey(),
+					authority: this.wallet.publicKey,
+				},
+				remainingAccounts,
+			}
+		);
+
+		const marginRatio = Math.floor(
+			(1 / positionMaxLev) * MARGIN_PRECISION.toNumber()
+		);
+
+		// TODO: Handle multiple markets?
+		const setPositionMaxLevIxs =
+			await this.getUpdateUserPerpPositionCustomMarginRatioIx(
+				readablePerpMarketIndex[0],
+				marginRatio,
+				subAccountId
+			);
+
+		return [placeOrdersIxs, setPositionMaxLevIxs];
+	}
+
 	public async fillPerpOrder(
 		userAccountPublicKey: PublicKey,
 		user: UserAccount,

sdk/src/user.ts

@@ -449,7 +449,8 @@ export class User {
 	public getPerpBuyingPower(
 		marketIndex: number,
 		collateralBuffer = ZERO,
-		enterHighLeverageMode = undefined
+		enterHighLeverageMode = undefined,
+		maxMarginRatio = undefined
 	): BN {
 		const perpPosition = this.getPerpPositionOrEmpty(marketIndex);
 
@@ -473,7 +474,7 @@ export class User {
 			freeCollateral,
 			worstCaseBaseAssetAmount,
 			enterHighLeverageMode,
-			perpPosition
+			maxMarginRatio || perpPosition.maxMarginRatio
 		);
 	}
 
@@ -482,17 +483,17 @@ export class User {
 		freeCollateral: BN,
 		baseAssetAmount: BN,
 		enterHighLeverageMode = undefined,
-		perpPosition?: PerpPosition
+		perpMarketMaxMarginRatio = undefined
 	): BN {
-		const userCustomMargin = Math.max(
-			perpPosition?.maxMarginRatio ?? 0,
+		const maxMarginRatio = Math.max(
+			perpMarketMaxMarginRatio,
 			this.getUserAccount().maxMarginRatio
 		);
 		const marginRatio = calculateMarketMarginRatio(
 			this.driftClient.getPerpMarketAccount(marketIndex),
 			baseAssetAmount,
 			'Initial',
-			userCustomMargin,
+			maxMarginRatio,
 			enterHighLeverageMode || this.isHighLeverageMode('Initial')
 		);
 
@@ -1247,7 +1248,10 @@ export class User {
 		}
 
 		if (marginCategory) {
-			const userCustomMargin = this.getUserAccount().maxMarginRatio;
+			const userCustomMargin = Math.max(
+				perpPosition.maxMarginRatio,
+				this.getUserAccount().maxMarginRatio
+			);
 			let marginRatio = new BN(
 				calculateMarketMarginRatio(
 					market,
@@ -2345,13 +2349,18 @@ export class User {
 	public getMarginUSDCRequiredForTrade(
 		targetMarketIndex: number,
 		baseSize: BN,
-		estEntryPrice?: BN
+		estEntryPrice?: BN,
+		perpMarketMaxMarginRatio?: number
 	): BN {
+		const maxMarginRatio = Math.max(
+			perpMarketMaxMarginRatio,
+			this.getUserAccount().maxMarginRatio
+		);
 		return calculateMarginUSDCRequiredForTrade(
 			this.driftClient,
 			targetMarketIndex,
 			baseSize,
-			this.getUserAccount().maxMarginRatio,
+			maxMarginRatio,
 			undefined,
 			estEntryPrice
 		);
@@ -2360,14 +2369,19 @@ export class User {
 	public getCollateralDepositRequiredForTrade(
 		targetMarketIndex: number,
 		baseSize: BN,
-		collateralIndex: number
+		collateralIndex: number,
+		perpMarketMaxMarginRatio?: number
 	): BN {
+		const maxMarginRatio = Math.max(
+			perpMarketMaxMarginRatio,
+			this.getUserAccount().maxMarginRatio
+		);
 		return calculateCollateralDepositRequiredForTrade(
 			this.driftClient,
 			targetMarketIndex,
 			baseSize,
 			collateralIndex,
-			this.getUserAccount().maxMarginRatio,
+			maxMarginRatio,
 			false // assume user cant be high leverage if they havent created user account ?
 		);
 	}
@@ -2385,7 +2399,8 @@ export class User {
 		targetMarketIndex: number,
 		tradeSide: PositionDirection,
 		isLp = false,
-		enterHighLeverageMode = undefined
+		enterHighLeverageMode = undefined,
+		maxMarginRatio = undefined
 	): { tradeSize: BN; oppositeSideTradeSize: BN } {
 		let tradeSize = ZERO;
 		let oppositeSideTradeSize = ZERO;
@@ -2424,7 +2439,8 @@ export class User {
 		const maxPositionSize = this.getPerpBuyingPower(
 			targetMarketIndex,
 			lpBuffer,
-			enterHighLeverageMode
+			enterHighLeverageMode,
+			maxMarginRatio
 		);
 
 		if (maxPositionSize.gte(ZERO)) {
@@ -2451,8 +2467,12 @@ export class User {
 				const marginRequirement = this.getInitialMarginRequirement(
 					enterHighLeverageMode
 				);
+				const marginRatio = Math.max(
+					currentPosition.maxMarginRatio,
+					this.getUserAccount().maxMarginRatio
+				);
 				const marginFreedByClosing = perpLiabilityValue
-					.mul(new BN(market.marginRatioInitial))
+					.mul(new BN(marginRatio))
 					.div(MARGIN_PRECISION);
 				const marginRequirementAfterClosing =
 					marginRequirement.sub(marginFreedByClosing);
@@ -2468,7 +2488,8 @@ export class User {
 						this.getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(
 							targetMarketIndex,
 							freeCollateralAfterClose,
-							ZERO
+							ZERO,
+							currentPosition.maxMarginRatio
 						);
 					oppositeSideTradeSize = perpLiabilityValue;
 					tradeSize = buyingPowerAfterClose;

sdk/tests/dlob/helpers.ts

@@ -44,6 +44,7 @@ export const mockPerpPosition: PerpPosition = {
 	lastBaseAssetAmountPerLp: new BN(0),
 	lastQuoteAssetAmountPerLp: new BN(0),
 	perLpBase: 0,
+	maxMarginRatio: 1,
 };
 
 export const mockAMM: AMM = {