@strkfarm/sdk 1.1.3 → 1.1.5

package/src/interfaces/risks.ts

@@ -0,0 +1,175 @@
+import { RiskType } from "./common";
+
+export enum MarketRiskLevel {
+  NO_RISK = 0,
+  VERY_LOW_VOLATILITY = 1,
+  LOW_VOLATILITY = 2,
+  MODERATE_VOLATILITY = 3,
+  HIGH_VOLATILITY = 4,
+  VERY_HIGH_VOLATILITY = 5
+}
+
+export enum ImpermanentLossLevel {
+  NO_RISK = 0,
+  HIGHLY_CORRELATED = 1,    // e.g. xSTRK/STRK
+  CORRELATED = 2,           // e.g. BTC/SOL
+  NON_CORRELATED = 3,       // e.g. STRK/USDC
+  LEVERAGED_CORRELATED = 4, // Added leverage on correlated pairs
+  LEVERAGED_NON_CORRELATED = 5  // Added leverage on non-correlated pairs
+}
+
+export enum LiquidationRiskLevel {
+  NO_RISK = 0,
+  VERY_LOW_PROBABILITY = 1,
+  LOW_PROBABILITY = 2,
+  MODERATE_PROBABILITY = 3,
+  HIGH_PROBABILITY = 4,
+  CRITICAL_PROBABILITY = 5
+}
+
+export enum LowLiquidityRiskLevel {
+  HIGH_LIQUIDITY = 0,
+  GOOD_LIQUIDITY = 1,
+  ADEQUATE_LIQUIDITY = 2,
+  MODERATE_CONCERNS = 3,
+  LOW_LIQUIDITY = 4,
+  SEVERE_CONSTRAINTS = 5
+}
+
+export enum SmartContractRiskLevel {
+  NO_RISK = 0,
+  BATTLE_TESTED = 1,        // Well-audited, battle-tested contracts
+  WELL_AUDITED = 2,         // Audited contracts with good track record
+  RECENTLY_AUDITED = 3,     // Recently audited or some complexity
+  UNAUDITED = 4,            // Unaudited or complex logic
+  EXPERIMENTAL = 5          // Experimental or known vulnerabilities
+}
+
+export enum OracleRiskLevel {
+  NO_DEPENDENCY = 0,
+  MULTIPLE_RELIABLE = 1,    // Multiple reliable oracles (Chainlink, etc.)
+  SINGLE_RELIABLE = 2,      // Single reliable oracle
+  LESS_ESTABLISHED = 3,     // Less established oracle
+  UNPROVEN = 4,             // Custom or unproven oracle
+  UNRELIABLE = 5            // No oracle or highly unreliable
+}
+
+export enum TechnicalRiskLevel {
+  NO_RISK = 0,
+  STABLE_INFRASTRUCTURE = 1,    // Stable, well-tested infrastructure
+  ESTABLISHED_PROTOCOLS = 2,    // Established protocols
+  SOME_COMPLEXITY = 3,          // Some technical complexity
+  NEW_IMPLEMENTATION = 4,       // New or complex technical implementation
+  EXPERIMENTAL_TECHNOLOGY = 5   // Experimental or untested technology
+}
+
+export enum CounterpartyRiskLevel {
+  NO_RISK = 0,
+  FULLY_DECENTRALIZED = 1,      // Decentralized, no counterparty
+  REPUTABLE_COUNTERPARTY = 2,   // Established, reputable counterparty
+  SOME_EXPOSURE = 3,            // Some counterparty exposure
+  SIGNIFICANT_RISK = 4,         // Significant counterparty risk
+  BAD_DEBT_ISSUES = 5           // Bad debt or known issues
+}
+
+export enum DepegRiskLevel {
+  NO_RISK = 0,
+  HIGHLY_STABLE = 1,            // Highly stable assets (e.g., major stablecoins)
+  GENERALLY_STABLE = 2,         // Generally stable with minor fluctuations
+  OCCASIONAL_DEPEG = 3,         // Occasional depeg events
+  FREQUENT_DEPEG = 4,           // Frequent or significant depeg risk
+  HIGH_DEPEG_PROBABILITY = 5    // High probability of severe depeg (e.g., USDC depeg scenarios)
+}
+
+// Helper type to map risk types to their corresponding level enums
+export type RiskLevelMap = {
+  [RiskType.MARKET_RISK]: MarketRiskLevel;
+  [RiskType.IMPERMANENT_LOSS]: ImpermanentLossLevel;
+  [RiskType.LIQUIDATION_RISK]: LiquidationRiskLevel;
+  [RiskType.LOW_LIQUIDITY_RISK]: LowLiquidityRiskLevel;
+  [RiskType.SMART_CONTRACT_RISK]: SmartContractRiskLevel;
+  [RiskType.ORACLE_RISK]: OracleRiskLevel;
+  [RiskType.TECHNICAL_RISK]: TechnicalRiskLevel;
+  [RiskType.COUNTERPARTY_RISK]: CounterpartyRiskLevel;
+  [RiskType.DEPEG_RISK]: DepegRiskLevel;
+};
+
+// Utility function to get risk level description
+export function getRiskLevelDescription(riskType: RiskType, level: number): string {
+  const descriptions: Record<RiskType, Record<number, string>> = {
+    [RiskType.MARKET_RISK]: {
+      0: "No market risk",
+      1: "Very low market volatility",
+      2: "Low market volatility",
+      3: "Moderate market volatility",
+      4: "High market volatility",
+      5: "Very high market volatility"
+    },
+    [RiskType.IMPERMANENT_LOSS]: {
+      0: "No impermanent loss risk",
+      1: "Highly correlated pairs (minimal IL)",
+      2: "Correlated pairs (low IL)",
+      3: "Non-correlated pairs (moderate IL)",
+      4: "Leveraged correlated pairs",
+      5: "Leveraged non-correlated pairs"
+    },
+    [RiskType.LIQUIDATION_RISK]: {
+      0: "No liquidation risk",
+      1: "Very low liquidation probability",
+      2: "Low liquidation probability",
+      3: "Moderate liquidation risk",
+      4: "High liquidation risk",
+      5: "Critical liquidation risk"
+    },
+    [RiskType.LOW_LIQUIDITY_RISK]: {
+      0: "High liquidity",
+      1: "Good liquidity",
+      2: "Adequate liquidity",
+      3: "Moderate liquidity concerns",
+      4: "Low liquidity",
+      5: "Severe liquidity constraints"
+    },
+    [RiskType.SMART_CONTRACT_RISK]: {
+      0: "No smart contract risk",
+      1: "Battle-tested contracts",
+      2: "Well-audited contracts",
+      3: "Recently audited contracts",
+      4: "Unaudited contracts",
+      5: "Experimental or vulnerable contracts"
+    },
+    [RiskType.ORACLE_RISK]: {
+      0: "No oracle dependency",
+      1: "Multiple reliable oracles",
+      2: "Single reliable oracle",
+      3: "Less established oracle",
+      4: "Unproven oracle",
+      5: "Unreliable or no oracle"
+    },
+    [RiskType.TECHNICAL_RISK]: {
+      0: "No technical risk",
+      1: "Stable infrastructure",
+      2: "Established protocols",
+      3: "Some complexity",
+      4: "New implementation",
+      5: "Experimental technology"
+    },
+    [RiskType.COUNTERPARTY_RISK]: {
+      0: "No counterparty risk",
+      1: "Fully decentralized",
+      2: "Reputable counterparty",
+      3: "Some counterparty exposure",
+      4: "Significant counterparty risk",
+      5: "Bad debt or known issues"
+    },
+    [RiskType.DEPEG_RISK]: {
+      0: "No depeg risk",
+      1: "Highly stable asset",
+      2: "Generally stable",
+      3: "Occasional depeg events",
+      4: "Frequent depeg risk",
+      5: "High depeg probability"
+    }
+  };
+  
+  return descriptions[riskType][level] || "Unknown risk level";
+}

