@velocity-exchange/sdk 0.4.0 → 0.6.0

package/src/assert/assert.ts

@@ -1,5 +0,0 @@
-export function assert(condition: boolean, error?: string): void {
-	if (!condition) {
-		throw new Error(error || 'Unspecified AssertionError');
-	}
-}

package/src/auctionSubscriber/auctionSubscriber.ts

@@ -1,86 +0,0 @@
-import { AuctionSubscriberConfig, AuctionSubscriberEvents } from './types';
-import { VelocityClient } from '../velocityClient';
-import { getUserFilter, getUserWithAuctionFilter } from '../memcmp';
-import StrictEventEmitter from 'strict-event-emitter-types';
-import { EventEmitter } from 'events';
-import { UserAccount } from '../types';
-import { ConfirmOptions, Context, PublicKey } from '@solana/web3.js';
-import { WebSocketProgramAccountSubscriber } from '../accounts/webSocketProgramAccountSubscriber';
-import { ResubOpts } from '../accounts/types';
-
-/**
- * AuctionSubscriber — websocket program-account subscription scoped to
- * `User` accounts that currently have at least one order in its auction
- * window (`getUserWithAuctionFilter`). Used by keepers/fillers to react to
- * auction-eligible orders (JIT-fillable or approaching the end of a Dutch
- * auction) without scanning every user account.
- */
-export class AuctionSubscriber {
-	private velocityClient: VelocityClient;
-	private opts: ConfirmOptions;
-	private resubOpts?: ResubOpts;
-
-	eventEmitter: StrictEventEmitter<EventEmitter, AuctionSubscriberEvents>;
-	private subscriber?: WebSocketProgramAccountSubscriber<UserAccount>;
-
-	/**
-	 * @param velocityClient Client whose `program`/`connection` back the subscription; also supplies default `opts` if `opts` is omitted.
-	 * @param opts Confirm options (commitment) for the subscription; defaults to `velocityClient.opts`.
-	 * @param resubTimeoutMs Max time with no update before resubscribing.
-	 * @param logResubMessages Whether to log resubscribe attempts.
-	 */
-	constructor({
-		velocityClient,
-		opts,
-		resubTimeoutMs,
-		logResubMessages,
-	}: AuctionSubscriberConfig) {
-		// Type-system guarantees at least one of the two is supplied.
-		this.velocityClient = velocityClient!;
-		this.opts = opts || this.velocityClient.opts || {};
-		this.eventEmitter = new EventEmitter();
-		this.resubOpts = { resubTimeoutMs, logResubMessages };
-	}
-
-	/** Establishes the filtered program-account subscription (idempotent — reuses the existing subscriber if already created) and emits `onAccountUpdate` for each matching account update. */
-	public async subscribe() {
-		let subscriber = this.subscriber;
-		if (!subscriber) {
-			subscriber = new WebSocketProgramAccountSubscriber<UserAccount>(
-				'AuctionSubscriber',
-				'user',
-				this.velocityClient.program,
-				(
-					this.velocityClient.program.account as any
-				).user.coder.accounts.decode.bind(
-					(this.velocityClient.program.account as any).user.coder.accounts
-				),
-				{
-					filters: [getUserFilter(), getUserWithAuctionFilter()],
-					commitment: this.opts.commitment,
-				},
-				this.resubOpts
-			);
-			this.subscriber = subscriber;
-		}
-
-		await subscriber.subscribe(
-			(accountId: PublicKey, data: UserAccount, context: Context) => {
-				this.eventEmitter.emit(
-					'onAccountUpdate',
-					data,
-					accountId,
-					context.slot
-				);
-			}
-		);
-	}
-
-	/** Tears down the subscription. No-op if never subscribed. */
-	public async unsubscribe() {
-		if (!this.subscriber) {
-			return;
-		}
-		this.subscriber.unsubscribe();
-	}
-}

package/src/auctionSubscriber/auctionSubscriberGrpc.ts

