@drift-labs/sdk 2.97.0-beta.0 → 2.97.0-beta.10

package/src/idl/drift.json

@@ -1283,6 +1283,37 @@
       ],
       "args": []
     },
+    {
+      "name": "enableUserHighLeverageMode",
+      "accounts": [
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "user",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "authority",
+          "isMut": false,
+          "isSigner": true
+        },
+        {
+          "name": "highLeverageModeConfig",
+          "isMut": true,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "subAccountId",
+          "type": "u16"
+        }
+      ]
+    },
     {
       "name": "fillPerpOrder",
       "accounts": [
@@ -1498,6 +1529,58 @@
       ],
       "args": []
     },
+    {
+      "name": "disableUserHighLeverageMode",
+      "accounts": [
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "authority",
+          "isMut": false,
+          "isSigner": true
+        },
+        {
+          "name": "user",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "highLeverageModeConfig",
+          "isMut": true,
+          "isSigner": false
+        }
+      ],
+      "args": []
+    },
+    {
+      "name": "updateUserFuelBonus",
+      "accounts": [
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "authority",
+          "isMut": false,
+          "isSigner": true
+        },
+        {
+          "name": "user",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "userStats",
+          "isMut": true,
+          "isSigner": false
+        }
+      ],
+      "args": []
+    },
     {
       "name": "updateUserOpenOrdersCount",
       "accounts": [
@@ -3961,6 +4044,36 @@
         }
       ]
     },
+    {
+      "name": "updatePerpMarketHighLeverageMarginRatio",
+      "accounts": [
+        {
+          "name": "admin",
+          "isMut": false,
+          "isSigner": true
+        },
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "perpMarket",
+          "isMut": true,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "marginRatioInitial",
+          "type": "u16"
+        },
+        {
+          "name": "marginRatioMaintenance",
+          "type": "u16"
+        }
+      ]
+    },
     {
       "name": "updatePerpMarketFundingPeriod",
       "accounts": [
@@ -5926,6 +6039,72 @@
           }
         }
       ]
+    },
+    {
+      "name": "initializeHighLeverageModeConfig",
+      "accounts": [
+        {
+          "name": "admin",
+          "isMut": true,
+          "isSigner": true
+        },
+        {
+          "name": "highLeverageModeConfig",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "rent",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "systemProgram",
+          "isMut": false,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "maxUsers",
+          "type": "u32"
+        }
+      ]
+    },
+    {
+      "name": "updateHighLeverageModeConfig",
+      "accounts": [
+        {
+          "name": "admin",
+          "isMut": true,
+          "isSigner": true
+        },
+        {
+          "name": "highLeverageModeConfig",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "maxUsers",
+          "type": "u32"
+        },
+        {
+          "name": "reduceOnly",
+          "type": "bool"
+        }
+      ]
     }
   ],
   "accounts": [
@@ -6132,6 +6311,35 @@
         ]
       }
     },
+    {
+      "name": "HighLeverageModeConfig",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "maxUsers",
+            "type": "u32"
+          },
+          {
+            "name": "currentUsers",
+            "type": "u32"
+          },
+          {
+            "name": "reduceOnly",
+            "type": "u8"
+          },
+          {
+            "name": "padding",
+            "type": {
+              "array": [
+                "u8",
+                31
+              ]
+            }
+          }
+        ]
+      }
+    },
     {
       "name": "InsuranceFundStake",
       "type": {
@@ -6520,12 +6728,24 @@
             ],
             "type": "u8"
           },
+          {
+            "name": "padding1",
+            "type": "u8"
+          },
+          {
+            "name": "highLeverageMarginRatioInitial",
+            "type": "u16"
+          },
+          {
+            "name": "highLeverageMarginRatioMaintenance",
+            "type": "u16"
+          },
           {
             "name": "padding",
             "type": {
               "array": [
                 "u8",
-                43
+                38
               ]
             }
           }
@@ -7375,12 +7595,18 @@
             ],
             "type": "bool"
           },
+          {
+            "name": "marginMode",
+            "type": {
+              "defined": "MarginMode"
+            }
+          },
           {
             "name": "padding1",
             "type": {
               "array": [
                 "u8",
-                5
+                4
               ]
             }
           },
