@strkfarm/sdk 2.0.0-dev.35 → 2.0.0-dev.36

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

@@ -1,56 +0,0 @@
-import { Web3Number } from "@/dataTypes";
-import { ExtendedAdapter } from "@/strategies/universal-adapters/extended-adapter";
-import { VesuMultiplyAdapter } from "../../universal-adapters/vesu-multiply-adapter";
-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<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, cycleType: CycleType },
-    extendedAdapter: ExtendedAdapter,
-    vesuAdapter: VesuMultiplyAdapter,
-  ): Promise<TransactionResult>;
-  /**
-   * Handle deposit operation.
-   * Returns transaction calls and metadata for DB tracking.
-   */
-  abstract handleDeposit(): Promise<TransactionResult<{
-    extendedAmountInBTC: Web3Number;
-  }>>;
-  /**
-   * 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

@@ -1,88 +0,0 @@
-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

@@ -1,78 +0,0 @@
-import {
-  AVNU_API,
-  USDC_TOKEN_ADDRESS,
-  USDC_TOKEN_DECIMALS,
-  WBTC_TOKEN_ADDRESS,
-  WBTC_TOKEN_DECIMALS,
-  WALLET_ADDRESS,
-  EXTEND_CONTRACT_ADDRESS,
-  MULTIPLY_CONTRACT_ADDRESS,
-  EXTENDED_BASE_URL,
-  EXTEND_MARKET_NAME,
-  EXTENDED_QTY_PRECISION,
-  EXTENDED_FEES,
-  MAINTENANCE_MARGIN,
-  VESU_POOL_ID,
-  MAX_LTV_BTC_USDC,
-  MAX_LIQUIDATION_RATIO,
-  TARGET_HF,
-  EKUBO_ENDPOINT,
-  PRICE_MAX_SLIPPAGE_EKUBO,
-  MINIMUM_DEBT_AMOUNT_VESU_FOR_REBALANCING,
-  MINIMUM_EXTENDED_POSITION_SIZE
-} from "./constants"
-import VesuPoolV2Abi from '@/data/vesu-pool-v2.abi.json';
-import ExtendedDepositAbi from '@/data/extended-deposit.abi.json';
-import VesuMultiplyAbi from '@/data/vesu-multiple.abi.json';
-
-// Grouped, readable configuration (no behavior change). Consumers can migrate gradually.
-
-export const AddressesConfig = {
-  tokens: {
-    USDC: { address: USDC_TOKEN_ADDRESS, decimals: USDC_TOKEN_DECIMALS },
-    WBTC: { address: WBTC_TOKEN_ADDRESS, decimals: WBTC_TOKEN_DECIMALS },
-  },
-  contracts: {
-    EXTENDED: EXTEND_CONTRACT_ADDRESS,
-    MULTIPLY: MULTIPLY_CONTRACT_ADDRESS,
-  },
-  wallet: {
-    address: WALLET_ADDRESS,
-  },
-} as const;
-
-export const ExtendedConfig = {
-  baseUrl: EXTENDED_BASE_URL,
-  marketName: EXTEND_MARKET_NAME,
-  maintenanceMargin: MAINTENANCE_MARGIN,
-  precision: EXTENDED_QTY_PRECISION,
-  fees: EXTENDED_FEES,
-  minPositionSize: MINIMUM_EXTENDED_POSITION_SIZE,
-} as const;
-
-export const VesuConfig = {
-  poolId: VESU_POOL_ID,
-  maxLtv: MAX_LTV_BTC_USDC,
-  maxLiquidationRatio: MAX_LIQUIDATION_RATIO,
-  targetHealthFactor: TARGET_HF,
-  ekubo: {
-    endpoint: EKUBO_ENDPOINT,
-    priceMaxSlippage: PRICE_MAX_SLIPPAGE_EKUBO,
-  },
-  avnu: {
-    api: AVNU_API,
-  },
-  targetLtv : 0.61,
-  minDebtForVesuRebalacing:MINIMUM_DEBT_AMOUNT_VESU_FOR_REBALANCING
-} as const;
-
-export const AbisConfig = {
-  vesu: {
-    multiply: VesuMultiplyAbi,
-    pool: VesuPoolV2Abi,
-  },
-  extended: {
-    contract: ExtendedDepositAbi,
-  },
-} as const;
-

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

@@ -1,48 +0,0 @@
-export const AVNU_API = "https://starknet.api.avnu.fi/swap/v2/quotes";
-export const SLIPPAGE = 0.01;
-export const USDC_TOKEN_DECIMALS = 6;
-export const USDC_TOKEN_ADDRESS =
-  "0x053C91253BC9682c04929cA02ED00b3E423f6710D2ee7e0D5EBB06F3eCF368A8";
-export const BUFFER_USDC_IN_WITHDRAWAL=5;
-export const WBTC_TOKEN_ADDRESS = "0x3fe2b97c1fd336e750087d68b9b867997fd64a2661ff3ca5a7c771641e8e7ac";
-export const WBTC_TOKEN_DECIMALS = 8;
-export const MAINTENANCE_MARGIN = 0.01;
-export const MAX_PRICE_DROP_PERCENTAGE = Number(process.env.MAX_PRICE_DROP_PERCENTAGE ?? 0.25);
-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 ?? "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";
-
-// 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
-export const MAXIMUM_DELTA = Number(process.env.MAXIMUM_DELTA ?? 5);
-export const EXTENDED_BASE_URL = process.env.EXTENDED_BASE_URL ?? "https://api.starknet.extended.exchange";
-export const VESU_POOL_ID = "0x02eef0c13b10b487ea5916b54c0a7f98ec43fb3048f60fdeedaf5b08f6f88aaf";
-export const EKUBO_ENDPOINT = "https://quoter-mainnet-api.ekubo.org/{{AMOUNT}}/{{TOKEN_FROM_ADDRESS}}/{{TOKEN_TO_ADDRESS}}"; // e.g. ETH/USDC'
-export const TARGET_HF = Number(process.env.TARGET_HF ?? 1.4);
-export const MULTIPLY_CONTRACT_ADDRESS = "0x07964760e90baa28841ec94714151e03fbc13321797e68a874e88f27c9d58513";
-export const EXTEND_CONTRACT_ADDRESS = "0x062da0780fae50d68cecaa5a051606dc21217ba290969b302db4dd99d2e9b470";
-export const EXTENDED_QTY_PRECISION =  5;
-export const EXTENDED_FEES= Number(process.env.EXTENDED_FEES ?? 0.006);
-export const REBALANCE_PRICE_DROP_PERCENTAGE = Number(process.env.REBALANCE_PRICE_DROP_PERCENTAGE ?? 3);
-export const PRICE_MAX_SLIPPAGE_EKUBO = Number(process.env.PRICE_MAX_SLIPPAGE_EKUBO ?? 0.005);
-export const MINIMUM_DEBT_AMOUNT_VESU_FOR_REBALANCING = Number(process.env.MINIMUM_DEBT_AMOUNT_VESU_FOR_REBALANCING ?? 1);
-export const MINIMUM_EXTENDED_POSITION_SIZE =  0.0001;
-export const MINIMUM_WBTC_DIFFERENCE_FOR_AVNU_SWAP = 0.00001;
-export const MAX_PRICE_DIFFERENCE_BETWEEN_AVNU_AND_EXTENDED = 700;
-export const MIN_PRICE_DIFFERENCE_BETWEEN_AVNU_AND_EXTENDED = -100;
-
-//STATUS CODES
-export const SUCCESS_STATUS_CODE = 200;
-export const ERROR_STATUS_CODE = 500;
-export const BAD_REQUEST_STATUS_CODE = 400;