@drift-labs/sdk 0.2.0-master.12 → 0.2.0-master.15

package/src/accounts/webSocketUserStatsAccountSubsriber.ts

@@ -0,0 +1,80 @@
+import {
+	DataAndSlot,
+	AccountSubscriber,
+	NotSubscribedError,
+	UserStatsAccountSubscriber,
+	UserStatsAccountEvents,
+} from './types';
+import { Program } from '@project-serum/anchor';
+import StrictEventEmitter from 'strict-event-emitter-types';
+import { EventEmitter } from 'events';
+import { PublicKey } from '@solana/web3.js';
+import { WebSocketAccountSubscriber } from './webSocketAccountSubscriber';
+import { UserStatsAccount } from '../types';
+
+export class WebSocketUserStatsAccountSubscriber
+	implements UserStatsAccountSubscriber
+{
+	isSubscribed: boolean;
+	program: Program;
+	eventEmitter: StrictEventEmitter<EventEmitter, UserStatsAccountEvents>;
+	userStatsAccountPublicKey: PublicKey;
+
+	userStatsAccountSubscriber: AccountSubscriber<UserStatsAccount>;
+
+	public constructor(program: Program, userStatsAccountPublicKey: PublicKey) {
+		this.isSubscribed = false;
+		this.program = program;
+		this.userStatsAccountPublicKey = userStatsAccountPublicKey;
+		this.eventEmitter = new EventEmitter();
+	}
+
+	async subscribe(): Promise<boolean> {
+		if (this.isSubscribed) {
+			return true;
+		}
+
+		this.userStatsAccountSubscriber = new WebSocketAccountSubscriber(
+			'userStats',
+			this.program,
+			this.userStatsAccountPublicKey
+		);
+		await this.userStatsAccountSubscriber.subscribe(
+			(data: UserStatsAccount) => {
+				this.eventEmitter.emit('userStatsAccountUpdate', data);
+				this.eventEmitter.emit('update');
+			}
+		);
+
+		this.eventEmitter.emit('update');
+		this.isSubscribed = true;
+		return true;
+	}
+
+	async fetch(): Promise<void> {
+		await Promise.all([this.userStatsAccountSubscriber.fetch()]);
+	}
+
+	async unsubscribe(): Promise<void> {
+		if (!this.isSubscribed) {
+			return;
+		}
+
+		await Promise.all([this.userStatsAccountSubscriber.unsubscribe()]);
+
+		this.isSubscribed = false;
+	}
+
+	assertIsSubscribed(): void {
+		if (!this.isSubscribed) {
+			throw new NotSubscribedError(
+				'You must call `subscribe` before using this function'
+			);
+		}
+	}
+
+	public getUserStatsAccountAndSlot(): DataAndSlot<UserStatsAccount> {
+		this.assertIsSubscribed();
+		return this.userStatsAccountSubscriber.dataAndSlot;
+	}
+}

package/src/addresses/pda.ts

@@ -57,6 +57,19 @@ export function getUserAccountPublicKeySync(
 	)[0];
 }
 
+export function getUserStatsAccountPublicKey(
+	programId: PublicKey,
+	authority: PublicKey
+): PublicKey {
+	return anchor.web3.PublicKey.findProgramAddressSync(
+		[
+			Buffer.from(anchor.utils.bytes.utf8.encode('user_stats')),
+			authority.toBuffer(),
+		],
+		programId
+	)[0];
+}
+
 export async function getMarketPublicKey(
 	programId: PublicKey,
 	marketIndex: BN

package/src/admin.ts

@@ -575,6 +575,35 @@ export class Admin extends ClearingHouse {
 		});
 	}
 
+	public async updateBankWithdrawGuardThreshold(
+		bankIndex: BN,
+		withdrawGuardThreshold: BN
+	): Promise<TransactionSignature> {
+		return await this.program.rpc.updateBankWithdrawGuardThreshold(
+			withdrawGuardThreshold,
+			{
+				accounts: {
+					admin: this.wallet.publicKey,
+					state: await this.getStatePublicKey(),
+					bank: await getBankPublicKey(this.program.programId, bankIndex),
+				},
+			}
+		);
+	}
+
+	public async updateLpCooldownTime(
+		marketIndex: BN,
+		cooldownTime: BN
+	): Promise<TransactionSignature> {
+		return await this.program.rpc.updateLpCooldownTime(cooldownTime, {
+			accounts: {
+				admin: this.wallet.publicKey,
+				state: await this.getStatePublicKey(),
+				market: await getMarketPublicKey(this.program.programId, marketIndex),
+			},
+		});
+	}
+
 	public async updateMarketOracle(
 		marketIndex: BN,
 		oracle: PublicKey,
@@ -662,7 +691,6 @@ export class Admin extends ClearingHouse {
 			},
 		});
 	}
