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

package/src/strategies/vesu-extended-strategy/services/operationService.ts

@@ -1,34 +1,56 @@
 import { Web3Number } from "@/dataTypes";
-import { TokenInfo } from "@/interfaces";
 import { ExtendedAdapter } from "@/strategies/universal-adapters/extended-adapter";
 import { VesuMultiplyAdapter } from "../../universal-adapters/vesu-multiply-adapter";
-import { Call } from "starknet";
+import { CycleType, TransactionResult } from "../types/transaction-metadata";
+
+/** Planned asset routing between protocols (concrete `Operations` subclasses define shape). */
+export interface AssetMovementPlan {}
+
 export abstract class Operations {
+
+  abstract computeAssetMovements(
+    extendedAmount: Web3Number,
+    vesuAmount: Web3Number
+  ): Promise<AssetMovementPlan | null>;
+
+  abstract executeAssetMovements(
+    plan: AssetMovementPlan
+  ): Promise<TransactionResult[]>;
+
   abstract shouldMoveAssets(
     extendedAmount: Web3Number,
     vesuAmount: Web3Number
-  ): Promise<Call[]>;
+  ): Promise<TransactionResult[]>;
+
+
   abstract shouldInvest(): Promise<{
     shouldInvest: boolean;
     vesuAmount: Web3Number;
     extendedAmount: Web3Number;
     extendedLeverage: number;
     vesuLeverage: number;
+    debtAmountToBeRepaid: Web3Number;
   }>;
+
+  /**
+   * Move assets between protocols.
+   * Returns transaction calls and metadata for DB tracking.
+   */
   abstract moveAssets(
-    params: { from: string; to: string; amount: Web3Number },
+    params: { from: string; to: string; amount: Web3Number, cycleType: CycleType },
     extendedAdapter: ExtendedAdapter,
-    vesuAdapter: VesuMultiplyAdapter
-  ): Promise<{
-    calls: Call[];
-    status: boolean;
-  }>;
-  abstract handleDeposit(): Promise<{
+    vesuAdapter: VesuMultiplyAdapter,
+  ): Promise<TransactionResult>;
+  /**
+   * Handle deposit operation.
+   * Returns transaction calls and metadata for DB tracking.
+   */
+  abstract handleDeposit(): Promise<TransactionResult<{
     extendedAmountInBTC: Web3Number;
-    calls: Call[];
-  }>;
-  abstract handleWithdraw(amount: Web3Number): Promise<{
-    calls: Call[];
-    status: boolean;
-  }> ;
+  }>>;
+  /**
+   * Handle withdrawal operation.
+   * Returns transaction calls and metadata for DB tracking.
+   */
+  abstract handleWithdraw(amount: Web3Number): Promise<TransactionResult[]>;
 }

package/src/strategies/vesu-extended-strategy/types/transaction-metadata.ts

