@strkfarm/sdk 1.0.30 → 1.0.32

package/dist/index.browser.mjs

@@ -2089,7 +2089,7 @@ var AutoCompounderSTRK = class {
   }
 };
 
-// src/strategies/vesu-rebalance.ts
+// src/strategies/vesu-rebalance.tsx
 import { CairoCustomEnum, Contract as Contract5, num as num3, uint256 as uint2563 } from "starknet";
 
 // src/data/vesu-rebalance.abi.json
@@ -12697,7 +12697,7 @@ var vesu_pools_default = {
   ]
 };
 
-// src/strategies/vesu-rebalance.ts
+// src/strategies/vesu-rebalance.tsx
 var VesuRebalance = class _VesuRebalance extends BaseStrategy {
   // 10000 bps = 100%
   /**
@@ -12824,6 +12824,11 @@ var VesuRebalance = class _VesuRebalance extends BaseStrategy {
     let vTokenContract = new Contract5(vesu_rebalance_abi_default, p.v_token.address, this.config.provider);
     const bal = await vTokenContract.balanceOf(this.address.address);
     const assets = await vTokenContract.convert_to_assets(uint2563.bnToUint256(bal.toString()));
+    logger.verbose(`Collateral: ${JSON.stringify(vesuPosition?.collateral)}`);
+    logger.verbose(`supplyApy: ${JSON.stringify(assetInfo?.stats.supplyApy)}`);
+    logger.verbose(`defiSpringSupplyApr: ${JSON.stringify(assetInfo?.stats.defiSpringSupplyApr)}`);
+    logger.verbose(`currentUtilization: ${JSON.stringify(assetInfo?.stats.currentUtilization)}`);
+    logger.verbose(`maxUtilization: ${JSON.stringify(assetInfo?.config.maxUtilization)}`);
     const item = {
       pool_id: p.pool_id,
       pool_name: _pool?.name,
@@ -12838,7 +12843,7 @@ var VesuRebalance = class _VesuRebalance extends BaseStrategy {
         netApy: 0
       } : {
         baseApy: Number(Web3Number.fromWei(assetInfo.stats.supplyApy.value, assetInfo.stats.supplyApy.decimals).toFixed(6)),
-        defiSpringApy: Number(Web3Number.fromWei(assetInfo.stats.defiSpringSupplyApr.value, assetInfo.stats.defiSpringSupplyApr.decimals).toFixed(6)),
+        defiSpringApy: assetInfo.stats.defiSpringSupplyApr ? Number(Web3Number.fromWei(assetInfo.stats.defiSpringSupplyApr.value, assetInfo.stats.defiSpringSupplyApr.decimals).toFixed(6)) : 0,
         netApy: 0
       },
       currentUtilization: isErrorPoolsAPI || !assetInfo ? 0 : Number(Web3Number.fromWei(assetInfo.stats.currentUtilization.value, assetInfo.stats.currentUtilization.decimals).toFixed(6)),
@@ -13193,7 +13198,7 @@ var VesuRebalanceStrategies = [{
   //     },
 }];
 
-// src/strategies/ekubo-cl-vault.ts
+// src/strategies/ekubo-cl-vault.tsx
 import { Contract as Contract6, num as num4, uint256 as uint2564 } from "starknet";
 
 // src/data/cl-vault.abi.json
@@ -18095,7 +18100,8 @@ var erc4626_abi_default = [
   }
 ];
 
-// src/strategies/ekubo-cl-vault.ts
+// src/strategies/ekubo-cl-vault.tsx
+import { jsx, jsxs } from "react/jsx-runtime";
 var EkuboCLVault = class _EkuboCLVault extends BaseStrategy {
   /**
    * Creates a new VesuRebalance strategy instance.
@@ -18809,7 +18815,13 @@ var _riskFactor2 = [
 var AUDIT_URL2 = "https://assets.strkfarm.com/strkfarm/audit_report_vesu_and_ekubo_strats.pdf";
 var EkuboCLVaultStrategies = [{
   name: "Ekubo xSTRK/STRK",
-  description: _description2.replace("{{POOL_NAME}}", "xSTRK/STRK"),
+  description: /* @__PURE__ */ jsxs("div", { children: [
+    /* @__PURE__ */ jsx("p", { children: _description2.replace("{{POOL_NAME}}", "xSTRK/STRK") }),
+    /* @__PURE__ */ jsxs("ul", { style: { marginLeft: "20px", listStyle: "circle", fontSize: "12px" }, children: [
+      /* @__PURE__ */ jsx("li", { style: { marginTop: "10px" }, children: "During withdrawal, you may receive either or both tokens depending on market conditions and prevailing prices." }),
+      /* @__PURE__ */ jsx("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." })
+    ] })
+  ] }),
   address: ContractAddr.from("0x01f083b98674bc21effee29ef443a00c7b9a500fd92cf30341a3da12c73f2324"),
   type: "Other",
   // must be same order as poolKey token0 and token1

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import BigNumber from 'bignumber.js';
 import * as starknet from 'starknet';
 import { RpcProvider, BlockIdentifier, Contract, Uint256, Call, Account } from 'starknet';
