@velocity-exchange/sdk 0.3.0 → 0.6.0

package/src/accounts/testBulkAccountLoader.ts

@@ -1,51 +0,0 @@
-import { AccountToLoad, BulkAccountLoader } from './bulkAccountLoader';
-
-export class TestBulkAccountLoader extends BulkAccountLoader {
-	async loadChunk(accountsToLoadChunks: AccountToLoad[][]): Promise<void> {
-		if (accountsToLoadChunks.length === 0) {
-			return;
-		}
-
-		for (const accountsToLoadChunk of accountsToLoadChunks) {
-			for (const accountToLoad of accountsToLoadChunk) {
-				const account = await this.connection.getAccountInfoAndContext(
-					accountToLoad.publicKey,
-					this.commitment
-				);
-				const newSlot = account.context.slot;
-				if (newSlot > this.mostRecentSlot) {
-					this.mostRecentSlot = newSlot;
-				}
-
-				if (accountToLoad.callbacks.size === 0) {
-					continue;
-				}
-
-				const key = accountToLoad.publicKey.toBase58();
-				const prev = this.bufferAndSlotMap.get(key);
-
-				if (prev && newSlot < prev.slot) {
-					continue;
-				}
-
-				let newBuffer: Buffer | undefined = undefined;
-
-				if (account.value) {
-					newBuffer = account.value.data;
-				}
-
-				if (!prev) {
-					this.bufferAndSlotMap.set(key, { slot: newSlot, buffer: newBuffer });
-					this.handleAccountCallbacks(accountToLoad, newBuffer, newSlot);
-					continue;
-				}
-
-				const oldBuffer = prev.buffer;
-				if (newBuffer && (!oldBuffer || !newBuffer.equals(oldBuffer))) {
-					this.bufferAndSlotMap.set(key, { slot: newSlot, buffer: newBuffer });
-					this.handleAccountCallbacks(accountToLoad, newBuffer, newSlot);
-				}
-			}
-		}
-	}
-}

package/src/accounts/types.ts

