@strkfarm/sdk 2.0.0-staging.7 → 2.0.0-staging.70

package/src/modules/erc20.ts

@@ -2,7 +2,7 @@ import { ContractAddr, Web3Number } from "@/dataTypes";
 import { IConfig } from "@/interfaces";
 import { Contract } from "starknet";
 import ERC20Abi from '@/data/erc20.abi.json';
-
+import { uint256 } from "starknet";
 export class ERC20 {
     readonly config: IConfig;
 
@@ -12,7 +12,7 @@ export class ERC20 {
 
     contract(addr: string | ContractAddr) {
         const _addr = typeof addr === 'string' ? addr : addr.address;
-        return new Contract({abi: ERC20Abi, address: _addr, providerOrAccount: this.config.provider});
+        return new Contract({ abi: ERC20Abi, address: _addr, providerOrAccount: this.config.provider });
     }
 
     async balanceOf(token: string | ContractAddr, address: string | ContractAddr, tokenDecimals: number) {
@@ -26,4 +26,20 @@ export class ERC20 {
         const allowance = await contract.call('allowance', [owner.toString(), spender.toString()]);
         return Web3Number.fromWei(allowance.toString(), tokenDecimals);
     }
+
+    approve(
+        token: string | ContractAddr,
+        spender: string | ContractAddr,
+        amount: Web3Number
+    ) {
+        const contract = this.contract(token);
+        const amountUint256 = uint256.bnToUint256(amount.toWei());
+        const approveCall = contract.populate("approve", [
+            spender.toString(),
+            amountUint256.low.toString(),
+            amountUint256.high.toString(),
+        ]);
+        return approveCall;
+    }
+
 }

package/src/modules/index.ts

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

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

@@ -0,0 +1,114 @@
+import axios from "axios";
+import { TokenInfo } from "@/interfaces/common";
+import { IConfig } from "@/interfaces/common";
+import { PricerBase } from "./pricerBase";
+import { PriceInfo } from "./pricer";
+import { logger } from "@/utils/logger";
+import { ContractAddr } from "@/dataTypes";
+
+const AVNU_TOKENS_API = "https://starknet.impulse.avnu.fi/v3/tokens";
+
+interface AvnuTokenApiEntry {
+    address: string;
+    symbol: string;
+    starknet?: {
+        usd?: number;
+    };
+}
+
+/**
+ * Polls Avnu impulse tokens API and keeps USD prices in memory for configured tokens.
+ * Price timestamp is set when each poll request completes.
+ */
+export class PricerAvnuApi extends PricerBase {
+    protected prices: { [key: string]: PriceInfo } = {};
+
+    readonly refreshInterval = 15_000;
+    readonly staleTime = 5 * 60 * 1000;
+
+    private pollTimer: ReturnType<typeof setInterval> | null = null;
+    private loading = false;
+
+    constructor(config: IConfig, tokens: TokenInfo[]) {
+        super(config, tokens);
+    }
+
+    start() {
+        this._loadPrices();
+        this.pollTimer = setInterval(() => {
+            this._loadPrices();
+        }, this.refreshInterval);
+    }
+
+    stop() {
+        if (this.pollTimer) {
+            clearInterval(this.pollTimer);
+            this.pollTimer = null;
+        }
+    }
+
+    isStale(timestamp: Date) {
+        return Date.now() - timestamp.getTime() > this.staleTime;
+    }
+
+    hasPrice(tokenSymbol: string) {
+        const info = this.prices[tokenSymbol];
+        return !!info && !this.isStale(info.timestamp);
+    }
+
+    async getPrice(tokenSymbol: string): Promise<PriceInfo> {
+        const info = this.prices[tokenSymbol];
+        if (!info) {
+            throw new Error(`AvnuApi: price of ${tokenSymbol} not found`);
+        }
+        if (this.isStale(info.timestamp)) {
+            throw new Error(`AvnuApi: price of ${tokenSymbol} is stale`);
+        }
+        return info;
+    }
+
+    protected async _loadPrices() {
+        if (this.loading) {
+            return;
+        }
+        this.loading = true;
+        const timestamp = new Date();
+        try {
+            const result = await axios.get<AvnuTokenApiEntry[]>(AVNU_TOKENS_API);
+            const priceByAddress = new Map<string, number>();
+            for (const entry of result.data) {
+                const usd = entry.starknet?.usd;
+                if (usd != null && usd > 0) {
+                    priceByAddress.set(ContractAddr.standardise(entry.address), usd);
+                }
+            }
+
+            for (const token of this.tokens) {
+                if (token.symbol === "USDT" || token.symbol === "USDC") {
+                    this.prices[token.symbol] = { price: 1, timestamp };
+                    continue;
+                }
+
+                const targetToken = token.priceProxySymbol
+                    ? this.tokens.find((t) => t.symbol === token.priceProxySymbol)
+                    : token;
+                if (!targetToken) {
+                    continue;
+                }
+
+                const addr = targetToken.address.address;
+                const price = priceByAddress.get(addr);
+                if (price != null) {
+                    this.prices[token.symbol] = { price, timestamp };
+                    logger.verbose(
+                        `AvnuApi: ${token.symbol} -> $${price}`,
+                    );
+                }
+            }
+        } catch (error: any) {
+            logger.warn(`AvnuApi: failed to fetch tokens: ${error?.message ?? error}`);
+        } finally {
+            this.loading = false;
+        }
+    }
+}

package/src/modules/pricer.ts

@@ -7,12 +7,23 @@ import { PricerBase } from "./pricerBase";
 import { logger } from "@/utils/logger";
 import { AvnuWrapper } from "./avnu";
 import { BlockIdentifier } from "starknet";
+import { PricerAvnuApi } from "./pricer-avnu-api";
 
 export interface PriceInfo {
     price: number,
     timestamp: Date
 }
 
+type PriceMethod = 'AvnuApi' | 'Coinbase' | 'Coinmarketcap' | 'Ekubo' | 'Avnu';
+
+const PRICE_METHOD_PRIORITY: PriceMethod[] = [
+    'AvnuApi',
+    'Coinbase',
+    'Coinmarketcap',
+    'Ekubo',
+    'Avnu',
+];
+
 export class Pricer extends PricerBase {
     protected prices: {
         [key: string]: PriceInfo
@@ -21,9 +32,11 @@ export class Pricer extends PricerBase {
     refreshInterval = 30000;
     staleTime = 60000;
 
+    protected readonly avnuApiPricer: PricerAvnuApi;
+
     // code populates this map during runtime to determine which method to use for a given token
     // The method set will be the first one to try after first attempt
-    protected methodToUse: {[tokenSymbol: string]: 'Ekubo' | 'Coinbase' | 'Coinmarketcap' | 'Avnu'} = {};
+    protected methodToUse: {[tokenSymbol: string]: PriceMethod} = {};
 
     /**
      * TOKENA and TOKENB are the two token names to get price of TokenA in terms of TokenB
@@ -36,6 +49,7 @@ export class Pricer extends PricerBase {
         super(config, tokens);
         this.refreshInterval = refreshInterval;
         this.staleTime = staleTime;
+        this.avnuApiPricer = new PricerAvnuApi(config, tokens);
     }
 
     isReady() {
@@ -69,6 +83,7 @@ export class Pricer extends PricerBase {
     }
 
     start() {
+        this.avnuApiPricer.start();
         this._loadPrices();
         setInterval(() => {
             this._loadPrices();
@@ -96,6 +111,9 @@ export class Pricer extends PricerBase {
             let retry = 0;
             while (retry < MAX_RETRIES) {
                 try {
+                    if (token.dontPrice) {
+                        return;
+                    }
                     if (token.symbol === 'USDT' || token.symbol === 'USDC') {
                         this.prices[token.symbol] = {
                             price: 1,
@@ -145,56 +163,56 @@ export class Pricer extends PricerBase {
         }
     }
 
-    async _getPrice(token: TokenInfo, defaultMethod = 'all'): Promise<number> {
-        const methodToUse: string = this.methodToUse[token.symbol] || defaultMethod; // default start with coinbase
-        logger.verbose(`Fetching price of ${token.symbol} using ${methodToUse}`);
-        switch (methodToUse) {
+    async _getPrice(token: TokenInfo): Promise<number> {
+        const pinned = this.methodToUse[token.symbol];
+        if (pinned) {
+            logger.verbose(`Fetching price of ${token.symbol} using pinned ${pinned}`);
+            try {
+                return await this._tryPriceMethod(token, pinned);
+            } catch (error: any) {
+                console.warn(`${pinned}: pinned price failed [${token.symbol}]: `, error.message);
+                delete this.methodToUse[token.symbol];
+            }
+        }
+
+        for (const method of PRICE_METHOD_PRIORITY) {
+            logger.verbose(`Fetching price of ${token.symbol} using ${method}`);
+            try {
+                const result = await this._tryPriceMethod(token, method);
+                this.methodToUse[token.symbol] = method;
+                return result;
+            } catch (error: any) {
+                console.warn(`${method}: price err [${token.symbol}]: `, error.message);
+            }
+        }
+
+        throw new FatalError(`Price not found for ${token.symbol}`);
+    }
+
+    protected async _tryPriceMethod(token: TokenInfo, method: PriceMethod): Promise<number> {
+        switch (method) {
+            case 'AvnuApi':
+                return await this._getPriceAvnuApi(token);
             case 'Coinbase':
-                // try {
-                //     const result = await this._getPriceCoinbase(token);
-                //     this.methodToUse[token.symbol] = 'Coinbase';
-                //     return result;
-                // } catch (error: any) {
-                //     console.warn(`Coinbase: price err: message [${token.symbol}]: `, error.message);
-                //     // do nothing, try next
-                // }
+                return await this._getPriceCoinbase(token);
             case 'Coinmarketcap':
-                try {
-                    const result = await this._getPriceCoinMarketCap(token);
-                    this.methodToUse[token.symbol] = 'Coinmarketcap';
-                    return result;
-                } catch (error: any) {
-                    console.warn(`CoinMarketCap: price err [${token.symbol}]: `, Object.keys(error));
-                    console.warn(`CoinMarketCap: price err [${token.symbol}]: `, error.message);
-                }
+                return await this._getPriceCoinMarketCap(token);
             case 'Ekubo':
-                try {
-                    const result = await this._getPriceEkubo(token, new Web3Number(token.priceCheckAmount ? token.priceCheckAmount : 1, token.decimals));
-                    this.methodToUse[token.symbol] = 'Ekubo';
-                    return result;
-                } catch (error: any) {
-                    console.warn(`Ekubo: price err [${token.symbol}]: `, error.message);
-                    console.warn(`Ekubo: price err [${token.symbol}]: `, Object.keys(error));
-                    // do nothing, try next
-                }
+                return await this._getPriceEkubo(
+                    token,
+                    new Web3Number(token.priceCheckAmount ? token.priceCheckAmount : 1, token.decimals),
+                );
             case 'Avnu':
-                try {
-                    const result = await this._getAvnuPrice(token, new Web3Number(token.priceCheckAmount ? token.priceCheckAmount : 1, token.decimals));
-                    this.methodToUse[token.symbol] = 'Avnu';
-                    return result;
-                } catch (error: any) {
-                    console.warn(`Avnu: price err [${token.symbol}]: `, error.message);
-                    console.warn(`Avnu: price err [${token.symbol}]: `, Object.keys(error));
-                }
-        }
-
-        // if methodToUse is the default one, pass Coinbase to try all from start
-        if (defaultMethod == 'all') {
-            // try again with coinbase
-            return await this._getPrice(token, 'Coinbase');
+                return await this._getAvnuPrice(
+                    token,
+                    new Web3Number(token.priceCheckAmount ? token.priceCheckAmount : 1, token.decimals),
+                );
         }
+    }
 
-        throw new FatalError(`Price not found for ${token.symbol}`);
+    async _getPriceAvnuApi(token: TokenInfo): Promise<number> {
+        const priceInfo = await this.avnuApiPricer.getPrice(token.symbol);
+        return priceInfo.price;
     }
 
     async _getPriceCoinbase(token: TokenInfo) {

package/src/node/pricer-redis.ts

@@ -18,6 +18,7 @@ export class PricerRedis extends Pricer {
         await this.initRedis(redisUrl);
 
         logger.info(`Starting Pricer with Redis`);
+        this.avnuApiPricer.start();
         this._loadPrices(this._setRedisPrices.bind(this));
         setInterval(() => {
             this._loadPrices(this._setRedisPrices.bind(this));

package/src/strategies/base-strategy.ts

@@ -23,6 +23,9 @@ export interface DualTokenInfo {
     token1: SingleTokenInfo
 }
 
+export type StrategyInputMode = "single" | "dual";
+export type InputModeFromAction<T> = T extends DualActionAmount ? "dual" : "single";
+
 export interface NetAPYSplit {
   apy: number;
   id: string;
@@ -33,18 +36,59 @@ export interface NetAPYDetails {
   splits: NetAPYSplit[];
 }
 
+export type UserPositionCardSubValueColor = "default" | "positive" | "negative" | "info";
+
+export interface UserPositionCard {
+  title: string;
+  value: string;
+  tooltip?: string;
+  subValue?: string;
+  subValueColor?: UserPositionCardSubValueColor;
+}
+
+export interface UserPositionCardsInput {
+  user: ContractAddr;
+  investmentFlows?: Array<{ amount: string; type: string; timestamp: number; tx_hash: string }>;
+  usualTimeToEarnings?: string | null;
+  usualTimeToEarningsDescription?: string | null;
+}
+
 interface CacheData {
   timestamp: number;
   ttl: number;
   data: any;
 }
-export class BaseStrategy<TVLInfo, ActionInfo> extends CacheClass {
-    readonly config: IConfig;
-    readonly cache: Map<string, CacheData> = new Map();
+export class BaseStrategy<
+  TVLInfo,
+  DepositActionInfo,
+  WithdrawActionInfo = DepositActionInfo,
+> extends CacheClass {
+  readonly config: IConfig;
+  readonly cache: Map<string, CacheData> = new Map();
+  private readonly _depositInputMode: InputModeFromAction<DepositActionInfo>;
+  private readonly _withdrawInputMode: InputModeFromAction<WithdrawActionInfo>;
 
-    constructor(config: IConfig) {
+    constructor(
+      config: IConfig,
+      inputModes?: {
+        depositInputMode?: InputModeFromAction<DepositActionInfo>;
+        withdrawInputMode?: InputModeFromAction<WithdrawActionInfo>;
+      }
+    ) {
         super();
         this.config = config;
+        this._depositInputMode = (inputModes?.depositInputMode ??
+          ("single" as InputModeFromAction<DepositActionInfo>));
+        this._withdrawInputMode = (inputModes?.withdrawInputMode ??
+          ("single" as InputModeFromAction<WithdrawActionInfo>));
+    }
+
+    depositInputMode(): InputModeFromAction<DepositActionInfo> {
+      return this._depositInputMode;
+    }
+
+    withdrawInputMode(): InputModeFromAction<WithdrawActionInfo> {
+      return this._withdrawInputMode;
     }
 
     async getUserTVL(user: ContractAddr, blockIdentifier?: BlockIdentifier): Promise<TVLInfo> {
@@ -55,11 +99,11 @@ export class BaseStrategy<TVLInfo, ActionInfo> extends CacheClass {
         throw new Error("Not implemented");
     }   
 
-    async depositCall(amountInfo: ActionInfo, receiver: ContractAddr): Promise<Call[]> {
+    async depositCall(amountInfo: DepositActionInfo, receiver: ContractAddr): Promise<Call[]> {
         throw new Error("Not implemented");
     }
 
-    async withdrawCall(amountInfo: ActionInfo, receiver: ContractAddr, owner: ContractAddr): Promise<Call[]> {
+    async withdrawCall(amountInfo: WithdrawActionInfo, receiver: ContractAddr, owner: ContractAddr): Promise<Call[]> {
         throw new Error("Not implemented");
     }
 
@@ -71,11 +115,112 @@ export class BaseStrategy<TVLInfo, ActionInfo> extends CacheClass {
         blockIdentifier?: BlockIdentifier,
         sinceBlocks?: number,
         timeperiod?: "24h" | "7d" | "30d" | "3m"
-    ): Promise<number | NetAPYDetails> {
+    ): Promise<number | string | NetAPYDetails> {
         throw new Error("Not implemented");
     }
 
     async getPendingRewards(): Promise<HarvestInfo[]> {
         return [];
     }
-}
+
+    async getUserRealizedAPY(
+        blockIdentifier?: BlockIdentifier,
+        sinceBlocks?: number
+    ): Promise<number> {
+        throw new Error("Not implemented");
+    }
+
+    async getUserPositionCards(_input: UserPositionCardsInput): Promise<UserPositionCard[]> {
+      throw new Error("Not implemented");
+    }
+
+    async getMaxTVL() : Promise<Web3Number> {
+      // Can throw an error as well if needed, RN returning 0
+      return new Web3Number('0', 18)
+    }
+
+    protected formatTokenAmountForCard(amount: Web3Number, tokenInfo: TokenInfo): string {
+      const displayDecimals = tokenInfo.displayDecimals ?? 2;
+      const fixed = Number(amount.toFixed(displayDecimals));
+      const normalized = Number.isFinite(fixed) ? fixed : 0;
+      return `${normalized.toLocaleString("en-US", {
+        maximumFractionDigits: displayDecimals,
+        minimumFractionDigits: 0,
+      })} ${tokenInfo.symbol}`;
+    }
+
+    protected formatPercentForCard(value: number): string {
+      if (!Number.isFinite(value)) return "N/A";
+      return `${(value * 100).toFixed(2)}%`;
+    }
+
+    protected formatUSDForCard(value: number): string {
+      if (!Number.isFinite(value)) return "$0.00";
+      return new Intl.NumberFormat("en-US", {
+        style: "currency",
+        currency: "USD",
+        maximumFractionDigits: 2,
+      }).format(value);
+    }
+
+    protected getSubValueColorFromSignedNumber(value: number): UserPositionCardSubValueColor {
+      if (!Number.isFinite(value)) return "default";
+      if (value > 0) return "positive";
+      if (value < 0) return "negative";
+      return "default";
+    }
+
+    /**
+     * Calculate lifetime earnings for a user based on provided data from client
+     * Formula: lifetimeEarnings = currentValue + totalWithdrawals - totalDeposits
+     * 
+     * @param userTVL - The user's current TVL (SingleTokenInfo with amount, usdValue, tokenInfo)
+     * @param investmentFlows - Array of investment flow transactions from client
+     * @returns Object containing lifetime earnings, current value, and total deposits/withdrawals
+     */
+    getLifetimeEarnings(
+        userTVL: SingleTokenInfo,
+        investmentFlows: Array<{ amount: string; type: string; timestamp: number; tx_hash: string }>
+    ): {
+        tokenInfo: SingleTokenInfo;
+        lifetimeEarnings: Web3Number;
+        currentValue: Web3Number;
+        totalDeposits: Web3Number;
+        totalWithdrawals: Web3Number;
+    } {
+        // Get token decimals from userTVL
+        const tokenDecimals = userTVL.tokenInfo.decimals;
+
+        // Initialize totals
+        let totalDeposits = Web3Number.fromWei("0", tokenDecimals);
+        let totalWithdrawals = Web3Number.fromWei("0", tokenDecimals);
+
+        // Process investment flows
+        for (const flow of investmentFlows) {
+            const amount = Web3Number.fromWei(flow.amount, tokenDecimals);
+            
+            if (flow.type === 'deposit') {
+                totalDeposits = totalDeposits.plus(amount);
+            } else if (flow.type === 'withdraw' || flow.type === 'redeem') {
+                totalWithdrawals = totalWithdrawals.plus(amount);
+            }
+        }
+
+        // Calculate lifetime earnings: current value + withdrawals - deposits
+        const lifetimeEarnings = userTVL.amount
+            .plus(totalWithdrawals)
+            .minus(totalDeposits);
+
+        return {
+            tokenInfo: {
+                tokenInfo: userTVL.tokenInfo,
+                amount: lifetimeEarnings,
+                usdValue: 0, // Lifetime earnings are not converted to USD
+            },
+            lifetimeEarnings,
+            currentValue: userTVL.amount,
+            totalDeposits,
+            totalWithdrawals,
+        };
+    }
+}

package/src/strategies/constants.ts

@@ -1,10 +1,10 @@
 import { ContractAddr } from "@/dataTypes";
 
-export const COMMON_CONTRACTS = [{
+export const MY_ACCESS_CONTROL = {
   address: ContractAddr.from("0x0636a3f51cc37f5729e4da4b1de6a8549a28f3c0d5bf3b17f150971e451ff9c2"),
   name: "Access Controller",
   sourceCodeUrl: "https://github.com/strkfarm/strkfarm-contracts/blob/main/src/components/accessControl.cairo",
-}];
+};
 
 export const ENDPOINTS = {
   VESU_BASE: "https://proxy.api.troves.fi/vesu",