@strkfarm/sdk 2.0.0-dev.40 → 2.0.0-dev.41

package/src/strategies/svk-strategy.ts

@@ -2,8 +2,8 @@ import { ContractAddr, Web3Number } from "@/dataTypes";
 import { IConfig, IStrategyMetadata, Protocols, TokenInfo, VaultPosition } from "@/interfaces";
 import { PricerBase } from "@/modules/pricerBase";
 import { ERC20 } from "@/modules";
-import { BaseStrategy, SingleActionAmount, SingleTokenInfo } from "./base-strategy";
-import { Call, Contract, num, uint256 } from "starknet";
+import { BaseStrategy, SingleActionAmount, SingleTokenInfo, UserPositionCard, UserPositionCardsInput } from "./base-strategy";
+import { BlockIdentifier, Call, Contract, num, uint256 } from "starknet";
 import { assert, LeafData, logger, StandardMerkleTree } from "@/utils";
 import { UniversalStrategySettings } from "./universal-strategy";
 import { UNIVERSAL_MANAGE_IDS } from "./universal-strategy";
@@ -94,6 +94,34 @@ export abstract class SVKStrategy<S extends UniversalStrategySettings>
     return [call];
   }
 
+  async getUserTVL(user: ContractAddr, blockIdentifier: BlockIdentifier = "latest"): Promise<SingleTokenInfo> {
+    const shares: any = await this.contract.call("balanceOf", [user.address], { blockIdentifier });
+    const assets: any = await this.contract.call(
+      "convert_to_assets",
+      [uint256.bnToUint256(shares)],
+      { blockIdentifier }
+    );
+    const amount = Web3Number.fromWei(
+      assets.toString(),
+      this.metadata.depositTokens[0].decimals
+    );
+
+    const blockNumber = typeof blockIdentifier === "number" || typeof blockIdentifier === "bigint"
+      ? Number(blockIdentifier)
+      : undefined;
+
+    const price = await this.pricer.getPrice(
+      this.metadata.depositTokens[0].symbol,
+      blockNumber
+    );
+    const usdValue = Number(amount.toFixed(6)) * price.price;
+    return {
+      tokenInfo: this.asset(),
+      amount,
+      usdValue
+    };
+  }
+
   /**
    * Returns the unused balance in the vault allocator.
    * Note: This function is common for any SVK strategy.
@@ -322,6 +350,135 @@ export abstract class SVKStrategy<S extends UniversalStrategySettings>
     };
   }
 
+  async getUserRealizedAPY(
+    blockIdentifier: BlockIdentifier = "latest",
+    sinceBlocks = 600000
+  ): Promise<number> {
+    logger.verbose(
+      `${this.getTag()}: getUserRealizedAPY => starting with blockIdentifier=${blockIdentifier}, sinceBlocks=${sinceBlocks}`
+    );
+
+    const blockNow =
+      typeof blockIdentifier === "number" || typeof blockIdentifier === "bigint"
+        ? Number(blockIdentifier)
+        : (await this.config.provider.getBlockLatestAccepted()).block_number;
+    const blockNowTime =
+      typeof blockIdentifier === "number" || typeof blockIdentifier === "bigint"
+        ? (await this.config.provider.getBlockWithTxs(blockIdentifier)).timestamp
+        : new Date().getTime() / 1000;
+
+    const blockBefore = Math.max(
+      blockNow - sinceBlocks,
+      this.metadata.launchBlock
+    );
+
+    const assetsNowRaw: bigint = await this.contract.call("total_assets", [], {
+      blockIdentifier,
+    }) as bigint;
+    const amountNow = Web3Number.fromWei(
+      assetsNowRaw.toString(),
+      this.metadata.depositTokens[0].decimals
+    );
+
+    const supplyNowRaw: bigint = await this.contract.call("total_supply", [], {
+      blockIdentifier,
+    }) as bigint;
+    const supplyNow = Web3Number.fromWei(supplyNowRaw.toString(), 18);
+
+    const assetsBeforeRaw: bigint = await this.contract.call(
+      "total_assets",
+      [],
+      { blockIdentifier: blockBefore }
+    ) as bigint;
+    const amountBefore = Web3Number.fromWei(
+      assetsBeforeRaw.toString(),
+      this.metadata.depositTokens[0].decimals
+    );
+
+    const supplyBeforeRaw: bigint = await this.contract.call(
+      "total_supply",
+      [],
+      { blockIdentifier: blockBefore }
+    ) as bigint;
+    const supplyBefore = Web3Number.fromWei(supplyBeforeRaw.toString(), 18);
+
+    const blockBeforeInfo = await this.config.provider.getBlockWithTxs(
+      blockBefore
+    );
+
+    const assetsPerShareNow = amountNow
+      .multipliedBy(1e18)
+      .dividedBy(supplyNow.toString());
+
+    const assetsPerShareBf = amountBefore
+      .multipliedBy(1e18)
+      .dividedBy(supplyBefore.toString());
+
+    const timeDiffSeconds = blockNowTime - blockBeforeInfo.timestamp;
+
+    logger.verbose(`${this.getTag()} [getUserRealizedAPY] assetsNow: ${amountNow.toString()}`);
+    logger.verbose(`${this.getTag()} [getUserRealizedAPY] assetsBefore: ${amountBefore.toString()}`);
+    logger.verbose(`${this.getTag()} [getUserRealizedAPY] assetsPerShareNow: ${assetsPerShareNow.toString()}`);
+    logger.verbose(`${this.getTag()} [getUserRealizedAPY] assetsPerShareBf: ${assetsPerShareBf.toString()}`);
+    logger.verbose(`${this.getTag()} [getUserRealizedAPY] Supply before: ${supplyBefore.toString()}`);
+    logger.verbose(`${this.getTag()} [getUserRealizedAPY] Supply now: ${supplyNow.toString()}`);
+    logger.verbose(`${this.getTag()} [getUserRealizedAPY] Time diff in seconds: ${timeDiffSeconds}`);
+
+    const apyForGivenBlocks =
+      Number(
+        assetsPerShareNow
+          .minus(assetsPerShareBf)
+          .multipliedBy(10000)
+          .dividedBy(assetsPerShareBf)
+      ) / 10000;
+
+    return (apyForGivenBlocks * (365 * 24 * 3600)) / timeDiffSeconds;
+  }
+
+  async getUserPositionCards(input: UserPositionCardsInput): Promise<UserPositionCard[]> {
+    const { user, investmentFlows = [] } = input;
+    const [userTVL] = await Promise.all([
+      this.getUserTVL(user),
+    ]);
+    const cards: UserPositionCard[] = [
+      {
+        title: "Your Holdings",
+        tooltip: "Your Holdings",
+        value: this.formatTokenAmountForCard(userTVL.amount, userTVL.tokenInfo),
+        subValue: `≈ ${this.formatUSDForCard(userTVL.usdValue)}`,
+        subValueColor: "positive",
+      },
+    ];
+
+    let lifetimeAmount = userTVL.amount.multipliedBy(0);
+    let lifetimeTokenInfo = userTVL.tokenInfo;
+    let lifetimeUsdValue = 0;
+    if (investmentFlows.length > 0) {
+      try {
+        const earningsResult = this.getLifetimeEarnings(userTVL, investmentFlows);
+        lifetimeAmount = earningsResult.lifetimeEarnings;
+        lifetimeTokenInfo = earningsResult.tokenInfo.tokenInfo;
+        const userAmount = userTVL.amount.toNumber();
+        if (Number.isFinite(userAmount) && userAmount > 0) {
+          const pricePerToken = userTVL.usdValue / userAmount;
+          lifetimeUsdValue = lifetimeAmount.toNumber() * pricePerToken;
+        }
+      } catch (error) {
+        logger.warn(`${this.getTag()}::getUserPositionCards lifetime earnings fallback`, error);
+      }
+    }
+
+    cards.push({
+      title: "Lifetime Earnings",
+      tooltip: "Lifetime Earnings",
+      value: this.formatTokenAmountForCard(lifetimeAmount, lifetimeTokenInfo),
+      subValue: `≈ ${this.formatUSDForCard(lifetimeUsdValue)}`,
+      subValueColor: this.getSubValueColorFromSignedNumber(lifetimeUsdValue),
+    });
+
+    return cards;
+  }
+
   async getPrevAUM() {
     const currentAUM: bigint = await this.contract.call('aum', []) as bigint;
     const prevAum = Web3Number.fromWei(currentAUM.toString(), this.asset().decimals);

package/src/strategies/token-boosted-xstrk-carry-strategy.tsx

@@ -33,7 +33,11 @@ import { ERC20, PricerFromApi, TokenMarketData } from "@/modules";
 import { PricerBase } from "@/modules/pricerBase";
 import { logger, assert } from "@/utils";
 import { BlockIdentifier, Call, uint256, num } from "starknet";
-import { SingleTokenInfo } from "./base-strategy";
+import {
+  SingleTokenInfo,
+  UserPositionCard,
+  UserPositionCardsInput,
+} from "./base-strategy";
 import { SVKStrategy } from "./svk-strategy";
 import {
   APYType,
@@ -320,6 +324,34 @@ export class BoostedxSTRKCarryStrategy<
     };
   }
 
+  async getUserPositionCards(
+    input: UserPositionCardsInput,
+  ): Promise<UserPositionCard[]> {
+    const cards = await super.getUserPositionCards(input);
+    const realizedApyRaw = await this.getUserRealizedAPY().catch((error) => {
+      logger.warn(
+        `${this.getTag()}::getUserPositionCards realized APY fallback`,
+        error,
+      );
+      return null;
+    });
+
+    const realizedApy =
+      typeof realizedApyRaw === "number"
+        ? this.formatPercentForCard(realizedApyRaw)
+        : "N/A";
+
+    cards.push({
+      title: "Realized APY",
+      tooltip:
+        this.metadata.realizedApyMethodology ||
+        "Realized APY is based on past 14 days performance",
+      value: realizedApy,
+    });
+
+    return cards;
+  }
+
   async getAUM(): Promise<{
     net: SingleTokenInfo;
     prevAum: Web3Number;
@@ -952,7 +984,7 @@ const wbtcBoostedSettings: BoostedxSTRKCarryStrategySettings = {
   depositToken: Global.getDefaultTokens().find((t) => t.symbol === "WBTC")!,
   debtToken: Global.getDefaultTokens().find((t) => t.symbol === "STRK")!,
   lstHyperToken: Global.getDefaultTokens().find((t) => t.symbol === "xSTRK")!,
-  maxLTV: 0.70,
+  maxLTV: 0.7,
   targetLTV: 0.5,
   hasBtcFiRewards: true,
   hyperLstVaultAddress: ContractAddr.from(
@@ -1013,8 +1045,7 @@ const boostedCarryRiskFactors: RiskFactor[] = [
     value: OracleRiskLevel.SINGLE_RELIABLE,
     // 10% — Vesu HF depends on feeds; Starknet oracles are established but not redundant here.
     weight: 10,
-    reason:
-      "Vesu collateral and debt valuations rely on Starknet price feeds.",
+    reason: "Vesu collateral and debt valuations rely on Starknet price feeds.",
   },
   {
     type: RiskType.COUNTERPARTY_RISK,
@@ -1065,9 +1096,10 @@ function getBoostedCarryFAQs(
       question: "Which protocols are used?",
       answer: (
         <span>
-          <strong>Vesu</strong> for collateral and borrowing, <strong>Avnu</strong>{" "}
-          for swaps, <strong>Endur</strong> for {lstSymbol}, and the Troves{" "}
-          <strong>Hyper-{lstSymbol}</strong> vault for the boosted leg.
+          <strong>Vesu</strong> for collateral and borrowing,{" "}
+          <strong>Avnu</strong> for swaps, <strong>Endur</strong> for{" "}
+          {lstSymbol}, and the Troves <strong>Hyper-{lstSymbol}</strong> vault
+          for the boosted leg.
         </span>
       ),
     },
@@ -1160,6 +1192,9 @@ function getStrategySettings(
       ],
     },
     contractDetails: getContractDetails(settings),
+    feeBps: {
+      performanceFeeBps: 1500,
+    },
     faqs: getBoostedCarryFAQs(
       depositToken.symbol,
       debtToken.symbol,
@@ -1180,7 +1215,8 @@ function getStrategySettings(
       auditStatus: AuditStatus.AUDITED,
       sourceCode: {
         type: SourceCodeType.OPEN_SOURCE,
-        contractLink: "https://github.com/trovesfi/starknet_vault_kit/tree/sherlock-audited",
+        contractLink:
+          "https://github.com/trovesfi/starknet_vault_kit/tree/sherlock-audited",
       },
       // TODO
       accessControl: {
@@ -1206,7 +1242,8 @@ function getStrategySettings(
       ],
     },
     usualTimeToEarnings: "2 weeks",
-    usualTimeToEarningsDescription: "This strategy depends on Hyper xSTRK's yield, which depends on the price of xSTRK on DEX appreciating. It may be possible the increase is not continuous and generally rebases atleast once every 2 weeks.",
+    usualTimeToEarningsDescription:
+      "This strategy depends on Hyper xSTRK's yield, which depends on the price of xSTRK on DEX appreciating. It may be possible the increase is not continuous and generally rebases atleast once every 2 weeks.",
   };
 }
 

package/src/strategies/universal-lst-muliplier-strategy.tsx

@@ -8,7 +8,7 @@ import { AVNU_EXCHANGE } from "./universal-adapters/adapter-utils";
 import { DepegRiskLevel, LiquidationRiskLevel, SmartContractRiskLevel, TechnicalRiskLevel } from "@/interfaces/risks";
 import { AvnuWrapper, EkuboQuoter, ERC20, LSTAPRService, PricerFromApi, PricerLST } from "@/modules";
 import { assert, logger } from "@/utils";
-import { SingleActionAmount, SingleTokenInfo } from "./base-strategy";
+import { SingleActionAmount, SingleTokenInfo, UserPositionCard, UserPositionCardsInput } from "./base-strategy";
 import { SVKStrategy } from "./svk-strategy";
 import { Call, Contract, uint256 } from "starknet";
 import ERC4626Abi from "@/data/erc4626.abi.json";
@@ -119,8 +119,8 @@ export class UniversalLstMultiplierStrategy<S extends HyperLSTStrategySettings>
   // todo support lending assets of underlying as well (like if xSTRK looping is not viable, simply supply STRK)
   getVesuMultiplyAdapters() {
     const vesuMultipleAdapters = this.metadata.additionalInfo.adapters
-    .filter(adapter => adapter.adapter.name === VesuMultiplyAdapter.name)
-    .map(adapter => adapter.adapter) as VesuMultiplyAdapter[]
+      .filter(adapter => adapter.adapter.name === VesuMultiplyAdapter.name)
+      .map(adapter => adapter.adapter) as VesuMultiplyAdapter[]
 
     for (const vesuAdapter of vesuMultipleAdapters) {
       vesuAdapter.config.pricer = this.pricer;
@@ -586,7 +586,7 @@ export class UniversalLstMultiplierStrategy<S extends HyperLSTStrategySettings>
     };
   }
 
-  async getAUM(unrealizedAUM: boolean = false): Promise<{net: SingleTokenInfo, prevAum: Web3Number, splits: PositionInfo[]}> {
+  async getAUM(unrealizedAUM: boolean = false): Promise<{ net: SingleTokenInfo, prevAum: Web3Number, splits: PositionInfo[] }> {
     const underlying = this.asset();
     assert(underlying.symbol.startsWith('x'), 'Underlying is not an LST of Endur');
 
@@ -642,7 +642,7 @@ export class UniversalLstMultiplierStrategy<S extends HyperLSTStrategySettings>
       tokenInfo: underlying,
       amount: netAUM,
       usdValue: netAUM.toNumber() * assetPrice.price,
-      apy: {apy: 0, type: APYType.BASE}, // VT: Dont remember why this field exists here. FOr now, set it to 0.
+      apy: { apy: 0, type: APYType.BASE }, // VT: Dont remember why this field exists here. FOr now, set it to 0.
       remarks: AUMTypes.FINALISED,
       protocol: Protocols.NONE
     };
@@ -651,16 +651,18 @@ export class UniversalLstMultiplierStrategy<S extends HyperLSTStrategySettings>
       tokenInfo: underlying,
       amount: Web3Number.fromWei('0', underlying.decimals),
       usdValue: 0,
-      apy: {apy: 0, type: APYType.BASE},
+      apy: { apy: 0, type: APYType.BASE },
       remarks: AUMTypes.DEFISPRING,
       protocol: Protocols.NONE
     };
 
-    return {net: {
-      tokenInfo: underlying,
-      amount: netAUM,
-      usdValue: netAUM.toNumber() * assetPrice.price
-    }, prevAum: prevAum, splits: [realAUM, estimatedAUMDelta]};
+    return {
+      net: {
+        tokenInfo: underlying,
+        amount: netAUM,
+        usdValue: netAUM.toNumber() * assetPrice.price
+      }, prevAum: prevAum, splits: [realAUM, estimatedAUMDelta]
+    };
   }
 
   async getTVLUnrealized() {
@@ -682,6 +684,70 @@ export class UniversalLstMultiplierStrategy<S extends HyperLSTStrategySettings>
     };
   }
 
+  async getUserPositionCards(input: UserPositionCardsInput): Promise<UserPositionCard[]> {
+    const cards = await super.getUserPositionCards(input);
+
+    try {
+      const [unrealizedResult, userTVL, realizedApyRaw] = await Promise.all([
+        this.getUserUnrealizedGains(input.user),
+        this.getUserTVL(input.user),
+        this.getUserRealizedAPY().catch(() => null),
+      ]);
+      const amount = unrealizedResult.unrealizedGains;
+      let usdValue = 0;
+      const userAmount = userTVL.amount.toNumber();
+      if (Number.isFinite(userAmount) && userAmount > 0) {
+        usdValue = (userTVL.usdValue / userAmount) * amount.toNumber();
+      }
+
+      cards.push({
+        title: "Unrealized Gains",
+        tooltip: "Unrealized gains based on current market prices vs Endur prices. If you withdraw now, you will forgo these gains.",
+        value: this.formatTokenAmountForCard(amount, unrealizedResult.tokenInfo),
+        subValue: `≈ ${this.formatUSDForCard(usdValue)}`,
+        subValueColor: this.getSubValueColorFromSignedNumber(usdValue),
+      });
+
+      const realizedApy = typeof realizedApyRaw === "number"
+        ? this.formatPercentForCard(realizedApyRaw)
+        : "N/A";
+      cards.push({
+        title: "Realized APY",
+        tooltip: this.metadata.realizedApyMethodology || "Realized APY is based on past 14 days performance",
+        value: realizedApy,
+      });
+    } catch (error) {
+      logger.warn(`${this.getTag()}::getUserPositionCards unrealized gains fallback`, error);
+      cards.push({
+        title: "Unrealized Gains",
+        tooltip: "Unrealized gains based on current market prices vs Endur prices. If you withdraw now, you will forgo these gains.",
+        value: this.formatTokenAmountForCard(
+          Web3Number.fromWei("0", this.asset().decimals),
+          this.asset()
+        ),
+        subValue: `≈ ${this.formatUSDForCard(0)}`,
+        subValueColor: "default",
+      });
+      cards.push({
+        title: "Realized APY",
+        tooltip: this.metadata.realizedApyMethodology || "Realized APY is based on past 14 days performance",
+        value: "N/A",
+      });
+    }
+
+    if (this.asset().symbol === "xSTRK") {
+      const index = cards.findIndex((card) => card.title === "Lifetime Earnings");
+      if (index >= 0) {
+        cards[index] = {
+          ...cards[index],
+          tooltip: "Lifetime earnings of the vault. Due to migration of xSTRK Sensei to this vault, any migrated funds are also seen as lifetime earnings. Team is working to fix this soon.",
+        };
+      }
+    }
+
+    return cards;
+  }
+
 }
 
 export default function VaultDescription(
@@ -706,7 +772,7 @@ export default function VaultDescription(
       </p>
 
       <p style={{ fontSize: "14px", lineHeight: "1.5", marginBottom: "16px" }}>
-        This vault uses Vesu for lending and borrowing. The oracle used by this pool is a {highlightTextWithLinks("conversion rate oracle", [{highlight: "conversion rate oracle", link: "https://docs.pragma.build/starknet/development#conversion-rate"}])}
+        This vault uses Vesu for lending and borrowing. The oracle used by this pool is a {highlightTextWithLinks("conversion rate oracle", [{ highlight: "conversion rate oracle", link: "https://docs.pragma.build/starknet/development#conversion-rate" }])}
         {" "}which is resilient to liquidity issues and price volatility, hence reducing the risk of liquidation. However, overtime, if left un-monitored, debt can increase enough to trigger a liquidation. But no worries, our continuous monitoring systems look for situations with reduced health factor and balance collateral/debt to bring it back to safe levels. With Troves, you can have a peaceful sleep.
       </p>
 
@@ -747,7 +813,7 @@ function getLooperSettings(
 
   const baseAdapterConfig: BaseAdapterConfig = {
     baseToken: lstToken,
-    supportedPositions: [{asset: lstToken, isDebt: false}, {asset: underlyingToken, isDebt: true}],
+    supportedPositions: [{ asset: lstToken, isDebt: false }, { asset: underlyingToken, isDebt: true }],
     networkConfig: getMainnetConfig(),
     pricer: new PricerFromApi(getMainnetConfig(), Global.getDefaultTokens()),
     vaultAllocator: vaultSettings.vaultAllocator,
@@ -899,7 +965,7 @@ export const _riskFactor: RiskFactor[] = [
   { type: RiskType.SMART_CONTRACT_RISK, value: SmartContractRiskLevel.WELL_AUDITED, weight: 25, reason: "Audited by Zellic" },
   { type: RiskType.LIQUIDATION_RISK, value: LiquidationRiskLevel.VERY_LOW_PROBABILITY, weight: 25, reason: "The collateral and debt are highly correlated" },
   { type: RiskType.TECHNICAL_RISK, value: TechnicalRiskLevel.STABLE_INFRASTRUCTURE, weight: 25, reason: "Liquidation can only happen if vault is left un-monitored for weeks, which is highly unlikely. We actively monitor all services on a daily basis." },
-  {type: RiskType.DEPEG_RISK, value: DepegRiskLevel.GENERALLY_STABLE, weight: 25, reason: "Generally stable pegged assets" },
+  { type: RiskType.DEPEG_RISK, value: DepegRiskLevel.GENERALLY_STABLE, weight: 25, reason: "Generally stable pegged assets" },
 ];
 
 const hyperxSTRK: HyperLSTStrategySettings = {
@@ -1088,8 +1154,8 @@ function createHyperLSTSettings(
         tab: "deposit" as const,
         text: (
           <>
-          To acquire the LST, please visit{" "}
-          <a href="https://app.endur.fi" target="_blank" rel="noopener noreferrer">endur.fi</a>
+            To acquire the LST, please visit{" "}
+            <a href="https://app.endur.fi" target="_blank" rel="noopener noreferrer">endur.fi</a>
           </>
         ),
         type: "info" as const,
@@ -1171,9 +1237,14 @@ function getStrategySettings(
     faqs: getFAQs(lstSymbol, underlyingSymbol, isLST),
     investmentSteps: getInvestmentSteps(lstSymbol, underlyingSymbol),
     isPreview: isPreview,
-    apyMethodology: 'Current annualized APY in terms of base asset of the LST. There is no additional fee taken by Troves on LST APY. We charge a 10% performance fee on the additional gain which is already accounted in the APY shown.',
-    realizedApyMethodology: 'The realizedAPY is based on past 14 days performance by the vault',
-    tags: lstSymbol.includes('BTC')
+    apyMethodology:
+      "Current annualized APY in terms of base asset of the LST. There is no additional fee taken by Troves on LST APY. We charge a 10% performance fee on the additional gain which is already accounted in the APY shown.",
+    realizedApyMethodology:
+      "The realizedAPY is based on past 14 days performance by the vault",
+    feeBps: {
+      performanceFeeBps: 1000,
+    },
+    tags: lstSymbol.includes("BTC")
       ? [StrategyTag.BTC, StrategyTag.LEVERED]
       : [StrategyTag.LEVERED],
     security: HYPER_LST_SECURITY,