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

package/dist/index.d.ts

@@ -1520,7 +1520,10 @@ declare class ExtendedAdapter extends BaseAdapter<DepositParams, WithdrawParams>
     };
     getSwapFromLegacyCall(params: DepositParams): Promise<ManageCall[]>;
     getWithdrawCall(params: WithdrawParams): Promise<ManageCall[]>;
-    withdrawFromExtended(amount: Web3Number): Promise<boolean>;
+    withdrawFromExtended(amount: Web3Number): Promise<{
+        status: boolean;
+        receivedTxnHash: boolean;
+    }>;
     getHealthFactor(): Promise<number>;
     getExtendedDepositAmount(): Promise<Balance | undefined>;
     setLeverage(leverage: string, marketName: string): Promise<boolean>;
@@ -2178,8 +2181,29 @@ declare const _riskFactor: RiskFactor[];
 declare function getInvestmentSteps(lstSymbol: string, underlyingSymbol: string): string[];
 declare const HyperLSTStrategies: IStrategyMetadata<HyperLSTStrategySettings>[];
 
+/**
+ * Transaction metadata that SDK generates and risk engine stores in DB.
+ * This metadata is used to track transaction lifecycle without coupling SDK to DB.
+ */
+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).
+ */
+interface TransactionResult<T = any> {
+    calls: Call[];
+    status: boolean;
+    transactionMetadata: TransactionMetadata;
+}
+
 declare abstract class Operations {
-    abstract shouldMoveAssets(extendedAmount: Web3Number, vesuAmount: Web3Number): Promise<Call[]>;
+    abstract shouldMoveAssets(extendedAmount: Web3Number, vesuAmount: Web3Number): Promise<TransactionResult[]>;
     abstract shouldInvest(): Promise<{
         shouldInvest: boolean;
         vesuAmount: Web3Number;
@@ -2187,22 +2211,27 @@ declare 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<{
+    }, extendedAdapter: ExtendedAdapter, 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[]>;
 }
 
 interface VesuExtendedStrategySettings extends UniversalStrategySettings {
@@ -2226,7 +2255,10 @@ declare class VesuExtendedMultiplierStrategy<S extends VesuExtendedStrategySetti
     getVesuAdapter(): Promise<VesuMultiplyAdapter | null>;
     getAvnuAdapter(): Promise<AvnuAdapter | null>;
     getExtendedAdapter(): Promise<ExtendedAdapter | null>;
-    moveAssetsToVaultAllocator(amount: Web3Number, extendedAdapter: ExtendedAdapter): Promise<Call[]>;
+    moveAssetsToVaultAllocator(amount: Web3Number, extendedAdapter: ExtendedAdapter): Promise<{
+        calls: Call[];
+        status: boolean;
+    }>;
     shouldInvest(): Promise<{
         shouldInvest: boolean;
         vesuAmount: Web3Number;
@@ -2236,29 +2268,29 @@ declare class VesuExtendedMultiplierStrategy<S extends VesuExtendedStrategySetti
         debtPrice: number;
         vesuLeverage: number;
     }>;
-    shouldMoveAssets(extendedAmount: Web3Number, vesuAmount: Web3Number): Promise<Call[]>;
+    shouldMoveAssets(extendedAmount: Web3Number, vesuAmount: Web3Number): Promise<TransactionResult[]>;
+    /**
+     * Helper method to create transaction result with metadata
+     */
+    private createTransactionResult;
     moveAssets(params: {
         amount: Web3Number;
         from: string;
         to: string;
-    }, extendedAdapter: ExtendedAdapter, vesuAdapter: VesuMultiplyAdapter): Promise<{
-        calls: Call[];
-        status: boolean;
-    }>;
-    handleDeposit(): Promise<{
-        extendedAmountInBTC: Web3Number;
-        calls: Call[];
-    }>;
+    }, extendedAdapter: ExtendedAdapter, vesuAdapter: VesuMultiplyAdapter): Promise<TransactionResult>;
+    handleDeposit(): Promise<TransactionResult>;
     checkPriceDifferenceBetweenAvnuAndExtended(extendedAdapter: ExtendedAdapter, vesuAdapter: VesuMultiplyAdapter, avnuAdapter: AvnuAdapter, positionType: PositionTypeAvnuExtended): Promise<boolean>;
