@liquid-af/sdk 0.1.0

package/dist/instructions/liquid.d.ts

@@ -0,0 +1,297 @@
+import type { Connection, PublicKey, TransactionInstruction } from "@solana/web3.js";
+import type BN from "bn.js";
+import { type LiquidConfig } from "../config.js";
+export interface BuildCreateNativeCurveParams {
+    creator: PublicKey;
+    mint: PublicKey;
+    pythPriceFeed: PublicKey;
+    name: string;
+    symbol: string;
+    uri: string;
+    config: LiquidConfig;
+}
+/**
+ * Builds a createNativeCurve instruction.
+ * The mint Keypair must be passed as a signer when sending the transaction.
+ * Atomically initializes the fee configuration via CPI to liquid-fees
+ * with the creator as the sole recipient (100%). Use `buildUpdateFeeConfig`
+ * to set custom recipients afterward.
+ *
+ * @param params - {@link BuildCreateNativeCurveParams}
+ * @returns Transaction instruction
+ */
+export declare function buildCreateNativeCurve(params: BuildCreateNativeCurveParams): Promise<TransactionInstruction>;
+export interface BuildBumpNativeParams {
+    mint: PublicKey;
+    pythPriceFeed: PublicKey;
+    config: LiquidConfig;
+}
+/**
+ * Builds a bumpNative instruction.
+ * Re-evaluates a native bonding curve's market cap against the current oracle price
+ * and marks it as complete if the threshold is exceeded. Permissionless.
+ *
+ * @param params - {@link BuildBumpNativeParams}
+ * @returns Transaction instruction
+ */
+export declare function buildBumpNative(params: BuildBumpNativeParams): Promise<TransactionInstruction>;
+export interface BuildBuyNativeParams {
+    user: PublicKey;
+    mint: PublicKey;
+    creator: PublicKey;
+    pythPriceFeed: PublicKey;
+    amountIn: BN;
+    minAmountOut: BN;
+    feeRecipient: PublicKey;
+    creatorReferralVault?: PublicKey | null;
+    traderReferralVault?: PublicKey | null;
+    config: LiquidConfig;
+}
+/**
+ * Builds a buyNative instruction.
+ * Requires the bonding curve creator and Pyth price feed to be known.
+ *
+ * @param params - {@link BuildBuyNativeParams}
+ * @returns Transaction instruction
+ */
+export declare function buildBuyNative(params: BuildBuyNativeParams): Promise<TransactionInstruction>;
+/**
+ * Builds a buyNative instruction, automatically fetching the bonding curve
+ * creator from chain. Convenience wrapper around `buildBuyNative`.
+ *
+ * @param connection - Solana RPC connection
+ * @param params - {@link BuildBuyNativeParams} without `creator`
+ * @returns Transaction instruction
+ */
+export declare function buildBuyNativeAutoResolve(connection: Connection, params: Omit<BuildBuyNativeParams, "creator">): Promise<TransactionInstruction>;
+export interface BuildSellNativeParams {
+    user: PublicKey;
+    mint: PublicKey;
+    creator: PublicKey;
+    pythPriceFeed: PublicKey;
+    amountIn: BN;
+    minAmountOut: BN;
+    feeRecipient: PublicKey;
+    creatorReferralVault?: PublicKey | null;
+    traderReferralVault?: PublicKey | null;
+    config: LiquidConfig;
+}
+/**
+ * Builds a sellNative instruction.
+ * Requires the bonding curve creator and Pyth price feed to be known.
+ *
+ * @param params - {@link BuildSellNativeParams}
+ * @returns Transaction instruction
+ */
+export declare function buildSellNative(params: BuildSellNativeParams): Promise<TransactionInstruction>;
+/**
+ * Builds a sellNative instruction, automatically fetching the bonding curve
+ * creator from chain. Convenience wrapper around `buildSellNative`.
+ *
+ * @param connection - Solana RPC connection
+ * @param params - {@link BuildSellNativeParams} without `creator`
+ * @returns Transaction instruction
+ */
+export declare function buildSellNativeAutoResolve(connection: Connection, params: Omit<BuildSellNativeParams, "creator">): Promise<TransactionInstruction>;
+export interface BuildMigrateNativeParams {
+    migrator: PublicKey;
+    mint: PublicKey;
+    config: LiquidConfig;
+}
+/**
+ * Builds a migrate instruction (bonding curve -> AMM pool).
+ * Permissionless — anyone can trigger migration once the curve is complete.
+ *
+ * @param params - {@link BuildMigrateNativeParams}
+ * @returns Transaction instruction
+ */
+export declare function buildMigrateNative(params: BuildMigrateNativeParams): Promise<TransactionInstruction>;
+export interface BuildInitializeNativeReferralVaultParams {
+    user: PublicKey;
+    config: LiquidConfig;
+}
+/**
+ * Builds an initializeNativeReferralVault instruction (creates native SOL referral vault).
+ *
+ * @param params - {@link BuildInitializeNativeReferralVaultParams}
+ * @returns Transaction instruction
+ */
+export declare function buildInitializeNativeReferralVault(params: BuildInitializeNativeReferralVaultParams): Promise<TransactionInstruction>;
+export interface BuildWithdrawReferralRewardsParams {
+    user: PublicKey;
+    config: LiquidConfig;
+}
+/**
+ * Builds a withdrawReferralRewards instruction.
+ *
+ * @param params - {@link BuildWithdrawReferralRewardsParams}
+ * @returns Transaction instruction
+ */
+export declare function buildWithdrawReferralRewards(params: BuildWithdrawReferralRewardsParams): Promise<TransactionInstruction>;
+export interface BuildExecuteBuybackNativeParams {
+    payer: PublicKey;
+    mint: PublicKey;
+    pythPriceFeed: PublicKey;
+    config: LiquidConfig;
+}
+/**
+ * Builds an executeBuybackNative instruction for a native SOL bonding curve.
+ * Permissionless — anyone can trigger. Only works when fee config is Revoked.
+ *
+ * @param params - {@link BuildExecuteBuybackNativeParams}
+ * @returns Transaction instruction
+ */
+export declare function buildExecuteBuybackNative(params: BuildExecuteBuybackNativeParams): Promise<TransactionInstruction>;
+export interface BuildExecuteBuybackTokenParams {
+    payer: PublicKey;
+    mint: PublicKey;
+    quoteMint: PublicKey;
+    config: LiquidConfig;
+}
+/**
+ * Builds an executeBuybackToken instruction for a token-based bonding curve.
+ * Permissionless — anyone can trigger. Only works when fee config is Revoked.
+ *
+ * @param params - {@link BuildExecuteBuybackTokenParams}
+ * @returns Transaction instruction
+ */
+export declare function buildExecuteBuybackToken(params: BuildExecuteBuybackTokenParams): Promise<TransactionInstruction>;
+export interface BuildCreateStableCurveParams {
+    creator: PublicKey;
+    mint: PublicKey;
+    quoteMint: PublicKey;
+    name: string;
+    symbol: string;
+    uri: string;
+    config: LiquidConfig;
+}
+/**
+ * Builds a createStableCurve instruction.
+ * Creates a token-based bonding curve (e.g., using USDC as quote).
+ * The mint Keypair must be passed as a signer when sending the transaction.
+ * Atomically initializes the fee configuration via CPI to liquid-fees
+ * with the creator as the sole recipient (100%). Use `buildUpdateFeeConfig`
+ * to set custom recipients afterward.
+ *
+ * @param params - {@link BuildCreateStableCurveParams}
+ * @returns Transaction instruction
+ */
+export declare function buildCreateStableCurve(params: BuildCreateStableCurveParams): Promise<TransactionInstruction>;
+export interface BuildBuyStableParams {
+    user: PublicKey;
+    mint: PublicKey;
+    quoteMint: PublicKey;
+    creator: PublicKey;
+    amountIn: BN;
+    minAmountOut: BN;
+    feeRecipient: PublicKey;
+    creatorReferralVault?: PublicKey | null;
+    traderReferralVault?: PublicKey | null;
+    config: LiquidConfig;
+}
+/**
+ * Builds a buyStable instruction.
+ * Buys tokens from a token-based bonding curve using quote tokens (e.g., USDC).
+ *
+ * @param params - {@link BuildBuyStableParams}
+ * @returns Transaction instruction
+ */
+export declare function buildBuyStable(params: BuildBuyStableParams): Promise<TransactionInstruction>;
+/**
+ * Builds a buyStable instruction, automatically fetching the bonding curve
+ * creator from chain. Convenience wrapper around `buildBuyStable`.
+ *
+ * @param connection - Solana RPC connection
+ * @param params - {@link BuildBuyStableParams} without `creator`
+ * @returns Transaction instruction
+ */
+export declare function buildBuyStableAutoResolve(connection: Connection, params: Omit<BuildBuyStableParams, "creator">): Promise<TransactionInstruction>;
+export interface BuildSellStableParams {
+    user: PublicKey;
+    mint: PublicKey;
+    quoteMint: PublicKey;
+    creator: PublicKey;
+    amountIn: BN;
+    minAmountOut: BN;
+    feeRecipient: PublicKey;
+    creatorReferralVault?: PublicKey | null;
+    traderReferralVault?: PublicKey | null;
+    config: LiquidConfig;
+}
+/**
+ * Builds a sellStable instruction.
+ * Sells tokens to a token-based bonding curve for quote tokens (e.g., USDC).
+ *
+ * @param params - {@link BuildSellStableParams}
+ * @returns Transaction instruction
+ */
+export declare function buildSellStable(params: BuildSellStableParams): Promise<TransactionInstruction>;
+/**
+ * Builds a sellStable instruction, automatically fetching the bonding curve
+ * creator from chain. Convenience wrapper around `buildSellStable`.
+ *
+ * @param connection - Solana RPC connection
+ * @param params - {@link BuildSellStableParams} without `creator`
+ * @returns Transaction instruction
+ */
+export declare function buildSellStableAutoResolve(connection: Connection, params: Omit<BuildSellStableParams, "creator">): Promise<TransactionInstruction>;
+export interface BuildMigrateStableParams {
+    migrator: PublicKey;
+    mint: PublicKey;
+    quoteMint: PublicKey;
+    config: LiquidConfig;
+}
+/**
+ * Builds a migrateStable instruction (token bonding curve -> AMM pool).
+ * Permissionless — anyone can trigger migration once the curve is complete.
+ *
+ * @param params - {@link BuildMigrateStableParams}
+ * @returns Transaction instruction
+ */
+export declare function buildMigrateStable(params: BuildMigrateStableParams): Promise<TransactionInstruction>;
+export interface BuildSetFeeRecipientsParams {
+    admin: PublicKey;
+    /** Array of 8 fee recipient pubkeys */
+    feeRecipients: PublicKey[];
+    config: LiquidConfig;
+}
+/**
+ * Builds a setFeeRecipients instruction.
+ * Admin-only instruction to set/update the protocol fee recipients.
+ *
+ * @param params - {@link BuildSetFeeRecipientsParams}
+ * @returns Transaction instruction
+ */
+export declare function buildSetFeeRecipients(params: BuildSetFeeRecipientsParams): Promise<TransactionInstruction>;
+export interface BuildInitializeFeeRecipientVaultsParams {
+    payer: PublicKey;
+    quoteMint: PublicKey;
+    /** Array of 8 fee recipient pubkeys (must match config) */
+    feeRecipients: PublicKey[];
+    config: LiquidConfig;
+}
+/**
+ * Builds an initializeFeeRecipientVaults instruction.
+ * Permissionless instruction to create token accounts for all fee recipients
+ * for a given quote mint. Call this before trading stable curves.
+ *
+ * @param params - {@link BuildInitializeFeeRecipientVaultsParams}
+ * @returns Transaction instruction
+ */
+export declare function buildInitializeFeeRecipientVaults(params: BuildInitializeFeeRecipientVaultsParams): Promise<TransactionInstruction>;
+export interface BuildInitializeReferralTokenVaultParams {
+    user: PublicKey;
+    quoteMint: PublicKey;
+    config: LiquidConfig;
+}
+/**
+ * Builds an initializeReferralTokenVault instruction.
+ * Creates a referral token vault (ATA) for the user for a specific quote mint.
+ * Users must call this for each quote mint they want to receive referral rewards for.
+ * If not initialized, referral fees will be redirected to protocol fees.
+ *
+ * @param params - {@link BuildInitializeReferralTokenVaultParams}
+ * @returns Transaction instruction
+ */
+export declare function buildInitializeReferralTokenVault(params: BuildInitializeReferralTokenVaultParams): Promise<TransactionInstruction>;
+//# sourceMappingURL=liquid.d.ts.map

