@drift-labs/sdk 0.1.19-master.1 → 0.1.21-master.3

package/src/accounts/bulkAccountLoader.ts

@@ -0,0 +1,215 @@
+import { Commitment, Connection, PublicKey } from '@solana/web3.js';
+import { v4 as uuidv4 } from 'uuid';
+import { AccountData } from './types';
+
+type AccountToLoad = {
+	publicKey: PublicKey;
+	callbacks: Map<string, (buffer: Buffer) => void>;
+};
+
+const GET_MULTIPLE_ACCOUNTS_CHUNK_SIZE = 99;
+
+export class BulkAccountLoader {
+	connection: Connection;
+	commitment: Commitment;
+	pollingFrequency: number;
+	accountsToLoad = new Map<string, AccountToLoad>();
+	accountData = new Map<string, AccountData>();
+	errorCallbacks = new Map<string, (e) => void>();
+	intervalId?: NodeJS.Timer;
+	// to handle clients spamming load
+	loadPromise?: Promise<void>;
+	loadPromiseResolver: () => void;
+
+	public constructor(
+		connection: Connection,
+		commitment: Commitment,
+		pollingFrequency: number
+	) {
+		this.connection = connection;
+		this.commitment = commitment;
+		this.pollingFrequency = pollingFrequency;
+	}
+
+	public addAccount(
+		publicKey: PublicKey,
+		callback: (buffer: Buffer) => void
+	): string {
+		const existingSize = this.accountsToLoad.size;
+
+		const callbackId = uuidv4();
+		const existingAccountToLoad = this.accountsToLoad.get(publicKey.toString());
+		if (existingAccountToLoad) {
+			existingAccountToLoad.callbacks.set(callbackId, callback);
+		} else {
+			const callbacks = new Map<string, (buffer: Buffer) => void>();
+			callbacks.set(callbackId, callback);
+			const newAccountToLoad = {
+				publicKey,
+				callbacks,
+			};
+			this.accountsToLoad.set(publicKey.toString(), newAccountToLoad);
+		}
+
+		if (existingSize === 0) {
+			this.startPolling();
+		}
+
+		// if a new account needs to be polled, remove the cached loadPromise in case client calls load immediately after
+		this.loadPromise = undefined;
+
+		return callbackId;
+	}
+
+	public removeAccount(publicKey: PublicKey, callbackId: string): void {
+		const existingAccountToLoad = this.accountsToLoad.get(publicKey.toString());
+		if (existingAccountToLoad) {
+			existingAccountToLoad.callbacks.delete(callbackId);
+			if (existingAccountToLoad.callbacks.size === 0) {
+				this.accountsToLoad.delete(existingAccountToLoad.publicKey.toString());
+			}
+		}
+
+		if (this.accountsToLoad.size === 0) {
+			this.stopPolling();
+		}
+	}
+
+	public addErrorCallbacks(callback: (error: Error) => void): string {
+		const callbackId = uuidv4();
+		this.errorCallbacks.set(callbackId, callback);
+		return callbackId;
+	}
+
+	public removeErrorCallbacks(callbackId: string): void {
+		this.errorCallbacks.delete(callbackId);
+	}
+
+	chunks<T>(array: readonly T[], size: number): T[][] {
+		return new Array(Math.ceil(array.length / size))
+			.fill(null)
+			.map((_, index) => index * size)
+			.map((begin) => array.slice(begin, begin + size));
+	}
+
+	public async load(): Promise<void> {
+		if (this.loadPromise) {
+			return this.loadPromise;
+		}
+		this.loadPromise = new Promise((resolver) => {
+			this.loadPromiseResolver = resolver;
+		});
+
+		try {
+			const chunks = this.chunks(
+				Array.from(this.accountsToLoad.values()),
+				GET_MULTIPLE_ACCOUNTS_CHUNK_SIZE
+			);
+
+			await Promise.all(
+				chunks.map((chunk) => {
+					return this.loadChunk(chunk);
+				})
+			);
+		} catch (e) {
+			console.error(`Error in bulkAccountLoader.load()`);
+			console.error(e);
+			for (const [_, callback] of this.errorCallbacks) {
+				callback(e);
+			}
+		} finally {
+			this.loadPromiseResolver();
+			this.loadPromise = undefined;
+		}
+	}
+
+	async loadChunk(accountsToLoad: AccountToLoad[]): Promise<void> {
+		if (accountsToLoad.length === 0) {
+			return;
+		}
+
+		const args = [
+			accountsToLoad.map((accountToLoad) => {
+				return accountToLoad.publicKey.toBase58();
+			}),
+			{ commitment: this.commitment },
+		];
+
+		let rpcResponse;
+		try {
+			// @ts-ignore
+			rpcResponse = await this.connection._rpcRequest(
+				'getMultipleAccounts',
+				args
+			);
+		} catch (e) {
+			for (const [_, callback] of this.errorCallbacks) {
+				callback(e);
+			}
+			return;
+		}
+
+		const newSlot = rpcResponse.result.context.slot;
+
+		for (const i in accountsToLoad) {
+			const accountToLoad = accountsToLoad[i];
+			const key = accountToLoad.publicKey.toString();
+			const oldRPCResponse = this.accountData.get(key);
+
+			let newBuffer: Buffer | undefined = undefined;
+			if (rpcResponse.result.value[i]) {
+				const raw: string = rpcResponse.result.value[i].data[0];
+				const dataType = rpcResponse.result.value[i].data[1];
+				newBuffer = Buffer.from(raw, dataType);
+			}
+
+			if (!oldRPCResponse) {
+				this.accountData.set(key, {
+					slot: newSlot,
+					buffer: newBuffer,
+				});
+				this.handleAccountCallbacks(accountToLoad, newBuffer);
+				continue;
+			}
+
+			if (newSlot <= oldRPCResponse.slot) {
+				continue;
+			}
+
+			const oldBuffer = oldRPCResponse.buffer;
+			if (newBuffer && (!oldBuffer || !newBuffer.equals(oldBuffer))) {
+				this.accountData.set(key, {
+					slot: newSlot,
+					buffer: newBuffer,
+				});
+				this.handleAccountCallbacks(accountToLoad, newBuffer);
+			}
+		}
+	}
+
+	handleAccountCallbacks(accountToLoad: AccountToLoad, buffer: Buffer): void {
+		for (const [_, callback] of accountToLoad.callbacks) {
+			callback(buffer);
+		}
+	}
+
+	public getAccountData(publicKey: PublicKey): Buffer | undefined {
+		const accountData = this.accountData.get(publicKey.toString());
+		return accountData?.buffer;
+	}
+
+	public startPolling(): void {
+		if (this.intervalId) {
+			return;
+		}
+
+		this.intervalId = setInterval(this.load.bind(this), this.pollingFrequency);
+	}
+
+	public stopPolling(): void {
+		if (this.intervalId) {
+			clearInterval(this.intervalId);
+			this.intervalId = undefined;
+		}
+	}
+}

