@strkfarm/sdk 1.0.16 → 1.0.17

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "@strkfarm/sdk",
-  "version": "1.0.16",
+  "version": "1.0.17",
   "description": "STRKFarm TS SDK (Meant for our internal use, but feel free to use it)",
   "typings": "dist/index.d.ts",
-  "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
     "accountsecure": "dist/cli.js"
   },
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "browser": "./dist/index.global.js",
+      "import": {
+        "browser": "./dist/index.browser.mjs",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "browser": "./dist/index.browser.global.js",
+        "default": "./dist/index.js"
+      },
+      "browser": "./dist/index.browser.global.js",
       "types": "./dist/index.d.ts"
     }
   },
@@ -22,12 +27,13 @@
   ],
   "scripts": {
     "test": "jest",
-    "build": "tsup --clean && pnpm run build:esm && npm run build:dts && npm run build:iife && npm run build-cli",
+    "build": "tsup --clean && pnpm run build:esm && npm run build:dts && npm run build:iife && npm run build-cli && pnpm run build:iife-esm",
     "build:esm": "tsup --clean false --format esm --platform node",
     "build-cli:esm": "tsup ./src/cli.ts --clean false --format esm --platform node",
     "build-cli": "tsup ./src/cli.ts --clean false && pnpm run build-cli:esm",
     "build:dts": "tsup --clean false --dts-only",
-    "build:iife": "tsup --clean false --format iife --platform browser"
+    "build:iife": "tsup --clean false --format iife --platform browser",
+    "build:iife-esm": "tsup --clean false --format iife --format esm --platform browser"
   },
   "keywords": [],
   "author": "",
@@ -48,10 +54,10 @@
     "bignumber.js": "4.0.4",
     "browser-assert": "^1.2.1",
     "chalk": "^4.1.2",
-    "coinmarketcap-api": "^3.1.1",
     "commander": "^12.1.0",
     "inquirer": "^10.1.2",
     "node-telegram-bot-api": "^0.66.0",
+    "proxy-from-env": "^1.1.0",
     "redis": "^4.7.0",
     "stacktrace-js": "^2.0.2",
     "starknet": "^6.11.0",

package/src/global.ts

@@ -48,6 +48,7 @@ export class FatalError extends Error {
 const tokens: TokenInfo[] = [{
     name: 'Starknet',
     symbol: 'STRK',
+    logo: 'https://assets.coingecko.com/coins/images/26433/small/starknet.png',
     address: '0x4718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d',
     decimals: 18,
     coingeckId: 'starknet'
@@ -110,6 +111,7 @@ export class Global {
                 symbol: token.symbol,
                 address: token.address,
                 decimals: token.decimals,
+                logo: token.logoUri,
                 coingeckId: token.extensions.coingeckoId,
             });
         });

package/src/interfaces/common.ts

@@ -1,11 +1,27 @@
-import { ContractAddr } from "@/dataTypes"
+import { ContractAddr, Web3Number } from "@/dataTypes"
 import { BlockIdentifier, RpcProvider } from "starknet"
 
+export enum RiskType {
+    MARKET_RISK = 'MARKET_RISK',
+    IMPERMANENT_LOSS = 'IMPERMANENT_LOSS',
+    LIQUIDITY_RISK = 'LIQUIDITY_RISK',
+    SMART_CONTRACT_RISK = 'SMART_CONTRACT_RISK',
+    TECHNICAL_RISK = 'TECHNICAL_RISK',
+    COUNTERPARTY_RISK = 'COUNTERPARTY_RISK', // e.g. bad debt
+}
+
+export interface RiskFactor {
+    type: RiskType,
+    value: number, // 0 to 5
+    weight: number // 0 to 100
+}
+
 export interface TokenInfo {
     name: string,
     symbol: string,
     address: string,
     decimals: number,
+    logo: string,
     coingeckId?: string,
 }
 
@@ -27,13 +43,29 @@ export interface IProtocol {
     logo: string,
 }
 
