@velocity-exchange/sdk 0.1.0 → 0.2.1

package/src/userMap/WebsocketSubscription.ts

@@ -14,7 +14,7 @@ export class WebsocketSubscription {
 	private additionalFilters?: MemcmpFilter[];
 	private decodeFn: (name: string, data: Buffer) => UserAccount;
 
-	private subscriber: WebSocketProgramAccountSubscriber<UserAccount>;
+	private subscriber?: WebSocketProgramAccountSubscriber<UserAccount>;
 
 	constructor({
 		userMap,

package/src/userMap/grpcSubscription.ts

@@ -15,7 +15,7 @@ export class grpcSubscription {
 	private additionalFilters?: MemcmpFilter[];
 	private decodeFn: (name: string, data: Buffer) => UserAccount;
 
-	private subscriber: WebSocketProgramAccountSubscriber<UserAccount>;
+	private subscriber?: WebSocketProgramAccountSubscriber<UserAccount>;
 
 	constructor({
 		grpcConfigs,

package/src/userMap/referrerMap.ts

@@ -32,7 +32,7 @@ export class ReferrerMap {
 	private parallelSync: boolean;
 
 	private fetchPromise?: Promise<void>;
-	private fetchPromiseResolver: () => void;
+	private fetchPromiseResolver: () => void = () => {};
 
 	/**
 	 * Creates a new UserStatsMap instance.
@@ -72,12 +72,16 @@ export class ReferrerMap {
 				this.velocityClient.program.programId,
 				new PublicKey(authority)
 			);
-			const buffer = (
-				await this.velocityClient.connection.getAccountInfo(
-					userStatsAccountPublicKey,
-					'processed'
-				)
-			).data;
+			const accountInfo = await this.velocityClient.connection.getAccountInfo(
+				userStatsAccountPublicKey,
+				'processed'
+			);
+			if (!accountInfo) {
+				throw new Error(
+					`ReferrerMap: UserStats account not found for authority ${authority}`
+				);
+			}
+			const buffer = accountInfo.data;
 
 			const referrer = bs58.encode(buffer.subarray(40, 72));
 
@@ -173,7 +177,7 @@ export class ReferrerMap {
 		const rpcRequestArgs = [
 			this.velocityClient.program.programId.toBase58(),
 			{
-				commitment: this.velocityClient.opts.commitment,
+				commitment: this.velocityClient.opts?.commitment,
 				filters: [getUserStatsFilter()],
 				encoding: 'base64',
 				dataSlice: {
@@ -213,7 +217,7 @@ export class ReferrerMap {
 		const rpcRequestArgs = [
 			this.velocityClient.program.programId.toBase58(),
 			{
-				commitment: this.velocityClient.opts.commitment,
+				commitment: this.velocityClient.opts?.commitment,
 				filters: [getUserStatsFilter(), referrerFilter],
 				encoding: 'base64',
 				dataSlice: {
@@ -248,7 +252,7 @@ export class ReferrerMap {
 					// @ts-ignore
 					const buffer = Buffer.from(
 						programAccount.account.data[0],
-						programAccount.account.data[1]
+						programAccount.account.data[1] as BufferEncoding
 					);
 					const authority = bs58.encode(buffer.subarray(8, 40));
 					const referrer = bs58.encode(buffer.subarray(40, 72));

package/src/userMap/revenueShareEscrowMap.ts

@@ -13,7 +13,7 @@ export class RevenueShareEscrowMap {
 	private parallelSync: boolean;
 
 	private fetchPromise?: Promise<void>;
-	private fetchPromiseResolver: () => void;
+	private fetchPromiseResolver: () => void = () => {};
 
 	/**
 	 * Creates a new RevenueShareEscrowMap instance.
@@ -130,6 +130,11 @@ export class RevenueShareEscrowMap {
 				),
 				'confirmed'
 			);
+			if (accountInfo === null) {
+				throw new Error(
+					`RevenueShareEscrow account not found for authority ${authority} during slowSync`
+				);
+			}
 			const escrowNew = (
 				this.velocityClient.program.account as any
 			).revenueShareEscrow.coder.accounts.decode(
@@ -178,7 +183,7 @@ export class RevenueShareEscrowMap {
 							// @ts-ignore
 							const buffer = Buffer.from(
 								programAccount.account.data[0],
-								programAccount.account.data[1]
+								programAccount.account.data[1] as BufferEncoding
 							);
 
 							const escrow = (
@@ -205,7 +210,7 @@ export class RevenueShareEscrowMap {
 						// @ts-ignore
 						const buffer = Buffer.from(
 							programAccount.account.data[0],
-							programAccount.account.data[1]
+							programAccount.account.data[1] as BufferEncoding
 						);
 
 						const escrow = (

package/src/userMap/userMap.ts

@@ -85,23 +85,26 @@ export class UserMap implements UserMapInterface {
 	private filterByPoolId?: number;
 	private additionalFilters?: MemcmpFilter[];
 	private disableSyncOnTotalAccountsChange: boolean;
-	private lastNumberOfSubAccounts: BN;
+	private lastNumberOfSubAccounts?: BN;
 	private subscription:
 		| PollingSubscription
 		| WebsocketSubscription
 		| grpcSubscription;
 	private stateAccountUpdateCallback = async (state: StateAccount) => {
-		if (!state.numberOfSubAccounts.eq(this.lastNumberOfSubAccounts)) {
+		if (
+			this.lastNumberOfSubAccounts === undefined ||
+			!state.numberOfSubAccounts.eq(this.lastNumberOfSubAccounts)
+		) {
 			await this.sync();
 			this.lastNumberOfSubAccounts = state.numberOfSubAccounts;
 		}
 	};
-	private decode;
+	private decode: (name: string, buffer: Buffer) => UserAccount;
 	private mostRecentSlot = 0;
 	private syncConfig: SyncConfig;
 
 	private syncPromise?: Promise<void>;
-	private syncPromiseResolver: () => void;
+	private syncPromiseResolver: () => void = () => {};
 
 	private throwOnFailedSync: boolean;
 
@@ -117,20 +120,20 @@ export class UserMap implements UserMapInterface {
 			this.connection = this.velocityClient.connection;
 		}
 		this.commitment =
-			config.subscriptionConfig.type === 'websocket' ||
+			(config.subscriptionConfig.type === 'websocket' ||
 			config.subscriptionConfig.type === 'polling'
 				? config.subscriptionConfig.commitment ??
-				  this.velocityClient.opts.commitment
-				: this.velocityClient.opts.commitment;
+				  this.velocityClient.opts?.commitment
+				: this.velocityClient.opts?.commitment) ?? 'confirmed';
 		this.includeIdle = config.includeIdle ?? false;
 		this.filterByPoolId = config.filterByPoolId;
 		this.additionalFilters = config.additionalFilters;
 		this.disableSyncOnTotalAccountsChange =
 			config.disableSyncOnTotalAccountsChange ?? false;
 
-		let decodeFn;
+		let decodeFn: (name: string, buffer: Buffer) => UserAccount;
 		if (config.fastDecode ?? true) {
-			decodeFn = (name, buffer) => decodeUser(buffer);
+			decodeFn = (_name: string, buffer: Buffer) => decodeUser(buffer);
 		} else {
 			decodeFn = (
 				this.velocityClient.program.account as any
@@ -219,9 +222,15 @@ export class UserMap implements UserMapInterface {
 			},
 		});
 		await user.subscribe(userAccount);
+		const resolvedSlot = slot ?? user.getUserAccountAndSlot()?.slot;
+		if (resolvedSlot === undefined) {
+			throw new Error(
+				'UserMap.addPubkey: no slot available after subscribing user account'
+			);
+		}
 		this.userMap.set(userAccountPublicKey.toString(), {
 			data: user,
-			slot: slot ?? user.getUserAccountAndSlot()?.slot,
+			slot: resolvedSlot,
 		});
 		this.eventEmitter.emit('userUpdate', user);
 	}
@@ -259,7 +268,11 @@ export class UserMap implements UserMapInterface {
 				accountSubscription
 			);
 		}
-		return this.userMap.get(key).data;
+		const userWithSlot = this.userMap.get(key);
+		if (!userWithSlot) {
+			throw new Error(`UserMap.mustGet: no user found for ${key}`);
+		}
+		return userWithSlot.data;
 	}
 	public async mustGetWithSlot(
 		key: string,
@@ -273,12 +286,16 @@ export class UserMap implements UserMapInterface {
 				accountSubscription
 			);
 		}
-		return this.userMap.get(key);
+		const userWithSlot = this.userMap.get(key);
+		if (!userWithSlot) {
+			throw new Error(`UserMap.mustGetWithSlot: no user found for ${key}`);
+		}
+		return userWithSlot;
 	}
 
 	public async mustGetUserAccount(key: string): Promise<UserAccount> {
 		const user = await this.mustGet(key);
-		return user.getUserAccount();
+		return user.getUserAccountOrThrow();
 	}
 
 	/**
@@ -291,7 +308,7 @@ export class UserMap implements UserMapInterface {
 		if (!user) {
 			return undefined;
 		}
-		return user.data.getUserAccount().authority;
+		return user.data.getUserAccount()?.authority;
 	}
 
 	/**
@@ -375,15 +392,15 @@ export class UserMap implements UserMapInterface {
 		filterCriteria?: UserFilterCriteria
 	): PublicKey[] {
 		const usersMeetingCriteria = Array.from(this.values()).filter((user) => {
-			let pass = true;
+			const userAccount = user.getUserAccountOrThrow();
 			if (filterCriteria && filterCriteria.hasOpenOrders) {
-				pass = pass && user.getUserAccount().hasOpenOrder;
+				return userAccount.hasOpenOrder;
 			}
-			return pass;
+			return true;
 		});
 		const userAuths = new Set(
 			usersMeetingCriteria.map((user) =>
-				user.getUserAccount().authority.toBase58()
+				user.getUserAccountOrThrow().authority.toBase58()
 			)
 		);
 		const userAuthKeys = Array.from(userAuths).map(
@@ -537,9 +554,12 @@ export class UserMap implements UserMapInterface {
 				(account) => account.pubkey
 			);
 
-			const limitConcurrency = async (tasks, limit) => {
-				const executing = [];
-				const results = [];
+			const limitConcurrency = async (
+				tasks: Array<() => Promise<void>>,
+				limit: number
+			) => {
+				const executing: Promise<void>[] = [];
+				const results: Promise<void>[] = [];
 
 				for (let i = 0; i < tasks.length; i++) {
 					const executor = Promise.resolve().then(tasks[i]);
@@ -565,7 +585,7 @@ export class UserMap implements UserMapInterface {
 
 			// @ts-ignore
 			const chunkSize = this.syncConfig.chunkSize ?? 100;
-			const tasks = [];
+			const tasks: Array<() => Promise<void>> = [];
 			for (let i = 0; i < accountPublicKeys.length; i += chunkSize) {
 				const chunk = accountPublicKeys.slice(i, i + chunkSize);
 				tasks.push(async () => {
@@ -626,9 +646,7 @@ export class UserMap implements UserMapInterface {
 				throw err;
 			}
 		} finally {
-			if (this.syncPromiseResolver) {
-				this.syncPromiseResolver();
-			}
+			this.syncPromiseResolver();
 			this.syncPromise = undefined;
 		}
 	}

package/src/userMap/userStatsMap.ts

@@ -32,7 +32,7 @@ export class UserStatsMap {
 	private syncConfig: SyncConfig;
 
 	private syncPromise?: Promise<void>;
-	private syncPromiseResolver: () => void;
+	private syncPromiseResolver: () => void = () => {};
 
 	/**
 	 * Creates a new UserStatsMap instance.
@@ -49,7 +49,7 @@ export class UserStatsMap {
 		if (!bulkAccountLoader) {
 			bulkAccountLoader = new BulkAccountLoader(
 				velocityClient.connection,
-				velocityClient.opts.commitment,
+				velocityClient.opts?.commitment ?? 'confirmed',
 				0
 			);
 		}
@@ -110,8 +110,12 @@ export class UserStatsMap {
 
 	public async updateWithOrderRecord(record: OrderRecord, userMap: UserMap) {
 		const user = await userMap.mustGet(record.user.toString());
-		if (!this.has(user.getUserAccount().authority.toString())) {
-			await this.addUserStat(user.getUserAccount().authority, undefined, false);
+		if (!this.has(user.getUserAccountOrThrow().authority.toString())) {
+			await this.addUserStat(
+				user.getUserAccountOrThrow().authority,
+				undefined,
+				false
+			);
 		}
 	}
 
@@ -133,12 +137,14 @@ export class UserStatsMap {
 			const liqRecord = record as LiquidationRecord;
 
 			const user = await userMap.mustGet(liqRecord.user.toString());
-			await this.mustGet(user.getUserAccount().authority.toString());
+			await this.mustGet(user.getUserAccountOrThrow().authority.toString());
 
 			const liquidatorUser = await userMap.mustGet(
 				liqRecord.liquidator.toString()
 			);
-			await this.mustGet(liquidatorUser.getUserAccount().authority.toString());
+			await this.mustGet(
+				liquidatorUser.getUserAccountOrThrow().authority.toString()
+			);
 		} else if (record.eventType === 'OrderRecord') {
 			if (!userMap) {
 				return;
@@ -153,11 +159,11 @@ export class UserStatsMap {
 
 			if (actionRecord.taker) {
 				const taker = await userMap.mustGet(actionRecord.taker.toString());
-				await this.mustGet(taker.getUserAccount().authority.toString());
+				await this.mustGet(taker.getUserAccountOrThrow().authority.toString());
 			}
 			if (actionRecord.maker) {
 				const maker = await userMap.mustGet(actionRecord.maker.toString());
-				await this.mustGet(maker.getUserAccount().authority.toString());
+				await this.mustGet(maker.getUserAccountOrThrow().authority.toString());
 			}
 		} else if (record.eventType === 'SettlePnlRecord') {
 			if (!userMap) {
@@ -165,7 +171,7 @@ export class UserStatsMap {
 			}
 			const settlePnlRecord = record as SettlePnlRecord;
 			const user = await userMap.mustGet(settlePnlRecord.user.toString());
-			await this.mustGet(user.getUserAccount().authority.toString());
+			await this.mustGet(user.getUserAccountOrThrow().authority.toString());
 		} else if (record.eventType === 'NewUserRecord') {
 			const newUserRecord = record as NewUserRecord;
 			await this.mustGet(newUserRecord.userAuthority.toString());
@@ -179,7 +185,7 @@ export class UserStatsMap {
 		return this.userStatsMap.has(authorityPublicKey);
 	}
 
-	public get(authorityPublicKey: string): UserStats {
+	public get(authorityPublicKey: string): UserStats | undefined {
 		return this.userStatsMap.get(authorityPublicKey);
 	}
 
@@ -197,7 +203,13 @@ export class UserStatsMap {
 				false
 			);
 		}
-		return this.get(authorityPublicKey);
+		const userStats = this.get(authorityPublicKey);
+		if (!userStats) {
+			throw new Error(
+				`UserStatsMap: UserStats missing for authority ${authorityPublicKey} after addUserStat`
+			);
+		}
+		return userStats;
 	}
 
 	public values(): IterableIterator<UserStats> {
@@ -262,9 +274,12 @@ export class UserStatsMap {
 				accountsToLoad = accountsPrefetch.map((account) => account.pubkey);
 			}
 
-			const limitConcurrency = async (tasks, limit) => {
-				const executing = [];
-				const results = [];
+			const limitConcurrency = async (
+				tasks: Array<() => Promise<void>>,
+				limit: number
+			) => {
+				const executing: Array<Promise<void>> = [];
+				const results: Array<Promise<void>> = [];
 
 				for (let i = 0; i < tasks.length; i++) {
 					const executor = Promise.resolve().then(tasks[i]);
@@ -290,7 +305,7 @@ export class UserStatsMap {
 
 			// @ts-ignore
 			const chunkSize = this.syncConfig.chunkSize ?? 100;
-			const tasks = [];
+			const tasks: Array<() => Promise<void>> = [];
 			for (let i = 0; i < accountsToLoad.length; i += chunkSize) {
 				const chunk = accountsToLoad.slice(i, i + chunkSize);
 				tasks.push(async () => {
@@ -298,7 +313,7 @@ export class UserStatsMap {
 						await this.velocityClient.connection.getMultipleAccountsInfoAndContext(
 							chunk,
 							{
-								commitment: this.velocityClient.opts.commitment,
+								commitment: this.velocityClient.opts?.commitment,
 							}
 						);
 
@@ -342,9 +357,7 @@ export class UserStatsMap {
 		} catch (err) {
 			console.error(`Error in UserStatsMap.paginatedSync():`, err);
 		} finally {
-			if (this.syncPromiseResolver) {
-				this.syncPromiseResolver();
-			}
+			this.syncPromiseResolver();
 			this.syncPromise = undefined;
 		}
 	}

package/src/userStats.ts

@@ -20,7 +20,7 @@ export class UserStats {
 	velocityClient: VelocityClient;
 	userStatsAccountPublicKey: PublicKey;
 	accountSubscriber: UserStatsAccountSubscriber;
-	isSubscribed: boolean;
+	isSubscribed = false;
 
 	public constructor(config: UserStatsConfig) {
 		// Type-system guarantees at least one of the two is supplied.
@@ -57,7 +57,7 @@ export class UserStats {
 			this.accountSubscriber =
 				config.accountSubscription.userStatsAccountSubscriber;
 		} else {
-			const exhaustiveCheck: never = config.accountSubscription;
+			const exhaustiveCheck: undefined = config.accountSubscription;
 
 			throw new Error(
 				`Unknown user stats account subscription type: ${exhaustiveCheck}`
@@ -83,27 +83,40 @@ export class UserStats {
 		this.isSubscribed = false;
 	}
 
-	public getAccountAndSlot(): DataAndSlot<UserStatsAccount> {
+	public getAccountAndSlot(): DataAndSlot<UserStatsAccount> | undefined {
 		return this.accountSubscriber.getUserStatsAccountAndSlot();
 	}
 
-	public getAccount(): UserStatsAccount {
-		return this.accountSubscriber.getUserStatsAccountAndSlot().data;
+	public getAccount(): UserStatsAccount | undefined {
+		return this.accountSubscriber.getUserStatsAccountAndSlot()?.data;
+	}
+
+	/**
+	 * Like {@link getAccount} but throws a named error instead of returning
+	 * `undefined` when the stats account has not been loaded yet.
+	 */
+	public getAccountOrThrow(): UserStatsAccount {
+		const account = this.getAccount();
+		if (!account) {
+			throw new Error('UserStats account not loaded');
+		}
+		return account;
 	}
 
 	public getReferrerInfo(): ReferrerInfo | undefined {
-		if (this.getAccount().referrer.equals(PublicKey.default)) {
+		const account = this.getAccount();
+		if (!account || account.referrer.equals(PublicKey.default)) {
 			return undefined;
 		} else {
 			return {
 				referrer: getUserAccountPublicKeySync(
 					this.velocityClient.program.programId,
-					this.getAccount().referrer,
+					account.referrer,
 					0
 				),
 				referrerStats: getUserStatsAccountPublicKey(
 					this.velocityClient.program.programId,
-					this.getAccount().referrer
+					account.referrer
 				),
 			};
 		}

package/src/util/TransactionConfirmationManager.ts

@@ -62,7 +62,7 @@ export class TransactionConfirmationManager {
 
 		let response: RpcResponseAndContext<SignatureResult> | null = null;
 
-		let subscriptionId: ClientSubscriptionId;
+		let subscriptionId: ClientSubscriptionId | undefined;
 
 		const confirmationPromise = new Promise((resolve, reject) => {
 			try {
@@ -262,13 +262,21 @@ export class TransactionConfirmationManager {
 
 			if (status.err) {
 				this.pendingConfirmations.delete(request.txSig);
+				const txError = await getTransactionErrorFromTxSig(
+					request.txSig,
+					this.connection
+				);
 				request.reject(
-					await getTransactionErrorFromTxSig(request.txSig, this.connection)
+					txError ??
+						new Error(
+							`Transaction failed but no error could be resolved for signature ${request.txSig}`
+						)
 				);
 				continue;
 			}
 
 			if (
+				status.confirmationStatus === undefined ||
 				confirmationStatusValues[status.confirmationStatus] === undefined ||
 				confirmationStatusValues[request.desiredConfirmationStatus] ===
 					undefined

package/src/util/chainClock.ts

@@ -35,7 +35,7 @@ export class ChainClock {
 		}
 	}
 
-	public getState(commitment: Commitment): ChainClockProgress {
+	public getState(commitment: Commitment): ChainClockProgress | undefined {
 		return this._state.get(commitment);
 	}
 }

package/src/util/computeUnits.ts

@@ -11,13 +11,17 @@ export async function findComputeUnitConsumption(
 	connection: Connection,
 	txSignature: string,
 	commitment: Finality = 'confirmed'
-): Promise<number[]> {
+): Promise<string[]> {
 	const tx = await connection.getTransaction(txSignature, { commitment });
-	const computeUnits = [];
+	const computeUnits: string[] = [];
+	const logMessages = tx?.meta?.logMessages;
+	if (!logMessages) {
+		return computeUnits;
+	}
 	const regex = new RegExp(
 		`Program ${programId.toString()} consumed ([0-9]{0,6}) of ([0-9]{0,7}) compute units`
 	);
-	tx.meta.logMessages.forEach((logMessage) => {
+	logMessages.forEach((logMessage) => {
 		const match = logMessage.match(regex);
 		if (match && match[1]) {
 			computeUnits.push(match[1]);