@strkfarm/sdk 2.0.0-staging.6 → 2.0.0-staging.60

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@strkfarm/sdk",
-    "version": "2.0.0-staging.6",
+    "version": "2.0.0-staging.60",
     "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",
@@ -25,9 +25,6 @@
         "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",
@@ -59,6 +56,9 @@
         "react": "19.1.2",
         "starknet": "9.2.1"
     },
+    "publishConfig": {
+      "tag": "staging"
+    },
     "dependencies": {
         "@apollo/client": "3.11.8",
         "@avnu/avnu-sdk": "3.0.2",

package/src/data/universal-vault.abi.json

@@ -2,11 +2,11 @@
   {
     "type": "impl",
     "name": "UpgradeableImpl",
-    "interface_name": "openzeppelin_upgrades::interface::IUpgradeable"
+    "interface_name": "openzeppelin_interfaces::upgrades::IUpgradeable"
   },
   {
     "type": "interface",
-    "name": "openzeppelin_upgrades::interface::IUpgradeable",
+    "name": "openzeppelin_interfaces::upgrades::IUpgradeable",
     "items": [
       {
         "type": "function",
@@ -25,7 +25,7 @@
   {
     "type": "impl",
     "name": "VaultMetadataImpl",
-    "interface_name": "openzeppelin_token::erc20::interface::IERC20Metadata"
+    "interface_name": "openzeppelin_interfaces::token::erc20::IERC20Metadata"
   },
   {
     "type": "struct",
@@ -47,7 +47,7 @@
   },
   {
     "type": "interface",
-    "name": "openzeppelin_token::erc20::interface::IERC20Metadata",
+    "name": "openzeppelin_interfaces::token::erc20::IERC20Metadata",
     "items": [
       {
         "type": "function",
@@ -431,17 +431,95 @@
           }
         ],
         "state_mutability": "view"
+      },
+      {
+        "type": "function",
+        "name": "due_assets_from_id",
+        "inputs": [
+          {
+            "name": "id",
+            "type": "core::integer::u256"
+          }
+        ],
+        "outputs": [
+          {
+            "type": "core::integer::u256"
+          }
+        ],
+        "state_mutability": "view"
+      },
+      {
+        "type": "function",
+        "name": "due_assets_from_owner",
+        "inputs": [
+          {
+            "name": "owner",
+            "type": "core::starknet::contract_address::ContractAddress"
+          }
+        ],
+        "outputs": [
+          {
+            "type": "core::integer::u256"
+          }
+        ],
+        "state_mutability": "view"
+      },
+      {
+        "type": "function",
+        "name": "set_deposit_limit",
+        "inputs": [
+          {
+            "name": "limit",
+            "type": "core::integer::u256"
+          }
+        ],
+        "outputs": [],
+        "state_mutability": "external"
+      },
+      {
+        "type": "function",
+        "name": "set_mint_limit",
+        "inputs": [
+          {
+            "name": "limit",
+            "type": "core::integer::u256"
+          }
+        ],
+        "outputs": [],
+        "state_mutability": "external"
+      },
+      {
+        "type": "function",
+        "name": "get_deposit_limit",
+        "inputs": [],
+        "outputs": [
+          {
+            "type": "core::integer::u256"
+          }
+        ],
+        "state_mutability": "view"
+      },
+      {
+        "type": "function",
+        "name": "get_mint_limit",
+        "inputs": [],
+        "outputs": [
+          {
+            "type": "core::integer::u256"
+          }
+        ],
+        "state_mutability": "view"
       }
     ]
   },
   {
     "type": "impl",
     "name": "ERC4626Impl",
-    "interface_name": "openzeppelin_token::erc20::extensions::erc4626::interface::IERC4626"
+    "interface_name": "openzeppelin_interfaces::token::erc4626::IERC4626"
   },
   {
     "type": "interface",
-    "name": "openzeppelin_token::erc20::extensions::erc4626::interface::IERC4626",
+    "name": "openzeppelin_interfaces::token::erc4626::IERC4626",
     "items": [
       {
         "type": "function",
@@ -718,7 +796,7 @@
   {
     "type": "impl",
     "name": "ERC20Impl",
-    "interface_name": "openzeppelin_token::erc20::interface::IERC20"
+    "interface_name": "openzeppelin_interfaces::token::erc20::IERC20"
   },
   {
     "type": "enum",
@@ -736,7 +814,7 @@
   },
   {
     "type": "interface",
-    "name": "openzeppelin_token::erc20::interface::IERC20",
+    "name": "openzeppelin_interfaces::token::erc20::IERC20",
     "items": [
       {
         "type": "function",
@@ -854,11 +932,11 @@
   {
     "type": "impl",
     "name": "ERC20CamelOnlyImpl",
-    "interface_name": "openzeppelin_token::erc20::interface::IERC20CamelOnly"
+    "interface_name": "openzeppelin_interfaces::token::erc20::IERC20CamelOnly"
   },
   {
     "type": "interface",
-    "name": "openzeppelin_token::erc20::interface::IERC20CamelOnly",
+    "name": "openzeppelin_interfaces::token::erc20::IERC20CamelOnly",
     "items": [
       {
         "type": "function",
@@ -916,11 +994,11 @@
   {
     "type": "impl",
     "name": "AccessControlImpl",
-    "interface_name": "openzeppelin_access::accesscontrol::interface::IAccessControl"
+    "interface_name": "openzeppelin_interfaces::access::accesscontrol::IAccessControl"
   },
   {
     "type": "interface",
-    "name": "openzeppelin_access::accesscontrol::interface::IAccessControl",
+    "name": "openzeppelin_interfaces::access::accesscontrol::IAccessControl",
     "items": [
       {
         "type": "function",
@@ -1011,11 +1089,11 @@
   {
     "type": "impl",
     "name": "PausableImpl",
-    "interface_name": "openzeppelin_security::interface::IPausable"
+    "interface_name": "openzeppelin_interfaces::security::pausable::IPausable"
   },
   {
     "type": "interface",
-    "name": "openzeppelin_security::interface::IPausable",
+    "name": "openzeppelin_interfaces::security::pausable::IPausable",
     "items": [
       {
         "type": "function",
@@ -1139,7 +1217,7 @@
   },
   {
     "type": "event",
-    "name": "vault::oz_4626::ERC4626Component::Deposit",
+    "name": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Deposit",
     "kind": "struct",
     "members": [
       {
@@ -1166,7 +1244,7 @@
   },
   {
     "type": "event",
-    "name": "vault::oz_4626::ERC4626Component::Withdraw",
+    "name": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Withdraw",
     "kind": "struct",
     "members": [
       {
@@ -1198,17 +1276,17 @@
   },
   {
     "type": "event",
-    "name": "vault::oz_4626::ERC4626Component::Event",
+    "name": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Event",
     "kind": "enum",
     "variants": [
       {
         "name": "Deposit",
-        "type": "vault::oz_4626::ERC4626Component::Deposit",
+        "type": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Deposit",
         "kind": "nested"
       },
       {
         "name": "Withdraw",
-        "type": "vault::oz_4626::ERC4626Component::Withdraw",
+        "type": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Withdraw",
         "kind": "nested"
       }
     ]
@@ -1510,6 +1588,38 @@
       }
     ]
   },
+  {
+    "type": "event",
+    "name": "vault::vault::vault::Vault::BringLiquidity",
+    "kind": "struct",
+    "members": [
+      {
+        "name": "caller",
+        "type": "core::starknet::contract_address::ContractAddress",
+        "kind": "data"
+      },
+      {
+        "name": "amount",
+        "type": "core::integer::u256",
+        "kind": "data"
+      },
+      {
+        "name": "new_buffer",
+        "type": "core::integer::u256",
+        "kind": "data"
+      },
+      {
+        "name": "new_aum",
+        "type": "core::integer::u256",
+        "kind": "data"
+      },
+      {
+        "name": "epoch",
+        "type": "core::integer::u256",
+        "kind": "data"
+      }
+    ]
+  },
   {
     "type": "event",
     "name": "vault::vault::vault::Vault::Event",
@@ -1518,32 +1628,32 @@
       {
         "name": "ERC20Event",
         "type": "openzeppelin_token::erc20::erc20::ERC20Component::Event",
-        "kind": "nested"
+        "kind": "flat"
       },
       {
         "name": "ERC4626Event",
-        "type": "vault::oz_4626::ERC4626Component::Event",
-        "kind": "nested"
+        "type": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Event",
+        "kind": "flat"
       },
       {
         "name": "SRC5Event",
         "type": "openzeppelin_introspection::src5::SRC5Component::Event",
-        "kind": "nested"
+        "kind": "flat"
       },
       {
         "name": "AccessControlEvent",
         "type": "openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Event",
-        "kind": "nested"
+        "kind": "flat"
       },
       {
         "name": "UpgradeableEvent",
         "type": "openzeppelin_upgrades::upgradeable::UpgradeableComponent::Event",
-        "kind": "nested"
+        "kind": "flat"
       },
       {
         "name": "PausableEvent",
         "type": "openzeppelin_security::pausable::PausableComponent::Event",
-        "kind": "nested"
+        "kind": "flat"
       },
       {
         "name": "RedeemRequested",
@@ -1559,7 +1669,13 @@
         "name": "Report",
         "type": "vault::vault::vault::Vault::Report",
         "kind": "nested"
+      },
+      {
+        "name": "BringLiquidity",
+        "type": "vault::vault::vault::Vault::BringLiquidity",
+        "kind": "nested"
       }
     ]
   }
-]
+]
+

package/src/dataTypes/_bignumber.ts

@@ -1,5 +1,6 @@
 import { logger } from "@/utils/logger";
 import BigNumber from "bignumber.js";
+import { uint256 } from "starknet";
 
 export class _Web3Number<T extends _Web3Number<T>> extends BigNumber {
   decimals: number;
@@ -107,6 +108,10 @@ export class _Web3Number<T extends _Web3Number<T>> extends BigNumber {
       sign: sign,
     }
   }
+
+  toUint256() {
+    return uint256.bnToUint256(this.toWei());
+  }
 }
 
 BigNumber.config({ DECIMAL_PLACES: 18, ROUNDING_MODE: BigNumber.ROUND_DOWN });

package/src/dataTypes/bignumber.browser.ts

@@ -1,3 +1,4 @@
+import { Uint256, uint256 } from "starknet";
 import { _Web3Number } from "./_bignumber";
 
 export class Web3Number extends _Web3Number<Web3Number> {
@@ -5,4 +6,8 @@ export class Web3Number extends _Web3Number<Web3Number> {
         const bn = (new Web3Number(weiNumber, decimals)).dividedBy(10 ** decimals)
         return new Web3Number(bn.toString(), decimals);
     }
+
+    static fromUint256(uint256Value: Uint256): Web3Number {
+        return this.fromWei(uint256.uint256ToBN(uint256Value).toString(), 18);
+    }
 }

package/src/dataTypes/bignumber.node.ts

@@ -1,5 +1,6 @@
 import util from 'util';
 import { _Web3Number } from "./_bignumber";
+import { Uint256, uint256 } from 'starknet';
 
 export class Web3Number extends _Web3Number<Web3Number> {
 
@@ -8,6 +9,10 @@ export class Web3Number extends _Web3Number<Web3Number> {
         return new Web3Number(bn.toString(), decimals);
     }
 
+    static fromUint256(uint256Value: Uint256): Web3Number {
+        return this.fromWei(uint256.uint256ToBN(uint256Value).toString(), 18);
+    }
+
     [util.inspect.custom](depth: any, opts: any): string {
         return this.toString();
     }

package/src/global.ts

@@ -165,7 +165,54 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 2,
     priceCheckAmount: 100,
-}]
+}, {
+    name: "fyeWBTC",
+    symbol: "fyeWBTC",
+    logo: 'https://assets.strkfarm.com/integrations/tokens/wbtc.svg',
+    address: ContractAddr.from('0x04dd39de0a588f5e1c7a8377e1bef2c49caaee49a11433429d2c48f587b3a492'),
+    decimals: 8,
+    coingeckId: undefined,
+    displayDecimals: 6,
+    priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
+}, {
+    name: "fyETH",
+    symbol: "fyETH",
+    logo: 'https://assets.strkfarm.com/integrations/tokens/eth.svg',
+    address: ContractAddr.from('0x050707bC3b8730022F10530C2c6f6b9467644129C50C2868Ad0036c5e4E9e616'),
+    decimals: 18,
+    coingeckId: undefined,
+    displayDecimals: 4,
+    priceCheckAmount: 0.1,
+}, {
+    name: "fyeUSDC",
+    symbol: "fyeUSDC",
+    logo: 'https://assets.strkfarm.com/integrations/tokens/usdc.svg',
+    address: ContractAddr.from('0x07fdcec0cef01294c9c3d52415215949805c77bae8003702a7928fd6d2c36bc1'),
+    decimals: 6,
+    coingeckId: undefined,
+    displayDecimals: 2,
+    priceCheckAmount: 100,
+}, {
+    name: 'strkBTC',
+    symbol: 'strkBTC',
+    logo: 'https://assets.troves.fi/integrations/tokens/strkbtc.svg',
+    address: ContractAddr.from('0x0787150e306e6eae6e3f79dea881770e8bbff2c1b8eb490f969669ee945b3135'),
+    decimals: 8,
+    coingeckId: undefined,
+    displayDecimals: 6,
+    priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
+    priceProxySymbol: 'WBTC',
+}, {
+    name: 'xstrkBTC',
+    symbol: 'xstrkBTC',
+    logo: 'https://assets.troves.fi/integrations/tokens/xstrkbtc.svg',
+    address: ContractAddr.from('0x047751b3532fabca89b0f2e35ca1cb45e5a7b11d5e3d3663dfa1f4406b45fd88'),
+    decimals: 8,
+    coingeckId: undefined,
+    displayDecimals: 6,
+    priceCheckAmount: 0.001,
+    priceProxySymbol: 'WBTC',
+},]
 const tokens: TokenInfo[] = defaultTokens;
 
 /** Contains globally useful functions. 

package/src/interfaces/common.tsx

@@ -55,21 +55,24 @@ export interface IProtocol {
   logo: string;
 }
 
-// Strategy-level enums
-export enum StrategyCategory {
-  ALL = "all",
-  BTC = "btc",
-  META_VAULTS = "meta-vaults",
+export interface ICurator {
+  name: string;
+  logo: string;
 }
 
 export enum StrategyTag {
-  EKUBO = "Ekubo",
-  EVERGREEN = "Evergreen",
-  HYPER_LST = "Hyper-LST",
-  VESU = "Vesu",
-  SENSEI = "Sensei",
-  ENDUR = "Endur",
-    BTC = "BTC"
+  META_VAULT = "Meta Vaults",
+  LEVERED = "Maxx",
+  AUTOMATED_LP = "Ekubo",
+  BTC = "BTC"
+}
+
+export enum VaultType {
+  LOOPING = "Looping",
+  META_VAULT = "Meta Vault",
+  DELTA_NEUTRAL = "Delta Neutral",
+  AUTOMATED_LP = "Automated LP",
+  TVA = "Troves Value Averaging",
 }
 
 // Security metadata enums
@@ -86,6 +89,7 @@ export enum SourceCodeType {
 export enum AccessControlType {
   MULTISIG_ACCOUNT = "Multisig Account",
   STANDARD_ACCOUNT = "Standard Account",
+  ROLE_BASED_ACCESS = "Role Based Access",
 }
 
 export enum InstantWithdrawalVault {
@@ -102,7 +106,7 @@ export interface SourceCodeInfo {
 export interface AccessControlInfo {
   type: AccessControlType;
   addresses: ContractAddr[];
-  timeLock: string;
+  timeLock?: string;
 }
 
 export interface SecurityMetadata {
@@ -111,16 +115,13 @@ export interface SecurityMetadata {
   accessControl: AccessControlInfo;
 }
 
-// Redemption metadata interfaces
-export interface RedemptionExpectedTime {
-  upto1M: string;
-  upto10M: string;
-  above10M: string;
-}
-
 export interface RedemptionInfo {
   instantWithdrawalVault: InstantWithdrawalVault;
-  expectedRedemptionTime?: RedemptionExpectedTime;
+  redemptionsInfo: {
+    title: string; // e.g. Upto $1M
+    description: string; // e.g. "1-2 hours"
+  }[],
+  alerts: StrategyAlert[];
 }
 
 export enum FlowChartColors {
@@ -138,7 +139,8 @@ export enum StrategyLiveStatus {
     ACTIVE = "Active",
     NEW = "New",
     COMING_SOON = "Coming Soon",
-    RETIRED = "Retired",
+    DEPRECATED = "Deprecated", // active but not recommended
+    RETIRED = "Retired", // not active anymore
     HOT = "Hot & New 🔥"
 }
 
@@ -149,7 +151,6 @@ export interface StrategyAlert {
 }
 
 export interface StrategySettings {
-    maxTVL?: Web3Number;
     liveStatus?: StrategyLiveStatus;
     isPaused?: boolean;
     isInMaintenance?: boolean;
@@ -165,6 +166,13 @@ export interface StrategySettings {
     tags?: StrategyTag[];
 }
 
+export interface StrategyApyHistoryUIConfig {
+  // Defaults to true in UI if omitted.
+  showApyHistory?: boolean;
+  // Optional message shown when APY history is hidden.
+  noApyHistoryMessage?: 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.
@@ -175,9 +183,26 @@ export interface IStrategyMetadata<T> {
   id: string;
   name: string;
   description: string | React.ReactNode;
+  /**
+   * Optional UI sort priority. Higher shows earlier.
+   * Intended for pinning flagship parent vaults (e.g. BTC above STRK).
+   */
+  priority?: number;
+  /**
+   * Optional UI config for the variant intro popup (strategy page).
+   * Should be identical across strategies that share the same `parentId`.
+   */
+  variantIntro?: {
+    title: string;
+    description: string;
+  };
   address: ContractAddr;
   launchBlock: number;
   type: "ERC4626" | "ERC721" | "Other";
+  vaultType: {
+    type: VaultType;
+    description: string;
+  };
   depositTokens: TokenInfo[];
   protocols: IProtocol[];
   auditUrl?: string;
@@ -187,6 +212,7 @@ export interface IStrategyMetadata<T> {
     notARisks: RiskType[];
   };
   apyMethodology?: string;
+  realizedApyMethodology?: string;
   additionalInfo: T;
   contractDetails: {
     address: ContractAddr;
@@ -197,13 +223,20 @@ export interface IStrategyMetadata<T> {
   points?: {multiplier: number, logo: string, toolTip?: string}[];
   docs?: string;
   investmentSteps: string[];
-  curator?: { name: string, logo: string },
+  curator?: ICurator,
   isPreview?: boolean;
-  category: StrategyCategory;
   tags?: StrategyTag[];
   security: SecurityMetadata;
   redemptionInfo: RedemptionInfo;
+  usualTimeToEarnings: null | string; // e.g. "2 weeks" // some strats grow like step functions
+  usualTimeToEarningsDescription: null | string; // e.g. "LSTs price on DEX goes up roughly every 2 weeks"
+  discontinuationInfo?: {
+    date?: Date;
+    reason?: React.ReactNode | string;
+    info?: React.ReactNode | string;
+  };
   settings?: StrategySettings;
+  apyHistoryUIConfig?: StrategyApyHistoryUIConfig;
     // Legacy field for multi-step strategies (deprecated, use investmentFlows instead)
     actions?: Array<{
         name?: string;
@@ -216,6 +249,8 @@ export interface IStrategyMetadata<T> {
         amount?: string | number;
         isDeposit?: boolean;
     }>;
+  parentId?: string;
+  parentName?: string;
 }
 
 export interface IInvestmentFlow {
@@ -242,6 +277,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:
@@ -314,7 +366,7 @@ export function highlightTextWithLinks(
       {parts.map((part, i) => {
         const match = highlights.find(m => m.highlight.toLowerCase() === part.toLowerCase());
         return match ? (
-          <a key={i} href={match.link} target="_blank" style={{ color: 'var(--chakra-colors-white)', background: 'var(--chakra-colors-highlight)' }}>
+          <a key={i} href={match.link} target="_blank" style={{ color: 'white', background: 'rgba(255, 255, 255, 0.04)' }}>
             {part}
           </a>
         ) : (
@@ -375,4 +427,9 @@ export const Protocols = {
   VESU: VesuProtocol,
   ENDUR: EndurProtocol,
   EXTENDED: ExtendedProtocol
+}
+
+export const UnwrapLabsCurator: ICurator = {
+  name: "Unwrap Labs",
+  logo: "https://assets.troves.fi/integrations/unwraplabs/white.png"
 }

package/src/modules/avnu.ts

@@ -37,7 +37,7 @@ export class AvnuWrapper {
     excludeSources = ['Haiko(Solvers)']
   ): Promise<Quote> {
     const MAX_RETRY = 5;
-    // logger.verbose(`${AvnuWrapper.name}: getQuotes => Getting quotes for ${fromToken} -> ${toToken}, amount: ${amountWei}, taker: ${taker}, retry: ${retry}`);
+    logger.verbose(`${AvnuWrapper.name}: getQuotes => Getting quotes for ${fromToken} -> ${toToken}, amount: ${amountWei}, taker: ${taker}, retry: ${retry}`);
     const params: any = {
       sellTokenAddress: fromToken,
       buyTokenAddress: toToken,