@velocity-exchange/sdk 0.3.0 → 0.6.0

package/src/events/types.ts

@@ -1,217 +0,0 @@
-import { Commitment, PublicKey, TransactionSignature } from '@solana/web3.js';
-import {
-	DepositRecord,
-	FundingPaymentRecord,
-	FundingRateRecord,
-	LiquidationRecord,
-	NewUserRecord,
-	OrderActionRecord,
-	OrderRecord,
-	SettlePnlRecord,
-	InsuranceFundRecord,
-	SpotInterestRecord,
-	InsuranceFundStakeRecord,
-	AmmCurveChanged,
-	SwapRecord,
-	SpotMarketVaultDepositRecord,
-	SignedMsgOrderRecord,
-	DeleteUserRecord,
-	LPMintRedeemRecord,
-	LPSettleRecord,
-	LPSwapRecord,
-	LPBorrowLendDepositRecord,
-} from '../types';
-import { EventEmitter } from 'events';
-
-export type EventSubscriptionOptions = {
-	address?: PublicKey;
-	eventTypes?: EventType[];
-	maxEventsPerType?: number;
-	orderBy?: EventSubscriptionOrderBy;
-	orderDir?: EventSubscriptionOrderDirection;
-	commitment?: Commitment;
-	maxTx?: number;
-	logProviderConfig?: LogProviderConfig;
-	// when the subscription starts, client might want to backtrack and fetch old tx's
-	// this specifies how far to backtrack
-	untilTx?: TransactionSignature;
-};
-
-export const DefaultEventSubscriptionOptions: EventSubscriptionOptions = {
-	eventTypes: [
-		'DepositRecord',
-		'FundingPaymentRecord',
-		'LiquidationRecord',
-		'OrderRecord',
-		'OrderActionRecord',
-		'FundingRateRecord',
-		'NewUserRecord',
-		'SettlePnlRecord',
-		'InsuranceFundRecord',
-		'SpotInterestRecord',
-		'InsuranceFundStakeRecord',
-		'AmmCurveChanged',
-		'SwapRecord',
-		'SpotMarketVaultDepositRecord',
-		'SignedMsgOrderRecord',
-		'DeleteUserRecord',
-		'LPMintRedeemRecord',
-		'LPSettleRecord',
-		'LPSwapRecord',
-	],
-	maxEventsPerType: 4096,
-	orderBy: 'blockchain',
-	orderDir: 'asc',
-	commitment: 'confirmed',
-	maxTx: 4096,
-	logProviderConfig: {
-		type: 'websocket',
-	},
-};
-
-// Whether we sort events based on order blockchain produced events or client receives events
-export type EventSubscriptionOrderBy = 'blockchain' | 'client';
-export type EventSubscriptionOrderDirection = 'asc' | 'desc';
-
-export type Event<T> = T & {
-	txSig: TransactionSignature;
-	slot: number;
-	txSigIndex: number; // Unique index for each event inside a tx
-};
-
-export type WrappedEvent<Type extends EventType> = EventMap[Type] & {
-	eventType: Type;
-};
-
-export type WrappedEvents = WrappedEvent<EventType>[];
-
-export type EventMap = {
-	DepositRecord: Event<DepositRecord>;
-	FundingPaymentRecord: Event<FundingPaymentRecord>;
-	LiquidationRecord: Event<LiquidationRecord>;
-	FundingRateRecord: Event<FundingRateRecord>;
-	OrderRecord: Event<OrderRecord>;
-	OrderActionRecord: Event<OrderActionRecord>;
-	SettlePnlRecord: Event<SettlePnlRecord>;
-	NewUserRecord: Event<NewUserRecord>;
-	InsuranceFundRecord: Event<InsuranceFundRecord>;
-	SpotInterestRecord: Event<SpotInterestRecord>;
-	InsuranceFundStakeRecord: Event<InsuranceFundStakeRecord>;
-	AmmCurveChanged: Event<AmmCurveChanged>;
-	SwapRecord: Event<SwapRecord>;
-	SpotMarketVaultDepositRecord: Event<SpotMarketVaultDepositRecord>;
-	SignedMsgOrderRecord: Event<SignedMsgOrderRecord>;
-	DeleteUserRecord: Event<DeleteUserRecord>;
-	LPSettleRecord: Event<LPSettleRecord>;
-	LPMintRedeemRecord: Event<LPMintRedeemRecord>;
-	LPSwapRecord: Event<LPSwapRecord>;
-};
-
-export type EventType = keyof EventMap;
-
-export type VelocityEvent =
-	| Event<DepositRecord>
-	| Event<FundingPaymentRecord>
-	| Event<LiquidationRecord>
-	| Event<FundingRateRecord>
-	| Event<OrderRecord>
-	| Event<OrderActionRecord>
-	| Event<SettlePnlRecord>
-	| Event<NewUserRecord>
-	| Event<InsuranceFundRecord>
-	| Event<SpotInterestRecord>
-	| Event<InsuranceFundStakeRecord>
-	| Event<AmmCurveChanged>
-	| Event<SwapRecord>
-	| Event<SpotMarketVaultDepositRecord>
-	| Event<SignedMsgOrderRecord>
-	| Event<DeleteUserRecord>
-	| Event<LPSettleRecord>
-	| Event<LPMintRedeemRecord>
-	| Event<LPSwapRecord>
-	| Event<LPBorrowLendDepositRecord>
-	| Event<CuUsage>;
-
-export interface EventSubscriberEvents {
-	newEvent: (event: WrappedEvent<EventType>) => void;
-}
-
-export type SortFn = (
-	currentRecord: EventMap[EventType],
-	newRecord: EventMap[EventType]
-) => 'less than' | 'greater than';
-
-export type logProviderCallback = (
-	txSig: TransactionSignature,
-	slot: number,
-	logs: string[],
-	mostRecentBlockTime: number | undefined,
-	txSigIndex: number | undefined
-) => void;
-
-export interface LogProvider {
-	isSubscribed(): boolean;
-	subscribe(
-		callback: logProviderCallback,
-		skipHistory?: boolean
-	): Promise<boolean>;
-	unsubscribe(external?: boolean): Promise<boolean>;
-	eventEmitter?: EventEmitter;
-}
-
-export type LogProviderType = 'websocket' | 'polling' | 'events-server';
-
-export type StreamingLogProviderConfig = {
-	/// Max number of times to try reconnecting before failing over to fallback provider
-	maxReconnectAttempts?: number;
-	/// used for PollingLogProviderConfig on fallback
-	fallbackFrequency?: number;
-	/// used for PollingLogProviderConfig on fallback
-	fallbackBatchSize?: number;
-};
-
-export type WebSocketLogProviderConfig = StreamingLogProviderConfig & {
-	type: 'websocket';
-	/// Max time to wait before resubscribing
-	resubTimeoutMs?: number;
-};
-
-export type PollingLogProviderConfig = {
-	type: 'polling';
-	/// frequency to poll for new events
-	frequency: number;
-	/// max number of events to fetch per poll
-	batchSize?: number;
-};
-
-export type EventsServerLogProviderConfig = StreamingLogProviderConfig & {
-	type: 'events-server';
-	/// url of the events server
-	url: string;
-};
-
-export type LogProviderConfig =
-	| WebSocketLogProviderConfig
-	| PollingLogProviderConfig
-	| EventsServerLogProviderConfig;
-
-export type CuUsageEvent = {
-	name: 'CuUsage';
-	fields: [
-		{
-			name: 'instruction';
-			type: 'string';
-			index: false;
-		},
-		{
-			name: 'cuUsage';
-			type: 'u32';
-			index: false;
-		},
-	];
-};
-
-export type CuUsage = {
-	instruction: string;
-	cuUsage: number;
-};