+import React from 'react';
 import { Quote } from '@avnu/avnu-sdk';
 import * as util from 'util';
 import TelegramBot from 'node-telegram-bot-api';
@@ -90,7 +91,7 @@ declare enum FlowChartColors {
  */
 interface IStrategyMetadata<T> {
     name: string;
-    description: string;
+    description: string | React.ReactNode;
     address: ContractAddr;
     type: 'ERC4626' | 'ERC721' | 'Other';
     depositTokens: TokenInfo[];

package/dist/index.js

@@ -2178,7 +2178,7 @@ var AutoCompounderSTRK = class {
   }
 };
 
-// src/strategies/vesu-rebalance.ts
+// src/strategies/vesu-rebalance.tsx
 var import_starknet8 = require("starknet");
 
 // src/data/vesu-rebalance.abi.json
@@ -12786,7 +12786,7 @@ var vesu_pools_default = {
   ]
 };
 
-// src/strategies/vesu-rebalance.ts
+// src/strategies/vesu-rebalance.tsx
 var VesuRebalance = class _VesuRebalance extends BaseStrategy {
   // 10000 bps = 100%
   /**
@@ -12913,6 +12913,11 @@ var VesuRebalance = class _VesuRebalance extends BaseStrategy {
     let vTokenContract = new import_starknet8.Contract(vesu_rebalance_abi_default, p.v_token.address, this.config.provider);
     const bal = await vTokenContract.balanceOf(this.address.address);
     const assets = await vTokenContract.convert_to_assets(import_starknet8.uint256.bnToUint256(bal.toString()));
+    logger.verbose(`Collateral: ${JSON.stringify(vesuPosition?.collateral)}`);
+    logger.verbose(`supplyApy: ${JSON.stringify(assetInfo?.stats.supplyApy)}`);
+    logger.verbose(`defiSpringSupplyApr: ${JSON.stringify(assetInfo?.stats.defiSpringSupplyApr)}`);
+    logger.verbose(`currentUtilization: ${JSON.stringify(assetInfo?.stats.currentUtilization)}`);
+    logger.verbose(`maxUtilization: ${JSON.stringify(assetInfo?.config.maxUtilization)}`);
     const item = {
       pool_id: p.pool_id,
       pool_name: _pool?.name,
@@ -12927,7 +12932,7 @@ var VesuRebalance = class _VesuRebalance extends BaseStrategy {
         netApy: 0
       } : {
         baseApy: Number(Web3Number.fromWei(assetInfo.stats.supplyApy.value, assetInfo.stats.supplyApy.decimals).toFixed(6)),
-        defiSpringApy: Number(Web3Number.fromWei(assetInfo.stats.defiSpringSupplyApr.value, assetInfo.stats.defiSpringSupplyApr.decimals).toFixed(6)),
+        defiSpringApy: assetInfo.stats.defiSpringSupplyApr ? Number(Web3Number.fromWei(assetInfo.stats.defiSpringSupplyApr.value, assetInfo.stats.defiSpringSupplyApr.decimals).toFixed(6)) : 0,
         netApy: 0
       },
       currentUtilization: isErrorPoolsAPI || !assetInfo ? 0 : Number(Web3Number.fromWei(assetInfo.stats.currentUtilization.value, assetInfo.stats.currentUtilization.decimals).toFixed(6)),
@@ -13282,7 +13287,7 @@ var VesuRebalanceStrategies = [{
   //     },
 }];
 
-// src/strategies/ekubo-cl-vault.ts
+// src/strategies/ekubo-cl-vault.tsx
 var import_starknet9 = require("starknet");
 
 // src/data/cl-vault.abi.json
@@ -18184,7 +18189,8 @@ var erc4626_abi_default = [
   }
 ];
 
-// src/strategies/ekubo-cl-vault.ts
+// src/strategies/ekubo-cl-vault.tsx
+var import_jsx_runtime = require("react/jsx-runtime");
 var EkuboCLVault = class _EkuboCLVault extends BaseStrategy {
   /**
    * Creates a new VesuRebalance strategy instance.
@@ -18898,7 +18904,13 @@ var _riskFactor2 = [
 var AUDIT_URL2 = "https://assets.strkfarm.com/strkfarm/audit_report_vesu_and_ekubo_strats.pdf";
 var EkuboCLVaultStrategies = [{
   name: "Ekubo xSTRK/STRK",
-  description: _description2.replace("{{POOL_NAME}}", "xSTRK/STRK"),
+  description: /* @__PURE__ */ (0, import_jsx_runtime.jsxs)("div", { children: [
+    /* @__PURE__ */ (0, import_jsx_runtime.jsx)("p", { children: _description2.replace("{{POOL_NAME}}", "xSTRK/STRK") }),
+    /* @__PURE__ */ (0, import_jsx_runtime.jsxs)("ul", { style: { marginLeft: "20px", listStyle: "circle", fontSize: "12px" }, children: [
+      /* @__PURE__ */ (0, import_jsx_runtime.jsx)("li", { style: { marginTop: "10px" }, children: "During withdrawal, you may receive either or both tokens depending on market conditions and prevailing prices." }),
+      /* @__PURE__ */ (0, import_jsx_runtime.jsx)("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." })
+    ] })
+  ] }),
   address: ContractAddr.from("0x01f083b98674bc21effee29ef443a00c7b9a500fd92cf30341a3da12c73f2324"),
   type: "Other",
   // must be same order as poolKey token0 and token1