package/dist/instructions/liquid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liquid.d.ts","sourceRoot":"","sources":["../../src/instructions/liquid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,UAAU,EACV,SAAS,EACT,sBAAsB,EACtB,MAAM,iBAAiB,CAAC;AAKzB,OAAO,KAAK,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAa,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC;AAqB5D,MAAM,WAAW,4BAA4B;IAC5C,OAAO,EAAE,SAAS,CAAC;IACnB,IAAI,EAAE,SAAS,CAAC;IAChB,aAAa,EAAE,SAAS,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACrC,MAAM,EAAE,4BAA4B,GAClC,OAAO,CAAC,sBAAsB,CAAC,CAqBjC;AAED,MAAM,WAAW,qBAAqB;IACrC,IAAI,EAAE,SAAS,CAAC;IAChB,aAAa,EAAE,SAAS,CAAC;IACzB,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC9B,MAAM,EAAE,qBAAqB,GAC3B,OAAO,CAAC,sBAAsB,CAAC,CAWjC;AAED,MAAM,WAAW,oBAAoB;IACpC,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,SAAS,CAAC;IACnB,aAAa,EAAE,SAAS,CAAC;IACzB,QAAQ,EAAE,EAAE,CAAC;IACb,YAAY,EAAE,EAAE,CAAC;IACjB,YAAY,EAAE,SAAS,CAAC;IACxB,oBAAoB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACxC,mBAAmB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACvC,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC7B,MAAM,EAAE,oBAAoB,GAC1B,OAAO,CAAC,sBAAsB,CAAC,CAsCjC;AAED;;;;;;;GAOG;AACH,wBAAsB,yBAAyB,CAC9C,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,GAC3C,OAAO,CAAC,sBAAsB,CAAC,CAWjC;AAED,MAAM,WAAW,qBAAqB;IACrC,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,SAAS,CAAC;IACnB,aAAa,EAAE,SAAS,CAAC;IACzB,QAAQ,EAAE,EAAE,CAAC;IACb,YAAY,EAAE,EAAE,CAAC;IACjB,YAAY,EAAE,SAAS,CAAC;IACxB,oBAAoB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACxC,mBAAmB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACvC,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC9B,MAAM,EAAE,qBAAqB,GAC3B,OAAO,CAAC,sBAAsB,CAAC,CAsCjC;AAED;;;;;;;GAOG;AACH,wBAAsB,0BAA0B,CAC/C,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,IAAI,CAAC,qBAAqB,EAAE,SAAS,CAAC,GAC5C,OAAO,CAAC,sBAAsB,CAAC,CAWjC;AAED,MAAM,WAAW,wBAAwB;IACxC,QAAQ,EAAE,SAAS,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,EAAE,wBAAwB,GAC9B,OAAO,CAAC,sBAAsB,CAAC,CA8DjC;AAED,MAAM,WAAW,wCAAwC;IACxD,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;GAKG;AACH,wBAAgB,kCAAkC,CACjD,MAAM,EAAE,wCAAwC,GAC9C,OAAO,CAAC,sBAAsB,CAAC,CAQjC;AAED,MAAM,WAAW,kCAAkC;IAClD,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAC3C,MAAM,EAAE,kCAAkC,GACxC,OAAO,CAAC,sBAAsB,CAAC,CAQjC;AAED,MAAM,WAAW,+BAA+B;IAC/C,KAAK,EAAE,SAAS,CAAC;IACjB,IAAI,EAAE,SAAS,CAAC;IAChB,aAAa,EAAE,SAAS,CAAC;IACzB,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACxC,MAAM,EAAE,+BAA+B,GACrC,OAAO,CAAC,sBAAsB,CAAC,CAYjC;AAED,MAAM,WAAW,8BAA8B;IAC9C,KAAK,EAAE,SAAS,CAAC;IACjB,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACvC,MAAM,EAAE,8BAA8B,GACpC,OAAO,CAAC,sBAAsB,CAAC,CAYjC;AAED,MAAM,WAAW,4BAA4B;IAC5C,OAAO,EAAE,SAAS,CAAC;IACnB,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CACrC,MAAM,EAAE,4BAA4B,GAClC,OAAO,CAAC,sBAAsB,CAAC,CAgBjC;AAED,MAAM,WAAW,oBAAoB;IACpC,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,EAAE,SAAS,CAAC;IACnB,QAAQ,EAAE,EAAE,CAAC;IACb,YAAY,EAAE,EAAE,CAAC;IACjB,YAAY,EAAE,SAAS,CAAC;IACxB,oBAAoB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACxC,mBAAmB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACvC,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC7B,MAAM,EAAE,oBAAoB,GAC1B,OAAO,CAAC,sBAAsB,CAAC,CA8CjC;AAED;;;;;;;GAOG;AACH,wBAAsB,yBAAyB,CAC9C,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,GAC3C,OAAO,CAAC,sBAAsB,CAAC,CAQjC;AAED,MAAM,WAAW,qBAAqB;IACrC,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,EAAE,SAAS,CAAC;IACnB,QAAQ,EAAE,EAAE,CAAC;IACb,YAAY,EAAE,EAAE,CAAC;IACjB,YAAY,EAAE,SAAS,CAAC;IACxB,oBAAoB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACxC,mBAAmB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACvC,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC9B,MAAM,EAAE,qBAAqB,GAC3B,OAAO,CAAC,sBAAsB,CAAC,CA8CjC;AAED;;;;;;;GAOG;AACH,wBAAsB,0BAA0B,CAC/C,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,IAAI,CAAC,qBAAqB,EAAE,SAAS,CAAC,GAC5C,OAAO,CAAC,sBAAsB,CAAC,CAQjC;AAED,MAAM,WAAW,wBAAwB;IACxC,QAAQ,EAAE,SAAS,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,EAAE,wBAAwB,GAC9B,OAAO,CAAC,sBAAsB,CAAC,CAmEjC;AAED,MAAM,WAAW,2BAA2B;IAC3C,KAAK,EAAE,SAAS,CAAC;IACjB,uCAAuC;IACvC,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACpC,MAAM,EAAE,2BAA2B,GACjC,OAAO,CAAC,sBAAsB,CAAC,CAuBjC;AAED,MAAM,WAAW,uCAAuC;IACvD,KAAK,EAAE,SAAS,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;IACrB,2DAA2D;IAC3D,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,wBAAgB,iCAAiC,CAChD,MAAM,EAAE,uCAAuC,GAC7C,OAAO,CAAC,sBAAsB,CAAC,CAwBjC;AAED,MAAM,WAAW,uCAAuC;IACvD,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iCAAiC,CAChD,MAAM,EAAE,uCAAuC,GAC7C,OAAO,CAAC,sBAAsB,CAAC,CAWjC"}