@strkfarm/sdk 2.0.0-dev.13 → 2.0.0-dev.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strkfarm/sdk",
-  "version": "2.0.0-dev.13",
+  "version": "2.0.0-dev.15",
   "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",

package/src/strategies/index.ts

@@ -8,4 +8,5 @@ export * from './universal-strategy';
 export * from './universal-lst-muliplier-strategy';
 export * from './vesu-extended-strategy/vesu-extended-strategy';
 export * from './vesu-extended-strategy/utils/config.runtime';
-export * from './vesu-extended-strategy/utils/helper';
+export * from './vesu-extended-strategy/utils/helper';
+export * from './vesu-extended-strategy/types/transaction-metadata';

package/src/strategies/universal-adapters/extended-adapter.ts

@@ -415,30 +415,45 @@ export class ExtendedAdapter extends BaseAdapter<
     }
   }
 
-  async withdrawFromExtended(amount: Web3Number): Promise<boolean> {
+  async withdrawFromExtended(amount: Web3Number): Promise<{
+    status: boolean;
+    receivedTxnHash: boolean;
+  }> {
     try {
       if (!this.client) {
         logger.error("Client not initialized");
-        return false;
+        return {
+          status: false,
+          receivedTxnHash: false,
+        }
       }
       if (amount.lessThanOrEqualTo(0)) {
         logger.error(
           `Invalid withdrawal amount: ${amount.toNumber()}. Amount must be positive.`
         );
-        return false;
+        return {
+          status: false,
+          receivedTxnHash: false,
+        }
       }
       if (amount.lessThanOrEqualTo(this.minimumExtendedMovementAmount)) {
         logger.warn(
           `Withdrawal amount ${amount.toNumber()} is below minimum Extended movement amount ${this.minimumExtendedMovementAmount}. Skipping withdrawal.`
         );
-        return false;
+        return {
+          status: false,
+          receivedTxnHash: false,
+        }
       }
       const holdings = await this.getExtendedDepositAmount();
       if (!holdings) {
         logger.error(
           "Cannot get holdings - unable to validate withdrawal amount"
         );
-        return false;
+        return {
+          status: false,
+          receivedTxnHash: false,
+        }
       }
 
       const availableForWithdrawal = parseFloat(
@@ -451,7 +466,10 @@ export class ExtendedAdapter extends BaseAdapter<
         logger.error(
           `Invalid availableForWithdrawal: ${holdings.availableForWithdrawal}. Expected a finite, non-negative number.`
         );
-        return false;
+        return {
+          status: false,
+          receivedTxnHash: false,
+        }
       }
 
       const withdrawalAmount = amount.toNumber();
@@ -459,7 +477,10 @@ export class ExtendedAdapter extends BaseAdapter<
         logger.error(
           `Withdrawal amount ${withdrawalAmount} exceeds available balance ${availableForWithdrawal}`
         );
-        return false;
+        return {
+          status: false,
+          receivedTxnHash: false,
+        }
       }
 
       logger.info(
@@ -475,16 +496,24 @@ export class ExtendedAdapter extends BaseAdapter<
           withdrawalRequest.data,
           AssetOperationType.WITHDRAWAL
         );
-        return withdrawalStatus;
+        return {
+          status: true,
+          receivedTxnHash: withdrawalStatus,
+        }
       }
-
       logger.error(
         `Withdrawal request failed with status: ${withdrawalRequest.status}`
       );
-      return false;
+      return {
+        status: false,
+        receivedTxnHash: false,
+      }
     } catch (error) {
       logger.error(`Error creating Withdraw Call: ${error}`);
-      return false;
+      return {
+        status: false,
+        receivedTxnHash: false,
+      }
     }
   }
 

package/src/strategies/universal-adapters/index.ts

@@ -5,4 +5,5 @@ export * from "./vesu-supply-only-adapter";
 export * from "./vesu-multiply-adapter";
 export * from "./extended-adapter";
 export * from "./adapter-utils";
-export * from "./unused-balance-adapter";
+export * from "./unused-balance-adapter";
+export * from "./avnu-adapter";

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

@@ -1,13 +1,17 @@
 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 { TransactionResult } from "../types/transaction-metadata";
+
 export abstract class Operations {
+
   abstract shouldMoveAssets(
     extendedAmount: Web3Number,
     vesuAmount: Web3Number
-  ): Promise<Call[]>;
+  ): Promise<TransactionResult[]>;
+
+
   abstract shouldInvest(): Promise<{
     shouldInvest: boolean;
     vesuAmount: Web3Number;
@@ -15,20 +19,26 @@ export abstract class Operations {
     extendedLeverage: number;
     vesuLeverage: number;
   }>;
+
+  /**
+   * Move assets between protocols.
+   * Returns transaction calls and metadata for DB tracking.
+   */
   abstract moveAssets(
     params: { from: string; to: string; amount: Web3Number },
     extendedAdapter: ExtendedAdapter,
     vesuAdapter: VesuMultiplyAdapter
-  ): Promise<{
-    calls: Call[];
-    status: boolean;
-  }>;
-  abstract handleDeposit(): Promise<{
+  ): 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,25 @@
+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';
+}
+
+/**
+ * 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;
+}
+
+

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

@@ -317,6 +317,46 @@ export const calculateAmountDepositOnExtendedWhenIncurringLosses = async (
   }
 };
 
+/**
+ * calculate the amount of collateral to deposit to maintain the ltv
+ * The formula is:
+ * ((debt * debtPrice * targetHF) - (collateral * collateralPrice * ltv)) / ltv
+ * @param collateralAmount in collateral units
+ * @param debtAmount in debt units
+ * @param debtPrice in usd
+ * @param maxLtv 
+ * @param collateralPrice in usd
+ * @param targetHF 
+ * @returns deltaCollateralAmountUnits in collateral units
+ *          null if there is an error
+ */
+export const calculateWBTCAmountToMaintainLTV = (
+  collateralAmount: Web3Number,
+  debtAmount: Web3Number,
+  debtPrice: number,
+  maxLtv: number = MAX_LIQUIDATION_RATIO,
+  collateralPrice: number,
+  targetHF: number = TARGET_HF,
+) =>{
+  try {
+    const numerator1 = (collateralAmount)
+      .multipliedBy(collateralPrice)
+      .multipliedBy(maxLtv)
+    const numerator2 = debtAmount
+      .multipliedBy(debtPrice)
+      .multipliedBy(targetHF);
+    const denominator = maxLtv;
+    const collateralAmountToMaintainLTV = numerator2.minus(numerator1).dividedBy(denominator);
+    let deltaCollateralAmountUnits = new Web3Number(
+      collateralAmountToMaintainLTV.dividedBy(collateralPrice).toFixed(WBTC_TOKEN_DECIMALS),
+      WBTC_TOKEN_DECIMALS
+    );
+    return {deltaCollateralAmountUnits};
+  } catch (err) {
+    return { deltaCollateralAmountUnits: null };
+  }
+}
+
 export const calculateExposureDelta = (
   exposure_extended: number,
   exposure_vesu: number