@@ -1,279 +0,0 @@
-/**
- * Account subscription interfaces and types.
- *
- * VelocityClient uses a `VelocityClientAccountSubscriber` (WebSocket or polling) to keep
- * market, oracle, and state accounts cached in memory. `User` uses a `UserAccountSubscriber`
- * for the individual User account. All subscribers implement the interfaces defined here.
- *
- * Implementations: `webSocketVelocityClientAccountSubscriber.ts` (default),
- * `pollingVelocityClientAccountSubscriber.ts`, `bulkAccountLoader.ts` (batched RPC).
- */
-import {
-	SpotMarketAccount,
-	PerpMarketAccount,
-	OracleSource,
-	StateAccount,
-	UserAccount,
-	UserStatsAccount,
-	InsuranceFundStake,
-	ConstituentAccount,
-} from '../types';
-import StrictEventEmitter from 'strict-event-emitter-types';
-import { EventEmitter } from 'events';
-import { Context, PublicKey } from '@solana/web3.js';
-import { Account } from '@solana/spl-token';
-import { OracleInfo, OraclePriceData } from '../oracles/types';
-import { User } from '../user';
-import { Client, CommitmentLevel, LaserstreamConfig } from '../isomorphic/grpc';
-
-export interface AccountSubscriber<T> {
-	dataAndSlot?: DataAndSlot<T>;
-	subscribe(onChange: (data: T) => void): Promise<void>;
-	fetch(): Promise<void>;
-	unsubscribe(): Promise<void>;
-
-	setData(userAccount: T, slot?: number): void;
-}
-
-export interface ProgramAccountSubscriber<T> {
-	subscribe(
-		onChange: (
-			accountId: PublicKey,
-			data: T,
-			context: Context,
-			buffer: Buffer
-		) => void
-	): Promise<void>;
-	unsubscribe(): Promise<void>;
-}
-
-export class NotSubscribedError extends Error {
-	name = 'NotSubscribedError';
-}
-
-export interface VelocityClientAccountEvents {
-	stateAccountUpdate: (payload: StateAccount) => void;
-	perpMarketAccountUpdate: (payload: PerpMarketAccount) => void;
-	spotMarketAccountUpdate: (payload: SpotMarketAccount) => void;
-	oraclePriceUpdate: (
-		publicKey: PublicKey,
-		oracleSource: OracleSource,
-		data: OraclePriceData
-	) => void;
-	userAccountUpdate: (payload: UserAccount) => void;
-	update: void;
-	error: (e: Error) => void;
-}
-
-export interface VelocityClientAccountSubscriber {
-	eventEmitter: StrictEventEmitter<EventEmitter, VelocityClientAccountEvents>;
-	isSubscribed: boolean;
-
-	subscribe(): Promise<boolean>;
-	fetch(): Promise<void>;
-	unsubscribe(): Promise<void>;
-
-	addPerpMarket(marketIndex: number): Promise<boolean>;
-	addSpotMarket(marketIndex: number): Promise<boolean>;
-	addOracle(oracleInfo: OracleInfo): Promise<boolean>;
-	setPerpOracleMap(): Promise<void>;
-	setSpotOracleMap(): Promise<void>;
-
-	getStateAccountAndSlot(): DataAndSlot<StateAccount>;
-	getMarketAccountAndSlot(
-		marketIndex: number
-	): DataAndSlot<PerpMarketAccount> | undefined;
-	getMarketAccountsAndSlots(): DataAndSlot<PerpMarketAccount>[];
-	getSpotMarketAccountAndSlot(
-		marketIndex: number
-	): DataAndSlot<SpotMarketAccount> | undefined;
-	getSpotMarketAccountsAndSlots(): DataAndSlot<SpotMarketAccount>[];
-	getOraclePriceDataAndSlot(
-		oracleId: string
-	): DataAndSlot<OraclePriceData> | undefined;
-	getOraclePriceDataAndSlotForPerpMarket(
-		marketIndex: number
-	): DataAndSlot<OraclePriceData> | undefined;
-	getOraclePriceDataAndSlotForSpotMarket(
-		marketIndex: number
-	): DataAndSlot<OraclePriceData> | undefined;
-
-	updateAccountLoaderPollingFrequency?: (pollingFrequency: number) => void;
-}
-
-export enum DelistedMarketSetting {
-	Unsubscribe,
-	Subscribe,
-	Discard,
-}
-
-export interface UserAccountEvents {
-	userAccountUpdate: (payload: UserAccount) => void;
-	update: void;
-	error: (e: Error) => void;
-}
-
-export interface UserEvents {
-	userUpdate: (payload: User) => void;
-	update: void;
-	error: (e: Error) => void;
-}
-
-export interface UserAccountSubscriber {
-	eventEmitter: StrictEventEmitter<EventEmitter, UserAccountEvents>;
-	isSubscribed: boolean;
-
-	subscribe(userAccount?: UserAccount): Promise<boolean>;
-	fetch(): Promise<void>;
-	updateData(userAccount: UserAccount, slot: number): void;
-	unsubscribe(): Promise<void>;
-
-	getUserAccountAndSlot(): DataAndSlot<UserAccount> | undefined;
-}
-
-export interface TokenAccountEvents {
-	tokenAccountUpdate: (payload: Account) => void;
-	update: void;
-	error: (e: Error) => void;
-}
-
-export interface TokenAccountSubscriber {
-	eventEmitter: StrictEventEmitter<EventEmitter, TokenAccountEvents>;
-	isSubscribed: boolean;
-
-	subscribe(): Promise<boolean>;
-	fetch(): Promise<void>;
-	unsubscribe(): Promise<void>;
-
-	getTokenAccountAndSlot(): DataAndSlot<Account>;
-}
-
-export interface InsuranceFundStakeAccountSubscriber {
-	eventEmitter: StrictEventEmitter<
-		EventEmitter,
-		InsuranceFundStakeAccountEvents
-	>;
-	isSubscribed: boolean;
-
-	subscribe(): Promise<boolean>;
-	fetch(): Promise<void>;
-	unsubscribe(): Promise<void>;
-
-	getInsuranceFundStakeAccountAndSlot():
-		| DataAndSlot<InsuranceFundStake>
-		| undefined;
-}
-
-export interface InsuranceFundStakeAccountEvents {
-	insuranceFundStakeAccountUpdate: (payload: InsuranceFundStake) => void;
-	update: void;
-	error: (e: Error) => void;
-}
-
-export interface OracleEvents {
-	oracleUpdate: (payload: OraclePriceData) => void;
-	update: void;
-	error: (e: Error) => void;
-}
-
-export interface OracleAccountSubscriber {
-	eventEmitter: StrictEventEmitter<EventEmitter, OracleEvents>;
-	isSubscribed: boolean;
-
-	subscribe(): Promise<boolean>;
-	fetch(): Promise<void>;
-	unsubscribe(): Promise<void>;
-
-	getOraclePriceData(): DataAndSlot<OraclePriceData>;
-}
-
-export type AccountToPoll = {
-	key: 'state' | 'perpMarket' | 'spotMarket';
-	publicKey: PublicKey;
-	eventType: string;
-	callbackId?: string;
-	mapKey?: number;
-};
-
-export type OraclesToPoll = {
-	publicKey: PublicKey;
-	source: OracleSource;
-	callbackId?: string;
-};
-
-export type BufferAndSlot = {
-	slot: number;
-	buffer: Buffer | undefined;
-};
-
-export type DataAndSlot<T> = {
-	data: T;
-	slot: number;
-};
-
-export type ResubOpts = {
-	resubTimeoutMs?: number;
-	logResubMessages?: boolean;
-	// New options for polling-based resubscription
-	usePollingInsteadOfResub?: boolean;
-	pollingIntervalMs?: number;
-};
-
-export interface UserStatsAccountEvents {
-	userStatsAccountUpdate: (payload: UserStatsAccount) => void;
-	update: void;
-	error: (e: Error) => void;
-}
-
-export interface UserStatsAccountSubscriber {
-	eventEmitter: StrictEventEmitter<EventEmitter, UserStatsAccountEvents>;
-	isSubscribed: boolean;
-
-	subscribe(userStatsAccount?: UserStatsAccount): Promise<boolean>;
-	fetch(): Promise<void>;
-	unsubscribe(): Promise<void>;
-
-	getUserStatsAccountAndSlot(): DataAndSlot<UserStatsAccount> | undefined;
-}
-
-type BaseGrpcConfigs = {
-	endpoint: string;
-	token: string;
-	commitmentLevel?: CommitmentLevel;
-	/**
-	 * Whether to enable automatic reconnection on connection loss .
-	 * Defaults to false, will throw on connection loss.
-	 */
-	enableReconnect?: boolean;
-};
-
-export type YellowstoneGrpcConfigs = BaseGrpcConfigs & {
-	client?: 'yellowstone';
-	channelOptions?: ConstructorParameters<typeof Client>[2];
-};
-
-export type LaserGrpcConfigs = BaseGrpcConfigs & {
-	client: 'laser';
-	channelOptions?: LaserstreamConfig['channelOptions'];
-};
-
-export type GrpcConfigs = YellowstoneGrpcConfigs | LaserGrpcConfigs;
-
-export interface ConstituentAccountSubscriber {
-	eventEmitter: StrictEventEmitter<EventEmitter, ConstituentAccountEvents>;
-	isSubscribed: boolean;
-
-	subscribe(constituentAccount?: ConstituentAccount): Promise<boolean>;
-	sync(): Promise<void>;
-	unsubscribe(): Promise<void>;
-}
-
-export interface ConstituentAccountEvents {
-	onAccountUpdate: (
-		account: ConstituentAccount,
-		pubkey: PublicKey,
-		slot: number
-	) => void;
-	update: void;
-	error: (e: Error) => void;
-}