package/dist/index.mjs

@@ -2109,7 +2109,7 @@ var AutoCompounderSTRK = class {
   }
 };
 
-// src/strategies/vesu-rebalance.ts
+// src/strategies/vesu-rebalance.tsx
 import { CairoCustomEnum, Contract as Contract5, num as num3, uint256 as uint2563 } from "starknet";
 
 // src/data/vesu-rebalance.abi.json
@@ -12717,7 +12717,7 @@ var vesu_pools_default = {
   ]
 };
 
-// src/strategies/vesu-rebalance.ts
+// src/strategies/vesu-rebalance.tsx
 var VesuRebalance = class _VesuRebalance extends BaseStrategy {
   // 10000 bps = 100%
   /**
@@ -12844,6 +12844,11 @@ var VesuRebalance = class _VesuRebalance extends BaseStrategy {
     let vTokenContract = new Contract5(vesu_rebalance_abi_default, p.v_token.address, this.config.provider);
     const bal = await vTokenContract.balanceOf(this.address.address);
     const assets = await vTokenContract.convert_to_assets(uint2563.bnToUint256(bal.toString()));
+    logger.verbose(`Collateral: ${JSON.stringify(vesuPosition?.collateral)}`);
+    logger.verbose(`supplyApy: ${JSON.stringify(assetInfo?.stats.supplyApy)}`);
+    logger.verbose(`defiSpringSupplyApr: ${JSON.stringify(assetInfo?.stats.defiSpringSupplyApr)}`);
+    logger.verbose(`currentUtilization: ${JSON.stringify(assetInfo?.stats.currentUtilization)}`);
+    logger.verbose(`maxUtilization: ${JSON.stringify(assetInfo?.config.maxUtilization)}`);
     const item = {
       pool_id: p.pool_id,
       pool_name: _pool?.name,
@@ -12858,7 +12863,7 @@ var VesuRebalance = class _VesuRebalance extends BaseStrategy {
         netApy: 0
       } : {
         baseApy: Number(Web3Number.fromWei(assetInfo.stats.supplyApy.value, assetInfo.stats.supplyApy.decimals).toFixed(6)),
-        defiSpringApy: Number(Web3Number.fromWei(assetInfo.stats.defiSpringSupplyApr.value, assetInfo.stats.defiSpringSupplyApr.decimals).toFixed(6)),
+        defiSpringApy: assetInfo.stats.defiSpringSupplyApr ? Number(Web3Number.fromWei(assetInfo.stats.defiSpringSupplyApr.value, assetInfo.stats.defiSpringSupplyApr.decimals).toFixed(6)) : 0,
         netApy: 0
       },
       currentUtilization: isErrorPoolsAPI || !assetInfo ? 0 : Number(Web3Number.fromWei(assetInfo.stats.currentUtilization.value, assetInfo.stats.currentUtilization.decimals).toFixed(6)),
@@ -13213,7 +13218,7 @@ var VesuRebalanceStrategies = [{
   //     },
 }];
 
-// src/strategies/ekubo-cl-vault.ts
+// src/strategies/ekubo-cl-vault.tsx
 import { Contract as Contract6, num as num4, uint256 as uint2564 } from "starknet";
 
 // src/data/cl-vault.abi.json
@@ -18115,7 +18120,8 @@ var erc4626_abi_default = [
   }
 ];
 
-// src/strategies/ekubo-cl-vault.ts
+// src/strategies/ekubo-cl-vault.tsx
+import { jsx, jsxs } from "react/jsx-runtime";
 var EkuboCLVault = class _EkuboCLVault extends BaseStrategy {
   /**
    * Creates a new VesuRebalance strategy instance.
@@ -18829,7 +18835,13 @@ var _riskFactor2 = [
 var AUDIT_URL2 = "https://assets.strkfarm.com/strkfarm/audit_report_vesu_and_ekubo_strats.pdf";
 var EkuboCLVaultStrategies = [{
   name: "Ekubo xSTRK/STRK",
-  description: _description2.replace("{{POOL_NAME}}", "xSTRK/STRK"),
+  description: /* @__PURE__ */ jsxs("div", { children: [
+    /* @__PURE__ */ jsx("p", { children: _description2.replace("{{POOL_NAME}}", "xSTRK/STRK") }),
+    /* @__PURE__ */ jsxs("ul", { style: { marginLeft: "20px", listStyle: "circle", fontSize: "12px" }, children: [
+      /* @__PURE__ */ jsx("li", { style: { marginTop: "10px" }, children: "During withdrawal, you may receive either or both tokens depending on market conditions and prevailing prices." }),
+      /* @__PURE__ */ jsx("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." })
+    ] })
+  ] }),
   address: ContractAddr.from("0x01f083b98674bc21effee29ef443a00c7b9a500fd92cf30341a3da12c73f2324"),
   type: "Other",
   // must be same order as poolKey token0 and token1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strkfarm/sdk",
