@velocity-exchange/sdk 0.4.0 → 0.6.0

package/src/math/builder.ts

@@ -1,130 +0,0 @@
-import { PublicKey } from '@solana/web3.js';
-import { BN } from '../isomorphic/anchor';
-import {
-	OrderParams,
-	ReferrerStatus,
-	RevenueShareEscrowAccount,
-	RevenueShareOrder,
-	UserStatsAccount,
-} from '../types';
-
-const BUILDER_FEE_TENTH_BPS_DENOMINATOR = new BN(100_000);
-
-/**
- * Calculates the builder fee charged on top of the tiered taker/maker fee, mirroring the
- * program's builder-fee calc. `builderFeeTenthBps` is denominated in tenth-basis-points, i.e.
- * `10 * builderFeeTenthBps == 1 bp == 0.01%` — the fee fraction is `builderFeeTenthBps / 100_000`.
- *
- * @param {BN} quoteAssetAmount - The fill's quote asset amount the fee is charged against,
- *   QUOTE_PRECISION (1e6)
- * @param {number} builderFeeTenthBps - The builder fee rate, in tenth-bps (`OrderParams.builderFeeTenthBps`)
- * @return {BN} The builder fee, QUOTE_PRECISION (1e6)
- */
-export function calculateBuilderFee(
-	quoteAssetAmount: BN,
-	builderFeeTenthBps: number
-): BN {
-	return quoteAssetAmount
-		.mul(new BN(builderFeeTenthBps))
-		.div(BUILDER_FEE_TENTH_BPS_DENOMINATOR);
-}
-
-/**
- * True when the user's `RevenueShareEscrow` was initialized with a referrer.
- *
- * @param {Pick<UserStatsAccount, 'referrerStatus'>} userStats - The user's stats account (or a
- *   pick containing just `referrerStatus`)
- * @return {boolean} Whether `ReferrerStatus.BuilderReferral` is set in `referrerStatus`. When
- *   true, fills for this user must include the escrow account as a remaining account or the
- *   program rejects them with `UnableToLoadRevenueShareAccount`
- */
-export function isBuilderReferral(
-	userStats: Pick<UserStatsAccount, 'referrerStatus'>
-): boolean {
-	return (userStats.referrerStatus & ReferrerStatus.BuilderReferral) !== 0;
-}
-
-/**
- * True when the escrow was initialized with a referrer (its `referrer` field is not the default
- * pubkey).
- *
- * @param {Pick<RevenueShareEscrowAccount, 'referrer'>} escrow - The revenue share escrow account
- *   (or a pick containing just `referrer`)
- * @return {boolean} Whether `escrow.referrer` is set. Referral rewards accrue into such escrows on
- *   fills, so fills of the escrow owner's orders must include the escrow account (see `isBuilderReferral`)
- */
-export function escrowHasReferrer(
-	escrow: Pick<RevenueShareEscrowAccount, 'referrer'>
-): boolean {
-	return !escrow.referrer.equals(PublicKey.default);
-}
-
-/**
- * True when the order params carry a builder code (both `builderIdx` and `builderFeeTenthBps`
- * are set, i.e. neither `null` nor `undefined`).
- *
- * @param {Pick<OrderParams, 'builderIdx' | 'builderFeeTenthBps'>} orderParams - The order params
- *   (or a pick containing just the builder fields)
- * @return {boolean} Whether both builder fields are present
- */
-export function hasBuilderParams(
-	orderParams: Pick<OrderParams, 'builderIdx' | 'builderFeeTenthBps'>
-): boolean {
-	return (
-		orderParams.builderIdx !== null &&
-		orderParams.builderIdx !== undefined &&
-		orderParams.builderFeeTenthBps !== null &&
-		orderParams.builderFeeTenthBps !== undefined
-	);
-}
-
-const FLAG_IS_OPEN = 0x01;
-/**
- * True if this `RevenueShareOrder` slot is occupied by an active order, mirroring
- * `RevenueShareOrder::is_open` (`RevenueShareOrderBitFlag::Open`). While open, `orderId` and
- * `subAccountId` identify the live order this slot is tracking.
- *
- * @param {RevenueShareOrder} order - The revenue share order slot
- * @return {boolean} Whether the `Open` bit is set in `order.bitFlags`
- */
-export function isBuilderOrderOpen(order: RevenueShareOrder): boolean {
-	return (order.bitFlags & FLAG_IS_OPEN) !== 0;
-}
-
-const FLAG_IS_COMPLETED = 0x02;
-/**
- * True if this `RevenueShareOrder` has been filled or canceled and is awaiting settlement into
- * the builder's account, mirroring `RevenueShareOrder::is_completed`
- * (`RevenueShareOrderBitFlag::Completed`). Once completed, `orderId`/`subAccountId` are no
- * longer meaningful and the slot's accrued fees may be merged with other completed orders.
- *
- * @param {RevenueShareOrder} order - The revenue share order slot
- * @return {boolean} Whether the `Completed` bit is set in `order.bitFlags`
- */
-export function isBuilderOrderCompleted(order: RevenueShareOrder): boolean {
-	return (order.bitFlags & FLAG_IS_COMPLETED) !== 0;
-}
-
-const FLAG_IS_REFERRAL = 0x04;
-/**
- * True if this `RevenueShareOrder` slot instead holds referral rewards pending settlement for a
- * market (`RevenueShareOrderBitFlag::Referral`), rather than tracking a builder-fee order. When
- * set, no other bit flag should be set and `builderIdx` is ignored.
- *
- * @param {RevenueShareOrder} order - The revenue share order slot
- * @return {boolean} Whether the `Referral` bit is set in `order.bitFlags`
- */
-export function isBuilderOrderReferral(order: RevenueShareOrder): boolean {
-	return (order.bitFlags & FLAG_IS_REFERRAL) !== 0;
-}
-
-/**
- * True if this `RevenueShareOrder` slot is free to be (re)written — neither open nor completed —
- * mirroring `RevenueShareOrder::is_available`.
- *
- * @param {RevenueShareOrder} order - The revenue share order slot
- * @return {boolean} Whether the slot can be claimed for a new order
- */
-export function isBuilderOrderAvailable(order: RevenueShareOrder): boolean {
-	return !isBuilderOrderOpen(order) && !isBuilderOrderCompleted(order);
-}