package/src/accounts/utils.ts

@@ -1,72 +0,0 @@
-import { DataAndSlot } from './types';
-import { isVariant, PerpMarketAccount, SpotMarketAccount } from '../types';
-import { OracleInfo } from '../oracles/types';
-import { getOracleId } from '../oracles/oracleId';
-
-export function capitalize(value: string): string {
-	return value[0].toUpperCase() + value.slice(1);
-}
-
-export function assertDataAndSlot<T>(
-	dataAndSlot: DataAndSlot<T> | undefined,
-	message: string
-): DataAndSlot<T> {
-	if (!dataAndSlot) {
-		throw new Error(message);
-	}
-	return dataAndSlot;
-}
-
-export function findDelistedPerpMarketsAndOracles(
-	perpMarkets: DataAndSlot<PerpMarketAccount>[],
-	spotMarkets: DataAndSlot<SpotMarketAccount>[]
-): { perpMarketIndexes: number[]; oracles: OracleInfo[] } {
-	const delistedPerpMarketIndexes = [];
-	const delistedOracles: OracleInfo[] = [];
-	for (const perpMarket of perpMarkets) {
-		if (!perpMarket || !perpMarket.data) {
-			continue;
-		}
-
-		if (isVariant(perpMarket.data.status, 'delisted')) {
-			delistedPerpMarketIndexes.push(perpMarket.data.marketIndex);
-			delistedOracles.push({
-				publicKey: perpMarket.data.oracle,
-				source: perpMarket.data.oracleSource,
-			});
-		}
-	}
-
-	// make sure oracle isn't used by spot market
-	const filteredDelistedOracles = [];
-	for (const delistedOracle of delistedOracles) {
-		let isUsedBySpotMarket = false;
-		for (const spotMarket of spotMarkets) {
-			if (!spotMarket || !spotMarket.data) {
-				continue;
-			}
-
-			const delistedOracleId = getOracleId(
-				delistedOracle.publicKey,
-				delistedOracle.source
-			);
-			const spotMarketOracleId = getOracleId(
-				spotMarket.data.oracle,
-				spotMarket.data.oracleSource
-			);
-			if (spotMarketOracleId === delistedOracleId) {
-				isUsedBySpotMarket = true;
-				break;
-			}
-		}
-
-		if (!isUsedBySpotMarket) {
-			filteredDelistedOracles.push(delistedOracle);
-		}
-	}
-
-	return {
-		perpMarketIndexes: delistedPerpMarketIndexes,
-		oracles: filteredDelistedOracles,
-	};
-}

