@drift-labs/sdk 0.2.0-master.37 → 0.2.0-master.39

package/src/{clearingHouse.ts → driftClient.ts}

@@ -26,7 +26,7 @@ import {
 	isVariant,
 } from './types';
 import * as anchor from '@project-serum/anchor';
-import clearingHouseIDL from './idl/clearing_house.json';
+import driftIDL from './idl/drift.json';
 
 import {
 	Connection,
@@ -47,8 +47,8 @@ import { TokenFaucet } from './tokenFaucet';
 import { EventEmitter } from 'events';
 import StrictEventEmitter from 'strict-event-emitter-types';
 import {
-	getClearingHouseSignerPublicKey,
-	getClearingHouseStateAccountPublicKey,
+	getDriftSignerPublicKey,
+	getDriftStateAccountPublicKey,
 	getInsuranceFundStakeAccountPublicKey,
 	getPerpMarketPublicKey,
 	getSerumFulfillmentConfigPublicKey,
@@ -59,8 +59,8 @@ import {
 	getUserStatsAccountPublicKey,
 } from './addresses/pda';
 import {
-	ClearingHouseAccountSubscriber,
-	ClearingHouseAccountEvents,
+	DriftClientAccountSubscriber,
+	DriftClientAccountEvents,
 	DataAndSlot,
 } from './accounts/types';
 import { TxSender } from './tx/types';
@@ -70,15 +70,15 @@ import { findDirectionToClose, positionIsAvailable } from './math/position';
 import { getTokenAmount } from './math/spotBalance';
 import { DEFAULT_USER_NAME, encodeName } from './userName';
 import { OraclePriceData } from './oracles/types';
-import { ClearingHouseConfig } from './clearingHouseConfig';
-import { PollingClearingHouseAccountSubscriber } from './accounts/pollingClearingHouseAccountSubscriber';
-import { WebSocketClearingHouseAccountSubscriber } from './accounts/webSocketClearingHouseAccountSubscriber';
+import { DriftClientConfig } from './driftClientConfig';
+import { PollingDriftClientAccountSubscriber } from './accounts/pollingDriftClientAccountSubscriber';
+import { WebSocketDriftClientAccountSubscriber } from './accounts/webSocketDriftClientAccountSubscriber';
 import { RetryTxSender } from './tx/retryTxSender';
-import { ClearingHouseUser } from './clearingHouseUser';
-import { ClearingHouseUserAccountSubscriptionConfig } from './clearingHouseUserConfig';
+import { User } from './user';
+import { UserSubscriptionConfig } from './userConfig';
 import { getMarketsAndOraclesForSubscription } from './config';
 import { WRAPPED_SOL_MINT } from './constants/spotMarkets';
-import { ClearingHouseUserStats } from './clearingHouseUserStats';
+import { UserStats } from './userStats';
 import { isSpotPositionAvailable } from './math/spotPosition';
 
 type RemainingAccountParams = {
@@ -91,21 +91,21 @@ type RemainingAccountParams = {
 };
 
 /**
- * # ClearingHouse
+ * # DriftClient
  * This class is the main way to interact with Drift Protocol. It allows you to subscribe to the various accounts where the Market's state is stored, as well as: opening positions, liquidating, settling funding, depositing & withdrawing, and more.
  */
-export class ClearingHouse {
+export class DriftClient {
 	connection: Connection;
 	wallet: IWallet;
 	public program: Program;
 	provider: AnchorProvider;
 	opts?: ConfirmOptions;
-	users = new Map<number, ClearingHouseUser>();
-	userStats?: ClearingHouseUserStats;
+	users = new Map<number, User>();
+	userStats?: UserStats;
 	activeSubAccountId: number;
-	userAccountSubscriptionConfig: ClearingHouseUserAccountSubscriptionConfig;
-	accountSubscriber: ClearingHouseAccountSubscriber;
-	eventEmitter: StrictEventEmitter<EventEmitter, ClearingHouseAccountEvents>;
+	userAccountSubscriptionConfig: UserSubscriptionConfig;
+	accountSubscriber: DriftClientAccountSubscriber;
+	eventEmitter: StrictEventEmitter<EventEmitter, DriftClientAccountEvents>;
 	_isSubscribed = false;
 	txSender: TxSender;
 	perpMarketLastSlotCache = new Map<number, number>();
@@ -120,7 +120,7 @@ export class ClearingHouse {
 		this._isSubscribed = val;
 	}
 
-	public constructor(config: ClearingHouseConfig) {
+	public constructor(config: DriftClientConfig) {
 		this.connection = config.connection;
 		this.wallet = config.wallet;
 		this.opts = config.opts || AnchorProvider.defaultOptions();
@@ -130,7 +130,7 @@ export class ClearingHouse {
 			this.opts
 		);
 		this.program = new Program(
-			clearingHouseIDL as Idl,
+			driftIDL as Idl,
 			config.programID,
 			this.provider
 		);
@@ -149,8 +149,8 @@ export class ClearingHouse {
 				  };
 		this.createUsers(subAccountIds, this.userAccountSubscriptionConfig);
 		if (config.userStats) {
-			this.userStats = new ClearingHouseUserStats({
-				clearingHouse: this,
+			this.userStats = new UserStats({
+				driftClient: this,
 				userStatsAccountPublicKey: getUserStatsAccountPublicKey(
 					this.program.programId,
 					this.authority
@@ -178,7 +178,7 @@ export class ClearingHouse {
 		}
 
 		if (config.accountSubscription?.type === 'polling') {
-			this.accountSubscriber = new PollingClearingHouseAccountSubscriber(
+			this.accountSubscriber = new PollingDriftClientAccountSubscriber(
 				this.program,
 				config.accountSubscription.accountLoader,
 				perpMarketIndexes ?? [],
@@ -186,7 +186,7 @@ export class ClearingHouse {
 				oracleInfos ?? []
 			);
 		} else {
-			this.accountSubscriber = new WebSocketClearingHouseAccountSubscriber(
+			this.accountSubscriber = new WebSocketDriftClientAccountSubscriber(
 				this.program,
 				config.perpMarketIndexes ?? [],
 				config.spotMarketIndexes ?? [],
@@ -204,7 +204,7 @@ export class ClearingHouse {
 
 	createUsers(
 		subAccountIds: number[],
-		accountSubscriptionConfig: ClearingHouseUserAccountSubscriptionConfig
+		accountSubscriptionConfig: UserSubscriptionConfig
 	): void {
 		for (const subAccountId of subAccountIds) {
 			const user = this.createUser(subAccountId, accountSubscriptionConfig);
@@ -214,16 +214,16 @@ export class ClearingHouse {
 
 	createUser(
 		subAccountId: number,
-		accountSubscriptionConfig: ClearingHouseUserAccountSubscriptionConfig
-	): ClearingHouseUser {
+		accountSubscriptionConfig: UserSubscriptionConfig
+	): User {
 		const userAccountPublicKey = getUserAccountPublicKeySync(
 			this.program.programId,
 			this.authority,
 			subAccountId
 		);
 
-		return new ClearingHouseUser({
-			clearingHouse: this,
+		return new User({
+			driftClient: this,
 			userAccountPublicKey,
 			accountSubscription: accountSubscriptionConfig,
 		});
@@ -279,7 +279,7 @@ export class ClearingHouse {
 		if (this.statePublicKey) {
 			return this.statePublicKey;
 		}
-		this.statePublicKey = await getClearingHouseStateAccountPublicKey(
+		this.statePublicKey = await getDriftStateAccountPublicKey(
 			this.program.programId
 		);
 		return this.statePublicKey;
@@ -290,9 +290,7 @@ export class ClearingHouse {
 		if (this.signerPublicKey) {
 			return this.signerPublicKey;
 		}
-		this.signerPublicKey = getClearingHouseSignerPublicKey(
-			this.program.programId
-		);
+		this.signerPublicKey = getDriftSignerPublicKey(this.program.programId);
 		return this.signerPublicKey;
 	}
 
@@ -349,7 +347,7 @@ export class ClearingHouse {
 	}
 
 	/**
-	 * Update the wallet to use for clearing house transactions and linked user account
+	 * Update the wallet to use for drift transactions and linked user account
 	 * @param newWallet
 	 * @param subAccountIds
 	 * @param activeSubAccountId
@@ -365,7 +363,7 @@ export class ClearingHouse {
 			this.opts
 		);
 		const newProgram = new Program(
-			clearingHouseIDL as Idl,
+			driftIDL as Idl,
 			this.program.programId,
 			newProvider
 		);
@@ -588,7 +586,7 @@ export class ClearingHouse {
 		return txSig;
 	}
 
-	public getUser(subAccountId?: number): ClearingHouseUser {
+	public getUser(subAccountId?: number): User {
 		subAccountId = subAccountId ?? this.activeSubAccountId;
 		if (!this.users.has(subAccountId)) {
 			throw new Error(`Clearing House has no user for user id ${subAccountId}`);
@@ -596,11 +594,11 @@ export class ClearingHouse {
 		return this.users.get(subAccountId);
 	}
 
-	public getUsers(): ClearingHouseUser[] {
+	public getUsers(): User[] {
 		return [...this.users.values()];
 	}
 
-	public getUserStats(): ClearingHouseUserStats {
+	public getUserStats(): UserStats {
 		return this.userStats;
 	}
 
@@ -1320,7 +1318,7 @@ export class ClearingHouse {
 					state: await this.getStatePublicKey(),
 					spotMarket: spotMarketAccount.pubkey,
 					spotMarketVault: spotMarketAccount.vault,
-					clearingHouseSigner: this.getSignerPublicKey(),
+					driftSigner: this.getSignerPublicKey(),
 					user: userAccountPublicKey,
 					userStats: this.getUserStatsAccountPublicKey(),
 					userTokenAccount: userTokenAccount,
@@ -2166,13 +2164,11 @@ export class ClearingHouse {
 		const orderId = order.orderId;
 		const makerOrderId = makerInfo ? makerInfo.order.orderId : null;
 
-		if (fulfillmentConfig) {
-			this.addSerumRemainingAccounts(
-				marketIndex,
-				remainingAccounts,
-				fulfillmentConfig
-			);
-		}
+		this.addSpotFulfillmentAccounts(
+			marketIndex,
+			remainingAccounts,
+			fulfillmentConfig
+		);
 
 		return await this.program.instruction.fillSpotOrder(
 			orderId,
@@ -2192,6 +2188,31 @@ export class ClearingHouse {
 		);
 	}
 
+	addSpotFulfillmentAccounts(
+		marketIndex: number,
+		remainingAccounts: AccountMeta[],
+		fulfillmentConfig?: SerumV3FulfillmentConfigAccount
+	) {
+		if (fulfillmentConfig) {
+			this.addSerumRemainingAccounts(
+				marketIndex,
+				remainingAccounts,
+				fulfillmentConfig
+			);
+		} else {
+			remainingAccounts.push({
+				pubkey: this.getSpotMarketAccount(marketIndex).vault,
+				isWritable: false,
+				isSigner: false,
+			});
+			remainingAccounts.push({
+				pubkey: this.getQuoteSpotMarketAccount().vault,
+				isWritable: false,
+				isSigner: false,
+			});
+		}
+	}
+
 	addSerumRemainingAccounts(
 		marketIndex: number,
 		remainingAccounts: AccountMeta[],
@@ -2556,13 +2577,11 @@ export class ClearingHouse {
 			});
 		}
 
-		if (fulfillmentConfig) {
-			this.addSerumRemainingAccounts(
-				orderParams.marketIndex,
-				remainingAccounts,
-				fulfillmentConfig
-			);
-		}
+		this.addSpotFulfillmentAccounts(
+			orderParams.marketIndex,
+			remainingAccounts,
+			fulfillmentConfig
+		);
 
 		return await this.program.instruction.placeAndTakeSpotOrder(
 			orderParams,
@@ -2635,13 +2654,11 @@ export class ClearingHouse {
 			});
 		}
 
-		if (fulfillmentConfig) {
-			this.addSerumRemainingAccounts(
-				orderParams.marketIndex,
-				remainingAccounts,
-				fulfillmentConfig
-			);
-		}
+		this.addSpotFulfillmentAccounts(
+			orderParams.marketIndex,
+			remainingAccounts,
+			fulfillmentConfig
+		);
 
 		const takerOrderId = takerInfo.order.orderId;
 		return await this.program.instruction.placeAndMakeSpotOrder(
@@ -2671,7 +2688,7 @@ export class ClearingHouse {
 		marketIndex: number,
 		limitPrice?: BN
 	): Promise<TransactionSignature> {
-		const userPosition = this.getUser().getUserPosition(marketIndex);
+		const userPosition = this.getUser().getPerpPosition(marketIndex);
 		if (!userPosition) {
 			throw Error(`No position in market ${marketIndex.toString()}`);
 		}
@@ -3126,7 +3143,7 @@ export class ClearingHouse {
 					liquidatorStats: liquidatorStatsPublicKey,
 					spotMarketVault: spotMarket.vault,
 					insuranceFundVault: spotMarket.insuranceFund.vault,
-					clearingHouseSigner: this.getSignerPublicKey(),
+					driftSigner: this.getSignerPublicKey(),
 					tokenProgram: TOKEN_PROGRAM_ID,
 				},
 				remainingAccounts: remainingAccounts,
@@ -3183,7 +3200,7 @@ export class ClearingHouse {
 				liquidator: liquidatorPublicKey,
 				spotMarketVault: spotMarket.vault,
 				insuranceFundVault: spotMarket.insuranceFund.vault,
-				clearingHouseSigner: this.getSignerPublicKey(),
+				driftSigner: this.getSignerPublicKey(),
 				tokenProgram: TOKEN_PROGRAM_ID,
 			},
 			remainingAccounts: remainingAccounts,
@@ -3258,7 +3275,7 @@ export class ClearingHouse {
 		});
 	}
 
-	public triggerEvent(eventName: keyof ClearingHouseAccountEvents, data?: any) {
+	public triggerEvent(eventName: keyof DriftClientAccountEvents, data?: any) {
 		this.eventEmitter.emit(eventName, data);
 	}
 
@@ -3340,7 +3357,7 @@ export class ClearingHouse {
 				authority: this.wallet.publicKey,
 				spotMarketVault: spotMarket.vault,
 				insuranceFundVault: spotMarket.insuranceFund.vault,
-				clearingHouseSigner: this.getSignerPublicKey(),
+				driftSigner: this.getSignerPublicKey(),
 				userTokenAccount: collateralAccountPublicKey,
 				tokenProgram: TOKEN_PROGRAM_ID,
 			},
@@ -3439,7 +3456,7 @@ export class ClearingHouse {
 				userStats: this.getUserStatsAccountPublicKey(),
 				authority: this.wallet.publicKey,
 				insuranceFundVault: spotMarketAccount.insuranceFund.vault,
-				clearingHouseSigner: this.getSignerPublicKey(),
+				driftSigner: this.getSignerPublicKey(),
 				userTokenAccount: collateralAccountPublicKey,
 				tokenProgram: TOKEN_PROGRAM_ID,
 			},
@@ -3463,7 +3480,7 @@ export class ClearingHouse {
 				state: await this.getStatePublicKey(),
 				spotMarket: spotMarketAccount.pubkey,
 				spotMarketVault: spotMarketAccount.vault,
-				clearingHouseSigner: this.getSignerPublicKey(),
+				driftSigner: this.getSignerPublicKey(),
 				insuranceFundVault: spotMarketAccount.insuranceFund.vault,
 				tokenProgram: TOKEN_PROGRAM_ID,
 			},
@@ -3507,7 +3524,7 @@ export class ClearingHouse {
 					authority: this.wallet.publicKey,
 					spotMarketVault: spotMarket.vault,
 					insuranceFundVault: spotMarket.insuranceFund.vault,
-					clearingHouseSigner: this.getSignerPublicKey(),
+					driftSigner: this.getSignerPublicKey(),
 					tokenProgram: TOKEN_PROGRAM_ID,
 				},
 				remainingAccounts: remainingAccounts,

package/src/{clearingHouseConfig.ts → driftClientConfig.ts}

@@ -4,11 +4,11 @@ import { OracleInfo } from './oracles/types';
 import { BulkAccountLoader } from './accounts/bulkAccountLoader';
 import { DriftEnv } from './config';
 
-export type ClearingHouseConfig = {
+export type DriftClientConfig = {
 	connection: Connection;
 	wallet: IWallet;
 	programID: PublicKey;
-	accountSubscription?: ClearingHouseSubscriptionConfig;
+	accountSubscription?: DriftClientSubscriptionConfig;
 	opts?: ConfirmOptions;
 	txSenderConfig?: TxSenderConfig;
 	subAccountIds?: number[];
@@ -21,7 +21,7 @@ export type ClearingHouseConfig = {
 	authority?: PublicKey; // explicitly pass an authority if signer is delegate
 };
 
-type ClearingHouseSubscriptionConfig =
+type DriftClientSubscriptionConfig =
 	| {
 			type: 'websocket';
 	  }

package/src/examples/makeTradeExample.ts

@@ -4,8 +4,8 @@ import { Token, TOKEN_PROGRAM_ID } from '@solana/spl-token';
 import { Connection, Keypair, PublicKey } from '@solana/web3.js';
 import {
 	calculateReservePrice,
-	ClearingHouse,
-	ClearingHouseUser,
+	DriftClient,
+	User,
 	initialize,
 	PositionDirection,
 	convertToNumber,
@@ -64,18 +64,16 @@ const main = async () => {
 	);
 
 	// Set up the Drift Clearing House
-	const clearingHousePublicKey = new PublicKey(
-		sdkConfig.CLEARING_HOUSE_PROGRAM_ID
-	);
+	const driftPublicKey = new PublicKey(sdkConfig.CLEARING_HOUSE_PROGRAM_ID);
 	const bulkAccountLoader = new BulkAccountLoader(
 		connection,
 		'confirmed',
 		1000
 	);
-	const clearingHouse = new ClearingHouse({
+	const driftClient = new DriftClient({
 		connection,
 		wallet: provider.wallet,
-		programID: clearingHousePublicKey,
+		programID: driftPublicKey,
 		perpMarketIndexes: PerpMarkets[cluster].map((market) => market.marketIndex),
 		spotMarketIndexes: SpotMarkets[cluster].map(
 			(spotMarket) => spotMarket.marketIndex
@@ -85,12 +83,12 @@ const main = async () => {
 			accountLoader: bulkAccountLoader,
 		},
 	});
-	await clearingHouse.subscribe();
+	await driftClient.subscribe();
 
 	// Set up Clearing House user client
-	const user = new ClearingHouseUser({
-		clearingHouse,
-		userAccountPublicKey: await clearingHouse.getUserAccountPublicKey(),
+	const user = new User({
+		driftClient: driftClient,
+		userAccountPublicKey: await driftClient.getUserAccountPublicKey(),
 		accountSubscription: {
 			type: 'polling',
 			accountLoader: bulkAccountLoader,
@@ -103,7 +101,7 @@ const main = async () => {
 	if (!userAccountExists) {
 		//// Create a Clearing House account by Depositing some USDC ($10,000 in this case)
 		const depositAmount = new BN(10000).mul(QUOTE_PRECISION);
-		await clearingHouse.initializeUserAccountAndDepositCollateral(
+		await driftClient.initializeUserAccountAndDepositCollateral(
 			depositAmount,
 			await getTokenAddress(
 				usdcTokenAddress.toString(),
@@ -121,7 +119,7 @@ const main = async () => {
 	);
 
 	const currentMarketPrice = calculateReservePrice(
-		clearingHouse.getPerpMarketAccount(solMarketInfo.marketIndex),
+		driftClient.getPerpMarketAccount(solMarketInfo.marketIndex),
 		undefined
 	);
 
@@ -130,7 +128,7 @@ const main = async () => {
 	console.log(`Current Market Price is $${formattedPrice}`);
 
 	// Estimate the slippage for a $5000 LONG trade
-	const solMarketAccount = clearingHouse.getPerpMarketAccount(
+	const solMarketAccount = driftClient.getPerpMarketAccount(
 		solMarketInfo.marketIndex
 	);
 
@@ -151,7 +149,7 @@ const main = async () => {
 	);
 
 	// Make a $5000 LONG trade
-	await clearingHouse.openPosition(
+	await driftClient.openPosition(
 		PositionDirection.LONG,
 		longAmount,
 		solMarketInfo.marketIndex
@@ -160,14 +158,14 @@ const main = async () => {
 
 	// Reduce the position by $2000
 	const reduceAmount = new BN(2000).mul(QUOTE_PRECISION);
-	await clearingHouse.openPosition(
+	await driftClient.openPosition(
 		PositionDirection.SHORT,
 		reduceAmount,
 		solMarketInfo.marketIndex
 	);
 
 	// Close the rest of the position
-	await clearingHouse.closePosition(solMarketInfo.marketIndex);
+	await driftClient.closePosition(solMarketInfo.marketIndex);
 };
 
 main();