@velocity-exchange/sdk 0.0.5 → 0.2.0

package/src/accounts/webSocketProgramAccountSubscriberV2.ts

@@ -101,12 +101,33 @@ export class WebSocketProgramAccountsSubscriberV2<T>
 	bufferAndSlotMap: Map<string, BufferAndSlot> = new Map();
 	program: VelocityProgram;
 	decodeBuffer: (accountName: string, ix: Buffer) => T;
-	onChange: (
+	private _onChange?: (
 		accountId: PublicKey,
 		data: T,
 		context: Context,
 		buffer: Buffer
 	) => void;
+	get onChange(): (
+		accountId: PublicKey,
+		data: T,
+		context: Context,
+		buffer: Buffer
+	) => void {
+		if (!this._onChange) {
+			throw new Error('onChange callback function must be set');
+		}
+		return this._onChange;
+	}
+	set onChange(
+		onChange: (
+			accountId: PublicKey,
+			data: T,
+			context: Context,
+			buffer: Buffer
+		) => void
+	) {
+		this._onChange = onChange;
+	}
 	listenerId?: number;
 	resubOpts: ResubOpts;
 	isUnsubscribing = false;
@@ -160,7 +181,10 @@ export class WebSocketProgramAccountsSubscriberV2<T>
 			usePollingInsteadOfResub: true,
 			logResubMessages: false,
 		};