package/src/notifs/telegram.ts

@@ -4,9 +4,9 @@ import { logger } from "@/utils/logger";
 export class TelegramNotif {
     private subscribers: string[] = [
         // '6820228303',
-        '1505578076',
-        '1356705582', // langs
-        '1388729514', // hwashere
+        // '1505578076',
+        // '1356705582', // langs
+        // '1388729514', // hwashere
         '985902592'
     ];
     readonly bot: TelegramBot;

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

@@ -10,6 +10,7 @@ import {
   IStrategyMetadata,
   RiskFactor,
   RiskType,
+  TokenInfo,
 } from "@/interfaces";
 import { PricerBase } from "@/modules/pricerBase";
 import { assert } from "@/utils";
@@ -34,6 +35,7 @@ import { log } from "winston";
 import { EkuboHarvests } from "@/modules/harvests";
 import { logger } from "@/utils/logger";
 import { COMMON_CONTRACTS } from "./constants";
+import { ImpermanentLossLevel, MarketRiskLevel, SmartContractRiskLevel } from "@/interfaces/risks";
 
 export interface EkuboPoolKey {
   token0: ContractAddr;
@@ -69,6 +71,7 @@ export interface CLVaultStrategySettings {
     direction: "any" | "uponly"; // any for pools like USDC/USDT, uponly for pools like xSTRK/STRK
     customShouldRebalance: (currentPoolPrice: number) => Promise<boolean>; // any additional logic for deciding factor to rebalance or not based on pools
   };
+  quoteAsset: TokenInfo
 }
 
 export class EkuboCLVault extends BaseStrategy<
@@ -1588,15 +1591,41 @@ const _protocol: IProtocol = {
   logo: "https://app.ekubo.org/favicon.ico",
 };
 // need to fine tune better
-const _riskFactor: RiskFactor[] = [
-  { 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 _corelatedPoolRiskFactors: RiskFactor[] = [
+  { type: RiskType.SMART_CONTRACT_RISK, value: SmartContractRiskLevel.WELL_AUDITED, weight: 34, reason: "Audited smart contracts" },
+  { type: RiskType.IMPERMANENT_LOSS, value: ImpermanentLossLevel.HIGHLY_CORRELATED, weight: 33, reason: "Low risk due to co-related assets" },
+  { type: RiskType.MARKET_RISK, value: MarketRiskLevel.VERY_LOW_VOLATILITY, weight: 33, reason: "Low risk due to co-related assets" },
 ];
 
-const _riskFactorStable: RiskFactor[] = [
-  { type: RiskType.SMART_CONTRACT_RISK, value: 0.5, weight: 25 },
+const mediumVolatilityPoolRiskFactors: RiskFactor[] = [
+  { type: RiskType.SMART_CONTRACT_RISK, value: SmartContractRiskLevel.WELL_AUDITED, weight: 34, reason: "Audited smart contracts" },
+  { type: RiskType.IMPERMANENT_LOSS, value: ImpermanentLossLevel.NON_CORRELATED, weight: 33, reason: "Low risk due to co-related assets" },
+  { type: RiskType.MARKET_RISK, value: MarketRiskLevel.MODERATE_VOLATILITY, weight: 33, reason: "Low risk due to co-related assets" },
 ];
+
+const highVolatilityPoolRiskFactors: RiskFactor[] = [
+  { type: RiskType.SMART_CONTRACT_RISK, value: SmartContractRiskLevel.WELL_AUDITED, weight: 34, reason: "Audited smart contracts" },
+  { type: RiskType.IMPERMANENT_LOSS, value: ImpermanentLossLevel.NON_CORRELATED, weight: 33, reason: "Low risk due to co-related assets" },
+  { type: RiskType.MARKET_RISK, value: MarketRiskLevel.HIGH_VOLATILITY, weight: 33, reason: "Low risk due to co-related assets" },
+];
+
+const mediumRisk = {
+  riskFactor: mediumVolatilityPoolRiskFactors,
+  netRisk:
+  mediumVolatilityPoolRiskFactors.reduce((acc, curr) => acc + curr.value * curr.weight, 0) /
+  mediumVolatilityPoolRiskFactors.reduce((acc, curr) => acc + curr.weight, 0),
+  notARisks: getNoRiskTags(mediumVolatilityPoolRiskFactors),
+};
+
+const highRisk = {
+  riskFactor: highVolatilityPoolRiskFactors,
+  netRisk:
+  highVolatilityPoolRiskFactors.reduce((acc, curr) => acc + curr.value * curr.weight, 0) /
+  highVolatilityPoolRiskFactors.reduce((acc, curr) => acc + curr.weight, 0),
+  notARisks: getNoRiskTags(highVolatilityPoolRiskFactors),
+};
+
+
 const AUDIT_URL =
   "https://assets.troves.fi/strkfarm/audit_report_vesu_and_ekubo_strats.pdf";
 
@@ -1616,6 +1645,11 @@ const faqs: FAQ[] = [
     answer:
       "During withdrawal, you may receive either or both tokens depending on market conditions and prevailing prices.",
   },
+  {
+    question: "Are there any deposit/withdrawal fees?",
+    answer:
+      "No, there are no deposit/withdrawal fees. However, there is a performance fee varying between 10-20% of the fees and rewards generated. The exact fee is determined by the strategy and the APY shown is net of this fee.",
+  },
   {
     question: "Is the strategy audited?",
     answer: (
@@ -1651,11 +1685,11 @@ const xSTRKSTRK: IStrategyMetadata<CLVaultStrategySettings> = {
   auditUrl: AUDIT_URL,
   maxTVL: Web3Number.fromWei("0", 18),
   risk: {
-    riskFactor: _riskFactor,
+    riskFactor: _corelatedPoolRiskFactors,
     netRisk:
-      _riskFactor.reduce((acc, curr) => acc + curr.value * curr.weight, 0) /
-      _riskFactor.reduce((acc, curr) => acc + curr.weight, 0),
-    notARisks: getNoRiskTags(_riskFactor),
+    _corelatedPoolRiskFactors.reduce((acc, curr) => acc + curr.value * curr.weight, 0) /
+    _corelatedPoolRiskFactors.reduce((acc, curr) => acc + curr.weight, 0),
+    notARisks: getNoRiskTags(_corelatedPoolRiskFactors),
   },
   apyMethodology:
     "APY based on 7-day historical performance, including fees and rewards.",
@@ -1673,6 +1707,7 @@ const xSTRKSTRK: IStrategyMetadata<CLVaultStrategySettings> = {
       minWaitHours: 24,
       direction: "uponly",
     },
+    quoteAsset: Global.getDefaultTokens().find((t) => t.symbol === "STRK")!,
   },
   faqs: [
     ...faqs,
@@ -1691,76 +1726,171 @@ const xSTRKSTRK: IStrategyMetadata<CLVaultStrategySettings> = {
   investmentSteps: []
 };
 
-/**
- * Represents the Vesu Rebalance Strategies.
- */
-export const EkuboCLVaultStrategies: IStrategyMetadata<CLVaultStrategySettings>[] =
-  [
-    xSTRKSTRK,
-    {
-      ...xSTRKSTRK,
-      name: "Ekubo USDC/USDT",
-      description: <></>,
-      address: ContractAddr.from(
-        "0xd647ed735f0db52f2a5502b6e06ed21dc4284a43a36af4b60d3c80fbc56c91"
-      ),
-      launchBlock: 1385576,
-      // must be same order as poolKey token0 and token1
-      depositTokens: [
-        Global.getDefaultTokens().find((t) => t.symbol === "USDC")!,
-        Global.getDefaultTokens().find((t) => t.symbol === "USDT")!,
-      ],
-      additionalInfo: {
-        newBounds: {
-          lower: -1,
-          upper: 1,
-        },
-        truePrice: 1,
-        feeBps: 1000,
-        rebalanceConditions: {
-          customShouldRebalance: async (currentPrice: number) =>
-            currentPrice > 0.99 && currentPrice < 1.01,
-          minWaitHours: 6,
-          direction: "any",
-        },
-      },
+const ETHUSDCRe7Strategy: IStrategyMetadata<CLVaultStrategySettings> = {
+  ...xSTRKSTRK,
+  name: "Ekubo ETH/USDC",
+  description: <></>,
+  address: ContractAddr.from(
+    "0x160d8fa4569ef6a12e6bf47cb943d7b5ebba8a41a69a14c1d943050ba5ff947"
+  ),
+  launchBlock: 1501761,
+  // must be same order as poolKey token0 and token1
+  depositTokens: [
+    Global.getDefaultTokens().find((t) => t.symbol === "ETH")!,
+    Global.getDefaultTokens().find((t) => t.symbol === "USDC")!
+  ],
+  additionalInfo: {
+    newBounds: "Managed by Re7",
+    truePrice: 1,
+    feeBps: 1000,
+    rebalanceConditions: {
+      customShouldRebalance: async (currentPrice: number) =>
+        currentPrice > 0.99 && currentPrice < 1.01,
+      minWaitHours: 6,
+      direction: "any"
     },
+    quoteAsset: Global.getDefaultTokens().find((t) => t.symbol === "USDC")!,
+  },
+  faqs: [
+    ...faqs,
     {
-      ...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",
-        },
-      },
+      question: "Who is the curator of this strategy?",
+      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>
     },
+  ],
+  risk: highRisk,
+  points: [],
+  curator: { name: "Re7 Labs", logo: "https://www.re7labs.xyz/favicon.ico" }
+};
+
+const RE7Strategies: IStrategyMetadata<CLVaultStrategySettings>[] = [
+  ETHUSDCRe7Strategy,
+  {
+    ...ETHUSDCRe7Strategy,
+    name: "Ekubo USDC/USDT",
+    description: <></>,
+    address: ContractAddr.from(
+      "0x3a4f8debaf12af97bb911099bc011d63d6c208d4c5ba8e15d7f437785b0aaa2"
+    ),
+    launchBlock: 1501761,
+    // must be same order as poolKey token0 and token1
+    depositTokens: [
+      Global.getDefaultTokens().find((t) => t.symbol === "USDC")!,
+      Global.getDefaultTokens().find((t) => t.symbol === "USDT")!
+    ],
+    risk: xSTRKSTRK.risk,
+  },
+  {
+    ...ETHUSDCRe7Strategy,
+    name: "Ekubo STRK/USDC",
+    description: <></>,
+    address: ContractAddr.from(
+      "0x351b36d0d9d8b40010658825adeeddb1397436cd41acd0ff6c6e23aaa8b5b30"
+    ),
+    launchBlock: 1501762,
+    // must be same order as poolKey token0 and token1
+    depositTokens: [
+      Global.getDefaultTokens().find((t) => t.symbol === "STRK")!,
+      Global.getDefaultTokens().find((t) => t.symbol === "USDC")!
+    ],
+    risk: highRisk,
+  },
+  {
+    ...ETHUSDCRe7Strategy,
+    name: "Ekubo STRK/ETH",
+    description: <></>,
+    address: ContractAddr.from(
+      "0x4ce3024b0ee879009112d7b0e073f8a87153dd35b029347d4247ffe48d28f51"
+    ),
+    launchBlock: 1501763,
+    // must be same order as poolKey token0 and token1
+    depositTokens: [
+      Global.getDefaultTokens().find((t) => t.symbol === "STRK")!,
+      Global.getDefaultTokens().find((t) => t.symbol === "ETH")!
+    ],
+    risk: highRisk,
+  },
+  {
+    ...ETHUSDCRe7Strategy,
+    name: "Ekubo WBTC/USDC",
+    description: <></>,
+    address: ContractAddr.from(
+      "0x2bcaef2eb7706875a5fdc6853dd961a0590f850bc3a031c59887189b5e84ba1"
+    ),
+    launchBlock: 1501764,
+    // must be same order as poolKey token0 and token1
+    depositTokens: [
+      Global.getDefaultTokens().find((t) => t.symbol === "WBTC")!,
+      Global.getDefaultTokens().find((t) => t.symbol === "USDC")!
+    ],
+    risk: mediumRisk,
+  },
+  {
+    ...ETHUSDCRe7Strategy,
+    name: "Ekubo tBTC/USDC",
+    description: <></>,
+    address: ContractAddr.from(
+      "0x4aad891a2d4432fba06b6558631bb13f6bbd7f6f33ab8c3111e344889ea4456"
+    ),
+    launchBlock: 1501764,
+    // must be same order as poolKey token0 and token1
+    depositTokens: [
+      Global.getDefaultTokens().find((t) => t.symbol === "tBTC")!,
+      Global.getDefaultTokens().find((t) => t.symbol === "USDC")!
+    ],
+    risk: mediumRisk,
+  },
+  {
+    ...ETHUSDCRe7Strategy,
+    name: "Ekubo WBTC/ETH",
+    description: <></>,
+    address: ContractAddr.from(
+      "0x1c9232b8186d9317652f05055615f18a120c2ad9e5ee96c39e031c257fb945b"
+    ),
+    launchBlock: 1501765,
+    // must be same order as poolKey token0 and token1
+    depositTokens: [
+      Global.getDefaultTokens().find((t) => t.symbol === "WBTC")!,
+      Global.getDefaultTokens().find((t) => t.symbol === "ETH")!
+    ],
+    risk: mediumRisk,
+  },
+  {
+    ...ETHUSDCRe7Strategy,
+    name: "Ekubo WBTC/STRK",
+    description: <></>,
+    address: ContractAddr.from(
+      "0x1248e385c23a929a015ec298a26560fa7745bbd6e41a886550e337b02714b1b"
+    ),
+    launchBlock: 1501766,
+    // must be same order as poolKey token0 and token1
+    depositTokens: [
+      Global.getDefaultTokens().find((t) => t.symbol === "WBTC")!,
+      Global.getDefaultTokens().find((t) => t.symbol === "STRK")!
+    ],
+    risk: highRisk,
+  }
+];
+
+/**
+ * Represents the Ekubo CL Vault Strategies.
+ */
+export const EkuboCLVaultStrategies: IStrategyMetadata<CLVaultStrategySettings>[] = [
+    xSTRKSTRK,
+    ...RE7Strategies,
 ];
 
 // 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];
+      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.troves.fi/p/ekubo-cl-vaults"