@strkfarm/sdk 1.1.4 → 1.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strkfarm/sdk",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "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",
@@ -60,6 +60,7 @@
     "@avnu/avnu-sdk": "3.0.2",
     "@ericnordelo/strk-merkle-tree": "^1.0.0",
     "@noble/curves": "^1.9.7",
+    "@noble/hashes": "^2.0.0",
     "@scure/starknet": "^2.0.0",
     "bignumber.js": "4.0.4",
     "browser-assert": "^1.2.1",

package/src/global.ts

@@ -63,7 +63,7 @@ const defaultTokens: TokenInfo[] = [{
     name: 'WBTC',
     symbol: 'WBTC',
     logo: 'https://assets.troves.fi/integrations/tokens/wbtc.svg',
-    address: ContractAddr.from('0x3fe2b97c1fd336e750087d68b9b867997fd64a2661ff3ca5a7c771641e8e7ac'),
+    address: ContractAddr.from('0x03fe2b97c1fd336e750087d68b9b867997fd64a2661ff3ca5a7c771641e8e7ac'),
     decimals: 8,
     coingeckId: undefined,
     displayDecimals: 6,
@@ -77,6 +77,56 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+}, {
+    name: 'solvBTC',
+    symbol: 'solvBTC',
+    logo: 'https://assets.strkfarm.com/integrations/tokens/solvbtc.svg',
+    address: ContractAddr.from('0x0593e034dda23eea82d2ba9a30960ed42cf4a01502cc2351dc9b9881f9931a68'),
+    decimals: 18,
+    coingeckId: undefined,
+    priceProxySymbol: 'WBTC',
+    displayDecimals: 6,
+    priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+}, {
+    name: 'LBTC',
+    symbol: 'LBTC',
+    logo: 'https://assets.strkfarm.com/integrations/tokens/lbtc.svg',
+    address: ContractAddr.from('0x036834a40984312f7f7de8d31e3f6305b325389eaeea5b1c0664b2fb936461a4'),
+    decimals: 8,
+    coingeckId: undefined,
+    displayDecimals: 6,
+    priceProxySymbol: 'WBTC',
+    priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+}, {
+    name: 'xWBTC',
+    symbol: 'xWBTC',
+    logo: 'https://assets.strkfarm.com/integrations/tokens/xwbtc.svg',
+    address: ContractAddr.from('0x6a567e68c805323525fe1649adb80b03cddf92c23d2629a6779f54192dffc13'),
+    decimals: 8,
+    coingeckId: undefined,
+    displayDecimals: 6,
+    priceProxySymbol: 'WBTC',
+    priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+}, {
+    name: 'xsBTC',
+    symbol: 'xsBTC',
+    logo: 'https://assets.strkfarm.com/integrations/tokens/xsbtc_solv.svg',
+    address: ContractAddr.from('0x580f3dc564a7b82f21d40d404b3842d490ae7205e6ac07b1b7af2b4a5183dc9'),
+    decimals: 18,
+    coingeckId: undefined,
+    displayDecimals: 6,
+    priceProxySymbol: 'WBTC',
+    priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+}, {
+    name: 'xtBTC',
+    symbol: 'xtBTC',
+    logo: 'https://assets.strkfarm.com/integrations/tokens/xtbtc.svg',
+    address: ContractAddr.from('0x43a35c1425a0125ef8c171f1a75c6f31ef8648edcc8324b55ce1917db3f9b91'),
+    decimals: 8,
+    coingeckId: undefined,
+    displayDecimals: 6,
+    priceProxySymbol: 'WBTC',
+    priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
 }]
 const tokens: TokenInfo[] = defaultTokens;
 

package/src/interfaces/common.tsx

@@ -33,6 +33,7 @@ export interface TokenInfo {
   logo: string;
   coingeckId?: string;
   displayDecimals: number;
+  priceProxySymbol?: string; // for tokens like illiquid tokens, we use a proxy symbol to get the price
   priceCheckAmount?: number; // for tokens like BTC, doing 1BTC price check may not be ideal, esp on illiquid netwrks like sn
 }
 