package/src/accounts/bulkUserSubscription.ts

@@ -0,0 +1,28 @@
+import { ClearingHouseUser } from '../clearingHouseUser';
+import { BulkAccountLoader } from './bulkAccountLoader';
+import { PollingUserAccountSubscriber } from './pollingUserAccountSubscriber';
+
+/**
+ * @param users
+ * @param accountLoader
+ */
+export async function bulkPollingUserSubscribe(
+	users: ClearingHouseUser[],
+	accountLoader: BulkAccountLoader
+): Promise<void> {
+	await Promise.all(
+		users.map((user) => {
+			return (
+				user.accountSubscriber as PollingUserAccountSubscriber
+			).addToAccountLoader();
+		})
+	);
+
+	await accountLoader.load();
+
+	await Promise.all(
+		users.map(async (user) => {
+			return user.subscribe();
+		})
+	);
+}

package/src/accounts/pollingClearingHouseAccountSubscriber.ts

@@ -0,0 +1,326 @@
+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,
+	OrderHistoryAccount,
+	OrderStateAccount,
+	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;
+	orderState?: OrderStateAccount;
+	tradeHistory?: TradeHistoryAccount;
+	depositHistory?: DepositHistoryAccount;
+	fundingPaymentHistory?: FundingPaymentHistoryAccount;
+	fundingRateHistory?: FundingRateHistoryAccount;
+	liquidationHistory?: LiquidationHistoryAccount;
+	extendedCurveHistory: ExtendedCurveHistoryAccount;
+	orderHistory?: OrderHistoryAccount;
+
+	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',
+		});
+
+		this.accountsToPoll.set(state.orderState.toString(), {
+			key: 'orderState',
+			publicKey: state.orderState,
+			eventType: 'orderStateAccountUpdate',
+		});
+
+		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',
+			});
+		}
+
+		if (this.optionalExtraSubscriptions?.includes('orderHistoryAccount')) {
+			const orderState = (await this.program.account.orderState.fetch(
+				state.orderState
+			)) as OrderStateAccount;
+
+			this.accountsToPoll.set(orderState.orderHistory.toString(), {
+				key: 'orderHistory',
+				publicKey: orderState.orderHistory,
+				eventType: 'orderHistoryAccountUpdate',
+			});
+		}
+	}
+
+	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 getOrderStateAccount(): OrderStateAccount {
+		this.assertIsSubscribed();
+		return this.orderState;
+	}
+
+	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;
+	}
+
+	public getOrderHistoryAccount(): OrderHistoryAccount {
+		this.assertIsSubscribed();
+		this.assertOptionalIsSubscribed('orderHistoryAccount');
+		return this.orderHistory;
+	}
+}

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