@drift-labs/sdk 0.1.19-master.0 → 0.1.21-master.0

package/src/accounts/pollingTokenAccountSubscriber.ts

@@ -0,0 +1,99 @@
+import {
+	NotSubscribedError,
+	TokenAccountEvents,
+	TokenAccountSubscriber,
+} 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 { BulkAccountLoader } from './bulkAccountLoader';
+import { AccountInfo } from '@solana/spl-token';
+import { parseTokenAccount } from '../token';
+
+export class PollingTokenAccountSubscriber implements TokenAccountSubscriber {
+	isSubscribed: boolean;
+	program: Program;
+	eventEmitter: StrictEventEmitter<EventEmitter, TokenAccountEvents>;
+	publicKey: PublicKey;
+
+	accountLoader: BulkAccountLoader;
+	callbackId?: string;
+	errorCallbackId?: string;
+
+	tokenAccount?: AccountInfo;
+
+	public constructor(publicKey: PublicKey, accountLoader: BulkAccountLoader) {
+		this.isSubscribed = false;
+		this.publicKey = publicKey;
+		this.accountLoader = accountLoader;
+		this.eventEmitter = new EventEmitter();
+	}
+
+	async subscribe(): Promise<boolean> {
+		if (this.isSubscribed) {
+			return true;
+		}
+
+		this.addToAccountLoader();
+		await this.fetch();
+		this.eventEmitter.emit('update');
+
+		this.isSubscribed = true;
+		return true;
+	}
+
+	addToAccountLoader(): void {
+		if (this.callbackId) {
+			return;
+		}
+
+		this.callbackId = this.accountLoader.addAccount(
+			this.publicKey,
+			(buffer) => {
+				const tokenAccount = parseTokenAccount(buffer);
+				this.tokenAccount = tokenAccount;
+				// @ts-ignore
+				this.eventEmitter.emit('tokenAccountUpdate', tokenAccount);
+				this.eventEmitter.emit('update');
+			}
+		);
+
+		this.errorCallbackId = this.accountLoader.addErrorCallbacks((error) => {
+			this.eventEmitter.emit('error', error);
+		});
+	}
+
+	async fetch(): Promise<void> {
+		await this.accountLoader.load();
+		const buffer = this.accountLoader.getAccountData(this.publicKey);
+		this.tokenAccount = parseTokenAccount(buffer);
+	}
+
+	async unsubscribe(): Promise<void> {
+		if (!this.isSubscribed) {
+			return;
+		}
+
+		this.accountLoader.removeAccount(this.publicKey, this.callbackId);
+		this.callbackId = undefined;
+
+		this.accountLoader.removeErrorCallbacks(this.errorCallbackId);
+		this.errorCallbackId = undefined;
+
+		this.isSubscribed = false;
+	}
+
+	assertIsSubscribed(): void {
+		if (!this.isSubscribed) {
+			throw new NotSubscribedError(
+				'You must call `subscribe` before using this function'
+			);
+		}
+	}
+
+	public getTokenAccount(): AccountInfo {
+		this.assertIsSubscribed();
+		return this.tokenAccount;
+	}
+}

package/src/accounts/pollingUserAccountSubscriber.ts

