@velocity-exchange/sdk 0.1.0 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@velocity-exchange/sdk",
-	"version": "0.1.0",
+	"version": "0.2.0",
 	"main": "lib/node/index.js",
 	"types": "lib/node/index.d.ts",
 	"module": "./lib/browser/index.js",
@@ -23,8 +23,8 @@
 		"test:events": "mocha -r ts-node/register tests/events/**/*.ts",
 		"test:velocitycore": "bun test tests/VelocityCore",
 		"patch-and-pub": "npm version patch --force && npm publish",
-		"prettify": "prettier --check './src/***/*.ts'",
-		"prettify:fix": "prettier --write './{src,tests}/***/*.ts'",
+		"prettify": "prettier --check './src/**/*.ts'",
+		"prettify:fix": "prettier --write './{src,tests}/**/*.ts'",
 		"version": "node ./scripts/updateVersion.js",
 		"circular-deps": "bunx madge --circular --circular --extensions ts src"
 	},
@@ -57,6 +57,7 @@
 		"gill": "0.10.2",
 		"nanoid": "3.3.4",
 		"node-cache": "5.1.2",
+		"node-fetch": "2.6.11",
 		"solana-bankrun": "0.4.0",
 		"strict-event-emitter-types": "2.0.0",
 		"tweetnacl": "1.0.3",
@@ -76,6 +77,7 @@
 		"@types/chai": "4.3.20",
 		"@types/jest": "28.1.8",
 		"@types/mocha": "9.1.1",
+		"@types/node-fetch": "2.6.11",
 		"@typescript-eslint/eslint-plugin": "6.21.0",
 		"@typescript-eslint/parser": "6.21.0",
 		"chai": "4.5.0",

package/src/accounts/basicUserAccountSubscriber.ts

