@meteora-ag/cp-amm-sdk 1.2.2 → 1.2.3

package/dist/index.mjs

@@ -7952,7 +7952,7 @@ var getSqrtPriceFromPrice = (price, tokenADecimal, tokenBDecimal) => {
   const sqrtValueQ64 = sqrtValue.mul(Decimal.pow(2, 64));
   return new BN2(sqrtValueQ64.floor().toFixed());
 };
-var getUnClaimReward = (poolState, positionState) => {
+var getUnClaimLpFee = (poolState, positionState) => {
   const totalPositionLiquidity = positionState.unlockedLiquidity.add(positionState.vestedLiquidity).add(positionState.permanentLockedLiquidity);
   const feeAPerTokenStored = new BN2(
     Buffer.from(poolState.feeAPerLiquidity).reverse()
@@ -7968,6 +7968,100 @@ var getUnClaimReward = (poolState, positionState) => {
     rewards: positionState.rewardInfos.length > 0 ? positionState.rewardInfos.map((item) => item.rewardPendings) : []
   };
 };
+function getRewardPerTokenStore(poolReward, poolLiquidity, currentTime) {
+  if (poolLiquidity.eq(new BN2(0))) {
+    return new BN2(0);
+  }
+  const lastTimeRewardApplicable = BN2.min(
+    currentTime,
+    poolReward.rewardDurationEnd
+  );
+  const timePeriod = lastTimeRewardApplicable.sub(poolReward.lastUpdateTime);
+  const currentTotalReward = timePeriod.mul(poolReward.rewardRate);
+  const rewardPerTokenStore = currentTotalReward.shln(128).div(poolLiquidity);
+  const totalRewardPerTokenStore = new BN2(
+    Buffer.from(poolReward.rewardPerTokenStored).reverse()
+  ).add(rewardPerTokenStore);
+  return totalRewardPerTokenStore;
+}
+function getRewardPerPeriod(poolReward, currentTime, periodTime) {
+  const timeRewardAppicable = currentTime.add(periodTime);
+  const period = timeRewardAppicable <= poolReward.rewardDurationEnd ? periodTime : poolReward.rewardDurationEnd.sub(currentTime);
+  const rewardPerPeriod = poolReward.rewardRate.mul(period);
+  return rewardPerPeriod;
+}
+function getRewardInfo(poolState, rewardIndex, periodTime, currentTime) {
+  const poolReward = poolState.rewardInfos[rewardIndex];
+  const rewardPerTokenStore = getRewardPerTokenStore(
+    poolReward,
+    poolState.liquidity,
+    currentTime
+  );
+  const totalRewardDistributed = rewardPerTokenStore.mul(poolState.liquidity).shrn(192);
+  if (poolReward.rewardDurationEnd <= currentTime) {
+    return {
+      rewardPerPeriod: new BN2(0),
+      rewardBalance: new BN2(0),
+      totalRewardDistributed
+    };
+  }
+  const rewardPerPeriod = getRewardPerPeriod(
+    poolReward,
+    currentTime,
+    periodTime
+  );
+  const remainTime = poolReward.rewardDurationEnd.sub(currentTime);
+  const rewardBalance = poolReward.rewardRate.mul(remainTime).shrn(64);
+  if (poolState.liquidity.eq(new BN2(0))) {
+    return {
+      rewardPerPeriod,
+      rewardBalance,
+      totalRewardDistributed: new BN2(0)
+    };
+  }
+  return {
+    rewardPerPeriod: rewardPerPeriod.shrn(64),
+    rewardBalance,
+    totalRewardDistributed
+  };
+}
+function getUserRewardPending(poolState, positionState, rewardIndex, currentTime, periodTime) {
+  if (poolState.liquidity.eq(new BN2(0))) {
+    return {
+      userRewardPerPeriod: new BN2(0),
+      userPendingReward: new BN2(0)
+    };
+  }
+  const poolReward = poolState.rewardInfos[rewardIndex];
+  const userRewardInfo = positionState.rewardInfos[rewardIndex];
+  const rewardPerTokenStore = getRewardPerTokenStore(
+    poolReward,
+    poolState.liquidity,
+    currentTime
+  );
+  const totalPositionLiquidity = positionState.unlockedLiquidity.add(positionState.vestedLiquidity).add(positionState.permanentLockedLiquidity);
+  const userRewardPerTokenCheckPoint = new BN2(
+    Buffer.from(userRewardInfo.rewardPerTokenCheckpoint).reverse()
+  );
+  const newReward = totalPositionLiquidity.mul(rewardPerTokenStore.sub(userRewardPerTokenCheckPoint)).shrn(192);
+  if (poolReward.rewardDurationEnd <= currentTime) {
+    return {
+      userPendingReward: userRewardInfo.rewardPendings.add(newReward),
+      userRewardPerPeriod: new BN2(0)
+    };
+  }
+  const rewardPerPeriod = getRewardPerPeriod(
+    poolReward,
+    currentTime,
+    periodTime
+  );
+  const rewardPerTokenStorePerPeriod = rewardPerPeriod.shln(128).div(poolState.liquidity);
+  const userRewardPerPeriod = totalPositionLiquidity.mul(rewardPerTokenStorePerPeriod).shrn(192);
+  return {
+    userPendingReward: userRewardInfo.rewardPendings.add(newReward),
+    userRewardPerPeriod
+  };
+}
 
 // src/helpers/accountFilters.ts
 var positionByPoolFilter = (pool) => {
@@ -10564,6 +10658,11 @@ var CpAmm = class {
       return positionResult;
     });
   }
+  /**
+   * Retrieves all vesting accounts associated with a position.
+   * @param position - Public key of the position.
+   * @returns Array of vesting account public keys and their states.
+   */
   getAllVestingsByPosition(position) {
     return __async(this, null, function* () {
       const vestings = yield this._program.account.vesting.all([
@@ -10572,12 +10671,22 @@ var CpAmm = class {
       return vestings;
     });
   }
+  /**
+   * Checks if a position has any locked liquidity.
+   * @param position - Position state.
+   * @returns True if the position has locked liquidity, false otherwise.
+   */
   isLockedPosition(position) {
     const totalLockedLiquidity = position.vestedLiquidity.add(
       position.permanentLockedLiquidity
     );
     return totalLockedLiquidity.gtn(0);
   }
+  /**
+   * Checks if a position is permanently locked.
+   * @param positionState - Position state.
+   * @returns True if the position is permanently locked, false otherwise.
+   */
   isPermanentLockedPosition(positionState) {
     return positionState.permanentLockedLiquidity.gtn(0);
   }
@@ -10616,6 +10725,11 @@ var CpAmm = class {
     }
     return { canUnlock: true };
   }
+  /**
+   * Checks if a pool exists.
+   * @param pool - Public key of the pool.
+   * @returns True if the pool exists, false otherwise.
+   */
   isPoolExist(pool) {
     return __async(this, null, function* () {
       const poolState = yield this._program.account.pool.fetchNullable(pool);
@@ -10691,6 +10805,11 @@ var CpAmm = class {
       priceImpact: swapResult.priceImpact
     };
   }
+  /**
+   * Calculates the expected output amount or input amount for a swap depending on the swap mode.
+   * @param params GetQuote2Params
+   * @returns Quote2Result
+   */
   getQuote2(params) {
     const {
       inputTokenMint,
@@ -11130,6 +11249,11 @@ var CpAmm = class {
       return { tx: transaction, pool, position };
     });
   }
+  /**
+   * Builds a transaction to create a customizable pool with dynamic config.
+   * @param params InitializeCustomizeablePoolWithDynamicConfigParams
+   * @returns Transaction and related addresses.
+   */
   createCustomPoolWithDynamicConfig(params) {
     return __async(this, null, function* () {
       const {
@@ -11667,6 +11791,11 @@ var CpAmm = class {
       }).remainingAccounts(remainingAccounts).preInstructions(preInstructions).postInstructions(postInstructions).transaction();
     });
   }
+  /**
+   * Builds a transaction to perform a swap in the pool.
+   * @param params Swap2Params
+   * @returns Transaction builder.
+   */
   swap2(params) {
     return __async(this, null, function* () {
       const {
@@ -11835,6 +11964,11 @@ var CpAmm = class {
       return new Transaction().add(instruction);
     });
   }
+  /**
+   * Builds a transaction to close a position.
+   * @param params ClosePositionParams
+   * @returns Transaction builder.
+   */
   closePosition(params) {
     return __async(this, null, function* () {
       const { owner, pool, position, positionNftMint, positionNftAccount } = params;
@@ -12077,6 +12211,77 @@ var CpAmm = class {
       return transaction;
     });
   }
+  /**
+   * Builds a transaction to initialize a reward for a pool.
+   * @param params InitializeRewardParams
+   * @returns Transaction builder.
+   */
+  initializeReward(params) {
+    return __async(this, null, function* () {
+      const {
+        rewardIndex,
+        rewardDuration,
+        funder,
+        pool,
+        creator,
+        payer,
+        rewardMint,
+        rewardMintProgram
+      } = params;
+      const rewardVault = deriveRewardVaultAddress(pool, rewardIndex);
+      return yield this._program.methods.initializeReward(rewardIndex, rewardDuration, funder).accountsPartial({
+        poolAuthority: this.poolAuthority,
+        pool,
+        rewardVault,
+        rewardMint,
+        signer: creator,
+        payer,
+        tokenProgram: rewardMintProgram
+      }).transaction();
+    });
+  }
+  /**
+   * Builds a transaction to initialize and fund a reward for a pool.
+   * @param params InitializeAndFundReward
+   * @returns Transaction builder.
+   */
+  initializeAndFundReward(params) {
+    return __async(this, null, function* () {
+      const {
+        rewardIndex,
+        rewardDuration,
+        pool,
+        creator,
+        payer,
+        rewardMint,
+        carryForward,
+        amount,
+        rewardMintProgram
+      } = params;
+      const rewardVault = deriveRewardVaultAddress(pool, rewardIndex);
+      const initializeRewardTx = yield this.initializeReward({
+        rewardIndex,
+        rewardDuration,
+        funder: payer,
+        pool,
+        creator,
+        payer,
+        rewardMint,
+        rewardMintProgram
+      });
+      const fundRewardTx = yield this.fundReward({
+        rewardIndex,
+        carryForward,
+        pool,
+        funder: payer,
+        amount,
+        rewardMint,
+        rewardVault,
+        rewardMintProgram
+      });
+      return new Transaction().add(initializeRewardTx).add(fundRewardTx);
+    });
+  }
   /**
    * Builds a transaction to update reward duration.
    * @param {UpdateRewardDurationParams} params - Parameters including pool and new duration.
@@ -12084,10 +12289,10 @@ var CpAmm = class {
    */
   updateRewardDuration(params) {
     return __async(this, null, function* () {
-      const { pool, admin, rewardIndex, newDuration } = params;
+      const { pool, signer, rewardIndex, newDuration } = params;
       return yield this._program.methods.updateRewardDuration(rewardIndex, newDuration).accountsPartial({
         pool,
-        signer: admin
+        signer
       }).transaction();
     });
   }
@@ -12098,10 +12303,10 @@ var CpAmm = class {
    */
   updateRewardFunder(params) {
     return __async(this, null, function* () {
-      const { pool, admin, rewardIndex, newFunder } = params;
+      const { pool, signer, rewardIndex, newFunder } = params;
       return yield this._program.methods.updateRewardFunder(rewardIndex, newFunder).accountsPartial({
         pool,
-        signer: admin
+        signer
       }).transaction();
     });
   }
@@ -12378,9 +12583,9 @@ var CpAmm = class {
         position,
         positionNftAccount,
         rewardIndex,
-        skipReward,
         poolState,
-        positionState
+        positionState,
+        isSkipReward
       } = params;
       const rewardInfo = poolState.rewardInfos[rewardIndex];
       const tokenProgram = getTokenProgram(rewardInfo.rewardTokenFlag);
@@ -12399,6 +12604,7 @@ var CpAmm = class {
         const closeWrappedSOLIx = yield unwrapSOLInstruction(user);
         closeWrappedSOLIx && postInstructions.push(closeWrappedSOLIx);
       }
+      const skipReward = isSkipReward ? 1 : 0;
       return yield this._program.methods.claimReward(rewardIndex, skipReward).accountsPartial({
         pool: positionState.pool,
         positionNftAccount,
@@ -12412,6 +12618,11 @@ var CpAmm = class {
       }).preInstructions(preInstructions).postInstructions(postInstructions).transaction();
     });
   }
+  /**
+   * Builds a transaction to split a position into two positions.
+   * @param params SplitPositionParams
+   * @returns Transaction builder.
+   */
   splitPosition(params) {
     return __async(this, null, function* () {
       const {
@@ -12448,6 +12659,11 @@ var CpAmm = class {
       }).transaction();
     });
   }
+  /**
+   * Builds a transaction to split a position into two positions.
+   * @param params SplitPosition2Params
+   * @returns Transaction builder.
+   */
   splitPosition2(params) {
     return __async(this, null, function* () {
       const {
@@ -12592,6 +12808,7 @@ export {
   getPriceFromSqrtPrice,
   getPriceImpact,
   getRateLimiterParams,
+  getRewardInfo,
   getSecondKey,
   getSimulationComputeUnits,
   getSqrtPriceFromPrice,
@@ -12604,7 +12821,8 @@ export {
   getTotalLockedLiquidity,
   getTotalTradingFeeFromExcludedFeeAmount,
   getTotalTradingFeeFromIncludedFeeAmount,
-  getUnClaimReward,
+  getUnClaimLpFee,
+  getUserRewardPending,
   hasPartner,
   isDynamicFeeEnabled,
   isNonZeroRateLimiter,