@@ -10633,6 +10859,20 @@
           }
         ]
       }
+    },
+    {
+      "name": "MarginMode",
+      "type": {
+        "kind": "enum",
+        "variants": [
+          {
+            "name": "Default"
+          },
+          {
+            "name": "HighLeverage"
+          }
+        ]
+      }
     }
   ],
   "events": [
@@ -13126,6 +13366,11 @@
       "code": 6289,
       "name": "PlaceAndTakeOrderSuccessConditionFailed",
       "msg": "Place and take order success condition failed"
+    },
+    {
+      "code": 6290,
+      "name": "InvalidHighLeverageModeConfig",
+      "msg": "Invalid High Leverage Mode Config"
     }
   ],
   "metadata": {

package/src/math/margin.ts

@@ -214,7 +214,8 @@ export function calculateMarginUSDCRequiredForTrade(
 	driftClient: DriftClient,
 	targetMarketIndex: number,
 	baseSize: BN,
-	userMaxMarginRatio?: number
+	userMaxMarginRatio?: number,
+	userHighLeverageMode?: boolean
 ): BN {
 	const targetMarket = driftClient.getPerpMarketAccount(targetMarketIndex);
 	const oracleData = driftClient.getOracleDataForPerpMarket(
@@ -232,7 +233,8 @@ export function calculateMarginUSDCRequiredForTrade(
 			targetMarket,
 			baseSize.abs(),
 			'Initial',
-			userMaxMarginRatio
+			userMaxMarginRatio,
+			userHighLeverageMode
 		)
 	)
 		.mul(perpLiabilityValue)
@@ -251,13 +253,15 @@ export function calculateCollateralDepositRequiredForTrade(
 	targetMarketIndex: number,
 	baseSize: BN,
 	collateralIndex: number,
-	userMaxMarginRatio?: number
+	userMaxMarginRatio?: number,
+	userHighLeverageMode?: boolean
 ): BN {
 	const marginRequiredUsdc = calculateMarginUSDCRequiredForTrade(
 		driftClient,
 		targetMarketIndex,
 		baseSize,
-		userMaxMarginRatio
+		userMaxMarginRatio,
+		userHighLeverageMode
 	);
 
 	const collateralMarket = driftClient.getSpotMarketAccount(collateralIndex);

package/src/math/market.ts

@@ -130,8 +130,24 @@ export function calculateMarketMarginRatio(
 	market: PerpMarketAccount,
 	size: BN,
 	marginCategory: MarginCategory,
-	customMarginRatio = 0
+	customMarginRatio = 0,
+	userHighLeverageMode = false
 ): number {
+	let marginRationInitial;
+	let marginRatioMaintenance;
+
+	if (
+		userHighLeverageMode &&
+		market.highLeverageMarginRatioInitial > 0 &&
+		market.highLeverageMarginRatioMaintenance
+	) {
+		marginRationInitial = market.highLeverageMarginRatioInitial;
+		marginRatioMaintenance = market.highLeverageMarginRatioMaintenance;
+	} else {
+		marginRationInitial = market.marginRatioInitial;
+		marginRatioMaintenance = market.marginRatioMaintenance;
+	}
+
 	let marginRatio;
 	switch (marginCategory) {
 		case 'Initial': {
@@ -140,7 +156,7 @@ export function calculateMarketMarginRatio(
 				calculateSizePremiumLiabilityWeight(
 					size,
 					new BN(market.imfFactor),
-					new BN(market.marginRatioInitial),
+					new BN(marginRationInitial),
 					MARGIN_PRECISION
 				).toNumber(),
 				customMarginRatio
@@ -151,7 +167,7 @@ export function calculateMarketMarginRatio(
 			marginRatio = calculateSizePremiumLiabilityWeight(
 				size,
 				new BN(market.imfFactor),
-				new BN(market.marginRatioMaintenance),
+				new BN(marginRatioMaintenance),
 				MARGIN_PRECISION
 			).toNumber();
 			break;

package/src/types.ts

@@ -68,6 +68,11 @@ export enum UserStatus {
 	ADVANCED_LP = 8,
 }
 
+export class MarginMode {
+	static readonly DEFAULT = { default: {} };
+	static readonly HIGH_LEVERAGE = { highLeverage: {} };
+}
+
 export class ContractType {
 	static readonly PERPETUAL = { perpetual: {} };
 	static readonly FUTURE = { future: {} };
@@ -661,6 +666,9 @@ export type PerpMarketAccount = {
 	fuelBoostTaker: number;
 	fuelBoostMaker: number;
 	fuelBoostPosition: number;
+
+	highLeverageMarginRatioInitial: number;
+	highLeverageMarginRatioMaintenance: number;
 };
 
 export type HistoricalOracleData = {
@@ -950,6 +958,7 @@ export type UserAccount = {
 	openAuctions: number;
 	hasOpenAuction: boolean;
 	lastFuelBonusUpdateTs: number;
+	marginMode: MarginMode;
 };
 
 export type SpotPosition = {

package/src/user.ts

@@ -676,7 +676,8 @@ export class User {
 			this.driftClient.getPerpMarketAccount(marketIndex),
 			baseAssetAmount,
 			'Initial',
-			this.getUserAccount().maxMarginRatio
+			this.getUserAccount().maxMarginRatio,
+			this.isHighLeverageMode()
 		);
 
 		return freeCollateral.mul(MARGIN_PRECISION).div(new BN(marginRatio));
@@ -1507,7 +1508,8 @@ export class User {
 					market,
 					baseAssetAmount.abs(),
 					marginCategory,
-					this.getUserAccount().maxMarginRatio
+					this.getUserAccount().maxMarginRatio,
+					this.isHighLeverageMode()
 				)
 			);
 
@@ -1972,7 +1974,8 @@ export class User {
 			market,
 			maxSize,
 			marginCategory,
-			this.getUserAccount().maxMarginRatio
+			this.getUserAccount().maxMarginRatio,
+			this.isHighLeverageMode()
 		);
 
 		// use more fesible size since imf factor activated
@@ -1993,7 +1996,8 @@ export class User {
 				market,
 				targetSize,
 				marginCategory,
-				this.getUserAccount().maxMarginRatio
+				this.getUserAccount().maxMarginRatio,
+				this.isHighLeverageMode()
 			);
 			attempts += 1;
 		}
@@ -2154,6 +2158,10 @@ export class User {
 		return (this.getUserAccount().status & UserStatus.BANKRUPT) > 0;
 	}
 
+	public isHighLeverageMode(): boolean {
+		return isVariant(this.getUserAccount().marginMode, 'highLeverage');
+	}
+
 	/**
 	 * Checks if any user position cumulative funding differs from respective market cumulative funding
 	 * @returns
@@ -2443,7 +2451,9 @@ export class User {
 			const marginRatio = calculateMarketMarginRatio(
 				market,
 				baseAssetAmount.abs(),
-				'Maintenance'
+				'Maintenance',
+				this.getUserAccount().maxMarginRatio,
+				this.isHighLeverageMode()
 			);
 
 			return liabilityValue.mul(new BN(marginRatio)).div(MARGIN_PRECISION);
@@ -2488,7 +2498,8 @@ export class User {
 			market,
 			proposedBaseAssetAmount.abs(),
 			marginCategory,
-			this.getUserAccount().maxMarginRatio
+			this.getUserAccount().maxMarginRatio,
+			this.isHighLeverageMode()
 		);
 		const marginRatioQuotePrecision = new BN(marginRatio)
 			.mul(QUOTE_PRECISION)
@@ -2622,7 +2633,8 @@ export class User {
 			targetMarketIndex,
 			baseSize,
 			collateralIndex,
-			this.getUserAccount().maxMarginRatio
+			this.getUserAccount().maxMarginRatio,
+			false // assume user cant be high leverage if they havent created user account ?
 		);
 	}
 
@@ -3771,7 +3783,8 @@ export class User {
 				perpMarket,
 				worstCaseBaseAmount.abs(),
 				marginCategory,
-				this.getUserAccount().maxMarginRatio
+				this.getUserAccount().maxMarginRatio,
+				this.isHighLeverageMode()
 			)
 		);