@velocity-exchange/sdk 0.4.0 → 0.6.0

package/src/decode/user.ts

@@ -1,401 +0,0 @@
-import { BN } from '../isomorphic/anchor';
-import {
-	MarketType,
-	Order,
-	OrderStatus,
-	OrderTriggerCondition,
-	OrderType,
-	PerpPosition,
-	PositionDirection,
-	PositionFlag,
-	SpotBalanceType,
-	SpotPosition,
-	UserAccount,
-} from '../types';
-import { PublicKey } from '@solana/web3.js';
-import { ZERO } from '../constants/numericConstants';
-
-function readUnsignedBigInt64LE(buffer: Buffer, offset: number): BN {
-	return new BN(buffer.subarray(offset, offset + 8), 10, 'le');
-}
-
-function readSignedBigInt64LE(buffer: Buffer, offset: number): BN {
-	const unsignedValue = new BN(buffer.subarray(offset, offset + 8), 10, 'le');
-	if (unsignedValue.testn(63)) {
-		const inverted = unsignedValue.notn(64).addn(1);
-		return inverted.neg();
-	} else {
-		return unsignedValue;
-	}
-}
-
-/**
- * Hand-rolled, offset-based decoder for the `User` account, used as a fast path instead of
- * Anchor's generic Borsh decoder in hot paths (e.g. bulk DLOB/account-map refreshes). Byte offsets
- * here are hardcoded to the current on-chain `User` layout and must be kept in sync with any
- * change to `programs/velocity/src/state/user.rs` — see the offset notes in `../memcmp.ts`
- * (`USER_IDLE_OFFSET` etc.), which mirror this same layout and will silently return zero matches
- * if this decoder and those offsets drift apart.
- *
- * Empty slots are skipped without full-field decoding: a spot position is treated as unused when
- * `scaledBalance == 0 && openOrders == 0`; a perp position when `baseAssetAmount`,
- * `quoteAssetAmount`, and `isolatedPositionScaledBalance` are all 0, `openOrders == 0`, and
- * neither `BeingLiquidated` nor `Bankruptcy` position flags are set; an order slot when its
- * `status` byte isn't `1` (`OrderStatus.OPEN`) — in all three cases the skipped slot is omitted
- * from the returned array entirely (only active entries are pushed), so the array length may be
- * less than the on-chain fixed slot count.
- * @param buffer - Raw `User` account data, including its 8-byte Anchor discriminator (skipped internally).
- * @returns The decoded `UserAccount`. Amount/price fields retain on-chain precision (e.g.
- * `baseAssetAmount`/`openBids`/`openAsks` in BASE_PRECISION 1e9, `quoteAssetAmount` and other
- * quote-denominated fields in QUOTE_PRECISION 1e6, order `price`/`triggerPrice`/auction prices in
- * PRICE_PRECISION 1e6) — this function only re-parses bytes, it does not rescale anything.
- * @throws Error if an order's encoded `status`, `orderType`, or `triggerCondition` byte doesn't match a known enum value.
- */
-export function decodeUser(buffer: Buffer): UserAccount {
-	let offset = 8;
-	const authority = new PublicKey(buffer.slice(offset, offset + 32));
-	offset += 32;
-	const delegate = new PublicKey(buffer.slice(offset, offset + 32));
-	offset += 32;
-	const name = [];
-	for (let i = 0; i < 32; i++) {
-		name.push(buffer.readUint8(offset + i));
-	}
-	offset += 32;
-
-	const spotPositions: SpotPosition[] = [];
-	for (let i = 0; i < 8; i++) {
-		const scaledBalance = readUnsignedBigInt64LE(buffer, offset);
-		const openOrders = buffer.readUInt8(offset + 35);
-		if (scaledBalance.eq(ZERO) && openOrders === 0) {
-			offset += 40;
-			continue;
-		}
-
-		offset += 8;
-		const openBids = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const openAsks = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const cumulativeDeposits = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const marketIndex = buffer.readUInt16LE(offset);
-		offset += 2;
-		const balanceTypeNum = buffer.readUInt8(offset);
-		let balanceType: SpotBalanceType;
-		if (balanceTypeNum === 0) {
-			balanceType = SpotBalanceType.DEPOSIT;
-		} else {
-			balanceType = SpotBalanceType.BORROW;
-		}
-		offset += 6;
-		spotPositions.push({
-			scaledBalance,
-			openBids,
-			openAsks,
-			cumulativeDeposits,
-			marketIndex,
-			balanceType,
-			openOrders,
-		});
-	}
-
-	const perpPositions: PerpPosition[] = [];
-	for (let i = 0; i < 8; i++) {
-		const baseAssetAmount = readSignedBigInt64LE(buffer, offset + 8);
-		const quoteAssetAmount = readSignedBigInt64LE(buffer, offset + 16);
-		const isolatedPositionScaledBalance = readUnsignedBigInt64LE(
-			buffer,
-			offset + 64
-		);
-		const openOrders = buffer.readUInt8(offset + 78);
-		const positionFlag = buffer.readUInt8(offset + 79);
-
-		if (
-			baseAssetAmount.eq(ZERO) &&
-			openOrders === 0 &&
-			quoteAssetAmount.eq(ZERO) &&
-			isolatedPositionScaledBalance.eq(ZERO) &&
-			!(
-				(positionFlag &
-					(PositionFlag.BeingLiquidated | PositionFlag.Bankruptcy)) >
-				0
-			)
-		) {
-			offset += 80;
-			continue;
-		}
-
-		const lastCumulativeFundingRate = readSignedBigInt64LE(buffer, offset);
-		offset += 24;
-		const quoteBreakEvenAmount = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const quoteEntryAmount = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const openBids = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const openAsks = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const settledPnl = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		offset += 8; // isolated_position_scaled_balance (already pre-read above)
-		offset += 2; // skip padding[u8; 2]
-		const maxMarginRatio = buffer.readUInt16LE(offset); // offset+74
-		offset += 2;
-		const marketIndex = buffer.readUInt16LE(offset); // offset+76
-		offset += 4; // advance past marketIndex(2) + openOrders(1) + positionFlag(1)
-		perpPositions.push({
-			lastCumulativeFundingRate,
-			baseAssetAmount,
-			quoteAssetAmount,
-			quoteBreakEvenAmount,
-			quoteEntryAmount,
-			openBids,
-			openAsks,
-			settledPnl,
-			remainderBaseAssetAmount: 0,
-			marketIndex,
-			openOrders,
-			maxMarginRatio,
-			positionFlag,
-			isolatedPositionScaledBalance,
-		});
-	}
-
-	const orders: Order[] = [];
-	for (let i = 0; i < 32; i++) {
-		// skip order if it's not open
-		if (buffer.readUint8(offset + 86) !== 1) {
-			offset += 104;
-			continue;
-		}
-
-		const slot = readUnsignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const price = readUnsignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const baseAssetAmount = readUnsignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const baseAssetAmountFilled = readUnsignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const quoteAssetAmountFilled = readUnsignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const triggerPrice = readUnsignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const auctionStartPrice = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const auctionEndPrice = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const maxTs = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const oraclePriceOffset = readSignedBigInt64LE(buffer, offset);
-		offset += 8;
-		const orderId = buffer.readUInt32LE(offset);
-		offset += 4;
-		const marketIndex = buffer.readUInt16LE(offset);
-		offset += 2;
-		const orderStatusNum = buffer.readUInt8(offset);
-
-		let status: OrderStatus;
-		if (orderStatusNum === 0) {
-			status = OrderStatus.INIT;
-		} else if (orderStatusNum === 1) {
-			status = OrderStatus.OPEN;
-		} else {
-			throw new Error(`decodeUser: unknown order status ${orderStatusNum}`);
-		}
-		offset += 1;
-		const orderTypeNum = buffer.readUInt8(offset);
-		let orderType: OrderType;
-		if (orderTypeNum === 0) {
-			orderType = OrderType.MARKET;
-		} else if (orderTypeNum === 1) {
-			orderType = OrderType.LIMIT;
-		} else if (orderTypeNum === 2) {
-			orderType = OrderType.TRIGGER_MARKET;
-		} else if (orderTypeNum === 3) {
-			orderType = OrderType.TRIGGER_LIMIT;
-		} else if (orderTypeNum === 4) {
-			orderType = OrderType.ORACLE;
-		} else {
-			throw new Error(`decodeUser: unknown order type ${orderTypeNum}`);
-		}
-		offset += 1;
-		const marketTypeNum = buffer.readUInt8(offset);
-		let marketType: MarketType;
-		if (marketTypeNum === 0) {
-			marketType = MarketType.SPOT;
-		} else {
-			marketType = MarketType.PERP;
-		}
-		offset += 1;
-		const userOrderId = buffer.readUint8(offset);
-		offset += 1;
-		const existingPositionDirectionNum = buffer.readUInt8(offset);
-		let existingPositionDirection: PositionDirection;
-		if (existingPositionDirectionNum === 0) {
-			existingPositionDirection = PositionDirection.LONG;
-		} else {
-			existingPositionDirection = PositionDirection.SHORT;
-		}
-		offset += 1;
-		const positionDirectionNum = buffer.readUInt8(offset);
-		let direction: PositionDirection;
-		if (positionDirectionNum === 0) {
-			direction = PositionDirection.LONG;
-		} else {
-			direction = PositionDirection.SHORT;
-		}
-		offset += 1;
-		const reduceOnly = buffer.readUInt8(offset) === 1;
-		offset += 1;
-		const postOnly = buffer.readUInt8(offset) === 1;
-		offset += 1;
-		const immediateOrCancel = buffer.readUInt8(offset) === 1;
-		offset += 1;
-		const triggerConditionNum = buffer.readUInt8(offset);
-		let triggerCondition: OrderTriggerCondition;
-		if (triggerConditionNum === 0) {
-			triggerCondition = OrderTriggerCondition.ABOVE;
-		} else if (triggerConditionNum === 1) {
-			triggerCondition = OrderTriggerCondition.BELOW;
-		} else if (triggerConditionNum === 2) {
-			triggerCondition = OrderTriggerCondition.TRIGGERED_ABOVE;
-		} else if (triggerConditionNum === 3) {
-			triggerCondition = OrderTriggerCondition.TRIGGERED_BELOW;
-		} else {
-			throw new Error(
-				`decodeUser: unknown trigger condition ${triggerConditionNum}`
-			);
-		}
-		offset += 1;
-		const auctionDuration = buffer.readUInt8(offset);
-		offset += 1;
-		const postedSlotTail = buffer.readUint8(offset);
-		offset += 1;
-		const bitFlags = buffer.readUint8(offset);
-		offset += 1;
-		offset += 5; // padding
-		orders.push({
-			slot,
-			price,
-			baseAssetAmount,
-			baseAssetAmountFilled,
-			quoteAssetAmountFilled,
-			triggerPrice,
-			auctionStartPrice,
-			auctionEndPrice,
-			maxTs,
-			oraclePriceOffset,
-			orderId,
-			marketIndex,
-			status,
-			orderType,
-			marketType,
-			userOrderId,
-			existingPositionDirection,
-			direction,
-			reduceOnly,
-			postOnly,
-			immediateOrCancel,
-			triggerCondition,
-			auctionDuration,
-			bitFlags,
-			postedSlotTail,
-		});
-	}
-
-	const totalDeposits = readUnsignedBigInt64LE(buffer, offset);
-	offset += 8;
-
-	const totalWithdraws = readUnsignedBigInt64LE(buffer, offset);
-	offset += 8;
-
-	const totalSocialLoss = readUnsignedBigInt64LE(buffer, offset);
-	offset += 8;
-
-	const settledPerpPnl = readSignedBigInt64LE(buffer, offset);
-	offset += 8;
-
-	const cumulativeSpotFees = readSignedBigInt64LE(buffer, offset);
-	offset += 8;
-
-	const cumulativePerpFunding = readSignedBigInt64LE(buffer, offset);
-	offset += 8;
-
-	const liquidationMarginFreed = readUnsignedBigInt64LE(buffer, offset);
-	offset += 8;
-
-	const lastActiveSlot = readUnsignedBigInt64LE(buffer, offset);
-	offset += 8;
-
-	const nextOrderId = buffer.readUInt32LE(offset);
-	offset += 4;
-
-	const maxMarginRatio = buffer.readUInt32LE(offset);
-	offset += 4;
-
-	const nextLiquidationId = buffer.readUInt16LE(offset);
-	offset += 2;
-
-	const subAccountId = buffer.readUInt16LE(offset);
-	offset += 2;
-
-	const status = buffer.readUInt8(offset);
-	offset += 1;
-
-	const isMarginTradingEnabled = buffer.readUInt8(offset) === 1;
-	offset += 1;
-
-	const idle = buffer.readUInt8(offset) === 1;
-	offset += 1;
-
-	const openOrders = buffer.readUInt8(offset);
-	offset += 1;
-
-	const hasOpenOrder = buffer.readUInt8(offset) === 1;
-	offset += 1;
-
-	const openAuctions = buffer.readUInt8(offset);
-	offset += 1;
-
-	const hasOpenAuction = buffer.readUInt8(offset) === 1;
-	offset += 1;
-
-	const poolId = buffer.readUint8(offset);
-	offset += 1;
-
-	const specialUserStatus = buffer.readUInt8(offset);
-	offset += 1;
-
-	offset += 14; // padding
-	return {
-		authority,
-		delegate,
-		name,
-		spotPositions,
-		perpPositions,
-		orders,
-		totalDeposits,
-		totalWithdraws,
-		totalSocialLoss,
-		settledPerpPnl,
-		cumulativeSpotFees,
-		cumulativePerpFunding,
-		liquidationMarginFreed,
-		lastActiveSlot,
-		nextOrderId,
-		maxMarginRatio,
-		nextLiquidationId,
-		subAccountId,
-		status,
-		isMarginTradingEnabled,
-		idle,
-		openOrders,
-		hasOpenOrder,
-		openAuctions,
-		hasOpenAuction,
-		poolId,
-		specialUserStatus,
-	};
-}