@@ -0,0 +1,166 @@
+import {
+	AccountToPoll,
+	NotSubscribedError,
+	UserAccountEvents,
+	UserAccountSubscriber,
+} 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 { getUserAccountPublicKey } from '../addresses';
+import { UserAccount, UserPositionsAccount } from '../types';
+import { BulkAccountLoader } from './bulkAccountLoader';
+import { capitalize } from './utils';
+import { ClearingHouseConfigType } from '../factory/clearingHouse';
+
+export class PollingUserAccountSubscriber implements UserAccountSubscriber {
+	isSubscribed: boolean;
+	program: Program;
+	eventEmitter: StrictEventEmitter<EventEmitter, UserAccountEvents>;
+	authority: PublicKey;
+
+	accountLoader: BulkAccountLoader;
+	accountsToPoll = new Map<string, AccountToPoll>();
+	errorCallbackId?: string;
+
+	user?: UserAccount;
+	userPositions?: UserPositionsAccount;
+
+	type: ClearingHouseConfigType = 'polling';
+
+	public constructor(
+		program: Program,
+		authority: PublicKey,
+		accountLoader: BulkAccountLoader
+	) {
+		this.isSubscribed = false;
+		this.program = program;
+		this.authority = authority;
+		this.accountLoader = accountLoader;
+		this.eventEmitter = new EventEmitter();
+	}
+
+	async subscribe(): Promise<boolean> {
+		if (this.isSubscribed) {
+			return true;
+		}
+
+		await this.addToAccountLoader();
+		await this.fetchIfUnloaded();
+		this.eventEmitter.emit('update');
+
+		this.isSubscribed = true;
+		return true;
+	}
+
+	async addToAccountLoader(): Promise<void> {
+		if (this.accountsToPoll.size > 0) {
+			return;
+		}
+
+		const userPublicKey = await getUserAccountPublicKey(
+			this.program.programId,
+			this.authority
+		);
+
+		const userAccount = (await this.program.account.user.fetch(
+			userPublicKey
+		)) as UserAccount;
+
+		this.accountsToPoll.set(userPublicKey.toString(), {
+			key: 'user',
+			publicKey: userPublicKey,
+			eventType: 'userAccountData',
+		});
+
+		this.accountsToPoll.set(userAccount.positions.toString(), {
+			key: 'userPositions',
+			publicKey: userAccount.positions,
+			eventType: 'userPositionsData',
+		});
+
+		for (const [_, accountToPoll] of this.accountsToPoll) {
+			accountToPoll.callbackId = this.accountLoader.addAccount(
+				accountToPoll.publicKey,
+				(buffer) => {
+					const account = this.program.account[
+						accountToPoll.key
+					].coder.accounts.decode(capitalize(accountToPoll.key), buffer);
+					this[accountToPoll.key] = account;
+					// @ts-ignore
+					this.eventEmitter.emit(accountToPoll.eventType, account);
+					this.eventEmitter.emit('update');
+				}
+			);
+		}
+
+		this.errorCallbackId = this.accountLoader.addErrorCallbacks((error) => {
+			this.eventEmitter.emit('error', error);
+		});
+	}
+
+	async fetchIfUnloaded(): Promise<void> {
+		let shouldFetch = false;
+		for (const [_, accountToPoll] of this.accountsToPoll) {
+			if (this[accountToPoll.key] === undefined) {
+				shouldFetch = true;
+				break;
+			}
+		}
+
+		if (shouldFetch) {
+			await this.fetch();
+		}
+	}
+
+	async fetch(): Promise<void> {
+		await this.accountLoader.load();
+		for (const [_, accountToPoll] of this.accountsToPoll) {
+			const buffer = this.accountLoader.getAccountData(accountToPoll.publicKey);
+			if (buffer) {
+				this[accountToPoll.key] = this.program.account[
+					accountToPoll.key
+				].coder.accounts.decode(capitalize(accountToPoll.key), buffer);
+			}
+		}
+	}
+
+	async unsubscribe(): Promise<void> {
+		if (!this.isSubscribed) {
+			return;
+		}
+
+		for (const [_, accountToPoll] of this.accountsToPoll) {
+			this.accountLoader.removeAccount(
+				accountToPoll.publicKey,
+				accountToPoll.callbackId
+			);
+		}
+
+		this.accountLoader.removeErrorCallbacks(this.errorCallbackId);
+		this.errorCallbackId = undefined;
+
+		this.accountsToPoll.clear();
+
+		this.isSubscribed = false;
+	}
+
+	assertIsSubscribed(): void {
+		if (!this.isSubscribed) {
+			throw new NotSubscribedError(
+				'You must call `subscribe` before using this function'
+			);
+		}
+	}
+
+	public getUserAccount(): UserAccount {
+		this.assertIsSubscribed();
+		return this.user;
+	}
+
+	public getUserPositionsAccount(): UserPositionsAccount {
+		this.assertIsSubscribed();
+		return this.userPositions;
+	}
+}