package/src/events/webSocketLogProvider.ts

@@ -1,123 +0,0 @@
-import { LogProvider, logProviderCallback } from './types';
-import {
-	Commitment,
-	Connection,
-	Context,
-	Logs,
-	PublicKey,
-} from '@solana/web3.js';
-import { EventEmitter } from 'events';
-
-export class WebSocketLogProvider implements LogProvider {
-	private subscriptionId?: number;
-	private isUnsubscribing = false;
-	private externalUnsubscribe = false;
-	private receivingData = false;
-	private timeoutId?: ReturnType<typeof setTimeout>;
-	private reconnectAttempts = 0;
-	eventEmitter?: EventEmitter;
-	private callback?: logProviderCallback;
-	public constructor(
-		private connection: Connection,
-		private address: PublicKey,
-		private commitment: Commitment,
-		private resubTimeoutMs?: number
-	) {
-		if (this.resubTimeoutMs) {
-			this.eventEmitter = new EventEmitter();
-		}
-	}
-
-	public async subscribe(callback: logProviderCallback): Promise<boolean> {
-		if (this.subscriptionId != null) {
-			return true;
-		}
-
-		this.callback = callback;
-		try {
-			this.setSubscription(callback);
-		} catch (error) {
-			// Sometimes ws connection isn't ready, give it a few secs
-			setTimeout(() => this.setSubscription(callback), 2000);
-		}
-
-		if (this.resubTimeoutMs) {
-			this.setTimeout();
-		}
-
-		return true;
-	}
-
-	public setSubscription(callback: logProviderCallback): void {
-		this.subscriptionId = this.connection.onLogs(
-			this.address,
-			(logs: Logs, ctx: Context) => {
-				if (this.resubTimeoutMs && !this.isUnsubscribing) {
-					this.receivingData = true;
-					clearTimeout(this.timeoutId);
-					this.setTimeout();
-					if (this.reconnectAttempts > 0) {
-						console.log('Resetting reconnect attempts to 0');
-					}
-					this.reconnectAttempts = 0;
-				}
-				if (logs.err !== null) {
-					return;
-				}
-				callback(logs.signature, ctx.slot, logs.logs, undefined, undefined);
-			},
-			this.commitment
-		);
-	}
-
-	public isSubscribed(): boolean {
-		return this.subscriptionId != null;
-	}
-
-	public async unsubscribe(external = false): Promise<boolean> {
-		this.isUnsubscribing = true;
-		this.externalUnsubscribe = external;
-		clearTimeout(this.timeoutId);
-		this.timeoutId = undefined;
-
-		if (this.subscriptionId != null) {
-			try {
-				await this.connection.removeOnLogsListener(this.subscriptionId);
-				this.subscriptionId = undefined;
-				this.isUnsubscribing = false;
-				return true;
-			} catch (err) {
-				console.log('Error unsubscribing from logs: ', err);
-				this.isUnsubscribing = false;
-				return false;
-			}
-		} else {
-			this.isUnsubscribing = false;
-			return true;
-		}
-	}
-
-	private setTimeout(): void {
-		this.timeoutId = setTimeout(async () => {
-			if (this.isUnsubscribing || this.externalUnsubscribe) {
-				// If we are in the process of unsubscribing, do not attempt to resubscribe
-				return;
-			}
-
-			if (this.receivingData) {
-				console.log(
-					`webSocketLogProvider: No log data in ${
-						this.resubTimeoutMs
-					}ms, resubscribing on attempt ${this.reconnectAttempts + 1}`
-				);
-				await this.unsubscribe();
-				this.receivingData = false;
-				this.reconnectAttempts++;
-				this.eventEmitter?.emit('reconnect', this.reconnectAttempts);
-				if (this.callback) {
-					this.subscribe(this.callback);
-				}
-			}
-		}, this.resubTimeoutMs);
-	}
-}