-
 	public async updateExchangePaused(
 		exchangePaused: boolean
 	): Promise<TransactionSignature> {

package/src/clearingHouse.ts

@@ -41,6 +41,7 @@ import {
 	getMarketPublicKey,
 	getUserAccountPublicKey,
 	getUserAccountPublicKeySync,
+	getUserStatsAccountPublicKey,
 } from './addresses/pda';
 import {
 	ClearingHouseAccountSubscriber,
@@ -62,6 +63,7 @@ import { ClearingHouseUser } from './clearingHouseUser';
 import { ClearingHouseUserAccountSubscriptionConfig } from './clearingHouseUserConfig';
 import { getMarketsBanksAndOraclesForSubscription } from './config';
 import { WRAPPED_SOL_MINT } from './constants/banks';
+import { ClearingHouseUserStats } from './clearingHouseUserStats';
 
 /**
  * # ClearingHouse
@@ -74,6 +76,7 @@ export class ClearingHouse {
 	provider: AnchorProvider;
 	opts?: ConfirmOptions;
 	users = new Map<number, ClearingHouseUser>();
+	userStats?: ClearingHouseUserStats;
 	activeUserId: number;
 	userAccountSubscriptionConfig: ClearingHouseUserAccountSubscriptionConfig;
 	accountSubscriber: ClearingHouseAccountSubscriber;
@@ -117,6 +120,16 @@ export class ClearingHouse {
 						type: 'websocket',
 				  };
 		this.createUsers(userIds, this.userAccountSubscriptionConfig);
+		if (config.userStats) {
+			this.userStats = new ClearingHouseUserStats({
+				clearingHouse: this,
+				userStatsAccountPublicKey: getUserStatsAccountPublicKey(
+					this.program.programId,
+					this.wallet.publicKey
+				),
+				accountSubscription: this.userAccountSubscriptionConfig,
+			});
+		}
 
 		let marketIndexes = config.marketIndexes;
 		let bankIndexes = config.bankIndexes;
@@ -188,6 +201,9 @@ export class ClearingHouse {
 		const subscribePromises = this.subscribeUsers().concat(
 			this.accountSubscriber.subscribe()
 		);
+		if (this.userStats !== undefined) {
+			subscribePromises.concat(this.userStats.subscribe());
+		}
 		this.isSubscribed = (await Promise.all(subscribePromises)).reduce(
 			(success, prevSuccess) => success && prevSuccess
 		);
@@ -213,6 +229,9 @@ export class ClearingHouse {
 		const unsubscribePromises = this.unsubscribeUsers().concat(
 			this.accountSubscriber.unsubscribe()
 		);
+		if (this.userStats !== undefined) {
+			unsubscribePromises.concat(this.userStats.unsubscribe());
+		}
 		await Promise.all(unsubscribePromises);
 		this.isSubscribed = false;
 	}
@@ -302,6 +321,7 @@ export class ClearingHouse {
 		}
 
 		this.activeUserId = activeUserId;
+		this.userStatsAccountPublicKey = undefined;
 	}
 
 	public async switchActiveUser(userId: number): Promise<void> {
@@ -325,7 +345,12 @@ export class ClearingHouse {
 		const [userAccountPublicKey, initializeUserAccountIx] =
 			await this.getInitializeUserInstructions(userId, name);
 
-		const tx = new Transaction().add(initializeUserAccountIx);
+		const tx = new Transaction();
+		if (userId === 0) {
+			// not the safest assumption, can explicitly check if user stats account exists if it causes problems
+			tx.add(await this.getInitializeUserStatsIx());
+		}
+		tx.add(initializeUserAccountIx);
 		const { txSig } = await this.txSender.send(tx, [], this.opts);
 		return [txSig, userAccountPublicKey];
 	}
@@ -345,6 +370,7 @@ export class ClearingHouse {
 			await this.program.instruction.initializeUser(userId, nameBuffer, {
 				accounts: {
 					user: userAccountPublicKey,
+					userStats: this.getUserStatsAccountPublicKey(),
 					authority: this.wallet.publicKey,
 					payer: this.wallet.publicKey,
 					rent: anchor.web3.SYSVAR_RENT_PUBKEY,
@@ -356,6 +382,19 @@ export class ClearingHouse {
 		return [userAccountPublicKey, initializeUserAccountIx];
 	}
 
+	async getInitializeUserStatsIx(): Promise<TransactionInstruction> {
+		return await this.program.instruction.initializeUserStats({
+			accounts: {
+				userStats: this.getUserStatsAccountPublicKey(),
+				authority: this.wallet.publicKey,
+				payer: this.wallet.publicKey,
+				rent: anchor.web3.SYSVAR_RENT_PUBKEY,
+				systemProgram: anchor.web3.SystemProgram.programId,
+				state: await this.getStatePublicKey(),
+			},
+		});
+	}
+
 	public getUser(userId?: number): ClearingHouseUser {
 		userId = userId ?? this.activeUserId;
 		if (!this.users.has(userId)) {
@@ -368,6 +407,23 @@ export class ClearingHouse {
 		return [...this.users.values()];
 	}
 
+	public getUserStats(): ClearingHouseUserStats {
+		return this.userStats;
+	}
+
+	userStatsAccountPublicKey: PublicKey;
+	public getUserStatsAccountPublicKey(): PublicKey {
+		if (this.userStatsAccountPublicKey) {
+			return this.userStatsAccountPublicKey;
+		}
+
+		this.userStatsAccountPublicKey = getUserStatsAccountPublicKey(
+			this.program.programId,
+			this.wallet.publicKey
+		);
+		return this.userStatsAccountPublicKey;
+	}
+
 	public async getUserAccountPublicKey(): Promise<PublicKey> {
 		return this.getUser().userAccountPublicKey;
 	}
@@ -831,6 +887,9 @@ export class ClearingHouse {
 						false
 				  );
 
+		if (userId === 0) {
+			tx.add(await this.getInitializeUserStatsIx());
+		}
 		tx.add(initializeUserAccountIx).add(depositCollateralIx);
 
 		// Close the wrapped sol account at the end of the transaction
@@ -880,11 +939,12 @@ export class ClearingHouse {
 			false
 		);
 
-		const tx = new Transaction()
-			.add(createAssociatedAccountIx)
-			.add(mintToIx)
-			.add(initializeUserAccountIx)
-			.add(depositCollateralIx);
+		const tx = new Transaction().add(createAssociatedAccountIx).add(mintToIx);
+
+		if (userId === 0) {
+			tx.add(await this.getInitializeUserStatsIx());
+		}
+		tx.add(initializeUserAccountIx).add(depositCollateralIx);
 
 		const txSig = await this.program.provider.sendAndConfirm(tx, []);
 
@@ -1056,6 +1116,135 @@ export class ClearingHouse {
 		});
 	}
 
+	public async settleLP(
+		settleeUserAccountPublicKey: PublicKey,
+		marketIndex: BN
+	): Promise<TransactionSignature> {
+		const { txSig } = await this.txSender.send(
+			wrapInTx(await this.settleLPIx(settleeUserAccountPublicKey, marketIndex)),
+			[],
+			this.opts
+		);
+		return txSig;
+	}
+
+	public async settleLPIx(
+		settleeUserAccountPublicKey: PublicKey,
+		marketIndex: BN
+	): Promise<TransactionInstruction> {
+		const settleeUserAccount = (await this.program.account.user.fetch(
+			settleeUserAccountPublicKey
+		)) as UserAccount;
+		const userPositions = settleeUserAccount.positions;
+		const remainingAccounts = [];
+
+		let foundMarket = false;
+		for (const position of userPositions) {
+			if (!positionIsAvailable(position)) {
+				const marketPublicKey = await getMarketPublicKey(
+					this.program.programId,
+					position.marketIndex
+				);
+				remainingAccounts.push({
+					pubkey: marketPublicKey,
+					isWritable: true,
+					isSigner: false,
+				});
+
+				if (marketIndex.eq(position.marketIndex)) {
+					foundMarket = true;
+				}
+			}
+		}
+
+		if (!foundMarket) {
+			console.log(
+				'Warning: lp is not in the market specified -- tx will likely fail'
+			);
+		}
+
+		return this.program.instruction.settleLp(marketIndex, {
+			accounts: {
+				state: await this.getStatePublicKey(),
+				user: settleeUserAccountPublicKey,
+			},
+			remainingAccounts: remainingAccounts,
+		});
+	}
+
+	public async removeLiquidity(
+		marketIndex: BN,
+		sharesToBurn?: BN
+	): Promise<TransactionSignature> {
+		const { txSig } = await this.txSender.send(
+			wrapInTx(await this.getRemoveLiquidityIx(marketIndex, sharesToBurn)),
+			[],
+			this.opts
+		);
+		return txSig;
+	}
+
+	public async getRemoveLiquidityIx(
+		marketIndex: BN,
+		sharesToBurn?: BN
+	): Promise<TransactionInstruction> {
+		const userAccountPublicKey = await this.getUserAccountPublicKey();
+
+		const remainingAccounts = this.getRemainingAccounts({
+			writableMarketIndex: marketIndex,
+		});
+
+		if (sharesToBurn == undefined) {
+			const userAccount = this.getUserAccount();
+			const marketPosition = userAccount.positions.filter((position) =>
+				position.marketIndex.eq(marketIndex)
+			)[0];
+			sharesToBurn = marketPosition.lpShares;
+			console.log('burning lp shares:', sharesToBurn.toString());
+		}
+
+		return this.program.instruction.removeLiquidity(sharesToBurn, marketIndex, {
+			accounts: {
+				state: await this.getStatePublicKey(),
+				user: userAccountPublicKey,
+				authority: this.wallet.publicKey,
+			},
+			remainingAccounts: remainingAccounts,
+		});
+	}
+
+	public async addLiquidity(
+		amount: BN,
+		marketIndex: BN
+	): Promise<TransactionSignature> {
+		const { txSig, slot } = await this.txSender.send(
+			wrapInTx(await this.getAddLiquidityIx(amount, marketIndex)),
+			[],
+			this.opts
+		);
+		this.marketLastSlotCache.set(marketIndex.toNumber(), slot);
+		return txSig;
+	}
+
+	public async getAddLiquidityIx(
+		amount: BN,
+		marketIndex: BN
+	): Promise<TransactionInstruction> {
+		const userAccountPublicKey = await this.getUserAccountPublicKey();
+		const remainingAccounts = this.getRemainingAccounts({
+			writableMarketIndex: marketIndex,
+		});
+
+		return this.program.instruction.addLiquidity(amount, marketIndex, {
+			accounts: {
+				state: await this.getStatePublicKey(),
+				user: userAccountPublicKey,
+				authority: this.wallet.publicKey,
+			},
+			remainingAccounts: remainingAccounts,
+		});
+	}
+
 	public async openPosition(
 		direction: PositionDirection,
 		amount: BN,
@@ -1101,6 +1290,7 @@ export class ClearingHouse {
 			accounts: {
 				state: await this.getStatePublicKey(),
 				user: userAccountPublicKey,
+				userStats: this.getUserStatsAccountPublicKey(),
 				authority: this.wallet.publicKey,
 			},
 			remainingAccounts,
@@ -1228,7 +1418,13 @@ export class ClearingHouse {
 		order: Order,
 		makerInfo?: MakerInfo
 	): Promise<TransactionInstruction> {
+		const userStatsPublicKey = getUserStatsAccountPublicKey(
+			this.program.programId,
+			userAccount.authority
+		);
+
 		const fillerPublicKey = await this.getUserAccountPublicKey();
+		const fillerStatsPublicKey = this.getUserStatsAccountPublicKey();
 
 		const marketIndex = order.marketIndex;
 		const marketAccount = this.getMarketAccount(marketIndex);
@@ -1298,6 +1494,11 @@ export class ClearingHouse {
 				isWritable: true,
 				isSigner: false,
 			});
+			remainingAccounts.push({
+				pubkey: makerInfo.makerStats,
+				isWritable: true,
+				isSigner: false,
+			});
 		}
 
 		const orderId = order.orderId;
@@ -1307,7 +1508,9 @@ export class ClearingHouse {
 			accounts: {
 				state: await this.getStatePublicKey(),
 				filler: fillerPublicKey,
+				fillerStats: fillerStatsPublicKey,
 				user: userAccountPublicKey,
+				userStats: userStatsPublicKey,
 				authority: this.wallet.publicKey,
 			},
 			remainingAccounts,
@@ -1426,6 +1629,7 @@ export class ClearingHouse {
 		makerInfo?: MakerInfo
 	): Promise<TransactionInstruction> {
 		orderParams = this.getOrderParams(orderParams);
+		const userStatsPublicKey = await this.getUserStatsAccountPublicKey();
 		const userAccountPublicKey = await this.getUserAccountPublicKey();
 
 		const remainingAccounts = this.getRemainingAccounts({
@@ -1441,6 +1645,11 @@ export class ClearingHouse {
 				isSigner: false,
 				isWritable: true,
 			});
+			remainingAccounts.push({
+				pubkey: makerInfo.makerStats,
+				isSigner: false,
+				isWritable: true,
+			});
 		}
 
 		return await this.program.instruction.placeAndTake(
@@ -1450,6 +1659,7 @@ export class ClearingHouse {
 				accounts: {
 					state: await this.getStatePublicKey(),
 					user: userAccountPublicKey,
+					userStats: userStatsPublicKey,
 					authority: this.wallet.publicKey,
 				},
 				remainingAccounts,
@@ -1477,20 +1687,14 @@ export class ClearingHouse {
 		takerInfo: TakerInfo
 	): Promise<TransactionInstruction> {
 		orderParams = this.getOrderParams(orderParams);
+		const userStatsPublicKey = this.getUserStatsAccountPublicKey();
 		const userAccountPublicKey = await this.getUserAccountPublicKey();
 
 		const remainingAccounts = this.getRemainingAccounts({
 			writableMarketIndex: orderParams.marketIndex,
-			writableBankIndex: QUOTE_ASSET_BANK_INDEX,
 		});
 
 		const takerOrderId = takerInfo!.order!.orderId;
-		remainingAccounts.push({
-			pubkey: takerInfo.taker,
-			isSigner: false,
-			isWritable: true,
-		});
-
 		return await this.program.instruction.placeAndMake(
 			orderParams,
 			takerOrderId,
@@ -1498,7 +1702,9 @@ export class ClearingHouse {
 				accounts: {
 					state: await this.getStatePublicKey(),
 					user: userAccountPublicKey,
+					userStats: userStatsPublicKey,
 					taker: takerInfo.taker,
+					takerStats: takerInfo.takerStats,
 					authority: this.wallet.publicKey,
 				},
 				remainingAccounts,
@@ -1511,7 +1717,10 @@ export class ClearingHouse {
 	 * @param marketIndex
 	 * @returns
 	 */
-	public async closePosition(marketIndex: BN): Promise<TransactionSignature> {
+	public async closePosition(
+		marketIndex: BN,
+		limitPrice?: BN
+	): Promise<TransactionSignature> {
 		const userPosition = this.getUser().getUserPosition(marketIndex);
 		if (!userPosition) {
 			throw Error(`No position in market ${marketIndex.toString()}`);
@@ -1521,8 +1730,9 @@ export class ClearingHouse {
 			orderType: OrderType.MARKET,
 			marketIndex,
 			direction: findDirectionToClose(userPosition),
-			baseAssetAmount: userPosition.baseAssetAmount,
+			baseAssetAmount: userPosition.baseAssetAmount.abs(),
 			reduceOnly: true,
+			price: limitPrice,
 		});
 	}
 
@@ -1577,6 +1787,7 @@ export class ClearingHouse {
 		const marketAccountMap = new Map<number, AccountMeta>();
 		const oracleAccountMap = new Map<string, AccountMeta>();
 		const bankAccountMap = new Map<number, AccountMeta>();
+
 		for (const position of settleeUserAccount.positions) {
 			if (!positionIsAvailable(position)) {
 				const market = this.getMarketAccount(position.marketIndex);
@@ -1672,7 +1883,13 @@ export class ClearingHouse {
 		marketIndex: BN,
 		maxBaseAssetAmount: BN
 	): Promise<TransactionInstruction> {
+		const userStatsPublicKey = getUserStatsAccountPublicKey(
+			this.program.programId,
+			userAccount.authority
+		);
+
 		const liquidatorPublicKey = await this.getUserAccountPublicKey();
+		const liquidatorStatsPublicKey = this.getUserStatsAccountPublicKey();
 
 		const remainingAccounts = this.getRemainingAccountsForLiquidation({
 			writableMarketIndex: marketIndex,
@@ -1687,7 +1904,9 @@ export class ClearingHouse {
 					state: await this.getStatePublicKey(),
 					authority: this.wallet.publicKey,
 					user: userAccountPublicKey,
+					userStats: userStatsPublicKey,
 					liquidator: liquidatorPublicKey,
+					liquidatorStats: liquidatorStatsPublicKey,
 				},
 				remainingAccounts: remainingAccounts,
 			}
@@ -1855,6 +2074,90 @@ export class ClearingHouse {
 		);
 	}
 
+	public async resolvePerpBankruptcy(
+		userAccountPublicKey: PublicKey,
+		userAccount: UserAccount,
+		marketIndex: BN
+	): Promise<TransactionSignature> {
+		const { txSig } = await this.txSender.send(
+			wrapInTx(
+				await this.getResolvePerpBankruptcyIx(
+					userAccountPublicKey,
+					userAccount,
+					marketIndex
+				)
+			),
+			[],
+			this.opts
+		);
+		return txSig;
+	}
+
+	public async getResolvePerpBankruptcyIx(
+		userAccountPublicKey: PublicKey,
+		userAccount: UserAccount,
+		marketIndex: BN
+	): Promise<TransactionInstruction> {
+		const liquidatorPublicKey = await this.getUserAccountPublicKey();
+
+		const remainingAccounts = this.getRemainingAccountsForLiquidation({
+			writableMarketIndex: marketIndex,
+			userAccount,
+		});
+
+		return await this.program.instruction.resolvePerpBankruptcy(marketIndex, {
+			accounts: {
+				state: await this.getStatePublicKey(),
+				authority: this.wallet.publicKey,
+				user: userAccountPublicKey,
+				liquidator: liquidatorPublicKey,
+			},
+			remainingAccounts: remainingAccounts,
+		});
+	}
+
+	public async resolveBorrowBankruptcy(
+		userAccountPublicKey: PublicKey,
+		userAccount: UserAccount,
+		bankIndex: BN
+	): Promise<TransactionSignature> {
+		const { txSig } = await this.txSender.send(
+			wrapInTx(
+				await this.getResolveBorrowBankruptcyIx(
+					userAccountPublicKey,
+					userAccount,
+					bankIndex
+				)
+			),
+			[],
+			this.opts
+		);
+		return txSig;
+	}
+
+	public async getResolveBorrowBankruptcyIx(
+		userAccountPublicKey: PublicKey,
+		userAccount: UserAccount,
+		bankIndex: BN
+	): Promise<TransactionInstruction> {
+		const liquidatorPublicKey = await this.getUserAccountPublicKey();
+
+		const remainingAccounts = this.getRemainingAccountsForLiquidation({
+			writableBankIndexes: [bankIndex],
+			userAccount,
+		});
+
+		return await this.program.instruction.resolveBorrowBankruptcy(bankIndex, {
+			accounts: {
+				state: await this.getStatePublicKey(),
+				authority: this.wallet.publicKey,
+				user: userAccountPublicKey,
+				liquidator: liquidatorPublicKey,
+			},
+			remainingAccounts: remainingAccounts,
+		});
+	}
+
 	getRemainingAccountsForLiquidation(params: {
 		userAccount: UserAccount;
 		writableMarketIndex?: BN;

package/src/clearingHouseConfig.ts

@@ -18,6 +18,7 @@ export type ClearingHouseConfig = {
 	bankIndexes?: BN[];
 	oracleInfos?: OracleInfo[];
 	env?: DriftEnv;
+	userStats?: boolean;
 };
 
 type ClearingHouseSubscriptionConfig =