@strkfarm/sdk 1.1.49 → 1.1.51

package/src/strategies/ekubo-cl-vault.tsx

@@ -416,22 +416,41 @@ export class EkuboCLVault extends BaseStrategy<
     const tvlBefore = await this._getTVL(blockBefore);
     const supplyBefore = await this.totalSupply(blockBefore);
     const priceBefore = await this.getCurrentPrice(blockBefore);
-
-    const tvlInToken0Now = (tvlNow.amount0
-      .multipliedBy(priceNow.price))
-      .plus(tvlNow.amount1);
-    const tvlPerShareNow = tvlInToken0Now
+    const poolKey = await this.getPoolKey(blockBefore);
+    logger.verbose(`priceBefore: ${priceBefore.price.toString()}`);
+    logger.verbose(`priceNow: ${priceNow.price.toString()}`);
+    logger.verbose(`tvlBefore: ${JSON.stringify(tvlBefore)}`);
+    logger.verbose(`tvlNow: ${JSON.stringify(tvlNow)}`);
+
+    const isQuoteTokenToken0 = this.metadata.additionalInfo.quoteAsset.address.eq(poolKey.token0);
+    logger.verbose(`isQuoteTokenToken0: ${isQuoteTokenToken0}`);
+    let tvlBeforeInBaseAsset = Web3Number.fromWei(0, this.metadata.additionalInfo.quoteAsset.decimals);
+    let tvlNowInBaseAsset = Web3Number.fromWei(0, this.metadata.additionalInfo.quoteAsset.decimals);
+    if (!isQuoteTokenToken0) {
+      tvlNowInBaseAsset = (tvlNow.amount0
+        .multipliedBy(priceNow.price))
+        .plus(tvlNow.amount1);
+      tvlBeforeInBaseAsset = (tvlBefore.amount0
+        .multipliedBy(priceBefore.price))
+        .plus(tvlBefore.amount1);
+    } else {
+      tvlNowInBaseAsset = (tvlNow.amount1
+        .multipliedBy(1 / priceNow.price))
+        .plus(tvlNow.amount0);
+      tvlBeforeInBaseAsset = (tvlBefore.amount1
+        .multipliedBy(1 / priceBefore.price))
+        .plus(tvlBefore.amount0);
+    }
+    const tvlPerShareNow = tvlNowInBaseAsset
       .multipliedBy(1e18)
       .dividedBy(adjustedSupplyNow.toString());
-    const tvlInToken0Bf = (tvlBefore.amount0
-      .multipliedBy(priceBefore.price))
-      .plus(tvlBefore.amount1);
-    const tvlPerShareBf = tvlInToken0Bf
+
+    const tvlPerShareBf = tvlBeforeInBaseAsset
       .multipliedBy(1e18)
       .dividedBy(supplyBefore.toString());
     const timeDiffSeconds = blockNowTime - blockBeforeInfo.timestamp;
-    logger.verbose(`tvlInToken0Now: ${tvlInToken0Now.toString()}`);
-    logger.verbose(`tvlInToken0Bf: ${tvlInToken0Bf.toString()}`);
+    logger.verbose(`tvlNowInBaseAsset: ${tvlNowInBaseAsset.toString()}`);
+    logger.verbose(`tvlBeforeInBaseAsset: ${tvlBeforeInBaseAsset.toString()}`);
     logger.verbose(`tvlPerShareNow: ${tvlPerShareNow.toString()}`);
     logger.verbose(`tvlPerShareBf: ${tvlPerShareBf.toString()}`);
     logger.verbose(`Price before: ${priceBefore.price.toString()}`);
@@ -1578,11 +1597,20 @@ export class EkuboCLVault extends BaseStrategy<
     };
   }
 
