@meteora-ag/cp-amm-sdk 1.0.1-rc.12 → 1.0.1-rc.14

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Program, IdlAccounts, BN, IdlTypes } from '@coral-xyz/anchor';
-import { PublicKey, Transaction, Connection, TransactionInstruction, AddressLookupTableAccount, Commitment } from '@solana/web3.js';
+import { PublicKey, Transaction, Connection, TransactionInstruction, AddressLookupTableAccount, Commitment, GetProgramAccountsFilter } from '@solana/web3.js';
 
 /**
  * Program IDL in camelCase format in order to be used in JS/TS.
@@ -6177,6 +6177,10 @@ declare enum ActivationType {
     Slot = 0,
     Timestamp = 1
 }
+type FeeMode = {
+    feeOnInput: boolean;
+    feesOnTokenA: boolean;
+};
 type PoolState = IdlAccounts<CpAmm$1>["pool"];
 type PositionState = IdlAccounts<CpAmm$1>["position"];
 type VestingState = IdlAccounts<CpAmm$1>["vesting"];
@@ -6227,8 +6231,6 @@ type InitializeCustomizeablePoolParams = {
 type PreparePoolCreationParams = {
     tokenAAmount: BN;
     tokenBAmount: BN;
-    tokenADecimal: number;
-    tokenBDecimal: number;
 };
 type PreparedPoolCreation = {
     sqrtPriceQ64: BN;
@@ -6243,8 +6245,6 @@ type CreatePoolParams = {
     tokenBMint: PublicKey;
     tokenAAmount: BN;
     tokenBAmount: BN;
-    tokenADecimal: number;
-    tokenBDecimal: number;
     activationPoint: BN | null;
     tokenAProgram: PublicKey;
     tokenBProgram: PublicKey;
@@ -6391,44 +6391,90 @@ type PermanentLockParams = {
     unlockedLiquidity: BN;
 };
 
+/**
+ * CpAmm SDK class to interact with the Dynamic CP-AMM
+ */
 declare class CpAmm {
     _program: AmmProgram;
     constructor(connection: Connection);
+    /**
+     * Returns the Anchor program instance.
+     * @returns The AmmProgram instance.
+     */
     getProgram(): AmmProgram;
     /**
-      Prepares token ordering, calculates the initial sqrtPrice in Q64 format,
-      @private
-      @async
-      @param {PublicKey} tokenX - One token mint address in the pair.
-      @param {PublicKey} tokenY - The other token mint address in the pair.
-      @param {Decimal} initialPrice - The initial price ratio of tokenX/tokenY (will be inverted if needed).
-      @param {Decimal} liquidity - The initial liquidity value.
-      @returns {PreparedPoolCreation} Object containing the ordered token mints and their Q64 price/liquidity values.
-    */
+     * Prepares parameters required for pool creation, including initial sqrt price and liquidity.
+     * @private
+     * @param {PreparePoolCreationParams} params - Initial token amounts for pool creation.
+     * @returns init sqrt price and liquidity in Q64 format.
+     */
     private preparePoolCreationParams;
+    /**
+     * Fetches the Config state of the program.
+     * @param config - Public key of the config account.
+     * @returns Parsed ConfigState.
+     */
     fetchConfigState(config: PublicKey): Promise<ConfigState>;
+    /**
+     * Fetches the Pool state.
+     * @param pool - Public key of the pool.
+     * @returns Parsed PoolState.
+     */
     fetchPoolState(pool: PublicKey): Promise<PoolState>;
+    /**
+     * Fetches the Position state.
+     * @param position - Public key of the position.
+     * @returns Parsed PositionState.
+     */
     fetchPositionState(position: PublicKey): Promise<PositionState>;
+    /**
+     * Retrieves all config accounts.
+     * @returns Array of config public keys and their states.
+     */
     getAllConfigs(): Promise<Array<{
         publicKey: PublicKey;
         account: ConfigState;
     }>>;
+    /**
+     * Retrieves all pool accounts.
+     * @returns Array of pool public keys and their states.
+     */
     getAllPools(): Promise<Array<{
         publicKey: PublicKey;
         account: PoolState;
     }>>;
+    /**
+     * Retrieves all position accounts.
+     * @returns Array of position public keys and their states.
+     */
     getAllPositions(): Promise<Array<{
         publicKey: PublicKey;
         account: PositionState;
     }>>;
+    /**
+     * Gets all positions of a user for a specific pool.
+     * @param pool - Public key of the pool.
+     * @param user - Public key of the user.
+     * @returns List of user positions for the pool.
+     */
     getUserPositionByPool(pool: PublicKey, user: PublicKey): Promise<Array<{
         publicKey: PublicKey;
         account: PositionState;
     }>>;
+    /**
+     * Gets all positions of a user across all pools.
+     * @param user - Public key of the user.
+     * @returns Array of user positions.
+     */
     getPositionsByUser(user: PublicKey): Promise<Array<{
         publicKey: PublicKey;
         account: PositionState;
     }>>;
+    /**
+     * Calculates swap quote based on input amount and pool state.
+     * @param params - Swap parameters including input amount, pool state, slippage, etc.
+     * @returns Swap quote including expected output amount, fee, and price impact.
+     */
     getQuote(params: GetQuoteParams): Promise<{
         swapInAmount: BN;
         swapOutAmount: BN;
@@ -6439,35 +6485,109 @@ declare class CpAmm {
     /**
      * Computes the liquidity delta based on the provided token amounts and pool state.
      *
-     * @param {LiquidityDeltaParams} params - The parameters for liquidity calculation, including:
-     *   - tokenX: The mint address of token X.
-     *   - tokenY: The mint address of token Y.
-     *   - maxAmountX: The maximum amount of token X available.
-     *   - maxAmountY: The maximum amount of token Y available.
-     *   - pool: The address of the liquidity pool.
-     *
+     * @param {LiquidityDeltaParams} params - The parameters for liquidity calculation
      * @returns {Promise<BN>} - The computed liquidity delta in Q64 value.
      */
     getLiquidityDelta(params: LiquidityDeltaParams): Promise<BN>;
+    /**
+     * Builds a transaction to create a permissionless pool.
+     * @param params - Parameters for pool creation.
+     * @returns Transaction builder.
+     */
     createPool(params: CreatePoolParams): TxBuilder;
+    /**
+     * Builds a transaction to create a customizable pool.
+     * @param params - Parameters for customizable pool creation.
+     * @returns Transaction and related addresses.
+     */
     createCustomPool(params: InitializeCustomizeablePoolParams): Promise<{
         tx: Transaction;
         pool: PublicKey;
         position: PublicKey;
     }>;
+    /**
+     * Builds a transaction to create a position.
+     * @param {CreatePositionParams} params - Parameters for position creation.
+     * @returns Transaction builder.
+     */
     createPosition(params: CreatePositionParams): TxBuilder;
+    /**
+     * Builds a transaction to add liquidity to an existing position.
+     * @param {AddLiquidityParams} params - Parameters for adding liquidity.
+     * @returns Transaction builder.
+     */
     addLiquidity(params: AddLiquidityParams): TxBuilder;
+    /**
+     * Builds a transaction to remove liquidity from a position.
+     * @param {RemoveLiquidityParams} params - Parameters for removing liquidity.
+     * @returns Transaction builder.
+     */
     removeLiquidity(params: RemoveLiquidityParams): TxBuilder;
+    /**
+     * Builds a transaction to perform a swap in the pool.
+     * @param {SwapParams} params - Parameters for swapping tokens.
+     * @returns Transaction builder.
+     */
     swap(params: SwapParams): TxBuilder;
+    /**
+     * Builds a transaction to lock a position with vesting schedule.
+     * @param {LockPositionParams} params - Locking parameters.
+     * @returns Transaction builder.
+     */
     lockPosition(params: LockPositionParams): TxBuilder;
+    /**
+     * Builds a transaction to permanently lock a position.
+     * @param {PermanentLockParams} params - Parameters for permanent locking.
+     * @returns Transaction builder.
+     */
     permanentLockPosition(params: PermanentLockParams): TxBuilder;
+    /**
+     * Builds a transaction to refresh vesting status of a position.
+     * @param {RefreshVestingParams} params - Refresh vesting parameters.
+     * @returns Transaction builder.
+     */
     refreshVesting(params: RefreshVestingParams): TxBuilder;
+    /**
+     * Builds a transaction to claim position fee rewards.
+     * @param {ClaimPositionFeeParams} params - Parameters for claiming position fee.
+     * @returns Transaction builder.
+     */
     claimPositionFee(params: ClaimPositionFeeParams): TxBuilder;
+    /**
+     * Builds a transaction to update reward duration.
+     * @param {UpdateRewardDurationParams} params - Parameters including pool and new duration.
+     * @returns Transaction builder.
+     */
     updateRewardDuration(params: UpdateRewardDurationParams): TxBuilder;
+    /**
+     * Builds a transaction to update reward funder address.
+     * @param {UpdateRewardFunderParams} params - Parameters including pool and new funder address.
+     * @returns Transaction builder.
+     */
     updateRewardFunder(params: UpdateRewardFunderParams): TxBuilder;
+    /**
+     * Builds a transaction to fund rewards in a pool.
+     * @param {FundRewardParams} params - Funding parameters.
+     * @returns Transaction builder.
+     */
     fundReward(params: FundRewardParams): TxBuilder;
+    /**
+     * Builds a transaction to withdraw ineligible rewards from a pool.
+     * @param {WithdrawIneligibleRewardParams} params - Parameters for withdrawal.
+     * @returns Transaction builder.
+     */
     withdrawIneligibleReward(params: WithdrawIneligibleRewardParams): TxBuilder;
+    /**
+     * Builds a transaction to claim partner fee rewards.
+     * @param {ClaimPartnerFeeParams} params - Claim parameters including amounts and partner address.
+     * @returns Transaction builder.
+     */
     claimPartnerFee(params: ClaimPartnerFeeParams): TxBuilder;
+    /**
+     * Builds a transaction to claim reward from a position.
+     * @param {ClaimRewardParams} params - Parameters for claiming reward.
+     * @returns Transaction builder.
+     */
     claimReward(params: ClaimRewardParams): TxBuilder;
 }
 
@@ -6490,6 +6610,7 @@ declare const SCALE_OFFSET = 64;
 declare const BASIS_POINT_MAX = 10000;
 declare const MAX_FEE_NUMERATOR = 500000000;
 declare const FEE_DENOMINATOR = 1000000000;
+declare const PRECISION = 1000000;
 declare const MIN_SQRT_PRICE: BN;
 declare const MAX_SQRT_PRICE: BN;
 declare const MIN_CU_BUFFER = 50000;
@@ -6512,20 +6633,32 @@ declare function getFeeNumerator(currentPoint: number, activationPoint: BN, numb
     binStep: BN;
     variableFeeControl: BN;
 }): BN;
+/**
+ *
+ * Calculates the output amount and fees for a swap operation in a concentrated liquidity pool.
+ *
+ * @param inAmount - The input amount of tokens the user is swapping
+ * @param sqrtPrice - The current square root price of the pool
+ * @param liquidity - The current liquidity available in the pool
+ * @param tradeFeeNumerator - The fee numerator used to calculate trading fees
+ * @param aToB - Direction of the swap: true for token A to token B, false for token B to token A
+ * @param collectFeeMode - Determines how fees are collected (0: both tokens, 1: only token B)
+ * @returns Object containing the actual output amount after fees and the total fee amount
+ */
+declare function getSwapAmount(inAmount: BN, sqrtPrice: BN, liquidity: BN, tradeFeeNumerator: BN, aToB: boolean, collectFeeMode: number): {
+    actualOutAmount: BN;
+    totalFee: BN;
+};
 
 declare function getNextSqrtPrice(amount: BN, sqrtPrice: BN, liquidity: BN, aToB: boolean): BN;
 declare function getDeltaAmountA(lowerSqrtPrice: BN, upperSqrtPrice: BN, liquidity: BN, rounding: Rounding): BN;
 declare function getDeltaAmountB(lowerSqrtPrice: BN, upperSqrtPrice: BN, liquidity: BN, rounding: Rounding): BN;
-declare function calculateSwap(inAmount: BN, sqrtPrice: BN, liquidity: BN, tradeFeeNumerator: BN, aToB: boolean, collectFeeMode: number): {
-    amountOutExcludedlpFee: BN;
-    lpFee: BN;
-};
 declare function getLiquidityDeltaFromAmountA(maxAmountA: BN, lowerSqrtPrice: BN, // current sqrt price
 upperSqrtPrice: BN): BN;
 declare function getLiquidityDeltaFromAmountB(maxAmountB: BN, lowerSqrtPrice: BN, // min sqrt price
 upperSqrtPrice: BN): BN;
-declare function getAmountAFromLiquidityDelta(liquidity: BN, currentSqrtPrice: BN): BN;
-declare function getAmountBFromLiquidityDelta(liquidity: BN, currentSqrtPrice: BN): BN;
+declare function getAmountAFromLiquidityDelta(liquidity: BN, currentSqrtPrice: BN): string;
+declare function getAmountBFromLiquidityDelta(liquidity: BN, currentSqrtPrice: BN): string;
 
 declare const getSimulationComputeUnits: (connection: Connection, instructions: Array<TransactionInstruction>, payer: PublicKey, lookupTables: Array<AddressLookupTableAccount> | [], commitment?: Commitment) => Promise<number | null>;
 /**
@@ -6552,27 +6685,35 @@ declare const getEstimatedComputeUnitIxWithBuffer: (connection: Connection, inst
  * It takes an amount and a slippage rate, and returns the maximum amount that can be received with
  * that slippage rate
  * @param {BN} amount - The amount of tokens you want to buy.
- * @param {number} slippageRate - The maximum percentage of slippage you're willing to accept. (Max to 2 decimal place)
+ * @param {number} rate - The maximum percentage of slippage you're willing to accept. (Max to 2 decimal place)
  * @returns The maximum amount of tokens that can be bought with the given amount of ETH, given the
  * slippage rate.
  */
-declare const getMaxAmountWithSlippage: (amount: BN, slippageRate: number) => BN;
+declare const getMaxAmountWithSlippage: (amount: BN, rate: number) => BN;
 /**
  * It takes an amount and a slippage rate, and returns the minimum amount that will be received after
  * slippage
  * @param {BN} amount - The amount of tokens you want to sell.
- * @param {number} slippageRate - The percentage of slippage you're willing to accept. (Max to 2 decimal place)
+ * @param {number} rate - The percentage of slippage you're willing to accept. (Max to 2 decimal place)
  * @returns The minimum amount that can be received after slippage is applied.
  */
-declare const getMinAmountWithSlippage: (amount: BN, slippageRate: number) => BN;
-declare const getPriceImpact: (amount: BN, amountWithoutSlippage: BN) => number;
-declare const getCurrentPrice: (sqrtPrice: BN, tokenADecimal: number, tokenBDecimal: number) => BN;
+declare const getMinAmountWithSlippage: (amount: BN, rate: number) => BN;
+/**
+ * Calculate price impact as a percentage
+ * @param actualAmount Amount after slippage in token units
+ * @param idealAmount Theoretical amount without slippage in token units
+ * @returns Price impact as a percentage (e.g., 1.5 means 1.5%)
+ */
+declare const getPriceImpact: (actualAmount: BN, idealAmount: BN) => number;
+declare const getCurrentPrice: (sqrtPrice: BN, tokenADecimal: number, tokenBDecimal: number) => string;
 declare const getUnClaimReward: (positionState: PositionState) => {
     feeTokenA: BN;
     feeTokenB: BN;
     rewards: BN[];
 };
 
+declare const positionByPoolFilter: (pool: PublicKey) => GetProgramAccountsFilter;
+
 var address = "cpamdpZCGKUy5JxQXB4dcpGPiikHawvSWAd6mEn1sGG";
 var metadata = {
 	name: "cp_amm",
@@ -12732,4 +12873,4 @@ var CpAmmIDL = {
 	types: types
 };
 
-export { ActivationPoint, ActivationType, type AddLiquidityParams, type AmmProgram, BASIS_POINT_MAX, type BaseFee, CP_AMM_PROGRAM_ID, type ClaimPartnerFeeParams, type ClaimPositionFeeParams, type ClaimRewardParams, CollectFeeMode, type ConfigState, CpAmm, type CpAmm$1 as CpAmmTypes, type CreatePoolParams, type CreatePositionParams, type DynamicFee, FEE_DENOMINATOR, FeeSchedulerMode, type FundRewardParams, type GetQuoteParams, type InitializeCustomizeablePoolParams, type InitializeRewardParams, type LiquidityDeltaParams, type LockPositionParams, MAX_CU_BUFFER, MAX_FEE_NUMERATOR, MAX_SQRT_PRICE, MIN_CU_BUFFER, MIN_SQRT_PRICE, type PermanentLockParams, type PoolFeesParams, type PoolState, type PositionState, type PreparePoolCreationParams, type PreparedPoolCreation, type RefreshVestingParams, type RemoveLiquidityParams, type RewardInfo, Rounding, SCALE_OFFSET, type SwapParams, type SwapQuotes, type TokenBadgeState, TradeDirection, type TxBuilder, type UpdateRewardDurationParams, type UpdateRewardFunderParams, type VestingState, type WithdrawIneligibleRewardParams, calculateSwap, CpAmmIDL as default, deriveClaimFeeOperatorAddress, deriveConfigAddress, deriveCustomizablePoolAddress, deriveEventAuthority, derivePoolAddress, derivePoolAuthority, derivePositionAddress, derivePositionNftAccount, deriveRewardVaultAddress, deriveTokenBadgeAddress, deriveTokenVaultAddress, getAmountAFromLiquidityDelta, getAmountBFromLiquidityDelta, getBaseFeeNumerator, getCurrentPrice, getDeltaAmountA, getDeltaAmountB, getDynamicFeeNumerator, getEstimatedComputeUnitIxWithBuffer, getEstimatedComputeUnitUsageWithBuffer, getFeeNumerator, getFirstKey, getLiquidityDeltaFromAmountA, getLiquidityDeltaFromAmountB, getMaxAmountWithSlippage, getMinAmountWithSlippage, getNextSqrtPrice, getNftOwner, getOrCreateATAInstruction, getPriceImpact, getSecondKey, getSimulationComputeUnits, getTokenDecimals, getTokenProgram, getUnClaimReward, unwrapSOLInstruction, wrapSOLInstruction };
+export { ActivationPoint, ActivationType, type AddLiquidityParams, type AmmProgram, BASIS_POINT_MAX, type BaseFee, CP_AMM_PROGRAM_ID, type ClaimPartnerFeeParams, type ClaimPositionFeeParams, type ClaimRewardParams, CollectFeeMode, type ConfigState, CpAmm, type CpAmm$1 as CpAmmTypes, type CreatePoolParams, type CreatePositionParams, type DynamicFee, FEE_DENOMINATOR, type FeeMode, FeeSchedulerMode, type FundRewardParams, type GetQuoteParams, type InitializeCustomizeablePoolParams, type InitializeRewardParams, type LiquidityDeltaParams, type LockPositionParams, MAX_CU_BUFFER, MAX_FEE_NUMERATOR, MAX_SQRT_PRICE, MIN_CU_BUFFER, MIN_SQRT_PRICE, PRECISION, type PermanentLockParams, type PoolFeesParams, type PoolState, type PositionState, type PreparePoolCreationParams, type PreparedPoolCreation, type RefreshVestingParams, type RemoveLiquidityParams, type RewardInfo, Rounding, SCALE_OFFSET, type SwapParams, type SwapQuotes, type TokenBadgeState, TradeDirection, type TxBuilder, type UpdateRewardDurationParams, type UpdateRewardFunderParams, type VestingState, type WithdrawIneligibleRewardParams, CpAmmIDL as default, deriveClaimFeeOperatorAddress, deriveConfigAddress, deriveCustomizablePoolAddress, deriveEventAuthority, derivePoolAddress, derivePoolAuthority, derivePositionAddress, derivePositionNftAccount, deriveRewardVaultAddress, deriveTokenBadgeAddress, deriveTokenVaultAddress, getAmountAFromLiquidityDelta, getAmountBFromLiquidityDelta, getBaseFeeNumerator, getCurrentPrice, getDeltaAmountA, getDeltaAmountB, getDynamicFeeNumerator, getEstimatedComputeUnitIxWithBuffer, getEstimatedComputeUnitUsageWithBuffer, getFeeNumerator, getFirstKey, getLiquidityDeltaFromAmountA, getLiquidityDeltaFromAmountB, getMaxAmountWithSlippage, getMinAmountWithSlippage, getNextSqrtPrice, getNftOwner, getOrCreateATAInstruction, getPriceImpact, getSecondKey, getSimulationComputeUnits, getSwapAmount, getTokenDecimals, getTokenProgram, getUnClaimReward, positionByPoolFilter, unwrapSOLInstruction, wrapSOLInstruction };