+/**
+ * @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.
+ */
 export interface IStrategyMetadata {
     name: string,
     description: string,
     address: ContractAddr,
     type: 'ERC4626' | 'ERC721' | 'Other',
     depositTokens: TokenInfo[],
-    protocols: IProtocol[]
+    protocols: IProtocol[],
+    auditUrl?: string,
+    maxTVL: Web3Number,
+    risk: {
+        riskFactor: RiskFactor[],
+        netRisk: number
+    }
+}
+
+export interface IInvestmentFlow {
+    title: string,
+    subItems: string[],
+    linkedFlows: IInvestmentFlow[],
 }
 
 export function getMainnetConfig(rpcUrl = "https://starknet-mainnet.public.blastapi.io", blockIdentifier: BlockIdentifier = 'pending'): IConfig {

package/src/modules/index.ts

@@ -1,3 +1,4 @@
 export * from './pricer';
 export * from './pragma';
-export * from './zkLend';
+export * from './zkLend';
+export * from './pricer-from-api';

package/src/modules/pricer-from-api.ts

@@ -0,0 +1,61 @@
+import { logger } from "@/global";
+import { PriceInfo } from "./pricer";
+import axios from "axios";
+import { IConfig, TokenInfo } from "@/interfaces";
+import { PricerBase } from "./pricerBase";
+
+export class PricerFromApi extends PricerBase {
+    constructor(config: IConfig, tokens: TokenInfo[]) {
+        super(config, tokens);
+    }
+
+    async getPrice(tokenSymbol: string): Promise<PriceInfo> {
+        try {
+            return await this.getPriceFromMyAPI(tokenSymbol);
+        } catch (e) {
+            logger.warn('getPriceFromMyAPI error', e);
+        }
+        logger.log('getPrice coinbase', tokenSymbol);
+        let retry = 0;
+        const MAX_RETRIES = 5;
+        for (retry = 1; retry < MAX_RETRIES + 1; retry++) {
+            try {
+                const priceInfo = await axios.get(
+                    `https://api.coinbase.com/v2/prices/${tokenSymbol}-USDT/spot`,
+                );
+                if (!priceInfo) {
+                    throw new Error('Failed to fetch price');
+                }
+                const data = await priceInfo.data;
+                const price = Number(data.data.amount);
+                return {
+                    price,
+                    timestamp: new Date()
+                }
+            } catch (e) {
+                logger.warn('getPrice coinbase error', e, retry);
+                await new Promise((resolve) => setTimeout(resolve, retry * 1000));
+            }
+        }
+        throw new Error(`Failed to fetch price for ${tokenSymbol}`);
+    }
+
+    async getPriceFromMyAPI(tokenSymbol: string) {
+        logger.verbose(`getPrice from redis: ${tokenSymbol}`);
+        const endpoint = 'https://app.strkfarm.com'
+        const url = `${endpoint}/api/price/${tokenSymbol}`;
+        const priceInfoRes = await fetch(url);
+        const priceInfo = await priceInfoRes.json();
+        const now = new Date();
+        const priceTime = new Date(priceInfo.timestamp);
+        if (now.getTime() - priceTime.getTime() > 900000) {
+          // 15 mins
+          throw new Error('Price is stale');
+        }
+        const price = Number(priceInfo.price);
+        return {
+            price,
+            timestamp: new Date(priceInfo.timestamp)
+        }
+      }
+}

package/src/modules/pricer.ts

@@ -3,22 +3,14 @@ import { FatalError, Global, logger } from "@/global";
 import { TokenInfo } from "@/interfaces/common";
 import { IConfig } from "@/interfaces/common";
 import { Web3Number } from "@/dataTypes";
-const CoinMarketCap = require('coinmarketcap-api')
+import { PricerBase } from "./pricerBase";
 
 export interface PriceInfo {
     price: number,
     timestamp: Date
 }
 
-export abstract class PricerBase {
-    async getPrice(tokenSymbol: string): Promise<PriceInfo> {
-        throw new Error('Method not implemented');
-    }
-}
-
-export class Pricer implements PricerBase{
-    readonly config: IConfig;
-    readonly tokens: TokenInfo[] = [];
+export class Pricer extends PricerBase {
     protected prices: {
         [key: string]: PriceInfo
     } = {}
@@ -33,12 +25,8 @@ export class Pricer implements 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
 
-    // backup oracle001
-    protected client = new CoinMarketCap(process.env.COINMARKETCAP_KEY!);
-    
     constructor(config: IConfig, tokens: TokenInfo[]) {
-        this.config = config;
-        this.tokens = tokens;
+        super(config, tokens);
     }
 
     isReady() {
@@ -187,11 +175,11 @@ export class Pricer implements PricerBase{
     }
 
     async _getPriceCoinMarketCap(token: TokenInfo): Promise<number> {
-        const result = await this.client.getQuotes({symbol: token.symbol});
-        if (result.data)
-            return result.data[token.symbol].quote.USD.price as number
+        // const result = await this.client.getQuotes({symbol: token.symbol});
+        // if (result.data)
+        //     return result.data[token.symbol].quote.USD.price as number
 
-        throw new Error(result);
+        throw new Error("Not implemented");
     }
 
     async _getPriceEkubo(token: TokenInfo, amountIn = new Web3Number(1, token.decimals), retry = 0): Promise<number> {

package/src/modules/pricerBase.ts

@@ -0,0 +1,15 @@
+import { IConfig, TokenInfo } from "@/interfaces";
+import { PriceInfo } from "./pricer";
+
+export abstract class PricerBase {
+    readonly config: IConfig;
+    readonly tokens: TokenInfo[];
+    constructor(config: IConfig, tokens: TokenInfo[]) {
+        this.config = config;
+        this.tokens = tokens;
+    }
+
+    async getPrice(tokenSymbol: string): Promise<PriceInfo> {
+        throw new Error('Method not implemented');
+    }
+}

package/src/modules/zkLend.ts

@@ -37,6 +37,7 @@ export class ZkLend extends ILending implements ILending {
                     name: pool.token.name,
                     symbol: pool.token.symbol,
                     address: savedTokenInfo?.address || '',
+                    logo: '',
                     decimals: pool.token.decimals,
                     borrowFactor: Web3Number.fromWei(pool.borrow_factor.value, pool.borrow_factor.decimals),
                     collareralFactor

package/src/node/pricer-redis.ts

@@ -6,6 +6,7 @@ import type { RedisClientType } from 'redis'
 
 export class PricerRedis extends Pricer {
     private redisClient: RedisClientType | null = null;
+    
     constructor(config: IConfig, tokens: TokenInfo[]) {
         super(config, tokens)
     }

package/src/strategies/vesu-rebalance.ts

@@ -1,11 +1,12 @@
 import { ContractAddr, Web3Number } from "@/dataTypes";
-import { IConfig, IProtocol, IStrategyMetadata } from "@/interfaces";
-import { Pricer, PricerBase } from "@/modules";
+import { IConfig, IInvestmentFlow, IProtocol, IStrategyMetadata, RiskFactor, RiskType } from "@/interfaces";
+import { Pricer } from "@/modules";
 import { CairoCustomEnum, Contract, num, uint256 } from "starknet";
 import VesuRebalanceAbi from '@/data/vesu-rebalance.abi.json';
 import { Global } from "@/global";
 import { assert } from "@/utils";
 import axios from "axios";
+import { PricerBase } from "@/modules/pricerBase";
 
 interface PoolProps {
     pool_id: ContractAddr;
@@ -412,10 +413,41 @@ export class VesuRebalance {
         }
         return this.contract.populate('rebalance', [actions]);
     }
+
+    async getInvestmentFlows(pools: PoolInfoFull[]) {
+        const netYield = this.netAPYGivenPools(pools);
+       
+        const baseFlow: IInvestmentFlow = {
+            title: "Deposit $1000",
+            subItems: [`Net yield: ${(netYield * 100).toFixed(2)}%`],
+            linkedFlows: [],
+        };
+
+        pools.forEach((p) => {
+            if (p.amount.eq(0)) return;
+            const flow: IInvestmentFlow = {
+                title: `${p.pool_name} - $${(p.current_weight * 1000).toFixed(2)}`,
+                subItems: [
+                    `APY: ${(p.APY.netApy * 100).toFixed(2)}%`,
+                    `Weight: ${(p.current_weight * 100).toFixed(2)}% / ${(p.max_weight * 100).toFixed(2)}%`,
+                ],
+                linkedFlows: [],
+            };
+            baseFlow.linkedFlows.push(flow);
+        });
+
+        return [baseFlow];
+    }
 }
 
 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[] = [
+    {type: RiskType.SMART_CONTRACT_RISK, value: 0.5, weight: 25},
+    {type: RiskType.TECHNICAL_RISK, value: 0.5, weight: 25},
+    {type: RiskType.COUNTERPARTY_RISK, value: 1, weight: 50},
+]
 /**
  * Represents the Vesu Rebalance Strategies.
  */
@@ -425,5 +457,10 @@ export const VesuRebalanceStrategies: IStrategyMetadata[] = [{
     address: ContractAddr.from('0xeeb729d554ae486387147b13a9c8871bc7991d454e8b5ff570d4bf94de71e1'),
     type: 'ERC4626',
     depositTokens: [Global.getDefaultTokens().find(t => t.symbol === 'STRK')!],
-    protocols: [_protocol]
+    protocols: [_protocol],
+    maxTVL: Web3Number.fromWei('0', 18),
+    risk: {
+        riskFactor: _riskFactor,
+        netRisk: _riskFactor.reduce((acc, curr) => acc + curr.value * curr.weight, 0) / 100,
+    }
 }]