package/src/accounts/types.ts

@@ -12,6 +12,9 @@ import {
 } from '../types';
 import StrictEventEmitter from 'strict-event-emitter-types';
 import { EventEmitter } from 'events';
+import { PublicKey } from '@solana/web3.js';
+import { AccountInfo } from '@solana/spl-token';
+import { ClearingHouseConfigType, ClearingHouseUserConfigType } from '..';
 
 export interface AccountSubscriber<T> {
 	data?: T;
@@ -36,6 +39,7 @@ export interface ClearingHouseAccountEvents {
 	depositHistoryAccountUpdate: (payload: DepositHistoryAccount) => void;
 	curveHistoryAccountUpdate: (payload: ExtendedCurveHistoryAccount) => void;
 	update: void;
+	error: (e: Error) => void;
 }
 
 export type ClearingHouseAccountTypes =
@@ -66,12 +70,15 @@ export interface ClearingHouseAccountSubscriber {
 	getFundingRateHistoryAccount(): FundingRateHistoryAccount;
 	getCurveHistoryAccount(): ExtendedCurveHistoryAccount;
 	getLiquidationHistoryAccount(): LiquidationHistoryAccount;
+
+	type: ClearingHouseConfigType;
 }
 
 export interface UserAccountEvents {
 	userAccountData: (payload: UserAccount) => void;
 	userPositionsData: (payload: UserPositionsAccount) => void;
 	update: void;
+	error: (e: Error) => void;
 }
 
 export interface UserAccountSubscriber {
@@ -84,4 +91,35 @@ export interface UserAccountSubscriber {
 
 	getUserAccount(): UserAccount;
 	getUserPositionsAccount(): UserPositionsAccount;
+
+	type: ClearingHouseUserConfigType;
+}
+
+export interface TokenAccountEvents {
+	tokenAccountUpdate: (payload: AccountInfo) => void;
+	update: void;
+	error: (e: Error) => void;
 }
+
+export interface TokenAccountSubscriber {
+	eventEmitter: StrictEventEmitter<EventEmitter, TokenAccountEvents>;
+	isSubscribed: boolean;
+
+	subscribe(): Promise<boolean>;
+	fetch(): Promise<void>;
+	unsubscribe(): Promise<void>;
+
+	getTokenAccount(): AccountInfo;
+}
+
+export type AccountToPoll = {
+	key: string;
+	publicKey: PublicKey;
+	eventType: string;
+	callbackId?: string;
+};
+
+export type AccountData = {
+	slot: number;
+	buffer: Buffer | undefined;
+};

package/src/accounts/utils.ts

@@ -0,0 +1,3 @@
+export function capitalize(value: string): string {
+	return value[0].toUpperCase() + value.slice(1);
+}

package/src/accounts/webSocketAccountSubscriber.ts

@@ -1,13 +1,17 @@
-import { AccountSubscriber } from './types';
+import { AccountData, AccountSubscriber } from './types';
 import { Program } from '@project-serum/anchor';
-import { PublicKey } from '@solana/web3.js';
+import { AccountInfo, Context, PublicKey } from '@solana/web3.js';
+import { capitalize } from './utils';
+import * as Buffer from 'buffer';
 
 export class WebSocketAccountSubscriber<T> implements AccountSubscriber<T> {
 	data?: T;
+	accountData?: AccountData;
 	accountName: string;
 	program: Program;
 	accountPublicKey: PublicKey;
 	onChange: (data: T) => void;
+	listenerId?: number;
 
 	public constructor(
 		accountName: string,
@@ -20,32 +24,78 @@ export class WebSocketAccountSubscriber<T> implements AccountSubscriber<T> {
 	}
 
 	async subscribe(onChange: (data: T) => void): Promise<void> {
+		if (this.listenerId) {
+			return;
+		}
+
 		this.onChange = onChange;
 		await this.fetch();
 
-		this.program.account[this.accountName]
-			.subscribe(this.accountPublicKey, this.program.provider.opts.commitment)
-			.on('change', async (data: T) => {
-				this.data = data;
-				this.onChange(data);
-			});
+		this.listenerId = this.program.provider.connection.onAccountChange(
+			this.accountPublicKey,
+			(accountInfo, context) => {
+				this.handleRpcResponse(context, accountInfo);
+			},
+			this.program.provider.opts.commitment
+		);
 	}
 
 	async fetch(): Promise<void> {
-		const newData = (await this.program.account[this.accountName].fetch(
-			this.accountPublicKey
-		)) as T;
+		const rpcResponse =
+			await this.program.provider.connection.getAccountInfoAndContext(
+				this.accountPublicKey,
+				this.program.provider.opts.commitment
+			);
+		this.handleRpcResponse(rpcResponse.context, rpcResponse?.value);
+	}
+
+	handleRpcResponse(context: Context, accountInfo?: AccountInfo<Buffer>): void {
+		const newSlot = context.slot;
+		let newBuffer: Buffer | undefined = undefined;
+		if (accountInfo) {
+			newBuffer = accountInfo.data;
+		}
 
-		// if data has changed trigger update
-		if (JSON.stringify(newData) !== JSON.stringify(this.data)) {
-			this.data = newData;
+		if (!this.accountData) {
+			this.accountData = {
+				buffer: newBuffer,
+				slot: newSlot,
+			};
+			if (newBuffer) {
+				this.data = this.program.account[
+					this.accountName
+				].coder.accounts.decode(capitalize(this.accountName), newBuffer);
+				this.onChange(this.data);
+			}
+			return;
+		}
+
+		if (newSlot <= this.accountData.slot) {
+			return;
+		}
+
+		const oldBuffer = this.accountData.buffer;
+		if (newBuffer && (!oldBuffer || !newBuffer.equals(oldBuffer))) {
+			this.accountData = {
+				buffer: newBuffer,
+				slot: newSlot,
+			};
+			this.data = this.program.account[this.accountName].coder.accounts.decode(
+				capitalize(this.accountName),
+				newBuffer
+			);
 			this.onChange(this.data);
 		}
 	}
 
 	unsubscribe(): Promise<void> {
-		return this.program.account[this.accountName].unsubscribe(
-			this.accountPublicKey
-		);
+		if (this.listenerId) {
+			const promise =
+				this.program.provider.connection.removeAccountChangeListener(
+					this.listenerId
+				);
+			this.listenerId = undefined;
+			return promise;
+		}
 	}
 }

package/src/accounts/{defaultClearingHouseAccountSubscriber.ts → webSocketClearingHouseAccountSubscriber.ts}

@@ -19,8 +19,9 @@ import StrictEventEmitter from 'strict-event-emitter-types';
 import { EventEmitter } from 'events';
 import { getClearingHouseStateAccountPublicKey } from '../addresses';
 import { WebSocketAccountSubscriber } from './webSocketAccountSubscriber';
+import { ClearingHouseConfigType } from '../factory/clearingHouse';
 
-export class DefaultClearingHouseAccountSubscriber
+export class WebSocketClearingHouseAccountSubscriber
 	implements ClearingHouseAccountSubscriber
 {
 	isSubscribed: boolean;
@@ -37,6 +38,8 @@ export class DefaultClearingHouseAccountSubscriber
 
 	optionalExtraSubscriptions: ClearingHouseAccountTypes[] = [];
 
+	type: ClearingHouseConfigType = 'websocket';
+
 	private isSubscribing = false;
 	private subscriptionPromise: Promise<boolean>;
 	private subscriptionPromiseResolver: (val: boolean) => void;

package/src/accounts/{defaultUserAccountSubscriber.ts → webSocketUserAccountSubscriber.ts}

@@ -11,8 +11,9 @@ import { PublicKey } from '@solana/web3.js';
 import { getUserAccountPublicKey } from '../addresses';
 import { WebSocketAccountSubscriber } from './webSocketAccountSubscriber';
 import { UserAccount, UserPositionsAccount } from '../types';
+import { ClearingHouseConfigType } from '../factory/clearingHouse';
 
-export class DefaultUserAccountSubscriber implements UserAccountSubscriber {
+export class WebSocketUserAccountSubscriber implements UserAccountSubscriber {
 	isSubscribed: boolean;
 	program: Program;
 	eventEmitter: StrictEventEmitter<EventEmitter, UserAccountEvents>;
@@ -21,6 +22,8 @@ export class DefaultUserAccountSubscriber implements UserAccountSubscriber {
 	userDataAccountSubscriber: AccountSubscriber<UserAccount>;
 	userPositionsAccountSubscriber: AccountSubscriber<UserPositionsAccount>;
 
+	type: ClearingHouseConfigType = 'websocket';
+
 	public constructor(program: Program, authority: PublicKey) {
 		this.isSubscribed = false;
 		this.program = program;

package/src/admin.ts

@@ -6,17 +6,18 @@ import {
 	TransactionSignature,
 } from '@solana/web3.js';
 import { FeeStructure, IWallet, OracleGuardRails, OracleSource } from './types';
-import { BN, Idl, Program, Provider } from '@project-serum/anchor';
+import { BN, Provider } from '@project-serum/anchor';
 import * as anchor from '@project-serum/anchor';
 import { getClearingHouseStateAccountPublicKeyAndNonce } from './addresses';
 import { TOKEN_PROGRAM_ID } from '@solana/spl-token';
 import { ClearingHouse } from './clearingHouse';
 import { PEG_PRECISION } from './constants/numericConstants';
-import clearingHouseIDL from './idl/clearing_house.json';
-import { DefaultClearingHouseAccountSubscriber } from './accounts/defaultClearingHouseAccountSubscriber';
-import { DefaultTxSender } from './tx/defaultTxSender';
 import { calculateTargetPriceTrade } from './math/trade';
 import { calculateAmmReservesAfterSwap, getSwapDirection } from './math/amm';
+import {
+	getAdmin,
+	getWebSocketClearingHouseConfig,
+} from './factory/clearingHouse';
 
 export class Admin extends ClearingHouse {
 	public static from(
@@ -25,24 +26,13 @@ export class Admin extends ClearingHouse {
 		clearingHouseProgramId: PublicKey,
 		opts: ConfirmOptions = Provider.defaultOptions()
 	): Admin {
-		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 Admin(
+		const config = getWebSocketClearingHouseConfig(
 			connection,
 			wallet,
-			program,
-			accountSubscriber,
-			txSender,
+			clearingHouseProgramId,
 			opts
 		);
+		return getAdmin(config);
 	}
 
 	public async initialize(
@@ -338,6 +328,25 @@ export class Admin extends ClearingHouse {
 		});
 	}
 
+	public async resetAmmOracleTwap(
+		marketIndex: BN
+	): Promise<TransactionSignature> {
+		const state = this.getStateAccount();
+		const markets = this.getMarketsAccount();
+		const marketData = markets.markets[marketIndex.toNumber()];
+		const ammData = marketData.amm;
+
+		return await this.program.rpc.resetAmmOracleTwap(marketIndex, {
+			accounts: {
+				state: await this.getStatePublicKey(),
+				admin: this.wallet.publicKey,
+				oracle: ammData.oracle,
+				markets: state.markets,
+				curveHistory: state.extendedCurveHistory,
+			},
+		});
+	}
+
 	public async withdrawFromInsuranceVault(
 		amount: BN,
 		recipient: PublicKey

package/src/clearingHouse.ts

@@ -44,16 +44,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 {
@@ -64,33 +67,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(