@strkfarm/sdk 1.0.46 → 1.0.49

package/dist/index.mjs

@@ -2012,8 +2012,9 @@ var AvnuWrapper = class _AvnuWrapper {
   }
 };
 
-// src/interfaces/common.ts
+// src/interfaces/common.tsx
 import { RpcProvider as RpcProvider2 } from "starknet";
+import { Fragment, jsx } from "react/jsx-runtime";
 var RiskType = /* @__PURE__ */ ((RiskType2) => {
   RiskType2["MARKET_RISK"] = "Market Risk";
   RiskType2["IMPERMANENT_LOSS"] = "Impermanent Loss Risk";
@@ -2069,8 +2070,8 @@ var getRiskExplaination = (riskType) => {
 };
 var getRiskColor = (risk) => {
   const value = risk.value;
-  if (value === 0) return "green";
-  if (value < 2.5) return "yellow";
+  if (value <= 1) return "light_green_2";
+  if (value < 3) return "yellow";
   return "red";
 };
 var getNoRiskTags = (risks) => {
@@ -2079,8 +2080,20 @@ var getNoRiskTags = (risks) => {
     (risk) => !risks.map((risk2) => risk2.type).includes(risk)
   );
   const mergedUnique = [.../* @__PURE__ */ new Set([...noRisks1, ...noRisks2])];
-  return mergedUnique.map((risk) => `No ${risk}`);
+  return mergedUnique;
 };
+function highlightTextWithLinks(put, highlights) {
+  const escapeRegExp = (text) => text.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&");
+  const pattern = new RegExp(
+    `(${highlights.map((m) => escapeRegExp(m.highlight)).join("|")})`,
+    "gi"
+  );
+  const parts = put.split(pattern);
+  return /* @__PURE__ */ jsx(Fragment, { children: parts.map((part, i) => {
+    const match = highlights.find((m) => m.highlight.toLowerCase() === part.toLowerCase());
+    return match ? /* @__PURE__ */ jsx("a", { href: match.link, target: "_blank", style: { color: "var(--chakra-colors-white)", background: "var(--chakra-colors-highlight)" }, children: part }, i) : /* @__PURE__ */ jsx("span", { children: part }, i);
+  }) });
+}
 
 // src/interfaces/initializable.ts
 var Initializable = class {
@@ -9202,8 +9215,15 @@ var vesu_pools_default = {
   ]
 };
 
+// src/strategies/constants.ts
+var COMMON_CONTRACTS = [{
+  address: ContractAddr.from("0x0636a3f51cc37f5729e4da4b1de6a8549a28f3c0d5bf3b17f150971e451ff9c2"),
+  name: "Access Controller",
+  sourceCodeUrl: "https://github.com/strkfarm/strkfarm-contracts/blob/main/src/components/accessControl.cairo"
+}];
+
 // src/strategies/vesu-rebalance.tsx
-import { jsx, jsxs } from "react/jsx-runtime";
+import { jsx as jsx2, jsxs } from "react/jsx-runtime";
 var VesuRebalance = class _VesuRebalance extends BaseStrategy {
   // 10000 bps = 100%
   /**
@@ -9844,9 +9864,9 @@ var _protocol = {
   logo: "https://static-assets-8zct.onrender.com/integrations/vesu/logo.png"
 };
 var _riskFactor = [
-  { type: "Smart Contract Risk" /* SMART_CONTRACT_RISK */, value: 0.5, weight: 25 },
-  { type: "Counterparty Risk" /* COUNTERPARTY_RISK */, value: 1, weight: 50 },
-  { type: "Oracle Risk" /* ORACLE_RISK */, value: 0.5, weight: 25 }
+  { type: "Smart Contract Risk" /* SMART_CONTRACT_RISK */, value: 0.5, weight: 25, reason: "Audited by CSC" },
+  { type: "Counterparty Risk" /* COUNTERPARTY_RISK */, value: 1, weight: 50, reason: "Reasonable max LTV ratios and Curated by well-known risk managers like Re7" },
+  { type: "Oracle Risk" /* ORACLE_RISK */, value: 0.5, weight: 25, reason: "Uses Pragma price feeds, Most reputable price feed on Starknet" }
 ];
 var AUDIT_URL = "https://assets.strkfarm.com/strkfarm/audit_report_vesu_and_ekubo_strats.pdf";
 var faqs = [
@@ -9886,7 +9906,7 @@ var faqs = [
     question: "Is the strategy audited?",
     answer: /* @__PURE__ */ jsxs("div", { children: [
       "Yes, the strategy has been audited. You can review the audit report in our docs ",
-      /* @__PURE__ */ jsx("a", { href: "https://docs.strkfarm.com/p/strategies/vesu-fusion-rebalancing-vaults#technical-details", style: { textDecoration: "underline", marginLeft: "5px" }, children: "Here" }),
+      /* @__PURE__ */ jsx2("a", { href: "https://docs.strkfarm.com/p/strategies/vesu-fusion-rebalancing-vaults#technical-details", style: { textDecoration: "underline", marginLeft: "5px" }, children: "Here" }),
       "."
     ] })
   }
@@ -9894,7 +9914,7 @@ var faqs = [
 var VesuRebalanceStrategies = [
   {
     name: "Vesu Fusion STRK",
-    description: _description.replace("{{TOKEN}}", "STRK"),
+    description: _description,
     address: ContractAddr.from(
       "0x7fb5bcb8525954a60fde4e8fb8220477696ce7117ef264775a1770e23571929"
     ),
@@ -9914,7 +9934,9 @@ var VesuRebalanceStrategies = [
     additionalInfo: {
       feeBps: 1e3
     },
-    faqs
+    faqs,
+    contractDetails: [],
+    investmentSteps: []
   },
   {
     name: "Vesu Fusion ETH",
@@ -9938,7 +9960,9 @@ var VesuRebalanceStrategies = [
     additionalInfo: {
       feeBps: 1e3
     },
-    faqs
+    faqs,
+    contractDetails: [],
+    investmentSteps: []
   },
   {
     name: "Vesu Fusion USDC",
@@ -9962,7 +9986,9 @@ var VesuRebalanceStrategies = [
     additionalInfo: {
       feeBps: 1e3
     },
-    faqs
+    faqs,
+    contractDetails: [],
+    investmentSteps: []
   },
   {
     name: "Vesu Fusion USDT",
@@ -9986,7 +10012,9 @@ var VesuRebalanceStrategies = [
     additionalInfo: {
       feeBps: 1e3
     },
-    faqs
+    faqs,
+    contractDetails: [],
+    investmentSteps: []
     // }, {
     //     name: 'Vesu Fusion WBTC',
     //     description: _description.replace('{{TOKEN}}', 'WBTC'),
@@ -10005,6 +10033,32 @@ var VesuRebalanceStrategies = [
     //     },
   }
 ];
+VesuRebalanceStrategies.forEach((s) => {
+  s.contractDetails = [
+    {
+      address: s.address,
+      name: "Vault",
+      sourceCodeUrl: "https://github.com/strkfarm/strkfarm-contracts/tree/main/src/strategies/vesu_rebalance"
+    },
+    ...COMMON_CONTRACTS
+  ];
+  s.docs = "https://docs.strkfarm.com/p/strategies/vesu-fusion-rebalancing-vaults";
+  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/"
+    }]
+  );
+  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)"
+  ];
+});
 
 // src/strategies/ekubo-cl-vault.tsx
 import {
@@ -14913,7 +14967,7 @@ var erc4626_abi_default = [
 ];
 
 // src/strategies/ekubo-cl-vault.tsx
-import { jsx as jsx2, jsxs as jsxs2 } from "react/jsx-runtime";
+import { Fragment as Fragment2, jsx as jsx3, jsxs as jsxs2 } from "react/jsx-runtime";
 var EkuboCLVault = class _EkuboCLVault extends BaseStrategy {
   /**
    * Creates a new VesuRebalance strategy instance.
@@ -15320,18 +15374,16 @@ var EkuboCLVault = 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()
     };
   }
@@ -15978,14 +16030,15 @@ var EkuboCLVault = class _EkuboCLVault extends BaseStrategy {
     return [baseFlow, rebalanceFlow];
   }
 };
-var _description2 = "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.";
+var _description2 = "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";
 var _protocol2 = {
   name: "Ekubo",
   logo: "https://app.ekubo.org/favicon.ico"
 };
 var _riskFactor2 = [
-  { type: "Smart Contract Risk" /* SMART_CONTRACT_RISK */, value: 0.5, weight: 25 },
-  { type: "Impermanent Loss Risk" /* IMPERMANENT_LOSS */, value: 1, weight: 75 }
+  { type: "Smart Contract Risk" /* SMART_CONTRACT_RISK */, value: 0.5, weight: 34, reason: "Audited smart contracts" },
+  { type: "Impermanent Loss Risk" /* IMPERMANENT_LOSS */, value: 0.75, weight: 33, reason: "Low risk due to co-related assets" },
+  { type: "Market Risk" /* MARKET_RISK */, value: 0.75, weight: 33, reason: "Low risk due to co-related assets" }
 ];
 var _riskFactorStable = [
   { type: "Smart Contract Risk" /* SMART_CONTRACT_RISK */, value: 0.5, weight: 25 }
@@ -16009,7 +16062,7 @@ var faqs2 = [
     answer: /* @__PURE__ */ jsxs2("div", { children: [
       "Yes, the strategy has been audited. You can review the audit report in our docs",
       " ",
-      /* @__PURE__ */ jsx2(
+      /* @__PURE__ */ jsx3(
         "a",
         {
           href: "https://docs.strkfarm.com/p/ekubo-cl-vaults#technical-details",
@@ -16023,23 +16076,7 @@ var faqs2 = [
 ];
 var xSTRKSTRK = {
   name: "Ekubo xSTRK/STRK",
-  description: /* @__PURE__ */ jsxs2("div", { children: [
-    /* @__PURE__ */ jsx2("p", { children: _description2.replace("{{POOL_NAME}}", "xSTRK/STRK") }),
-    /* @__PURE__ */ jsxs2(
-      "ul",
-      {
-        style: {
-          marginLeft: "20px",
-          listStyle: "circle",
-          fontSize: "12px"
-        },
-        children: [
-          /* @__PURE__ */ jsx2("li", { style: { marginTop: "10px" }, children: "During withdrawal, you may receive either or both tokens depending on market conditions and prevailing prices." }),
-          /* @__PURE__ */ jsx2("li", { style: { marginTop: "10px" }, children: "Sometimes you might see a negative APY \u2014 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." })
-        ]
-      }
-    )
-  ] }),
+  description: /* @__PURE__ */ jsx3(Fragment2, {}),
   address: ContractAddr.from(
     "0x01f083b98674bc21effee29ef443a00c7b9a500fd92cf30341a3da12c73f2324"
   ),
@@ -16085,48 +16122,25 @@ var xSTRKSTRK = {
     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: []
 };
 var EkuboCLVaultStrategies = [
   xSTRKSTRK,
   {
+    ...xSTRKSTRK,
     name: "Ekubo USDC/USDT",
-    description: /* @__PURE__ */ jsxs2("div", { children: [
-      /* @__PURE__ */ jsx2("p", { children: _description2.replace("{{POOL_NAME}}", "USDC/USDT") }),
-      /* @__PURE__ */ jsx2(
-        "ul",
-        {
-          style: {
-            marginLeft: "20px",
-            listStyle: "circle",
-            fontSize: "12px"
-          },
-          children: /* @__PURE__ */ jsx2("li", { style: { marginTop: "10px" }, children: "During withdrawal, you may receive either or both tokens depending on market conditions and prevailing prices." })
-        }
-      )
-    ] }),
+    description: /* @__PURE__ */ jsx3(Fragment2, {}),
     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: [_protocol2],
-    auditUrl: AUDIT_URL2,
-    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,
@@ -16139,51 +16153,71 @@ var EkuboCLVaultStrategies = [
         minWaitHours: 6,
         direction: "any"
       }
-    },
-    faqs: [...faqs2]
+    }
+  },
+  {
+    ...xSTRKSTRK,
+    name: "Ekubo STRK/USDC",
+    description: /* @__PURE__ */ jsx3(Fragment2, {}),
+    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: 1e3,
+      rebalanceConditions: {
+        customShouldRebalance: async (currentPrice) => true,
+        minWaitHours: 6,
+        direction: "any"
+      }
+    }
   }
-  // {
-  //   ...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",
-  //     },
-  //   },
-  // },
 ];
+EkuboCLVaultStrategies.forEach((s) => {
+  s.contractDetails = [
+    {
+      address: s.address,
+      name: "Vault",
+      sourceCodeUrl: "https://github.com/strkfarm/strkfarm-contracts/tree/main/src/strategies/cl_vault"
+    },
+    ...COMMON_CONTRACTS
+  ];
+  s.docs = "https://docs.strkfarm.com/p/ekubo-cl-vaults";
+  s.description = /* @__PURE__ */ jsxs2("div", { children: [
+    /* @__PURE__ */ jsx3("p", { children: highlightTextWithLinks(
+      _description2.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/"
+      }]
+    ) }),
+    /* @__PURE__ */ jsxs2("div", { style: { padding: "16px 16px", background: "var(--chakra-colors-mycard_light)", marginTop: "16px", borderRadius: "16px" }, children: [
+      /* @__PURE__ */ jsx3("h4", { style: { fontWeight: "bold" }, children: "Key points to note:" }),
+      /* @__PURE__ */ jsxs2("div", { style: { display: "flex", flexDirection: "column", gap: "10px", color: "var(--chakra-colors-text_secondary)" }, children: [
+        /* @__PURE__ */ jsx3("p", { style: {}, children: "1. During withdrawal, you may receive either or both tokens depending on market conditions and prevailing prices." }),
+        s.name.includes("xSTRK/STRK") && /* @__PURE__ */ jsx3("p", { style: {}, children: "2. Sometimes you might see a negative APY \u2014 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." })
+      ] })
+    ] })
+  ] });
+  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)"
+  ];
+});
 
 // src/notifs/telegram.ts
 import TelegramBot from "node-telegram-bot-api";
@@ -16480,5 +16514,6 @@ export {
   getNoRiskTags,
   getRiskColor,
   getRiskExplaination,
+  highlightTextWithLinks,
   logger
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strkfarm/sdk",
-  "version": "1.0.46",
+  "version": "1.0.49",
   "description": "STRKFarm TS SDK (Meant for our internal use, but feel free to use it)",
   "typings": "dist/index.d.ts",
   "types": "dist/index.d.ts",
@@ -56,7 +56,7 @@
     "axios": "^1.7.2"
   },
   "dependencies": {
-    "@avnu/avnu-sdk": "^3.0.2",
+    "@avnu/avnu-sdk": "3.0.2",
     "bignumber.js": "4.0.4",
     "browser-assert": "^1.2.1",
     "chalk": "^4.1.2",

package/src/interfaces/{common.ts → common.tsx}

@@ -1,6 +1,6 @@
 import { ContractAddr, Web3Number } from "@/dataTypes";
 import { BlockIdentifier, RpcProvider } from "starknet";
-import React from "react";
+import React, { ReactNode } from "react";
 
 export enum RiskType {
   MARKET_RISK = "Market Risk",
@@ -21,6 +21,7 @@ export interface RiskFactor {
   type: RiskType;
   value: number; // 0 to 5
   weight: number; // 0 to 100
+  reason?: string; // optional reason for the risk factor
 }
 
 export interface TokenInfo {
@@ -79,12 +80,19 @@ export interface IStrategyMetadata<T> {
   risk: {
     riskFactor: RiskFactor[];
     netRisk: number;
-    notARisks: string[];
+    notARisks: RiskType[];
   };
   apyMethodology?: string;
   additionalInfo: T;
+  contractDetails: {
+    address: ContractAddr;
+    name: string;
+    sourceCodeUrl?: string;
+  }[],
   faqs: FAQ[];
   points?: {multiplier: number, logo: string, toolTip?: string}[];
+  docs?: string;
+  investmentSteps: string[];
 }
 
 export interface IInvestmentFlow {
@@ -132,8 +140,8 @@ export const getRiskExplaination = (riskType: RiskType) => {
 
 export const getRiskColor = (risk: RiskFactor) => {
   const value = risk.value;
-  if (value === 0) return "green";
-  if (value < 2.5) return "yellow";
+  if (value <= 1) return "light_green_2";
+  if (value < 3) return "yellow";
   return "red";
 };
 
@@ -150,5 +158,42 @@ export const getNoRiskTags = (risks: RiskFactor[]) => {
   const mergedUnique = [...new Set([...noRisks1, ...noRisks2])];
 
   // add `No` to the start of each risk
-  return mergedUnique.map((risk) => `No ${risk}`);
+  return mergedUnique
 };
+
+interface HighlightLink {
+  highlight: string;
+  link: string;
+}
+
+export function highlightTextWithLinks(
+  put: string,
+  highlights: HighlightLink[],
+): ReactNode {
+  // Escape RegExp special characters in highlight strings
+  const escapeRegExp = (text: string) =>
+    text.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&');
+
+  // Create a single regex for all highlight terms
+  const pattern = new RegExp(
+    `(${highlights.map(m => escapeRegExp(m.highlight)).join('|')})`,
+    'gi'
+  );
+
+  const parts = put.split(pattern);
+
+  return (
+    <>
+      {parts.map((part, i) => {
+        const match = highlights.find(m => m.highlight.toLowerCase() === part.toLowerCase());
+        return match ? (
+          <a key={i} href={match.link} target="_blank" style={{ color: 'var(--chakra-colors-white)', background: 'var(--chakra-colors-highlight)' }}>
+            {part}
+          </a>
+        ) : (
+          <span key={i}>{part}</span>
+        );
+      })}
+    </>
+  );
+}

package/src/strategies/constants.ts

@@ -0,0 +1,7 @@
+import { ContractAddr } from "@/dataTypes";
+
+export const COMMON_CONTRACTS = [{
+  address: ContractAddr.from("0x0636a3f51cc37f5729e4da4b1de6a8549a28f3c0d5bf3b17f150971e451ff9c2"),
+  name: "Access Controller",
+  sourceCodeUrl: "https://github.com/strkfarm/strkfarm-contracts/blob/main/src/components/accessControl.cairo",
+}];