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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@strkfarm/sdk",
-    "version": "2.0.0-staging.71",
+    "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';
 
@@ -23,7 +23,8 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: 'starknet',
     displayDecimals: 2,
     priceCheckAmount: 5000, 
-    priceMethod: 'Avnu'
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.INDEXER,
 }, {
     name: 'xSTRK',
     symbol: 'xSTRK',
@@ -33,7 +34,8 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     priceCheckAmount: 5000, 
     displayDecimals: 2,
-    priceMethod: 'Avnu'
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
 }, {
     name: 'ETH',
     symbol: 'ETH',
@@ -43,6 +45,7 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     priceCheckAmount: 0.1, 
     displayDecimals: 6,
+    indexingType: TokenIndexingType.INDEXER,
 }, {
     name: 'USDC.e',
     symbol: 'USDC.e',
@@ -52,6 +55,8 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 2,
     priceCheckAmount: 1000,
+    priceProxySymbol: 'USDC',
+    indexingType: TokenIndexingType.PEGGED,
 }, {
     name: 'USDC',
     symbol: 'USDC',
@@ -61,6 +66,7 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 2,
     priceCheckAmount: 1000,
+    indexingType: TokenIndexingType.INDEXER,
 }, {
     name: 'USDT',
     symbol: 'USDT',
@@ -70,6 +76,7 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     priceCheckAmount: 1000,
     displayDecimals: 2,
+    indexingType: TokenIndexingType.INDEXER,
 }, {
     name: 'WBTC',
     symbol: 'WBTC',
@@ -79,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',
@@ -88,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',
@@ -98,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',
@@ -108,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',
@@ -117,7 +129,8 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
-    priceMethod: 'Avnu'
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
 }, {
     name: 'xsBTC',
     symbol: 'xsBTC',
@@ -127,7 +140,8 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
-    priceMethod: 'Avnu'
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
 }, {
     name: 'xtBTC',
     symbol: 'xtBTC',
@@ -137,7 +151,8 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
-    priceMethod: 'Avnu'
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
 }, {
     name: 'xLBTC',
     symbol: 'xLBTC',
@@ -147,7 +162,8 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
-    priceMethod: 'Avnu'
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
 }, {
     name: 'mRe7BTC',
     symbol: 'mRe7BTC',
@@ -158,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',
@@ -168,6 +185,7 @@ const defaultTokens: TokenInfo[] = [{
     displayDecimals: 2,
     priceCheckAmount: 100,
     dontPrice: true,
+    indexingType: TokenIndexingType.IGNORE,
 }, {
     name: "fyeWBTC",
     symbol: "fyeWBTC",
@@ -178,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",
@@ -188,6 +207,7 @@ const defaultTokens: TokenInfo[] = [{
     displayDecimals: 4,
     priceCheckAmount: 0.1,
     dontPrice: true,
+    indexingType: TokenIndexingType.IGNORE,
 }, {
     name: "fyeUSDC",
     symbol: "fyeUSDC",
@@ -198,6 +218,7 @@ const defaultTokens: TokenInfo[] = [{
     displayDecimals: 2,
     priceCheckAmount: 100,
     dontPrice: true,
+    indexingType: TokenIndexingType.IGNORE,
 }, {
     name: 'strkBTC',
     symbol: 'strkBTC',
@@ -207,7 +228,9 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
-    priceMethod: 'Avnu'
+    priceMethod: 'Avnu',
+    priceProxySymbol: 'WBTC',
+    indexingType: TokenIndexingType.PEGGED,
 }, {
     name: 'xstrkBTC',
     symbol: 'xstrkBTC',
@@ -217,8 +240,9 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001,
-    priceMethod: 'Avnu'
-},]
+    priceMethod: 'Avnu',
+    indexingType: TokenIndexingType.LST_SCRIPT,
+}];
 const tokens: TokenInfo[] = defaultTokens;
 
 /** Contains globally useful functions. 
@@ -282,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

@@ -26,6 +26,12 @@ export interface RiskFactor {
 }
 
 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;
@@ -39,6 +45,7 @@ export interface TokenInfo {
   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 {

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/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/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")!;