@velocity-exchange/sdk 0.0.2 → 0.0.5

package/src/config.ts

@@ -27,6 +27,9 @@ export type VelocityEnv = 'devnet' | 'mainnet-beta';
 /** @deprecated Use `VelocityEnv` instead. `DriftEnv` will be removed in a future major. */
 export type DriftEnv = VelocityEnv;
 
+/** Widened env type accepted by `initialize()`; `'master'` is a legacy alias for `'devnet'`. */
+export type LegacyVelocityEnv = VelocityEnv | 'master';
+
 export interface VelocityConfig {
 	ENV: VelocityEnv;
 	PYTH_ORACLE_MAPPING_ADDRESS: string;
@@ -50,7 +53,8 @@ export interface VelocityConfig {
 /** @deprecated Use `VelocityConfig` instead. `DriftConfig` will be removed in a future major. */
 export type DriftConfig = VelocityConfig;
 
-export const VELOCITY_PROGRAM_ID = 'dRiftyHA39MWEi3m9aunc5MzRF1JYuBsbn6VPcn33UH';
+export const VELOCITY_PROGRAM_ID =
+	'dRiftyHA39MWEi3m9aunc5MzRF1JYuBsbn6VPcn33UH';
 
 /** @deprecated Use `VELOCITY_PROGRAM_ID` instead. `DRIFT_PROGRAM_ID` will be removed in a future major. */
 export const DRIFT_PROGRAM_ID = VELOCITY_PROGRAM_ID;
@@ -140,35 +144,40 @@ export const getConfig = (): VelocityConfig => currentConfig;
  * @param props
  * @returns
  */
+/**
+ * Mirror a canonical/deprecated alias pair so the resolved config carries the
+ * same value under both keys regardless of which one the caller overrode.
+ */
+const mirrorAlias = <
+	K1 extends keyof VelocityConfig,
+	K2 extends keyof VelocityConfig,
+>(
+	merged: VelocityConfig,
+	override: Partial<VelocityConfig>,
+	canon: K1,
+	deprecated: K2
+): void => {
+	const value = override[canon] ?? override[deprecated] ?? merged[canon];
+	(merged[canon] as VelocityConfig[K1]) = value as VelocityConfig[K1];
+	(merged[deprecated] as VelocityConfig[K2]) = value as VelocityConfig[K2];
+};
+
 export const initialize = (props: {
-	env: VelocityEnv;
+	env: LegacyVelocityEnv;
 	overrideEnv?: Partial<VelocityConfig>;
 }): VelocityConfig => {
 	const override = props.overrideEnv ?? {};
-
-	//@ts-ignore
-	const base = props.env === 'master' ? configs['devnet'] : configs[props.env];
-	const merged: VelocityConfig = { ...base, ...override };
-
-	const overrodeVelocity = 'VELOCITY_PROGRAM_ID' in override;
-	const overrodeDrift = 'DRIFT_PROGRAM_ID' in override;
-	if (overrodeVelocity && !overrodeDrift) {
-		merged.DRIFT_PROGRAM_ID = merged.VELOCITY_PROGRAM_ID;
-	} else if (overrodeDrift && !overrodeVelocity) {
-		merged.VELOCITY_PROGRAM_ID = merged.DRIFT_PROGRAM_ID;
-	}
-
-	const overrodeVelocityOracleReceiver =
-		'VELOCITY_ORACLE_RECEIVER_ID' in override;
-	const overrodeDriftOracleReceiver = 'DRIFT_ORACLE_RECEIVER_ID' in override;
-	if (overrodeVelocityOracleReceiver && !overrodeDriftOracleReceiver) {
-		merged.DRIFT_ORACLE_RECEIVER_ID = merged.VELOCITY_ORACLE_RECEIVER_ID;
-	} else if (overrodeDriftOracleReceiver && !overrodeVelocityOracleReceiver) {
-		merged.VELOCITY_ORACLE_RECEIVER_ID = merged.DRIFT_ORACLE_RECEIVER_ID;
-	}
-
-	//@ts-ignore
-	if (props.env === 'master') return merged;
+	const normalizedEnv: VelocityEnv =
+		props.env === 'master' ? 'devnet' : props.env;
+	const merged: VelocityConfig = { ...configs[normalizedEnv], ...override };
+
+	mirrorAlias(merged, override, 'VELOCITY_PROGRAM_ID', 'DRIFT_PROGRAM_ID');
+	mirrorAlias(
+		merged,
+		override,
+		'VELOCITY_ORACLE_RECEIVER_ID',
+		'DRIFT_ORACLE_RECEIVER_ID'
+	);
 
 	currentConfig = merged;
 	return currentConfig;
@@ -215,7 +224,9 @@ export function getMarketsAndOraclesForSubscription(
 	};
 }
 
-export async function findAllMarketAndOracles(program: VelocityProgram): Promise<{
+export async function findAllMarketAndOracles(
+	program: VelocityProgram
+): Promise<{
 	perpMarketIndexes: number[];
 	perpMarketAccounts: PerpMarketAccount[];
 	spotMarketIndexes: number[];

package/src/constituentMap/constituentMap.ts

@@ -17,7 +17,9 @@ import { getLpPoolPublicKey } from '../addresses/pda';
 const MAX_CONSTITUENT_SIZE_BYTES = 480; // TODO: update this when account is finalized
 
 export type ConstituentMapConfig = {
-	driftClient: VelocityClient;
+	velocityClient?: VelocityClient;
+	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
+	driftClient?: VelocityClient;
 	connection?: Connection;
 	subscriptionConfig:
 		| {
@@ -55,7 +57,7 @@ export interface ConstituentMapInterface {
 }
 
 export class ConstituentMap implements ConstituentMapInterface {
-	private driftClient: VelocityClient;
+	private velocityClient: VelocityClient;
 	private constituentMap = new Map<string, DataAndSlot<ConstituentAccount>>();
 	private constituentAccountSubscriber: ConstituentAccountSubscriber;
 	private additionalFilters?: MemcmpFilter[];
@@ -69,10 +71,16 @@ export class ConstituentMap implements ConstituentMapInterface {
 	private decoder: 'base64' | 'base64+zstd';
 
 	constructor(config: ConstituentMapConfig) {
-		this.driftClient = config.driftClient;
+		const velocityClient = config.velocityClient ?? config.driftClient;
+		if (!velocityClient) {
+			throw new Error(
+				'ConstituentMap: velocityClient (or deprecated driftClient) must be provided'
+			);
+		}
+		this.velocityClient = velocityClient;
 		this.additionalFilters = config.additionalFilters;
 		this.commitment = config.subscriptionConfig.commitment;
-		this.connection = config.connection || this.driftClient.connection;
+		this.connection = config.connection || this.velocityClient.connection;
 		this.lpPoolId = config.lpPoolId ?? 0;
 		this.decoder = config.decoder ?? 'base64+zstd';
 
@@ -80,7 +88,7 @@ export class ConstituentMap implements ConstituentMapInterface {
 			this.constituentAccountSubscriber =
 				new PollingConstituentAccountSubscriber(
 					this,
-					this.driftClient.program,
+					this.velocityClient.program,
 					config.subscriptionConfig.frequency,
 					config.subscriptionConfig.commitment,
 					this.getFilters()
@@ -89,7 +97,7 @@ export class ConstituentMap implements ConstituentMapInterface {
 			this.constituentAccountSubscriber =
 				new WebSocketConstituentAccountSubscriber(
 					this,
-					this.driftClient.program,
+					this.velocityClient.program,
 					config.subscriptionConfig.resubTimeoutMs,
 					config.subscriptionConfig.commitment,
 					this.getFilters()
@@ -109,7 +117,7 @@ export class ConstituentMap implements ConstituentMapInterface {
 		const filters = [
 			getConstituentFilter(),
 			getConstituentLpPoolFilter(
-				getLpPoolPublicKey(this.driftClient.program.programId, this.lpPoolId)
+				getLpPoolPublicKey(this.velocityClient.program.programId, this.lpPoolId)
 			),
 		];
 		if (this.additionalFilters) {
@@ -120,14 +128,14 @@ export class ConstituentMap implements ConstituentMapInterface {
 
 	private decode(name: string, buffer: Buffer): ConstituentAccount {
 		return (
-			this.driftClient.program.account as any
+			this.velocityClient.program.account as any
 		).constituent.coder.accounts.decodeUnchecked(name, buffer);
 	}
 
 	public async sync(): Promise<void> {
 		try {
 			const rpcRequestArgs = [
-				this.driftClient.program.programId.toBase58(),
+				this.velocityClient.program.programId.toBase58(),
 				{
 					commitment: this.commitment,
 					filters: this.getFilters(),

package/src/core/VelocityCore.ts

@@ -329,3 +329,9 @@ export class VelocityCore {
 		return [];
 	}
 }
+
+/** @deprecated Use `VelocityCore` instead. `DriftCore` will be removed in a future major. */
+export const DriftCore = VelocityCore;
+
+/** @deprecated Use `VelocityCore` instead. `DriftCore` will be removed in a future major. */
+export type DriftCore = VelocityCore;

package/src/decode/user.ts

@@ -143,8 +143,8 @@ export function decodeUser(buffer: Buffer): UserAccount {
 	const orders: Order[] = [];
 	for (let i = 0; i < 32; i++) {
 		// skip order if it's not open
-		if (buffer.readUint8(offset + 82) !== 1) {
-			offset += 96;
+		if (buffer.readUint8(offset + 86) !== 1) {
+			offset += 104;
 			continue;
 		}
 
@@ -166,8 +166,8 @@ export function decodeUser(buffer: Buffer): UserAccount {
 		offset += 8;
 		const maxTs = readSignedBigInt64LE(buffer, offset);
 		offset += 8;
-		const oraclePriceOffset = buffer.readInt32LE(offset);
-		offset += 4;
+		const oraclePriceOffset = readSignedBigInt64LE(buffer, offset);
+		offset += 8;
 		const orderId = buffer.readUInt32LE(offset);
 		offset += 4;
 		const marketIndex = buffer.readUInt16LE(offset);
@@ -245,7 +245,7 @@ export function decodeUser(buffer: Buffer): UserAccount {
 		offset += 1;
 		const bitFlags = buffer.readUint8(offset);
 		offset += 1;
-		offset += 1; // padding
+		offset += 5; // padding
 		orders.push({
 			slot,
 			price,

package/src/dlob/DLOB.ts

@@ -333,7 +333,7 @@ export class DLOB {
 			isOneOfVariant(order.orderType, ['market', 'triggerMarket', 'oracle'])
 		) {
 			type = 'market';
-		} else if (order.oraclePriceOffset !== 0) {
+		} else if (!order.oraclePriceOffset.eq(ZERO)) {
 			type = 'floatingLimit';
 		} else {
 			const isResting = isRestingLimitOrder(order, slot);

package/src/dlob/DLOBNode.ts

@@ -115,7 +115,7 @@ export class FloatingLimitOrderNode extends OrderNode {
 	previous?: FloatingLimitOrderNode;
 
 	getSortValue(order: Order): BN {
-		return new BN(order.oraclePriceOffset);
+		return order.oraclePriceOffset;
 	}
 }
 

package/src/dlob/DLOBSubscriber.ts

@@ -20,7 +20,11 @@ import {
 import { BN } from '../isomorphic/anchor';
 
 export class DLOBSubscriber {
-	driftClient: VelocityClient;
+	velocityClient: VelocityClient;
+	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
+	public get driftClient(): VelocityClient {
+		return this.velocityClient;
+	}
 	dlobSource: DLOBSource;
 	slotSource: SlotSource;
 	updateFrequency: number;
@@ -28,7 +32,13 @@ export class DLOBSubscriber {
 	dlob: DLOB;
 	public eventEmitter: StrictEventEmitter<EventEmitter, DLOBSubscriberEvents>;
 	constructor(config: DLOBSubscriptionConfig) {
-		this.driftClient = config.driftClient;
+		const velocityClient = config.velocityClient ?? config.driftClient;
+		if (!velocityClient) {
+			throw new Error(
+				'DLOBSubscriber: velocityClient (or deprecated driftClient) must be provided'
+			);
+		}
+		this.velocityClient = velocityClient;
 		this.dlobSource = config.dlobSource;
 		this.slotSource = config.slotSource;
 		this.updateFrequency = config.updateFrequency;
@@ -93,7 +103,7 @@ export class DLOBSubscriber {
 	}): L2OrderBook {
 		if (marketName) {
 			const derivedMarketInfo =
-				this.driftClient.getMarketIndexAndType(marketName);
+				this.velocityClient.getMarketIndexAndType(marketName);
 			if (!derivedMarketInfo) {
 				throw new Error(`Market ${marketName} not found`);
 			}
@@ -111,13 +121,13 @@ export class DLOBSubscriber {
 		const isPerp = isVariant(marketType, 'perp');
 		if (isPerp) {
 			const perpMarketAccount =
-				this.driftClient.getPerpMarketAccount(marketIndex);
-			oraclePriceData = this.driftClient.getOracleDataForPerpMarket(
+				this.velocityClient.getPerpMarketAccount(marketIndex);
+			oraclePriceData = this.velocityClient.getOracleDataForPerpMarket(
 				perpMarketAccount.marketIndex
 			);
 		} else {
 			oraclePriceData =
-				this.driftClient.getOracleDataForSpotMarket(marketIndex);
+				this.velocityClient.getOracleDataForSpotMarket(marketIndex);
 		}
 
 		if (isPerp && includeVamm) {
@@ -129,9 +139,9 @@ export class DLOBSubscriber {
 
 			fallbackL2Generators = [
 				getVammL2Generator({
-					marketAccount: this.driftClient.getPerpMarketAccount(marketIndex),
+					marketAccount: this.velocityClient.getPerpMarketAccount(marketIndex),
 					mmOraclePriceData:
-						this.driftClient.getMMOracleDataForPerpMarket(marketIndex),
+						this.velocityClient.getMMOracleDataForPerpMarket(marketIndex),
 					numOrders: numVammOrders ?? depth,
 					topOfBookQuoteAmounts:
 						marketIndex < 3
@@ -170,7 +180,7 @@ export class DLOBSubscriber {
 	}): L3OrderBook {
 		if (marketName) {
 			const derivedMarketInfo =
-				this.driftClient.getMarketIndexAndType(marketName);
+				this.velocityClient.getMarketIndexAndType(marketName);
 			if (!derivedMarketInfo) {
 				throw new Error(`Market ${marketName} not found`);
 			}
@@ -188,10 +198,10 @@ export class DLOBSubscriber {
 		const isPerp = isVariant(marketType, 'perp');
 		if (isPerp) {
 			oraclePriceData =
-				this.driftClient.getOracleDataForPerpMarket(marketIndex);
+				this.velocityClient.getOracleDataForPerpMarket(marketIndex);
 		} else {
 			oraclePriceData =
-				this.driftClient.getOracleDataForSpotMarket(marketIndex);
+				this.velocityClient.getOracleDataForSpotMarket(marketIndex);
 		}
 
 		return this.dlob.getL3({

package/src/dlob/types.ts

@@ -2,7 +2,9 @@ import { DLOB } from './DLOB';
 import { VelocityClient } from '../velocityClient';
 
 export type DLOBSubscriptionConfig = {
-	driftClient: VelocityClient;
+	velocityClient?: VelocityClient;
+	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
+	driftClient?: VelocityClient;
 	dlobSource: DLOBSource;
 	slotSource: SlotSource;
 	updateFrequency: number;