@strkfarm/sdk 1.0.38 → 1.0.40

package/src/global.ts

@@ -1,39 +1,7 @@
 import axios from 'axios';
 import { TokenInfo } from './interfaces';
 import { ContractAddr } from './dataTypes';
-
-const colors = {
-    error: 'red',
-    warn: 'yellow',
-    info: 'blue',
-    verbose: 'white',
-    debug: 'white',
-}
-
-// Add custom colors to Winston
-// winston.addColors(colors);
-
-// export const logger = createLogger({
-//   level: 'verbose', // Set the minimum logging level
-//   format: format.combine(
-//     format.colorize({ all: true }), // Apply custom colors
-//     format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }), // Add timestamp to log messages
-//     format.printf(({ timestamp, level, message }) => {
-//       return `${timestamp} ${level}: ${message}`;
-//     })
-//   ),
-//   transports: [
-//     // new transports.Console() // Output logs to the console
-//   ]
-// });
-
-
-export const logger = {
-    ...console,
-    verbose(message: string) {
-        console.log(`[VERBOSE] ${message}`);
-    }
-};
+import { logger } from '@/utils/logger';
 
 
 export class FatalError extends Error {

package/src/interfaces/common.ts

@@ -70,6 +70,7 @@ export interface IStrategyMetadata<T> {
   name: string;
   description: string | React.ReactNode;
   address: ContractAddr;
+  launchBlock: number;
   type: "ERC4626" | "ERC721" | "Other";
   depositTokens: TokenInfo[];
   protocols: IProtocol[];

package/src/interfaces/lending.ts

@@ -1,10 +1,9 @@
 import { IConfig } from "@/interfaces/common";
 import { TokenInfo } from "./common";
 import { ContractAddr } from "@/dataTypes/address";
-import { loggers } from "winston";
-import { logger } from "@/global";
 import { log } from "console";
 import { Web3Number } from "@/dataTypes";
+import { logger } from "@/utils/logger";
 
 export interface ILendingMetadata {
     name: string;

package/src/modules/avnu.ts

@@ -3,7 +3,7 @@ import { uint256 } from "starknet";
 import { Call, Uint256 } from "starknet";
 import { fetchBuildExecuteTransaction, fetchQuotes, Quote } from "@avnu/avnu-sdk";
 import { assert } from "../utils";
-import { logger } from "@/global";
+import { logger } from "@/utils/logger";
 
 export interface Route {
     token_from: string,

package/src/modules/erc20.ts

@@ -20,4 +20,10 @@ export class ERC20 {
         const balance = await contract.call('balanceOf', [address.toString()]);
         return Web3Number.fromWei(balance.toString(), tokenDecimals);
     }
+
+    async allowance(token: string | ContractAddr, owner: string | ContractAddr, spender: string | ContractAddr, tokenDecimals: number) {
+        const contract = this.contract(token);
+        const allowance = await contract.call('allowance', [owner.toString(), spender.toString()]);
+        return Web3Number.fromWei(allowance.toString(), tokenDecimals);
+    }
 }

package/src/modules/harvests.ts

@@ -1,5 +1,5 @@
 import { ContractAddr, Web3Number } from "@/dataTypes";
-import { logger } from "@/global";
+import { logger } from "@/utils/logger";
 import { IConfig } from "@/interfaces";
 import { assert } from "@/utils";
 import { Contract, num } from "starknet";

package/src/modules/pragma.ts

@@ -1,6 +1,6 @@
 import { Contract, RpcProvider } from "starknet";
 import PragmaAbi from '@/data/pragma.abi.json';
-import { logger } from "@/global";
+import { logger } from "@/utils/logger";
 
 export class Pragma {
     contractAddr = '0x023fb3afbff2c0e3399f896dcf7400acf1a161941cfb386e34a123f228c62832';

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

@@ -1,8 +1,8 @@
-import { logger } from "@/global";
-import { PriceInfo } from "./pricer";
+    import { PriceInfo } from "./pricer";
 import axios from "axios";
 import { IConfig, TokenInfo } from "@/interfaces";
 import { PricerBase } from "./pricerBase";
+import { logger } from "@/utils/logger";
 
 export class PricerFromApi extends PricerBase {
     constructor(config: IConfig, tokens: TokenInfo[]) {
@@ -15,7 +15,7 @@ export class PricerFromApi extends PricerBase {
         } catch (e: any) {
             logger.warn('getPriceFromMyAPI error', JSON.stringify(e.message || e));
         }
-        logger.log('getPrice coinbase', tokenSymbol);
+        logger.info('getPrice coinbase', tokenSymbol);
         let retry = 0;
         const MAX_RETRIES = 5;
         for (retry = 1; retry < MAX_RETRIES + 1; retry++) {

package/src/modules/pricer.ts

@@ -1,9 +1,10 @@
 import axios from "axios";
-import { FatalError, Global, logger } from "@/global";
+import { FatalError, Global } from "@/global";
 import { TokenInfo } from "@/interfaces/common";
 import { IConfig } from "@/interfaces/common";
 import { Web3Number } from "@/dataTypes";
 import { PricerBase } from "./pricerBase";
+import { logger } from "@/utils/logger";
 
 export interface PriceInfo {
     price: number,

package/src/modules/zkLend.ts

@@ -1,12 +1,13 @@
 import axios from "axios";
 import BigNumber from "bignumber.js";
 import { Web3Number } from "@/dataTypes/bignumber.browser";
-import { FatalError, Global, logger } from "@/global";
+import { FatalError, Global } from "@/global";
 import { TokenInfo } from "@/interfaces";
 import { ILending, ILendingPosition, LendingToken, MarginType } from "@/interfaces/lending";
 import { ContractAddr } from "@/dataTypes/address";
 import { IConfig } from "@/interfaces";
 import { Pricer } from "./pricer";
+import { logger } from "@/utils/logger";
 
 export class ZkLend extends ILending implements ILending {
     readonly pricer: Pricer;

package/src/node/pricer-redis.ts

@@ -1,8 +1,9 @@
-import { FatalError, Global, logger } from '@/global';
+import { FatalError, Global } from '@/global';
 import { IConfig, TokenInfo } from '@/interfaces';
 import { PriceInfo, Pricer } from '@/modules/pricer';
 import { createClient } from 'redis';
 import type { RedisClientType } from 'redis'
+import { logger } from "@/utils/logger";
 
 export class PricerRedis extends Pricer {
     private redisClient: RedisClientType | null = null;

package/src/notifs/telegram.ts

@@ -1,5 +1,5 @@
-import { logger } from "@/global";
 import TelegramBot from "node-telegram-bot-api";
+import { logger } from "@/utils/logger";
 
 export class TelegramNotif {
     private subscribers: string[] = [

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

@@ -24,13 +24,14 @@ import CLVaultAbi from "@/data/cl-vault.abi.json";
 import EkuboPositionsAbi from "@/data/ekubo-positions.abi.json";
 import EkuboMathAbi from "@/data/ekubo-math.abi.json";
 import ERC4626Abi from "@/data/erc4626.abi.json";
-import { Global, logger } from "@/global";
+import { Global } from "@/global";
 import { AvnuWrapper, ERC20, SwapInfo } from "@/modules";
 import { BaseStrategy } from "./base-strategy";
 import { DualActionAmount } from "./base-strategy";
 import { DualTokenInfo } from "./base-strategy";
 import { log } from "winston";
 import { EkuboHarvests } from "@/modules/harvests";
+import { logger } from "@/utils/logger";
 
 export interface EkuboPoolKey {
   token0: ContractAddr;
@@ -58,7 +59,8 @@ export interface CLVaultStrategySettings {
     upper: number;
   };
   // to get true price
-  lstContract: ContractAddr;
+  lstContract?: ContractAddr;
+  truePrice?: number; // useful for pools where price is known (e.g. USDC/USDT as 1)
   feeBps: number;
 }
 
@@ -78,7 +80,7 @@ export class EkuboCLVault extends BaseStrategy<
 
   readonly ekuboPositionsContract: Contract;
   readonly ekuboMathContract: Contract;
-  readonly lstContract: Contract;
+  readonly lstContract: Contract | null;
   poolKey: EkuboPoolKey | undefined;
   readonly avnu: AvnuWrapper;
 
@@ -109,11 +111,15 @@ export class EkuboCLVault extends BaseStrategy<
       this.address.address,
       this.config.provider
     );
-    this.lstContract = new Contract(
-      ERC4626Abi,
-      this.metadata.additionalInfo.lstContract.address,
-      this.config.provider
-    );
+    if (this.metadata.additionalInfo.lstContract) {
+      this.lstContract = new Contract(
+        ERC4626Abi,
+        this.metadata.additionalInfo.lstContract.address,
+        this.config.provider
+      );
+    } else {
+      this.lstContract = null;
+    }
 
     // ekubo positions contract
     const EKUBO_POSITION =
@@ -291,7 +297,7 @@ export class EkuboCLVault extends BaseStrategy<
         ? (await this.config.provider.getBlockWithTxs(blockIdentifier))
             .timestamp
         : new Date().getTime() / 1000;
-    const blockBefore = blockNow - sinceBlocks;
+    const blockBefore = Math.max(blockNow - sinceBlocks, this.metadata.launchBlock);
     const adjustedSupplyNow = supplyNow.minus(
       await this.getHarvestRewardShares(blockBefore, blockNow)
     );
@@ -307,13 +313,13 @@ export class EkuboCLVault extends BaseStrategy<
       .plus(tvlNow.amount1);
     const tvlPerShareNow = tvlInToken0Now
       .multipliedBy(1e18)
-      .dividedBy(adjustedSupplyNow);
+      .dividedBy(adjustedSupplyNow.toString());
     const tvlInToken0Bf = tvlBefore.amount0
       .multipliedBy(priceBefore.price)
       .plus(tvlBefore.amount1);
     const tvlPerShareBf = tvlInToken0Bf
       .multipliedBy(1e18)
-      .dividedBy(supplyBefore);
+      .dividedBy(supplyBefore.toString());
     const timeDiffSeconds = blockNowTime - blockBeforeInfo.timestamp;
     logger.verbose(`tvlInToken0Now: ${tvlInToken0Now.toString()}`);
     logger.verbose(`tvlInToken0Bf: ${tvlInToken0Bf.toString()}`);
@@ -362,7 +368,9 @@ export class EkuboCLVault extends BaseStrategy<
     user: ContractAddr,
     blockIdentifier: BlockIdentifier = "pending"
   ): Promise<Web3Number> {
-    let bal = await this.contract.call("balance_of", [user.address]);
+    let bal = await this.contract.call("balance_of", [user.address], {
+      blockIdentifier
+    });
     return Web3Number.fromWei(bal.toString(), 18);
   }
 
@@ -529,12 +537,18 @@ export class EkuboCLVault extends BaseStrategy<
   }
 
   async truePrice() {
-    const result: any = await this.lstContract.call("convert_to_assets", [
-      uint256.bnToUint256(BigInt(1e18).toString()),
-    ]);
-    const truePrice =
-      Number((BigInt(result.toString()) * BigInt(1e9)) / BigInt(1e18)) / 1e9;
-    return truePrice;
+    if (this.metadata.additionalInfo.truePrice) {
+      return this.metadata.additionalInfo.truePrice;
+    } else if (this.lstContract) {
+      const result: any = await this.lstContract.call("convert_to_assets", [
+        uint256.bnToUint256(BigInt(1e18).toString()),
+      ]);
+      const truePrice =
+        Number((BigInt(result.toString()) * BigInt(1e9)) / BigInt(1e18)) / 1e9;
+      return truePrice;
+    }
+
+    throw new Error("No true price available");
   }
 
   async getCurrentPrice(blockIdentifier: BlockIdentifier = "pending") {
@@ -1294,7 +1308,7 @@ export class EkuboCLVault extends BaseStrategy<
       const harvestEstimateCall = async (swapInfo1: SwapInfo) => {
         const swap1Amount = Web3Number.fromWei(
           uint256.uint256ToBN(swapInfo1.token_from_amount).toString(),
-          18
+          18, // cause its always STRK?
         );
         const remainingAmount = postFeeAmount.minus(swap1Amount);
         const swapInfo2 = {
@@ -1401,6 +1415,10 @@ const _riskFactor: RiskFactor[] = [
   { type: RiskType.SMART_CONTRACT_RISK, value: 0.5, weight: 25 },
   { type: RiskType.IMPERMANENT_LOSS, value: 1, weight: 75 },
 ];
+
+const _riskFactorStable: RiskFactor[] = [
+  { type: RiskType.SMART_CONTRACT_RISK, value: 0.5, weight: 25 },
+];
 const AUDIT_URL =
   "https://assets.strkfarm.com/strkfarm/audit_report_vesu_and_ekubo_strats.pdf";
 
@@ -1458,6 +1476,7 @@ export const EkuboCLVaultStrategies: IStrategyMetadata<CLVaultStrategySettings>[
       address: ContractAddr.from(
         "0x01f083b98674bc21effee29ef443a00c7b9a500fd92cf30341a3da12c73f2324"
       ),
+      launchBlock: 1209881,
       type: "Other",
       // must be same order as poolKey token0 and token1
       depositTokens: [
@@ -1495,4 +1514,57 @@ export const EkuboCLVaultStrategies: IStrategyMetadata<CLVaultStrategySettings>[
         },
       ]
     },
+    {
+      name: "Ekubo USDC/USDT",
+      description: (
+        <div>
+          <p>{_description.replace("{{POOL_NAME}}", "USDC/USDT")}</p>
+          <ul
+            style={{
+              marginLeft: "20px",
+              listStyle: "circle",
+              fontSize: "12px",
+            }}
+          >
+            <li style={{ marginTop: "10px" }}>
+              During withdrawal, you may receive either or both tokens depending
+              on market conditions and prevailing prices.
+            </li>
+          </ul>
+        </div>
+      ),
+      address: ContractAddr.from(
+        "0xd647ed735f0db52f2a5502b6e06ed21dc4284a43a36af4b60d3c80fbc56c91"
+      ),
+      launchBlock: 1385576,
+      type: "Other",
+      // must be same order as poolKey token0 and token1
+      depositTokens: [
+        Global.getDefaultTokens().find((t) => t.symbol === "USDC")!,
+        Global.getDefaultTokens().find((t) => t.symbol === "USDT")!,
+      ],
+      protocols: [_protocol],
+      auditUrl: AUDIT_URL,
+      maxTVL: Web3Number.fromWei("0", 6),
+      risk: {
+        riskFactor: _riskFactorStable,
+        netRisk:
+        _riskFactorStable.reduce((acc, curr) => acc + curr.value * curr.weight, 0) /
+        _riskFactorStable.reduce((acc, curr) => acc + curr.weight, 0),
+        notARisks: getNoRiskTags(_riskFactorStable),
+      },
+      apyMethodology:
+        "APY based on 7-day historical performance, including fees and rewards.",
+      additionalInfo: {
+        newBounds: {
+          lower: -1,
+          upper: 1,
+        },
+        truePrice: 1,
+        feeBps: 1000,
+      },
+      faqs: [
+        ...faqs,
+      ]
+    },
   ];

package/src/strategies/vesu-rebalance.tsx

@@ -13,8 +13,9 @@ import {
 import { AvnuWrapper, Pricer, SwapInfo } from "@/modules";
 import { Account, CairoCustomEnum, Contract, num, uint256 } from "starknet";
 import VesuRebalanceAbi from "@/data/vesu-rebalance.abi.json";
-import { Global, logger } from "@/global";
+import { Global } from "@/global";
 import { assert } from "@/utils";
+import { logger } from "@/utils/logger";
 import axios from "axios";
 import { PricerBase } from "@/modules/pricerBase";
 import {
@@ -954,6 +955,7 @@ export const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[]
       address: ContractAddr.from(
         "0x7fb5bcb8525954a60fde4e8fb8220477696ce7117ef264775a1770e23571929"
       ),
+      launchBlock: 0,
       type: "ERC4626",
       depositTokens: [
         Global.getDefaultTokens().find((t) => t.symbol === "STRK")!
@@ -979,6 +981,7 @@ export const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[]
       address: ContractAddr.from(
         "0x5eaf5ee75231cecf79921ff8ded4b5ffe96be718bcb3daf206690ad1a9ad0ca"
       ),
+      launchBlock: 0,
       type: "ERC4626",
       auditUrl: AUDIT_URL,
       depositTokens: [
@@ -1004,6 +1007,7 @@ export const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[]
       address: ContractAddr.from(
         "0xa858c97e9454f407d1bd7c57472fc8d8d8449a777c822b41d18e387816f29c"
       ),
+      launchBlock: 0,
       type: "ERC4626",
       auditUrl: AUDIT_URL,
       depositTokens: [
@@ -1029,6 +1033,7 @@ export const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[]
       address: ContractAddr.from(
         "0x115e94e722cfc4c77a2f15c4aefb0928c1c0029e5a57570df24c650cb7cec2c"
       ),
+      launchBlock: 0,
       type: "ERC4626",
       depositTokens: [
         Global.getDefaultTokens().find((t) => t.symbol === "USDT")!

package/src/utils/index.ts

@@ -1,3 +1,5 @@
+export * from '@/utils/logger';
+
 // Utility type to make all optional properties required
 export type RequiredFields<T> = {
     [K in keyof T]-?: T[K]

package/src/utils/logger.browser.ts

@@ -0,0 +1,20 @@
+
+interface LeveledLogMethod {
+  (message: string, ...meta: any[]): void;
+  (message: any): void
+}
+
+interface MyLogger {
+  error: LeveledLogMethod;
+  warn: LeveledLogMethod;
+  info: LeveledLogMethod;
+  verbose: LeveledLogMethod;
+  debug: LeveledLogMethod;
+}
+
+export const logger: MyLogger = {
+    ...console,
+    verbose(message: string) {
+        console.log(`[VERBOSE] ${message}`);
+    }
+};

package/src/utils/logger.node.ts

@@ -0,0 +1,35 @@
+import winston, { format } from "winston";
+
+const colors = {
+  error: "red",
+  warn: "yellow",
+  info: "blue",
+  verbose: "white",
+  debug: "white",
+};
+
+// Add custom colors to Winston
+winston.addColors(colors);
+
+export const logger = winston.createLogger({
+  level: "verbose", // Set the minimum logging level
+  format: format.combine(
+    format.colorize({ all: true }), // Apply custom colors
+    format.timestamp({ format: "YYYY-MM-DD HH:mm:ss" }), // Add timestamp to log messages
+    format.printf(({ timestamp, level, message, ...meta }) => {
+      let msg = `${timestamp} ${level}: ${message}`;
+      // Print stack trace if error is passed
+      if (meta && meta[Symbol.for("splat")]) {
+        for (const arg of meta[Symbol.for("splat")]) {
+          if (arg instanceof Error) {
+            msg += `\n${arg.stack}`;
+          }
+        }
+      }
+      return msg;
+    })
+  ),
+  transports: [
+    new winston.transports.Console(), // Output logs to the console
+  ],
+});

package/src/utils/logger.ts

@@ -0,0 +1 @@
+export * from '@/utils/logger.browser';

package/src/utils/store.ts

@@ -3,8 +3,8 @@ import fs, { readFileSync, writeFileSync } from 'fs';
 import { Account, constants } from 'starknet';
 import * as crypto from 'crypto';
 import { PasswordJsonCryptoUtil } from './encrypt';
-import { logger } from '..';
 import { log } from 'winston';
+import { logger } from "@/utils/logger";
 
 /**
  * @description Config to manage storage of files on disk