@velocity-exchange/sdk 0.3.0 → 0.6.0

package/src/userMap/userMapConfig.ts

@@ -1,69 +0,0 @@
-import { Commitment, Connection, MemcmpFilter } from '@solana/web3.js';
-import { VelocityClient } from '../velocityClient';
-import { GrpcConfigs } from '../accounts/types';
-
-// passed into UserMap.getUniqueAuthorities to filter users
-export type UserAccountFilterCriteria = {
-	// only return users that have open orders
-	hasOpenOrders: boolean;
-};
-
-export type SyncConfig =
-	| {
-			type: 'default';
-	  }
-	| {
-			type: 'paginated';
-			chunkSize?: number;
-			concurrencyLimit?: number;
-	  };
-
-type UserMapConfigBase = {
-	// connection object to use specifically for the UserMap. If undefined, will use the velocityClient's connection
-	connection?: Connection;
-	subscriptionConfig:
-		| {
-				type: 'polling';
-				frequency: number;
-				commitment?: Commitment;
-		  }
-		| {
-				type: 'grpc';
-				grpcConfigs: GrpcConfigs;
-				resubTimeoutMs?: number;
-				logResubMessages?: boolean;
-		  }
-		| {
-				type: 'websocket';
-				resubTimeoutMs?: number;
-				logResubMessages?: boolean;
-				commitment?: Commitment;
-		  };
-
-	// True to skip the initial load of userAccounts via getProgramAccounts
-	skipInitialLoad?: boolean;
-
-	// True to include idle users when loading. Defaults to false to decrease # of accounts subscribed to.
-	includeIdle?: boolean;
-
-	// Whether to skip loading available perp/spot positions and open orders
-	fastDecode?: boolean;
-
-	// If true, will not do a full sync whenever StateAccount.numberOfSubAccounts changes.
-	// default behavior is to do a full sync on changes.
-	disableSyncOnTotalAccountsChange?: boolean;
-
-	syncConfig?: SyncConfig;
-
-	// Whether to throw an error if the userMap fails to sync. Defaults to true.
-	throwOnFailedSync?: boolean;
-
-	// Whether to filter users by poolId. Defaults to false (all users).
-	filterByPoolId?: number;
-
-	additionalFilters?: MemcmpFilter[];
-};
-
-export type UserMapConfig = UserMapConfigBase & {
-	velocityClient: VelocityClient;
-};

package/src/userMap/userStatsMap.ts

