@velocity-exchange/sdk 0.0.3 → 0.1.0

package/src/types.ts

@@ -1,12 +1,12 @@
 /**
- * Shared TypeScript types for the Drift SDK.
+ * Shared TypeScript types for the Velocity SDK.
  *
  * Contains TypeScript mirrors of all on-chain account structs (UserAccount, PerpMarketAccount,
  * SpotMarketAccount, StateAccount, OracleData, etc.), instruction parameter types (OrderParams,
  * ModifyOrderParams), enums (MarketType, OrderType, PositionDirection, OracleSource), and
  * precision constants used throughout the SDK.
  *
- * The authoritative layout source is `sdk/src/idl/drift.json` (generated from the program).
+ * The authoritative layout source is `sdk/src/idl/velocity.json` (generated from the program).
  * Do not edit struct shapes here without a corresponding on-chain change.
  */
 import {
@@ -385,9 +385,8 @@ export type SpotInterestRecord = {
 	maxBorrowRate: number;
 };
 
-export type CurveRecord = {
+export type AmmCurveChanged = {
 	ts: BN;
-	recordId: BN;
 	marketIndex: number;
 	pegMultiplierBefore: BN;
 	baseAssetReserveBefore: BN;
@@ -397,15 +396,9 @@ export type CurveRecord = {
 	baseAssetReserveAfter: BN;
 	quoteAssetReserveAfter: BN;
 	sqrtKAfter: BN;
-	baseAssetAmountLong: BN;
-	baseAssetAmountShort: BN;
-	baseAssetAmountWithAmm: BN;
-	totalFee: BN;
-	totalFeeMinusDistributions: BN;
 	adjustmentCost: BN;
-	numberOfUsers: BN;
+	totalFeeMinusDistributionsAfter: BN;
 	oraclePrice: BN;
-	fillRecord: BN;
 };
 
 export declare type InsuranceFundRecord = {
@@ -447,7 +440,6 @@ export type FundingRateRecord = {
 	cumulativeFundingRateShort: BN;
 	oraclePriceTwap: BN;
 	markPriceTwap: BN;
-	periodRevenue: BN;
 	baseAssetAmountWithAmm: BN;
 };
 
@@ -816,13 +808,13 @@ export type PerpMarketAccount = {
 	pubkey: PublicKey;
 	name: number[];
 	amm: AMM;
+	marketStats: MarketStats;
 	numberOfUsersWithBase: number;
 	numberOfUsers: number;
 	marginRatioInitial: number;
 	marginRatioMaintenance: number;
 	nextFillRecordId: BN;
 	nextFundingRateRecordId: BN;
-	nextCurveRecordId: BN;
 	pnlPool: PoolBalance;
 	liquidatorFee: number;
 	ifLiquidationFee: number;
@@ -844,12 +836,41 @@ export type PerpMarketAccount = {
 
 	lastFillPrice: BN;
 
-	lpPoolId: number;
-	lpFeeTransferScalar: number;
-	lpExchangeFeeExcluscionScalar: number;
-	lpStatus: number;
-	lpPausedOperations: number;
+	hedgeConfig: {
+		poolId: number;
+		status: number;
+		pausedOperations: number;
+		exchangeFeeExclusionScalar: number;
+		feeTransferScalar: number;
+	};
 	marketConfig: number;
+
+	// Fields migrated off AMM to top-level PerpMarket
+	oracle: PublicKey;
+	oracleSource: OracleSource;
+	oracleSlotDelayOverride: number;
+	oracleLowRiskSlotDelayOverride: number;
+	baseAssetAmountLong: BN;
+	baseAssetAmountShort: BN;
+	quoteAssetAmount: BN;
+	quoteEntryAmountLong: BN;
+	quoteEntryAmountShort: BN;
+	quoteBreakEvenAmountLong: BN;
+	quoteBreakEvenAmountShort: BN;
+	totalSocialLoss: BN;
+	maxOpenInterest: BN;
+	totalExchangeFee: BN;
+	totalLiquidationFee: BN;
+	cumulativeFundingRateLong: BN;
+	cumulativeFundingRateShort: BN;
+	lastFundingRate: BN;
+	lastFundingRateLong: BN;
+	lastFundingRateShort: BN;
+	lastFundingRateTs: BN;
+	netUnsettledFundingPnl: BN;
+	lastFundingOracleTwap: BN;
+	orderStepSize: BN;
+	orderTickSize: BN;
 };
 
 export type HistoricalOracleData = {
@@ -960,97 +981,58 @@ export type PoolBalance = {
 };
 
 export type AMM = {
+	feePool: PoolBalance;
 	baseAssetReserve: BN;
-	sqrtK: BN;
-	cumulativeFundingRate: BN;
-	lastFundingRate: BN;
-	lastFundingRateTs: BN;
-	lastMarkPriceTwap: BN;
-	lastMarkPriceTwap5Min: BN;
-	lastMarkPriceTwapTs: BN;
-	lastTradeTs: BN;
-
-	oracle: PublicKey;
-	oracleSource: OracleSource;
-	historicalOracleData: HistoricalOracleData;
-
-	lastOracleReservePriceSpreadPct: BN;
-	lastOracleConfPct: BN;
-
-	fundingPeriod: BN;
 	quoteAssetReserve: BN;
+	concentrationCoef: BN;
+	minBaseAssetReserve: BN;
+	maxBaseAssetReserve: BN;
+	sqrtK: BN;
 	pegMultiplier: BN;
-	cumulativeFundingRateLong: BN;
-	cumulativeFundingRateShort: BN;
-	last24HAvgFundingRate: BN;
-	lastFundingRateShort: BN;
-	lastFundingRateLong: BN;
-
-	totalLiquidationFee: BN;
+	terminalQuoteAssetReserve: BN;
+	baseAssetAmountWithAmm: BN;
+	totalFee: BN;
+	totalMmFee: BN;
 	totalFeeMinusDistributions: BN;
 	totalFeeWithdrawn: BN;
-	totalFee: BN;
-	mmOracleSequenceId: BN;
-	orderStepSize: BN;
-	orderTickSize: BN;
+	lastUpdateSlot: BN;
+	netRevenueSinceLastFunding: BN;
+	lastCumulativeFundingRateLong: BN;
+	lastCumulativeFundingRateShort: BN;
+	baseSpread: number;
+	maxSpread: number;
 	maxFillReserveFraction: number;
 	maxSlippageRatio: number;
-	baseSpread: number;
 	curveUpdateIntensity: number;
-	baseAssetAmountWithAmm: BN;
-	baseAssetAmountLong: BN;
-	baseAssetAmountShort: BN;
-	quoteAssetAmount: BN;
-	terminalQuoteAssetReserve: BN;
-	concentrationCoef: BN;
-	feePool: PoolBalance;
-	totalExchangeFee: BN;
-	totalMmFee: BN;
-	netRevenueSinceLastFunding: BN;
-	lastUpdateSlot: BN;
-	lastOracleNormalisedPrice: BN;
-	lastOracleValid: boolean;
-	lastBidPriceTwap: BN;
-	lastAskPriceTwap: BN;
-	longSpread: number;
-	shortSpread: number;
-	maxSpread: number;
-
 	ammJitIntensity: number;
-	maxOpenInterest: BN;
-	maxBaseAssetReserve: BN;
-	minBaseAssetReserve: BN;
-	totalSocialLoss: BN;
-
-	quoteBreakEvenAmountLong: BN;
-	quoteBreakEvenAmountShort: BN;
-	quoteEntryAmountLong: BN;
-	quoteEntryAmountShort: BN;
+	ammSpreadAdjustment: number;
+	ammInventorySpreadAdjustment: number;
+	referencePriceOffsetDeadbandPct: number;
+};
 
+export type MarketStats = {
+	lastMarkPriceTwap: BN;
+	lastMarkPriceTwap5Min: BN;
+	lastMarkPriceTwapTs: BN;
+	lastBidPriceTwap: BN;
+	lastAskPriceTwap: BN;
 	markStd: BN;
 	oracleStd: BN;
+	lastOracleConfPct: BN;
+	volume24H: BN;
 	longIntensityVolume: BN;
 	shortIntensityVolume: BN;
-	volume24H: BN;
+	lastTradeTs: BN;
+	last24HAvgFundingRate: BN;
+	fundingPeriod: BN;
 	minOrderSize: BN;
 	mmOraclePrice: BN;
 	mmOracleSlot: BN;
-
-	bidBaseAssetReserve: BN;
-	bidQuoteAssetReserve: BN;
-	askBaseAssetReserve: BN;
-	askQuoteAssetReserve: BN;
-
-	netUnsettledFundingPnl: BN;
-	referencePriceOffset: number;
-
-	oracleLowRiskSlotDelayOverride: number;
-	oracleSlotDelayOverride: number;
-	ammSpreadAdjustment: number;
-	ammInventorySpreadAdjustment: number;
-
-	lastFundingOracleTwap: BN;
-	referencePriceOffsetDeadbandPct: number;
+	mmOracleSequenceId: BN;
+	lastOracleNormalisedPrice: BN;
+	lastReferencePriceOffset: number;
+	lastOracleValid: boolean;
+	historicalOracleData: HistoricalOracleData;
 };
 
 // # User Account Types
@@ -1086,14 +1068,13 @@ export type UserStatsAccount = {
 		totalFeeRebate: BN;
 		totalTokenDiscount: BN;
 		totalRefereeDiscount: BN;
-		totalReferrerReward: BN;
-		current_epoch_referrer_reward: BN;
 	};
 	referrer: PublicKey;
 	referrerStatus: number;
 	authority: PublicKey;
 	ifStakedQuoteAssetAmount: BN;
 	ifStakedGovTokenAmount: BN;
+	delegatePermissions: number;
 };
 
 export type UserAccount = {
@@ -1156,7 +1137,7 @@ export type Order = {
 	existingPositionDirection: PositionDirection;
 	postOnly: boolean;
 	immediateOrCancel: boolean;
-	oraclePriceOffset: number;
+	oraclePriceOffset: BN;
 	auctionDuration: number;
 	auctionStartPrice: BN;
 	auctionEndPrice: BN;
@@ -1178,11 +1159,15 @@ export type OrderParams = {
 	bitFlags: number;
 	triggerPrice: BN | null;
 	triggerCondition: OrderTriggerCondition;
-	oraclePriceOffset: number | null;
+	oraclePriceOffset: BN | null;
 	auctionDuration: number | null;
 	maxTs: BN | null;
 	auctionStartPrice: BN | null;
 	auctionEndPrice: BN | null;
+	/** index into the placing user's RevenueShareEscrow.approved_builders list (non-swift builder codes) */
+	builderIdx?: number | null;
+	/** builder fee on this order, in tenths of a bps, e.g. 100 = 0.01% */
+	builderFeeTenthBps?: number | null;
 };
 
 export class PostOnlyParams {
@@ -1276,6 +1261,8 @@ export const DefaultOrderParams: OrderParams = {
 	maxTs: null,
 	auctionStartPrice: null,
 	auctionEndPrice: null,
+	builderIdx: null,
+	builderFeeTenthBps: null,
 };
 
 export type SignedMsgOrderParamsMessage = {
@@ -1331,6 +1318,8 @@ export type ReferrerInfo = {
 export enum ReferrerStatus {
 	IsReferrer = 1,
 	IsReferred = 2,
+	/** set when the user's RevenueShareEscrow was initialized with a referrer */
+	BuilderReferral = 4,
 }
 
 export enum PlaceAndTakeOrderSuccessCondition {
@@ -1508,9 +1497,6 @@ export interface VelocityClientMetricsEvents {
 	preTxSigned: void;
 }
 
-/** @deprecated Use `VelocityClientMetricsEvents` instead. `DriftClientMetricsEvents` will be removed in a future major. */
-export interface DriftClientMetricsEvents extends VelocityClientMetricsEvents {}
-
 export type SignedTxData = {
 	txSig: string;
 	signedTx: Transaction | VersionedTransaction;
@@ -1547,7 +1533,7 @@ export type IfRebalanceConfigParams = {
 };
 
 /* Represents proof of a signed msg taker order
- * It can be provided to drift program to fill a signed msg order
+ * It can be provided to velocity program to fill a signed msg order
  */
 export interface SignedMsgOrderParams {
 	/**
@@ -1581,10 +1567,6 @@ export type RevenueShareAccount = {
 export type RevenueShareEscrowAccount = {
 	authority: PublicKey;
 	referrer: PublicKey;
-	referrerBoostExpireTs: number;
-	referrerRewardOffset: number;
-	refereeFeeNumeratorOffset: number;
-	referrerBoostNumerator: number;
 	reservedFixed: number[];
 	orders: RevenueShareOrder[];
 	approvedBuilders: BuilderInfo[];

package/src/user.ts

@@ -2,7 +2,7 @@
  * User — read-oriented abstraction over the on-chain `User` account.
  *
  * Responsibilities:
- *   - Margin and free-collateral calculations (mirrors `programs/drift/src/math/margin.rs`).
+ *   - Margin and free-collateral calculations (mirrors `programs/velocity/src/math/margin.rs`).
  *   - Position accessors: perp positions, spot positions, unrealized PnL, leverage.
  *   - Open order queries and filtering.
  *   - Health factor and liquidation threshold checks.
@@ -129,10 +129,6 @@ export type MarginType = 'Cross' | 'Isolated';
 
 export class User {
 	velocityClient: VelocityClient;
-	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
-	public get driftClient(): VelocityClient {
-		return this.velocityClient;
-	}
 	userAccountPublicKey: PublicKey;
 	accountSubscriber: UserAccountSubscriber;
 	_isSubscribed = false;
@@ -148,7 +144,7 @@ export class User {
 
 	public constructor(config: UserConfig) {
 		// Type-system guarantees at least one of the two is supplied.
-		const velocityClient = (config.velocityClient ?? config.driftClient)!;
+		const velocityClient = config.velocityClient!;
 		this.velocityClient = velocityClient;
 		this.userAccountPublicKey = config.userAccountPublicKey;
 		if (config.accountSubscription?.type === 'polling') {
@@ -2093,10 +2089,10 @@ export class User {
 				userPosition.marketIndex
 			);
 			if (
-				market.amm.cumulativeFundingRateLong.eq(
+				market.cumulativeFundingRateLong.eq(
 					userPosition.lastCumulativeFundingRate
 				) ||
-				market.amm.cumulativeFundingRateShort.eq(
+				market.cumulativeFundingRateShort.eq(
 					userPosition.lastCumulativeFundingRate
 				)
 			) {
@@ -2153,7 +2149,7 @@ export class User {
 		const oracle = market.oracle;
 		const perpMarketWithSameOracle = this.velocityClient
 			.getPerpMarketAccounts()
-			.find((market) => market.amm.oracle.equals(oracle));
+			.find((market) => market.oracle.equals(oracle));
 		const oraclePrice =
 			this.velocityClient.getOracleDataForSpotMarket(marketIndex).price;
 		if (perpMarketWithSameOracle) {
@@ -2172,7 +2168,7 @@ export class User {
 				if (freeCollateralDeltaForPerp) {
 					const { numerator, denominator } = getMultipleBetweenOracleSources(
 						market.oracleSource,
-						perpMarketWithSameOracle.amm.oracleSource
+						perpMarketWithSameOracle.oracleSource
 					);
 					freeCollateralDeltaForPerp = freeCollateralDeltaForPerp
 						.mul(numerator)
@@ -2223,8 +2219,7 @@ export class User {
 	): BN {
 		const market = this.velocityClient.getPerpMarketAccount(marketIndex);
 
-		const oracle =
-			this.velocityClient.getPerpMarketAccount(marketIndex).amm.oracle;
+		const oracle = this.velocityClient.getPerpMarketAccount(marketIndex).oracle;
 
 		const oraclePrice =
 			this.velocityClient.getOracleDataForPerpMarket(marketIndex).price;
@@ -2292,7 +2287,7 @@ export class User {
 
 		positionBaseSizeChange = standardizeBaseAssetAmount(
 			positionBaseSizeChange,
-			market.amm.orderStepSize
+			market.orderStepSize
 		);
 
 		const freeCollateralChangeFromNewPosition =
@@ -2345,7 +2340,7 @@ export class User {
 
 				if (spotFreeCollateralDelta) {
 					const { numerator, denominator } = getMultipleBetweenOracleSources(
-						market.amm.oracleSource,
+						market.oracleSource,
 						spotMarketWithSameOracle.oracleSource
 					);
 					spotFreeCollateralDelta = spotFreeCollateralDelta

package/src/userConfig.ts

@@ -5,15 +5,13 @@ import { GrpcConfigs, UserAccountSubscriber } from './accounts/types';
 import { WebSocketProgramAccountSubscriber } from './accounts/webSocketProgramAccountSubscriber';
 import { UserAccount } from './types';
 import { grpcMultiUserAccountSubscriber } from './accounts/grpcMultiUserAccountSubscriber';
-import { AtLeastOne } from './util/deprecatedAlias';
 
 type UserConfigBase = {
 	accountSubscription?: UserSubscriptionConfig;
 	userAccountPublicKey: PublicKey;
 };
 
-export type UserConfig = UserConfigBase &
-	AtLeastOne<'velocityClient', 'driftClient', VelocityClient>;
+export type UserConfig = UserConfigBase & { velocityClient: VelocityClient };
 
 export type UserSubscriptionConfig =
 	| {

package/src/userMap/WebsocketSubscription.ts

@@ -54,7 +54,7 @@ export class WebsocketSubscription {
 			this.subscriber = new WebSocketProgramAccountSubscriber<UserAccount>(
 				'UserMap',
 				'user',
-				this.userMap.driftClient.program,
+				this.userMap.velocityClient.program,
 				this.decodeFn,
 				{
 					filters,

package/src/userMap/grpcSubscription.ts

@@ -56,7 +56,7 @@ export class grpcSubscription {
 				this.grpcConfigs,
 				'UserMap',
 				'user',
-				this.userMap.driftClient.program,
+				this.userMap.velocityClient.program,
 				this.decodeFn,
 				{
 					filters,

package/src/userMap/referrerMap.ts

@@ -29,10 +29,6 @@ export class ReferrerMap {
 	 */
 	private referrerReferrerInfoMap = new Map<string, ReferrerInfo>();
 	private velocityClient: VelocityClient;
-	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
-	private get driftClient(): VelocityClient {
-		return this.velocityClient;
-	}
 	private parallelSync: boolean;
 
 	private fetchPromise?: Promise<void>;

package/src/userMap/revenueShareEscrowMap.ts

@@ -10,10 +10,6 @@ export class RevenueShareEscrowMap {
 	 */
 	private authorityEscrowMap = new Map<string, RevenueShareEscrowAccount>();
 	private velocityClient: VelocityClient;
-	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
-	private get driftClient(): VelocityClient {
-		return this.velocityClient;
-	}
 	private parallelSync: boolean;
 
 	private fetchPromise?: Promise<void>;

package/src/userMap/userMap.ts

@@ -78,10 +78,6 @@ export interface UserMapInterface {
 export class UserMap implements UserMapInterface {
 	private userMap = new Map<string, DataAndSlot<User>>();
 	velocityClient: VelocityClient;
-	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
-	public get driftClient(): VelocityClient {
-		return this.velocityClient;
-	}
 	eventEmitter: StrictEventEmitter<EventEmitter, UserEvents>;
 	private connection: Connection;
 	private commitment: Commitment;
@@ -114,7 +110,7 @@ export class UserMap implements UserMapInterface {
 	 */
 	constructor(config: UserMapConfig) {
 		// Type-system guarantees at least one of the two is supplied.
-		this.velocityClient = (config.velocityClient ?? config.driftClient)!;
+		this.velocityClient = config.velocityClient!;
 		if (config.connection) {
 			this.connection = config.connection;
 		} else {
@@ -420,7 +416,7 @@ export class UserMap implements UserMapInterface {
 
 	/**
 	 * Syncs the UserMap using the default sync method (single getProgramAccounts call with filters).
-	 * This method may fail when drift has too many users. (nodejs response size limits)
+	 * This method may fail when velocity has too many users. (nodejs response size limits)
 	 * @returns
 	 */
 	private async defaultSync() {
@@ -517,7 +513,7 @@ export class UserMap implements UserMapInterface {
 
 	/**
 	 * Syncs the UserMap using the paginated sync method (multiple getMultipleAccounts calls with filters).
-	 * This method is more reliable when drift has many users.
+	 * This method is more reliable when velocity has many users.
 	 * @returns
 	 */
 	private async paginatedSync() {

package/src/userMap/userMapConfig.ts

@@ -1,7 +1,6 @@
 import { Commitment, Connection, MemcmpFilter } from '@solana/web3.js';
 import { VelocityClient } from '../velocityClient';
 import { GrpcConfigs } from '../accounts/types';
-import { AtLeastOne } from '../util/deprecatedAlias';
 
 // passed into UserMap.getUniqueAuthorities to filter users
 export type UserAccountFilterCriteria = {
@@ -65,5 +64,6 @@ type UserMapConfigBase = {
 	additionalFilters?: MemcmpFilter[];
 };
 
-export type UserMapConfig = UserMapConfigBase &
-	AtLeastOne<'velocityClient', 'driftClient', VelocityClient>;
+export type UserMapConfig = UserMapConfigBase & {
+	velocityClient: VelocityClient;
+};

package/src/userMap/userStatsMap.ts

@@ -27,10 +27,6 @@ export class UserStatsMap {
 	 */
 	private userStatsMap = new Map<string, UserStats>();
 	private velocityClient: VelocityClient;
-	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
-	private get driftClient(): VelocityClient {
-		return this.velocityClient;
-	}
 	private bulkAccountLoader: BulkAccountLoader;
 	private decode;
 	private syncConfig: SyncConfig;

package/src/userStats.ts

@@ -18,17 +18,13 @@ import { grpcUserStatsAccountSubscriber } from './accounts/grpcUserStatsAccountS
 
 export class UserStats {
 	velocityClient: VelocityClient;
-	/** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
-	public get driftClient(): VelocityClient {
-		return this.velocityClient;
-	}
 	userStatsAccountPublicKey: PublicKey;
 	accountSubscriber: UserStatsAccountSubscriber;
 	isSubscribed: boolean;
 
 	public constructor(config: UserStatsConfig) {
 		// Type-system guarantees at least one of the two is supplied.
-		const velocityClient = (config.velocityClient ?? config.driftClient)!;
+		const velocityClient = config.velocityClient!;
 		this.velocityClient = velocityClient;
 		this.userStatsAccountPublicKey = config.userStatsAccountPublicKey;
 		if (config.accountSubscription?.type === 'polling') {

package/src/userStatsConfig.ts

@@ -2,15 +2,15 @@ import { VelocityClient } from './velocityClient';
 import { Commitment, PublicKey } from '@solana/web3.js';
 import { BulkAccountLoader } from './accounts/bulkAccountLoader';
 import { GrpcConfigs, UserStatsAccountSubscriber } from './accounts/types';
-import { AtLeastOne } from './util/deprecatedAlias';
 
 type UserStatsConfigBase = {
 	accountSubscription?: UserStatsSubscriptionConfig;
 	userStatsAccountPublicKey: PublicKey;
 };
 
-export type UserStatsConfig = UserStatsConfigBase &
-	AtLeastOne<'velocityClient', 'driftClient', VelocityClient>;
+export type UserStatsConfig = UserStatsConfigBase & {
+	velocityClient: VelocityClient;
+};
 
 export type UserStatsSubscriptionConfig =
 	| {

package/src/util/ed25519Utils.ts

@@ -37,7 +37,7 @@ const ED25519_INSTRUCTION_LAYOUT = BufferLayout.struct<
 
 /**
  * Constructs a minimal Ed25519 verification instruction that references the data
- * inside the drift custom instruction (e.g. postPythLazerOracleUpdate, placeSignedMsgTakerOrder).
+ * inside the velocity custom instruction (e.g. postPythLazerOracleUpdate, placeSignedMsgTakerOrder).
  *
  * @param customInstructionIndex The index of the custom instruction in the transaction (e.g. if tx contains compute budget limit, compute budget price, ed25519 verify, custom ix, this would be 3).
  * @param messageOffset The offset within the custom instruction data where the signed message begins.