@strkfarm/sdk 1.0.46 → 1.0.49

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

@@ -3,6 +3,7 @@ import {
   FAQ,
   FlowChartColors,
   getNoRiskTags,
+  highlightTextWithLinks,
   IConfig,
   IInvestmentFlow,
   IProtocol,
@@ -32,6 +33,7 @@ import { DualTokenInfo } from "./base-strategy";
 import { log } from "winston";
 import { EkuboHarvests } from "@/modules/harvests";
 import { logger } from "@/utils/logger";
+import { COMMON_CONTRACTS } from "./constants";
 
 export interface EkuboPoolKey {
   token0: ContractAddr;
@@ -589,18 +591,16 @@ export class EkuboCLVault extends BaseStrategy<
     console.log(
       `EkuboCLVault: getCurrentPrice: blockIdentifier: ${blockIdentifier}, sqrtRatio: ${sqrtRatio}, ${priceInfo.sqrt_ratio.toString()}`
     );
-    const price = sqrtRatio * sqrtRatio;
-    const tick = EkuboCLVault.priceToTick(
-      price,
-      true,
-      Number(poolKey.tick_spacing)
-    );
+    const token0Info = await Global.getTokenInfoFromAddr(poolKey.token0);
+    const token1Info = await Global.getTokenInfoFromAddr(poolKey.token1);
+    const price = sqrtRatio * sqrtRatio * (10 ** token0Info.decimals) / ( 10 ** token1Info.decimals);
+    const tick = priceInfo.tick;
     console.log(
       `EkuboCLVault: getCurrentPrice: blockIdentifier: ${blockIdentifier}, price: ${price}, tick: ${tick.mag}, ${tick.sign}`
     );
     return {
       price,
-      tick: tick.mag * (tick.sign == 0 ? 1 : -1),
+      tick: Number(tick.mag) * (tick.sign ? -1 : 1),
       sqrtRatio: priceInfo.sqrt_ratio.toString(),
     };
   }
@@ -1505,15 +1505,16 @@ export class EkuboCLVault extends BaseStrategy<
 }
 
 const _description =
