@strkfarm/sdk 2.0.0-dev.3 → 2.0.0-dev.30

package/src/interfaces/common.tsx

@@ -55,6 +55,68 @@ export interface IProtocol {
   logo: string;
 }
 
+export enum StrategyTag {
+  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",
+}
+
+// Security metadata enums
+export enum AuditStatus {
+  AUDITED = "Audited",
+  NOT_AUDITED = "Not Audited",
+}
+
+export enum SourceCodeType {
+  OPEN_SOURCE = "Open Source",
+  CLOSED_SOURCE = "Closed Source",
+}
+
+export enum AccessControlType {
+  MULTISIG_ACCOUNT = "Multisig Account",
+  STANDARD_ACCOUNT = "Standard Account",
+}
+
+export enum InstantWithdrawalVault {
+  YES = "Yes",
+  NO = "No",
+}
+
+// Security metadata interfaces
+export interface SourceCodeInfo {
+  type: SourceCodeType;
+  contractLink: string;
+}
+
+export interface AccessControlInfo {
+  type: AccessControlType;
+  addresses: ContractAddr[];
+  timeLock: string;
+}
+
+export interface SecurityMetadata {
+  auditStatus: AuditStatus;
+  sourceCode: SourceCodeInfo;
+  accessControl: AccessControlInfo;
+}
+
+export interface RedemptionInfo {
+  instantWithdrawalVault: InstantWithdrawalVault;
+  redemptionsInfo: {
+    title: string; // e.g. Upto $1M
+    description: string; // e.g. "1-2 hours"
+  }[],
+  alerts: StrategyAlert[];
+}
+
 export enum FlowChartColors {
   Green = "purple",
   Blue = "#35484f",
@@ -66,26 +128,65 @@ 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.
+ * @property security - Security-related metadata including audit status, source code information, and access control details.
+ * @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;
     notARisks: RiskType[];
   };
   apyMethodology?: string;
+  realizedAPYMethodology?: string;
   additionalInfo: T;
   contractDetails: {
     address: ContractAddr;
@@ -97,7 +198,30 @@ export interface IStrategyMetadata<T> {
   docs?: string;
   investmentSteps: string[];
   curator?: { name: string, logo: string },
-  isPreview?: boolean
+  isPreview?: boolean;
+  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;
+    // 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 {
@@ -124,6 +248,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:
@@ -215,6 +356,30 @@ export interface VaultPosition {
   protocol: IProtocol
 }
 
+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"
@@ -249,6 +414,12 @@ const VaultProtocol: IProtocol = {
   name: "Vault",
   logo: ""
 }
+
+const TrovesProtocol: IProtocol = {
+  name: "Troves",
+  logo: "https://app.troves.fi/favicon.ico"
+};
+
 export const Protocols = {
   NONE: NoneProtocol,
   VESU: VesuProtocol,
@@ -256,5 +427,6 @@ export const Protocols = {
   EXTENDED: ExtendedProtocol,
   EKUBO: EkuboProtocol,
   AVNU: AvnuProtocol,
-  VAULT: VaultProtocol
+  VAULT: VaultProtocol,
+  TROVES: TrovesProtocol
 }

package/src/modules/ExtendedWrapperSDk/types.ts

@@ -79,9 +79,10 @@ export enum AssetOperationType {
 }
 
 export enum AssetOperationStatus {
-  PENDING = "PENDING",
+  CREATED = "CREATED",
+  IN_PROGRESS = "IN_PROGRESS",
   COMPLETED = "COMPLETED",
-  FAILED = "FAILED",
+  REJECTED = "REJECTED",
 }
 
 // Base types
@@ -237,7 +238,7 @@ export interface Market {
 
 // Asset operation types
 export interface AssetOperation {
-  id: number;
+  id: string;
   type: AssetOperationType;
   status: AssetOperationStatus;
   amount: string;
@@ -255,6 +256,7 @@ export interface CreateOrderRequest {
   price: string;
   side: OrderSide;
   post_only?: boolean;
+  reduce_only?: boolean;
   previous_order_id?: number;
   external_id?: string;
   time_in_force?: TimeInForce;
@@ -293,7 +295,8 @@ export interface ExtendedApiResponse<T> {
 
 // Configuration types
 export interface ExtendedWrapperConfig {
-  baseUrl: string;
+  readUrl: string;
+  writeUrl: string;
   apiKey?: string;
   timeout?: number;
   retries?: number;
@@ -308,4 +311,24 @@ export interface FundingRate {
  m: string;
  f:string;
  t:number;
-}
+}
+
+export interface FundingPayment {
+  id: number;
+  accountId?: number;
+  account_id?: number;
+  market: string;
+  positionId?: number;
+  position_id?: number;
+  side: PositionSide;
+  size: string;
+  value: string;
+  markPrice?: string;
+  mark_price?: string;
+  fundingFee?: string;
+  funding_fee?: string;
+  fundingRate?: string;
+  funding_rate?: string;
+  paidTime?: number;
+  paid_time?: number;
+}