@velocity-exchange/sdk 0.0.1 → 0.0.3

package/src/userMap/referrerMap.ts

@@ -28,7 +28,11 @@ export class ReferrerMap {
 	 * Will be undefined if the referrer is not in the map yet.
 	 */
 	private referrerReferrerInfoMap = new Map<string, ReferrerInfo>();
-	private driftClient: VelocityClient;
+	private velocityClient: VelocityClient;
+	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
+	private get driftClient(): VelocityClient {
+		return this.velocityClient;
+	}
 	private parallelSync: boolean;
 
 	private fetchPromise?: Promise<void>;
@@ -37,10 +41,10 @@ export class ReferrerMap {
 	/**
 	 * Creates a new UserStatsMap instance.
 	 *
-	 * @param {VelocityClient} driftClient - The VelocityClient instance.
+	 * @param {VelocityClient} velocityClient - The VelocityClient instance.
 	 */
-	constructor(driftClient: VelocityClient, parallelSync?: boolean) {
-		this.driftClient = driftClient;
+	constructor(velocityClient: VelocityClient, parallelSync?: boolean) {
+		this.velocityClient = velocityClient;
 		this.parallelSync = parallelSync !== undefined ? parallelSync : true;
 	}
 
@@ -52,7 +56,7 @@ export class ReferrerMap {
 			return;
 		}
 
-		await this.driftClient.subscribe();
+		await this.velocityClient.subscribe();
 		await this.sync();
 	}
 
@@ -69,11 +73,11 @@ export class ReferrerMap {
 			this.authorityReferrerMap.set(authority, referrer);
 		} else if (referrer === undefined) {
 			const userStatsAccountPublicKey = getUserStatsAccountPublicKey(
-				this.driftClient.program.programId,
+				this.velocityClient.program.programId,
 				new PublicKey(authority)
 			);
 			const buffer = (
-				await this.driftClient.connection.getAccountInfo(
+				await this.velocityClient.connection.getAccountInfo(
 					userStatsAccountPublicKey,
 					'processed'
 				)
@@ -118,12 +122,12 @@ export class ReferrerMap {
 		const referrerKey = new PublicKey(referrer);
 		const referrerInfo = {
 			referrer: getUserAccountPublicKeySync(
-				this.driftClient.program.programId,
+				this.velocityClient.program.programId,
 				referrerKey,
 				0
 			),
 			referrerStats: getUserStatsAccountPublicKey(
-				this.driftClient.program.programId,
+				this.velocityClient.program.programId,
 				referrerKey
 			),
 		};
@@ -171,9 +175,9 @@ export class ReferrerMap {
 
 	public async syncAll(): Promise<void> {
 		const rpcRequestArgs = [
-			this.driftClient.program.programId.toBase58(),
+			this.velocityClient.program.programId.toBase58(),
 			{
-				commitment: this.driftClient.opts.commitment,
+				commitment: this.velocityClient.opts.commitment,
 				filters: [getUserStatsFilter()],
 				encoding: 'base64',
 				dataSlice: {
@@ -186,7 +190,7 @@ export class ReferrerMap {
 
 		const rpcJSONResponse: any =
 			// @ts-ignore
-			await this.driftClient.connection._rpcRequest(
+			await this.velocityClient.connection._rpcRequest(
 				'getProgramAccounts',
 				rpcRequestArgs
 			);
@@ -211,9 +215,9 @@ export class ReferrerMap {
 
 	async syncReferrer(referrerFilter: MemcmpFilter): Promise<void> {
 		const rpcRequestArgs = [
-			this.driftClient.program.programId.toBase58(),
+			this.velocityClient.program.programId.toBase58(),
 			{
-				commitment: this.driftClient.opts.commitment,
+				commitment: this.velocityClient.opts.commitment,
 				filters: [getUserStatsFilter(), referrerFilter],
 				encoding: 'base64',
 				dataSlice: {
@@ -226,7 +230,7 @@ export class ReferrerMap {
 
 		const rpcJSONResponse: any =
 			// @ts-ignore
-			await this.driftClient.connection._rpcRequest(
+			await this.velocityClient.connection._rpcRequest(
 				'getProgramAccounts',
 				rpcRequestArgs
 			);

package/src/userMap/revenueShareEscrowMap.ts

@@ -9,7 +9,11 @@ export class RevenueShareEscrowMap {
 	 * map from authority pubkey to RevenueShareEscrow account data.
 	 */
 	private authorityEscrowMap = new Map<string, RevenueShareEscrowAccount>();
-	private driftClient: VelocityClient;
+	private velocityClient: VelocityClient;
+	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
+	private get driftClient(): VelocityClient {
+		return this.velocityClient;
+	}
 	private parallelSync: boolean;
 
 	private fetchPromise?: Promise<void>;
@@ -18,11 +22,11 @@ export class RevenueShareEscrowMap {
 	/**
 	 * Creates a new RevenueShareEscrowMap instance.
 	 *
-	 * @param {VelocityClient} driftClient - The VelocityClient instance.
+	 * @param {VelocityClient} velocityClient - The VelocityClient instance.
 	 * @param {boolean} parallelSync - Whether to sync accounts in parallel.
 	 */
-	constructor(driftClient: VelocityClient, parallelSync?: boolean) {
-		this.driftClient = driftClient;
+	constructor(velocityClient: VelocityClient, parallelSync?: boolean) {
+		this.velocityClient = velocityClient;
 		this.parallelSync = parallelSync !== undefined ? parallelSync : true;
 	}
 
@@ -34,7 +38,7 @@ export class RevenueShareEscrowMap {
 			return;
 		}
 
-		await this.driftClient.subscribe();
+		await this.velocityClient.subscribe();
 		await this.sync();
 	}
 
@@ -65,19 +69,19 @@ export class RevenueShareEscrowMap {
 
 	public async addRevenueShareEscrow(authority: string) {
 		const escrowAccountPublicKey = getRevenueShareEscrowAccountPublicKey(
-			this.driftClient.program.programId,
+			this.velocityClient.program.programId,
 			new PublicKey(authority)
 		);
 
 		try {
-			const accountInfo = await this.driftClient.connection.getAccountInfo(
+			const accountInfo = await this.velocityClient.connection.getAccountInfo(
 				escrowAccountPublicKey,
 				'processed'
 			);
 
 			if (accountInfo && accountInfo.data) {
 				const escrow = (
-					this.driftClient.program.account as any
+					this.velocityClient.program.account as any
 				).revenueShareEscrow.coder.accounts.decode(
 					'revenueShareEscrow',
 					accountInfo.data
@@ -123,15 +127,15 @@ export class RevenueShareEscrowMap {
 			return this.fetchPromise;
 		}
 		for (const authority of this.authorityEscrowMap.keys()) {
-			const accountInfo = await this.driftClient.connection.getAccountInfo(
+			const accountInfo = await this.velocityClient.connection.getAccountInfo(
 				getRevenueShareEscrowAccountPublicKey(
-					this.driftClient.program.programId,
+					this.velocityClient.program.programId,
 					new PublicKey(authority)
 				),
 				'confirmed'
 			);
 			const escrowNew = (
-				this.driftClient.program.account as any
+				this.velocityClient.program.account as any
 			).revenueShareEscrow.coder.accounts.decode(
 				'revenueShareEscrow',
 				accountInfo.data
@@ -142,9 +146,9 @@ export class RevenueShareEscrowMap {
 
 	public async syncAll(): Promise<void> {
 		const rpcRequestArgs = [
-			this.driftClient.program.programId.toBase58(),
+			this.velocityClient.program.programId.toBase58(),
 			{
-				commitment: this.driftClient.opts.commitment,
+				commitment: this.velocityClient.opts.commitment,
 				filters: [getRevenueShareEscrowFilter()],
 				encoding: 'base64',
 				withContext: true,
@@ -153,7 +157,7 @@ export class RevenueShareEscrowMap {
 
 		const rpcJSONResponse: any =
 			// @ts-ignore
-			await this.driftClient.connection._rpcRequest(
+			await this.velocityClient.connection._rpcRequest(
 				'getProgramAccounts',
 				rpcRequestArgs
 			);
@@ -182,7 +186,7 @@ export class RevenueShareEscrowMap {
 							);
 
 							const escrow = (
-								this.driftClient.program.account as any
+								this.velocityClient.program.account as any
 							).revenueShareEscrow.coder.accounts.decode(
 								'revenueShareEscrow',
 								buffer
@@ -209,7 +213,7 @@ export class RevenueShareEscrowMap {
 						);
 
 						const escrow = (
-							this.driftClient.program.account as any
+							this.velocityClient.program.account as any
 						).revenueShareEscrow.coder.accounts.decode(
 							'revenueShareEscrow',
 							buffer

package/src/userMap/userMap.ts

@@ -77,7 +77,11 @@ export interface UserMapInterface {
 
 export class UserMap implements UserMapInterface {
 	private userMap = new Map<string, DataAndSlot<User>>();
-	driftClient: VelocityClient;
+	velocityClient: VelocityClient;
+	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
+	public get driftClient(): VelocityClient {
+		return this.velocityClient;
+	}
 	eventEmitter: StrictEventEmitter<EventEmitter, UserEvents>;
 	private connection: Connection;
 	private commitment: Commitment;
@@ -109,18 +113,19 @@ export class UserMap implements UserMapInterface {
 	 * Constructs a new UserMap instance.
 	 */
 	constructor(config: UserMapConfig) {
-		this.driftClient = config.driftClient;
+		// Type-system guarantees at least one of the two is supplied.
+		this.velocityClient = (config.velocityClient ?? config.driftClient)!;
 		if (config.connection) {
 			this.connection = config.connection;
 		} else {
-			this.connection = this.driftClient.connection;
+			this.connection = this.velocityClient.connection;
 		}
 		this.commitment =
 			config.subscriptionConfig.type === 'websocket' ||
 			config.subscriptionConfig.type === 'polling'
 				? config.subscriptionConfig.commitment ??
-				  this.driftClient.opts.commitment
-				: this.driftClient.opts.commitment;
+				  this.velocityClient.opts.commitment
+				: this.velocityClient.opts.commitment;
 		this.includeIdle = config.includeIdle ?? false;
 		this.filterByPoolId = config.filterByPoolId;
 		this.additionalFilters = config.additionalFilters;
@@ -132,9 +137,9 @@ export class UserMap implements UserMapInterface {
 			decodeFn = (name, buffer) => decodeUser(buffer);
 		} else {
 			decodeFn = (
-				this.driftClient.program.account as any
+				this.velocityClient.program.account as any
 			).user.coder.accounts.decodeUnchecked.bind(
-				(this.driftClient.program.account as any).user.coder.accounts
+				(this.velocityClient.program.account as any).user.coder.accounts
 			);
 		}
 		this.decode = decodeFn;
@@ -183,11 +188,11 @@ export class UserMap implements UserMapInterface {
 			return;
 		}
 
-		await this.driftClient.subscribe();
+		await this.velocityClient.subscribe();
 		this.lastNumberOfSubAccounts =
-			this.driftClient.getStateAccount().numberOfSubAccounts;
+			this.velocityClient.getStateAccount().numberOfSubAccounts;
 		if (!this.disableSyncOnTotalAccountsChange) {
-			this.driftClient.eventEmitter.on(
+			this.velocityClient.eventEmitter.on(
 				'stateAccountUpdate',
 				this.stateAccountUpdateCallback
 			);
@@ -203,13 +208,13 @@ export class UserMap implements UserMapInterface {
 		accountSubscription?: UserSubscriptionConfig
 	) {
 		const user = new User({
-			driftClient: this.driftClient,
+			velocityClient: this.velocityClient,
 			userAccountPublicKey,
 			accountSubscription: accountSubscription ?? {
 				type: 'custom',
 				// OneShotUserAccountSubscriber used here so we don't load up the RPC with AccountSubscribes
 				userAccountSubscriber: new OneShotUserAccountSubscriber(
-					this.driftClient.program,
+					this.velocityClient.program,
 					userAccountPublicKey,
 					userAccount,
 					slot,
@@ -428,7 +433,7 @@ export class UserMap implements UserMapInterface {
 
 		try {
 			const rpcRequestArgs = [
-				this.driftClient.program.programId.toBase58(),
+				this.velocityClient.program.programId.toBase58(),
 				{
 					commitment: this.commitment,
 					filters: this.getFilters(),
@@ -526,7 +531,7 @@ export class UserMap implements UserMapInterface {
 
 		try {
 			const accountsPrefetch = await this.connection.getProgramAccounts(
-				this.driftClient.program.programId,
+				this.velocityClient.program.programId,
 				{
 					dataSlice: { offset: 0, length: 0 },
 					filters: this.getFilters(),
@@ -642,7 +647,7 @@ export class UserMap implements UserMapInterface {
 
 		if (this.lastNumberOfSubAccounts) {
 			if (!this.disableSyncOnTotalAccountsChange) {
-				this.driftClient.eventEmitter.removeListener(
+				this.velocityClient.eventEmitter.removeListener(
 					'stateAccountUpdate',
 					this.stateAccountUpdateCallback
 				);

package/src/userMap/userMapConfig.ts

@@ -1,6 +1,7 @@
 import { Commitment, Connection, MemcmpFilter } from '@solana/web3.js';
 import { VelocityClient } from '../velocityClient';
 import { GrpcConfigs } from '../accounts/types';
+import { AtLeastOne } from '../util/deprecatedAlias';
 
 // passed into UserMap.getUniqueAuthorities to filter users
 export type UserAccountFilterCriteria = {
@@ -18,9 +19,8 @@ export type SyncConfig =
 			concurrencyLimit?: number;
 	  };
 
-export type UserMapConfig = {
-	driftClient: VelocityClient;
-	// connection object to use specifically for the UserMap. If undefined, will use the driftClient's connection
+type UserMapConfigBase = {
+	// connection object to use specifically for the UserMap. If undefined, will use the velocityClient's connection
 	connection?: Connection;
 	subscriptionConfig:
 		| {
@@ -64,3 +64,6 @@ export type UserMapConfig = {
 
 	additionalFilters?: MemcmpFilter[];
 };
+
+export type UserMapConfig = UserMapConfigBase &
+	AtLeastOne<'velocityClient', 'driftClient', VelocityClient>;

package/src/userMap/userStatsMap.ts

@@ -26,7 +26,11 @@ export class UserStatsMap {
 	 * map from authority pubkey to UserStats
 	 */
 	private userStatsMap = new Map<string, UserStats>();
-	private driftClient: VelocityClient;
+	private velocityClient: VelocityClient;
+	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
+	private get driftClient(): VelocityClient {
+		return this.velocityClient;
+	}
 	private bulkAccountLoader: BulkAccountLoader;
 	private decode;
 	private syncConfig: SyncConfig;
@@ -37,19 +41,19 @@ export class UserStatsMap {
 	/**
 	 * Creates a new UserStatsMap instance.
 	 *
-	 * @param {VelocityClient} driftClient - The VelocityClient instance.
+	 * @param {VelocityClient} velocityClient - The VelocityClient instance.
 	 * @param {BulkAccountLoader} [bulkAccountLoader] - If not provided, a new BulkAccountLoader with polling disabled will be created.
 	 */
 	constructor(
-		driftClient: VelocityClient,
+		velocityClient: VelocityClient,
 		bulkAccountLoader?: BulkAccountLoader,
 		syncConfig?: SyncConfig
 	) {
-		this.driftClient = driftClient;
+		this.velocityClient = velocityClient;
 		if (!bulkAccountLoader) {
 			bulkAccountLoader = new BulkAccountLoader(
-				driftClient.connection,
-				driftClient.opts.commitment,
+				velocityClient.connection,
+				velocityClient.opts.commitment,
 				0
 			);
 		}
@@ -60,9 +64,9 @@ export class UserStatsMap {
 		};
 
 		this.decode = (
-			this.driftClient.program.account as any
+			this.velocityClient.program.account as any
 		).userStats.coder.accounts.decodeUnchecked.bind(
-			(this.driftClient.program.account as any).userStats.coder.accounts
+			(this.velocityClient.program.account as any).userStats.coder.accounts
 		);
 	}
 
@@ -71,7 +75,7 @@ export class UserStatsMap {
 			return;
 		}
 
-		await this.driftClient.subscribe();
+		await this.velocityClient.subscribe();
 		await this.sync(authorities);
 	}
 
@@ -87,9 +91,9 @@ export class UserStatsMap {
 		skipFetch?: boolean
 	) {
 		const userStat = new UserStats({
-			driftClient: this.driftClient,
+			velocityClient: this.velocityClient,
 			userStatsAccountPublicKey: getUserStatsAccountPublicKey(
-				this.driftClient.program.programId,
+				this.velocityClient.program.programId,
 				authority
 			),
 			accountSubscription: {
@@ -252,8 +256,8 @@ export class UserStatsMap {
 			let accountsToLoad = authorities;
 			if (authorities.length === 0) {
 				const accountsPrefetch =
-					await this.driftClient.connection.getProgramAccounts(
-						this.driftClient.program.programId,
+					await this.velocityClient.connection.getProgramAccounts(
+						this.velocityClient.program.programId,
 						{
 							dataSlice: { offset: 0, length: 0 },
 							filters: [getUserStatsFilter()],
@@ -295,10 +299,10 @@ export class UserStatsMap {
 				const chunk = accountsToLoad.slice(i, i + chunkSize);
 				tasks.push(async () => {
 					const accountInfos =
-						await this.driftClient.connection.getMultipleAccountsInfoAndContext(
+						await this.velocityClient.connection.getMultipleAccountsInfoAndContext(
 							chunk,
 							{
-								commitment: this.driftClient.opts.commitment,
+								commitment: this.velocityClient.opts.commitment,
 							}
 						);
 

package/src/userStats.ts

@@ -17,24 +17,30 @@ import {
 import { grpcUserStatsAccountSubscriber } from './accounts/grpcUserStatsAccountSubscriber';
 
 export class UserStats {
-	driftClient: VelocityClient;
+	velocityClient: VelocityClient;
+	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
+	public get driftClient(): VelocityClient {
+		return this.velocityClient;
+	}
 	userStatsAccountPublicKey: PublicKey;
 	accountSubscriber: UserStatsAccountSubscriber;
 	isSubscribed: boolean;
 
 	public constructor(config: UserStatsConfig) {
-		this.driftClient = config.driftClient;
+		// Type-system guarantees at least one of the two is supplied.
+		const velocityClient = (config.velocityClient ?? config.driftClient)!;
+		this.velocityClient = velocityClient;
 		this.userStatsAccountPublicKey = config.userStatsAccountPublicKey;
 		if (config.accountSubscription?.type === 'polling') {
 			this.accountSubscriber = new PollingUserStatsAccountSubscriber(
-				config.driftClient.program,
+				velocityClient.program,
 				config.userStatsAccountPublicKey,
 				config.accountSubscription.accountLoader
 			);
 		} else if (config.accountSubscription?.type === 'grpc') {
 			this.accountSubscriber = new grpcUserStatsAccountSubscriber(
 				config.accountSubscription.grpcConfigs,
-				config.driftClient.program,
+				velocityClient.program,
 				config.userStatsAccountPublicKey,
 				{
 					resubTimeoutMs: config.accountSubscription?.resubTimeoutMs,
@@ -43,7 +49,7 @@ export class UserStats {
 			);
 		} else if (config.accountSubscription?.type === 'websocket') {
 			this.accountSubscriber = new WebSocketUserStatsAccountSubscriber(
-				config.driftClient.program,
+				velocityClient.program,
 				config.userStatsAccountPublicKey,
 				{
 					resubTimeoutMs: config.accountSubscription?.resubTimeoutMs,
@@ -95,12 +101,12 @@ export class UserStats {
 		} else {
 			return {
 				referrer: getUserAccountPublicKeySync(
-					this.driftClient.program.programId,
+					this.velocityClient.program.programId,
 					this.getAccount().referrer,
 					0
 				),
 				referrerStats: getUserStatsAccountPublicKey(
-					this.driftClient.program.programId,
+					this.velocityClient.program.programId,
 					this.getAccount().referrer
 				),
 			};

package/src/userStatsConfig.ts

@@ -2,13 +2,16 @@ import { VelocityClient } from './velocityClient';
 import { Commitment, PublicKey } from '@solana/web3.js';
 import { BulkAccountLoader } from './accounts/bulkAccountLoader';
 import { GrpcConfigs, UserStatsAccountSubscriber } from './accounts/types';
+import { AtLeastOne } from './util/deprecatedAlias';
 
-export type UserStatsConfig = {
+type UserStatsConfigBase = {
 	accountSubscription?: UserStatsSubscriptionConfig;
-	driftClient: VelocityClient;
 	userStatsAccountPublicKey: PublicKey;
 };
 
+export type UserStatsConfig = UserStatsConfigBase &
+	AtLeastOne<'velocityClient', 'driftClient', VelocityClient>;
+
 export type UserStatsSubscriptionConfig =
 	| {
 			type: 'websocket';

package/src/util/deprecatedAlias.ts

@@ -0,0 +1,25 @@
+/**
+ * Type helpers for expressing the Drift → Velocity rename surface.
+ *
+ * The SDK exposes paired keys (`velocityX` canonical, `driftX` deprecated) on
+ * several config objects. {@link AtLeastOne} captures the "callers must supply
+ * one of the two" contract at the type level so the runtime fallback in the
+ * consuming class can rely on the value being present.
+ */
+
+/**
+ * `AtLeastOne<A, B, T>` requires the caller to set at least one of two keys
+ * (`A` canonical, `B` deprecated) to a value of type `T`. Whichever the caller
+ * omits remains optional.
+ *
+ * Use this to express "rename `B` to `A`, but keep `B` accepted until the next
+ * major" on a config object without dropping back to "both optional + runtime
+ * throw".
+ */
+export type AtLeastOne<
+	A extends string,
+	B extends string,
+	T
+> =
+	| ({ [K in A]: T } & { [K in B]?: T })
+	| ({ [K in A]?: T } & { [K in B]: T });

package/src/velocityClient.ts

@@ -429,7 +429,7 @@ export class VelocityClient {
 
 		if (config.userStats) {
 			this.userStats = new UserStats({
-				driftClient: this,
+				velocityClient: this,
 				userStatsAccountPublicKey: getUserStatsAccountPublicKey(
 					this.program.programId,
 					this.authority
@@ -539,7 +539,7 @@ export class VelocityClient {
 		);
 
 		return new User({
-			driftClient: this,
+			velocityClient: this,
 			userAccountPublicKey,
 			accountSubscription: accountSubscriptionConfig,
 		});
@@ -820,7 +820,7 @@ export class VelocityClient {
 		this.userStats = undefined;
 
 		this.userStats = new UserStats({
-			driftClient: this,
+			velocityClient: this,
 			userStatsAccountPublicKey: this.getUserStatsAccountPublicKey(),
 			accountSubscription: this.userStatsAccountSubscriptionConfig,
 		});
@@ -868,7 +868,7 @@ export class VelocityClient {
 		this.userStats = undefined;
 
 		this.userStats = new UserStats({
-			driftClient: this,
+			velocityClient: this,
 			userStatsAccountPublicKey: this.getUserStatsAccountPublicKey(),
 			accountSubscription: this.userStatsAccountSubscriptionConfig,
 		});
@@ -903,7 +903,7 @@ export class VelocityClient {
 			}
 
 			this.userStats = new UserStats({
-				driftClient: this,
+				velocityClient: this,
 				userStatsAccountPublicKey: this.userStatsAccountPublicKey,
 				accountSubscription: this.userStatsAccountSubscriptionConfig,
 			});
@@ -5322,7 +5322,7 @@ export class VelocityClient {
 					withBuilder = hasBuilder(userOrder);
 				}
 			} else if (isSignedMsg) {
-				// Order hasn't been placed yet, we cant tell if it has a builder or not.
+				// Order hasn't been placed yet, we can't tell if it has a builder or not.
 				// Include it optimistically
 				withBuilder = true;
 			}