-  "Deploys your {{POOL_NAME}} into an Ekubo liquidity pool, automatically rebalancing positions around the current price to optimize yield and reduce the need for manual adjustments. Trading fees and DeFi Spring rewards are automatically compounded back into the strategy. In return, you receive an ERC-20 token representing your share of the strategy. The APY is calculated based on 7-day historical performance.";
+  "Deploys your {{POOL_NAME}} into an Ekubo liquidity pool, automatically rebalancing positions around the current price to optimize yield and reduce the need for manual adjustments. Trading fees and DeFi Spring rewards are automatically compounded back into the strategy. In return, you receive an ERC-20 token representing your share of the strategy";
 const _protocol: IProtocol = {
   name: "Ekubo",
   logo: "https://app.ekubo.org/favicon.ico",
 };
 // need to fine tune better
 const _riskFactor: RiskFactor[] = [
-  { type: RiskType.SMART_CONTRACT_RISK, value: 0.5, weight: 25 },
-  { type: RiskType.IMPERMANENT_LOSS, value: 1, weight: 75 },
+  { type: RiskType.SMART_CONTRACT_RISK, value: 0.5, weight: 34, reason: "Audited smart contracts" },
+  { type: RiskType.IMPERMANENT_LOSS, value: 0.75, weight: 33, reason: "Low risk due to co-related assets" },
+  { type: RiskType.MARKET_RISK, value: 0.75, weight: 33, reason: "Low risk due to co-related assets" },
 ];
 
 const _riskFactorStable: RiskFactor[] = [
@@ -1558,28 +1559,7 @@ const faqs: FAQ[] = [
 
 const xSTRKSTRK: IStrategyMetadata<CLVaultStrategySettings> = {
   name: "Ekubo xSTRK/STRK",
-  description: (
-    <div>
-      <p>{_description.replace("{{POOL_NAME}}", "xSTRK/STRK")}</p>
-      <ul
-        style={{
-          marginLeft: "20px",
-          listStyle: "circle",
-          fontSize: "12px",
-        }}
-      >
-        <li style={{ marginTop: "10px" }}>
-          During withdrawal, you may receive either or both tokens depending
-          on market conditions and prevailing prices.
-        </li>
-        <li style={{ marginTop: "10px" }}>
-          Sometimes you might see a negative APY — this is usually not a big
-          deal. It happens when xSTRK's price drops on DEXes, but things
-          typically bounce back within a few days or a week.
-        </li>
-      </ul>
-    </div>
-  ),
+  description: <></>,
   address: ContractAddr.from(
     "0x01f083b98674bc21effee29ef443a00c7b9a500fd92cf30341a3da12c73f2324"
   ),
@@ -1629,7 +1609,9 @@ const xSTRKSTRK: IStrategyMetadata<CLVaultStrategySettings> = {
     multiplier: 1, 
     logo: 'https://endur.fi/favicon.ico',
     toolTip: "This strategy holds xSTRK and STRK tokens. Earn 1x Endur points on your xSTRK portion of Liquidity. STRK portion will earn Endur's DEX Bonus points. Points can be found on endur.fi.",
-  }]
+  }],
+  contractDetails: [],
+  investmentSteps: []
 };
 
 /**
@@ -1639,48 +1621,18 @@ export const EkuboCLVaultStrategies: IStrategyMetadata<CLVaultStrategySettings>[
   [
     xSTRKSTRK,
     {
+      ...xSTRKSTRK,
       name: "Ekubo USDC/USDT",
-      description: (
-        <div>
-          <p>{_description.replace("{{POOL_NAME}}", "USDC/USDT")}</p>
-          <ul
-            style={{
-              marginLeft: "20px",
-              listStyle: "circle",
-              fontSize: "12px",
-            }}
-          >
-            <li style={{ marginTop: "10px" }}>
-              During withdrawal, you may receive either or both tokens depending
-              on market conditions and prevailing prices.
-            </li>
-          </ul>
-        </div>
-      ),
+      description: <></>,
       address: ContractAddr.from(
         "0xd647ed735f0db52f2a5502b6e06ed21dc4284a43a36af4b60d3c80fbc56c91"
       ),
       launchBlock: 1385576,
-      type: "Other",
       // must be same order as poolKey token0 and token1
       depositTokens: [
         Global.getDefaultTokens().find((t) => t.symbol === "USDC")!,
         Global.getDefaultTokens().find((t) => t.symbol === "USDT")!,
       ],
-      protocols: [_protocol],
-      auditUrl: AUDIT_URL,
-      maxTVL: Web3Number.fromWei("0", 6),
-      risk: {
-        riskFactor: _riskFactorStable,
-        netRisk:
-          _riskFactorStable.reduce(
-            (acc, curr) => acc + curr.value * curr.weight,
-            0
-          ) / _riskFactorStable.reduce((acc, curr) => acc + curr.weight, 0),
-        notARisks: getNoRiskTags(_riskFactorStable),
-      },
-      apyMethodology:
-        "APY based on 7-day historical performance, including fees and rewards.",
       additionalInfo: {
         newBounds: {
           lower: -1,
@@ -1695,50 +1647,82 @@ export const EkuboCLVaultStrategies: IStrategyMetadata<CLVaultStrategySettings>[
           direction: "any",
         },
       },
-      faqs: [...faqs],
     },
-    // {
-    //   ...xSTRKSTRK,
-    //   name: "Ekubo STRK/USDC",
-    //   description: (
-    //     <div>
-    //       <p>{_description.replace("{{POOL_NAME}}", "STRK/USDC")}</p>
-    //       <ul
-    //         style={{
-    //           marginLeft: "20px",
-    //           listStyle: "circle",
-    //           fontSize: "12px",
-    //         }}
-    //       >
-    //         <li style={{ marginTop: "10px" }}>
-    //           During withdrawal, you may receive either or both tokens depending
-    //           on market conditions and prevailing prices.
-    //         </li>
-    //       </ul>
-    //     </div>
-    //   ),
-    //   address: ContractAddr.from(
-    //     "0xb7bd37121041261446d8eedec618955a4490641034942da688e8cbddea7b23"
-    //   ),
-    //   launchBlock: 1492136,
-    //   // must be same order as poolKey token0 and token1
-    //   depositTokens: [
-    //     Global.getDefaultTokens().find((t) => t.symbol === "STRK")!,
-    //     Global.getDefaultTokens().find((t) => t.symbol === "USDC")!,
-    //   ],
-    //   maxTVL: Web3Number.fromWei("0", 6),
-    //   additionalInfo: {
-    //     newBounds: "Managed by Re7",
-    //     feeBps: 1000,
-    //     rebalanceConditions: {
-    //       customShouldRebalance: async (currentPrice: number) =>
-    //         true,
-    //       minWaitHours: 6,
-    //       direction: "any",
-    //     },
-    //   },
-    // },
+    {
+      ...xSTRKSTRK,
+      name: "Ekubo STRK/USDC",
+      description: <></>,
+      address: ContractAddr.from(
+        "0xb7bd37121041261446d8eedec618955a4490641034942da688e8cbddea7b23"
+      ),
+      launchBlock: 1492136,
+      // must be same order as poolKey token0 and token1
+      depositTokens: [
+        Global.getDefaultTokens().find((t) => t.symbol === "STRK")!,
+        Global.getDefaultTokens().find((t) => t.symbol === "USDC")!,
+      ],
+      maxTVL: Web3Number.fromWei("0", 6),
+      additionalInfo: {
+        newBounds: "Managed by Re7",
+        feeBps: 1000,
+        rebalanceConditions: {
+          customShouldRebalance: async (currentPrice: number) =>
+            true,
+          minWaitHours: 6,
+          direction: "any",
+        },
+      },
+    },
 ];
 
-
-// 0x65b6a3ae00e7343ca8b2463d81401716c6581c18336206f31085c06a7d63936
+// auto assign contract details to each strategy
+EkuboCLVaultStrategies.forEach((s) => {
+  // set contract details
+  s.contractDetails = [{
+    address: s.address,
+    name: "Vault",
+    sourceCodeUrl: "https://github.com/strkfarm/strkfarm-contracts/tree/main/src/strategies/cl_vault"
+  }, 
+  ...COMMON_CONTRACTS];
+  // set docs link
+  s.docs = "https://docs.strkfarm.com/p/ekubo-cl-vaults"
+
+  // set description
+  s.description = (
+    <div>
+      <p>{highlightTextWithLinks(
+        _description.replace("{{POOL_NAME}}", s.name.split(" ")[1]),
+          [{
+            highlight: "Ekubo liquidity pool",
+            link: "https://app.ekubo.org/positions",
+          }, {
+            highlight: "DeFi Spring rewards",
+            link: "https://defispring.starknet.io/"
+          }, {
+            highlight: "ERC-20 token",
+            link: "https://www.investopedia.com/news/what-erc20-and-what-does-it-mean-ethereum/"
+          }]
+        )}
+      </p>
+      <div style={{padding: '16px 16px', background: 'var(--chakra-colors-mycard_light)', marginTop: '16px', borderRadius: '16px'}}>
+        <h4 style={{fontWeight: 'bold'}}>Key points to note:</h4>
+        <div style={{display: "flex", flexDirection: "column", gap: "10px", color: 'var(--chakra-colors-text_secondary)'}}>
+          <p style={{}}>1. During withdrawal, you may receive either or both tokens depending
+          on market conditions and prevailing prices.</p>
+          {s.name.includes('xSTRK/STRK') && <p style={{}}>
+              2. Sometimes you might see a negative APY — this is usually not a big
+              deal. It happens when xSTRK's price drops on DEXes, but things
+              typically bounce back within a few days or a week.
+          </p>}
+        </div>
+      </div>
+    </div>
+  );
+
+  // add investment steps
+  s.investmentSteps = [
+    "Supply tokens to Ekubo's pool",
+    "Monitor and Rebalance position to optimize yield",
+    "Harvest and supply Defi Spring STRK rewards every week (Auto-compound)",
+  ]
+});

package/src/strategies/index.ts

@@ -1,4 +1,4 @@
 export * from './autoCompounderStrk';
 export * from './vesu-rebalance';
 export * from './ekubo-cl-vault';
-export * from './base-strategy';
+export * from './base-strategy';

package/src/strategies/vesu-rebalance.tsx

@@ -3,6 +3,7 @@ import {
   FAQ,
   FlowChartColors,
   getNoRiskTags,
+  highlightTextWithLinks,
   IConfig,
   IInvestmentFlow,
   IProtocol,
@@ -26,6 +27,7 @@ import {
 import { getAPIUsingHeadlessBrowser } from "@/node/headless";
 import { VesuHarvests } from "@/modules/harvests";
 import VesuPoolIDs from "@/data/vesu_pools.json";
+import { COMMON_CONTRACTS } from "./constants";
 
 interface PoolProps {
   pool_id: ContractAddr;
@@ -882,17 +884,17 @@ export class VesuRebalance extends BaseStrategy<
   }
 }
 
-const _description =
-  "Automatically diversify {{TOKEN}} holdings into different Vesu pools while reducing risk and maximizing yield. Defi spring STRK Rewards are auto-compounded as well.";
+const _description = "Automatically diversify {{TOKEN}} holdings into different Vesu pools while reducing risk and maximizing yield. Defi spring STRK Rewards are auto-compounded as well.";
+
 const _protocol: IProtocol = {
   name: "Vesu",
   logo: "https://static-assets-8zct.onrender.com/integrations/vesu/logo.png"
 };
 // need to fine tune better
 const _riskFactor: RiskFactor[] = [
-  { type: RiskType.SMART_CONTRACT_RISK, value: 0.5, weight: 25 },
-  { type: RiskType.COUNTERPARTY_RISK, value: 1, weight: 50 },
-  { type: RiskType.ORACLE_RISK, value: 0.5, weight: 25 }
+  { type: RiskType.SMART_CONTRACT_RISK, value: 0.5, weight: 25, reason: "Audited by CSC" },
+  { type: RiskType.COUNTERPARTY_RISK, value: 1, weight: 50, reason: "Reasonable max LTV ratios and Curated by well-known risk managers like Re7" },
+  { type: RiskType.ORACLE_RISK, value: 0.5, weight: 25, reason: "Uses Pragma price feeds, Most reputable price feed on Starknet" }
 ];
 const AUDIT_URL =
   "https://assets.strkfarm.com/strkfarm/audit_report_vesu_and_ekubo_strats.pdf";
@@ -951,7 +953,7 @@ export const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[]
   [
     {
       name: "Vesu Fusion STRK",
-      description: _description.replace("{{TOKEN}}", "STRK"),
+      description: _description,
       address: ContractAddr.from(
         "0x7fb5bcb8525954a60fde4e8fb8220477696ce7117ef264775a1770e23571929"
       ),
@@ -973,7 +975,9 @@ export const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[]
       additionalInfo: {
         feeBps: 1000
       },
-      faqs
+      faqs,
+      contractDetails: [],
+      investmentSteps: []
     },
     {
       name: "Vesu Fusion ETH",
@@ -999,7 +1003,9 @@ export const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[]
       additionalInfo: {
         feeBps: 1000
       },
-      faqs
+      faqs,
+      contractDetails: [],
+      investmentSteps: []
     },
     {
       name: "Vesu Fusion USDC",
@@ -1025,7 +1031,9 @@ export const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[]
       additionalInfo: {
         feeBps: 1000
       },
-      faqs
+      faqs,
+      contractDetails: [],
+      investmentSteps: []
     },
     {
       name: "Vesu Fusion USDT",
@@ -1051,7 +1059,9 @@ export const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[]
       additionalInfo: {
         feeBps: 1000
       },
-      faqs
+      faqs,
+      contractDetails: [],
+      investmentSteps: []
       // }, {
       //     name: 'Vesu Fusion WBTC',
       //     description: _description.replace('{{TOKEN}}', 'WBTC'),
@@ -1068,5 +1078,38 @@ export const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[]
       //     additionalInfo: {
       //         feeBps: 1000,
       //     },
+      
     }
-  ];
+];
+
+// auto assign contract details to each strategy
+VesuRebalanceStrategies.forEach((s) => {
+  // set contract details
+  s.contractDetails = [{
+    address: s.address,
+    name: "Vault",
+    sourceCodeUrl: "https://github.com/strkfarm/strkfarm-contracts/tree/main/src/strategies/vesu_rebalance"
+  }, 
+  ...COMMON_CONTRACTS];
+  // set docs link
+  s.docs = "https://docs.strkfarm.com/p/strategies/vesu-fusion-rebalancing-vaults"
+
+  // set description
+  s.description = highlightTextWithLinks(
+    _description.replace("{{TOKEN}}", s.depositTokens[0].symbol),
+    [{
+      highlight: "Vesu pools",
+      link: "https://vesu.xyz/pools",
+    }, {
+      highlight: "Defi spring STRK Rewards",
+      link: "https://defispring.starknet.io/"
+    }]
+  );
+
+  // add investment steps
+  s.investmentSteps = [
+    "Split the amount and Supply to configured Vesu pools",
+    "Monitor and Rebalance funds across multiple Vesu pools to maximize yield",
+    "Harvest and supply Defi Spring STRK rewards every week (Auto-compound)",
+  ]
+});