fix: bug with swift msg encoding + margin ratio

Author: LukasDeco

sdk/src/driftClient.ts

@@ -4035,7 +4035,10 @@ export class DriftClient {
 		const marketIndex = orderParams.marketIndex;
 		const orderId = userAccount.nextOrderId;
 
-		const ixPromisesForTxs: Record<TxKeys, Promise<TransactionInstruction | TransactionInstruction[]>> = {
+		const ixPromisesForTxs: Record<
+			TxKeys,
+			Promise<TransactionInstruction | TransactionInstruction[]>
+		> = {
 			cancelExistingOrdersTx: undefined,
 			settlePnlTx: undefined,
 			fillTx: undefined,
@@ -4044,14 +4047,16 @@ export class DriftClient {
 
 		const txKeys = Object.keys(ixPromisesForTxs);
 
-		const marketOrderTxIxs = positionMaxLev ? this.getPlaceOrdersAndSetPositionMaxLevIx(
-			[orderParams, ...bracketOrdersParams],
-			positionMaxLev,
-			userAccount.subAccountId
-		) : 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;
 
@@ -4094,7 +4099,10 @@ export class DriftClient {
 		const ixsMap = ixs.reduce((acc, ix, i) => {
 			acc[txKeys[i]] = ix;
 			return acc;
-		}, {}) as MappedRecord<typeof ixPromisesForTxs, TransactionInstruction | TransactionInstruction[]>;
+		}, {}) as MappedRecord<
+			typeof ixPromisesForTxs,
+			TransactionInstruction | TransactionInstruction[]
+		>;
 
 		const txsMap = (await this.buildTransactionsMap(
 			ixsMap,
@@ -4717,22 +4725,26 @@ export class DriftClient {
 
 		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 placeOrdersIxs = await this.program.instruction.placeOrders(
+			formattedParams,
+			{
+				accounts: {
+					state: await this.getStatePublicKey(),
+					user,
+					userStats: this.getUserStatsAccountPublicKey(),
+					authority: this.wallet.publicKey,
+				},
+				remainingAccounts,
+			}
+		);
 
 		// TODO: Handle multiple markets?
-		const setPositionMaxLevIxs = await this.getUpdateUserPerpPositionCustomMarginRatioIx(
-			readablePerpMarketIndex[0],
-			1 / positionMaxLev,
-			subAccountId
-		);
+		const setPositionMaxLevIxs =
+			await this.getUpdateUserPerpPositionCustomMarginRatioIx(
+				readablePerpMarketIndex[0],
+				1 / positionMaxLev,
+				subAccountId
+			);
 
 		return [placeOrdersIxs, setPositionMaxLevIxs];
 	}
@@ -4893,8 +4905,9 @@ export class DriftClient {
 		subAccountId?: number
 	): Promise<TransactionSignature> {
 		const { txSig, slot } = await this.sendTransaction(
-			(await this.preparePlaceSpotOrderTx(orderParams, txParams, subAccountId))
-				.placeSpotOrderTx,
+			(
+				await this.preparePlaceSpotOrderTx(orderParams, txParams, subAccountId)
+			).placeSpotOrderTx,
 			[],
 			this.opts,
 			false
@@ -6558,6 +6571,9 @@ export class DriftClient {
 			| SignedMsgOrderParamsDelegateMessage,
 		delegateSigner?: boolean
 	): Buffer {
+		if (orderParamsMessage.maxMarginRatio === undefined) {
+			orderParamsMessage.maxMarginRatio = null;
+		}
 		const anchorIxName = delegateSigner
 			? 'global' + ':' + 'SignedMsgOrderParamsDelegateMessage'
 			: 'global' + ':' + 'SignedMsgOrderParamsMessage';

sdk/src/user.ts

@@ -473,7 +473,7 @@ export class User {
 			freeCollateral,
 			worstCaseBaseAssetAmount,
 			enterHighLeverageMode,
-			perpPosition
+			perpPosition.maxMarginRatio
 		);
 	}
 
@@ -482,13 +482,17 @@ export class User {
 		freeCollateral: BN,
 		baseAssetAmount: BN,
 		enterHighLeverageMode = undefined,
-		perpPosition?: PerpPosition
+		perpMarketMaxMarginRatio = undefined
 	): BN {
+		const maxMarginRatio = Math.max(
+			perpMarketMaxMarginRatio,
+			this.getUserAccount().maxMarginRatio
+		);
 		const marginRatio = calculateMarketMarginRatio(
 			this.driftClient.getPerpMarketAccount(marketIndex),
 			baseAssetAmount,
 			'Initial',
-			this.getUserAccount().maxMarginRatio,
+			maxMarginRatio,
 			enterHighLeverageMode || this.isHighLeverageMode('Initial')
 		);
 
@@ -1023,6 +1027,7 @@ export class User {
 
 		if (marketIndex === undefined || marketIndex === QUOTE_SPOT_MARKET_INDEX) {
 			if (netQuoteValue.gt(ZERO)) {
+
 				totalAssetValue = totalAssetValue.add(netQuoteValue);
 			} else {
 				totalLiabilityValue = totalLiabilityValue.add(netQuoteValue.abs());
@@ -1243,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,
@@ -2165,7 +2173,10 @@ export class User {
 				);
 			}
 
-			const userCustomMargin = this.getUserAccount().maxMarginRatio;
+			const userCustomMargin = Math.max(
+				perpPosition.maxMarginRatio,
+				this.getUserAccount().maxMarginRatio
+			);
 			const marginRatio = calculateMarketMarginRatio(
 				market,
 				baseAssetAmount.abs(),
@@ -2338,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
 		);
@@ -2353,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 ?
 		);
 	}
@@ -2444,8 +2465,9 @@ 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);
@@ -2461,7 +2483,8 @@ export class User {
 						this.getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(
 							targetMarketIndex,
 							freeCollateralAfterClose,
-							ZERO
+							ZERO,
+							currentPosition.maxMarginRatio
 						);
 					oppositeSideTradeSize = perpLiabilityValue;
 					tradeSize = buyingPowerAfterClose;