@drift-labs/sdk 2.55.0-beta.3 → 2.56.0-beta.0

package/VERSION

@@ -1 +1 @@
-2.55.0-beta.3
+2.56.0-beta.0

package/lib/driftClient.d.ts

@@ -121,7 +121,7 @@ export declare class DriftClient {
     updateUserCustomMarginRatio(updates: {
         marginRatio: number;
         subAccountId: number;
-    }[]): Promise<TransactionSignature>;
+    }[], txParams?: TxParams): Promise<TransactionSignature>;
     getUpdateUserCustomMarginRatioIx(marginRatio: number, subAccountId?: number): Promise<TransactionInstruction>;
     getUpdateUserMarginTradingEnabledIx(marginTradingEnabled: boolean, subAccountId?: number, userAccountPublicKey?: PublicKey): Promise<TransactionInstruction>;
     updateUserMarginTradingEnabled(updates: {
@@ -238,7 +238,7 @@ export declare class DriftClient {
      * @param txParams
      * @returns
      */
-    initializeUserAccountAndDepositCollateral(amount: BN, userTokenAccount: PublicKey, marketIndex?: number, subAccountId?: number, name?: string, fromSubAccountId?: number, referrerInfo?: ReferrerInfo, donateAmount?: BN, txParams?: TxParams): Promise<[TransactionSignature, PublicKey]>;
+    initializeUserAccountAndDepositCollateral(amount: BN, userTokenAccount: PublicKey, marketIndex?: number, subAccountId?: number, name?: string, fromSubAccountId?: number, referrerInfo?: ReferrerInfo, donateAmount?: BN, txParams?: TxParams, customMaxMarginRatio?: number): Promise<[TransactionSignature, PublicKey]>;
     initializeUserAccountForDevnet(subAccountId: number, name: string, marketIndex: number, tokenFaucet: TokenFaucet, amount: BN, referrerInfo?: ReferrerInfo): Promise<[TransactionSignature, PublicKey]>;
     /**
      * Withdraws from a user account. If deposit doesn't already exist, creates a borrow

package/lib/driftClient.js

@@ -540,12 +540,12 @@ class DriftClient {
         const { txSig } = await this.sendTransaction(tx, [], this.opts);
         return txSig;
     }
-    async updateUserCustomMarginRatio(updates) {
+    async updateUserCustomMarginRatio(updates, txParams) {
         const ixs = await Promise.all(updates.map(async ({ marginRatio, subAccountId }) => {
             const ix = await this.getUpdateUserCustomMarginRatioIx(marginRatio, subAccountId);
             return ix;
         }));
-        const tx = await this.buildTransaction(ixs, this.txParams);
+        const tx = await this.buildTransaction(ixs, txParams !== null && txParams !== void 0 ? txParams : this.txParams);
         const { txSig } = await this.sendTransaction(tx, [], this.opts);
         return txSig;
     }
@@ -1092,7 +1092,7 @@ class DriftClient {
      * @param txParams
      * @returns
      */
-    async initializeUserAccountAndDepositCollateral(amount, userTokenAccount, marketIndex = 0, subAccountId = 0, name, fromSubAccountId, referrerInfo, donateAmount, txParams) {
+    async initializeUserAccountAndDepositCollateral(amount, userTokenAccount, marketIndex = 0, subAccountId = 0, name, fromSubAccountId, referrerInfo, donateAmount, txParams, customMaxMarginRatio) {
         var _a;
         const ixs = [];
         const [userAccountPublicKey, initializeUserAccountIx] = await this.getInitializeUserInstructions(subAccountId, name, referrerInfo);
@@ -1140,6 +1140,11 @@ class DriftClient {
             const donateIx = await this.getDepositIntoSpotMarketRevenuePoolIx(1, donateAmount, wsolTokenAccount);
             ixs.push(donateIx);
         }
+        // Set the max margin ratio to initialize account with if passed
+        if (customMaxMarginRatio) {
+            const customMarginRatioIx = await this.getUpdateUserCustomMarginRatioIx(customMaxMarginRatio, subAccountId);
+            ixs.push(customMarginRatioIx);
+        }
         // Close the wrapped sol account at the end of the transaction
         if (createWSOLTokenAccount) {
             ixs.push((0, spl_token_1.createCloseAccountInstruction)(wsolTokenAccount, authority, authority, []));

package/lib/idl/drift.json

@@ -1,5 +1,5 @@
 {
-    "version": "2.54.0",
+    "version": "2.55.0",
     "name": "drift",
     "instructions": [
         {

package/lib/user.d.ts

@@ -85,10 +85,11 @@ export declare class User {
     getPerpBidAsks(marketIndex: number): [BN, BN];
     /**
      * calculates the open bids and asks for an lp
+     * optionally pass in lpShares to see what bid/asks a user *would* take on
      * @returns : lp open bids
      * @returns : lp open asks
      */
-    getLPBidAsks(marketIndex: number): [BN, BN];
+    getLPBidAsks(marketIndex: number, lpShares?: BN): [BN, BN];
     /**
      * calculates the market position if the lp position was settled
      * @returns : the settled userPosition

package/lib/user.js

@@ -227,22 +227,20 @@ class User {
     }
     /**
      * calculates the open bids and asks for an lp
+     * optionally pass in lpShares to see what bid/asks a user *would* take on
      * @returns : lp open bids
      * @returns : lp open asks
      */
-    getLPBidAsks(marketIndex) {
+    getLPBidAsks(marketIndex, lpShares) {
         const position = this.getPerpPosition(marketIndex);
-        if (position === undefined || position.lpShares.eq(numericConstants_1.ZERO)) {
+        const lpSharesToCalc = lpShares !== null && lpShares !== void 0 ? lpShares : position === null || position === void 0 ? void 0 : position.lpShares;
+        if (!lpSharesToCalc || lpSharesToCalc.eq(numericConstants_1.ZERO)) {
             return [numericConstants_1.ZERO, numericConstants_1.ZERO];
         }
         const market = this.driftClient.getPerpMarketAccount(marketIndex);
         const [marketOpenBids, marketOpenAsks] = (0, amm_1.calculateMarketOpenBidAsk)(market.amm.baseAssetReserve, market.amm.minBaseAssetReserve, market.amm.maxBaseAssetReserve, market.amm.orderStepSize);
-        const lpOpenBids = marketOpenBids
-            .mul(position.lpShares)
-            .div(market.amm.sqrtK);
-        const lpOpenAsks = marketOpenAsks
-            .mul(position.lpShares)
-            .div(market.amm.sqrtK);
+        const lpOpenBids = marketOpenBids.mul(lpSharesToCalc).div(market.amm.sqrtK);
+        const lpOpenAsks = marketOpenAsks.mul(lpSharesToCalc).div(market.amm.sqrtK);
         return [lpOpenBids, lpOpenAsks];
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@drift-labs/sdk",
-	"version": "2.55.0-beta.3",
+	"version": "2.56.0-beta.0",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"author": "crispheaney",

package/src/driftClient.ts

@@ -904,7 +904,8 @@ export class DriftClient {
 	}
 
 	public async updateUserCustomMarginRatio(
-		updates: { marginRatio: number; subAccountId: number }[]
+		updates: { marginRatio: number; subAccountId: number }[],
+		txParams?: TxParams
 	): Promise<TransactionSignature> {
 		const ixs = await Promise.all(
 			updates.map(async ({ marginRatio, subAccountId }) => {
@@ -916,7 +917,7 @@ export class DriftClient {
 			})
 		);
 
-		const tx = await this.buildTransaction(ixs, this.txParams);
+		const tx = await this.buildTransaction(ixs, txParams ?? this.txParams);
 
 		const { txSig } = await this.sendTransaction(tx, [], this.opts);
 		return txSig;
@@ -1877,7 +1878,8 @@ export class DriftClient {
 		fromSubAccountId?: number,
 		referrerInfo?: ReferrerInfo,
 		donateAmount?: BN,
-		txParams?: TxParams
+		txParams?: TxParams,
+		customMaxMarginRatio?: number
 	): Promise<[TransactionSignature, PublicKey]> {
 		const ixs = [];
 
@@ -1971,6 +1973,15 @@ export class DriftClient {
 			ixs.push(donateIx);
 		}
 
+		// Set the max margin ratio to initialize account with if passed
+		if (customMaxMarginRatio) {
+			const customMarginRatioIx = await this.getUpdateUserCustomMarginRatioIx(
+				customMaxMarginRatio,
+				subAccountId
+			);
+			ixs.push(customMarginRatioIx);
+		}
+
 		// Close the wrapped sol account at the end of the transaction
 		if (createWSOLTokenAccount) {
 			ixs.push(

package/src/idl/drift.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.54.0",
+  "version": "2.55.0",
   "name": "drift",
   "instructions": [
     {

package/src/user.ts

@@ -388,12 +388,16 @@ export class User {
 
 	/**
 	 * calculates the open bids and asks for an lp
+	 * optionally pass in lpShares to see what bid/asks a user *would* take on
 	 * @returns : lp open bids
 	 * @returns : lp open asks
 	 */
-	public getLPBidAsks(marketIndex: number): [BN, BN] {
+	public getLPBidAsks(marketIndex: number, lpShares?: BN): [BN, BN] {
 		const position = this.getPerpPosition(marketIndex);
-		if (position === undefined || position.lpShares.eq(ZERO)) {
+
+		const lpSharesToCalc = lpShares ?? position?.lpShares;
+
+		if (!lpSharesToCalc || lpSharesToCalc.eq(ZERO)) {
 			return [ZERO, ZERO];
 		}
 
@@ -405,12 +409,8 @@ export class User {
 			market.amm.orderStepSize
 		);
 
-		const lpOpenBids = marketOpenBids
-			.mul(position.lpShares)
-			.div(market.amm.sqrtK);
-		const lpOpenAsks = marketOpenAsks
-			.mul(position.lpShares)
-			.div(market.amm.sqrtK);
+		const lpOpenBids = marketOpenBids.mul(lpSharesToCalc).div(market.amm.sqrtK);
+		const lpOpenAsks = marketOpenAsks.mul(lpSharesToCalc).div(market.amm.sqrtK);
 
 		return [lpOpenBids, lpOpenAsks];
 	}