@strkfarm/sdk 2.0.0-staging.1 → 2.0.0-staging.11

package/package.json

@@ -1,84 +1,82 @@
 {
-  "name": "@strkfarm/sdk",
-  "version": "2.0.0-staging.1",
-  "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",
-  "bin": {
-    "accountsecure": "dist/cli.js"
-  },
-  "exports": {
-
-    ".": {
-      "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"
+    "name": "@strkfarm/sdk",
+    "version": "2.0.0-staging.11",
+    "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",
+    "bin": {
+        "accountsecure": "dist/cli.js"
+    },
+    "exports": {
+        ".": {
+            "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"
+        }
+    },
+    "files": [
+        "dist",
+        "src"
+    ],
+    "publishConfig": {
+      "tag": "staging"
+    },
+    "scripts": {
+        "test": "jest",
+        "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-esm": "tsup --clean false --format iife --format esm --platform browser"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "devDependencies": {
+        "@types/jest": "^29.5.12",
+        "@types/node-telegram-bot-api": "^0.64.7",
+        "jest": "^29.7.0",
+        "jest-environment-jsdom": "^29.7.0",
+        "request": "^2.88.2",
+        "ts-jest": "^29.1.5",
+        "ts-node": "^10.9.2",
+        "tsup": "^8.1.0",
+        "typedoc": "^0.26.3",
+        "typescript": "^5.5.3"
+    },
+    "peerDependencies": {
+        "@types/react": "^19.1.2",
+        "axios": "^1.7.2",
+        "react": "19.1.2",
+        "starknet": "9.2.1"
+    },
+    "dependencies": {
+        "@apollo/client": "3.11.8",
+        "@avnu/avnu-sdk": "3.0.2",
+        "@ericnordelo/strk-merkle-tree": "^1.0.0",
+        "@noble/curves": "^1.0.0",
+        "@noble/hashes": "^2.0.0",
+        "@scure/starknet": "^2.0.0",
+        "bignumber.js": "4.0.4",
+        "browser-assert": "^1.2.1",
+        "chalk": "^4.1.2",
+        "commander": "^12.1.0",
+        "ethers": "^6.13.5",
+        "graphql": "16.9.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",
+        "winston": "^3.13.0"
     }
-  },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "publishConfig": {
-    "tag": "staging"
-  },
-  "scripts": {
-    "test": "jest",
-    "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-esm": "tsup --clean false --format iife --format esm --platform browser"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/jest": "^29.5.12",
-    "@types/node-telegram-bot-api": "^0.64.7",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "request": "^2.88.2",
-    "ts-jest": "^29.1.5",
-    "ts-node": "^10.9.2",
-    "tsup": "^8.1.0",
-    "typedoc": "^0.26.3",
-    "typescript": "^5.5.3"
-  },
-  "peerDependencies": {
-    "@types/react": "^19.1.2",
-    "axios": "^1.7.2",
-    "react": "19.1.0",
-    "starknet": "8.5.2"
-  },
-  "dependencies": {
-    "@apollo/client": "3.11.8",
-    "@avnu/avnu-sdk": "3.0.2",
-    "@ericnordelo/strk-merkle-tree": "^1.0.0",
-    "@noble/curves": "^1.0.0",
-    "@noble/hashes": "^2.0.0",
-    "@scure/starknet": "^2.0.0",
-    "@strkfarm/sdk": "link:",
-    "bignumber.js": "4.0.4",
-    "browser-assert": "^1.2.1",
-    "chalk": "^4.1.2",
-    "commander": "^12.1.0",
-    "ethers": "^6.13.5",
-    "graphql": "16.9.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",
-    "winston": "^3.13.0"
-  }
 }

package/src/dataTypes/index.ts

@@ -1,2 +1,3 @@
-export * from '@/dataTypes/bignumber';
-export * from './address';
+export * from "@/dataTypes/bignumber";
+export * from "./address";
+export * from "./mynumber";

package/src/dataTypes/mynumber.ts

@@ -0,0 +1,141 @@
+import BigNumber from "bignumber.js";
+import { ethers } from "ethers";
+
+const customInspectSymbol = Symbol.for("nodejs.util.inspect.custom");
+
+BigNumber.config({
+    DECIMAL_PLACES: 18
+});
+
+export class MyNumber {
+    bigNumber: BigNumber;
+    decimals: number;
+
+    constructor(bigNumber: string, decimals: number) {
+        this.bigNumber = new BigNumber(bigNumber);
+        this.decimals = decimals;
+    }
+
+    static fromEther(num: string, decimals: number) {
+        try {
+            return new MyNumber(
+                Number(
+                    ethers.parseUnits(Number(num).toFixed(10), decimals)
+                ).toFixed(6),
+                decimals
+            );
+        } catch (e) {
+            console.error("fromEther", e, num, decimals);
+            throw e;
+        }
+    }
+
+    static fromZero() {
+        return new MyNumber("0", 0);
+    }
+
+    toString() {
+        return this.bigNumber.toFixed();
+    }
+
+    toEtherStr() {
+        return ethers.formatUnits(this.bigNumber.toFixed(), this.decimals);
+    }
+
+    toFixedStr(decimals: number) {
+        return Number(this.toEtherStr()).toFixed(decimals);
+    }
+
+    toEtherToFixedDecimals(decimals: number) {
+        // rounding down
+        if (this.bigNumber.isNaN()) {
+            return "NaN";
+        }
+        return (
+            Math.floor(parseFloat(this.toEtherStr()) * 10 ** decimals) /
+            10 ** decimals
+        ).toFixed(decimals);
+    }
+
+    isZero() {
+        return this.bigNumber.eq("0");
+    }
+
+    /**
+     *
+     * @param amountEther in token terms without decimal e.g. 1 for 1 STRK
+     * @param command BigNumber compare funds. e.g. gte, gt, lt
+     * @returns
+     * @dev Add more commands as needed
+     */
+    compare(amountEther: string, command: "gte" | "gt" | "lt") {
+        const fullNum = new BigNumber(
+            ethers.parseUnits(amountEther, this.decimals).toString()
+        );
+        return this.bigNumber[command](fullNum);
+    }
+
+    operate(command: "div" | "plus" | "mul", value: string | number) {
+        const bn = new BigNumber(Number(value).toFixed(6));
+        return new MyNumber(
+            this.bigNumber[command](bn).toFixed(0),
+            this.decimals
+        );
+    }
+
+    subtract(value: MyNumber) {
+        const bn = this.bigNumber.minus(value.bigNumber);
+        return new MyNumber(bn.toString(), this.decimals);
+    }
+
+    static min(a: MyNumber, b: MyNumber) {
+        if (a.decimals !== b.decimals) {
+            const diff = Math.abs(a.decimals - b.decimals);
+            if (a.decimals > b.decimals) {
+                b = new MyNumber(
+                    b.bigNumber.times(10 ** diff).toString(),
+                    a.decimals
+                );
+            } else {
+                a = new MyNumber(
+                    a.bigNumber.times(10 ** diff).toString(),
+                    b.decimals
+                );
+            }
+        }
+        const bn = BigNumber.min(a.bigNumber, b.bigNumber);
+        return new MyNumber(
+            bn.toString(),
+            a.decimals > b.decimals ? a.decimals : b.decimals
+        );
+    }
+
+    static max(a: MyNumber, b: MyNumber) {
+        if (a.decimals !== b.decimals) {
+            const diff = Math.abs(a.decimals - b.decimals);
+            if (a.decimals > b.decimals) {
+                b = new MyNumber(
+                    b.bigNumber.times(10 ** diff).toString(),
+                    a.decimals
+                );
+            } else {
+                a = new MyNumber(
+                    a.bigNumber.times(10 ** diff).toString(),
+                    b.decimals
+                );
+            }
+        }
+        const bn = BigNumber.max(a.bigNumber, b.bigNumber);
+        return new MyNumber(
+            bn.toString(),
+            a.decimals > b.decimals ? a.decimals : b.decimals
+        );
+    }
+
+    [customInspectSymbol](depth: any, inspectOptions: any, inspect: any) {
+        return JSON.stringify({
+            raw: this.toString(),
+            decimals: this.decimals
+        });
+    }
+}

package/src/global.ts

@@ -41,11 +41,20 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     priceCheckAmount: 0.1, 
     displayDecimals: 6,
+}, {
+    name: 'USDC.e',
+    symbol: 'USDC.e',
+    logo: 'https://assets.troves.fi/integrations/tokens/usdc.svg',
+    address: ContractAddr.from('0x53c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8'),
+    decimals: 6,
+    coingeckId: undefined,
+    displayDecimals: 2,
+    priceCheckAmount: 1000,
 }, {
     name: 'USDC',
     symbol: 'USDC',
     logo: 'https://assets.troves.fi/integrations/tokens/usdc.svg',
-    address: ContractAddr.from('0x53c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8'),
+    address: ContractAddr.from('0x033068F6539f8e6e6b131e6B2B814e6c34A5224bC66947c47DaB9dFeE93b35fb'),
     decimals: 6,
     coingeckId: undefined,
     displayDecimals: 2,
@@ -105,6 +114,7 @@ const defaultTokens: TokenInfo[] = [{
     decimals: 8,
     coingeckId: undefined,
     displayDecimals: 6,
+    priceProxySymbol: 'WBTC',
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
 }, {
     name: 'xsBTC',
@@ -126,6 +136,7 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
+    priceProxySymbol: 'WBTC',
 }, {
     name: 'xLBTC',
     symbol: 'xLBTC',
@@ -244,6 +255,21 @@ export class Global {
         return token;
     }
 
+    static async getTokenInfoFromName(tokenName: string) {
+        // if tokens are not loaded, load them
+        if (tokens.length == defaultTokens.length) {
+            await Global.getTokens();
+        }
+
+        const token = tokens.find(
+            (token) => token.name.toLowerCase() === tokenName.toLowerCase()
+        );
+        if (!token) {
+            throw new FatalError(`Token not found: ${tokenName}`);
+        }
+        return token;
+    }
+
     static setGlobalCache(key: string, data: any, ttl: number = 60000) {
         Global.cache[key] = {
             value: data,

package/src/index.browser.ts

@@ -3,4 +3,5 @@ export * from './modules';
 export * from './interfaces';
 export * from './dataTypes';
 export * from './global';
-export * from './strategies';
+export * from './strategies';
+export * from "./utils";

package/src/interfaces/common.tsx

@@ -55,19 +55,15 @@ export interface IProtocol {
   logo: string;
 }
 
-// Strategy-level enums
-export enum StrategyCategory {
-  ALL = "all",
-  BTC = "btc",
-  META_VAULTS = "meta-vaults",
+export enum StrategyTag {
+  META_VAULT = "Meta Vaults",
+  LEVERED = "Maxx",
+  AUTOMATED_LP = "Ekubo",
+  BTC = "BTC"
 }
 
-export enum StrategyTag {
-  EKUBO = "Ekubo",
-  EVERGREEN = "Evergreen",
-  HYPER_LST = "Hyper-LST",
-  VESU = "Vesu",
-  SENSEI = "Sensei",
+export enum VaultType {
+  FARMING = "farming"
 }
 
 // Security metadata enums
@@ -132,6 +128,38 @@ export interface FAQ {
   answer: string | React.ReactNode;
 }
 
+export enum StrategyLiveStatus {
+    ACTIVE = "Active",
+    NEW = "New",
+    COMING_SOON = "Coming Soon",
+    DEPRECATED = "Deprecated", // active but not recommended
+    RETIRED = "Retired", // not active anymore
+    HOT = "Hot & New 🔥"
+}
+
+export interface StrategyAlert {
+    type: "warning" | "info";
+    text: string | React.ReactNode;
+    tab: "all" | "deposit" | "withdraw";
+}
+
+export interface StrategySettings {
+    maxTVL?: Web3Number;
+    liveStatus?: StrategyLiveStatus;
+    isPaused?: boolean;
+    isInMaintenance?: boolean;
+    isAudited: boolean;
+    isInstantWithdrawal?: boolean;
+    hideHarvestInfo?: boolean;
+    is_promoted?: boolean;
+    isTransactionHistDisabled?: boolean;
+    quoteToken: TokenInfo;
+    hideNetEarnings?: boolean;
+    showWithdrawalWarningModal?: boolean;
+    alerts?: StrategyAlert[];
+    tags?: StrategyTag[];
+}
+
 /**
  * @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.
@@ -139,15 +167,19 @@ export interface FAQ {
  * @property redemptionInfo - Redemption information including instant withdrawal availability and expected redemption times.
  */
 export interface IStrategyMetadata<T> {
+  id: string;
   name: string;
   description: string | React.ReactNode;
   address: ContractAddr;
   launchBlock: number;
   type: "ERC4626" | "ERC721" | "Other";
+  vaultType: {
+    type: VaultType;
+    description: string;
+  };
   depositTokens: TokenInfo[];
   protocols: IProtocol[];
   auditUrl?: string;
-  maxTVL: Web3Number;
   risk: {
     riskFactor: RiskFactor[];
     netRisk: number;
@@ -166,10 +198,22 @@ export interface IStrategyMetadata<T> {
   investmentSteps: string[];
   curator?: { name: string, logo: string },
   isPreview?: boolean;
-  category: StrategyCategory;
   tags?: StrategyTag[];
   security: SecurityMetadata;
   redemptionInfo: RedemptionInfo;
+  settings?: StrategySettings;
+    // Legacy field for multi-step strategies (deprecated, use investmentFlows instead)
+    actions?: Array<{
+        name?: string;
+        pool?: {
+            protocol?: { name: string; logo: string };
+            pool?: { name: string; logos?: string[] };
+            apr?: number;
+            borrow?: { apr?: number };
+        };
+        amount?: string | number;
+        isDeposit?: boolean;
+    }>;
 }
 
 export interface IInvestmentFlow {
@@ -196,6 +240,23 @@ export function getMainnetConfig(
   };
 }
 
+export const getStrategyTagDesciption = (tag: StrategyTag): string => {
+  switch (tag) {
+    case StrategyTag.META_VAULT:
+      return "A meta vault is a vault that auto allocates funds to multiple vaults based on optimal yield opportunities";
+    case StrategyTag.LEVERED:
+      return "Looping vaults on Endur LSTs with leveraged borrowing of STRK or BTC to increase yield (2-4x higher yield than simply staking)";
+    case StrategyTag.AUTOMATED_LP:
+      return "Automated LP vaults on Ekubo that rebalance position automatically, ensuring you earn fees efficiently";
+    case StrategyTag.BTC:
+      return "BTC linked vaults";
+  }
+}
+
+export const getAllStrategyTags = (): StrategyTag[] => {
+  return Object.values(StrategyTag);
+}
+
 export const getRiskExplaination = (riskType: RiskType) => {
   switch (riskType) {
     case RiskType.MARKET_RISK:
@@ -286,6 +347,30 @@ export interface VaultPosition {
   remarks: string
 }
 
+export interface AmountInfo {
+    amount: Web3Number;
+    usdValue: number;
+    tokenInfo: TokenInfo;
+}
+
+export interface AmountsInfo {
+    usdValue: number;
+    amounts: AmountInfo[];
+}
+
+/**
+ * Strategy capabilities interface
+ * Describes what optional methods a strategy instance supports
+ */
+export interface StrategyCapabilities {
+    hasMatchInputAmounts: boolean;
+    hasNetAPY: boolean;
+    hasGetInvestmentFlows: boolean;
+    hasGetPendingRewards: boolean;
+    hasHarvest: boolean;
+    hasRebalance: boolean;
+}
+
 const VesuProtocol: IProtocol = {
   name: "Vesu",
   logo: "https://static-assets-8zct.onrender.com/integrations/vesu/logo.png"

package/src/modules/ekubo-quoter.ts

@@ -28,7 +28,7 @@ export interface EkuboQuote {
 
 
 export class EkuboQuoter {
-  ENDPOINT = 'https://quoter-mainnet-api.ekubo.org/{{AMOUNT}}/{{TOKEN_FROM_ADDRESS}}/{{TOKEN_TO_ADDRESS}}'; // e.g. ETH/USDC'
+  ENDPOINT = 'https://prod-api-quoter.ekubo.org/23448594291968334/{{AMOUNT}}/{{TOKEN_FROM_ADDRESS}}/{{TOKEN_TO_ADDRESS}}'; // e.g. ETH/USDC'
   
   constructor(private readonly config: IConfig) {}
 

package/src/modules/harvests.ts

@@ -29,6 +29,7 @@ export class Harvests {
 
     async getUnHarvestedRewards(addr: ContractAddr) {
         const rewards = await this.getHarvests(addr);
+        logger.verbose(`${Harvests.name}: getUnHarvestedRewards => rewards length: ${rewards.length}`);
         if (rewards.length == 0) return [];
 
         const unClaimed: HarvestInfo[] = [];
@@ -66,26 +67,28 @@ const STRK = '0x4718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d'
 
 export class EkuboHarvests extends Harvests {
     async getHarvests(addr: ContractAddr) {
-        const EKUBO_API = `https://starknet-mainnet-api.ekubo.org/airdrops/${addr.address}?token=${STRK}`
+        logger.verbose(`${EkuboHarvests.name}: getHarvests => addr: ${addr.address}`);
+        const EKUBO_API = `https://prod-api.ekubo.org/claims/${addr.address}`
         const resultEkubo = await fetch(EKUBO_API);
-        const items = (await resultEkubo.json());
-
+        const data = (await resultEkubo.json());
+        const claims = data.claims || [];
+        logger.verbose(`${EkuboHarvests.name}: getHarvests => claims length: ${claims.length}`);
         const rewards: HarvestInfo[] = [];
-        for (let i=0; i<items.length; ++i) {
-            const info = items[i];
-            assert(info.token == STRK, 'expected strk token only')
+        for (let i=0; i<claims.length; ++i) {
+            const claimData = claims[i];
+            assert(claimData.key.token == STRK, 'expected strk token only')
             rewards.push({
-                rewardsContract: ContractAddr.from(info.contract_address),
+                rewardsContract: ContractAddr.from(claimData.dropAddress),
                 token: ContractAddr.from(STRK),
-                startDate: new Date(info.start_date),
-                endDate: new Date(info.end_date),
+                startDate: new Date(0),
+                endDate: new Date(0),
                 claim: {
-                    id: info.claim.id,
-                    amount: Web3Number.fromWei(info.claim.amount, 18),
-                    claimee: ContractAddr.from(info.claim.claimee)
+                    id: claimData.claim.index,
+                    amount: Web3Number.fromWei(claimData.claim.amount, 18),
+                    claimee: ContractAddr.from(claimData.claim.account)
                 },
-                actualReward: Web3Number.fromWei(info.claim.amount, 18),
-                proof: info.proof
+                actualReward: Web3Number.fromWei(claimData.claim.amount, 18),
+                proof: claimData.proof
             });
         }
         return rewards.sort((a, b) => b.endDate.getTime() - a.endDate.getTime());

package/src/modules/index.ts

@@ -5,6 +5,5 @@ export * from './pricer-from-api';
 export * from './erc20';
 export * from './avnu';
 export * from './ekubo-quoter';
-export * from './ekubo-pricer';
 export * from './pricer-lst';
 export * from './lst-apr';

package/src/modules/pricer-lst.ts

@@ -6,7 +6,7 @@ import axios from "axios";
 
 export class PricerLST extends Pricer {
   private tokenMaps: {lst: TokenInfo, underlying: TokenInfo}[];
-  protected EKUBO_API = 'https://quoter-mainnet-api.ekubo.org/{{AMOUNT}}/{{TOKEN_ADDRESS}}/{{UNDERLYING_ADDRESS}}'; // e.g. xSTRK/STRK
+  protected EKUBO_API = 'https://prod-api-quoter.ekubo.org/23448594291968334/{{AMOUNT}}/{{TOKEN_ADDRESS}}/{{UNDERLYING_ADDRESS}}'; // e.g. xSTRK/STRK
 
   constructor(config: IConfig, tokenMaps: {lst: TokenInfo, underlying: TokenInfo}[]) {
     const refreshInterval = 5000;