-    handleWithdraw(amount: Web3Number): Promise<{
-        calls: Call[];
-        status: boolean;
-    }>;
+    handleWithdraw(amount: Web3Number): Promise<TransactionResult[]>;
     getAUM(): Promise<{
         net: SingleTokenInfo;
         prevAum: Web3Number;
         splits: PositionInfo[];
     }>;
+    processTransactionDataFromSDK(txnData: TransactionResult<any>[]): Promise<{
+        callsToBeExecutedFinal: Call[];
+        txnMetadata: TransactionMetadata[];
+    } | null>;
+    processTransactionMetadata(txnMetadata: TransactionMetadata[], extendedIntentFulfilled: boolean): Promise<TransactionMetadata[] | null>;
 }
 declare const VesuExtendedTestStrategies: (extendedBackendUrl: string, extendedApiKey: string, vaultIdExtended: number, minimumExtendedMovementAmount: number, minimumVesuMovementAmount: number, minimumExtendedRetriesDelayForOrderStatus: number, minimumExtendedPriceDifferenceForSwapOpen: number, maximumExtendedPriceDifferenceForSwapClosing: number) => IStrategyMetadata<VesuExtendedStrategySettings>[];
 
@@ -2673,6 +2705,24 @@ declare const calculateDebtReductionAmountForWithdrawal: (debtAmount: Web3Number
  * @returns The amount to deposit on extended when incurring losses
  */
 declare const calculateAmountDepositOnExtendedWhenIncurringLosses: (client: ExtendedWrapper) => Promise<Web3Number | null>;
+/**
+ * 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
+ */
+declare const calculateWBTCAmountToMaintainLTV: (collateralAmount: Web3Number, debtAmount: Web3Number, debtPrice: number, maxLtv: number | undefined, collateralPrice: number, targetHF?: number) => {
+    deltaCollateralAmountUnits: Web3Number;
+} | {
+    deltaCollateralAmountUnits: null;
+};
 declare const calculateExposureDelta: (exposure_extended: number, exposure_vesu: number) => number;
 /**
  * calculate the delta percentage between the current btc price and the last btc price
@@ -3032,4 +3082,4 @@ declare class PasswordJsonCryptoUtil {
     decrypt(encryptedData: string, password: string): any;
 }
 
-export { type APYInfo, APYType, AUDIT_URL, AUMTypes, AVNU_EXCHANGE, AVNU_EXCHANGE_FOR_LEGACY_USDC, AVNU_LEGACY_SANITIZER, AVNU_MIDDLEWARE, AVNU_QUOTE_URL, AbisConfig, type AccountInfo, type AdapterLeafType, AddressesConfig, type AllAccountsStore, type ApiResponse, type ApproveCallParams, type AssetOperation, AssetOperationStatus, AssetOperationType, AutoCompounderSTRK, type AvnuSwapCallParams, AvnuWrapper, type Balance, BaseAdapter, type BaseAdapterConfig, BaseStrategy, type CLVaultStrategySettings, type CancelOrderRequest, CommonAdapter, type CommonAdapterConfig, ContractAddr, type CreateOrderRequest, type DecreaseLeverParams, Deployer, type DepositParams, type DualActionAmount, type DualTokenInfo, ERC20, EXTENDED_CONTRACT, EXTENDED_SANITIZER, type EkuboBounds, EkuboCLVault, EkuboCLVaultStrategies, type EkuboPoolKey, type EkuboQuote, EkuboQuoter, type EkuboRouteNode, type EkuboSplit, ExitType, ExtendedAdapter, type ExtendedAdapterConfig, type ExtendedApiResponse, ExtendedConfig, ExtendedWrapper, type ExtendedWrapperConfig, type FAQ, FatalError, type FlashloanCallParams, FlowChartColors, type FundingRate, type GenerateCallFn, Global, HyperLSTStrategies, type HyperLSTStrategySettings, type IConfig, type IInvestmentFlow, ILending, type ILendingMetadata, type ILendingPosition, type IProtocol, type IStrategyMetadata, type IncreaseLeverParams, Initializable, type L2Config, LSTAPRService, type LSTStats, type LeafAdapterFn, type LeafData, type LendingToken, type ManageCall, MarginType, type Market, type MarketStats, Midas, Network, type OpenOrder, OrderSide, OrderStatus, OrderStatusReason, OrderType, PRICE_ROUTER, PasswordJsonCryptoUtil, type PlacedOrder, type Position, type PositionAPY, type PositionAmount, type PositionHistory, type PositionInfo, PositionSide, PositionTypeAvnuExtended, Pragma, type PriceInfo, Pricer, PricerBase, PricerFromApi, PricerLST, PricerRedis, Protocols, type RequiredFields, type RequiredKeys, type RequiredStoreConfig, type RiskFactor, type RiskFactorConfig, RiskType, type Route, type RouteNode, SIMPLE_SANITIZER, SIMPLE_SANITIZER_V2, SIMPLE_SANITIZER_VESU_V1_DELEGATIONS, SenseiStrategies, SenseiVault, type SenseiVaultSettings, type SettlementSignature, type SignedWithdrawRequest, type SingleActionAmount, type SingleTokenInfo, StandardMerkleTree, type StandardMerkleTreeData, type StarkDebuggingOrderAmounts, type StarkSettlement, Store, type StoreConfig, type SupportedPosition, type Swap, type SwapInfo, TelegramGroupNotif, TelegramNotif, TimeInForce, type TokenAmount, type TokenInfo, TokenMarketData, type TradingConfig, UNIVERSAL_MANAGE_IDS, UniversalLstMultiplierStrategy, type UniversalManageCall, type UniversalStrategySettings, UnusedBalanceAdapter, type UnusedBalanceAdapterConfig, type UpdateLeverageRequest, VESU_SINGLETON, VESU_V2_MODIFY_POSITION_SANITIZER, type VaultPosition, VesuAdapter, type VesuAdapterConfig, type VesuAmount, VesuAmountDenomination, VesuAmountType, VesuConfig, type VesuDefiSpringRewardsCallParams, VesuExtendedMultiplierStrategy, type VesuExtendedStrategySettings, VesuExtendedTestStrategies, type VesuModifyDelegationCallParams, type VesuModifyPositionCallParams, VesuMultiplyAdapter, type VesuMultiplyAdapterConfig, type VesuMultiplyCallParams, VesuPools, VesuRebalance, type VesuRebalanceSettings, VesuRebalanceStrategies, VesuSupplyOnlyAdapter, type VesuSupplyOnlyAdapterConfig, Web3Number, type WithdrawParams, type WithdrawRequest, ZkLend, _riskFactor, assert, calculateAmountDepositOnExtendedWhenIncurringLosses, calculateAmountDistribution, calculateAmountDistributionForWithdrawal, calculateBTCPriceDelta, calculateDebtAmount, calculateDebtReductionAmountForWithdrawal, calculateExposureDelta, calculateExtendedLevergae, calculateVesUPositionSizeGivenExtended, calculateVesuLeverage, extensionMap, getAPIUsingHeadlessBrowser, getContractDetails, getDefaultStoreConfig, getFAQs, getInvestmentSteps, getMainnetConfig, getNoRiskTags, getRiskColor, getRiskExplaination, getTrovesEndpoint, getVesuSingletonAddress, highlightTextWithLinks, type i257, logger, returnFormattedAmount, toBigInt };
+export { type APYInfo, APYType, AUDIT_URL, AUMTypes, AVNU_EXCHANGE, AVNU_EXCHANGE_FOR_LEGACY_USDC, AVNU_LEGACY_SANITIZER, AVNU_MIDDLEWARE, AVNU_QUOTE_URL, AbisConfig, type AccountInfo, type AdapterLeafType, AddressesConfig, type AllAccountsStore, type ApiResponse, type ApproveCallParams, type AssetOperation, AssetOperationStatus, AssetOperationType, AutoCompounderSTRK, AvnuAdapter, type AvnuAdapterConfig, type AvnuSwapCallParams, AvnuWrapper, type Balance, BaseAdapter, type BaseAdapterConfig, BaseStrategy, type CLVaultStrategySettings, type CancelOrderRequest, CommonAdapter, type CommonAdapterConfig, ContractAddr, type CreateOrderRequest, type DecreaseLeverParams, Deployer, type DepositParams, type DualActionAmount, type DualTokenInfo, ERC20, EXTENDED_CONTRACT, EXTENDED_SANITIZER, type EkuboBounds, EkuboCLVault, EkuboCLVaultStrategies, type EkuboPoolKey, type EkuboQuote, EkuboQuoter, type EkuboRouteNode, type EkuboSplit, ExitType, ExtendedAdapter, type ExtendedAdapterConfig, type ExtendedApiResponse, ExtendedConfig, ExtendedWrapper, type ExtendedWrapperConfig, type FAQ, FatalError, type FlashloanCallParams, FlowChartColors, type FundingRate, type GenerateCallFn, Global, HyperLSTStrategies, type HyperLSTStrategySettings, type IConfig, type IInvestmentFlow, ILending, type ILendingMetadata, type ILendingPosition, type IProtocol, type IStrategyMetadata, type IncreaseLeverParams, Initializable, type L2Config, LSTAPRService, type LSTStats, type LeafAdapterFn, type LeafData, type LendingToken, type ManageCall, MarginType, type Market, type MarketStats, Midas, Network, type OpenOrder, OrderSide, OrderStatus, OrderStatusReason, OrderType, PRICE_ROUTER, PasswordJsonCryptoUtil, type PlacedOrder, type Position, type PositionAPY, type PositionAmount, type PositionHistory, type PositionInfo, PositionSide, PositionTypeAvnuExtended, Pragma, type PriceInfo, Pricer, PricerBase, PricerFromApi, PricerLST, PricerRedis, Protocols, type RequiredFields, type RequiredKeys, type RequiredStoreConfig, type RiskFactor, type RiskFactorConfig, RiskType, type Route, type RouteNode, SIMPLE_SANITIZER, SIMPLE_SANITIZER_V2, SIMPLE_SANITIZER_VESU_V1_DELEGATIONS, SenseiStrategies, SenseiVault, type SenseiVaultSettings, type SettlementSignature, type SignedWithdrawRequest, type SingleActionAmount, type SingleTokenInfo, StandardMerkleTree, type StandardMerkleTreeData, type StarkDebuggingOrderAmounts, type StarkSettlement, Store, type StoreConfig, type SupportedPosition, type Swap, type SwapInfo, TelegramGroupNotif, TelegramNotif, TimeInForce, type TokenAmount, type TokenInfo, TokenMarketData, type TradingConfig, type TransactionMetadata, type TransactionResult, UNIVERSAL_MANAGE_IDS, UniversalLstMultiplierStrategy, type UniversalManageCall, type UniversalStrategySettings, UnusedBalanceAdapter, type UnusedBalanceAdapterConfig, type UpdateLeverageRequest, VESU_SINGLETON, VESU_V2_MODIFY_POSITION_SANITIZER, type VaultPosition, VesuAdapter, type VesuAdapterConfig, type VesuAmount, VesuAmountDenomination, VesuAmountType, VesuConfig, type VesuDefiSpringRewardsCallParams, VesuExtendedMultiplierStrategy, type VesuExtendedStrategySettings, VesuExtendedTestStrategies, type VesuModifyDelegationCallParams, type VesuModifyPositionCallParams, VesuMultiplyAdapter, type VesuMultiplyAdapterConfig, type VesuMultiplyCallParams, VesuPools, VesuRebalance, type VesuRebalanceSettings, VesuRebalanceStrategies, VesuSupplyOnlyAdapter, type VesuSupplyOnlyAdapterConfig, Web3Number, type WithdrawParams, type WithdrawRequest, ZkLend, _riskFactor, assert, calculateAmountDepositOnExtendedWhenIncurringLosses, calculateAmountDistribution, calculateAmountDistributionForWithdrawal, calculateBTCPriceDelta, calculateDebtAmount, calculateDebtReductionAmountForWithdrawal, calculateExposureDelta, calculateExtendedLevergae, calculateVesUPositionSizeGivenExtended, calculateVesuLeverage, calculateWBTCAmountToMaintainLTV, extensionMap, getAPIUsingHeadlessBrowser, getContractDetails, getDefaultStoreConfig, getFAQs, getInvestmentSteps, getMainnetConfig, getNoRiskTags, getRiskColor, getRiskExplaination, getTrovesEndpoint, getVesuSingletonAddress, highlightTextWithLinks, type i257, logger, returnFormattedAmount, toBigInt };