@liquid-af/sdk 0.1.0

package/src/types.ts

@@ -0,0 +1,354 @@
+import type { PublicKey } from "@solana/web3.js";
+import type BN from "bn.js";
+
+/** Curve status enum values */
+export const CurveStatus = {
+	Active: "active",
+	Complete: "complete",
+	Migrated: "migrated",
+} as const;
+
+export type CurveStatus = (typeof CurveStatus)[keyof typeof CurveStatus];
+
+/** Anchor-serialized curve status representation */
+export type CurveStatusAnchor =
+	| { active: Record<string, never> }
+	| { complete: { solPriceSnapshot: BN } }
+	| { migrated: Record<string, never> };
+
+/**
+ * Checks if an Anchor-serialized curve status matches an expected CurveStatus enum value.
+ *
+ * @param anchorStatus - The Anchor-serialized curve status to check
+ * @param expected - The expected CurveStatus enum value
+ * @returns True if the Anchor status matches the expected value
+ */
+export const curveStatusEquals = (
+	anchorStatus: CurveStatusAnchor,
+	expected: CurveStatus
+): boolean => {
+	return Object.keys(anchorStatus)[0] === expected;
+};
+
+/** Fee mode enum values */
+export const FeeMode = {
+	Recipients: "recipients",
+	Revoked: "revoked",
+} as const;
+
+export type FeeMode = (typeof FeeMode)[keyof typeof FeeMode];
+
+/** Anchor-serialized fee mode representation */
+export type FeeModeAnchor =
+	| { recipients: Record<string, never> }
+	| { revoked: Record<string, never> };
+
+/**
+ * Converts a FeeMode enum value to its Anchor-compatible serialized format.
+ *
+ * @param mode - The fee mode to convert
+ * @returns Anchor-serialized fee mode object
+ */
+export const toAnchorFeeMode = (mode: FeeMode): FeeModeAnchor => {
+	switch (mode) {
+		case FeeMode.Recipients:
+			return { recipients: {} };
+		case FeeMode.Revoked:
+			return { revoked: {} };
+	}
+};
+
+/**
+ * Checks if an Anchor-serialized fee mode matches an expected FeeMode enum value.
+ *
+ * @param anchorMode - The Anchor-serialized fee mode to check
+ * @param expected - The expected FeeMode enum value
+ * @returns True if the Anchor fee mode matches the expected value
+ */
+export const feeModeEquals = (
+	anchorMode: FeeModeAnchor,
+	expected: FeeMode
+): boolean => {
+	return Object.keys(anchorMode)[0] === expected;
+};
+
+/** Global configuration for the bonding curve program */
+export interface GlobalConfiguration {
+	adminAuthority: PublicKey;
+	initialVirtualTokenReserves: BN;
+	initialVirtualSolReserves: BN;
+	initialRealTokenReserves: BN;
+	tokenTotalSupply: BN;
+	traderCashbackBasisPoints: number;
+	creatorFeeBasisPoints: number;
+	creatorReferralRewardBasisPoints: number;
+	traderReferralRewardBasisPoints: number;
+	protocolFeeBasisPoints: number;
+	feeRecipients: PublicKey[];
+	quoteMints: PublicKey[];
+	paused: boolean;
+}
+
+/** Native bonding curve account state */
+export interface BondingCurveState {
+	creator: PublicKey;
+	tokenMint: PublicKey;
+	realTokenReserves: BN;
+	virtualTokenReserves: BN;
+	realSolReserves: BN;
+	virtualSolReserves: BN;
+	tokenTotalSupply: BN;
+	status: CurveStatusAnchor;
+	bump: number;
+}
+
+/** Market cap-based fee tier definition */
+export interface FeeTier {
+	rangeStartInclusive: BN;
+	rangeEndExclusive: BN;
+	lpFeeRate: number;
+	protocolFeeRate: number;
+	creatorFeeRate: number;
+}
+
+/** AMM global configuration */
+export interface AmmConfig {
+	adminAuthority: PublicKey;
+	feeRecipients: PublicKey[];
+	quoteMints: PublicKey[];
+	bump: number;
+	paused: boolean;
+	feeTiers: FeeTier[];
+	oraclePriceFeed: PublicKey;
+}
+
+/** AMM pool state account */
+export interface PoolState {
+	baseVault: PublicKey;
+	quoteVault: PublicKey;
+	lpMint: PublicKey;
+	baseMint: PublicKey;
+	quoteMint: PublicKey;
+	baseTokenProgram: PublicKey;
+	quoteTokenProgram: PublicKey;
+	observationKey: PublicKey;
+	authBump: number;
+	lpMintDecimals: number;
+	baseDecimals: number;
+	quoteDecimals: number;
+	lpSupply: BN;
+	recentEpoch: BN;
+	creator: PublicKey;
+}
+
+/** Oracle observation entry */
+export interface Observation {
+	blockTimestamp: BN;
+	cumulativeBasePriceX32: BN;
+	cumulativeQuotePriceX32: BN;
+}
+
+/** Oracle observation state */
+export interface ObservationState {
+	initialized: boolean;
+	observationIndex: number;
+	poolId: PublicKey;
+	observations: Observation[];
+	lastUpdateTimestamp: BN;
+}
+
+/** Fee recipient with basis point allocation */
+export interface FeeRecipient {
+	pubkey: PublicKey;
+	basisPoints: number;
+}
+
+/** Unified fee configuration for a token */
+export interface UnifiedFeeConfiguration {
+	creator: PublicKey;
+	tokenMint: PublicKey;
+	feeMode: FeeModeAnchor;
+	recipientsCount: number;
+	recipients: FeeRecipient[];
+	updateAuthority: PublicKey;
+	locked: boolean;
+	bump: number;
+}
+
+/** Referrer information attached to a user */
+export interface ReferrerInfo {
+	referrer: PublicKey;
+	deal: PublicKey | null;
+	cashbackMultiplierBps: number;
+}
+
+/** User properties account */
+export interface UserProperties {
+	referrer: ReferrerInfo | null;
+	totalSolVolume: BN;
+	totalTokenVolume: BN;
+	cashbackCredits: BN;
+	isSpending: boolean;
+	curveSolVolume: BN;
+	ammSolVolume: BN;
+	snapshotSolVolume: BN;
+	snapshotTokenVolume: BN;
+	snapshotCount: number;
+	latestSnapshot: PublicKey | null;
+}
+
+/** User volume snapshot account */
+export interface UserSnapshot {
+	user: PublicKey;
+	index: number;
+	prevSnapshot: PublicKey | null;
+	solVolume: BN;
+	tokenVolume: BN;
+	createdAt: BN;
+}
+
+/** Exclusive deal for a referrer/influencer */
+export interface Deal {
+	owner: PublicKey;
+	cashbackMultiplierBps: number;
+	redemptionCount: number;
+}
+
+/** Arguments for admin_update_user instruction */
+export interface AdminUpdateUserArgs {
+	newReferrer: PublicKey | null;
+	newCashbackMultiplierBps: number | null;
+}
+
+/** Per-token volume accumulator */
+export interface TokenVolumeAccumulator {
+	mint: PublicKey;
+	totalSolVolume: BN;
+	totalTokenVolume: BN;
+	curveSolVolume: BN;
+	ammSolVolume: BN;
+}
+
+/** Global curve volume accumulator */
+export interface GlobalCurveVolume {
+	totalSolVolume: BN;
+	totalTokenVolume: BN;
+}
+
+/** Global AMM volume accumulator */
+export interface GlobalAmmVolume {
+	totalSolVolume: BN;
+	totalTokenVolume: BN;
+}
+
+/** Cashback range tier */
+export interface CashbackRange {
+	rangeStartInclusive: BN;
+	rangeEndExclusive: BN;
+	multiplierBasisPoints: number;
+}
+
+/** Cashback configuration */
+export interface CashbackConfiguration {
+	adminAuthority: PublicKey;
+	rangesCount: number;
+	ranges: CashbackRange[];
+	traderCashbackBasisPoints: number;
+}
+
+/** Fee breakdown from a trade */
+export interface FeeDistribution {
+	protocolFee: BN;
+	creatorFee: BN;
+	creatorReferralFee: BN;
+	traderReferralFee: BN;
+	totalFees: BN;
+}
+
+/** Buy calculation result for bonding curve */
+export interface BondingCurveBuyResult extends FeeDistribution {
+	tokensOut: BN;
+	newVirtualQuote: BN;
+	newVirtualToken: BN;
+	amountInNet: BN;
+}
+
+/** Sell calculation result for bonding curve */
+export interface BondingCurveSellResult extends FeeDistribution {
+	quoteOutGross: BN;
+	quoteOutNet: BN;
+	newVirtualQuote: BN;
+	newVirtualToken: BN;
+}
+
+/** AMM swap fees breakdown */
+export interface SwapFees {
+	lpFee: BN;
+	creatorFee: BN;
+	protocolFee: BN;
+	totalFees: BN;
+}
+
+/** AMM sell output calculation */
+export interface AmmSellOutput extends SwapFees {
+	quoteOut: BN;
+	quoteOutNet: BN;
+}
+
+/** AMM buy input calculation */
+export interface AmmBuyInput extends SwapFees {
+	quoteIn: BN;
+	quoteInGross: BN;
+}
+
+/** LP token to trading token conversion */
+export interface LpTokenAmounts {
+	baseAmount: BN;
+	quoteAmount: BN;
+}
+
+/** Fee distribution result for multi-recipient */
+export interface DistributionResult {
+	pubkey: PublicKey;
+	amount: number;
+}
+
+/** Convenience type aggregating pool state with derived addresses */
+export interface PoolInfo {
+	poolAddress: PublicKey;
+	poolState: PoolState;
+	baseMint: PublicKey;
+	quoteMint: PublicKey;
+	baseTokenProgram: PublicKey;
+	quoteTokenProgram: PublicKey;
+	baseVault: PublicKey;
+	quoteVault: PublicKey;
+	lpMint: PublicKey;
+	creator: PublicKey;
+}
+
+/** Preview result for buying on the bonding curve */
+export interface BuyCurvePreview {
+	tokensOut: BN;
+	fees: FeeDistribution;
+	priceImpactBps: number;
+	newReserves: { virtualQuote: BN; virtualToken: BN };
+	willComplete: boolean;
+}
+
+/** Preview result for selling on the bonding curve */
+export interface SellCurvePreview {
+	quoteOut: BN;
+	quoteOutNet: BN;
+	fees: FeeDistribution;
+	priceImpactBps: number;
+	newReserves: { virtualQuote: BN; virtualToken: BN };
+}
+
+/** Preview result for AMM swaps */
+export interface SwapPreview {
+	amountOut: BN;
+	amountOutNet: BN;
+	fees: SwapFees;
+	priceImpactBps: number;
+}