@strkfarm/sdk 1.1.22 → 1.1.23

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

@@ -37,6 +37,8 @@ import { EkuboHarvests } from "@/modules/harvests";
 import { logger } from "@/utils/logger";
 import { COMMON_CONTRACTS } from "./constants";
 import { DepegRiskLevel, ImpermanentLossLevel, MarketRiskLevel, SmartContractRiskLevel } from "@/interfaces/risks";
+import { gql } from "@apollo/client";
+import apolloClient from "@/modules/apollo-client";
 
 export interface EkuboPoolKey {
   token0: ContractAddr;
@@ -51,6 +53,12 @@ export interface EkuboBounds {
   upperTick: bigint;
 }
 
+interface FeeHistory {
+  date: string;
+  tokenInfo: TokenInfo;
+  amount: Web3Number;
+}
+
 /**
  * Settings for the CLVaultStrategy
  *
@@ -285,11 +293,97 @@ export class EkuboCLVault extends BaseStrategy<
     return [this.contract.populate("handle_fees", [])];
   }
 
-  /**
-   * Calculates assets before and now in a given token of TVL per share to observe growth
-   * @returns {Promise<number>} The weighted average APY across all pools
-   */
-  async netAPY(
+  async getFeeHistory(timePeriod: '24h' | '30d' | '3m' = '24h'): Promise<{
+    summary: DualTokenInfo,
+    history: FeeHistory[]
+  }> {
+    const { data } = await apolloClient.query({
+      query: gql`
+        query ContractFeeEarnings(
+          $timeframe: String!
+          $contract: String!
+        ) {
+          contractFeeEarnings(timeframe: $timeframe, contract: $contract) {
+            contract
+            dailyEarnings {
+              date
+              tokenAddress
+              amount
+            }
+            totalCollections
+          }
+        }
+      `,
+      variables: {
+        timeframe: timePeriod,
+        contract: this.address.address
+      },
+      fetchPolicy: 'no-cache',
+    });
+
+    // Sample response type:
+    // {
+    //   contractFeeEarnings: {
+    //     contract: '0x2bcaef2eb7706875a5fdc6853dd961a0590f850bc3a031c59887189b5e84ba1',
+    //     dailyEarnings: [ [Object], [Object], [Object], [Object] ],
+    //     totalCollections: 3,
+    //     __typename: 'FeeSummary'
+    //   }
+    // }
+    // dailyEarnings: {
+    //   date: '2025-09-27',
+    //   tokenAddress: '0x3fe2b97c1fd336e750087d68b9b867997fd64a2661ff3ca5a7c771641e8e7ac',
+    //   amount: '15404',
+    //   __typename: 'DailyFeeEarnings'
+    // }[]
+
+    // get pool key and token info
+    const poolKey = await this.getPoolKey();
+    const token0Info = await Global.getTokenInfoFromAddr(poolKey.token0);
+    const token1Info = await Global.getTokenInfoFromAddr(poolKey.token1);
+    const price0 = await this.pricer.getPrice(token0Info.symbol);
+    const price1 = await this.pricer.getPrice(token1Info.symbol);
+    let totalToken0Amount = Web3Number.fromWei(0, token0Info.decimals);
+    let totalToken1Amount = Web3Number.fromWei(0, token1Info.decimals);
+    let totalToken0Usd = 0;
+    let totalToken1Usd = 0;
+    const parsedFeeInfo: FeeHistory[] = [];
+    const feeInfo = data.contractFeeEarnings.dailyEarnings;
+    for (const d of feeInfo) {
+      const tokenInfo = await Global.getTokenInfoFromAddr(ContractAddr.from(d.tokenAddress));
+      const amount = Web3Number.fromWei(d.amount, tokenInfo.decimals);
+      if (tokenInfo.address.eq(poolKey.token0)) {
+        totalToken0Amount = totalToken0Amount.plus(amount);
+        totalToken0Usd = totalToken0Usd + amount.multipliedBy(price0.price).toNumber();
+      } else {
+        totalToken1Amount = totalToken1Amount.plus(amount);
+        totalToken1Usd = totalToken1Usd + amount.multipliedBy(price1.price).toNumber();
+      }
+      parsedFeeInfo.push({
+        date: d.date,
+        tokenInfo,
+        amount: Web3Number.fromWei(d.amount, tokenInfo.decimals)
+      });
+    }
+    return {
+      summary: {
+        usdValue: totalToken0Usd + totalToken1Usd,
+        token0: {
+          tokenInfo: token0Info,
+          amount: totalToken0Amount,
+          usdValue: totalToken0Usd
+        },
+        token1: {
+          tokenInfo: token1Info,
+          amount: totalToken1Amount,
+          usdValue: totalToken1Usd
+        }
+      },
+      history: parsedFeeInfo
+    }
+  }
+
+  async netSharesBasedTrueAPY(
     blockIdentifier: BlockIdentifier = "latest",
     sinceBlocks = 600000
   ): Promise<number> {
@@ -354,6 +448,33 @@ export class EkuboCLVault extends BaseStrategy<
     return (apyForGivenBlocks * (365 * 24 * 3600)) / timeDiffSeconds;
   }
 
+  async feeBasedAPY(
+    blockIdentifier: BlockIdentifier = "latest",
+    sinceBlocks = 600000
+  ): Promise<number> {
+    const feeInfo = await this.getFeeHistory('24h');
+    const tvlNow = await this.getTVL('latest');
+    return feeInfo.summary.usdValue * 365 / tvlNow.usdValue;
+  }
+
+  /**
+   * Calculates assets before and now in a given token of TVL per share to observe growth
+   * @returns {Promise<number>} The weighted average APY across all pools
+   */
+  async netAPY(
+    blockIdentifier: BlockIdentifier = "latest",
+    sinceBlocks = 600000
+  ): Promise<number> {
+    const isUSDCQouteToken = this.metadata.additionalInfo.quoteAsset.symbol === "USDC";
+    if (!isUSDCQouteToken) {
+      // good for LSTs and stables
+      return this.netSharesBasedTrueAPY(blockIdentifier, sinceBlocks);
+    } else {
+      // good for non-stables
+      return this.feeBasedAPY(blockIdentifier, sinceBlocks);
+    }
+  }
+
   async getHarvestRewardShares(fromBlock: number, toBlock: number) {
     const len = Number(await this.contract.call("get_total_rewards"));
     let shares = Web3Number.fromWei(0, 18);
@@ -1893,7 +2014,7 @@ const ETHUSDCRe7Strategy: IStrategyMetadata<CLVaultStrategySettings> = {
     Global.getDefaultTokens().find((t) => t.symbol === "USDC")!
   ],
   apyMethodology:
-  "APY based on 7-day historical performance, including fees and rewards.",
+  "Annualized fee APY, calculated as fees earned in the last 24h divided by TVL",
   additionalInfo: {
     newBounds: "Managed by Re7",
     truePrice: 1,
@@ -1913,6 +2034,11 @@ const ETHUSDCRe7Strategy: IStrategyMetadata<CLVaultStrategySettings> = {
       answer:
         <div>Re7 Labs is the curator of this strategy. Re7 Labs is a well-known Web3 asset management firm. This strategy is completely managed by them, including ownership of the vault. Troves is developer of the smart contracts and maintains infrastructure to help users access these strategies. You can find more information about them on their website <a href='https://www.re7labs.xyz' style={{textDecoration: "underline", marginLeft: "2px"}} target="_blank">here</a>.</div>
     },
+    {
+      question: "How is the APY calculated?",
+      answer:
+        <div>It's an annualized fee APY, calculated as fees earned in the last 24h divided by TVL. Factors like impermanent loss are not considered.</div>
+    },
   ],
   risk: highRisk,
   points: [],