package/src/accounts/webSocketAccountSubscriber.ts

@@ -1,263 +0,0 @@
-import {
-	DataAndSlot,
-	BufferAndSlot,
-	AccountSubscriber,
-	ResubOpts,
-} from './types';
-import { AnchorProvider } from '../isomorphic/anchor';
-import { AccountInfo, Commitment, Context, PublicKey } from '@solana/web3.js';
-import { VelocityProgram } from '../config';
-import * as Buffer from 'buffer';
-
-export class WebSocketAccountSubscriber<T> implements AccountSubscriber<T> {
-	dataAndSlot?: DataAndSlot<T>;
-	bufferAndSlot?: BufferAndSlot;
-	accountName: string;
-	logAccountName: string;
-	program: VelocityProgram;
-	accountPublicKey: PublicKey;
-	decodeBufferFn?: (buffer: Buffer) => T;
-	private _onChange?: (data: T) => void;
-	get onChange(): (data: T) => void {
-		if (!this._onChange) {
-			throw new Error('onChange callback function must be set');
-		}
-		return this._onChange;
-	}
-	set onChange(onChange: (data: T) => void) {
-		this._onChange = onChange;
-	}
-	listenerId?: number;
-
-	resubOpts?: ResubOpts;
-
-	commitment?: Commitment;
-	isUnsubscribing = false;
-
-	timeoutId?: ReturnType<typeof setTimeout>;
-
-	receivingData: boolean;
-
-	public constructor(
-		accountName: string,
-		program: VelocityProgram,
-		accountPublicKey: PublicKey,
-		decodeBuffer?: (buffer: Buffer) => T,
-		resubOpts?: ResubOpts,
-		commitment?: Commitment
-	) {
-		this.accountName = accountName;
-		this.logAccountName = `${accountName}-${accountPublicKey.toBase58()}`;
-		this.program = program;
-		this.accountPublicKey = accountPublicKey;
-		this.decodeBufferFn = decodeBuffer;
-		this.resubOpts = resubOpts;
-		if (
-			this.resubOpts?.resubTimeoutMs != null &&
-			this.resubOpts.resubTimeoutMs < 1000
-		) {
-			console.log(
-				`resubTimeoutMs should be at least 1000ms to avoid spamming resub ${this.logAccountName}`
-			);
-		}
-		this.receivingData = false;
-		this.commitment =
-			commitment ?? (this.program.provider as AnchorProvider).opts.commitment;
-	}
-
-	async subscribe(onChange: (data: T) => void): Promise<void> {
-		if (this.listenerId != null || this.isUnsubscribing) {
-			if (this.resubOpts?.logResubMessages) {
-				console.log(
-					`[${this.logAccountName}] Subscribe returning early - listenerId=${this.listenerId}, isUnsubscribing=${this.isUnsubscribing}`
-				);
-			}
-			return;
-		}
-
-		this.onChange = onChange;
-		if (!this.dataAndSlot) {
-			await this.fetch();
-		}
-
-		this.listenerId = this.program.provider.connection.onAccountChange(
-			this.accountPublicKey,
-			(accountInfo, context) => {
-				if (this.resubOpts?.resubTimeoutMs) {
-					this.receivingData = true;
-					clearTimeout(this.timeoutId);
-					this.handleRpcResponse(context, accountInfo);
-					this.setTimeout();
-				} else {
-					this.handleRpcResponse(context, accountInfo);
-				}
-			},
-			this.commitment
-		);
-
-		if (this.resubOpts?.resubTimeoutMs) {
-			this.receivingData = true;
-			this.setTimeout();
-		}
-	}
-
-	setData(data: T, slot?: number): void {
-		const newSlot = slot || 0;
-		if (this.dataAndSlot && this.dataAndSlot.slot > newSlot) {
-			return;
-		}
-
-		this.dataAndSlot = {
-			data,
-			slot: newSlot,
-		};
-	}
-
-	protected setTimeout(): void {
-		if (!this._onChange) {
-			throw new Error('onChange callback function must be set');
-		}
-		this.timeoutId = setTimeout(
-			async () => {
-				if (this.isUnsubscribing) {
-					// If we are in the process of unsubscribing, do not attempt to resubscribe
-					if (this.resubOpts?.logResubMessages) {
-						console.log(
-							`[${this.logAccountName}] Timeout fired but isUnsubscribing=true, skipping resubscribe`
-						);
-					}
-					return;
-				}
-
-				if (this.receivingData) {
-					if (this.resubOpts?.logResubMessages) {
-						console.log(
-							`No ws data from ${this.logAccountName} in ${this.resubOpts.resubTimeoutMs}ms, resubscribing - listenerId=${this.listenerId}, isUnsubscribing=${this.isUnsubscribing}`
-						);
-					}
-					await this.unsubscribe(true);
-					this.receivingData = false;
-					await this.subscribe(this.onChange);
-					if (this.resubOpts?.logResubMessages) {
-						console.log(
-							`[${this.logAccountName}] Resubscribe completed - receivingData=${this.receivingData}, listenerId=${this.listenerId}, isUnsubscribing=${this.isUnsubscribing}`
-						);
-					}
-				} else {
-					if (this.resubOpts?.logResubMessages) {
-						console.log(
-							`[${this.logAccountName}] Timeout fired but receivingData=false, skipping resubscribe`
-						);
-					}
-				}
-			},
-			this.resubOpts?.resubTimeoutMs
-		);
-	}
-
-	async fetch(): Promise<void> {
-		const rpcResponse =
-			await this.program.provider.connection.getAccountInfoAndContext(
-				this.accountPublicKey,
-				(this.program.provider as AnchorProvider).opts.commitment
-			);
-		this.handleRpcResponse(
-			rpcResponse.context,
-			rpcResponse?.value ?? undefined
-		);
-	}
-
-	handleRpcResponse(context: Context, accountInfo?: AccountInfo<Buffer>): void {
-		const newSlot = context.slot;
-		let newBuffer: Buffer | undefined = undefined;
-		if (accountInfo) {
-			newBuffer = accountInfo.data;
-		}
-
-		if (!this.bufferAndSlot) {
-			this.bufferAndSlot = {
-				buffer: newBuffer,
-				slot: newSlot,
-			};
-			if (newBuffer) {
-				const account = this.decodeBuffer(newBuffer);
-				this.dataAndSlot = {
-					data: account,
-					slot: newSlot,
-				};
-				this.onChange(account);
-			}
-			return;
-		}
-
-		if (newSlot < this.bufferAndSlot.slot) {
-			return;
-		}
-
-		const oldBuffer = this.bufferAndSlot.buffer;
-		if (newBuffer && (!oldBuffer || !newBuffer.equals(oldBuffer))) {
-			this.bufferAndSlot = {
-				buffer: newBuffer,
-				slot: newSlot,
-			};
-			const account = this.decodeBuffer(newBuffer);
-			this.dataAndSlot = {
-				data: account,
-				slot: newSlot,
-			};
-			this.onChange(account);
-		}
-	}
-
-	decodeBuffer(buffer: Buffer): T {
-		if (this.decodeBufferFn) {
-			return this.decodeBufferFn(buffer);
-		} else {
-			return this.program.coder.accounts.decode(this.accountName, buffer);
-		}
-	}
-
-	unsubscribe(onResub = false): Promise<void> {
-		if (!onResub && this.resubOpts) {
-			this.resubOpts.resubTimeoutMs = undefined;
-		}
-		this.isUnsubscribing = true;
-		clearTimeout(this.timeoutId);
-		this.timeoutId = undefined;
-
-		if (this.listenerId != null) {
-			const promise = Promise.race([
-				this.program.provider.connection.removeAccountChangeListener(
-					this.listenerId
-				),
-				new Promise((_, reject) =>
-					setTimeout(
-						() =>
-							reject(
-								new Error(
-									`Unsubscribe timeout for account ${this.logAccountName}`
-								)
-							),
-						10000
-					)
-				),
-			])
-				.then(() => {
-					this.listenerId = undefined;
-					this.isUnsubscribing = false;
-				})
-				.catch((error) => {
-					console.error(
-						`[${this.logAccountName}] Unsubscribe failed, forcing cleanup - listenerId=${this.listenerId}, isUnsubscribing=${this.isUnsubscribing}`,
-						error
-					);
-					this.listenerId = undefined;
-					this.isUnsubscribing = false;
-				});
-			return promise;
-		} else {
-			this.isUnsubscribing = false;
-			return Promise.resolve();
-		}
-	}
-}