@strkfarm/sdk 2.0.0-staging.70 → 2.0.0-staging.72

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@strkfarm/sdk",
-    "version": "2.0.0-staging.70",
+    "version": "2.0.0-staging.72",
     "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",

package/src/global.ts

@@ -1,5 +1,5 @@
 import axios from 'axios';
-import { TokenInfo } from './interfaces';
+import { TokenIndexingType, TokenInfo } from './interfaces';
 import { ContractAddr } from './dataTypes';
 import { logger } from '@/utils/logger';
 
@@ -22,7 +22,9 @@ const defaultTokens: TokenInfo[] = [{
     decimals: 18,
     coingeckId: 'starknet',
     displayDecimals: 2,
-    priceCheckAmount: 1000, 
+    priceCheckAmount: 5000, 
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.INDEXER,
 }, {
     name: 'xSTRK',
     symbol: 'xSTRK',
@@ -30,8 +32,10 @@ const defaultTokens: TokenInfo[] = [{
     address: ContractAddr.from('0x028d709c875c0ceac3dce7065bec5328186dc89fe254527084d1689910954b0a'),
     decimals: 18,
     coingeckId: undefined,
-    priceCheckAmount: 1000, 
+    priceCheckAmount: 5000, 
     displayDecimals: 2,
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
 }, {
     name: 'ETH',
     symbol: 'ETH',
@@ -41,6 +45,7 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     priceCheckAmount: 0.1, 
     displayDecimals: 6,
+    indexingType: TokenIndexingType.INDEXER,
 }, {
     name: 'USDC.e',
     symbol: 'USDC.e',
@@ -50,6 +55,8 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 2,
     priceCheckAmount: 1000,
+    priceProxySymbol: 'USDC',
+    indexingType: TokenIndexingType.PEGGED,
 }, {
     name: 'USDC',
     symbol: 'USDC',
@@ -59,6 +66,7 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 2,
     priceCheckAmount: 1000,
+    indexingType: TokenIndexingType.INDEXER,
 }, {
     name: 'USDT',
     symbol: 'USDT',
@@ -68,6 +76,7 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     priceCheckAmount: 1000,
     displayDecimals: 2,
+    indexingType: TokenIndexingType.INDEXER,
 }, {
     name: 'WBTC',
     symbol: 'WBTC',
@@ -77,6 +86,7 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
+    indexingType: TokenIndexingType.INDEXER,
 }, {
     name: 'tBTC',
     symbol: 'tBTC',
@@ -86,6 +96,8 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
+    priceProxySymbol: 'WBTC',
+    indexingType: TokenIndexingType.PEGGED,
 }, {
     name: 'solvBTC',
     symbol: 'solvBTC',
@@ -96,6 +108,7 @@ const defaultTokens: TokenInfo[] = [{
     priceProxySymbol: 'WBTC',
     displayDecimals: 6,
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+    indexingType: TokenIndexingType.PEGGED,
 }, {
     name: 'LBTC',
     symbol: 'LBTC',
@@ -106,6 +119,7 @@ const defaultTokens: TokenInfo[] = [{
     displayDecimals: 6,
     priceProxySymbol: 'WBTC',
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+    indexingType: TokenIndexingType.PEGGED,
 }, {
     name: 'xWBTC',
     symbol: 'xWBTC',
@@ -114,8 +128,9 @@ const defaultTokens: TokenInfo[] = [{
     decimals: 8,
     coingeckId: undefined,
     displayDecimals: 6,
-    priceProxySymbol: 'WBTC',
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
 }, {
     name: 'xsBTC',
     symbol: 'xsBTC',
@@ -124,10 +139,10 @@ const defaultTokens: TokenInfo[] = [{
     decimals: 18,
     coingeckId: undefined,
     displayDecimals: 6,
-    priceProxySymbol: 'WBTC',
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
 }, {
-    // todo upgrade proxy tokens once feeds are available
     name: 'xtBTC',
     symbol: 'xtBTC',
     logo: 'https://assets.strkfarm.com/integrations/tokens/xtbtc.svg',
@@ -136,7 +151,8 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
-    priceProxySymbol: 'WBTC',
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
 }, {
     name: 'xLBTC',
     symbol: 'xLBTC',
@@ -145,8 +161,9 @@ const defaultTokens: TokenInfo[] = [{
     decimals: 8,
     coingeckId: undefined,
     displayDecimals: 6,
-    priceProxySymbol: 'WBTC',
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
 }, {
     name: 'mRe7BTC',
     symbol: 'mRe7BTC',
@@ -157,6 +174,7 @@ const defaultTokens: TokenInfo[] = [{
     displayDecimals: 6,
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
     dontPrice: true,
+    indexingType: TokenIndexingType.IGNORE,
 }, {
     name: 'mRe7YIELD',
     symbol: 'mRe7YIELD',
@@ -167,6 +185,7 @@ const defaultTokens: TokenInfo[] = [{
     displayDecimals: 2,
     priceCheckAmount: 100,
     dontPrice: true,
+    indexingType: TokenIndexingType.IGNORE,
 }, {
     name: "fyeWBTC",
     symbol: "fyeWBTC",
@@ -177,6 +196,7 @@ const defaultTokens: TokenInfo[] = [{
     displayDecimals: 6,
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
     dontPrice: true,
+    indexingType: TokenIndexingType.IGNORE,
 }, {
     name: "fyETH",
     symbol: "fyETH",
@@ -187,6 +207,7 @@ const defaultTokens: TokenInfo[] = [{
     displayDecimals: 4,
     priceCheckAmount: 0.1,
     dontPrice: true,
+    indexingType: TokenIndexingType.IGNORE,
 }, {
     name: "fyeUSDC",
     symbol: "fyeUSDC",
@@ -197,6 +218,7 @@ const defaultTokens: TokenInfo[] = [{
     displayDecimals: 2,
     priceCheckAmount: 100,
     dontPrice: true,
+    indexingType: TokenIndexingType.IGNORE,
 }, {
     name: 'strkBTC',
     symbol: 'strkBTC',
@@ -206,7 +228,9 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
+    priceMethod: 'Avnu',
     priceProxySymbol: 'WBTC',
+    indexingType: TokenIndexingType.PEGGED,
 }, {
     name: 'xstrkBTC',
     symbol: 'xstrkBTC',
@@ -216,8 +240,9 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001,
-    priceProxySymbol: 'WBTC',
-},]
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
+}];
 const tokens: TokenInfo[] = defaultTokens;
 
 /** Contains globally useful functions. 
@@ -281,7 +306,8 @@ export class Global {
                 decimals: token.decimals,
                 logo: token.logoUri,
                 coingeckId: token.extensions.coingeckoId,
-                displayDecimals: 2
+                displayDecimals: 2,
+                indexingType: TokenIndexingType.IGNORE,
             });
         });
         console.log(tokens);

package/src/interfaces/common.tsx

@@ -25,6 +25,14 @@ export interface RiskFactor {
   reason?: string; // optional reason for the risk factor
 }
 
+export type PriceMethod = 'AvnuApi' | 'Coinbase' | 'Coinmarketcap' | 'Ekubo' | 'Avnu';
+export enum TokenIndexingType {
+  PEGGED = "pegged",
+  INDEXER = "indexer",
+  LST_SCRIPT = "lstScript",
+  IGNORE = "ignore",
+}
+
 export interface TokenInfo {
   name: string;
   symbol: string;
@@ -35,7 +43,9 @@ export interface TokenInfo {
   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
+  priceMethod?: PriceMethod; // preferred price source; tried first, then falls back to other methods
   dontPrice?: boolean; // a flag that skips pricer to check these tokens. 
+  indexingType: TokenIndexingType;
 }
 
 export enum Network {
@@ -174,6 +184,10 @@ export interface StrategyApyHistoryUIConfig {
   noApyHistoryMessage?: string;
 }
 
+export interface FeeBps {
+  performanceFeeBps: number;
+}
+
 /**
  * @property risk.riskFactor.factor - The risk factors that are considered for the strategy.
  * @property risk.riskFactor.factor - The value of the risk factor from 0 to 10, 0 being the lowest and 10 being the highest.
@@ -214,6 +228,7 @@ export interface IStrategyMetadata<T> {
   };
   apyMethodology?: string;
   realizedApyMethodology?: string;
+  feeBps?: FeeBps;
   additionalInfo: T;
   contractDetails: {
     address: ContractAddr;

package/src/modules/ekubo-pricer.ts

@@ -7,7 +7,8 @@ import { PriceInfo } from "./pricer";
 export class EkuboPricer extends PricerBase {
     EKUBO_PRICE_FETCHER_ADDRESS = '0x04946fb4ad5237d97bbb1256eba2080c4fe1de156da6a7f83e3b4823bb6d7da1';
     readonly contract: Contract;
-    private readonly USDC_ADDRESS = '0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8';
+    // Updating to new USDC_ADDRESS
+    private readonly USDC_ADDRESS = '0x033068F6539f8e6e6b131e6B2B814e6c34A5224bC66947c47DaB9dFeE93b35fb';
     private readonly USDC_DECIMALS = 6;
 
     constructor(config: IConfig, tokens: TokenInfo[]) {

package/src/modules/pricer.ts

@@ -1,6 +1,6 @@
 import axios from "axios";
 import { FatalError, Global } from "@/global";
-import { TokenInfo } from "@/interfaces/common";
+import { PriceMethod, TokenInfo } from "@/interfaces/common";
 import { IConfig } from "@/interfaces/common";
 import { Web3Number } from "@/dataTypes";
 import { PricerBase } from "./pricerBase";
@@ -14,8 +14,6 @@ export interface PriceInfo {
     timestamp: Date
 }
 
-type PriceMethod = 'AvnuApi' | 'Coinbase' | 'Coinmarketcap' | 'Ekubo' | 'Avnu';
-
 const PRICE_METHOD_PRIORITY: PriceMethod[] = [
     'AvnuApi',
     'Coinbase',
@@ -164,22 +162,15 @@ export class Pricer extends PricerBase {
     }
 
     async _getPrice(token: TokenInfo): Promise<number> {
-        const pinned = this.methodToUse[token.symbol];
-        if (pinned) {
-            logger.verbose(`Fetching price of ${token.symbol} using pinned ${pinned}`);
-            try {
-                return await this._tryPriceMethod(token, pinned);
-            } catch (error: any) {
-                console.warn(`${pinned}: pinned price failed [${token.symbol}]: `, error.message);
-                delete this.methodToUse[token.symbol];
-            }
-        }
+        const methodsToTry = this._getMethodsToTry(token);
 
-        for (const method of PRICE_METHOD_PRIORITY) {
+        for (const method of methodsToTry) {
             logger.verbose(`Fetching price of ${token.symbol} using ${method}`);
             try {
                 const result = await this._tryPriceMethod(token, method);
-                this.methodToUse[token.symbol] = method;
+                if (!token.priceMethod) {
+                    this.methodToUse[token.symbol] = method;
+                }
                 return result;
             } catch (error: any) {
                 console.warn(`${method}: price err [${token.symbol}]: `, error.message);
@@ -189,6 +180,27 @@ export class Pricer extends PricerBase {
         throw new FatalError(`Price not found for ${token.symbol}`);
     }
 
+    protected _getMethodsToTry(token: TokenInfo): PriceMethod[] {
+        const methods: PriceMethod[] = [];
+
+        if (token.priceMethod) {
+            methods.push(token.priceMethod);
+        }
+
+        const pinned = this.methodToUse[token.symbol];
+        if (pinned && pinned !== token.priceMethod) {
+            methods.push(pinned);
+        }
+
+        for (const method of PRICE_METHOD_PRIORITY) {
+            if (!methods.includes(method)) {
+                methods.push(method);
+            }
+        }
+
+        return methods;
+    }
+
     protected async _tryPriceMethod(token: TokenInfo, method: PriceMethod): Promise<number> {
         switch (method) {
             case 'AvnuApi':

package/src/modules/zkLend.ts

@@ -2,7 +2,7 @@ import axios from "axios";
 import BigNumber from "bignumber.js";
 import { Web3Number } from "@/dataTypes/bignumber.browser";
 import { FatalError, Global } from "@/global";
-import { TokenInfo } from "@/interfaces";
+import { TokenIndexingType, TokenInfo } from "@/interfaces";
 import { ILending, ILendingPosition, LendingToken, MarginType } from "@/interfaces/lending";
 import { ContractAddr } from "@/dataTypes/address";
 import { IConfig } from "@/interfaces";
@@ -42,7 +42,8 @@ export class ZkLend extends ILending implements ILending {
                     decimals: pool.token.decimals,
                     borrowFactor: Web3Number.fromWei(pool.borrow_factor.value, pool.borrow_factor.decimals),
                     collareralFactor,
-                    displayDecimals: 2
+                    displayDecimals: 2,
+                    indexingType: TokenIndexingType.IGNORE,
                 }
                 this.tokens.push(token);
             });

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

@@ -2443,6 +2443,9 @@ const xSTRKSTRK: IStrategyMetadata<CLVaultStrategySettings> = {
   apyMethodology:
     "APY based on 30-day historical performance, including fees and rewards.",
   realizedApyMethodology: "The realizedAPY is based on past 14 days performance by the vault",
+  feeBps: {
+    performanceFeeBps: 1000,
+  },
   additionalInfo: {
     newBounds: {
       lower: -1,

package/src/strategies/universal-lst-muliplier-strategy.tsx

@@ -2166,6 +2166,9 @@ function getStrategySettings(
       "Current annualized APY in terms of base asset of the LST. There is no additional fee taken by Troves on LST APY. We charge a 10% performance fee on the additional gain which is already accounted in the APY shown.",
     realizedApyMethodology:
       "The realizedAPY is based on past 14 days performance by the vault",
+    feeBps: {
+      performanceFeeBps: 1000,
+    },
     tags: lstSymbol.includes("BTC")
       ? [StrategyTag.BTC, StrategyTag.LEVERED]
       : [StrategyTag.LEVERED],

package/src/strategies/universal-strategy.tsx

@@ -1404,6 +1404,9 @@ const createUniversalStrategy = (params: {
         auditUrl: AUDIT_URL,
         protocols: [Protocols.VESU],
         realizedApyMethodology: "The realizedAPY is based on past 14 days performance by the vault",
+        feeBps: {
+            performanceFeeBps: 1000,
+        },
         curator: UnwrapLabsCurator,
         settings: createUniversalSettings(params.tokenSymbol),
         contractDetails: getContractDetails(params.vaultSettings),

package/src/strategies/yoloVault.ts

@@ -9,6 +9,7 @@ import {
   RiskFactor,
   SourceCodeType,
   StrategyLiveStatus,
+  TokenIndexingType,
   TokenInfo,
   UnwrapLabsCurator,
   VaultPosition,
@@ -875,6 +876,7 @@ const vesuPrimeUSDC: TokenInfo = {
   decimals: 18,
   logo: usdc.logo,
   displayDecimals: 2,
+  indexingType: TokenIndexingType.IGNORE,
 };
 
 const strk = Global.getDefaultTokens().find((t) => t.symbol === "STRK")!;
@@ -1042,6 +1044,9 @@ export const YoloVaultStrategies: IStrategyMetadata<YoloVaultSettings>[] = yoloV
     },
     apyMethodology:
       "Not a primary yield strategy. Funds earn yield when idle, but the main return comes from BTC price appreciation and your conviction to hold. This vault simply helps you accumulate more BTC.",
+    feeBps: {
+      performanceFeeBps: 1000,
+    },
     additionalInfo: {
       mainToken: yoloConfig.mainToken,
       secondaryToken: yoloConfig.secondaryToken,