@liquid-af/sdk 0.1.0

package/src/instructions/liquid-swap.ts

@@ -0,0 +1,414 @@
+import type { PublicKey, TransactionInstruction } from "@solana/web3.js";
+import {
+	getAssociatedTokenAddressSync,
+	TOKEN_PROGRAM_ID,
+} from "@solana/spl-token";
+import type BN from "bn.js";
+import type { LiquidConfig } from "../config.js";
+import { getCachedSwapProgram } from "./program-cache.js";
+
+export interface BuildCreatePoolParams {
+	signer: PublicKey;
+	payer?: PublicKey;
+	baseMint: PublicKey;
+	quoteMint: PublicKey;
+	baseTokenProgram: PublicKey;
+	quoteTokenProgram: PublicKey;
+	initAmountBase: BN;
+	initAmountQuote: BN;
+	config: LiquidConfig;
+}
+
+/**
+ * Builds a create pool instruction.
+ *
+ * @param params - {@link BuildCreatePoolParams}
+ * @returns Transaction instruction
+ */
+export function buildCreatePool(
+	params: BuildCreatePoolParams
+): Promise<TransactionInstruction> {
+	const {
+		signer,
+		payer,
+		baseMint,
+		quoteMint,
+		baseTokenProgram,
+		quoteTokenProgram,
+		initAmountBase,
+		initAmountQuote,
+		config,
+	} = params;
+
+	const program = getCachedSwapProgram(config);
+
+	const creatorBase = getAssociatedTokenAddressSync(
+		baseMint,
+		signer,
+		false,
+		baseTokenProgram
+	);
+	const creatorQuote = getAssociatedTokenAddressSync(
+		quoteMint,
+		signer,
+		false,
+		quoteTokenProgram
+	);
+
+	return program.methods
+		.create(initAmountBase, initAmountQuote, null)
+		.accounts({
+			signer,
+			payer: payer ?? signer,
+			baseMint,
+			quoteMint,
+			creatorBase,
+			creatorQuote,
+			baseTokenProgram,
+			quoteTokenProgram,
+		})
+		.instruction();
+}
+
+export interface BuildSwapBuyParams {
+	payer: PublicKey;
+	creator: PublicKey;
+	baseMint: PublicKey;
+	quoteMint: PublicKey;
+	baseTokenProgram: PublicKey;
+	quoteTokenProgram: PublicKey;
+	maxAmountIn: BN;
+	amountOut: BN;
+	feeRecipient: PublicKey;
+	oraclePriceFeed?: PublicKey;
+	config: LiquidConfig;
+}
+
+/**
+ * Builds a buy swap instruction (quote -> base).
+ *
+ * @param params - {@link BuildSwapBuyParams}
+ * @returns Transaction instruction
+ */
+export function buildSwapBuy(
+	params: BuildSwapBuyParams
+): Promise<TransactionInstruction> {
+	const {
+		payer,
+		creator,
+		baseMint,
+		quoteMint,
+		baseTokenProgram,
+		quoteTokenProgram,
+		maxAmountIn,
+		amountOut,
+		feeRecipient,
+		oraclePriceFeed,
+		config,
+	} = params;
+
+	const program = getCachedSwapProgram(config);
+
+	const baseTokenAccount = getAssociatedTokenAddressSync(
+		baseMint,
+		payer,
+		false,
+		baseTokenProgram
+	);
+	const quoteTokenAccount = getAssociatedTokenAddressSync(
+		quoteMint,
+		payer,
+		false,
+		quoteTokenProgram
+	);
+	return program.methods
+		.buy(maxAmountIn, amountOut)
+		.accountsPartial({
+			payer,
+			creator,
+			baseTokenAccount,
+			quoteTokenAccount,
+			baseTokenProgram,
+			quoteTokenProgram,
+			baseMint,
+			quoteMint,
+			feeRecipient,
+			liquidState: {
+				user: payer,
+				tokenMint: baseMint,
+			},
+			...(oraclePriceFeed ? { oraclePriceFeed } : {}),
+		})
+		.instruction();
+}
+
+export interface BuildSwapSellParams {
+	payer: PublicKey;
+	creator: PublicKey;
+	baseMint: PublicKey;
+	quoteMint: PublicKey;
+	baseTokenProgram: PublicKey;
+	quoteTokenProgram: PublicKey;
+	amountIn: BN;
+	minimumAmountOut: BN;
+	feeRecipient: PublicKey;
+	oraclePriceFeed?: PublicKey;
+	config: LiquidConfig;
+}
+
+/**
+ * Builds a sell swap instruction (base -> quote).
+ *
+ * @param params - {@link BuildSwapSellParams}
+ * @returns Transaction instruction
+ */
+export function buildSwapSell(
+	params: BuildSwapSellParams
+): Promise<TransactionInstruction> {
+	const {
+		payer,
+		creator,
+		baseMint,
+		quoteMint,
+		baseTokenProgram,
+		quoteTokenProgram,
+		amountIn,
+		minimumAmountOut,
+		feeRecipient,
+		oraclePriceFeed,
+		config,
+	} = params;
+
+	const program = getCachedSwapProgram(config);
+
+	const baseTokenAccount = getAssociatedTokenAddressSync(
+		baseMint,
+		payer,
+		false,
+		baseTokenProgram
+	);
+	const quoteTokenAccount = getAssociatedTokenAddressSync(
+		quoteMint,
+		payer,
+		false,
+		quoteTokenProgram
+	);
+	return program.methods
+		.sell(amountIn, minimumAmountOut)
+		.accountsPartial({
+			payer,
+			creator,
+			baseTokenAccount,
+			quoteTokenAccount,
+			baseTokenProgram,
+			quoteTokenProgram,
+			baseMint,
+			quoteMint,
+			feeRecipient,
+			liquidState: {
+				user: payer,
+				tokenMint: baseMint,
+			},
+			...(oraclePriceFeed ? { oraclePriceFeed } : {}),
+		})
+		.instruction();
+}
+
+export interface BuildDepositParams {
+	owner: PublicKey;
+	poolAddress: PublicKey;
+	baseMint: PublicKey;
+	quoteMint: PublicKey;
+	baseTokenProgram: PublicKey;
+	quoteTokenProgram: PublicKey;
+	baseVault: PublicKey;
+	quoteVault: PublicKey;
+	lpMint: PublicKey;
+	lpTokenAmount: BN;
+	maximumBaseAmount: BN;
+	maximumQuoteAmount: BN;
+	config: LiquidConfig;
+}
+
+/**
+ * Builds a deposit (add liquidity) instruction.
+ *
+ * @param params - {@link BuildDepositParams}
+ * @returns Transaction instruction
+ */
+export function buildDeposit(
+	params: BuildDepositParams
+): Promise<TransactionInstruction> {
+	const {
+		owner,
+		poolAddress,
+		baseMint,
+		quoteMint,
+		baseTokenProgram,
+		quoteTokenProgram,
+		baseVault,
+		quoteVault,
+		lpMint,
+		lpTokenAmount,
+		maximumBaseAmount,
+		maximumQuoteAmount,
+		config,
+	} = params;
+
+	const program = getCachedSwapProgram(config);
+
+	const ownerLpToken = getAssociatedTokenAddressSync(
+		lpMint,
+		owner,
+		false,
+		TOKEN_PROGRAM_ID
+	);
+	const baseAccount = getAssociatedTokenAddressSync(
+		baseMint,
+		owner,
+		false,
+		baseTokenProgram
+	);
+	const quoteAccount = getAssociatedTokenAddressSync(
+		quoteMint,
+		owner,
+		false,
+		quoteTokenProgram
+	);
+
+	return program.methods
+		.deposit(lpTokenAmount, maximumBaseAmount, maximumQuoteAmount)
+		.accounts({
+			owner,
+			poolState: poolAddress,
+			ownerLpToken,
+			baseAccount,
+			quoteAccount,
+			baseMint,
+			quoteMint,
+			baseVault,
+			quoteVault,
+			lpMint,
+		})
+		.instruction();
+}
+
+export interface BuildWithdrawParams {
+	owner: PublicKey;
+	poolAddress: PublicKey;
+	baseMint: PublicKey;
+	quoteMint: PublicKey;
+	baseTokenProgram: PublicKey;
+	quoteTokenProgram: PublicKey;
+	baseVault: PublicKey;
+	quoteVault: PublicKey;
+	lpMint: PublicKey;
+	lpTokenAmount: BN;
+	minimumBaseAmount: BN;
+	minimumQuoteAmount: BN;
+	config: LiquidConfig;
+}
+
+/**
+ * Builds a withdraw (remove liquidity) instruction.
+ *
+ * @param params - {@link BuildWithdrawParams}
+ * @returns Transaction instruction
+ */
+export function buildWithdraw(
+	params: BuildWithdrawParams
+): Promise<TransactionInstruction> {
+	const {
+		owner,
+		poolAddress,
+		baseMint,
+		quoteMint,
+		baseTokenProgram,
+		quoteTokenProgram,
+		baseVault,
+		quoteVault,
+		lpMint,
+		lpTokenAmount,
+		minimumBaseAmount,
+		minimumQuoteAmount,
+		config,
+	} = params;
+
+	const program = getCachedSwapProgram(config);
+
+	const ownerLpToken = getAssociatedTokenAddressSync(
+		lpMint,
+		owner,
+		false,
+		TOKEN_PROGRAM_ID
+	);
+	const baseAccount = getAssociatedTokenAddressSync(
+		baseMint,
+		owner,
+		false,
+		baseTokenProgram
+	);
+	const quoteAccount = getAssociatedTokenAddressSync(
+		quoteMint,
+		owner,
+		false,
+		quoteTokenProgram
+	);
+
+	return program.methods
+		.withdraw(lpTokenAmount, minimumBaseAmount, minimumQuoteAmount)
+		.accounts({
+			owner,
+			poolState: poolAddress,
+			ownerLpToken,
+			baseAccount,
+			quoteAccount,
+			baseMint,
+			quoteMint,
+			baseVault,
+			quoteVault,
+			lpMint,
+		})
+		.instruction();
+}
+
+export interface BuildSwapExecuteBuybackParams {
+	payer: PublicKey;
+	baseMint: PublicKey;
+	quoteMint: PublicKey;
+	baseTokenProgram: PublicKey;
+	quoteTokenProgram: PublicKey;
+	config: LiquidConfig;
+}
+
+/**
+ * Builds an executeBuyback instruction for an AMM pool.
+ * Permissionless. Only works when fee config is Revoked.
+ *
+ * @param params - {@link BuildSwapExecuteBuybackParams}
+ * @returns Transaction instruction
+ */
+export function buildSwapExecuteBuyback(
+	params: BuildSwapExecuteBuybackParams
+): Promise<TransactionInstruction> {
+	const {
+		payer,
+		baseMint,
+		quoteMint,
+		baseTokenProgram,
+		quoteTokenProgram,
+		config,
+	} = params;
+	const program = getCachedSwapProgram(config);
+
+	return program.methods
+		.executeBuyback()
+		.accounts({
+			payer,
+			baseMint,
+			quoteMint,
+			baseTokenProgram,
+			quoteTokenProgram,
+		})
+		.instruction();
+}