-		if (this.resubOpts?.resubTimeoutMs < 1000) {
+		if (
+			this.resubOpts?.resubTimeoutMs !== undefined &&
+			this.resubOpts.resubTimeoutMs < 1000
+		) {
 			console.log(
 				'resubTimeoutMs should be at least 1000ms to avoid spamming resub'
 			);
@@ -319,7 +343,7 @@ export class WebSocketProgramAccountsSubscriberV2<T>
 	}
 
 	protected setTimeout(): void {
-		if (!this.onChange) {
+		if (!this._onChange) {
 			throw new Error('onChange callback function must be set');
 		}
 		this.timeoutId = setTimeout(
@@ -389,7 +413,9 @@ export class WebSocketProgramAccountsSubscriberV2<T>
 		// If this account was being polled, stop polling it if the buffer has changed
 		if (
 			this.accountsCurrentlyPolling.has(accountIdString) &&
-			!existingBufferAndSlot?.buffer.equals(newBuffer)
+			newBuffer &&
+			(!existingBufferAndSlot?.buffer ||
+				!newBuffer.equals(existingBufferAndSlot.buffer))
 		) {
 			this.accountsCurrentlyPolling.delete(accountIdString);
 

package/src/accounts/webSocketProgramAccountsSubscriberV2.ts

@@ -101,12 +101,33 @@ export class WebSocketProgramAccountsSubscriberV2<T>
 	bufferAndSlotMap: Map<string, BufferAndSlot> = new Map();
 	program: VelocityProgram;
 	decodeBuffer: (accountName: string, ix: Buffer) => T;
-	onChange: (
+	private _onChange?: (
 		accountId: PublicKey,
 		data: T,
 		context: Context,
 		buffer: Buffer
 	) => void;
+	get onChange(): (
+		accountId: PublicKey,
+		data: T,
+		context: Context,
+		buffer: Buffer
+	) => void {
+		if (!this._onChange) {
+			throw new Error('onChange callback function must be set');
+		}
+		return this._onChange;
+	}
+	set onChange(
+		onChange: (
+			accountId: PublicKey,
+			data: T,
+			context: Context,
+			buffer: Buffer
+		) => void
+	) {
+		this._onChange = onChange;
+	}
 	listenerId?: number;
 	resubOpts: ResubOpts;
 	isUnsubscribing = false;
@@ -160,7 +181,10 @@ export class WebSocketProgramAccountsSubscriberV2<T>
 			usePollingInsteadOfResub: true,
 			logResubMessages: false,
 		};
-		if (this.resubOpts?.resubTimeoutMs < 1000) {
+		if (
+			this.resubOpts.resubTimeoutMs != null &&
+			this.resubOpts.resubTimeoutMs < 1000
+		) {
 			console.log(
 				'resubTimeoutMs should be at least 1000ms to avoid spamming resub'
 			);
@@ -319,7 +343,7 @@ export class WebSocketProgramAccountsSubscriberV2<T>
 	}
 
 	protected setTimeout(): void {
-		if (!this.onChange) {
+		if (!this._onChange) {
 			throw new Error('onChange callback function must be set');
 		}
 		this.timeoutId = setTimeout(
@@ -389,7 +413,8 @@ export class WebSocketProgramAccountsSubscriberV2<T>
 		// If this account was being polled, stop polling it if the buffer has changed
 		if (
 			this.accountsCurrentlyPolling.has(accountIdString) &&
-			!existingBufferAndSlot?.buffer.equals(newBuffer)
+			(!existingBufferAndSlot?.buffer ||
+				(newBuffer != null && !existingBufferAndSlot.buffer.equals(newBuffer)))
 		) {
 			this.accountsCurrentlyPolling.delete(accountIdString);
 

package/src/accounts/webSocketUserAccountSubscriber.ts

@@ -21,7 +21,16 @@ export class WebSocketUserAccountSubscriber implements UserAccountSubscriber {
 	eventEmitter: StrictEventEmitter<EventEmitter, UserAccountEvents>;
 	userAccountPublicKey: PublicKey;
 
-	userDataAccountSubscriber: AccountSubscriber<UserAccount>;
+	private _userDataAccountSubscriber?: AccountSubscriber<UserAccount>;
+	get userDataAccountSubscriber(): AccountSubscriber<UserAccount> {
+		if (!this._userDataAccountSubscriber) {
+			throw new Error('userDataAccountSubscriber accessed before subscribe()');
+		}
+		return this._userDataAccountSubscriber;
+	}
+	set userDataAccountSubscriber(subscriber: AccountSubscriber<UserAccount>) {
+		this._userDataAccountSubscriber = subscriber;
+	}
 
 	public constructor(
 		program: VelocityProgram,
@@ -87,7 +96,7 @@ export class WebSocketUserAccountSubscriber implements UserAccountSubscriber {
 		}
 	}
 
-	public getUserAccountAndSlot(): DataAndSlot<UserAccount> {
+	public getUserAccountAndSlot(): DataAndSlot<UserAccount> | undefined {
 		this.assertIsSubscribed();
 		return this.userDataAccountSubscriber.dataAndSlot;
 	}

package/src/accounts/webSocketUserStatsAccountSubsriber.ts

@@ -23,7 +23,18 @@ export class WebSocketUserStatsAccountSubscriber
 	eventEmitter: StrictEventEmitter<EventEmitter, UserStatsAccountEvents>;
 	userStatsAccountPublicKey: PublicKey;
 
-	userStatsAccountSubscriber: AccountSubscriber<UserStatsAccount>;
+	private _userStatsAccountSubscriber?: AccountSubscriber<UserStatsAccount>;
+	get userStatsAccountSubscriber(): AccountSubscriber<UserStatsAccount> {
+		if (!this._userStatsAccountSubscriber) {
+			throw new Error('userStatsAccountSubscriber accessed before subscribe()');
+		}
+		return this._userStatsAccountSubscriber;
+	}
+	set userStatsAccountSubscriber(
+		subscriber: AccountSubscriber<UserStatsAccount>
+	) {
+		this._userStatsAccountSubscriber = subscriber;
+	}
 
 	public constructor(
 		program: VelocityProgram,
@@ -91,7 +102,9 @@ export class WebSocketUserStatsAccountSubscriber
 		}
 	}
 
-	public getUserStatsAccountAndSlot(): DataAndSlot<UserStatsAccount> {
+	public getUserStatsAccountAndSlot():
+		| DataAndSlot<UserStatsAccount>
+		| undefined {
 		this.assertIsSubscribed();
 		return this.userStatsAccountSubscriber.dataAndSlot;
 	}

package/src/accounts/webSocketVelocityClientAccountSubscriber.ts

@@ -18,7 +18,7 @@ import {
 	getSpotMarketPublicKeySync,
 } from '../addresses/pda';
 import { WebSocketAccountSubscriber } from './webSocketAccountSubscriber';
-import { Commitment, PublicKey } from '@solana/web3.js';
+import { AccountInfo, Commitment, PublicKey } from '@solana/web3.js';
 import { OracleInfo, OraclePriceData } from '../oracles/types';
 import { OracleClientCache } from '../oracles/oracleClientCache';
 import * as Buffer from 'buffer';
@@ -86,9 +86,9 @@ export class WebSocketVelocityClientAccountSubscriber
 	oracleSubscribers = new Map<string, AccountSubscriber<OraclePriceData>>();
 	delistedMarketSetting: DelistedMarketSetting;
 
-	initialPerpMarketAccountData: Map<number, PerpMarketAccount>;
-	initialSpotMarketAccountData: Map<number, SpotMarketAccount>;
-	initialOraclePriceData: Map<string, OraclePriceData>;
+	initialPerpMarketAccountData?: Map<number, PerpMarketAccount>;
+	initialSpotMarketAccountData?: Map<number, SpotMarketAccount>;
+	initialOraclePriceData?: Map<string, OraclePriceData>;
 	customPerpMarketAccountSubscriber?: new (
 		accountName: string,
 		program: VelocityProgram,
@@ -107,8 +107,8 @@ export class WebSocketVelocityClientAccountSubscriber
 	) => AccountSubscriber<any>;
 
 	protected isSubscribing = false;
-	protected subscriptionPromise: Promise<boolean>;
-	protected subscriptionPromiseResolver: (val: boolean) => void;
+	protected subscriptionPromiseResolver: (val: boolean) => void = () => {};
+	protected subscriptionPromise: Promise<boolean> = Promise.resolve(false);
 
 	public constructor(
 		program: VelocityProgram,
@@ -255,7 +255,9 @@ export class WebSocketVelocityClientAccountSubscriber
 			).flat();
 			this.initialPerpMarketAccountData = new Map(
 				perpMarketAccountInfos
-					.filter((accountInfo) => !!accountInfo)
+					.filter(
+						(accountInfo): accountInfo is AccountInfo<Buffer> => !!accountInfo
+					)
 					.map((accountInfo) => {
 						const perpMarket = this.program.coder.accounts.decode(
 							'perpMarket',
@@ -280,7 +282,9 @@ export class WebSocketVelocityClientAccountSubscriber
 			).flat();
 			this.initialSpotMarketAccountData = new Map(
 				spotMarketAccountInfos
-					.filter((accountInfo) => !!accountInfo)
+					.filter(
+						(accountInfo): accountInfo is AccountInfo<Buffer> => !!accountInfo
+					)
 					.map((accountInfo) => {
 						const spotMarket = this.program.coder.accounts.decode(
 							'spotMarket',
@@ -303,27 +307,34 @@ export class WebSocketVelocityClientAccountSubscriber
 			)
 		).flat();
 		this.initialOraclePriceData = new Map(
-			this.oracleInfos.reduce((result, oracleInfo, i) => {
-				if (!oracleAccountInfos[i]) {
+			this.oracleInfos.reduce(
+				(result, oracleInfo, i) => {
+					const oracleAccountInfo = oracleAccountInfos[i];
+					if (!oracleAccountInfo) {
+						return result;
+					}
+
+					const oracleClient = this.oracleClientCache.get(
+						oracleInfo.source,
+						connection,
+						this.program
+					);
+					if (!oracleClient) {
+						return result;
+					}
+
+					const oraclePriceData = oracleClient.getOraclePriceDataFromBuffer(
+						oracleAccountInfo.data
+					);
+
+					result.push([
+						getOracleId(oracleInfo.publicKey, oracleInfo.source),
+						oraclePriceData,
+					]);
 					return result;
-				}
-
-				const oracleClient = this.oracleClientCache.get(
-					oracleInfo.source,
-					connection,
-					this.program
-				);
-
-				const oraclePriceData = oracleClient.getOraclePriceDataFromBuffer(
-					oracleAccountInfos[i].data
-				);
-
-				result.push([
-					getOracleId(oracleInfo.publicKey, oracleInfo.source),
-					oraclePriceData,
-				]);
-				return result;
-			}, [])
+				},
+				[] as [string, OraclePriceData][]
+			)
 		);
 	}
 
@@ -358,7 +369,7 @@ export class WebSocketVelocityClientAccountSubscriber
 			this.commitment
 		);
 		const initialPerpMarketData =
-			this.initialPerpMarketAccountData.get(marketIndex);
+			this.initialPerpMarketAccountData?.get(marketIndex);
 		if (initialPerpMarketData) {
 			accountSubscriber.setData(initialPerpMarketData);
 		}
@@ -394,7 +405,7 @@ export class WebSocketVelocityClientAccountSubscriber
 			this.commitment
 		);
 		const initialSpotMarketData =
-			this.initialSpotMarketAccountData.get(marketIndex);
+			this.initialSpotMarketAccountData?.get(marketIndex);
 		if (initialSpotMarketData) {
 			accountSubscriber.setData(initialSpotMarketData);
 		}
@@ -424,6 +435,9 @@ export class WebSocketVelocityClientAccountSubscriber
 			this.program.provider.connection,
 			this.program
 		);
+		if (!client) {
+			return false;
+		}
 		const AccountSubscriberClass =
 			this.customOracleAccountSubscriber || WebSocketAccountSubscriber;
 		const accountSubscriber = new AccountSubscriberClass<OraclePriceData>(
@@ -436,7 +450,7 @@ export class WebSocketVelocityClientAccountSubscriber
 			this.resubOpts,
 			this.commitment
 		);
-		const initialOraclePriceData = this.initialOraclePriceData.get(oracleId);
+		const initialOraclePriceData = this.initialOraclePriceData?.get(oracleId);
 		if (initialOraclePriceData) {
 			accountSubscriber.setData(initialOraclePriceData);
 		}
@@ -484,6 +498,10 @@ export class WebSocketVelocityClientAccountSubscriber
 			return;
 		}
 
+		if (!this.stateAccountSubscriber) {
+			return;
+		}
+
 		const promises = [this.stateAccountSubscriber.fetch()]
 			.concat(
 				Array.from(this.perpMarketAccountSubscribers.values()).map(
@@ -504,7 +522,7 @@ export class WebSocketVelocityClientAccountSubscriber
 			return;
 		}
 
-		await this.stateAccountSubscriber.unsubscribe();
+		await this.stateAccountSubscriber?.unsubscribe();
 
 		await this.unsubscribeFromMarketAccounts();
 		await this.unsubscribeFromSpotMarketAccounts();
@@ -553,13 +571,13 @@ export class WebSocketVelocityClientAccountSubscriber
 			}
 			const perpMarketAccount = perpMarket.data;
 			const perpMarketIndex = perpMarketAccount.marketIndex;
-			const oracle = perpMarketAccount.amm.oracle;
-			const oracleId = getOracleId(oracle, perpMarket.data.amm.oracleSource);
+			const oracle = perpMarketAccount.oracle;
+			const oracleId = getOracleId(oracle, perpMarket.data.oracleSource);
 			if (!this.oracleSubscribers.has(oracleId)) {
 				addOraclePromises.push(
 					this.addOracle({
 						publicKey: oracle,
-						source: perpMarket.data.amm.oracleSource,
+						source: perpMarket.data.oracleSource,
 					})
 				);
 			}
@@ -607,7 +625,7 @@ export class WebSocketVelocityClientAccountSubscriber
 		for (const perpMarketIndex of perpMarketIndexes) {
 			await this.perpMarketAccountSubscribers
 				.get(perpMarketIndex)
-				.unsubscribe();
+				?.unsubscribe();
 			if (this.delistedMarketSetting === DelistedMarketSetting.Discard) {
 				this.perpMarketAccountSubscribers.delete(perpMarketIndex);
 			}
@@ -615,7 +633,7 @@ export class WebSocketVelocityClientAccountSubscriber
 
 		for (const oracle of oracles) {
 			const oracleId = getOracleId(oracle.publicKey, oracle.source);
-			await this.oracleSubscribers.get(oracleId).unsubscribe();
+			await this.oracleSubscribers.get(oracleId)?.unsubscribe();
 			if (this.delistedMarketSetting === DelistedMarketSetting.Discard) {
 				this.oracleSubscribers.delete(oracleId);
 			}
@@ -632,33 +650,43 @@ export class WebSocketVelocityClientAccountSubscriber
 
 	public getStateAccountAndSlot(): DataAndSlot<StateAccount> {
 		this.assertIsSubscribed();
-		return this.stateAccountSubscriber.dataAndSlot;
+		const dataAndSlot = this.stateAccountSubscriber?.dataAndSlot;
+		if (!dataAndSlot) {
+			throw new Error('State account data not available');
+		}
+		return dataAndSlot;
 	}
 
 	public getMarketAccountAndSlot(
 		marketIndex: number
 	): DataAndSlot<PerpMarketAccount> | undefined {
 		this.assertIsSubscribed();
-		return this.perpMarketAccountSubscribers.get(marketIndex).dataAndSlot;
+		return this.perpMarketAccountSubscribers.get(marketIndex)?.dataAndSlot;
 	}
 
 	public getMarketAccountsAndSlots(): DataAndSlot<PerpMarketAccount>[] {
-		return Array.from(this.perpMarketAccountSubscribers.values()).map(
-			(subscriber) => subscriber.dataAndSlot
-		);
+		return Array.from(this.perpMarketAccountSubscribers.values())
+			.map((subscriber) => subscriber.dataAndSlot)
+			.filter(
+				(dataAndSlot): dataAndSlot is DataAndSlot<PerpMarketAccount> =>
+					dataAndSlot !== undefined
+			);
 	}
 
 	public getSpotMarketAccountAndSlot(
 		marketIndex: number
 	): DataAndSlot<SpotMarketAccount> | undefined {
 		this.assertIsSubscribed();
-		return this.spotMarketAccountSubscribers.get(marketIndex).dataAndSlot;
+		return this.spotMarketAccountSubscribers.get(marketIndex)?.dataAndSlot;
 	}
 
 	public getSpotMarketAccountsAndSlots(): DataAndSlot<SpotMarketAccount>[] {
-		return Array.from(this.spotMarketAccountSubscribers.values()).map(
-			(subscriber) => subscriber.dataAndSlot
-		);
+		return Array.from(this.spotMarketAccountSubscribers.values())
+			.map((subscriber) => subscriber.dataAndSlot)
+			.filter(
+				(dataAndSlot): dataAndSlot is DataAndSlot<SpotMarketAccount> =>
+					dataAndSlot !== undefined
+			);
 	}
 
 	public getOraclePriceDataAndSlot(
@@ -671,7 +699,7 @@ export class WebSocketVelocityClientAccountSubscriber
 				slot: 0,
 			};
 		}
-		return this.oracleSubscribers.get(oracleId).dataAndSlot;
+		return this.oracleSubscribers.get(oracleId)?.dataAndSlot;
 	}
 
 	public getOraclePriceDataAndSlotForPerpMarket(
@@ -684,8 +712,8 @@ export class WebSocketVelocityClientAccountSubscriber
 			return undefined;
 		}
 
-		if (!perpMarketAccount.data.amm.oracle.equals(oracle)) {
-			// If the oracle has changed, we need to update the oracle map in background
+		if (!oracle || !perpMarketAccount.data.oracle.equals(oracle)) {
+			// If the oracle has changed (or not yet cached), update the oracle map in background
 			this.setPerpOracleMap();
 		}
 
@@ -702,18 +730,11 @@ export class WebSocketVelocityClientAccountSubscriber
 			return undefined;
 		}
 
-		if (!spotMarketAccount.data.oracle.equals(oracle)) {
-			// If the oracle has changed, we need to update the oracle map in background
+		if (!oracle || !spotMarketAccount.data.oracle.equals(oracle)) {
+			// If the oracle has changed (or not yet cached), update the oracle map in background
 			this.setSpotOracleMap();
 		}
 
 		return this.getOraclePriceDataAndSlot(oracleId);
 	}
 }
-
-/** @deprecated Use `WebSocketVelocityClientAccountSubscriber` instead. `WebSocketDriftClientAccountSubscriber` will be removed in a future major. */
-export const WebSocketDriftClientAccountSubscriber =
-	WebSocketVelocityClientAccountSubscriber;
-/** @deprecated Use `WebSocketVelocityClientAccountSubscriber` instead. `WebSocketDriftClientAccountSubscriber` will be removed in a future major. */
-export type WebSocketDriftClientAccountSubscriber =
-	WebSocketVelocityClientAccountSubscriber;