@drift-labs/sdk 2.31.1-beta.1 → 2.31.1-beta.10

package/lib/user.js

@@ -12,6 +12,7 @@ const pollingUserAccountSubscriber_1 = require("./accounts/pollingUserAccountSub
 const webSocketUserAccountSubscriber_1 = require("./accounts/webSocketUserAccountSubscriber");
 const spotPosition_1 = require("./math/spotPosition");
 const oracles_1 = require("./math/oracles");
+const tiers_1 = require("./math/tiers");
 class User {
     get isSubscribed() {
         return this._isSubscribed && this.accountSubscriber.isSubscribed;
@@ -20,13 +21,16 @@ class User {
         this._isSubscribed = val;
     }
     constructor(config) {
-        var _a;
+        var _a, _b;
         this._isSubscribed = false;
         this.driftClient = config.driftClient;
         this.userAccountPublicKey = config.userAccountPublicKey;
         if (((_a = config.accountSubscription) === null || _a === void 0 ? void 0 : _a.type) === 'polling') {
             this.accountSubscriber = new pollingUserAccountSubscriber_1.PollingUserAccountSubscriber(config.driftClient.program, config.userAccountPublicKey, config.accountSubscription.accountLoader);
         }
+        else if (((_b = config.accountSubscription) === null || _b === void 0 ? void 0 : _b.type) === 'custom') {
+            this.accountSubscriber = config.accountSubscription.userAccountSubscriber;
+        }
         else {
             this.accountSubscriber = new webSocketUserAccountSubscriber_1.WebSocketUserAccountSubscriber(config.driftClient.program, config.userAccountPublicKey);
         }
@@ -176,7 +180,9 @@ class User {
      * @returns : pnl from settle
      */
     getPerpPositionWithLPSettle(marketIndex, originalPosition) {
-        originalPosition = originalPosition !== null && originalPosition !== void 0 ? originalPosition : this.getPerpPosition(marketIndex);
+        var _a;
+        originalPosition =
+            (_a = originalPosition !== null && originalPosition !== void 0 ? originalPosition : this.getPerpPosition(marketIndex)) !== null && _a !== void 0 ? _a : this.getEmptyPosition(marketIndex);
         if (originalPosition.lpShares.eq(numericConstants_1.ZERO)) {
             return [originalPosition, numericConstants_1.ZERO, numericConstants_1.ZERO];
         }
@@ -228,7 +234,7 @@ class User {
         let pnl;
         if (updateType == 'open' || updateType == 'increase') {
             newQuoteEntry = position.quoteEntryAmount.add(deltaQaa);
-            pnl = 0;
+            pnl = numericConstants_1.ZERO;
         }
         else if (updateType == 'reduce' || updateType == 'close') {
             newQuoteEntry = position.quoteEntryAmount.sub(position.quoteEntryAmount
@@ -305,6 +311,9 @@ class User {
             !(pos.openOrders == 0) ||
             !pos.lpShares.eq(numericConstants_1.ZERO));
     }
+    getActiveSpotPositions() {
+        return this.getUserAccount().spotPositions.filter((pos) => !(0, spotPosition_1.isSpotPositionAvailable)(pos));
+    }
     /**
      * calculates unrealized position price pnl
      * @returns : Precision QUOTE_PRECISION
@@ -601,7 +610,8 @@ class User {
      * @returns : Precision QUOTE_PRECISION
      */
     getPerpPositionValue(marketIndex, oraclePriceData, includeOpenOrders = false) {
-        const userPosition = this.getPerpPosition(marketIndex) || this.getEmptyPosition(marketIndex);
+        const userPosition = this.getPerpPositionWithLPSettle(marketIndex)[0] ||
+            this.getEmptyPosition(marketIndex);
         const market = this.driftClient.getPerpMarketAccount(userPosition.marketIndex);
         return (0, margin_1.calculateBaseAssetValueWithOracle)(market, userPosition, oraclePriceData, includeOpenOrders);
     }
@@ -775,12 +785,16 @@ class User {
         const totalCollateral = this.getTotalCollateral('Maintenance');
         // if user being liq'd, can continue to be liq'd until total collateral above the margin requirement plus buffer
         let liquidationBuffer = undefined;
-        const isBeingLiquidated = (0, types_1.isVariant)(this.getUserAccount().status, 'beingLiquidated');
-        if (isBeingLiquidated) {
+        if (this.isBeingLiquidated()) {
             liquidationBuffer = new _1.BN(this.driftClient.getStateAccount().liquidationMarginBufferRatio);
         }
-        const maintenanceRequirement = this.getMaintenanceMarginRequirement(liquidationBuffer);
-        return totalCollateral.lt(maintenanceRequirement);
+        const marginRequirement = this.getMaintenanceMarginRequirement(liquidationBuffer);
+        const canBeLiquidated = totalCollateral.lt(marginRequirement);
+        return {
+            canBeLiquidated,
+            marginRequirement,
+            totalCollateral,
+        };
     }
     isBeingLiquidated() {
         return (0, types_1.isOneOfVariant)(this.getUserAccount().status, [
@@ -1281,6 +1295,23 @@ class User {
         }
         return true;
     }
+    getSafestTiers() {
+        let safestPerpTier = 4;
+        let safestSpotTier = 4;
+        for (const perpPosition of this.getActivePerpPositions()) {
+            safestPerpTier = Math.min(safestPerpTier, (0, tiers_1.getPerpMarketTierNumber)(this.driftClient.getPerpMarketAccount(perpPosition.marketIndex)));
+        }
+        for (const spotPosition of this.getActiveSpotPositions()) {
+            if ((0, types_1.isVariant)(spotPosition.balanceType, 'deposit')) {
+                continue;
+            }
+            safestSpotTier = Math.min(safestSpotTier, (0, tiers_1.getSpotMarketTierNumber)(this.driftClient.getSpotMarketAccount(spotPosition.marketIndex)));
+        }
+        return {
+            perpTier: safestPerpTier,
+            spotTier: safestSpotTier,
+        };
+    }
     /**
      * Get the total position value, excluding any position coming from the given target market
      * @param marketToIgnore

package/lib/userConfig.d.ts

@@ -1,6 +1,7 @@
 import { DriftClient } from './driftClient';
 import { PublicKey } from '@solana/web3.js';
 import { BulkAccountLoader } from './accounts/bulkAccountLoader';
+import { UserAccountSubscriber } from './accounts/types';
 export type UserConfig = {
     accountSubscription?: UserSubscriptionConfig;
     driftClient: DriftClient;
@@ -11,4 +12,7 @@ export type UserSubscriptionConfig = {
 } | {
     type: 'polling';
     accountLoader: BulkAccountLoader;
+} | {
+    type: 'custom';
+    userAccountSubscriber: UserAccountSubscriber;
 };

package/lib/userStats.js

@@ -7,12 +7,15 @@ const webSocketUserStatsAccountSubsriber_1 = require("./accounts/webSocketUserSt
 const pda_1 = require("./addresses/pda");
 class UserStats {
     constructor(config) {
-        var _a;
+        var _a, _b;
         this.driftClient = config.driftClient;
         this.userStatsAccountPublicKey = config.userStatsAccountPublicKey;
         if (((_a = config.accountSubscription) === null || _a === void 0 ? void 0 : _a.type) === 'polling') {
             this.accountSubscriber = new pollingUserStatsAccountSubscriber_1.PollingUserStatsAccountSubscriber(config.driftClient.program, config.userStatsAccountPublicKey, config.accountSubscription.accountLoader);
         }
+        else if (((_b = config.accountSubscription) === null || _b === void 0 ? void 0 : _b.type) === 'custom') {
+            throw new Error('Custom account subscription not yet implemented for user stats');
+        }
         else {
             this.accountSubscriber = new webSocketUserStatsAccountSubsriber_1.WebSocketUserStatsAccountSubscriber(config.driftClient.program, config.userStatsAccountPublicKey);
         }

package/lib/userStatsConfig.d.ts

@@ -11,4 +11,6 @@ export type UserStatsSubscriptionConfig = {
 } | {
     type: 'polling';
     accountLoader: BulkAccountLoader;
+} | {
+    type: 'custom';
 };

package/package.json

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

package/src/accounts/mockUserAccountSubscriber.ts

@@ -0,0 +1,53 @@
+import { DataAndSlot, UserAccountEvents, UserAccountSubscriber } from './types';
+import { PublicKey } from '@solana/web3.js';
+import StrictEventEmitter from 'strict-event-emitter-types';
+import { EventEmitter } from 'events';
+import { UserAccount } from '../types';
+
+export class MockUserAccountSubscriber implements UserAccountSubscriber {
+	isSubscribed: boolean;
+	eventEmitter: StrictEventEmitter<EventEmitter, UserAccountEvents>;
+	userAccountPublicKey: PublicKey;
+
+	callbackId?: string;
+	errorCallbackId?: string;
+
+	user: DataAndSlot<UserAccount>;
+
+	public constructor(
+		userAccountPublicKey: PublicKey,
+		data: UserAccount,
+		slot: number
+	) {
+		this.isSubscribed = true;
+		this.eventEmitter = new EventEmitter();
+		this.userAccountPublicKey = userAccountPublicKey;
+		this.user = { data, slot };
+	}
+
+	async subscribe(_userAccount?: UserAccount): Promise<boolean> {
+		return true;
+	}
+
+	async addToAccountLoader(): Promise<void> {}
+
+	async fetch(): Promise<void> {}
+
+	doesAccountExist(): boolean {
+		return this.user !== undefined;
+	}
+
+	async unsubscribe(): Promise<void> {}
+
+	assertIsSubscribed(): void {}
+
+	public getUserAccountAndSlot(): DataAndSlot<UserAccount> {
+		return this.user;
+	}
+
+	public updateData(userAccount: UserAccount, slot: number): void {
+		this.user = { data: userAccount, slot };
+		this.eventEmitter.emit('userAccountUpdate', userAccount);
+		this.eventEmitter.emit('update');
+	}
+}

package/src/config.ts

@@ -131,7 +131,7 @@ export async function findAllMarketAndOracles(program: Program): Promise<{
 		(await program.account.spotMarket.all()) as ProgramAccount<SpotMarketAccount>[];
 
 	for (const perpMarketProgramAccount of perpMarketProgramAccounts) {
-		const perpMarket = perpMarketProgramAccount.account;
+		const perpMarket = perpMarketProgramAccount.account as PerpMarketAccount;
 		perpMarketIndexes.push(perpMarket.marketIndex);
 		oracleInfos.set(perpMarket.amm.oracle.toString(), {
 			publicKey: perpMarket.amm.oracle,
@@ -140,7 +140,7 @@ export async function findAllMarketAndOracles(program: Program): Promise<{
 	}
 
 	for (const spotMarketProgramAccount of spotMarketProgramAccounts) {
-		const spotMarket = spotMarketProgramAccount.account;
+		const spotMarket = spotMarketProgramAccount.account as SpotMarketAccount;
 		spotMarketIndexes.push(spotMarket.marketIndex);
 		oracleInfos.set(spotMarket.oracle.toString(), {
 			publicKey: spotMarket.oracle,

package/src/constants/perpMarkets.ts

@@ -134,6 +134,16 @@ export const DevnetPerpMarkets: PerpMarketConfig[] = [
 		launchTs: 1683125906000,
 		oracleSource: OracleSource.PYTH,
 	},
+	{
+		fullName: 'RNDR',
+		category: ['Infra'],
+		symbol: 'RNDR-PERP',
+		baseAssetSymbol: 'RNDR',
+		marketIndex: 12,
+		oracle: new PublicKey('C2QvUPBiU3fViSyqA4nZgGyYqLgYf9PRpd8B8oLoo48w'),
+		launchTs: 1683125906000,
+		oracleSource: OracleSource.PYTH,
+	},
 ];
 
 export const MainnetPerpMarkets: PerpMarketConfig[] = [
@@ -257,6 +267,16 @@ export const MainnetPerpMarkets: PerpMarketConfig[] = [
 		launchTs: 1683125906000,
 		oracleSource: OracleSource.PYTH,
 	},
+	{
+		fullName: 'RNDR',
+		category: ['Infra'],
+		symbol: 'RNDR-PERP',
+		baseAssetSymbol: 'RNDR',
+		marketIndex: 12,
+		oracle: new PublicKey('CYGfrBJB9HgLf9iZyN4aH5HvUAi2htQ4MjPxeXMf4Egn'),
+		launchTs: 1683125906000,
+		oracleSource: OracleSource.PYTH,
+	},
 ];
 
 export const PerpMarkets: { [key in DriftEnv]: PerpMarketConfig[] } = {

package/src/driftClient.ts

@@ -95,6 +95,7 @@ import {
 	PRICE_PRECISION,
 	QUOTE_SPOT_MARKET_INDEX,
 	ZERO,
+	QUOTE_PRECISION,
 } from './constants/numericConstants';
 import { findDirectionToClose, positionIsAvailable } from './math/position';
 import { getSignedTokenAmount, getTokenAmount } from './math/spotBalance';
@@ -115,6 +116,7 @@ import { fetchUserStatsAccount } from './accounts/fetch';
 import { castNumberToSpotPrecision } from './math/spotMarket';
 import { JupiterClient, Route, SwapMode } from './jupiter/jupiterClient';
 import { getNonIdleUserFilter } from './memcmp';
+import { UserStatsSubscriptionConfig } from './userStatsConfig';
 
 type RemainingAccountParams = {
 	userAccounts: UserAccount[];
@@ -139,6 +141,7 @@ export class DriftClient {
 	userStats?: UserStats;
 	activeSubAccountId: number;
 	userAccountSubscriptionConfig: UserSubscriptionConfig;
+	userStatsAccountSubscriptionConfig: UserStatsSubscriptionConfig;
 	accountSubscriber: DriftClientAccountSubscriber;
 	eventEmitter: StrictEventEmitter<EventEmitter, DriftClientAccountEvents>;
 	_isSubscribed = false;
@@ -152,6 +155,7 @@ export class DriftClient {
 	authoritySubAccountMap?: Map<string, number[]>;
 	skipLoadUsers?: boolean;
 	txVersion: TransactionVersion;
+	txParams: TxParams;
 
 	public get isSubscribed() {
 		return this._isSubscribed && this.accountSubscriber.isSubscribed;
@@ -180,6 +184,10 @@ export class DriftClient {
 		this.activeSubAccountId = config.activeSubAccountId ?? 0;
 		this.skipLoadUsers = config.skipLoadUsers ?? false;
 		this.txVersion = config.txVersion ?? 'legacy';
+		this.txParams = {
+			computeUnits: config.txParams?.computeUnits ?? 600_000,
+			computeUnitsPrice: config.txParams?.computeUnitsPrice ?? 0,
+		};
 
 		if (config.includeDelegates && config.subAccountIds) {
 			throw new Error(
@@ -206,15 +214,23 @@ export class DriftClient {
 			: new Map<string, number[]>();
 
 		this.includeDelegates = config.includeDelegates ?? false;
-		this.userAccountSubscriptionConfig =
-			config.accountSubscription?.type === 'polling'
-				? {
-						type: 'polling',
-						accountLoader: config.accountSubscription.accountLoader,
-				  }
-				: {
-						type: 'websocket',
-				  };
+		if (config.accountSubscription?.type === 'polling') {
+			this.userAccountSubscriptionConfig = {
+				type: 'polling',
+				accountLoader: config.accountSubscription.accountLoader,
+			};
+			this.userStatsAccountSubscriptionConfig = {
+				type: 'polling',
+				accountLoader: config.accountSubscription.accountLoader,
+			};
+		} else {
+			this.userAccountSubscriptionConfig = {
+				type: 'websocket',
+			};
+			this.userStatsAccountSubscriptionConfig = {
+				type: 'websocket',
+			};
+		}
 
 		if (config.userStats) {
 			this.userStats = new UserStats({
@@ -257,12 +273,13 @@ export class DriftClient {
 			);
 		}
 		this.eventEmitter = this.accountSubscriber.eventEmitter;
-		this.txSender = new RetryTxSender(
-			this.provider,
-			config.txSenderConfig?.timeout,
-			config.txSenderConfig?.retrySleep,
-			config.txSenderConfig?.additionalConnections
-		);
+		this.txSender =
+			config.txSender ??
+			new RetryTxSender({
+				connection: this.connection,
+				wallet: this.wallet,
+				opts: this.opts,
+			});
 	}
 
 	public getUserMapKey(subAccountId: number, authority: PublicKey): string {
@@ -503,7 +520,7 @@ export class DriftClient {
 
 		this.skipLoadUsers = false;
 		// Update provider for txSender with new wallet details
-		this.txSender.provider = newProvider;
+		this.txSender.wallet = newWallet;
 		this.wallet = newWallet;
 		this.provider = newProvider;
 		this.program = newProgram;
@@ -547,7 +564,7 @@ export class DriftClient {
 				this.userStats = new UserStats({
 					driftClient: this,
 					userStatsAccountPublicKey: this.getUserStatsAccountPublicKey(),
-					accountSubscription: this.userAccountSubscriptionConfig,
+					accountSubscription: this.userStatsAccountSubscriptionConfig,
 				});
 
 				await this.userStats.subscribe();
@@ -1033,11 +1050,19 @@ export class DriftClient {
 		const userMapKey = this.getUserMapKey(subAccountId, authority);
 
 		if (!this.users.has(userMapKey)) {
-			throw new Error(`Clearing House has no user for user id ${userMapKey}`);
+			throw new Error(`DriftClient has no user for user id ${userMapKey}`);
 		}
 		return this.users.get(userMapKey);
 	}
 
+	public hasUser(subAccountId?: number, authority?: PublicKey): boolean {
+		subAccountId = subAccountId ?? this.activeSubAccountId;
+		authority = authority ?? this.authority;
+		const userMapKey = this.getUserMapKey(subAccountId, authority);
+
+		return this.users.has(userMapKey);
+	}
+
 	public getUsers(): User[] {
 		// delegate users get added to the end
 		return [...this.users.values()]
@@ -1695,7 +1720,7 @@ export class DriftClient {
 	}
 
 	/**
-	 * Creates the Clearing House User account for a user, and deposits some initial collateral
+	 * Creates the User account for a user, and deposits some initial collateral
 	 * @param amount
 	 * @param userTokenAccount
 	 * @param marketIndex
@@ -2296,6 +2321,35 @@ export class DriftClient {
 		});
 	}
 
+	public getQuoteValuePerLpShare(marketIndex: number): BN {
+		const perpMarketAccount = this.getPerpMarketAccount(marketIndex);
+
+		const openBids = BN.max(
+			perpMarketAccount.amm.baseAssetReserve.sub(
+				perpMarketAccount.amm.minBaseAssetReserve
+			),
+			ZERO
+		);
+
+		const openAsks = BN.max(
+			perpMarketAccount.amm.maxBaseAssetReserve.sub(
+				perpMarketAccount.amm.baseAssetReserve
+			),
+			ZERO
+		);
+
+		const oraclePriceData = this.getOracleDataForPerpMarket(marketIndex);
+
+		const maxOpenBidsAsks = BN.max(openBids, openAsks);
+		const quoteValuePerLpShare = maxOpenBidsAsks
+			.mul(oraclePriceData.price)
+			.mul(QUOTE_PRECISION)
+			.div(PRICE_PRECISION)
+			.div(perpMarketAccount.amm.sqrtK);
+
+		return quoteValuePerLpShare;
+	}
+
 	/**
 	 * @deprecated use {@link placePerpOrder} or {@link placeAndTakePerpOrder} instead
 	 */
@@ -5366,7 +5420,7 @@ export class DriftClient {
 		lookupTables?: AddressLookupTableAccount[]
 	): Promise<Transaction | VersionedTransaction> {
 		const allIx = [];
-		const computeUnits = txParams?.computeUnits ?? 600_000;
+		const computeUnits = txParams?.computeUnits ?? this.txParams.computeUnits;
 		if (computeUnits !== 200_000) {
 			allIx.push(
 				ComputeBudgetProgram.setComputeUnitLimit({
@@ -5374,7 +5428,8 @@ export class DriftClient {
 				})
 			);
 		}
-		const computeUnitsPrice = txParams?.computeUnitsPrice ?? 0;
+		const computeUnitsPrice =
+			txParams?.computeUnitsPrice ?? this.txParams.computeUnitsPrice;
 		if (computeUnitsPrice !== 0) {
 			allIx.push(
 				ComputeBudgetProgram.setComputeUnitPrice({

package/src/driftClientConfig.ts

@@ -4,10 +4,11 @@ import {
 	PublicKey,
 	TransactionVersion,
 } from '@solana/web3.js';
-import { IWallet } from './types';
+import { IWallet, TxParams } from './types';
 import { OracleInfo } from './oracles/types';
 import { BulkAccountLoader } from './accounts/bulkAccountLoader';
 import { DriftEnv } from './config';
+import { TxSender } from './tx/types';
 
 export type DriftClientConfig = {
 	connection: Connection;
@@ -16,7 +17,7 @@ export type DriftClientConfig = {
 	programID?: PublicKey;
 	accountSubscription?: DriftClientSubscriptionConfig;
 	opts?: ConfirmOptions;
-	txSenderConfig?: TxSenderConfig;
+	txSender?: TxSender;
 	subAccountIds?: number[];
 	activeSubAccountId?: number;
 	perpMarketIndexes?: number[];
@@ -29,6 +30,7 @@ export type DriftClientConfig = {
 	authoritySubAccountMap?: Map<string, number[]>; // if passed this will override subAccountIds and includeDelegates
 	skipLoadUsers?: boolean; // if passed to constructor, no user accounts will be loaded. they will load if updateWallet is called afterwards.
 	txVersion?: TransactionVersion; // which tx version to use
+	txParams?: TxParams; // default tx params to use
 };
 
 export type DriftClientSubscriptionConfig =
@@ -39,10 +41,3 @@ export type DriftClientSubscriptionConfig =
 			type: 'polling';
 			accountLoader: BulkAccountLoader;
 	  };
-
-type TxSenderConfig = {
-	type: 'retry';
-	timeout?: number;
-	retrySleep?: number;
-	additionalConnections?: Connection[];
-};

package/src/idl/drift.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.31.1-beta.1",
+  "version": "2.31.1-beta.10",
   "name": "drift",
   "instructions": [
     {

package/src/math/tiers.ts

@@ -0,0 +1,44 @@
+import { isVariant, PerpMarketAccount, SpotMarketAccount } from '../types';
+
+export function getPerpMarketTierNumber(perpMarket: PerpMarketAccount): number {
+	if (isVariant(perpMarket.contractTier, 'a')) {
+		return 0;
+	} else if (isVariant(perpMarket.contractTier, 'b')) {
+		return 1;
+	} else if (isVariant(perpMarket.contractTier, 'c')) {
+		return 2;
+	} else if (isVariant(perpMarket.contractTier, 'speculative')) {
+		return 3;
+	} else if (isVariant(perpMarket.contractTier, 'isolated')) {
+		return 4;
+	} else {
+		return 5;
+	}
+}
+
+export function getSpotMarketTierNumber(spotMarket: SpotMarketAccount): number {
+	if (isVariant(spotMarket.assetTier, 'collateral')) {
+		return 0;
+	} else if (isVariant(spotMarket.assetTier, 'protected')) {
+		return 1;
+	} else if (isVariant(spotMarket.assetTier, 'cross')) {
+		return 2;
+	} else if (isVariant(spotMarket.assetTier, 'isolated')) {
+		return 3;
+	} else if (isVariant(spotMarket.assetTier, 'unlisted')) {
+		return 4;
+	} else {
+		return 5;
+	}
+}
+
+export function perpTierIsAsSafeAs(
+	perpTier: number,
+	otherPerpTier: number,
+	otherSpotTier: number
+): boolean {
+	const asSafeAsPerp = perpTier <= otherPerpTier;
+	const asSafeAsSpot =
+		otherSpotTier === 4 || (otherSpotTier >= 2 && perpTier <= 2);
+	return asSafeAsSpot && asSafeAsPerp;
+}