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

package/src/constants/numericConstants.ts

@@ -83,6 +83,7 @@ export const AMM_TIMES_PEG_TO_QUOTE_PRECISION_RATIO =
 export const MARGIN_PRECISION = TEN_THOUSAND;
 export const BID_ASK_SPREAD_PRECISION = new BN(1000000); // 10^6
 export const LIQUIDATION_PCT_PRECISION = TEN_THOUSAND;
+export const FUNDING_RATE_OFFSET_DENOMINATOR = new BN(5000);
 
 export const FIVE_MINUTE = new BN(60 * 5);
 export const ONE_HOUR = new BN(60 * 60);

package/src/dlob/DLOB.ts

@@ -73,6 +73,14 @@ export type MarketNodeLists = {
 
 type OrderBookCallback = () => void;
 
+/**
+ *  Receives a DLOBNode and is expected to return true if the node should
+ *  be taken into account when generating, or false otherwise.
+ *
+ * Currently used in getRestingLimitBids and getRestingLimitAsks.
+ */
+export type DLOBFilterFcn = (node: DLOBNode) => boolean;
+
 export type NodeToFill = {
 	node: DLOBNode;
 	makerNodes: DLOBNode[];
@@ -1065,7 +1073,8 @@ export class DLOB {
 			currentDLOBNode: DLOBNode,
 			slot: number,
 			oraclePriceData: OraclePriceData
-		) => boolean
+		) => boolean,
+		filterFcn?: DLOBFilterFcn
 	): Generator<DLOBNode> {
 		const generators = generatorList.map((generator) => {
 			return {
@@ -1102,6 +1111,11 @@ export class DLOB {
 					continue;
 				}
 
+				if (filterFcn && filterFcn(bestGenerator.next.value)) {
+					bestGenerator.next = bestGenerator.generator.next();
+					continue;
+				}
+
 				yield bestGenerator.next.value;
 				bestGenerator.next = bestGenerator.generator.next();
 			} else {
@@ -1114,7 +1128,8 @@ export class DLOB {
 		marketIndex: number,
 		slot: number,
 		marketType: MarketType,
-		oraclePriceData: OraclePriceData
+		oraclePriceData: OraclePriceData,
+		filterFcn?: DLOBFilterFcn
 	): Generator<DLOBNode> {
 		if (isVariant(marketType, 'spot') && !oraclePriceData) {
 			throw new Error('Must provide OraclePriceData to get spot asks');
@@ -1142,46 +1157,17 @@ export class DLOB {
 				return bestNode
 					.getPrice(oraclePriceData, slot)
 					.lt(currentNode.getPrice(oraclePriceData, slot));
-			}
+			},
+			filterFcn
 		);
 	}
 
-	/**
-	 * Filters the limit asks that are resting and do not cross fallback bid
-	 * Taking orders can only fill against orders that meet this criteria
-	 *
-	 * @returns
-	 */
-	*getMakerLimitAsks(
-		marketIndex: number,
-		slot: number,
-		marketType: MarketType,
-		oraclePriceData: OraclePriceData,
-		fallbackBid?: BN
-	): Generator<DLOBNode> {
-		const isPerpMarket = isVariant(marketType, 'perp');
-		for (const node of this.getRestingLimitAsks(
-			marketIndex,
-			slot,
-			marketType,
-			oraclePriceData
-		)) {
-			if (
-				isPerpMarket &&
-				fallbackBid &&
-				node.getPrice(oraclePriceData, slot).lte(fallbackBid)
-			) {
-				continue;
-			}
-			yield node;
-		}
-	}
-
 	*getRestingLimitBids(
 		marketIndex: number,
 		slot: number,
 		marketType: MarketType,
-		oraclePriceData: OraclePriceData
+		oraclePriceData: OraclePriceData,
+		filterFcn?: DLOBFilterFcn
 	): Generator<DLOBNode> {
 		if (isVariant(marketType, 'spot') && !oraclePriceData) {
 			throw new Error('Must provide OraclePriceData to get spot bids');
@@ -1209,41 +1195,11 @@ export class DLOB {
 				return bestNode
 					.getPrice(oraclePriceData, slot)
 					.gt(currentNode.getPrice(oraclePriceData, slot));
-			}
+			},
+			filterFcn
 		);
 	}
 
-	/**
-	 * Filters the limit bids that are post only, have been place for sufficiently long or are below the fallback ask
-	 * Market orders can only fill against orders that meet this criteria
-	 *
-	 * @returns
-	 */
-	*getMakerLimitBids(
-		marketIndex: number,
-		slot: number,
-		marketType: MarketType,
-		oraclePriceData: OraclePriceData,
-		fallbackAsk?: BN
-	): Generator<DLOBNode> {
-		const isPerpMarket = isVariant(marketType, 'perp');
-		for (const node of this.getRestingLimitBids(
-			marketIndex,
-			slot,
-			marketType,
-			oraclePriceData
-		)) {
-			if (
-				isPerpMarket &&
-				fallbackAsk &&
-				node.getPrice(oraclePriceData, slot).gte(fallbackAsk)
-			) {
-				continue;
-			}
-			yield node;
-		}
-	}
-
 	*getAsks(
 		marketIndex: number,
 		fallbackAsk: BN | undefined,

package/src/driftClient.ts

@@ -539,6 +539,10 @@ export class DriftClient {
 		this.activeSubAccountId = activeSubAccountId;
 		this.userStatsAccountPublicKey = undefined;
 		this.includeDelegates = includeDelegates ?? false;
+		const walletSupportsVersionedTxns =
+			//@ts-ignore
+			this.wallet.supportedTransactionVersions?.size ?? 0 > 1;
+		this.txVersion = walletSupportsVersionedTxns ? 0 : 'legacy';
 
 		if (includeDelegates && subAccountIds) {
 			throw new Error(
@@ -588,13 +592,30 @@ export class DriftClient {
 		return success;
 	}
 
-	public switchActiveUser(subAccountId: number, authority?: PublicKey) {
+	public async switchActiveUser(subAccountId: number, authority?: PublicKey) {
+		const authorityChanged = authority && !this.authority?.equals(authority);
+
 		this.activeSubAccountId = subAccountId;
 		this.authority = authority ?? this.authority;
 		this.userStatsAccountPublicKey = getUserStatsAccountPublicKey(
 			this.program.programId,
 			this.authority
 		);
+
+		/* If changing the user authority ie switching from delegate to non-delegate account, need to re-subscribe to the user stats account */
+		if (authorityChanged) {
+			if (this.userStats && this.userStats.isSubscribed) {
+				await this.userStats.unsubscribe();
+			}
+
+			this.userStats = new UserStats({
+				driftClient: this,
+				userStatsAccountPublicKey: this.userStatsAccountPublicKey,
+				accountSubscription: this.userAccountSubscriptionConfig,
+			});
+
+			this.userStats.subscribe();
+		}
 	}
 
 	public async addUser(
@@ -854,21 +875,48 @@ export class DriftClient {
 	}
 
 	public async updateUserCustomMarginRatio(
+		updates: { marginRatio: number; subAccountId: number }[]
+	): Promise<TransactionSignature> {
+		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 { txSig } = await this.sendTransaction(tx, [], this.opts);
+		return txSig;
+	}
+
+	public async getUpdateUserCustomMarginRatioIx(
 		marginRatio: number,
 		subAccountId = 0
-	): Promise<TransactionSignature> {
-		const tx = await this.program.transaction.updateUserCustomMarginRatio(
+	): Promise<TransactionInstruction> {
+		const userAccountPublicKey = getUserAccountPublicKeySync(
+			this.program.programId,
+			this.wallet.publicKey,
+			subAccountId
+		);
+
+		await this.addUser(subAccountId, this.wallet.publicKey);
+
+		const ix = this.program.instruction.updateUserCustomMarginRatio(
 			subAccountId,
 			marginRatio,
 			{
 				accounts: {
-					user: await this.getUserAccountPublicKey(),
+					user: userAccountPublicKey,
 					authority: this.wallet.publicKey,
 				},
 			}
 		);
-		const { txSig } = await this.sendTransaction(tx, [], this.opts);
-		return txSig;
+
+		return ix;
 	}
 
 	public async getUpdateUserMarginTradingEnabledIx(
@@ -909,31 +957,18 @@ export class DriftClient {
 	}
 
 	public async updateUserMarginTradingEnabled(
-		marginTradingEnabled: boolean,
-		subAccountId = 0
+		updates: { marginTradingEnabled: boolean; subAccountId: number }[]
 	): Promise<TransactionSignature> {
-		const userAccountPublicKey = getUserAccountPublicKeySync(
-			this.program.programId,
-			this.wallet.publicKey,
-			subAccountId
+		const ixs = await Promise.all(
+			updates.map(async ({ marginTradingEnabled, subAccountId }) => {
+				return await this.getUpdateUserMarginTradingEnabledIx(
+					marginTradingEnabled,
+					subAccountId
+				);
+			})
 		);
 
-		await this.addUser(subAccountId, this.wallet.publicKey);
-		const remainingAccounts = this.getRemainingAccounts({
-			userAccounts: [this.getUserAccount(subAccountId)],
-		});
-
-		const tx = await this.program.transaction.updateUserMarginTradingEnabled(
-			subAccountId,
-			marginTradingEnabled,
-			{
-				accounts: {
-					user: userAccountPublicKey,
-					authority: this.wallet.publicKey,
-				},
-				remainingAccounts,
-			}
-		);
+		const tx = await this.buildTransaction(ixs, this.txParams);
 
 		const { txSig } = await this.sendTransaction(tx, [], this.opts);
 		return txSig;
@@ -1557,13 +1592,6 @@ export class DriftClient {
 		subAccountId?: number,
 		reduceOnly = false
 	): Promise<TransactionSignature> {
-		const tx = new Transaction();
-		tx.add(
-			ComputeBudgetProgram.setComputeUnitLimit({
-				units: 600_000,
-			})
-		);
-
 		const additionalSigners: Array<Signer> = [];
 
 		const spotMarketAccount = this.getSpotMarketAccount(marketIndex);
@@ -1575,6 +1603,8 @@ export class DriftClient {
 		const createWSOLTokenAccount =
 			isSolMarket && associatedTokenAccount.equals(signerAuthority);
 
+		const instructions = [];
+
 		if (createWSOLTokenAccount) {
 			const { ixs, pubkey } = await this.getWrappedSolAccountCreationIxs(
 				amount,
@@ -1583,9 +1613,7 @@ export class DriftClient {
 
 			associatedTokenAccount = pubkey;
 
-			ixs.forEach((ix) => {
-				tx.add(ix);
-			});
+			instructions.push(...ixs);
 		}
 
 		const depositCollateralIx = await this.getDepositInstruction(
@@ -1597,11 +1625,11 @@ export class DriftClient {
 			true
 		);
 
-		tx.add(depositCollateralIx);
+		instructions.push(depositCollateralIx);
 
 		// Close the wrapped sol account at the end of the transaction
 		if (createWSOLTokenAccount) {
-			tx.add(
+			instructions.push(
 				createCloseAccountInstruction(
 					associatedTokenAccount,
 					signerAuthority,
@@ -1611,6 +1639,10 @@ export class DriftClient {
 			);
 		}
 
+		const txParams = { ...this.txParams, computeUnits: 600_000 };
+
+		const tx = await this.buildTransaction(instructions, txParams);
+
 		const { txSig, slot } = await this.sendTransaction(
 			tx,
 			additionalSigners,
@@ -2425,8 +2457,7 @@ export class DriftClient {
 		makerInfo?: MakerInfo | MakerInfo[],
 		txParams?: TxParams,
 		bracketOrdersParams = new Array<OptionalOrderParams>(),
-		referrerInfo?: ReferrerInfo,
-		useVersionedTx = true
+		referrerInfo?: ReferrerInfo
 	): Promise<{ txSig: TransactionSignature; signedFillTx: Transaction }> {
 		const marketIndex = orderParams.marketIndex;
 		const orderId = userAccount.nextOrderId;
@@ -2452,12 +2483,8 @@ export class DriftClient {
 			referrerInfo
 		);
 
-		const walletSupportsVersionedTxns =
-			//@ts-ignore
-			this.wallet.supportedTransactionVersions?.size ?? 0 > 1;
-
 		// use versioned transactions if there is a lookup table account and wallet is compatible
-		if (walletSupportsVersionedTxns && useVersionedTx) {
+		if (this.txVersion === 0) {
 			const versionedMarketOrderTx = await this.buildTransaction(
 				[placePerpOrderIx].concat(bracketOrderIxs),
 				txParams,
@@ -5835,17 +5862,16 @@ export class DriftClient {
 		opts?: ConfirmOptions,
 		preSigned?: boolean
 	): Promise<TxSigAndSlot> {
-		// @ts-ignore
-		if (!tx.message) {
-			return this.txSender.send(
-				tx as Transaction,
+		if (tx instanceof VersionedTransaction) {
+			return this.txSender.sendVersionedTransaction(
+				tx as VersionedTransaction,
 				additionalSigners,
 				opts,
 				preSigned
 			);
 		} else {
-			return this.txSender.sendVersionedTransaction(
-				tx as VersionedTransaction,
+			return this.txSender.send(
+				tx as Transaction,
 				additionalSigners,
 				opts,
 				preSigned

package/src/math/funding.ts

@@ -5,6 +5,7 @@ import {
 	QUOTE_PRECISION,
 	ZERO,
 	ONE,
+	FUNDING_RATE_OFFSET_DENOMINATOR,
 } from '../constants/numericConstants';
 import { PerpMarketAccount, isVariant } from '../types';
 import { OraclePriceData } from '../oracles/types';
@@ -156,7 +157,11 @@ export async function calculateAllEstimatedFundingRate(
 	// }
 
 	const twapSpread = markTwap.sub(oracleTwap);
-	const twapSpreadPct = twapSpread
+	const twapSpreadWithOffset = twapSpread.add(
+		oracleTwap.abs().div(FUNDING_RATE_OFFSET_DENOMINATOR)
+	);
+
+	const twapSpreadPct = twapSpreadWithOffset
 		.mul(PRICE_PRECISION)
 		.mul(new BN(100))
 		.div(oracleTwap);

package/src/math/market.ts

@@ -129,17 +129,22 @@ export function calculateOracleSpread(
 export function calculateMarketMarginRatio(
 	market: PerpMarketAccount,
 	size: BN,
-	marginCategory: MarginCategory
+	marginCategory: MarginCategory,
+	customMarginRatio = 0
 ): number {
 	let marginRatio;
 	switch (marginCategory) {
 		case 'Initial': {
-			marginRatio = calculateSizePremiumLiabilityWeight(
-				size,
-				new BN(market.imfFactor),
-				new BN(market.marginRatioInitial),
-				MARGIN_PRECISION
-			).toNumber();
+			// use lowest leverage between max allowed and optional user custom max
+			marginRatio = Math.max(
+				calculateSizePremiumLiabilityWeight(
+					size,
+					new BN(market.imfFactor),
+					new BN(market.marginRatioInitial),
+					MARGIN_PRECISION
+				).toNumber(),
+				customMarginRatio
+			);
 			break;
 		}
 		case 'Maintenance': {

package/src/math/spotMarket.ts

@@ -24,8 +24,11 @@ export function calculateSpotMarketMarginRatio(
 	oraclePrice: BN,
 	marginCategory: MarginCategory,
 	size: BN,
-	balanceType: SpotBalanceType
+	balanceType: SpotBalanceType,
+	customMarginRatio = 0
 ): number {
+	let marginRatio;
+
 	if (isVariant(balanceType, 'deposit')) {
 		const assetWeight = calculateAssetWeight(
 			size,
@@ -33,13 +36,20 @@ export function calculateSpotMarketMarginRatio(
 			market,
 			marginCategory
 		);
-		return MARGIN_PRECISION.sub(assetWeight).toNumber();
+		marginRatio = MARGIN_PRECISION.sub(assetWeight).toNumber();
 	} else {
 		const liabilityWeight = calculateLiabilityWeight(
 			size,
 			market,
 			marginCategory
 		);
-		return liabilityWeight.sub(MARGIN_PRECISION).toNumber();
+		marginRatio = liabilityWeight.sub(MARGIN_PRECISION).toNumber();
+	}
+
+	if (marginCategory === 'Initial') {
+		// use lowest leverage between max allowed and optional user custom max
+		return Math.max(marginRatio, customMarginRatio);
 	}
+
+	return marginRatio;
 }

package/src/math/spotPosition.ts

@@ -1,5 +1,6 @@
 import { MarginCategory, SpotMarketAccount, SpotPosition } from '../types';
 import {
+	QUOTE_SPOT_MARKET_INDEX,
 	SPOT_MARKET_WEIGHT_PRECISION,
 	ZERO,
 } from '../constants/numericConstants';
@@ -31,7 +32,8 @@ export function getWorstCaseTokenAmounts(
 	spotPosition: SpotPosition,
 	spotMarketAccount: SpotMarketAccount,
 	strictOraclePrice: StrictOraclePrice,
-	marginCategory: MarginCategory
+	marginCategory: MarginCategory,
+	customMarginRatio?: number
 ): OrderFillSimulation {
 	const tokenAmount = getSignedTokenAmount(
 		getTokenAmount(
@@ -54,7 +56,8 @@ export function getWorstCaseTokenAmounts(
 			tokenValue,
 			strictOraclePrice.current,
 			spotMarketAccount,
-			marginCategory
+			marginCategory,
+			customMarginRatio
 		);
 		return {
 			tokenAmount,
@@ -72,7 +75,8 @@ export function getWorstCaseTokenAmounts(
 		spotPosition.openBids,
 		strictOraclePrice,
 		spotMarketAccount,
-		marginCategory
+		marginCategory,
+		customMarginRatio
 	);
 	const asksSimulation = simulateOrderFill(
 		tokenAmount,
@@ -80,7 +84,8 @@ export function getWorstCaseTokenAmounts(
 		spotPosition.openAsks,
 		strictOraclePrice,
 		spotMarketAccount,
-		marginCategory
+		marginCategory,
+		customMarginRatio
 	);
 
 	if (
@@ -99,7 +104,8 @@ export function calculateWeightedTokenValue(
 	tokenValue: BN,
 	oraclePrice: BN,
 	spotMarket: SpotMarketAccount,
-	marginCategory: MarginCategory
+	marginCategory: MarginCategory,
+	customMarginRatio?: number
 ): { weight: BN; weightedTokenValue: BN } {
 	let weight: BN;
 	if (tokenValue.gte(ZERO)) {
@@ -117,6 +123,20 @@ export function calculateWeightedTokenValue(
 		);
 	}
 
+	if (
+		marginCategory === 'Initial' &&
+		customMarginRatio &&
+		spotMarket.marketIndex !== QUOTE_SPOT_MARKET_INDEX
+	) {
+		const userCustomAssetWeight = tokenValue.gte(ZERO)
+			? BN.max(ZERO, SPOT_MARKET_WEIGHT_PRECISION.subn(customMarginRatio))
+			: SPOT_MARKET_WEIGHT_PRECISION.addn(customMarginRatio);
+
+		weight = tokenValue.gte(ZERO)
+			? BN.min(weight, userCustomAssetWeight)
+			: BN.max(weight, userCustomAssetWeight);
+	}
+
 	return {
 		weight: weight,
 		weightedTokenValue: tokenValue
@@ -131,7 +151,8 @@ export function simulateOrderFill(
 	openOrders: BN,
 	strictOraclePrice: StrictOraclePrice,
 	spotMarket: SpotMarketAccount,
-	marginCategory: MarginCategory
+	marginCategory: MarginCategory,
+	customMarginRatio?: number
 ): OrderFillSimulation {
 	const ordersValue = getTokenValue(openOrders.neg(), spotMarket.decimals, {
 		price: strictOraclePrice.max(),
@@ -145,7 +166,8 @@ export function simulateOrderFill(
 			tokenValueAfterFill,
 			strictOraclePrice.current,
 			spotMarket,
-			marginCategory
+			marginCategory,
+			customMarginRatio
 		);
 
 	const freeCollateralContribution =

package/src/types.ts

@@ -200,6 +200,8 @@ export class StakeAction {
 	static readonly UNSTAKE_REQUEST = { unstakeRequest: {} };
 	static readonly UNSTAKE_CANCEL_REQUEST = { unstakeCancelRequest: {} };
 	static readonly UNSTAKE = { unstake: {} };
+	static readonly UNSTAKE_TRANSFER = { unstakeTransfer: {} };
+	static readonly STAKE_TRANSFER = { stakeTransfer: {} };
 }
 
 export function isVariant(object: unknown, type: string) {