@@ -1,99 +0,0 @@
-import { AuctionSubscriberConfig, AuctionSubscriberEvents } from './types';
-import { VelocityClient } from '../velocityClient';
-import { getUserFilter, getUserWithAuctionFilter } from '../memcmp';
-import StrictEventEmitter from 'strict-event-emitter-types';
-import { EventEmitter } from 'events';
-import { UserAccount } from '../types';
-import { ConfirmOptions, Context, PublicKey } from '@solana/web3.js';
-import { WebSocketProgramAccountSubscriber } from '../accounts/webSocketProgramAccountSubscriber';
-import { GrpcConfigs, ResubOpts } from '../accounts/types';
-import { grpcProgramAccountSubscriber } from '../accounts/grpcProgramAccountSubscriber';
-
-/**
- * Same as `AuctionSubscriber` (auction-eligible `User` accounts via
- * `getUserWithAuctionFilter`) but sourced from a gRPC/Geyser stream
- * (`grpcProgramAccountSubscriber`) instead of a websocket program-account
- * subscription. Requires `grpcConfigs`.
- */
-export class AuctionSubscriberGrpc {
-	private velocityClient: VelocityClient;
-	private opts: ConfirmOptions;
-	private resubOpts?: ResubOpts;
-	private grpcConfigs?: GrpcConfigs;
-
-	eventEmitter: StrictEventEmitter<EventEmitter, AuctionSubscriberEvents>;
-	private subscriber?: WebSocketProgramAccountSubscriber<UserAccount>;
-
-	/**
-	 * @param velocityClient Client whose `program` backs the subscription; also supplies default `opts` if `opts` is omitted.
-	 * @param opts Confirm options (commitment) for the subscription; defaults to `velocityClient.opts`.
-	 * @param grpcConfigs gRPC/Geyser endpoint config; required to call `subscribe()`.
-	 * @param resubTimeoutMs Max time with no update before resubscribing.
-	 * @param logResubMessages Whether to log resubscribe attempts.
-	 */
-	constructor({
-		velocityClient,
-		opts,
-		grpcConfigs,
-		resubTimeoutMs,
-		logResubMessages,
-	}: AuctionSubscriberConfig) {
-		// Type-system guarantees at least one of the two is supplied.
-		this.velocityClient = velocityClient!;
-		this.opts = opts || this.velocityClient.opts || {};
-		this.eventEmitter = new EventEmitter();
-		this.resubOpts = { resubTimeoutMs, logResubMessages };
-		this.grpcConfigs = grpcConfigs;
-	}
-
-	/**
-	 * Establishes the filtered gRPC subscription (idempotent) and emits
-	 * `onAccountUpdate` for each matching account update.
-	 * @throws If `grpcConfigs` was not provided at construction.
-	 */
-	public async subscribe() {
-		let subscriber = this.subscriber;
-		if (!subscriber) {
-			if (!this.grpcConfigs) {
-				throw new Error(
-					'grpcConfigs must be provided to use AuctionSubscriberGrpc'
-				);
-			}
-			subscriber = await grpcProgramAccountSubscriber.create<UserAccount>(
-				this.grpcConfigs,
-				'AuctionSubscriber',
-				'user',
-				this.velocityClient.program,
-				(
-					this.velocityClient.program.account as any
-				).user.coder.accounts.decode.bind(
-					(this.velocityClient.program.account as any).user.coder.accounts
-				),
-				{
-					filters: [getUserFilter(), getUserWithAuctionFilter()],
-				},
-				this.resubOpts
-			);
-			this.subscriber = subscriber;
-		}
-
-		await subscriber.subscribe(
-			(accountId: PublicKey, data: UserAccount, context: Context) => {
-				this.eventEmitter.emit(
-					'onAccountUpdate',
-					data,
-					accountId,
-					context.slot
-				);
-			}
-		);
-	}
-
-	/** Tears down the subscription. No-op if never subscribed. */
-	public async unsubscribe() {
-		if (!this.subscriber) {
-			return;
-		}
-		this.subscriber.unsubscribe();
-	}
-}

package/src/auctionSubscriber/index.ts

@@ -1,9 +0,0 @@
-/**
- * Auction-eligible order tracking — filtered `User`-account subscriptions
- * (`AuctionSubscriber` over websocket, `AuctionSubscriberGrpc` over gRPC/Geyser)
- * scoped to accounts with at least one order currently in its auction window,
- * for keepers/fillers reacting to JIT-fillable or expiring-auction orders.
- */
-export * from './types';
-export * from './auctionSubscriber';
-export * from './auctionSubscriberGrpc';

package/src/auctionSubscriber/types.ts

@@ -1,30 +0,0 @@
-import { GrpcConfigs } from '../accounts/types';
-import { VelocityClient } from '../velocityClient';
-import { UserAccount } from '../types';
-import { ConfirmOptions, PublicKey } from '@solana/web3.js';
-
-type AuctionSubscriberConfigBase = {
-	/** Confirm options (notably `commitment`) for the underlying program-account subscription; defaults to `velocityClient.opts`. */
-	opts?: ConfirmOptions;
-	/** Max time with no update before the subscription resubscribes. */
-	resubTimeoutMs?: number;
-	/** Whether to log resubscribe attempts. */
-	logResubMessages?: boolean;
-	/** gRPC/Geyser endpoint config; only consumed by `AuctionSubscriberGrpc`, ignored by `AuctionSubscriber`. */
-	grpcConfigs?: GrpcConfigs;
-};
-
-/** Configuration for `AuctionSubscriber`/`AuctionSubscriberGrpc`. */
-export type AuctionSubscriberConfig = AuctionSubscriberConfigBase & {
-	velocityClient: VelocityClient;
-};
-
-/** Events emitted on `AuctionSubscriber`/`AuctionSubscriberGrpc`'s `eventEmitter`. */
-export interface AuctionSubscriberEvents {
-	/** Fired whenever a `User` account with at least one order currently in its auction window is created or updated. */
-	onAccountUpdate: (
-		account: UserAccount,
-		pubkey: PublicKey,
-		slot: number
-	) => void;
-}