@@ -1,371 +0,0 @@
-import { VelocityClient } from '../velocityClient';
-import { getUserStatsAccountPublicKey } from '../addresses/pda';
-import {
-	OrderRecord,
-	UserStatsAccount,
-	DepositRecord,
-	FundingPaymentRecord,
-	LiquidationRecord,
-	OrderActionRecord,
-	SettlePnlRecord,
-	NewUserRecord,
-	InsuranceFundStakeRecord,
-} from '../types';
-import { UserStats } from '../userStats';
-import { WrappedEvent } from '../events/types';
-import { BulkAccountLoader } from '../accounts/bulkAccountLoader';
-import { PollingUserStatsAccountSubscriber } from '../accounts/pollingUserStatsAccountSubscriber';
-import { SyncConfig } from './userMapConfig';
-import { getUserStatsFilter } from '../memcmp';
-import { PublicKey } from '@solana/web3.js';
-
-import { UserMap } from './userMap';
-
-export class UserStatsMap {
-	/**
-	 * map from authority pubkey to UserStats
-	 */
-	private userStatsMap = new Map<string, UserStats>();
-	private velocityClient: VelocityClient;
-	private bulkAccountLoader: BulkAccountLoader;
-	private decode;
-	private syncConfig: SyncConfig;
-
-	private syncPromise?: Promise<void>;
-	private syncPromiseResolver: () => void = () => {};
-
-	/**
-	 * Creates a new UserStatsMap instance.
-	 *
-	 * @param {VelocityClient} velocityClient - The VelocityClient instance.
-	 * @param {BulkAccountLoader} [bulkAccountLoader] - If not provided, a new BulkAccountLoader with polling disabled will be created.
-	 */
-	constructor(
-		velocityClient: VelocityClient,
-		bulkAccountLoader?: BulkAccountLoader,
-		syncConfig?: SyncConfig
-	) {
-		this.velocityClient = velocityClient;
-		if (!bulkAccountLoader) {
-			bulkAccountLoader = new BulkAccountLoader(
-				velocityClient.connection,
-				velocityClient.opts?.commitment ?? 'confirmed',
-				0
-			);
-		}
-		this.bulkAccountLoader = bulkAccountLoader;
-
-		this.syncConfig = syncConfig ?? {
-			type: 'default',
-		};
-
-		this.decode = (
-			this.velocityClient.program.account as any
-		).userStats.coder.accounts.decodeUnchecked.bind(
-			(this.velocityClient.program.account as any).userStats.coder.accounts
-		);
-	}
-
-	public async subscribe(authorities: PublicKey[]) {
-		if (this.size() > 0) {
-			return;
-		}
-
-		await this.velocityClient.subscribe();
-		await this.sync(authorities);
-	}
-
-	/**
-	 *
-	 * @param authority that owns the UserStatsAccount
-	 * @param userStatsAccount optional UserStatsAccount to subscribe to, if undefined will be fetched later
-	 * @param skipFetch if true, will not immediately fetch the UserStatsAccount
-	 */
-	public async addUserStat(
-		authority: PublicKey,
-		userStatsAccount?: UserStatsAccount,
-		skipFetch?: boolean
-	) {
-		const userStat = new UserStats({
-			velocityClient: this.velocityClient,
-			userStatsAccountPublicKey: getUserStatsAccountPublicKey(
-				this.velocityClient.program.programId,
-				authority
-			),
-			accountSubscription: {
-				type: 'polling',
-				accountLoader: this.bulkAccountLoader,
-			},
-		});
-		if (skipFetch) {
-			await (
-				userStat.accountSubscriber as PollingUserStatsAccountSubscriber
-			).addToAccountLoader();
-		} else {
-			await userStat.subscribe(userStatsAccount);
-		}
-
-		this.userStatsMap.set(authority.toString(), userStat);
-	}
-
-	public async updateWithOrderRecord(record: OrderRecord, userMap: UserMap) {
-		const user = await userMap.mustGet(record.user.toString());
-		if (!this.has(user.getUserAccountOrThrow().authority.toString())) {
-			await this.addUserStat(
-				user.getUserAccountOrThrow().authority,
-				undefined,
-				false
-			);
-		}
-	}
-
-	public async updateWithEventRecord(
-		record: WrappedEvent<any>,
-		userMap?: UserMap
-	) {
-		if (record.eventType === 'DepositRecord') {
-			const depositRecord = record as DepositRecord;
-			await this.mustGet(depositRecord.userAuthority.toString());
-		} else if (record.eventType === 'FundingPaymentRecord') {
-			const fundingPaymentRecord = record as FundingPaymentRecord;
-			await this.mustGet(fundingPaymentRecord.userAuthority.toString());
-		} else if (record.eventType === 'LiquidationRecord') {
-			if (!userMap) {
-				return;
-			}
-
-			const liqRecord = record as LiquidationRecord;
-
-			const user = await userMap.mustGet(liqRecord.user.toString());
-			await this.mustGet(user.getUserAccountOrThrow().authority.toString());
-
-			const liquidatorUser = await userMap.mustGet(
-				liqRecord.liquidator.toString()
-			);
-			await this.mustGet(
-				liquidatorUser.getUserAccountOrThrow().authority.toString()
-			);
-		} else if (record.eventType === 'OrderRecord') {
-			if (!userMap) {
-				return;
-			}
-			const orderRecord = record as OrderRecord;
-			await userMap.updateWithOrderRecord(orderRecord);
-		} else if (record.eventType === 'OrderActionRecord') {
-			if (!userMap) {
-				return;
-			}
-			const actionRecord = record as OrderActionRecord;
-
-			if (actionRecord.taker) {
-				const taker = await userMap.mustGet(actionRecord.taker.toString());
-				await this.mustGet(taker.getUserAccountOrThrow().authority.toString());
-			}
-			if (actionRecord.maker) {
-				const maker = await userMap.mustGet(actionRecord.maker.toString());
-				await this.mustGet(maker.getUserAccountOrThrow().authority.toString());
-			}
-		} else if (record.eventType === 'SettlePnlRecord') {
-			if (!userMap) {
-				return;
-			}
-			const settlePnlRecord = record as SettlePnlRecord;
-			const user = await userMap.mustGet(settlePnlRecord.user.toString());
-			await this.mustGet(user.getUserAccountOrThrow().authority.toString());
-		} else if (record.eventType === 'NewUserRecord') {
-			const newUserRecord = record as NewUserRecord;
-			await this.mustGet(newUserRecord.userAuthority.toString());
-		} else if (record.eventType === 'InsuranceFundStakeRecord') {
-			const ifStakeRecord = record as InsuranceFundStakeRecord;
-			await this.mustGet(ifStakeRecord.userAuthority.toString());
-		}
-	}
-
-	public has(authorityPublicKey: string): boolean {
-		return this.userStatsMap.has(authorityPublicKey);
-	}
-
-	public get(authorityPublicKey: string): UserStats | undefined {
-		return this.userStatsMap.get(authorityPublicKey);
-	}
-
-	/**
-	 * Enforce that a UserStats will exist for the given authorityPublicKey,
-	 * reading one from the blockchain if necessary.
-	 * @param authorityPublicKey
-	 * @returns
-	 */
-	public async mustGet(authorityPublicKey: string): Promise<UserStats> {
-		if (!this.has(authorityPublicKey)) {
-			await this.addUserStat(
-				new PublicKey(authorityPublicKey),
-				undefined,
-				false
-			);
-		}
-		const userStats = this.get(authorityPublicKey);
-		if (!userStats) {
-			throw new Error(
-				`UserStatsMap: UserStats missing for authority ${authorityPublicKey} after addUserStat`
-			);
-		}
-		return userStats;
-	}
-
-	public values(): IterableIterator<UserStats> {
-		return this.userStatsMap.values();
-	}
-
-	public size(): number {
-		return this.userStatsMap.size;
-	}
-
-	/**
-	 * Sync the UserStatsMap
-	 * @param authorities list of authorities to derive UserStatsAccount public keys from.
-	 * You may want to get this list from UserMap in order to filter out idle users
-	 */
-	public async sync(authorities: PublicKey[]) {
-		if (this.syncConfig.type === 'default') {
-			return this.defaultSync(authorities);
-		} else {
-			return this.paginatedSync(authorities);
-		}
-	}
-
-	/**
-	 * Sync the UserStatsMap using the default sync method, which loads individual users into the bulkAccountLoader and
-	 * loads them. (bulkAccountLoader uses batch getMultipleAccounts)
-	 * @param authorities
-	 */
-	private async defaultSync(authorities: PublicKey[]) {
-		await Promise.all(
-			authorities.map((authority) =>
-				this.addUserStat(authority, undefined, true)
-			)
-		);
-		await this.bulkAccountLoader.load();
-	}
-
-	/**
-	 * Sync the UserStatsMap using the paginated sync method, which uses multiple getMultipleAccounts calls (without RPC batching), and limits concurrency.
-	 * @param authorities
-	 */
-	private async paginatedSync(authorities: PublicKey[]) {
-		if (this.syncPromise) {
-			return this.syncPromise;
-		}
-
-		this.syncPromise = new Promise<void>((resolve) => {
-			this.syncPromiseResolver = resolve;
-		});
-
-		try {
-			let accountsToLoad = authorities;
-			if (authorities.length === 0) {
-				const accountsPrefetch =
-					await this.velocityClient.connection.getProgramAccounts(
-						this.velocityClient.program.programId,
-						{
-							dataSlice: { offset: 0, length: 0 },
-							filters: [getUserStatsFilter()],
-						}
-					);
-				accountsToLoad = accountsPrefetch.map((account) => account.pubkey);
-			}
-
-			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]);
-					results.push(executor);
-
-					if (executing.length < limit) {
-						executing.push(executor);
-						executor.finally(() => {
-							const index = executing.indexOf(executor);
-							if (index > -1) {
-								executing.splice(index, 1);
-							}
-						});
-					} else {
-						await Promise.race(executing);
-					}
-				}
-
-				return Promise.all(results);
-			};
-
-			const programAccountBufferMap = new Set<string>();
-
-			// @ts-ignore
-			const chunkSize = this.syncConfig.chunkSize ?? 100;
-			const tasks: Array<() => Promise<void>> = [];
-			for (let i = 0; i < accountsToLoad.length; i += chunkSize) {
-				const chunk = accountsToLoad.slice(i, i + chunkSize);
-				tasks.push(async () => {
-					const accountInfos =
-						await this.velocityClient.connection.getMultipleAccountsInfoAndContext(
-							chunk,
-							{
-								commitment: this.velocityClient.opts?.commitment,
-							}
-						);
-
-					for (let j = 0; j < accountInfos.value.length; j += 1) {
-						const accountInfo = accountInfos.value[j];
-						if (accountInfo === null) continue;
-
-						const publicKeyString = chunk[j].toString();
-						if (!this.has(publicKeyString)) {
-							const buffer = Buffer.from(accountInfo.data);
-							const decodedUserStats = this.decode(
-								'userStats',
-								buffer
-							) as UserStatsAccount;
-							programAccountBufferMap.add(
-								decodedUserStats.authority.toBase58()
-							);
-							this.addUserStat(
-								decodedUserStats.authority,
-								decodedUserStats,
-								false
-							);
-						}
-					}
-				});
-			}
-
-			// @ts-ignore
-			const concurrencyLimit = this.syncConfig.concurrencyLimit ?? 10;
-			await limitConcurrency(tasks, concurrencyLimit);
-
-			for (const [key] of this.userStatsMap.entries()) {
-				if (!programAccountBufferMap.has(key)) {
-					const user = this.get(key);
-					if (user) {
-						await user.unsubscribe();
-						this.userStatsMap.delete(key);
-					}
-				}
-			}
-		} catch (err) {
-			console.error(`Error in UserStatsMap.paginatedSync():`, err);
-		} finally {
-			this.syncPromiseResolver();
-			this.syncPromise = undefined;
-		}
-	}
-
-	public async unsubscribe() {
-		for (const [key, userStats] of this.userStatsMap.entries()) {
-			await userStats.unsubscribe();
-			this.userStatsMap.delete(key);
-		}
-	}
-}