@@ -95,6 +96,7 @@ export interface IStrategyMetadata<T> {
   points?: {multiplier: number, logo: string, toolTip?: string}[];
   docs?: string;
   investmentSteps: string[];
+  curator?: { name: string, logo: string }
 }
 
 export interface IInvestmentFlow {

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/modules/harvests.ts

@@ -4,6 +4,7 @@ import { IConfig } from "@/interfaces";
 import { assert } from "@/utils";
 import { Contract, num } from "starknet";
 import { ERC20 } from "./erc20";
+import { ENDPOINTS } from "@/strategies/constants";
 
 export interface HarvestInfo {
     rewardsContract: ContractAddr,
@@ -87,7 +88,7 @@ export const VESU_REWARDS_CONTRACT = ContractAddr.from('0x0387f3eb1d98632fbe3440
 
 export class VesuHarvests extends Harvests {
     async getHarvests(addr: ContractAddr): Promise<HarvestInfo[]> {
-        const result = await fetch(`https://api.vesu.xyz/users/${addr.address}/strk-rewards/calldata`);
+        const result = await fetch(`${ENDPOINTS.VESU_BASE}/users/${addr.address}/strk-rewards/calldata`);
         const data = await result.json();
         const rewardsContract = VESU_REWARDS_CONTRACT;
 

package/src/modules/pricer.ts

@@ -16,6 +16,9 @@ export class Pricer extends PricerBase {
         [key: string]: PriceInfo
     } = {}
 
+    refreshInterval = 30000;
+    staleTime = 60000;
+
     // code populates this map during runtime to determine which method to use for a given token
     // The method set will be the first one to try after first attempt
     private methodToUse: {[tokenSymbol: string]: 'Ekubo' | 'Coinbase' | 'Coinmarketcap'} = {};
@@ -26,8 +29,10 @@ export class Pricer extends PricerBase {
     protected PRICE_API = `https://api.coinbase.com/v2/prices/{{PRICER_KEY}}/buy`;
     protected EKUBO_API = 'https://quoter-mainnet-api.ekubo.org/{{AMOUNT}}/{{TOKEN_ADDRESS}}/0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8'; // e.g. ETH/USDC
 
-    constructor(config: IConfig, tokens: TokenInfo[]) {
+    constructor(config: IConfig, tokens: TokenInfo[], refreshInterval = 30000, staleTime = 60000) {
         super(config, tokens);
+        this.refreshInterval = refreshInterval;
+        this.staleTime = staleTime;
     }
 
     isReady() {
@@ -64,11 +69,11 @@ export class Pricer extends PricerBase {
         this._loadPrices();
         setInterval(() => {
             this._loadPrices();
-        }, 30000);
+        }, this.refreshInterval);
     }
 
     isStale(timestamp: Date, tokenName: string) {
-        const STALE_TIME = 60000;
+        const STALE_TIME = this.staleTime;
         return (new Date().getTime() - timestamp.getTime()) > STALE_TIME;
     }
 
@@ -97,13 +102,25 @@ export class Pricer extends PricerBase {
                         return;
                     }
                     
-                    const price = await this._getPrice(token);
-                    this.prices[token.symbol] = {
-                        price,
-                        timestamp: new Date()
+                    if (token.priceProxySymbol) {
+                        const proxyToken = this.tokens.find(t => t.symbol === token.priceProxySymbol);
+                        if (!proxyToken) {
+                            throw new FatalError(`Price proxy token ${token.priceProxySymbol} not found`);
+                        }
+                        const price = await this._getPrice(proxyToken);
+                        this.prices[token.symbol] = {
+                            price,
+                            timestamp: new Date()
+                        }
+                    } else {
+                        const price = await this._getPrice(token);
+                        this.prices[token.symbol] = {
+                            price,
+                            timestamp: new Date()
+                        }
                     }
                     onUpdate(token.symbol);
-                    logger.verbose(`Fetched price of ${token.name} as ${price}`);
+                    logger.verbose(`Fetched price of ${token.name} as ${this.prices[token.symbol].price}`);
                     break;
                 } catch (error: any) {
                     if (retry < MAX_RETRIES) {

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/constants.ts

@@ -4,4 +4,8 @@ export const COMMON_CONTRACTS = [{
   address: ContractAddr.from("0x0636a3f51cc37f5729e4da4b1de6a8549a28f3c0d5bf3b17f150971e451ff9c2"),
   name: "Access Controller",
   sourceCodeUrl: "https://github.com/strkfarm/strkfarm-contracts/blob/main/src/components/accessControl.cairo",
-}];
+}];
+
+export const ENDPOINTS = {
+  VESU_BASE: "https://cache-server-t2me.onrender.com/vesu"
+}