-  "version": "1.0.30",
+  "version": "1.0.32",
   "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",
@@ -41,6 +41,7 @@
   "devDependencies": {
     "@types/jest": "^29.5.12",
     "@types/node-telegram-bot-api": "^0.64.7",
+    "@types/react": "^19.1.2",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "ts-jest": "^29.1.5",
@@ -49,6 +50,9 @@
     "typedoc": "^0.26.3",
     "typescript": "^5.5.3"
   },
+  "peerDependencies": {
+    "react": "19.1.0"
+  },
   "dependencies": {
     "@avnu/avnu-sdk": "^3.0.2",
     "axios": "^1.7.2",

package/src/interfaces/common.ts

@@ -1,5 +1,6 @@
 import { ContractAddr, Web3Number } from "@/dataTypes"
 import { BlockIdentifier, RpcProvider } from "starknet"
+import React from 'react';
 
 export enum RiskType {
     MARKET_RISK = 'Market Risk',
@@ -62,7 +63,7 @@ export enum FlowChartColors {
  */
 export interface IStrategyMetadata<T> {
     name: string,
-    description: string,
+    description: string | React.ReactNode,
     address: ContractAddr,
     type: 'ERC4626' | 'ERC721' | 'Other',
     depositTokens: TokenInfo[],

package/src/strategies/{ekubo-cl-vault.ts → ekubo-cl-vault.tsx}

@@ -933,7 +933,13 @@ const AUDIT_URL = 'https://assets.strkfarm.com/strkfarm/audit_report_vesu_and_ek
  */
 export const EkuboCLVaultStrategies: IStrategyMetadata<CLVaultStrategySettings>[] = [{
     name: 'Ekubo xSTRK/STRK',
-    description: _description.replace('{{POOL_NAME}}', '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>,
     address: ContractAddr.from('0x01f083b98674bc21effee29ef443a00c7b9a500fd92cf30341a3da12c73f2324'),
     type: 'Other',
     // must be same order as poolKey token0 and token1

package/src/strategies/{vesu-rebalance.ts → vesu-rebalance.tsx}

@@ -203,6 +203,11 @@ export class VesuRebalance extends BaseStrategy<SingleTokenInfo, SingleActionAmo
         let vTokenContract = new Contract(VesuRebalanceAbi, p.v_token.address, this.config.provider);
         const bal = await vTokenContract.balanceOf(this.address.address);
         const assets = await vTokenContract.convert_to_assets(uint256.bnToUint256(bal.toString()));
+        logger.verbose(`Collateral: ${JSON.stringify(vesuPosition?.collateral)}`);
+        logger.verbose(`supplyApy: ${JSON.stringify(assetInfo?.stats.supplyApy)}`);
+        logger.verbose(`defiSpringSupplyApr: ${JSON.stringify(assetInfo?.stats.defiSpringSupplyApr)}`);
+        logger.verbose(`currentUtilization: ${JSON.stringify(assetInfo?.stats.currentUtilization)}`);
+        logger.verbose(`maxUtilization: ${JSON.stringify(assetInfo?.config.maxUtilization)}`);
         const item = {
             pool_id: p.pool_id,
             pool_name: _pool?.name,
@@ -217,7 +222,7 @@ export class VesuRebalance extends BaseStrategy<SingleTokenInfo, SingleActionAmo
                 netApy: 0,
             } : {
                 baseApy: Number(Web3Number.fromWei(assetInfo.stats.supplyApy.value, assetInfo.stats.supplyApy.decimals).toFixed(6)),
-                defiSpringApy: Number(Web3Number.fromWei(assetInfo.stats.defiSpringSupplyApr.value, assetInfo.stats.defiSpringSupplyApr.decimals).toFixed(6)),
+                defiSpringApy: assetInfo.stats.defiSpringSupplyApr ? Number(Web3Number.fromWei(assetInfo.stats.defiSpringSupplyApr.value, assetInfo.stats.defiSpringSupplyApr.decimals).toFixed(6)) : 0,
                 netApy: 0,
             },
             currentUtilization: isErrorPoolsAPI || !assetInfo ? 0 : Number(Web3Number.fromWei(assetInfo.stats.currentUtilization.value, assetInfo.stats.currentUtilization.decimals).toFixed(6)),
@@ -562,7 +567,7 @@ export class VesuRebalance extends BaseStrategy<SingleTokenInfo, SingleActionAmo
     }
 }
 
-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[] = [