-  async harvest(acc: Account, maxIterations = 20, priceRatioPrecision = 4): Promise<Call[]> {
+  async harvest(acc: Account, maxIterations = 20, priceRatioPrecision = 4, minRewardAmount: Web3Number = new Web3Number(0, 18)): Promise<Call[]> {
     const ekuboHarvests = new EkuboHarvests(this.config);
-    const unClaimedRewards = await ekuboHarvests.getUnHarvestedRewards(
+    
+    // get unclaimed rewards and filter out those less than the minimum reward amount
+    const unClaimedRewards = (await ekuboHarvests.getUnHarvestedRewards(
       this.address
-    );
+    )).filter(claim => claim.actualReward.greaterThanOrEqualTo(minRewardAmount));
+
+    if (unClaimedRewards.length == 0) {
+      logger.verbose(`${EkuboCLVault.name}: harvest => no unclaimed rewards found`);
+      return [];
+    }
+
+    // get necessary info for the harvest
     const poolKey = await this.getPoolKey();
     const token0Info = await Global.getTokenInfoFromAddr(poolKey.token0);
     const token1Info = await Global.getTokenInfoFromAddr(poolKey.token1);
@@ -1590,8 +1618,14 @@ export class EkuboCLVault extends BaseStrategy<
     logger.verbose(
       `${EkuboCLVault.name}: harvest => unClaimedRewards: ${unClaimedRewards.length}`
     );
+
+    // execute the harvest
     const calls: Call[] = [];
-    for (let claim of unClaimedRewards) {
+    // do one at a time. 
+    const chosenClaim = unClaimedRewards[0];
+    logger.info(`${EkuboCLVault.name}: harvest => doing one at a time`);
+    logger.info(`${EkuboCLVault.name}: harvest => chosenClaim -> Claim ID: ${chosenClaim.claim.id}, Amount: ${chosenClaim.claim.amount.toString()}, actualAmount: ${chosenClaim.actualReward.toString()}, addr: ${chosenClaim.claim.claimee.toString()}`);
+    for (let claim of [chosenClaim]) {
       const fee = claim.claim.amount
         .multipliedBy(this.metadata.additionalInfo.feeBps)
         .dividedBy(10000);
@@ -1664,60 +1698,50 @@ export class EkuboCLVault extends BaseStrategy<
     logger.verbose(
       `${
         EkuboCLVault.name
-      }: harvest => token0Amt: ${token0Amt.toString()}, token1Amt: ${token1Amt.toString()}`
-    );
-
-    // THis function cannot handle swapping of non-STRK pool,
-    // bcz atleast one of token0Amt or token1Amt are in STRK terms. 
-    const swapInfo = await this.getSwapInfoGivenAmounts(
-      poolKey,
-      token0Amt,
-      token1Amt,
-      bounds,
-      maxIterations,
-      priceRatioPrecision
-    );
-    swapInfo.token_to_address = token0Info.address.address;
-    logger.verbose(
-      `${EkuboCLVault.name}: harvest => swapInfo: ${JSON.stringify(swapInfo)}`
+      }: harvest => token0Amt: ${token0Amt.toFixed(18)}, token1Amt: ${token1Amt.toFixed(18)}`
     );
 
     logger.verbose(
       `${EkuboCLVault.name}: harvest => claim: ${JSON.stringify(claim)}`
     );
-    const harvestEstimateCall = async (swapInfo1: SwapInfo) => {
-      const swap1Amount = Web3Number.fromWei(
-        uint256.uint256ToBN(swapInfo1.token_from_amount).toString(),
-        18 // cause its always STRK?
+    const claimTokenInfo = await Global.getTokenInfoFromAddr(claim.token);
+    const harvestEstimateCall = async (baseSwapInfo: SwapInfo) => {
+      // - the base swap if actual swap from claim token to non-claim token
+      // - the other swap is just claim token to claim token (e.g. STRK to STRK)
+      // which is just dummy
+      let baseSwapAmount = Web3Number.fromWei(
+        uint256.uint256ToBN(baseSwapInfo.token_from_amount).toString(),
+        claimTokenInfo.decimals
       ).minimum(
-        postFeeAmount.toFixed(18) // cause always strk
+        postFeeAmount.toFixed(claimTokenInfo.decimals)
       ); // ensure we don't swap more than we have
-      swapInfo.token_from_amount = uint256.bnToUint256(swap1Amount.toWei());
-      swapInfo.token_to_min_amount = uint256.bnToUint256(
-        swap1Amount.multipliedBy(0).toWei() // placeholder
-      ); // 0.01% slippage
+      if (baseSwapAmount.lt(0.0001)) {
+        baseSwapAmount = new Web3Number(0, claimTokenInfo.decimals);
+      }
+      baseSwapInfo.token_from_amount = uint256.bnToUint256(baseSwapAmount.toWei());
 
+      const isToken0ClaimToken = claim.token.eq(poolKey.token0);
       logger.verbose(
-        `${EkuboCLVault.name}: harvest => swap1Amount: ${swap1Amount}`
+        `${EkuboCLVault.name}: harvest => isToken0ClaimToken: ${isToken0ClaimToken}, baseSwapAmount: ${baseSwapAmount}`
       );
 
-      const remainingAmount = postFeeAmount.minus(swap1Amount).maximum(0);
+      const remainingAmount = postFeeAmount.minus(baseSwapAmount).maximum(0);
       logger.verbose(
         `${EkuboCLVault.name}: harvest => remainingAmount: ${remainingAmount}`
       );
-      const swapInfo2 = {
-        ...swapInfo,
-        token_from_amount: uint256.bnToUint256(remainingAmount.toWei()),
-      };
-      swapInfo2.token_to_address = token1Info.address.address;
+
+      // obv, same to same
+      let dummySwapInfo = AvnuWrapper.buildZeroSwap(claim.token, this.address.address, claim.token);
+      dummySwapInfo.token_from_amount = uint256.bnToUint256(remainingAmount.toWei());
+
       logger.verbose(
-        `${EkuboCLVault.name}: harvest => swapInfo: ${JSON.stringify(
-          swapInfo
+        `${EkuboCLVault.name}: harvest => dummySwapInfo: ${JSON.stringify(
+          dummySwapInfo
         )}`
       );
       logger.verbose(
-        `${EkuboCLVault.name}: harvest => swapInfo2: ${JSON.stringify(
-          swapInfo2
+        `${EkuboCLVault.name}: harvest => baseSwapInfo: ${JSON.stringify(
+          baseSwapInfo
         )}`
       );
       const calldata = [
@@ -1728,18 +1752,41 @@ export class EkuboCLVault extends BaseStrategy<
           claimee: claim.claim.claimee.address,
         },
         claim.proof.map((p) => num.getDecimalString(p)),
-        swapInfo,
-        swapInfo2,
+        isToken0ClaimToken ? dummySwapInfo : baseSwapInfo, // is token0 claim token, its just dummy swap
+        isToken0ClaimToken ? baseSwapInfo : dummySwapInfo,
       ];
-      logger.verbose(
-        `${EkuboCLVault.name}: harvest => calldata: ${JSON.stringify(
-          calldata
-        )}`
-      );
       return [this.contract.populate("harvest", calldata)];
     };
+
+    // if token0 == claim token, then the base swapInfo is from claim token to token1
+    // if token1 == claim token, then the base swapInfo is from claim token to token0
+    const isToken0ClaimToken = claim.token.eq(poolKey.token0);
+    let baseSwapInfo = AvnuWrapper.buildZeroSwap(claim.token, this.address.address, isToken0ClaimToken ? token1Info.address : token0Info.address);
+    baseSwapInfo.token_from_amount = uint256.bnToUint256(postFeeAmount.toWei()); // we try to swap all to start with
+   
+    // if token0 != claim token, then we swap from claim token to token0
+    if (postFeeAmount.greaterThan(0) && !isToken0ClaimToken) {
+      const avnuWrapper = new AvnuWrapper();
+      const quote = await avnuWrapper.getQuotes(
+        claim.token.address,
+        token0Info.address.address,
+        postFeeAmount.toWei(),
+        this.address.address
+      );
+      baseSwapInfo = await avnuWrapper.getSwapInfo(quote, this.address.address, 0, this.address.address);
+    } else if (postFeeAmount.greaterThan(0) && isToken0ClaimToken) {
+      // if token0 == claim token, then we swap from claim token to token1
+      const avnuWrapper = new AvnuWrapper();
+      const quote = await avnuWrapper.getQuotes(
+        claim.token.address,
+        token1Info.address.address,
+        postFeeAmount.toWei(),
+        this.address.address
+      );
+      baseSwapInfo = await avnuWrapper.getSwapInfo(quote, this.address.address, 0, this.address.address);
+    }
     const _callsFinal = await this.rebalanceIter(
-      swapInfo,
+      baseSwapInfo,
       acc,
       harvestEstimateCall,
       claim.token.eq(poolKey.token0),
@@ -1809,39 +1856,47 @@ export class EkuboCLVault extends BaseStrategy<
   }) {
     const { postFeeAmount, claim, token0Info, token1Info, acc } = params;
     let harvestCall: Call | null = null;
+    logger.verbose(`${EkuboCLVault.name}: harvestMismatchEstimateCallFn => postFeeAmount: ${postFeeAmount.toString()}`);
 
+    let attempt = 0;
+    let MAX_ATTEMPTS = 50;
     const binarySearchCallbackFn = async (mid: bigint) => {
+      attempt++;
+      logger.verbose(`${EkuboCLVault.name}: harvestMismatchEstimateCallFn => mid: ${mid}, attempt: ${attempt}/${MAX_ATTEMPTS}`);
       const rewardPart2 = BigInt(postFeeAmount.toWei()) - mid;
       const avnuWrapper = new AvnuWrapper();
       const beneficiary = this.address.address;
 
       // get quote for 1st part
-      const quote1 = await avnuWrapper.getQuotes(
+      const quote1Prom = avnuWrapper.getQuotes(
         claim.token.address,
         token0Info.address.address,
         mid.toString(),
         beneficiary
       );
+      const quote2Prom = avnuWrapper.getQuotes(
+        claim.token.address,
+        token1Info.address.address,
+        rewardPart2.toString(),
+        beneficiary
+      );
+      const [quote1, quote2] = await Promise.all([quote1Prom, quote2Prom]);
+      
       // default min amount is ok
       const swapInfo1 = await avnuWrapper.getSwapInfo(
         quote1,
         beneficiary,
-        0,
+        0, // fee bps
         beneficiary
       );
 
       // get quote for 2nd part
-      const quote2 = await avnuWrapper.getQuotes(
-        claim.token.address,
-        token1Info.address.address,
-        rewardPart2.toString(),
-        beneficiary
-      );
+
       // default min amount is ok
       const swapInfo2 = await avnuWrapper.getSwapInfo(
         quote2,
         beneficiary,
-        0,
+        0, // fee bps
         beneficiary
       );
 
@@ -1860,15 +1915,19 @@ export class EkuboCLVault extends BaseStrategy<
         ];
         harvestCall = this.contract.populate("harvest", calldata)
         const gas = await acc.estimateInvokeFee(harvestCall);
+        logger.verbose(`${EkuboCLVault.name}: harvestMismatchEstimateCallFn => gas: ${gas.overall_fee.toString()}, attempt: ${attempt}/${MAX_ATTEMPTS}`);
         return 'found';
       } catch (err: any) {
         if (err.message.includes('invalid token0 amount')) {
+          logger.verbose(`${EkuboCLVault.name}: harvestMismatchEstimateCallFn => invalid token0 amount, attempt: ${attempt}/${MAX_ATTEMPTS}`);
           // too much token0 amount left, may be swap less to token0
           return 'go_low';
         } else if (err.message.includes('invalid token1 amount')) {
+          logger.verbose(`${EkuboCLVault.name}: harvestMismatchEstimateCallFn => invalid token1 amount, attempt: ${attempt}/${MAX_ATTEMPTS}`);
           // too much token1 balance left, may be swap more to token0
           return 'go_high';
         }
+        logger.verbose(`${EkuboCLVault.name}: harvestMismatchEstimateCallFn => error: ${err.message}, attempt: ${attempt}/${MAX_ATTEMPTS}`);
         return 'retry';
       }
     }