package/src/userName.ts

@@ -1,21 +0,0 @@
-export const MAX_NAME_LENGTH = 32;
-
-export const DEFAULT_USER_NAME = 'Main Account';
-export const DEFAULT_MARKET_NAME = 'Default Market Name';
-
-export function encodeName(name: string): number[] {
-	if (name.length > MAX_NAME_LENGTH) {
-		throw Error(`Name (${name}) longer than 32 characters`);
-	}
-
-	const buffer = Buffer.alloc(32);
-	buffer.fill(name);
-	buffer.fill(' ', name.length);
-
-	return Array(...buffer);
-}
-
-export function decodeName(bytes: number[]): string {
-	const buffer = Buffer.from(bytes);
-	return buffer.toString('utf8').trim();
-}

package/src/userStats.ts

@@ -1,132 +0,0 @@
-/**
- * UserStats — abstraction over the on-chain `UserStats` account.
- * Tracks referral links, 30-day maker/taker volume, and IF staking stats.
- * One `UserStats` account exists per authority (shared across all subaccounts).
- */
-import { VelocityClient } from './velocityClient';
-import { PublicKey } from '@solana/web3.js';
-import { DataAndSlot, UserStatsAccountSubscriber } from './accounts/types';
-import { UserStatsConfig } from './userStatsConfig';
-import { PollingUserStatsAccountSubscriber } from './accounts/pollingUserStatsAccountSubscriber';
-import { WebSocketUserStatsAccountSubscriber } from './accounts/webSocketUserStatsAccountSubsriber';
-import { ReferrerInfo, UserStatsAccount } from './types';
-import {
-	getUserAccountPublicKeySync,
-	getUserStatsAccountPublicKey,
-} from './addresses/pda';
-import { grpcUserStatsAccountSubscriber } from './accounts/grpcUserStatsAccountSubscriber';
-
-export class UserStats {
-	velocityClient: VelocityClient;
-	userStatsAccountPublicKey: PublicKey;
-	accountSubscriber: UserStatsAccountSubscriber;
-	isSubscribed = false;
-
-	public constructor(config: UserStatsConfig) {
-		// Type-system guarantees at least one of the two is supplied.
-		const velocityClient = config.velocityClient!;
-		this.velocityClient = velocityClient;
-		this.userStatsAccountPublicKey = config.userStatsAccountPublicKey;
-		if (config.accountSubscription?.type === 'polling') {
-			this.accountSubscriber = new PollingUserStatsAccountSubscriber(
-				velocityClient.program,
-				config.userStatsAccountPublicKey,
-				config.accountSubscription.accountLoader
-			);
-		} else if (config.accountSubscription?.type === 'grpc') {
-			this.accountSubscriber = new grpcUserStatsAccountSubscriber(
-				config.accountSubscription.grpcConfigs,
-				velocityClient.program,
-				config.userStatsAccountPublicKey,
-				{
-					resubTimeoutMs: config.accountSubscription?.resubTimeoutMs,
-					logResubMessages: config.accountSubscription?.logResubMessages,
-				}
-			);
-		} else if (config.accountSubscription?.type === 'websocket') {
-			this.accountSubscriber = new WebSocketUserStatsAccountSubscriber(
-				velocityClient.program,
-				config.userStatsAccountPublicKey,
-				{
-					resubTimeoutMs: config.accountSubscription?.resubTimeoutMs,
-					logResubMessages: config.accountSubscription?.logResubMessages,
-				},
-				config.accountSubscription.commitment
-			);
-		} else if (config.accountSubscription?.type === 'custom') {
-			this.accountSubscriber =
-				config.accountSubscription.userStatsAccountSubscriber;
-		} else {
-			const exhaustiveCheck: undefined = config.accountSubscription;
-
-			throw new Error(
-				`Unknown user stats account subscription type: ${exhaustiveCheck}`
-			);
-		}
-	}
-
-	public async subscribe(
-		userStatsAccount?: UserStatsAccount
-	): Promise<boolean> {
-		this.isSubscribed = await this.accountSubscriber.subscribe(
-			userStatsAccount
-		);
-		return this.isSubscribed;
-	}
-
-	public async fetchAccounts(): Promise<void> {
-		await this.accountSubscriber.fetch();
-	}
-
-	public async unsubscribe(): Promise<void> {
-		await this.accountSubscriber.unsubscribe();
-		this.isSubscribed = false;
-	}
-
-	public getAccountAndSlot(): DataAndSlot<UserStatsAccount> | undefined {
-		return this.accountSubscriber.getUserStatsAccountAndSlot();
-	}
-
-	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 {
-		const account = this.getAccount();
-		if (!account || account.referrer.equals(PublicKey.default)) {
-			return undefined;
-		} else {
-			return {
-				referrer: getUserAccountPublicKeySync(
-					this.velocityClient.program.programId,
-					account.referrer,
-					0
-				),
-				referrerStats: getUserStatsAccountPublicKey(
-					this.velocityClient.program.programId,
-					account.referrer
-				),
-			};
-		}
-	}
-
-	public static getOldestActionTs(account: UserStatsAccount): number {
-		return Math.min(
-			account.lastFillerVolume30DTs.toNumber(),
-			account.lastMakerVolume30DTs.toNumber(),
-			account.lastTakerVolume30DTs.toNumber()
-		);
-	}
-}

package/src/userStatsConfig.ts

@@ -1,35 +0,0 @@
-import { VelocityClient } from './velocityClient';
-import { Commitment, PublicKey } from '@solana/web3.js';
-import { BulkAccountLoader } from './accounts/bulkAccountLoader';
-import { GrpcConfigs, UserStatsAccountSubscriber } from './accounts/types';
-
-type UserStatsConfigBase = {
-	accountSubscription?: UserStatsSubscriptionConfig;
-	userStatsAccountPublicKey: PublicKey;
-};
-
-export type UserStatsConfig = UserStatsConfigBase & {
-	velocityClient: VelocityClient;
-};
-
-export type UserStatsSubscriptionConfig =
-	| {
-			type: 'websocket';
-			resubTimeoutMs?: number;
-			logResubMessages?: boolean;
-			commitment?: Commitment;
-	  }
-	| {
-			type: 'polling';
-			accountLoader: BulkAccountLoader;
-	  }
-	| {
-			type: 'custom';
-			userStatsAccountSubscriber: UserStatsAccountSubscriber;
-	  }
-	| {
-			type: 'grpc';
-			resubTimeoutMs?: number;
-			logResubMessages?: boolean;
-			grpcConfigs: GrpcConfigs;
-	  };