lukas/per market lev (#1862)

* feat: per market max leverage

* fix: max margin ratio correct naming and decoding

* fix: correctly decode perp position max lev

* fix: add missing metadata for drift address on idl

Author: LukasDeco

sdk/src/decode/user.ts

@@ -111,7 +111,7 @@ export function decodeUser(buffer: Buffer): UserAccount {
 		offset += 8;
 		const lastQuoteAssetAmountPerLp = readSignedBigInt64LE(buffer, offset);
 		offset += 8;
-		const remainderBaseAssetAmount = buffer.readInt32LE(offset);
+		const maxMarginRatio = buffer.readUInt16LE(offset);
 		offset += 4;
 		const marketIndex = buffer.readUInt16LE(offset);
 		offset += 3;
@@ -128,12 +128,13 @@ export function decodeUser(buffer: Buffer): UserAccount {
 			openAsks,
 			settledPnl,
 			lpShares,
+			remainderBaseAssetAmount: 0,
 			lastBaseAssetAmountPerLp,
 			lastQuoteAssetAmountPerLp,
-			remainderBaseAssetAmount,
 			marketIndex,
 			openOrders,
 			perLpBase,
+			maxMarginRatio,
 		});
 	}
 

sdk/src/driftClient.ts

@@ -1538,6 +1538,50 @@ export class DriftClient {
 		return ix;
 	}
 
+	public async getUpdateUserPerpPositionCustomMarginRatioIx(
+		perpMarketIndex: number,
+		marginRatio: number,
+		subAccountId = 0
+	): Promise<TransactionInstruction> {
+		const userAccountPublicKey = getUserAccountPublicKeySync(
+			this.program.programId,
+			this.wallet.publicKey,
+			subAccountId
+		);
+
+		await this.addUser(subAccountId, this.wallet.publicKey);
+
+		const ix = this.program.instruction.updateUserPerpPositionCustomMarginRatio(
+			subAccountId,
+			perpMarketIndex,
+			marginRatio,
+			{
+				accounts: {
+					user: userAccountPublicKey,
+					authority: this.wallet.publicKey,
+				},
+			}
+		);
+
+		return ix;
+	}
+
+	public async updateUserPerpPositionCustomMarginRatio(
+		perpMarketIndex: number,
+		marginRatio: number,
+		subAccountId = 0,
+		txParams?: TxParams
+	): Promise<TransactionSignature> {
+		const ix = await this.getUpdateUserPerpPositionCustomMarginRatioIx(
+			perpMarketIndex,
+			marginRatio,
+			subAccountId
+		);
+		const tx = await this.buildTransaction(ix, txParams ?? this.txParams);
+		const { txSig } = await this.sendTransaction(tx, [], this.opts);
+		return txSig;
+	}
+
 	public async getUpdateUserMarginTradingEnabledIx(
 		marginTradingEnabled: boolean,
 		subAccountId = 0,

sdk/src/idl/drift.json

@@ -1444,6 +1444,35 @@
         }
       ]
     },
+    {
+      "name": "updateUserPerpPositionCustomMarginRatio",
+      "accounts": [
+        {
+          "name": "user",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "authority",
+          "isMut": false,
+          "isSigner": true
+        }
+      ],
+      "args": [
+        {
+          "name": "subAccountId",
+          "type": "u16"
+        },
+        {
+          "name": "perpMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "marginRatio",
+          "type": "u16"
+        }
+      ]
+    },
     {
       "name": "updateUserMarginTradingEnabled",
       "accounts": [
@@ -11484,13 +11513,17 @@
             "type": "i64"
           },
           {
-            "name": "remainderBaseAssetAmount",
-            "docs": [
-              "Settling LP position can lead to a small amount of base asset being left over smaller than step size",
-              "This records that remainder so it can be settled later on",
-              "precision: BASE_PRECISION"
-            ],
-            "type": "i32"
+            "name": "padding",
+            "type": {
+              "array": [
+                "u8",
+                2
+              ]
+            }
+          },
+          {
+            "name": "maxMarginRatio",
+            "type": "u16"
           },
           {
             "name": "marketIndex",

sdk/src/types.ts

@@ -1042,7 +1042,9 @@ export type PerpPosition = {
 	openAsks: BN;
 	settledPnl: BN;
 	lpShares: BN;
+	/**	 TODO: remove this field - it doesn't exist on chain */
 	remainderBaseAssetAmount: number;
+	maxMarginRatio: number;
 	lastBaseAssetAmountPerLp: BN;
 	lastQuoteAssetAmountPerLp: BN;
 	perLpBase: number;

sdk/src/user.ts

@@ -330,6 +330,7 @@ export class User {
 			lastBaseAssetAmountPerLp: ZERO,
 			lastQuoteAssetAmountPerLp: ZERO,
 			perLpBase: 0,
+			maxMarginRatio: 0,
 		};
 	}
 
@@ -471,21 +472,27 @@ export class User {
 			marketIndex,
 			freeCollateral,
 			worstCaseBaseAssetAmount,
-			enterHighLeverageMode
+			enterHighLeverageMode,
+			perpPosition
 		);
 	}
 
 	getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(
 		marketIndex: number,
 		freeCollateral: BN,
 		baseAssetAmount: BN,
-		enterHighLeverageMode = undefined
+		enterHighLeverageMode = undefined,
+		perpPosition?: PerpPosition
 	): BN {
+		const userCustomMargin = Math.max(
+			perpPosition?.maxMarginRatio ?? 0,
+			this.getUserAccount().maxMarginRatio
+		);
 		const marginRatio = calculateMarketMarginRatio(
 			this.driftClient.getPerpMarketAccount(marketIndex),
 			baseAssetAmount,
 			'Initial',
-			this.getUserAccount().maxMarginRatio,
+			userCustomMargin,
 			enterHighLeverageMode || this.isHighLeverageMode('Initial')
 		);
 
@@ -2162,7 +2169,10 @@ export class User {
 				);
 			}
 
-			const userCustomMargin = this.getUserAccount().maxMarginRatio;
+			const userCustomMargin = Math.max(
+				perpPosition.maxMarginRatio,
+				this.getUserAccount().maxMarginRatio
+			);
 			const marginRatio = calculateMarketMarginRatio(
 				market,
 				baseAssetAmount.abs(),
@@ -2212,7 +2222,10 @@ export class User {
 
 		const proposedBaseAssetAmount = baseAssetAmount.add(positionBaseSizeChange);
 
-		const userCustomMargin = this.getUserAccount().maxMarginRatio;
+		const userCustomMargin = Math.max(
+			perpPosition.maxMarginRatio,
+			this.getUserAccount().maxMarginRatio
+		);
 
 		const marginRatio = calculateMarketMarginRatio(
 			market,
@@ -3578,12 +3591,16 @@ export class User {
 			oraclePrice
 		);
 
+		const userCustomMargin = Math.max(
+			perpPosition.maxMarginRatio,
+			this.getUserAccount().maxMarginRatio
+		);
 		const marginRatio = new BN(
 			calculateMarketMarginRatio(
 				perpMarket,
 				worstCaseBaseAmount.abs(),
 				marginCategory,
-				this.getUserAccount().maxMarginRatio,
+				userCustomMargin,
 				this.isHighLeverageMode(marginCategory)
 			)
 		);