package/src/math/conversion.ts

@@ -1,45 +0,0 @@
-import { BN } from '../isomorphic/anchor';
-import { PRICE_PRECISION } from '../constants/numericConstants';
-
-/**
- * Converts a fixed-point `BN` into a human-readable JS `number` by dividing out `precision`.
- * Correctly handles negative `bigNumber` values: `bn.js`'s `.div()`/`.mod()` truncate toward
- * zero (matching JS `%` semantics), so the whole and fractional parts recombine with consistent
- * sign without needing separate negative-number handling. Precision beyond what a JS `number`
- * (IEEE-754 double) can represent exactly may be lost — this is a display/estimation helper, not
- * for further on-chain-precision math.
- *
- * @param {BN} bigNumber - The value to convert; `null`/`undefined` return 0 (a `BN` instance for
- *   zero is still an object and thus truthy, so it falls through to the normal division below)
- * @param {BN} [precision] - The fixed-point precision to divide out; defaults to `PRICE_PRECISION` (1e6)
- * @return {number} The value as a JS number, in the same units `precision` represents one whole unit of
- */
-export const convertToNumber = (
-	bigNumber: BN,
-	precision: BN = PRICE_PRECISION
-) => {
-	if (!bigNumber) return 0;
-	return (
-		bigNumber.div(precision).toNumber() +
-		bigNumber.mod(precision).toNumber() / precision.toNumber()
-	);
-};
-
-/**
- * Converts a human-readable JS `number` into a fixed-point `BN` scaled by `precision`. The
- * fractional part is rounded (`Math.round`) to the nearest unit of `precision`, not truncated.
- *
- * @param {number} value - The human-readable value to convert
- * @param {BN} precision - The fixed-point precision to scale by (e.g. `QUOTE_PRECISION`, `BASE_PRECISION`)
- * @return {BN} `value` scaled by `precision`
- */
-export function convertToBN(value: number, precision: BN): BN {
-	// Get the whole part using Math.floor
-	const wholePart = Math.floor(value);
-
-	// Get decimal part by subtracting whole part and multiplying by precision
-	const decimalPart = Math.round((value - wholePart) * precision.toNumber());
-
-	// Combine: wholePart * PRECISION + decimalPart
-	return new BN(wholePart).mul(precision).add(new BN(decimalPart));
-}

