@drift-labs/sdk 0.1.18-orders.0 → 0.1.18-orders.4

package/src/clearingHouse.ts

@@ -7,7 +7,6 @@ import {
 import {
 	MarketsAccount,
 	StateAccount,
-	CurveHistoryAccount,
 	DepositHistoryAccount,
 	FundingPaymentHistoryAccount,
 	FundingRateHistoryAccount,
@@ -21,6 +20,7 @@ import {
 	OrderStateAccount,
 	OrderParams,
 	Order,
+	ExtendedCurveHistoryAccount,
 } from './types';
 import * as anchor from '@project-serum/anchor';
 import clearingHouseIDL from './idl/clearing_house.json';
@@ -51,16 +51,19 @@ import {
 	ClearingHouseAccountEvents,
 	ClearingHouseAccountTypes,
 } from './accounts/types';
-import { DefaultClearingHouseAccountSubscriber } from './accounts/defaultClearingHouseAccountSubscriber';
 import { TxSender } from './tx/types';
 import { DefaultTxSender } from './tx/defaultTxSender';
 import { wrapInTx } from './tx/utils';
+import {
+	getClearingHouse,
+	getWebSocketClearingHouseConfig,
+} from './factory/clearingHouse';
 
 /**
  * # ClearingHouse
  * 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.
  *
- * The default way to construct a ClearingHouse instance is using the {@link from} method. This will create an instance using the static {@link DefaultClearingHouseAccountSubscriber}, which will use a websocket for each state account subscription.
+ * The default way to construct a ClearingHouse instance is using the {@link from} method. This will create an instance using the static {@link WebSocketClearingHouseAccountSubscriber}, which will use a websocket for each state account subscription.
  * Alternatively, if you want to implement your own method of subscribing to the state accounts on the blockchain, you can implement a {@link ClearingHouseAccountSubscriber} and use it in the {@link ClearingHouse.constructor}
  */
 export class ClearingHouse {
@@ -71,33 +74,38 @@ export class ClearingHouse {
 	opts?: ConfirmOptions;
 	accountSubscriber: ClearingHouseAccountSubscriber;
 	eventEmitter: StrictEventEmitter<EventEmitter, ClearingHouseAccountEvents>;
-	isSubscribed = false;
+	_isSubscribed = false;
 	txSender: TxSender;
 
+	public get isSubscribed() {
+		return this._isSubscribed && this.accountSubscriber.isSubscribed;
+	}
+
+	public set isSubscribed(val: boolean) {
+		this._isSubscribed = val;
+	}
+
+	/**
+	 * @deprecated You should use the getClearingHouse factory method instead
+	 * @param connection
+	 * @param wallet
+	 * @param clearingHouseProgramId
+	 * @param opts
+	 * @returns
+	 */
 	public static from(
 		connection: Connection,
 		wallet: IWallet,
 		clearingHouseProgramId: PublicKey,
 		opts: ConfirmOptions = Provider.defaultOptions()
 	): ClearingHouse {
-		const provider = new Provider(connection, wallet, opts);
-		const program = new Program(
-			clearingHouseIDL as Idl,
-			clearingHouseProgramId,
-			provider
-		);
-		const accountSubscriber = new DefaultClearingHouseAccountSubscriber(
-			program
-		);
-		const txSender = new DefaultTxSender(provider);
-		return new ClearingHouse(
+		const config = getWebSocketClearingHouseConfig(
 			connection,
 			wallet,
-			program,
-			accountSubscriber,
-			txSender,
+			clearingHouseProgramId,
 			opts
 		);
+		return getClearingHouse(config);
 	}
 
 	public constructor(
@@ -208,7 +216,7 @@ export class ClearingHouse {
 		return this.accountSubscriber.getDepositHistoryAccount();
 	}
 
-	public getCurveHistoryAccount(): CurveHistoryAccount {
+	public getCurveHistoryAccount(): ExtendedCurveHistoryAccount {
 		return this.accountSubscriber.getCurveHistoryAccount();
 	}
 
@@ -335,16 +343,16 @@ export class ClearingHouse {
 	async getInitializeUserOrdersInstruction(
 		userAccountPublicKey?: PublicKey
 	): Promise<TransactionInstruction> {
+		if (!userAccountPublicKey) {
+			userAccountPublicKey = await this.getUserAccountPublicKey();
+		}
+
 		const [userOrdersAccountPublicKey, userOrdersAccountNonce] =
 			await getUserOrdersAccountPublicKeyAndNonce(
 				this.program.programId,
-				this.wallet.publicKey
+				userAccountPublicKey
 			);
 
-		if (!userAccountPublicKey) {
-			userAccountPublicKey = await this.getUserAccountPublicKey();
-		}
-
 		return await this.program.instruction.initializeUserOrders(
 			userOrdersAccountNonce,
 			{
@@ -401,11 +409,25 @@ export class ClearingHouse {
 
 		this.userOrdersAccountPublicKey = await getUserOrdersAccountPublicKey(
 			this.program.programId,
-			this.wallet.publicKey
+			await this.getUserAccountPublicKey()
 		);
 		return this.userOrdersAccountPublicKey;
 	}
 
+	userOrdersExist?: boolean;
+	async userOrdersAccountExists(): Promise<boolean> {
+		if (this.userOrdersExist) {
+			return this.userOrdersExist;
+		}
+		const userOrdersAccountRPCResponse =
+			await this.connection.getParsedAccountInfo(
+				await this.getUserOrdersAccountPublicKey()
+			);
+
+		this.userOrdersExist = userOrdersAccountRPCResponse.value !== null;
+		return this.userOrdersExist;
+	}
+
 	public async depositCollateral(
 		amount: BN,
 		collateralAccountPublicKey: PublicKey,
@@ -660,6 +682,27 @@ export class ClearingHouse {
 		);
 	}
 
+	public async initializeUserOrdersThenPlaceOrder(
+		orderParams: OrderParams,
+		discountToken?: PublicKey,
+		referrer?: PublicKey
+	): Promise<TransactionSignature> {
+		const instructions: anchor.web3.TransactionInstruction[] = [];
+		const userOrdersAccountExists = await this.userOrdersAccountExists();
+		if (!userOrdersAccountExists) {
+			instructions.push(await this.getInitializeUserOrdersInstruction());
+		}
+		instructions.push(
+			await this.getPlaceOrderIx(orderParams, discountToken, referrer)
+		);
+		const tx = new Transaction();
+		for (const instruction of instructions) {
+			tx.add(instruction);
+		}
+
+		return await this.txSender.send(tx, [], this.opts);
+	}
+
 	public async placeOrder(
 		orderParams: OrderParams,
 		discountToken?: PublicKey,
@@ -765,6 +808,40 @@ export class ClearingHouse {
 		});
 	}
 
+	public async cancelOrderByUserId(
+		userOrderId: number
+	): Promise<TransactionSignature> {
+		return await this.txSender.send(
+			wrapInTx(await this.getCancelOrderByUserIdIx(userOrderId)),
+			[],
+			this.opts
+		);
+	}
+
+	public async getCancelOrderByUserIdIx(
+		userOrderId: number
+	): Promise<TransactionInstruction> {
+		const userAccountPublicKey = await this.getUserAccountPublicKey();
+		const userAccount = await this.getUserAccount();
+
+		const state = this.getStateAccount();
+		const orderState = this.getOrderStateAccount();
+		return await this.program.instruction.cancelOrderByUserId(userOrderId, {
+			accounts: {
+				state: await this.getStatePublicKey(),
+				user: userAccountPublicKey,
+				authority: this.wallet.publicKey,
+				markets: state.markets,
+				userOrders: await this.getUserOrdersAccountPublicKey(),
+				userPositions: userAccount.positions,
+				fundingPaymentHistory: state.fundingPaymentHistory,
+				fundingRateHistory: state.fundingRateHistory,
+				orderState: await this.getOrderStatePublicKey(),
+				orderHistory: orderState.orderHistory,
+			},
+		});
+	}
+
 	public async fillOrder(
 		userAccountPublicKey: PublicKey,
 		userOrdersAccountPublicKey: PublicKey,
@@ -823,12 +900,34 @@ export class ClearingHouse {
 				fundingRateHistory: state.fundingRateHistory,
 				orderState: await this.getOrderStatePublicKey(),
 				orderHistory: orderState.orderHistory,
+				extendedCurveHistory: state.extendedCurveHistory,
 				oracle: oracle,
 			},
 			remainingAccounts,
 		});
 	}
 
+	public async initializeUserOrdersThenPlaceAndFillOrder(
+		orderParams: OrderParams,
+		discountToken?: PublicKey,
+		referrer?: PublicKey
+	): Promise<TransactionSignature> {
+		const instructions: anchor.web3.TransactionInstruction[] = [];
+		const userOrdersAccountExists = await this.userOrdersAccountExists();
+		if (!userOrdersAccountExists) {
+			instructions.push(await this.getInitializeUserOrdersInstruction());
+		}
+		instructions.push(
+			await this.getPlaceAndFillOrderIx(orderParams, discountToken, referrer)
+		);
+		const tx = new Transaction();
+		for (const instruction of instructions) {
+			tx.add(instruction);
+		}
+
+		return await this.txSender.send(tx, [], this.opts);
+	}
+
 	public async placeAndFillOrder(
 		orderParams: OrderParams,
 		discountToken?: PublicKey,
@@ -899,6 +998,7 @@ export class ClearingHouse {
 				fundingRateHistory: state.fundingRateHistory,
 				orderState: await this.getOrderStatePublicKey(),
 				orderHistory: orderState.orderHistory,
+				extendedCurveHistory: state.extendedCurveHistory,
 				oracle: priceOracle,
 			},
 			remainingAccounts,

package/src/clearingHouseUser.ts

@@ -1,5 +1,4 @@
 import { PublicKey } from '@solana/web3.js';
-import BN from 'bn.js';
 import { EventEmitter } from 'events';
 import StrictEventEmitter from 'strict-event-emitter-types';
 import { ClearingHouse } from './clearingHouse';
@@ -24,7 +23,6 @@ import {
 	PRICE_TO_QUOTE_PRECISION,
 } from './constants/numericConstants';
 import { UserAccountSubscriber, UserAccountEvents } from './accounts/types';
-import { DefaultUserAccountSubscriber } from './accounts/defaultUserAccountSubscriber';
 import {
 	calculateMarkPrice,
 	calculateBaseAssetValue,
@@ -34,8 +32,13 @@ import {
 	getUserOrdersAccountPublicKey,
 	calculateNewStateAfterOrder,
 	calculateTradeSlippage,
+	BN,
 } from '.';
 import { getUserAccountPublicKey } from './addresses';
+import {
+	getClearingHouseUser,
+	getWebSocketClearingHouseUserConfig,
+} from './factory/clearingHouseUser';
 
 export class ClearingHouseUser {
 	clearingHouse: ClearingHouse;
@@ -43,18 +46,35 @@ export class ClearingHouseUser {
 	accountSubscriber: UserAccountSubscriber;
 	userAccountPublicKey?: PublicKey;
 	userOrdersAccountPublicKey?: PublicKey;
-	isSubscribed = false;
+	_isSubscribed = false;
 	eventEmitter: StrictEventEmitter<EventEmitter, UserAccountEvents>;
 
+	public get isSubscribed() {
+		return this._isSubscribed && this.accountSubscriber.isSubscribed;
+	}
+
+	public set isSubscribed(val: boolean) {
+		this._isSubscribed = val;
+	}
+
+	/**
+	 * @deprecated You should use getClearingHouseUser factory method instead
+	 * @param clearingHouse
+	 * @param authority
+	 * @returns
+	 */
 	public static from(
 		clearingHouse: ClearingHouse,
 		authority: PublicKey
 	): ClearingHouseUser {
-		const accountSubscriber = new DefaultUserAccountSubscriber(
-			clearingHouse.program,
+		if (clearingHouse.accountSubscriber.type !== 'websocket')
+			throw 'This method only works for clearing houses with a websocket account listener. Try using the getClearingHouseUser factory method to initialize a ClearingHouseUser instead';
+
+		const config = getWebSocketClearingHouseUserConfig(
+			clearingHouse,
 			authority
 		);
-		return new ClearingHouseUser(clearingHouse, authority, accountSubscriber);
+		return getClearingHouseUser(config);
 	}
 
 	public constructor(
@@ -100,7 +120,7 @@ export class ClearingHouseUser {
 		return this.accountSubscriber.getUserPositionsAccount();
 	}
 
-	public getUserOrdersAccount(): UserOrdersAccount {
+	public getUserOrdersAccount(): UserOrdersAccount | undefined {
 		return this.accountSubscriber.getUserOrdersAccount();
 	}
 
@@ -154,7 +174,7 @@ export class ClearingHouseUser {
 
 		this.userOrdersAccountPublicKey = await getUserOrdersAccountPublicKey(
 			this.clearingHouse.program.programId,
-			this.authority
+			await this.getUserAccountPublicKey()
 		);
 		return this.userOrdersAccountPublicKey;
 	}

package/src/config.ts

@@ -11,7 +11,7 @@ export const configs: { [key in DriftEnv]: DriftConfig } = {
 	devnet: {
 		ENV: 'devnet',
 		PYTH_ORACLE_MAPPING_ADDRESS: 'BmA9Z6FjioHJPpjT39QazZyhDRUdZy2ezwx4GiDdE2u2',
-		CLEARING_HOUSE_PROGRAM_ID: 'HiZ8CnfEE9LrBZTfc8hBneWrPg1Cbsn8Wdy6SPLfae9V',
+		CLEARING_HOUSE_PROGRAM_ID: '3PfbDmWxR6e2rJ2brhSv7KJyUrHbSCu63d3FHqdLhxUJ',
 		USDC_MINT_ADDRESS: '8zGuJQqwhZafTah7Uc7Z4tXRnguqkn5KLFAP8oV6PHe2',
 	},
 	'mainnet-beta': {

package/src/constants/markets.ts

@@ -1,4 +1,4 @@
-import BN from 'bn.js';
+import { BN } from '../';
 
 type Market = {
 	symbol: string;
@@ -90,4 +90,28 @@ export const Markets: Market[] = [
 		mainnetPythOracle: '3pyn4svBbxJ9Wnn3RVeafyLWfzie6yC5eTig2S62v9SC',
 		launchTs: 1643084413000,
 	},
+	{
+		symbol: 'ALGO-PERP',
+		baseAssetSymbol: 'ALGO',
+		marketIndex: new BN(10),
+		devnetPythOracle: 'c1A946dY5NHuVda77C8XXtXytyR3wK1SCP3eA9VRfC3',
+		mainnetPythOracle: 'HqFyq1wh1xKvL7KDqqT7NJeSPdAqsDqnmBisUC2XdXAX',
+		launchTs: 1643686767000,
+	},
+	{
+		symbol: 'FTT-PERP',
+		baseAssetSymbol: 'FTT',
+		marketIndex: new BN(11),
+		devnetPythOracle: '6vivTRs5ZPeeXbjo7dfburfaYDWoXjBtdtuYgQRuGfu',
+		mainnetPythOracle: '8JPJJkmDScpcNmBRKGZuPuG2GYAveQgP3t5gFuMymwvF',
+		launchTs: 1644382122000,
+	},
+	// {
+	// 	symbol: 'mSOL-PERP',
+	// 	baseAssetSymbol: 'mSOL',
+	// 	marketIndex: new BN(11), //todo
+	// 	devnetPythOracle: '9a6RNx3tCu1TSs6TBSfV2XRXEPEZXQ6WB7jRojZRvyeZ',
+	// 	mainnetPythOracle: 'E4v1BBgoso9s64TQvmyownAVJbhbEPGyzA3qn4n46qj9',
+	// 	launchTs: 1643346125000,
+	// },
 ];

package/src/constants/numericConstants.ts

@@ -1,4 +1,4 @@
-import BN from 'bn.js';
+import { BN } from '../';
 
 export const ZERO = new BN(0);
 export const ONE = new BN(1);
@@ -15,6 +15,7 @@ export const FUNDING_PAYMENT_PRECISION = new BN(10000);
 export const PEG_PRECISION = new BN(1000);
 
 export const AMM_RESERVE_PRECISION = new BN(10 ** 13);
+export const BASE_PRECISION = AMM_RESERVE_PRECISION;
 export const AMM_TO_QUOTE_PRECISION_RATIO =
 	AMM_RESERVE_PRECISION.div(QUOTE_PRECISION); // 10^7
 export const PRICE_TO_QUOTE_PRECISION =

package/src/examples/makeTradeExample.ts

@@ -95,7 +95,10 @@ const main = async () => {
 		clearingHouse.getMarket(solMarketInfo.marketIndex)
 	);
 
-	const formattedPrice = convertToNumber(currentMarketPrice, QUOTE_PRECISION);
+	const formattedPrice = convertToNumber(
+		currentMarketPrice,
+		MARK_PRICE_PRECISION
+	);
 
 	console.log(`Current Market Price is $${formattedPrice}`);
 

package/src/factory/clearingHouse.ts

@@ -0,0 +1,125 @@
+import { ConfirmOptions, Connection, PublicKey } from '@solana/web3.js';
+import { IWallet } from '../types';
+import { BulkAccountLoader } from '../accounts/bulkAccountLoader';
+import { TxSender } from '../tx/types';
+import { Idl, Program, Provider } from '@project-serum/anchor';
+import { ClearingHouse } from '../clearingHouse';
+import clearingHouseIDL from '../idl/clearing_house.json';
+import { WebSocketClearingHouseAccountSubscriber } from '../accounts/webSocketClearingHouseAccountSubscriber';
+import { DefaultTxSender } from '../tx/defaultTxSender';
+import { ClearingHouseAccountSubscriber } from '../accounts/types';
+import { PollingClearingHouseAccountSubscriber } from '../accounts/pollingClearingHouseAccountSubscriber';
+import { Admin } from '../admin';
+
+export type ClearingHouseConfigType = 'websocket' | 'polling' | 'custom';
+
+type BaseClearingHouseConfig = {
+	type: ClearingHouseConfigType;
+	connection: Connection;
+	wallet: IWallet;
+	programID: PublicKey;
+	opts?: ConfirmOptions;
+	txSender?: TxSender;
+};
+
+type WebSocketClearingHouseConfiguration = BaseClearingHouseConfig;
+
+type PollingClearingHouseConfiguration = BaseClearingHouseConfig & {
+	accountLoader: BulkAccountLoader;
+};
+
+type ClearingHouseConfig =
+	| PollingClearingHouseConfiguration
+	| WebSocketClearingHouseConfiguration;
+
+export function getWebSocketClearingHouseConfig(
+	connection: Connection,
+	wallet: IWallet,
+	programID: PublicKey,
+	opts: ConfirmOptions = Provider.defaultOptions(),
+	txSender?: TxSender
+): WebSocketClearingHouseConfiguration {
+	return {
+		type: 'websocket',
+		connection,
+		wallet,
+		programID,
+		opts,
+		txSender,
+	};
+}
+
+export function getPollingClearingHouseConfig(
+	connection: Connection,
+	wallet: IWallet,
+	programID: PublicKey,
+	accountLoader: BulkAccountLoader,
+	opts: ConfirmOptions = Provider.defaultOptions(),
+	txSender?: TxSender
+): PollingClearingHouseConfiguration {
+	return {
+		type: 'polling',
+		connection,
+		wallet,
+		programID,
+		accountLoader,
+		opts,
+		txSender,
+	};
+}
+
+export function getClearingHouse(config: ClearingHouseConfig): ClearingHouse {
+	const provider = new Provider(config.connection, config.wallet, config.opts);
+	const program = new Program(
+		clearingHouseIDL as Idl,
+		config.programID,
+		provider
+	);
+	let accountSubscriber: ClearingHouseAccountSubscriber;
+	if (config.type === 'websocket') {
+		accountSubscriber = new WebSocketClearingHouseAccountSubscriber(program);
+	} else if (config.type === 'polling') {
+		accountSubscriber = new PollingClearingHouseAccountSubscriber(
+			program,
+			(config as PollingClearingHouseConfiguration).accountLoader
+		);
+	}
+
+	const txSender = config.txSender || new DefaultTxSender(provider);
+	return new ClearingHouse(
+		config.connection,
+		config.wallet,
+		program,
+		accountSubscriber,
+		txSender,
+		config.opts
+	);
+}
+
+export function getAdmin(config: ClearingHouseConfig): Admin {
+	const provider = new Provider(config.connection, config.wallet, config.opts);
+	const program = new Program(
+		clearingHouseIDL as Idl,
+		config.programID,
+		provider
+	);
+	let accountSubscriber: ClearingHouseAccountSubscriber;
+	if (config.type === 'websocket') {
+		accountSubscriber = new WebSocketClearingHouseAccountSubscriber(program);
+	} else if (config.type === 'polling') {
+		accountSubscriber = new PollingClearingHouseAccountSubscriber(
+			program,
+			(config as PollingClearingHouseConfiguration).accountLoader
+		);
+	}
+
+	const txSender = config.txSender || new DefaultTxSender(provider);
+	return new Admin(
+		config.connection,
+		config.wallet,
+		program,
+		accountSubscriber,
+		txSender,
+		config.opts
+	);
+}

package/src/factory/clearingHouseUser.ts

@@ -0,0 +1,73 @@
+import { PublicKey } from '@solana/web3.js';
+import { ClearingHouse } from '../clearingHouse';
+import { BulkAccountLoader } from '../accounts/bulkAccountLoader';
+import { ClearingHouseUser } from '../clearingHouseUser';
+import { UserAccountSubscriber } from '../accounts/types';
+import { WebSocketUserAccountSubscriber } from '../accounts/webSocketUserAccountSubscriber';
+import { PollingUserAccountSubscriber } from '../accounts/pollingUserAccountSubscriber';
+
+export type ClearingHouseUserConfigType = 'websocket' | 'polling' | 'custom';
+
+type BaseClearingHouseUserConfig = {
+	type: ClearingHouseUserConfigType;
+	clearingHouse: ClearingHouse;
+	authority: PublicKey;
+};
+
+type WebSocketClearingHouseUserConfig = BaseClearingHouseUserConfig;
+
+type PollingClearingHouseUserConfig = BaseClearingHouseUserConfig & {
+	accountLoader: BulkAccountLoader;
+};
+
+type ClearingHouseUserConfig =
+	| PollingClearingHouseUserConfig
+	| WebSocketClearingHouseUserConfig;
+
+export function getWebSocketClearingHouseUserConfig(
+	clearingHouse: ClearingHouse,
+	authority: PublicKey
+): WebSocketClearingHouseUserConfig {
+	return {
+		type: 'websocket',
+		clearingHouse,
+		authority,
+	};
+}
+
+export function getPollingClearingHouseUserConfig(
+	clearingHouse: ClearingHouse,
+	authority: PublicKey,
+	accountLoader: BulkAccountLoader
+): PollingClearingHouseUserConfig {
+	return {
+		type: 'polling',
+		clearingHouse,
+		authority,
+		accountLoader,
+	};
+}
+
+export function getClearingHouseUser(
+	config: ClearingHouseUserConfig
+): ClearingHouseUser {
+	let accountSubscriber: UserAccountSubscriber;
+	if (config.type === 'websocket') {
+		accountSubscriber = new WebSocketUserAccountSubscriber(
+			config.clearingHouse.program,
+			config.authority
+		);
+	} else if (config.type === 'polling') {
+		accountSubscriber = new PollingUserAccountSubscriber(
+			config.clearingHouse.program,
+			config.authority,
+			(config as PollingClearingHouseUserConfig).accountLoader
+		);
+	}
+
+	return new ClearingHouseUser(
+		config.clearingHouse,
+		config.authority,
+		accountSubscriber
+	);
+}