@strkfarm/sdk 1.0.15 → 1.0.17

package/src/dataTypes/bignumber.ts

@@ -25,11 +25,13 @@ export class Web3Number extends BigNumber {
     }
 
     multipliedBy(value: string | number) {
-        return new Web3Number(this.mul(value).toString(), this.decimals);
+        let _value = Number(value).toFixed(6);
+        return new Web3Number(this.mul(_value).toString(), this.decimals);
     }
 
     dividedBy(value: string | number) {
-        return new Web3Number(this.div(value).toString(), this.decimals);
+        let _value = Number(value).toFixed(6);
+        return new Web3Number(this.div(_value).toString(), this.decimals);
     }
 
     plus(value: string | number) {

package/src/global.ts

@@ -45,7 +45,14 @@ export class FatalError extends Error {
     }
 }
 
-const tokens: TokenInfo[] = [];
+const tokens: TokenInfo[] = [{
+    name: 'Starknet',
+    symbol: 'STRK',
+    logo: 'https://assets.coingecko.com/coins/images/26433/small/starknet.png',
+    address: '0x4718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d',
+    decimals: 18,
+    coingeckId: 'starknet'
+}];
 
 /** Contains globally useful functions. 
  * - fatalError: Things to do when a fatal error occurs
@@ -64,6 +71,10 @@ export class Global {
         console.error(err);
     }
 
+    static getDefaultTokens() {
+        return tokens;
+    }
+
     static async getTokens(): Promise<TokenInfo[]> {
         if (tokens.length) return tokens;
 
@@ -100,6 +111,7 @@ export class Global {
                 symbol: token.symbol,
                 address: token.address,
                 decimals: token.decimals,
+                logo: token.logoUri,
                 coingeckId: token.extensions.coingeckoId,
             });
         });

package/src/index.ts

@@ -6,4 +6,7 @@ export * from './global';
 export * from './strategies';
 export * from './notifs';
 export * from './utils';
-export * from './node';
+export * from './node';
+
+export * from './utils/store';
+export * from './utils/encrypt';

package/src/interfaces/common.ts

@@ -1,10 +1,27 @@
+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,
 }
 
@@ -21,6 +38,36 @@ export interface IConfig {
     heartbeatUrl?: string
 }
 
+export interface IProtocol {
+    name: string,
+    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[],
+    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 {
     return {
         provider: new RpcProvider({

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,15 +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 class Pricer {
-    readonly config: IConfig;
-    readonly tokens: TokenInfo[] = [];
+
+export class Pricer extends PricerBase {
     protected prices: {
         [key: string]: PriceInfo
     } = {}
@@ -26,12 +25,8 @@ export class Pricer {
     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() {
@@ -80,10 +75,10 @@ export class Pricer {
         Global.assert(!this.isStale(timestamp, tokenName), `Price of ${tokenName} is stale`);
 
     }
-    async getPrice(tokenName: string) {
-        Global.assert(this.prices[tokenName], `Price of ${tokenName} not found`);
-       this.assertNotStale(this.prices[tokenName].timestamp, tokenName);
-        return this.prices[tokenName];
+    async getPrice(tokenSymbol: string) {
+        Global.assert(this.prices[tokenSymbol], `Price of ${tokenSymbol} not found`);
+       this.assertNotStale(this.prices[tokenSymbol].timestamp, tokenSymbol);
+        return this.prices[tokenSymbol];
     }
 
     protected _loadPrices(onUpdate: (tokenSymbol: string) => void = () => {}) {
@@ -180,11 +175,11 @@ export class Pricer {
     }
 
     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/index.ts

@@ -1 +1,2 @@
-export * from './autoCompounderStrk';
+export * from './autoCompounderStrk';
+export * from './vesu-rebalance';