@@ -16,7 +16,7 @@ export class BasicUserAccountSubscriber implements UserAccountSubscriber {
 	callbackId?: string;
 	errorCallbackId?: string;
 
-	user: DataAndSlot<UserAccount>;
+	user?: DataAndSlot<UserAccount>;
 
 	public constructor(
 		userAccountPublicKey: PublicKey,
@@ -26,7 +26,9 @@ export class BasicUserAccountSubscriber implements UserAccountSubscriber {
 		this.isSubscribed = true;
 		this.eventEmitter = new EventEmitter();
 		this.userAccountPublicKey = userAccountPublicKey;
-		this.user = { data, slot };
+		// `slot ?? 0` keeps {data, slot} atomic: a seeded account always carries a
+		// slot (0 = oldest-possible sentinel, overwritten by the first real fetch).
+		this.user = data ? { data, slot: slot ?? 0 } : undefined;
 	}
 
 	async subscribe(_userAccount?: UserAccount): Promise<boolean> {
@@ -37,7 +39,7 @@ export class BasicUserAccountSubscriber implements UserAccountSubscriber {
 
 	async fetch(): Promise<void> {}
 
-	doesAccountExist(): boolean {
+	doesAccountExist(): this is { user: DataAndSlot<UserAccount> } {
 		return this.user !== undefined;
 	}
 
@@ -45,12 +47,12 @@ export class BasicUserAccountSubscriber implements UserAccountSubscriber {
 
 	assertIsSubscribed(): void {}
 
-	public getUserAccountAndSlot(): DataAndSlot<UserAccount> {
+	public getUserAccountAndSlot(): DataAndSlot<UserAccount> | undefined {
 		return this.user;
 	}
 
 	public updateData(userAccount: UserAccount, slot: number): void {
-		if (!this.user || slot >= (this.user.slot ?? 0)) {
+		if (!this.user || slot >= this.user.slot) {
 			this.user = { data: userAccount, slot };
 			this.eventEmitter.emit('userAccountUpdate', userAccount);
 			this.eventEmitter.emit('update');

package/src/accounts/basicUserStatsAccountSubscriber.ts

@@ -22,7 +22,7 @@ export class BasicUserStatsAccountSubscriber
 	callbackId?: string;
 	errorCallbackId?: string;
 
-	userStats: DataAndSlot<UserStatsAccount>;
+	userStats?: DataAndSlot<UserStatsAccount>;
 
 	public constructor(
 		userStatsAccountPublicKey: PublicKey,
@@ -32,7 +32,9 @@ export class BasicUserStatsAccountSubscriber
 		this.isSubscribed = true;
 		this.eventEmitter = new EventEmitter();
 		this.userStatsAccountPublicKey = userStatsAccountPublicKey;
-		this.userStats = { data, slot };
+		// `slot ?? 0` keeps {data, slot} atomic: a seeded account always carries a
+		// slot (0 = oldest-possible sentinel, overwritten by the first real fetch).
+		this.userStats = data ? { data, slot: slot ?? 0 } : undefined;
 	}
 
 	async subscribe(_userStatsAccount?: UserStatsAccount): Promise<boolean> {
@@ -43,7 +45,7 @@ export class BasicUserStatsAccountSubscriber
 
 	async fetch(): Promise<void> {}
 
-	doesAccountExist(): boolean {
+	doesAccountExist(): this is { userStats: DataAndSlot<UserStatsAccount> } {
 		return this.userStats !== undefined;
 	}
 
@@ -51,12 +53,14 @@ export class BasicUserStatsAccountSubscriber
 
 	assertIsSubscribed(): void {}
 
-	public getUserStatsAccountAndSlot(): DataAndSlot<UserStatsAccount> {
+	public getUserStatsAccountAndSlot():
+		| DataAndSlot<UserStatsAccount>
+		| undefined {
 		return this.userStats;
 	}
 
 	public updateData(userStatsAccount: UserStatsAccount, slot: number): void {
-		if (!this.userStats || slot >= (this.userStats.slot ?? 0)) {
+		if (!this.userStats || slot >= this.userStats.slot) {
 			this.userStats = { data: userStatsAccount, slot };
 			this.eventEmitter.emit('userStatsAccountUpdate', userStatsAccount);
 			this.eventEmitter.emit('update');

package/src/accounts/bulkAccountLoader.ts

@@ -18,11 +18,11 @@ export class BulkAccountLoader {
 	pollingFrequency: number;
 	accountsToLoad = new Map<string, AccountToLoad>();
 	bufferAndSlotMap = new Map<string, BufferAndSlot>();
-	errorCallbacks = new Map<string, (e) => void>();
+	errorCallbacks = new Map<string, (e: Error) => void>();
 	intervalId?: ReturnType<typeof setTimeout>;
 	// to handle clients spamming load
 	loadPromise?: Promise<void>;
-	loadPromiseResolver: () => void;
+	private loadPromiseResolver: () => void = () => {};
 	lastTimeLoadingPromiseCleared = Date.now();
 	mostRecentSlot = 0;
 
@@ -73,7 +73,13 @@ export class BulkAccountLoader {
 		return callbackId;
 	}
 
-	public removeAccount(publicKey: PublicKey, callbackId: string): void {
+	public removeAccount(
+		publicKey: PublicKey,
+		callbackId: string | undefined
+	): void {
+		if (callbackId === undefined) {
+			return;
+		}
 		const existingAccountToLoad = this.accountsToLoad.get(publicKey.toString());
 		if (existingAccountToLoad) {
 			existingAccountToLoad.callbacks.delete(callbackId);
@@ -94,7 +100,10 @@ export class BulkAccountLoader {
 		return callbackId;
 	}
 
-	public removeErrorCallbacks(callbackId: string): void {
+	public removeErrorCallbacks(callbackId: string | undefined): void {
+		if (callbackId === undefined) {
+			return;
+		}
 		this.errorCallbacks.delete(callbackId);
 	}
 
@@ -137,8 +146,9 @@ export class BulkAccountLoader {
 		} catch (e) {
 			console.error(`Error in bulkAccountLoader.load()`);
 			console.error(e);
+			const error = e instanceof Error ? e : new Error(String(e));
 			for (const [_, callback] of this.errorCallbacks) {
-				callback(e);
+				callback(error);
 			}
 		} finally {
 			this.loadPromiseResolver();
@@ -179,7 +189,7 @@ export class BulkAccountLoader {
 			return;
 		}
 
-		rpcResponses.forEach((rpcResponse, i) => {
+		rpcResponses.forEach((rpcResponse: any, i: number) => {
 			if (!rpcResponse.result) {
 				console.error('rpc response missing result:');
 				console.log(JSON.stringify(rpcResponse));
@@ -234,9 +244,12 @@ export class BulkAccountLoader {
 
 	handleAccountCallbacks(
 		accountToLoad: AccountToLoad,
-		buffer: Buffer,
+		buffer: Buffer | undefined,
 		slot: number
 	): void {
+		if (buffer === undefined) {
+			return;
+		}
 		for (const [_, callback] of accountToLoad.callbacks) {
 			try {
 				callback(buffer, slot);

package/src/accounts/grpcAccountSubscriber.ts

@@ -15,7 +15,15 @@ import {
 
 export class grpcAccountSubscriber<T> extends WebSocketAccountSubscriber<T> {
 	private client: Client;
-	private stream: ClientDuplexStream;
+	private _stream?: ClientDuplexStream;
+	private get stream(): ClientDuplexStream {
+		if (!this._stream) {
+			throw new Error(
+				'grpcAccountSubscriber: stream accessed before subscribe()'
+			);
+		}
+		return this._stream;
+	}
 	private commitmentLevel: CommitmentLevel;
 	public listenerId?: number;
 
@@ -75,7 +83,7 @@ export class grpcAccountSubscriber<T> extends WebSocketAccountSubscriber<T> {
 		}
 
 		// Subscribe with grpc
-		this.stream =
+		this._stream =
 			(await this.client.subscribe()) as unknown as typeof this.stream;
 		const request: SubscribeRequest = {
 			slots: {},
@@ -95,7 +103,7 @@ export class grpcAccountSubscriber<T> extends WebSocketAccountSubscriber<T> {
 			transactionsStatus: {},
 		};
 		this.stream.on('data', (chunk: SubscribeUpdate) => {
-			if (!chunk.account) {
+			if (!chunk.account || !chunk.account.account) {
 				return;
 			}
 			const slot = Number(chunk.account.slot);

package/src/accounts/grpcMultiAccountSubscriber.ts

@@ -38,7 +38,15 @@ function commitmentLevelToCommitment(
 
 export class grpcMultiAccountSubscriber<T, U = undefined> {
 	private client: Client;
-	private stream: ClientDuplexStream;
+	private _stream?: ClientDuplexStream;
+	private get stream(): ClientDuplexStream {
+		if (!this._stream) {
+			throw new Error(
+				'grpcMultiAccountSubscriber: stream accessed before subscribe()'
+			);
+		}
+		return this._stream;
+	}
 	private commitmentLevel: CommitmentLevel;
 	private program: VelocityProgram;
 	private accountName: string;
@@ -58,7 +66,12 @@ export class grpcMultiAccountSubscriber<T, U = undefined> {
 	private subscribedAccounts = new Set<string>();
 	private onChangeMap = new Map<
 		string,
-		(data: T, context: Context, buffer: Buffer, accountProps: U) => void
+		(
+			data: T,
+			context: Context,
+			buffer: Buffer,
+			accountProps: U | undefined
+		) => void
 	>();
 
 	private dataMap = new Map<string, DataAndSlot<T>>();
@@ -82,7 +95,9 @@ export class grpcMultiAccountSubscriber<T, U = undefined> {
 		this.decodeBufferFn = decodeBuffer;
 		this.resubOpts = resubOpts;
 		this.onUnsubscribe = onUnsubscribe;
-		this.accountPropsMap = accountPropsMap;
+		if (accountPropsMap) {
+			this.accountPropsMap = accountPropsMap;
+		}
 	}
 
 	public static async create<T, U = undefined>(
@@ -119,7 +134,7 @@ export class grpcMultiAccountSubscriber<T, U = undefined> {
 	}
 
 	setAccountData(accountPubkey: string, data: T, slot?: number): void {
-		this.dataMap.set(accountPubkey, { data, slot });
+		this.dataMap.set(accountPubkey, { data, slot: slot ?? 0 });
 	}
 
 	getAccountData(accountPubkey: string): DataAndSlot<T> | undefined {
@@ -205,7 +220,7 @@ export class grpcMultiAccountSubscriber<T, U = undefined> {
 			data: T,
 			context: Context,
 			buffer: Buffer,
-			accountProps: U
+			accountProps: U | undefined
 		) => void
 	): Promise<void> {
 		if (this.resubOpts?.logResubMessages) {
@@ -225,7 +240,7 @@ export class grpcMultiAccountSubscriber<T, U = undefined> {
 			});
 		}
 
-		this.stream =
+		this._stream =
 			(await this.client.subscribe()) as unknown as typeof this.stream;
 		const request: SubscribeRequest = {
 			slots: {},
@@ -246,7 +261,7 @@ export class grpcMultiAccountSubscriber<T, U = undefined> {
 		};
 
 		this.stream.on('data', (chunk: SubscribeUpdate) => {
-			if (!chunk.account) {
+			if (!chunk.account || !chunk.account.account) {
 				return;
 			}
 			const slot = Number(chunk.account.slot);
@@ -300,11 +315,11 @@ export class grpcMultiAccountSubscriber<T, U = undefined> {
 			const handleDataBuffer = (
 				context: Context,
 				buffer: Buffer,
-				accountProps: U
+				accountProps: U | undefined
 			) => {
 				const data = this.decodeBufferFn
 					? this.decodeBufferFn(buffer, accountPubkey, accountProps)
-					: this.program.account[this.accountName].coder.accounts.decode(
+					: this.program.coder.accounts.decode(
 							this.capitalize(this.accountName),
 							buffer
 					  );

package/src/accounts/grpcMultiUserAccountSubscriber.ts

@@ -15,7 +15,15 @@ import { grpcMultiAccountSubscriber } from './grpcMultiAccountSubscriber';
 
 export class grpcMultiUserAccountSubscriber {
 	private program: VelocityProgram;
-	private multiSubscriber: grpcMultiAccountSubscriber<UserAccount>;
+	private _multiSubscriber?: grpcMultiAccountSubscriber<UserAccount>;
+	private get multiSubscriber(): grpcMultiAccountSubscriber<UserAccount> {
+		if (!this._multiSubscriber) {
+			throw new Error(
+				'grpcMultiUserAccountSubscriber: multiSubscriber accessed before subscribe()'
+			);
+		}
+		return this._multiSubscriber;
+	}
 
 	private userData = new Map<string, DataAndSlot<UserAccount>>();
 	private listeners = new Map<
@@ -56,14 +64,16 @@ export class grpcMultiUserAccountSubscriber {
 		multiSubscriber?: grpcMultiAccountSubscriber<UserAccount>
 	) {
 		this.program = program;
-		this.multiSubscriber = multiSubscriber;
+		if (multiSubscriber) {
+			this._multiSubscriber = multiSubscriber;
+		}
 		this.grpcConfigs = grpcConfigs;
 		this.resubOpts = resubOpts;
 	}
 
 	public async subscribe(): Promise<void> {
-		if (!this.multiSubscriber) {
-			this.multiSubscriber =
+		if (!this._multiSubscriber) {
+			this._multiSubscriber =
 				await grpcMultiAccountSubscriber.create<UserAccount>(
 					this.grpcConfigs,
 					'user',
@@ -189,14 +199,8 @@ export class grpcMultiUserAccountSubscriber {
 				isSubscribed = false;
 			},
 
-			getUserAccountAndSlot(): DataAndSlot<UserAccount> {
-				const das = parent.userData.get(key);
-				if (!das) {
-					throw new NotSubscribedError(
-						'Must subscribe before getting user account data'
-					);
-				}
-				return das;
+			getUserAccountAndSlot(): DataAndSlot<UserAccount> | undefined {
+				return parent.userData.get(key);
 			},
 		};
 

package/src/accounts/grpcProgramAccountSubscriber.ts

@@ -15,7 +15,15 @@ export class grpcProgramAccountSubscriber<
 	T,
 > extends WebSocketProgramAccountSubscriber<T> {
 	private client: Client;
-	private stream: Awaited<ReturnType<Client['subscribe']>>;
+	private _stream?: Awaited<ReturnType<Client['subscribe']>>;
+	private get stream(): Awaited<ReturnType<Client['subscribe']>> {
+		if (!this._stream) {
+			throw new Error(
+				'grpcProgramAccountSubscriber: stream accessed before subscribe()'
+			);
+		}
+		return this._stream;
+	}
 	private commitmentLevel: CommitmentLevel;
 	public listenerId?: number;
 
@@ -95,7 +103,7 @@ export class grpcProgramAccountSubscriber<
 		this.onChange = onChange;
 
 		// Subscribe with grpc
-		this.stream = await this.client.subscribe();
+		this._stream = await this.client.subscribe();
 
 		const filters = this.options.filters.map((filter) => {
 			return {
@@ -125,7 +133,7 @@ export class grpcProgramAccountSubscriber<
 		};
 
 		this.stream.on('data', (chunk: SubscribeUpdate) => {
-			if (!chunk.account) {
+			if (!chunk.account || !chunk.account.account) {
 				return;
 			}
 			const slot = Number(chunk.account.slot);

package/src/accounts/grpcVelocityClientAccountSubscriber.ts

@@ -135,9 +135,11 @@ export class grpcVelocityClientAccountSubscriber extends WebSocketVelocityClient
 				undefined,
 				this.resubOpts
 			);
-		accountSubscriber.setData(
-			this.initialSpotMarketAccountData.get(marketIndex)
-		);
+		const initialSpotMarketData =
+			this.initialSpotMarketAccountData?.get(marketIndex);
+		if (initialSpotMarketData) {
+			accountSubscriber.setData(initialSpotMarketData);
+		}
 		await accountSubscriber.subscribe((data: SpotMarketAccount) => {
 			this.eventEmitter.emit('spotMarketAccountUpdate', data);
 			this.eventEmitter.emit('update');
@@ -160,9 +162,11 @@ export class grpcVelocityClientAccountSubscriber extends WebSocketVelocityClient
 				undefined,
 				this.resubOpts
 			);
-		accountSubscriber.setData(
-			this.initialPerpMarketAccountData.get(marketIndex)
-		);
+		const initialPerpMarketData =
+			this.initialPerpMarketAccountData?.get(marketIndex);
+		if (initialPerpMarketData) {
+			accountSubscriber.setData(initialPerpMarketData);
+		}
 		await accountSubscriber.subscribe((data: PerpMarketAccount) => {
 			this.eventEmitter.emit('perpMarketAccountUpdate', data);
 			this.eventEmitter.emit('update');
@@ -178,6 +182,9 @@ export class grpcVelocityClientAccountSubscriber extends WebSocketVelocityClient
 			this.program.provider.connection,
 			this.program
 		);
+		if (!client) {
+			return false;
+		}
 		const accountSubscriber =
 			await grpcAccountSubscriber.create<OraclePriceData>(
 				this.grpcConfigs,
@@ -189,7 +196,10 @@ export class grpcVelocityClientAccountSubscriber extends WebSocketVelocityClient
 				},
 				this.resubOpts
 			);
-		accountSubscriber.setData(this.initialOraclePriceData.get(oracleId));
+		const initialOraclePriceData = this.initialOraclePriceData?.get(oracleId);
+		if (initialOraclePriceData) {
+			accountSubscriber.setData(initialOraclePriceData);
+		}
 		await accountSubscriber.subscribe((data: OraclePriceData) => {
 			this.eventEmitter.emit(
 				'oraclePriceUpdate',