feat: deposit into iso position ixs

Author: LukasDeco

sdk/src/driftClient.ts

@@ -57,7 +57,6 @@ import {
 	StateAccount,
 	SwapReduceOnly,
 	SignedMsgOrderParamsMessage,
-	TakerInfo,
 	TxParams,
 	UserAccount,
 	UserStatsAccount,
@@ -185,6 +184,8 @@ import nacl from 'tweetnacl';
 import { Slothash } from './slot/SlothashSubscriber';
 import { getOracleId } from './oracles/oracleId';
 import { SignedMsgOrderParams } from './types';
+import { TakerInfo } from './types';
+// BN is already imported globally in this file via other imports
 import { sha256 } from '@noble/hashes/sha256';
 
 type RemainingAccountParams = {
@@ -254,6 +255,69 @@ export class DriftClient {
 		return this._isSubscribed && this.accountSubscriber.isSubscribed;
 	}
 
+	public async getDepositIntoIsolatedPerpPositionIx({
+		perpMarketIndex,
+		amount,
+		spotMarketIndex,
+		subAccountId,
+		userTokenAccount,
+	}: {
+		perpMarketIndex: number;
+		amount: BN;
+		spotMarketIndex?: number; // defaults to perp.quoteSpotMarketIndex
+		subAccountId?: number;
+		userTokenAccount?: PublicKey; // defaults ATA for spot market mint
+	}): Promise<TransactionInstruction> {
+		const user = await this.getUserAccountPublicKey(subAccountId);
+		const userStats = this.getUserStatsAccountPublicKey();
+		const statePk = await this.getStatePublicKey();
+		const perp = this.getPerpMarketAccount(perpMarketIndex);
+		const spotIndex = spotMarketIndex ?? perp.quoteSpotMarketIndex;
+		const spot = this.getSpotMarketAccount(spotIndex);
+
+		const remainingAccounts = this.getRemainingAccounts({
+			userAccounts: [this.getUserAccount(subAccountId)],
+			readablePerpMarketIndex: perpMarketIndex,
+			writableSpotMarketIndexes: [spotIndex],
+		});
+
+		// token program and transfer hook mints need to be present for deposit
+		this.addTokenMintToRemainingAccounts(spot, remainingAccounts);
+		if (this.isTransferHook(spot)) {
+			await this.addExtraAccountMetasToRemainingAccounts(
+				spot.mint,
+				remainingAccounts
+			);
+		}
+
+		const tokenProgram = this.getTokenProgramForSpotMarket(spot);
+		const ata =
+			userTokenAccount ??
+			(await this.getAssociatedTokenAccount(
+				spotIndex,
+				false,
+				tokenProgram
+			));
+
+		return await this.program.instruction.depositIntoIsolatedPerpPosition(
+			spotIndex,
+			perpMarketIndex,
+			amount,
+			{
+				accounts: {
+					state: statePk,
+					user,
+					userStats,
+					authority: this.wallet.publicKey,
+					spotMarketVault: spot.vault,
+					userTokenAccount: ata,
+					tokenProgram,
+				},
+				remainingAccounts,
+			}
+		);
+	}
+
 	public set isSubscribed(val: boolean) {
 		this._isSubscribed = val;
 	}
@@ -717,7 +781,6 @@ export class DriftClient {
 
 		return lookupTableAccount;
 	}
-
 	public async fetchAllLookupTableAccounts(): Promise<
 		AddressLookupTableAccount[]
 	> {
@@ -1495,7 +1558,6 @@ export class DriftClient {
 		const { txSig } = await this.sendTransaction(tx, [], this.opts);
 		return txSig;
 	}
-
 	public async getUpdateUserCustomMarginRatioIx(
 		marginRatio: number,
 		subAccountId = 0
@@ -2196,7 +2258,6 @@ export class DriftClient {
 			this.mustIncludeSpotMarketIndexes.add(spotMarketIndex);
 		});
 	}
-
 	getRemainingAccounts(params: RemainingAccountParams): AccountMeta[] {
 		const { oracleAccountMap, spotMarketAccountMap, perpMarketAccountMap } =
 			this.getRemainingAccountMapsForUsers(params.userAccounts);
@@ -2977,7 +3038,6 @@ export class DriftClient {
 			userAccountPublicKey,
 		};
 	}
-
 	public async createInitializeUserAccountAndDepositCollateral(
 		amount: BN,
 		userTokenAccount: PublicKey,
@@ -3777,7 +3837,6 @@ export class DriftClient {
 			}
 		);
 	}
-
 	public async getRemovePerpLpSharesIx(
 		marketIndex: number,
 		sharesToBurn?: BN,
@@ -3933,7 +3992,8 @@ export class DriftClient {
 		bracketOrdersParams = new Array<OptionalOrderParams>(),
 		referrerInfo?: ReferrerInfo,
 		cancelExistingOrders?: boolean,
-		settlePnl?: boolean
+		settlePnl?: boolean,
+		isolatedPositionDepositAmount?: BN
 	): Promise<{
 		cancelExistingOrdersTx?: Transaction | VersionedTransaction;
 		settlePnlTx?: Transaction | VersionedTransaction;
@@ -3958,10 +4018,32 @@ export class DriftClient {
 
 		const txKeys = Object.keys(ixPromisesForTxs);
 
-		ixPromisesForTxs.marketOrderTx = this.getPlaceOrdersIx(
-			[orderParams, ...bracketOrdersParams],
-			userAccount.subAccountId
-		);
+
+		const preIxs: TransactionInstruction[] = [];
+		if (isVariant(orderParams.marketType, 'perp') && isolatedPositionDepositAmount?.gt?.(ZERO)) {
+			preIxs.push(
+				await this.getDepositIntoIsolatedPerpPositionIx({
+					perpMarketIndex: orderParams.marketIndex,
+					amount: isolatedPositionDepositAmount as BN,
+					subAccountId: userAccount.subAccountId,
+				})
+			);
+		}
+
+
+		ixPromisesForTxs.marketOrderTx = (async () => {
+			const placeOrdersIx = await this.getPlaceOrdersIx(
+				[orderParams, ...bracketOrdersParams],
+				userAccount.subAccountId
+			);
+			if (preIxs.length) {
+				return [
+					...preIxs,
+					placeOrdersIx,
+				] as unknown as TransactionInstruction;
+			}
+			return placeOrdersIx;
+		})();
 
 		/* Cancel open orders in market if requested */
 		if (cancelExistingOrders && isVariant(orderParams.marketType, 'perp')) {
@@ -4076,12 +4158,29 @@ export class DriftClient {
 	public async placePerpOrder(
 		orderParams: OptionalOrderParams,
 		txParams?: TxParams,
-		subAccountId?: number
+		subAccountId?: number,
+		isolatedPositionDepositAmount?: BN
 	): Promise<TransactionSignature> {
+		const preIxs: TransactionInstruction[] = [];
+		if (isolatedPositionDepositAmount?.gt?.(ZERO)) {
+			preIxs.push(
+				await this.getDepositIntoIsolatedPerpPositionIx({
+					perpMarketIndex: orderParams.marketIndex,
+					amount: isolatedPositionDepositAmount as BN,
+					subAccountId,
+				})
+			);
+		}
+
 		const { txSig, slot } = await this.sendTransaction(
 			await this.buildTransaction(
 				await this.getPlacePerpOrderIx(orderParams, subAccountId),
-				txParams
+				txParams,
+				undefined,
+				undefined,
+				undefined,
+				undefined,
+				preIxs
 			),
 			[],
 			this.opts
@@ -4435,6 +4534,7 @@ export class DriftClient {
 			useMarketLastSlotCache: true,
 		});
 
+
 		return await this.program.instruction.cancelOrders(
 			marketType ?? null,
 			marketIndex ?? null,
@@ -4478,7 +4578,8 @@ export class DriftClient {
 		params: OrderParams[],
 		txParams?: TxParams,
 		subAccountId?: number,
-		optionalIxs?: TransactionInstruction[]
+		optionalIxs?: TransactionInstruction[],
+		isolatedPositionDepositAmount?: BN
 	): Promise<TransactionSignature> {
 		const { txSig } = await this.sendTransaction(
 			(
@@ -4500,25 +4601,39 @@ export class DriftClient {
 		params: OrderParams[],
 		txParams?: TxParams,
 		subAccountId?: number,
-		optionalIxs?: TransactionInstruction[]
+		optionalIxs?: TransactionInstruction[],
+		isolatedPositionDepositAmount?: BN
 	) {
 		const lookupTableAccounts = await this.fetchAllLookupTableAccounts();
 
+		const preIxs: TransactionInstruction[] = [];
+		if (params?.length === 1) {
+			const p = params[0];
+			if (isVariant(p.marketType, 'perp') && isolatedPositionDepositAmount?.gt?.(ZERO)) {
+				preIxs.push(
+					await this.getDepositIntoIsolatedPerpPositionIx({
+						perpMarketIndex: p.marketIndex,
+						amount: isolatedPositionDepositAmount as BN,
+						subAccountId,
+					})
+				);
+			}
+		}
+
 		const tx = await this.buildTransaction(
 			await this.getPlaceOrdersIx(params, subAccountId),
 			txParams,
 			undefined,
 			lookupTableAccounts,
 			undefined,
 			undefined,
-			optionalIxs
+			[...preIxs, ...(optionalIxs ?? [])]
 		);
 
 		return {
 			placeOrdersTx: tx,
 		};
 	}
-
 	public async getPlaceOrdersIx(
 		params: OptionalOrderParams[],
 		subAccountId?: number
@@ -5256,7 +5371,6 @@ export class DriftClient {
 
 		return txSig;
 	}
-
 	public async getJupiterSwapIxV6({
 		jupiterClient,
 		outMarketIndex,
@@ -5926,7 +6040,6 @@ export class DriftClient {
 		this.perpMarketLastSlotCache.set(orderParams.marketIndex, slot);
 		return txSig;
 	}
-
 	public async preparePlaceAndTakePerpOrderWithAdditionalOrders(
 		orderParams: OptionalOrderParams,
 		makerInfo?: MakerInfo | MakerInfo[],
@@ -5938,7 +6051,8 @@ export class DriftClient {
 		settlePnl?: boolean,
 		exitEarlyIfSimFails?: boolean,
 		auctionDurationPercentage?: number,
-		optionalIxs?: TransactionInstruction[]
+		optionalIxs?: TransactionInstruction[],
+		isolatedPositionDepositAmount?: BN
 	): Promise<{
 		placeAndTakeTx: Transaction | VersionedTransaction;
 		cancelExistingOrdersTx: Transaction | VersionedTransaction;
@@ -5972,6 +6086,16 @@ export class DriftClient {
 				subAccountId
 			);
 
+			if (isVariant(orderParams.marketType, 'perp') && isolatedPositionDepositAmount?.gt?.(ZERO)) {
+				placeAndTakeIxs.push(
+					await this.getDepositIntoIsolatedPerpPositionIx({
+						perpMarketIndex: orderParams.marketIndex,
+						amount: isolatedPositionDepositAmount as BN,
+						subAccountId,
+					})
+				);
+			}
+
 			placeAndTakeIxs.push(placeAndTakeIx);
 
 			if (bracketOrdersParams.length > 0) {
@@ -5982,6 +6106,11 @@ export class DriftClient {
 				placeAndTakeIxs.push(bracketOrdersIx);
 			}
 
+			// Optional extra ixs can be appended at the front
+			if (optionalIxs?.length) {
+				placeAndTakeIxs.unshift(...optionalIxs);
+			}
+
 			const shouldUseSimulationComputeUnits =
 				txParams?.useSimulatedComputeUnits;
 			const shouldExitIfSimulationFails = exitEarlyIfSimFails;
@@ -6670,7 +6799,6 @@ export class DriftClient {
 		this.spotMarketLastSlotCache.set(QUOTE_SPOT_MARKET_INDEX, slot);
 		return txSig;
 	}
-
 	public async getPlaceAndTakeSpotOrderIx(
 		orderParams: OptionalOrderParams,
 		fulfillmentConfig?: SerumV3FulfillmentConfigAccount,
@@ -7115,7 +7243,6 @@ export class DriftClient {
 			bitFlags?: number;
 			policy?: ModifyOrderPolicy;
 			maxTs?: BN;
-			txParams?: TxParams;
 		},
 		subAccountId?: number
 	): Promise<TransactionInstruction> {
@@ -7454,7 +7581,6 @@ export class DriftClient {
 		this.perpMarketLastSlotCache.set(marketIndex, slot);
 		return txSig;
 	}
-
 	public async getLiquidatePerpIx(
 		userAccountPublicKey: PublicKey,
 		userAccount: UserAccount,
@@ -8245,7 +8371,6 @@ export class DriftClient {
 			}
 		);
 	}
-
 	public async resolveSpotBankruptcy(
 		userAccountPublicKey: PublicKey,
 		userAccount: UserAccount,
@@ -9040,7 +9165,6 @@ export class DriftClient {
 		const { txSig } = await this.sendTransaction(tx, [], this.opts);
 		return txSig;
 	}
-
 	public async getSettleRevenueToInsuranceFundIx(
 		spotMarketIndex: number
 	): Promise<TransactionInstruction> {
@@ -9830,7 +9954,6 @@ export class DriftClient {
 		);
 		return config as ProtectedMakerModeConfig;
 	}
-
 	public async updateUserProtectedMakerOrders(
 		subAccountId: number,
 		protectedOrders: boolean,
@@ -10048,4 +10171,4 @@ export class DriftClient {
 			forceVersionedTransaction,
 		});
 	}
-}
+}

sdk/src/math/position.ts

@@ -119,7 +119,6 @@ export function calculatePositionPNL(
 
 	if (withFunding) {
 		const fundingRatePnL = calculateUnsettledFundingPnl(market, perpPosition);
-
 		pnl = pnl.add(fundingRatePnL);
 	}
 

sdk/src/types.ts

@@ -1209,6 +1209,10 @@ export type OptionalOrderParams = {
 	[Property in keyof OrderParams]?: OrderParams[Property];
 } & NecessaryOrderParams;
 
+export type PerpOrderIsolatedExtras = {
+    isolatedPositionDepositAmount?: BN;
+};
+
 export type ModifyOrderParams = {
 	[Property in keyof OrderParams]?: OrderParams[Property] | null;
 } & { policy?: ModifyOrderPolicy };