@@ -0,0 +1,88 @@
+import { Call } from "starknet";
+
+/**
+ * Transaction metadata that SDK generates and risk engine stores in DB.
+ * This metadata is used to track transaction lifecycle without coupling SDK to DB.
+ */
+export interface TransactionMetadata {
+  protocolFrom: string;
+  protocolTo: string;
+  transactionType: 'DEPOSIT' | 'WITHDRAWAL' | 'NONE';
+  usdAmount: string;
+  status: 'COMPLETED' | 'FAILED' | 'PENDING';
+  cycleType: CycleType;
+}
+
+
+export enum CycleType {
+  INVESTMENT = 'INVESTMENT',
+  REBALANCE_PRICE_DROP = 'REBALANCE_PRICE_DROP',
+  REBALANCE_PRICE_RISE = 'REBALANCE_PRICE_RISE',
+  WITHDRAWAL = 'WITHDRAWAL',
+  DELTA_NEUTRAL_ADJUSTMENT = 'DELTA_NEUTRAL_ADJUSTMENT',
+}
+
+/**
+ * Enhanced return type for operations that generate transactions.
+ * Includes both the calls (for execution) and metadata (for DB storage).
+ */
+export interface TransactionResult<T = any> {
+  calls: Call[];
+  status: boolean;
+  transactionMetadata: TransactionMetadata;
+}
+
+// ─── Execution Lifecycle Events ─────────────────────────────────────────────
+
+/**
+ * Key lifecycle event types emitted during execution.
+ * Used by callers (e.g. risk engine) to hook into the execution pipeline
+ * and persist state to DB, send alerts, etc.
+ */
+export enum ExecutionEventType {
+  /** Execution started — tx sent on-chain or order placed on exchange */
+  INITIATED = 'INITIATED',
+  /** Execution completed successfully — tx confirmed / order filled */
+  SUCCESS = 'SUCCESS',
+  /** Execution failed — tx reverted / order rejected / timeout */
+  FAILURE = 'FAILURE',
+}
+
+/**
+ * Metadata payload accompanying each execution lifecycle event.
+ * Contains relevant identifiers, prices, and contextual information.
+ */
+export interface ExecutionEventMetadata {
+  /** Route type string (e.g. RouteType value) */
+  routeType?: string;
+  /** Human-readable route summary */
+  routeSummary?: string;
+  /** On-chain transaction hash (when available) */
+  txHash?: string;
+  /** Exchange order ID (for off-chain orders) */
+  orderId?: string;
+  /** Amount involved in the operation */
+  amount?: string;
+  /** Protocol name */
+  protocol?: string;
+  /** Actual execution price (for exchange orders) */
+  executionPrice?: number;
+  /** Limit price that was set */
+  limitPrice?: number;
+  /** Error message on failure */
+  error?: string;
+  /** On-chain calls that were built */
+  calls?: Call[];
+  /** Extensible: any extra metadata */
+  [key: string]: any;
+}
+
+/**
+ * Callback invoked on key execution lifecycle events.
+ * Callers can use this to save to DB, send notifications, log, etc.
+ */
+export type ExecutionCallback = (
+  eventType: ExecutionEventType,
+  metadata: ExecutionEventMetadata,
+) => void | Promise<void>;
+

package/src/strategies/vesu-extended-strategy/utils/config.runtime.ts

@@ -62,6 +62,7 @@ export const VesuConfig = {
   avnu: {
     api: AVNU_API,
   },
+  targetLtv : 0.61,
   minDebtForVesuRebalacing:MINIMUM_DEBT_AMOUNT_VESU_FOR_REBALANCING
 } as const;
 

package/src/strategies/vesu-extended-strategy/utils/constants.ts

@@ -12,17 +12,16 @@ export const MAX_LTV_BTC_USDC =  0.8428;
 export const MAX_LIQUIDATION_RATIO =  0.86;
 export const VAULT_ID_EXTENDED= process.env.VAULT_ID_EXTENDED ?? 220774;
 export const WALLET_ADDRESS =
-  process.env.WALLET_ADDRESS ?? "0x07b84bb6E87588BdAde0bfe6173A615b3C220F9C3803456aE183C50EA1d15Ba1";
-export const TESTNET_WALLET_ADDRESS =
-  process.env.TESTNET_WALLET_ADDRESS ?? "0x07b84bb6E87588BdAde0bfe6173A615b3C220F9C3803456aE183C50EA1d15Ba1";
-export const TEST_WALLET_2 =
-  process.env.TEST_WALLET_2 ?? "0x004C1bdC61DAc7947F3C93d0163d660012E2aB0521567f7155fcf502848791A7";
+  process.env.WALLET_ADDRESS ?? "0x007E24592287427aaE9d291770B17d582E8A45f3aE54228F998793Ec769B7D13";
 export const STRK_API_TEST_RPC = process.env.STRK_API_TEST_RPC ?? "https://sepolia.starknet.a5a.ch";
 export const STRK_API_RPC = process.env.STRK_API_RPC ?? "https://mainnet.starknet.a5a.ch";
 export const MAX_RETRIES = Number(process.env.MAX_RETRIES ?? 3);
 export const MAX_DELAY = Number(process.env.MAX_DELAY ?? 100);
 export const EXTEND_MARKET_NAME = "BTC-USD";
-export const LIMIT_BALANCE = Number(process.env.LIMIT_BALANCE ?? 10);
+
+// factor of balance to keep as buffer (0.05 = 5%)
+export const LIMIT_BALANCE = Number(process.env.LIMIT_BALANCE ?? 0.05);
+export const LIMIT_BALANCE_VALUE=20;
 export const REBALANCER_INTERVAL = Number(process.env.REBALANCER_INTERVAL ?? 180000); //3 mins
 export const WITHDRAWAL_INTERVAL = Number(process.env.WITHDRAWAL_INTERVAL ?? 18000000); //5 hours
 export const INVESTING_INTERVAL = Number(process.env.INVESTING_INTERVAL ?? 180000); //3 mins