@velocity-exchange/sdk 0.0.5 → 0.2.0

package/src/tx/whileValidTxSender.ts

@@ -20,12 +20,7 @@ type ResolveReference = {
 };
 
 export class WhileValidTxSender extends BaseTxSender {
-	connection: Connection;
-	wallet: IWallet;
-	opts: ConfirmOptions;
-	timeout: number;
 	retrySleep: number;
-	additionalConnections: Connection[];
 	timoutCount = 0;
 	untilValid = new Map<
 		string,
@@ -75,7 +70,7 @@ export class WhileValidTxSender extends BaseTxSender {
 		wallet: IWallet;
 		opts?: ConfirmOptions;
 		retrySleep?: number;
-		additionalConnections?;
+		additionalConnections?: Connection[];
 		additionalTxSenderCallbacks?: ((base58EncodedTx: string) => void)[];
 		confirmationStrategy?: ConfirmationStrategy;
 		txHandler?: TxHandler;
@@ -120,6 +115,12 @@ export class WhileValidTxSender extends BaseTxSender {
 		let latestBlockhash =
 			await this.txHandler.getLatestBlockhashForTransaction();
 
+		if (!latestBlockhash) {
+			throw new Error(
+				'WhileValidTxSender: failed to fetch latest blockhash for transaction'
+			);
+		}
+
 		// handle tx
 		let signedTx = tx;
 		if (!preSigned) {
@@ -141,9 +142,18 @@ export class WhileValidTxSender extends BaseTxSender {
 		}
 
 		// handle subclass-specific side effects
-		const txSig = bs58.encode(
-			signedTx?.signature || signedTx.signatures[0]?.signature
-		);
+		const signature = signedTx?.signature || signedTx.signatures[0]?.signature;
+		if (!signature) {
+			throw new Error(
+				'WhileValidTxSender: signed transaction is missing a signature'
+			);
+		}
+		const txSig = bs58.encode(signature);
+		if (!latestBlockhash) {
+			throw new Error(
+				'WhileValidTxSender: failed to resolve latest blockhash for transaction'
+			);
+		}
 		this.untilValid.set(txSig, latestBlockhash);
 
 		return signedTx;
@@ -158,6 +168,12 @@ export class WhileValidTxSender extends BaseTxSender {
 		let latestBlockhash =
 			await this.txHandler.getLatestBlockhashForTransaction();
 
+		if (!latestBlockhash) {
+			throw new Error(
+				'WhileValidTxSender: failed to fetch latest blockhash for transaction'
+			);
+		}
+
 		let signedTx;
 		if (preSigned) {
 			signedTx = tx;
@@ -184,7 +200,7 @@ export class WhileValidTxSender extends BaseTxSender {
 				});
 			signedTx = await this.txHandler.signVersionedTx(
 				tx,
-				additionalSigners,
+				additionalSigners ?? [],
 				latestBlockhash
 			);
 		}
@@ -193,7 +209,18 @@ export class WhileValidTxSender extends BaseTxSender {
 			opts = this.opts;
 		}
 
-		const txSig = bs58.encode(signedTx.signatures[0]);
+		const signature = signedTx.signatures[0];
+		if (!signature) {
+			throw new Error(
+				'WhileValidTxSender: signed transaction is missing a signature'
+			);
+		}
+		const txSig = bs58.encode(signature);
+		if (!latestBlockhash) {
+			throw new Error(
+				'WhileValidTxSender: failed to resolve latest blockhash for transaction'
+			);
+		}
 		this.untilValid.set(txSig, latestBlockhash);
 
 		return this.sendRawTransaction(signedTx.serialize(), opts);
@@ -235,24 +262,26 @@ export class WhileValidTxSender extends BaseTxSender {
 			}
 		})();
 
-		let slot: number;
+		let slot: number | undefined;
 		try {
 			const result = await this.confirmTransaction(txid, opts.commitment);
 
 			this.txSigCache?.set(txid, true);
 
-			await this.checkConfirmationResultForError(txid, result?.value);
+			if (result) {
+				await this.checkConfirmationResultForError(txid, result.value);
 
-			if (result?.value?.err && this.throwOnTransactionError) {
-				// Fallback error handling if there's a problem reporting the error in checkConfirmationResultForError
-				throw new SendTransactionError({
-					action: 'send',
-					signature: txid,
-					transactionMessage: `Transaction Failed`,
-				});
-			}
+				if (result.value?.err && this.throwOnTransactionError) {
+					// Fallback error handling if there's a problem reporting the error in checkConfirmationResultForError
+					throw new SendTransactionError({
+						action: 'send',
+						signature: txid,
+						transactionMessage: `Transaction Failed`,
+					});
+				}
 
-			slot = result?.context?.slot;
+				slot = result.context.slot;
+			}
 			// eslint-disable-next-line no-useless-catch
 		} catch (e) {
 			throw e;

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 {
@@ -313,17 +313,17 @@ export class SettlePnlMode {
 }
 
 export function isVariant(object: unknown, type: string) {
-	return object.hasOwnProperty(type);
+	return Object.prototype.hasOwnProperty.call(object, type);
 }
 
 export function isOneOfVariant(object: unknown, types: string[]) {
 	return types.reduce((result, type) => {
-		return result || object.hasOwnProperty(type);
+		return result || Object.prototype.hasOwnProperty.call(object, type);
 	}, false);
 }
 
 export function getVariant(object: unknown): string {
-	return Object.keys(object)[0];
+	return Object.keys(object as object)[0];
 }
 
 export enum TradeSide {
@@ -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;
 };
 
@@ -655,40 +647,6 @@ export type DeleteUserRecord = {
 	keeper: PublicKey | null;
 };
 
-export type InsuranceFundSwapRecord = {
-	rebalanceConfig: PublicKey;
-	inIfTotalSharesBefore: BN;
-	outIfTotalSharesBefore: BN;
-	inIfUserSharesBefore: BN;
-	outIfUserSharesBefore: BN;
-	inIfTotalSharesAfter: BN;
-	outIfTotalSharesAfter: BN;
-	inIfUserSharesAfter: BN;
-	outIfUserSharesAfter: BN;
-	ts: BN;
-	inAmount: BN;
-	outAmount: BN;
-	outOraclePrice: BN;
-	outOraclePriceTwap: BN;
-	inVaultAmountBefore: BN;
-	outVaultAmountBefore: BN;
-	inFundVaultAmountAfter: BN;
-	outFundVaultAmountAfter: BN;
-	inMarketIndex: number;
-	outMarketIndex: number;
-};
-
-export type TransferProtocolIfSharesToRevenuePoolRecord = {
-	ts: BN;
-	marketIndex: number;
-	amount: BN;
-	shares: BN;
-	ifVaultAmountBefore: BN;
-	protocolSharesBefore: BN;
-	protocolSharesAfter: BN;
-	transferAmount: BN;
-};
-
 export type LPSwapRecord = {
 	ts: BN;
 	slot: BN;
@@ -774,13 +732,15 @@ export type StateAccount = {
 	hotLpCache: PublicKey;
 	hotLpSwap: PublicKey;
 	hotLpSettle: PublicKey;
-	hotIfRebalance: PublicKey;
 	hotFeatureFlag: PublicKey;
 	hotFuel: PublicKey;
 	hotUserFlag: PublicKey;
 	hotVaultDeposit: PublicKey;
 	hotMmOracleCrank: PublicKey;
 	hotAmmSpreadAdjust: PublicKey;
+	hotFeeWithdraw: PublicKey;
+	protocolFeeRecipientPerp: PublicKey;
+	protocolFeeRecipientSpot: PublicKey;
 	exchangeStatus: number;
 	whitelistMint: PublicKey;
 	discountMint: PublicKey;
@@ -816,16 +776,20 @@ 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;
+	protocolFeePool: PoolBalance;
+	feeLedger: FeeLedger;
 	liquidatorFee: number;
 	ifLiquidationFee: number;
+	protocolLiquidationFee: number;
+	feePoolBufferTarget: BN;
 	imfFactor: number;
 	unrealizedPnlImfFactor: number;
 	unrealizedPnlMaxImbalance: BN;
@@ -844,12 +808,38 @@ 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;
+	cumulativeFundingRateLong: BN;
+	cumulativeFundingRateShort: BN;
+	lastFundingRate: BN;
+	lastFundingRateLong: BN;
+	lastFundingRateShort: BN;
+	lastFundingRateTs: BN;
+	netUnsettledFundingPnl: BN;
+	orderStepSize: BN;
+	orderTickSize: BN;
 };
 
 export type HistoricalOracleData = {
@@ -892,13 +882,15 @@ export type SpotMarketAccount = {
 		unstakingPeriod: BN;
 		lastRevenueSettleTs: BN;
 		revenueSettlePeriod: BN;
-		totalFactor: number;
-		userFactor: number;
+		ifFeeFactor: number;
 	};
 
 	revenuePool: PoolBalance;
+	protocolFeePool: PoolBalance;
 
 	ifLiquidationFee: number;
+	protocolLiquidationFee: number;
+	protocolFeeFactor: number;
 
 	decimals: number;
 	optimalUtilization: number;
@@ -952,6 +944,8 @@ export type SpotMarketAccount = {
 	tokenProgramFlag: number;
 
 	poolId: number;
+
+	feeAdjustment: number;
 };
 
 export type PoolBalance = {
@@ -959,98 +953,79 @@ export type PoolBalance = {
 	marketIndex: number;
 };
 
+/// Consolidated per-market fee ledger: lifetime analytics counters plus the
+/// pending (not-yet-materialized) protocol/IF/AMM carveouts and the AMM's
+/// backstop-of-last-resort clawback cap.
+export type FeeLedger = {
+	totalExchangeFee: BN;
+	totalLiquidationFee: BN;
+	pendingProtocolFee: BN;
+	pendingIfFee: BN;
+	ammProtocolFeesReceived: BN;
+	pendingAmmProvision: BN;
+};
+
 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;
+	/// the AMM's own fee-derived income (provision + spread surplus) — the
+	/// market's gross fees are feeLedger.totalExchangeFee
+	totalFee: BN;
+	/// spread-capture component of totalFee (trading profit, not a paid fee)
+	totalMmFee: BN;
+	/// the AMM's equity ledger (retained earnings): fee income + funding/PnL
+	/// + credits − curve costs − bankruptcy clawbacks; AMM money only
 	totalFeeMinusDistributions: BN;
+	/// @deprecated frozen pre-isolation analytics counter
 	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;
+	fundingBiasSensitivity: 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;
-
+	mmOracleSequenceId: BN;
+	lastOracleNormalisedPrice: BN;
+	lastReferencePriceOffset: number;
+	lastOracleValid: boolean;
 	lastFundingOracleTwap: BN;
-	referencePriceOffsetDeadbandPct: number;
+	historicalOracleData: HistoricalOracleData;
 };
 
 // # User Account Types
@@ -1086,14 +1061,12 @@ 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 = {
@@ -1146,7 +1119,6 @@ export type Order = {
 	marketIndex: number;
 	price: BN;
 	baseAssetAmount: BN;
-	quoteAssetAmount: BN;
 	baseAssetAmountFilled: BN;
 	quoteAssetAmountFilled: BN;
 	direction: PositionDirection;
@@ -1183,6 +1155,10 @@ export type OrderParams = {
 	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 {
@@ -1251,7 +1227,7 @@ export type OptionalOrderParams = {
 
 export type ModifyOrderParams = {
 	[Property in keyof OrderParams]?: OrderParams[Property] | null;
-} & { policy?: ModifyOrderPolicy };
+} & { policy?: ModifyOrderPolicy | null };
 
 export enum ModifyOrderPolicy {
 	MustModify = 1,
@@ -1276,6 +1252,8 @@ export const DefaultOrderParams: OrderParams = {
 	maxTs: null,
 	auctionStartPrice: null,
 	auctionEndPrice: null,
+	builderIdx: null,
+	builderFeeTenthBps: null,
 };
 
 export type SignedMsgOrderParamsMessage = {
@@ -1331,6 +1309,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 {
@@ -1390,7 +1370,8 @@ export type FeeStructure = {
 	feeTiers: FeeTier[];
 	fillerRewardStructure: OrderFillerRewardStructure;
 	flatFillerFee: BN;
-	referrerRewardEpochUpperBound: BN;
+	ammFeeNumerator: number;
+	ifFeeNumerator: number;
 };
 
 export type FeeTier = {
@@ -1508,9 +1489,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;
@@ -1518,36 +1496,8 @@ export type SignedTxData = {
 	blockHash: string;
 };
 
-export type IfRebalanceConfigAccount = {
-	pubkey: PublicKey;
-	totalInAmount: BN;
-	currentInAmount: BN;
-	currentOutAmount: BN;
-	currentOutAmountTransferred: BN;
-	epochStartTs: BN;
-	epochInAmount: BN;
-	epochMaxInAmount: BN;
-	epochDuration: BN;
-	outMarketIndex: number;
-	inMarketIndex: number;
-	maxSlippageBps: number;
-	swapMode: number;
-	status: number;
-};
-
-export type IfRebalanceConfigParams = {
-	totalInAmount: BN;
-	epochMaxInAmount: BN;
-	epochDuration: BN;
-	outMarketIndex: number;
-	inMarketIndex: number;
-	maxSlippageBps: number;
-	swapMode: number;
-	status: number;
-};
-
 /* 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 +1531,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[];