@drift-labs/sdk 0.1.18 → 0.1.20

package/src/accounts/pollingClearingHouseAccountSubscriber.ts

@@ -0,0 +1,293 @@
+import {
+	AccountToPoll,
+	ClearingHouseAccountEvents,
+	ClearingHouseAccountSubscriber,
+	ClearingHouseAccountTypes,
+	NotSubscribedError,
+} from './types';
+import { Program } from '@project-serum/anchor';
+import StrictEventEmitter from 'strict-event-emitter-types';
+import { EventEmitter } from 'events';
+import {
+	DepositHistoryAccount,
+	ExtendedCurveHistoryAccount,
+	FundingPaymentHistoryAccount,
+	FundingRateHistoryAccount,
+	LiquidationHistoryAccount,
+	MarketsAccount,
+	StateAccount,
+	TradeHistoryAccount,
+} from '../types';
+import { getClearingHouseStateAccountPublicKey } from '../addresses';
+import { BulkAccountLoader } from './bulkAccountLoader';
+import { capitalize } from './utils';
+import { ClearingHouseConfigType } from '../factory/clearingHouse';
+
+export class PollingClearingHouseAccountSubscriber
+	implements ClearingHouseAccountSubscriber
+{
+	isSubscribed: boolean;
+	program: Program;
+	eventEmitter: StrictEventEmitter<EventEmitter, ClearingHouseAccountEvents>;
+
+	accountLoader: BulkAccountLoader;
+	accountsToPoll = new Map<string, AccountToPoll>();
+	errorCallbackId?: string;
+
+	state?: StateAccount;
+	markets?: MarketsAccount;
+	tradeHistory?: TradeHistoryAccount;
+	depositHistory?: DepositHistoryAccount;
+	fundingPaymentHistory?: FundingPaymentHistoryAccount;
+	fundingRateHistory?: FundingRateHistoryAccount;
+	liquidationHistory?: LiquidationHistoryAccount;
+	extendedCurveHistory: ExtendedCurveHistoryAccount;
+
+	optionalExtraSubscriptions: ClearingHouseAccountTypes[] = [];
+
+	type: ClearingHouseConfigType = 'polling';
+
+	private isSubscribing = false;
+	private subscriptionPromise: Promise<boolean>;
+	private subscriptionPromiseResolver: (val: boolean) => void;
+
+	public constructor(program: Program, accountLoader: BulkAccountLoader) {
+		this.isSubscribed = false;
+		this.program = program;
+		this.eventEmitter = new EventEmitter();
+		this.accountLoader = accountLoader;
+	}
+
+	public async subscribe(
+		optionalSubscriptions?: ClearingHouseAccountTypes[]
+	): Promise<boolean> {
+		if (this.isSubscribed) {
+			return true;
+		}
+
+		if (this.isSubscribing) {
+			return await this.subscriptionPromise;
+		}
+
+		this.optionalExtraSubscriptions = optionalSubscriptions;
+
+		this.isSubscribing = true;
+
+		this.subscriptionPromise = new Promise((res) => {
+			this.subscriptionPromiseResolver = res;
+		});
+
+		await this.updateAccountsToPoll();
+		await this.addToAccountLoader();
+		await this.fetch();
+		this.eventEmitter.emit('update');
+
+		this.isSubscribing = false;
+		this.isSubscribed = true;
+		this.subscriptionPromiseResolver(true);
+
+		return true;
+	}
+
+	async updateAccountsToPoll(): Promise<void> {
+		if (this.accountsToPoll.size > 0) {
+			return;
+		}
+
+		const statePublicKey = await getClearingHouseStateAccountPublicKey(
+			this.program.programId
+		);
+
+		const state = (await this.program.account.state.fetch(
+			statePublicKey
+		)) as StateAccount;
+
+		this.accountsToPoll.set(statePublicKey.toString(), {
+			key: 'state',
+			publicKey: statePublicKey,
+			eventType: 'stateAccountUpdate',
+		});
+
+		this.accountsToPoll.set(state.markets.toString(), {
+			key: 'markets',
+			publicKey: state.markets,
+			eventType: 'marketsAccountUpdate',
+		});
+
+		if (this.optionalExtraSubscriptions?.includes('tradeHistoryAccount')) {
+			this.accountsToPoll.set(state.tradeHistory.toString(), {
+				key: 'tradeHistory',
+				publicKey: state.tradeHistory,
+				eventType: 'tradeHistoryAccountUpdate',
+			});
+		}
+
+		if (this.optionalExtraSubscriptions?.includes('depositHistoryAccount')) {
+			this.accountsToPoll.set(state.depositHistory.toString(), {
+				key: 'depositHistory',
+				publicKey: state.depositHistory,
+				eventType: 'depositHistoryAccountUpdate',
+			});
+		}
+
+		if (
+			this.optionalExtraSubscriptions?.includes('fundingPaymentHistoryAccount')
+		) {
+			this.accountsToPoll.set(state.fundingPaymentHistory.toString(), {
+				key: 'fundingPaymentHistory',
+				publicKey: state.fundingPaymentHistory,
+				eventType: 'fundingPaymentHistoryAccountUpdate',
+			});
+		}
+
+		if (
+			this.optionalExtraSubscriptions?.includes('fundingRateHistoryAccount')
+		) {
+			this.accountsToPoll.set(state.fundingRateHistory.toString(), {
+				key: 'fundingRateHistory',
+				publicKey: state.fundingRateHistory,
+				eventType: 'fundingRateHistoryAccountUpdate',
+			});
+		}
+
+		if (this.optionalExtraSubscriptions?.includes('curveHistoryAccount')) {
+			this.accountsToPoll.set(state.extendedCurveHistory.toString(), {
+				key: 'extendedCurveHistory',
+				publicKey: state.extendedCurveHistory,
+				eventType: 'curveHistoryAccountUpdate',
+			});
+		}
+
+		if (
+			this.optionalExtraSubscriptions?.includes('liquidationHistoryAccount')
+		) {
+			this.accountsToPoll.set(state.liquidationHistory.toString(), {
+				key: 'liquidationHistory',
+				publicKey: state.liquidationHistory,
+				eventType: 'liquidationHistoryAccountUpdate',
+			});
+		}
+	}
+
+	async addToAccountLoader(): Promise<void> {
+		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);
+		});
+	}
+
+	public 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);
+			}
+		}
+	}
+
+	public 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'
+			);
+		}
+	}
+
+	assertOptionalIsSubscribed(
+		optionalSubscription: ClearingHouseAccountTypes
+	): void {
+		if (!this.isSubscribed) {
+			throw new NotSubscribedError(
+				'You must call `subscribe` before using this function'
+			);
+		}
+
+		if (!this.optionalExtraSubscriptions.includes(optionalSubscription)) {
+			throw new NotSubscribedError(
+				`You need to subscribe to the optional Clearing House account "${optionalSubscription}" to use this method`
+			);
+		}
+	}
+
+	public getStateAccount(): StateAccount {
+		this.assertIsSubscribed();
+		return this.state;
+	}
+
+	public getMarketsAccount(): MarketsAccount {
+		this.assertIsSubscribed();
+		return this.markets;
+	}
+
+	public getTradeHistoryAccount(): TradeHistoryAccount {
+		this.assertIsSubscribed();
+		this.assertOptionalIsSubscribed('tradeHistoryAccount');
+		return this.tradeHistory;
+	}
+
+	public getDepositHistoryAccount(): DepositHistoryAccount {
+		this.assertIsSubscribed();
+		this.assertOptionalIsSubscribed('depositHistoryAccount');
+		return this.depositHistory;
+	}
+
+	public getFundingPaymentHistoryAccount(): FundingPaymentHistoryAccount {
+		this.assertIsSubscribed();
+		this.assertOptionalIsSubscribed('fundingPaymentHistoryAccount');
+		return this.fundingPaymentHistory;
+	}
+
+	public getFundingRateHistoryAccount(): FundingRateHistoryAccount {
+		this.assertIsSubscribed();
+		this.assertOptionalIsSubscribed('fundingRateHistoryAccount');
+		return this.fundingRateHistory;
+	}
+
+	public getCurveHistoryAccount(): ExtendedCurveHistoryAccount {
+		this.assertIsSubscribed();
+		this.assertOptionalIsSubscribed('curveHistoryAccount');
+		return this.extendedCurveHistory;
+	}
+
+	public getLiquidationHistoryAccount(): LiquidationHistoryAccount {
+		this.assertIsSubscribed();
+		this.assertOptionalIsSubscribed('liquidationHistoryAccount');
+		return this.liquidationHistory;
+	}
+}

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);
+}