package/src/math/exchangeStatus.ts

@@ -1,261 +0,0 @@
-import {
-	DEFAULT_REVENUE_SINCE_LAST_FUNDING_SPREAD_RETREAT,
-	PERCENTAGE_PRECISION,
-	ONE,
-} from '../constants/numericConstants';
-import {
-	ExchangeStatus,
-	PerpMarketAccount,
-	PerpOperation,
-	SolvencyStatus,
-	SpotMarketAccount,
-	SpotOperation,
-	StateAccount,
-	isVariant,
-	InsuranceFundOperation,
-	MarketConfigFlag,
-} from '../types';
-import { BN } from '../isomorphic/anchor';
-
-/**
- * True if the exchange-wide status is anything other than fully active, i.e. any bit in
- * `ExchangeStatus` is set (deposits, withdraws, AMM, fills, liquidations, funding, settle-pnl,
- * or AMM-immediate-fill paused).
- *
- * @param {StateAccount} state - The global state account
- * @return {boolean} Whether any exchange-wide pause flag is set
- */
-export function exchangePaused(state: StateAccount): boolean {
-	return state.exchangeStatus !== ExchangeStatus.ACTIVE;
-}
-
-/**
- * Mirror of the program's `State::solvency_repair_paused`. Gates the resolve-bankruptcy /
- * pnl-deficit instructions independently of `ExchangeStatus.WITHDRAW_PAUSED` — an admin can pause
- * solvency repair without also blocking ordinary user withdrawals, or vice versa.
- *
- * @param {StateAccount} state - The global state account
- * @return {boolean} Whether the `SOLVENCY_REPAIR_PAUSED` bit is set in `state.solvencyStatus`
- */
-export function solvencyRepairPaused(state: StateAccount): boolean {
-	return (
-		(state.solvencyStatus & SolvencyStatus.SOLVENCY_REPAIR_PAUSED) ===
-		SolvencyStatus.SOLVENCY_REPAIR_PAUSED
-	);
-}
-
-/**
- * True if deposits are blocked for `market`, either because the exchange-wide
- * `ExchangeStatus.DEPOSIT_PAUSED` flag is set, or because the market's own
- * `pausedOperations` bitmask has `SpotOperation.DEPOSIT` set.
- *
- * @param {StateAccount} state - The global state account
- * @param {SpotMarketAccount} market - The spot market account
- * @return {boolean} Whether deposits are paused for this market
- */
-export function depositPaused(
-	state: StateAccount,
-	market: SpotMarketAccount
-): boolean {
-	if (
-		(state.exchangeStatus & ExchangeStatus.DEPOSIT_PAUSED) ===
-		ExchangeStatus.DEPOSIT_PAUSED
-	) {
-		return true;
-	}
-
-	return isOperationPaused(market.pausedOperations, SpotOperation.DEPOSIT);
-}
-
-/**
- * True if withdrawals are blocked for `market`, either because the exchange-wide
- * `ExchangeStatus.WITHDRAW_PAUSED` flag is set, or because the market's own
- * `pausedOperations` bitmask has `SpotOperation.WITHDRAW` set. Independent of
- * `solvencyRepairPaused`.
- *
- * @param {StateAccount} state - The global state account
- * @param {SpotMarketAccount} market - The spot market account
- * @return {boolean} Whether withdrawals are paused for this market
- */
-export function withdrawPaused(
-	state: StateAccount,
-	market: SpotMarketAccount
-): boolean {
-	if (
-		(state.exchangeStatus & ExchangeStatus.WITHDRAW_PAUSED) ===
-		ExchangeStatus.WITHDRAW_PAUSED
-	) {
-		return true;
-	}
-
-	return isOperationPaused(market.pausedOperations, SpotOperation.WITHDRAW);
-}
-
-/**
- * True if fills are blocked for `market`, either because the exchange-wide
- * `ExchangeStatus.FILL_PAUSED` flag is set, or because the market's own `pausedOperations`
- * bitmask has the market-type-appropriate fill flag set (`PerpOperation.FILL` for perp markets,
- * detected via the presence of an `amm` field; `SpotOperation.FILL` otherwise).
- *
- * @param {StateAccount} state - The global state account
- * @param {PerpMarketAccount | SpotMarketAccount} market - The perp or spot market account
- * @return {boolean} Whether fills are paused for this market
- */
-export function fillPaused(
-	state: StateAccount,
-	market: PerpMarketAccount | SpotMarketAccount
-): boolean {
-	if (
-		(state.exchangeStatus & ExchangeStatus.FILL_PAUSED) ===
-		ExchangeStatus.FILL_PAUSED
-	) {
-		return true;
-	}
-
-	if (market.hasOwnProperty('amm')) {
-		return isOperationPaused(market.pausedOperations, PerpOperation.FILL);
-	} else {
-		return isOperationPaused(market.pausedOperations, SpotOperation.FILL);
-	}
-}
-
-/**
- * True if AMM fills are blocked for `market`: the exchange-wide `ExchangeStatus.AMM_PAUSED` flag
- * is set, the market's `pausedOperations` has `PerpOperation.AMM_FILL` set (perp markets only),
- * or (perp markets only) the AMM has breached its per-funding-period drawdown limit
- * (`isAmmDrawdownPause`). Always `false` for spot markets beyond the exchange-wide flag, since
- * spot markets have no AMM.
- *
- * @param {StateAccount} state - The global state account
- * @param {PerpMarketAccount | SpotMarketAccount} market - The perp or spot market account
- * @return {boolean} Whether AMM fills are paused for this market
- */
-export function ammPaused(
-	state: StateAccount,
-	market: PerpMarketAccount | SpotMarketAccount
-): boolean {
-	if (
-		(state.exchangeStatus & ExchangeStatus.AMM_PAUSED) ===
-		ExchangeStatus.AMM_PAUSED
-	) {
-		return true;
-	}
-
-	if (market.hasOwnProperty('amm')) {
-		const operationPaused = isOperationPaused(
-			market.pausedOperations,
-			PerpOperation.AMM_FILL
-		);
-		if (operationPaused) {
-			return true;
-		}
-		if (isAmmDrawdownPause(market as PerpMarketAccount)) {
-			return true;
-		}
-	}
-
-	return false;
-}
-
-/**
- * Bitmask test for whether `operation` is set in a `pausedOperations` field.
- *
- * @param {number} pausedOperations - A market or insurance-fund `pausedOperations` bitmask
- * @param {PerpOperation | SpotOperation | InsuranceFundOperation} operation - The operation flag to test
- * @return {boolean} Whether `operation`'s bit is set
- */
-export function isOperationPaused(
-	pausedOperations: number,
-	operation: PerpOperation | SpotOperation | InsuranceFundOperation
-): boolean {
-	return (pausedOperations & operation) > 0;
-}
-
-/**
- * True if a perp market's AMM has accumulated too much drawdown since its last funding update to
- * keep accepting AMM fills, mirroring `AMM::has_too_much_drawdown`. Uses a two-stage gate: an
- * absolute quote-denominated drawdown floor (contract tier A/B: -$10,000; others: -$5,000, i.e.
- * `DEFAULT_REVENUE_SINCE_LAST_FUNDING_SPREAD_RETREAT` ($25) times 400 or 200) must first be
- * breached, then a tier-specific percentage-of-total-fees drawdown limit (A: 2%, B: ~3%, C: 4%,
- * others: 5%) must also be breached.
- *
- * @param {PerpMarketAccount} market - The perp market account
- * @return {boolean} Whether the AMM should stop accepting fills due to drawdown this funding period
- */
-export function isAmmDrawdownPause(market: PerpMarketAccount): boolean {
-	let quoteDrawdownLimitBreached: boolean;
-
-	if (
-		isVariant(market.contractTier, 'a') ||
-		isVariant(market.contractTier, 'b')
-	) {
-		quoteDrawdownLimitBreached = market.amm.netRevenueSinceLastFunding.lte(
-			DEFAULT_REVENUE_SINCE_LAST_FUNDING_SPREAD_RETREAT.muln(400)
-		);
-	} else {
-		quoteDrawdownLimitBreached = market.amm.netRevenueSinceLastFunding.lte(
-			DEFAULT_REVENUE_SINCE_LAST_FUNDING_SPREAD_RETREAT.muln(200)
-		);
-	}
-
-	if (quoteDrawdownLimitBreached) {
-		const percentDrawdown = market.amm.netRevenueSinceLastFunding
-			.mul(PERCENTAGE_PRECISION)
-			.div(BN.max(market.amm.totalFeeMinusDistributions, ONE));
-
-		let percentDrawdownLimitBreached: boolean;
-
-		if (isVariant(market.contractTier, 'a')) {
-			percentDrawdownLimitBreached = percentDrawdown.lte(
-				PERCENTAGE_PRECISION.divn(50).neg()
-			);
-		} else if (isVariant(market.contractTier, 'b')) {
-			percentDrawdownLimitBreached = percentDrawdown.lte(
-				PERCENTAGE_PRECISION.divn(33).neg()
-			);
-		} else if (isVariant(market.contractTier, 'c')) {
-			percentDrawdownLimitBreached = percentDrawdown.lte(
-				PERCENTAGE_PRECISION.divn(25).neg()
-			);
-		} else {
-			percentDrawdownLimitBreached = percentDrawdown.lte(
-				PERCENTAGE_PRECISION.divn(20).neg()
-			);
-		}
-
-		if (percentDrawdownLimitBreached) {
-			return true;
-		}
-	}
-
-	return false;
-}
-
-/**
- * Bitmask test for whether `flag` is set in a perp market's `marketConfig` field.
- *
- * @param {number} marketConfig - A `PerpMarketAccount.marketConfig` bitmask
- * @param {MarketConfigFlag} flag - The config flag to test
- * @return {boolean} Whether `flag`'s bit is set
- */
-export function isMarketConfigFlagSet(
-	marketConfig: number,
-	flag: MarketConfigFlag
-): boolean {
-	return (marketConfig & flag) > 0;
-}
-
-/**
- * True if formulaic (automatic) `k` (AMM depth) updates are disabled for this market, meaning
- * `k` only changes via explicit admin instructions rather than the keeper-driven repeg/curve
- * update logic.
- *
- * @param {PerpMarketAccount} market - The perp market account
- * @return {boolean} Whether `DISABLE_FORMULAIC_K_UPDATE` is set in `market.marketConfig`
- */
-export function isFormulaicKUpdateDisabled(market: PerpMarketAccount): boolean {
-	return isMarketConfigFlagSet(
-		market.marketConfig,
-		MarketConfigFlag.DISABLE_FORMULAIC_K_UPDATE
-	);
-}