@strkfarm/sdk 1.1.38 → 1.1.40

package/dist/index.d.ts

@@ -343,7 +343,7 @@ interface SwapInfo {
 declare class AvnuWrapper {
     getQuotes(fromToken: string, toToken: string, amountWei: string, taker: string, retry?: number, excludeSources?: string[]): Promise<Quote>;
     getSwapInfo(quote: Pick<Quote, 'quoteId' | 'buyTokenAddress' | 'buyAmount' | 'sellTokenAddress' | 'sellAmount'>, taker: string, integratorFeeBps: number, integratorFeeRecipient: string, minAmount?: string, options?: AvnuOptions): Promise<SwapInfo>;
-    static buildZeroSwap(tokenToSell: ContractAddr, address: string): SwapInfo;
+    static buildZeroSwap(tokenToSell: ContractAddr, beneficiary: string, tokenToBuy?: ContractAddr): SwapInfo;
 }
 
 declare class AutoCompounderSTRK {
@@ -631,6 +631,20 @@ declare class VesuRebalance extends BaseStrategy<SingleTokenInfo, SingleActionAm
  */
 declare const VesuRebalanceStrategies: IStrategyMetadata<VesuRebalanceSettings>[];
 
+interface HarvestInfo {
+    rewardsContract: ContractAddr;
+    token: ContractAddr;
+    startDate: Date;
+    endDate: Date;
+    claim: {
+        id: number;
+        amount: Web3Number;
+        claimee: ContractAddr;
+    };
+    actualReward: Web3Number;
+    proof: string[];
+}
+
 interface EkuboPoolKey {
     token0: ContractAddr;
     token1: ContractAddr;
@@ -820,6 +834,47 @@ declare class EkuboCLVault extends BaseStrategy<DualTokenInfo, DualActionAmount>
         amount1: Web3Number;
     }>;
     harvest(acc: Account, maxIterations?: number, priceRatioPrecision?: number): Promise<Call[]>;
+    /**
+     * @description This funciton requires atleast one of the pool tokens to be reward token
+     * i.e. STRK.
+     * @param params
+     */
+    _handleRewardAndVaultTokenMatchHarvest(params: {
+        claim: HarvestInfo;
+        isToken1: boolean;
+        token0Info: TokenInfo;
+        token1Info: TokenInfo;
+        postFeeAmount: Web3Number;
+        poolKey: EkuboPoolKey;
+        bounds: EkuboBounds;
+        maxIterations: number;
+        priceRatioPrecision: number;
+        acc: Account;
+    }): Promise<Call[]>;
+    /**
+     * @description This function handles harvesting of reward token that is not the same as any of the vault token
+     * i.e. STRK is not part of vault tokens like BTC/ETH
+     * @param params
+     * @returns
+     */
+    _handleRewardAndVaultTokenMismatchHarvest(params: {
+        claim: HarvestInfo;
+        token0Info: TokenInfo;
+        token1Info: TokenInfo;
+        postFeeAmount: Web3Number;
+        poolKey: EkuboPoolKey;
+        bounds: EkuboBounds;
+        maxIterations: number;
+        priceRatioPrecision: number;
+        acc: Account;
+    }): Promise<never[]>;
+    harvestMismatchEstimateCallFn(params: {
+        postFeeAmount: Web3Number;
+        claim: HarvestInfo;
+        token0Info: TokenInfo;
+        token1Info: TokenInfo;
+        acc: Account;
+    }): Promise<null>;
     getInvestmentFlows(): Promise<IInvestmentFlow[]>;
 }
 /**
@@ -912,7 +967,35 @@ type AdapterLeafType<T> = {
     callConstructor: GenerateCallFn<T>;
 };
 type LeafAdapterFn<T> = () => AdapterLeafType<T>;
-declare class BaseAdapter extends CacheClass {
+declare enum APYType {
+    BASE = "base",
+    REWARD = "reward",
+    LST = "lst"
+}
+interface SupportedPosition {
+    asset: TokenInfo;
+    isDebt: boolean;
+}
+interface BaseAdapterConfig {
+    baseToken: TokenInfo;
+    supportedPositions: SupportedPosition[];
+    networkConfig: IConfig;
+    pricer: PricerBase;
+    vaultAllocator: ContractAddr;
+    vaultAddress: ContractAddr;
+}
+type PositionAPY = {
+    apy: number;
+    type: APYType;
+};
+type PositionInfo = {
+    amount: Web3Number;
+    usdValue: number;
+    remarks?: string;
+    apy: PositionAPY;
+};
+declare abstract class BaseAdapter extends CacheClass {
+    constructor();
     protected constructSimpleLeafData(params: {
         id: string;
         target: ContractAddr;
@@ -1115,10 +1198,11 @@ declare class VesuAdapter extends BaseAdapter {
         isV2: boolean;
     };
     getDebtCap(config: IConfig): Promise<Web3Number>;
+    getCurrentDebtUtilisationAmount(config: IConfig): Promise<Web3Number>;
     getMaxBorrowableByInterestRate(config: IConfig, asset: TokenInfo, maxBorrowAPY: number): Promise<Web3Number>;
-    getLTVConfig(config: IConfig): Promise<number>;
-    getPositions(config: IConfig): Promise<VaultPosition[]>;
-    getCollateralization(config: IConfig): Promise<Omit<VaultPosition, 'amount'>[]>;
+    getLTVConfig(config: IConfig, blockNumber?: BlockIdentifier): Promise<number>;
+    getPositions(config: IConfig, blockNumber?: BlockIdentifier): Promise<VaultPosition[]>;
+    getCollateralization(config: IConfig, blockNumber?: BlockIdentifier): Promise<Omit<VaultPosition, 'amount'>[]>;
     getAssetPrices(): Promise<{
         collateralTokenAmount: Web3Number;
         collateralUSDAmount: number;
@@ -1128,7 +1212,7 @@ declare class VesuAdapter extends BaseAdapter {
         debtPrice: number;
         ltv: number;
     }>;
-    getHealthFactor(): Promise<number>;
+    getHealthFactor(blockNumber?: BlockIdentifier): Promise<number>;
     static getVesuPools(retry?: number): Promise<VesuPoolsInfo>;
     fullUtilizationRate(interestRateConfig: InterestRateConfig, timeDelta: bigint, utilization: bigint, fullUtilizationRate: bigint): bigint;
     /**
@@ -1260,7 +1344,7 @@ declare class UniversalStrategy<S extends UniversalStrategySettings> extends Bas
     }>;
     protected getRewardsAUM(prevAum: Web3Number): Promise<Web3Number>;
     getVesuAdapters(): VesuAdapter[];
-    getVesuPositions(): Promise<VaultPosition[]>;
+    getVesuPositions(blockNumber?: BlockIdentifier): Promise<VaultPosition[]>;
     getVaultPositions(): Promise<VaultPosition[]>;
     getSetManagerCall(strategist: ContractAddr, root?: string): Call;
     getManageCall(proofIds: string[], manageCalls: ManageCall[]): Call;
@@ -1276,7 +1360,7 @@ declare class UniversalStrategy<S extends UniversalStrategySettings> extends Bas
      * @returns Promise<number> The LST APR (not divided by 1e18)
      */
     getLSTAPR(address: ContractAddr): Promise<number>;
-    getVesuHealthFactors(): Promise<number[]>;
+    getVesuHealthFactors(blockNumber?: BlockIdentifier): Promise<number[]>;
     computeRebalanceConditionAndReturnCalls(): Promise<Call[]>;
     private getNewHealthFactor;
     /**
@@ -1329,6 +1413,7 @@ declare const UniversalStrategies: IStrategyMetadata<UniversalStrategySettings>[
 
 interface HyperLSTStrategySettings extends UniversalStrategySettings {
     borrowable_assets: TokenInfo[];
+    underlyingToken: TokenInfo;
 }
 declare class UniversalLstMultiplierStrategy extends UniversalStrategy<HyperLSTStrategySettings> {
     private quoteAmountToFetchPrice;
@@ -1342,9 +1427,24 @@ declare class UniversalLstMultiplierStrategy extends UniversalStrategy<HyperLSTS
     getAvnuSwapMultiplyCall(params: {
         isDeposit: boolean;
         leg1DepositAmount: Web3Number;
-    }): Promise<Call>;
-    private _getAvnuDepositSwapLegCall;
+    }): Promise<{
+        call: Call | undefined;
+        vesuAdapter: VesuAdapter;
+    }>;
+    _getAvnuDepositSwapLegCall(params: {
+        isDeposit: boolean;
+        leg1DepositAmount: Web3Number;
+        minHF: number;
+        vesuAdapter: VesuAdapter;
+    }): Promise<Call | undefined>;
     getLSTMultiplierRebalanceCall(): Promise<{
+        shouldRebalance: boolean;
+        manageCalls: {
+            vesuAdapter: VesuAdapter;
+            manageCall: Call;
+        }[];
+    }>;
+    _getLSTMultiplierRebalanceCall(vesuAdapter: VesuAdapter): Promise<{
         shouldRebalance: boolean;
         manageCall: Call | undefined;
     }>;
@@ -1361,13 +1461,24 @@ declare class UniversalLstMultiplierStrategy extends UniversalStrategy<HyperLSTS
         leg1DepositAmount: Web3Number;
     }): Promise<Call[]>;
     getLSTUnderlyingTokenInfo(): TokenInfo;
-    getMaxBorrowableAmount(): Promise<{
+    getMaxBorrowableAmount(params?: {
+        isAPYComputation: boolean;
+    }): Promise<{
         netMaxBorrowableAmount: Web3Number;
         maxBorrowables: {
             amount: Web3Number;
+            dexSwappableAmount: Web3Number;
+            maxBorrowableAmount: Web3Number;
             borrowableAsset: TokenInfo;
         }[];
     }>;
+    getMaxSwappableWithMaxSlippage(fromToken: TokenInfo, toToken: TokenInfo, maxSlippage: number, maxAmount: Web3Number): Promise<Web3Number>;
+    getMaxBorrowableAmountByVesuAdapter(vesuAdapter: VesuAdapter, isAPYComputation: boolean): Promise<{
+        amount: Web3Number;
+        dexSwappableAmount: Web3Number;
+        maxBorrowableAmount: Web3Number;
+        borrowableAsset: TokenInfo;
+    }>;
     /**
      * Gets LST APR for the strategy's underlying asset from Endur API
      * @returns Promise<number> The LST APR (not divided by 1e18)
@@ -1380,7 +1491,9 @@ declare class UniversalLstMultiplierStrategy extends UniversalStrategy<HyperLSTS
             id: string;
         }[];
     }>;
-    maxNewDeposits(): Promise<number>;
+    maxNewDeposits(params?: {
+        isAPYComputation: boolean;
+    }): Promise<number>;
     protected getUnusedBalanceAPY(): Promise<{
         apy: number;
         weight: number;
@@ -1670,4 +1783,4 @@ declare class PasswordJsonCryptoUtil {
     decrypt(encryptedData: string, password: string): any;
 }
 
-export { AUMTypes, AVNU_EXCHANGE, AVNU_MIDDLEWARE, type AccountInfo, type AdapterLeafType, type AllAccountsStore, type ApproveCallParams, AutoCompounderSTRK, type AvnuSwapCallParams, AvnuWrapper, BaseAdapter, BaseStrategy, type CLVaultStrategySettings, CommonAdapter, type CommonAdapterConfig, ContractAddr, type DecreaseLeverParams, Deployer, type DualActionAmount, type DualTokenInfo, ERC20, type EkuboBounds, EkuboCLVault, EkuboCLVaultStrategies, type EkuboPoolKey, type EkuboQuote, EkuboQuoter, type EkuboRouteNode, type EkuboSplit, type FAQ, FatalError, type FlashloanCallParams, FlowChartColors, type GenerateCallFn, Global, HyperLSTStrategies, type HyperLSTStrategySettings, type IConfig, type IInvestmentFlow, ILending, type ILendingMetadata, type ILendingPosition, type IProtocol, type IStrategyMetadata, type IncreaseLeverParams, Initializable, LSTAPRService, type LSTStats, type LeafAdapterFn, type LeafData, type LendingToken, type ManageCall, MarginType, Network, PRICE_ROUTER, PasswordJsonCryptoUtil, Pragma, type PriceInfo, Pricer, PricerFromApi, PricerLST, PricerRedis, Protocols, type RequiredFields, type RequiredKeys, type RequiredStoreConfig, type RiskFactor, RiskType, type Route, type RouteNode, SIMPLE_SANITIZER, SIMPLE_SANITIZER_V2, SIMPLE_SANITIZER_VESU_V1_DELEGATIONS, SenseiStrategies, SenseiVault, type SenseiVaultSettings, type SingleActionAmount, type SingleTokenInfo, StandardMerkleTree, type StandardMerkleTreeData, Store, type StoreConfig, type Swap, type SwapInfo, TelegramGroupNotif, TelegramNotif, type TokenAmount, type TokenInfo, UNIVERSAL_ADAPTERS, UNIVERSAL_MANAGE_IDS, UniversalLstMultiplierStrategy, type UniversalManageCall, UniversalStrategies, UniversalStrategy, type UniversalStrategySettings, VESU_SINGLETON, VESU_V2_MODIFY_POSITION_SANITIZER, type VaultPosition, VesuAdapter, type VesuAdapterConfig, type VesuAmount, VesuAmountDenomination, VesuAmountType, type VesuDefiSpringRewardsCallParams, type VesuModifyDelegationCallParams, type VesuModifyPositionCallParams, type VesuMultiplyCallParams, VesuPools, VesuRebalance, type VesuRebalanceSettings, VesuRebalanceStrategies, Web3Number, ZkLend, assert, extensionMap, getAPIUsingHeadlessBrowser, getContractDetails, getDefaultStoreConfig, getMainnetConfig, getNoRiskTags, getRiskColor, getRiskExplaination, getTrovesEndpoint, getVesuSingletonAddress, highlightTextWithLinks, type i257, logger, toBigInt };
+export { APYType, AUMTypes, AVNU_EXCHANGE, AVNU_MIDDLEWARE, type AccountInfo, type AdapterLeafType, type AllAccountsStore, type ApproveCallParams, AutoCompounderSTRK, type AvnuSwapCallParams, AvnuWrapper, BaseAdapter, type BaseAdapterConfig, BaseStrategy, type CLVaultStrategySettings, CommonAdapter, type CommonAdapterConfig, ContractAddr, type DecreaseLeverParams, Deployer, type DualActionAmount, type DualTokenInfo, ERC20, type EkuboBounds, EkuboCLVault, EkuboCLVaultStrategies, type EkuboPoolKey, type EkuboQuote, EkuboQuoter, type EkuboRouteNode, type EkuboSplit, type FAQ, FatalError, type FlashloanCallParams, FlowChartColors, type GenerateCallFn, Global, HyperLSTStrategies, type HyperLSTStrategySettings, type IConfig, type IInvestmentFlow, ILending, type ILendingMetadata, type ILendingPosition, type IProtocol, type IStrategyMetadata, type IncreaseLeverParams, Initializable, LSTAPRService, type LSTStats, type LeafAdapterFn, type LeafData, type LendingToken, type ManageCall, MarginType, Network, PRICE_ROUTER, PasswordJsonCryptoUtil, type PositionAPY, type PositionInfo, Pragma, type PriceInfo, Pricer, PricerFromApi, PricerLST, PricerRedis, Protocols, type RequiredFields, type RequiredKeys, type RequiredStoreConfig, type RiskFactor, RiskType, type Route, type RouteNode, SIMPLE_SANITIZER, SIMPLE_SANITIZER_V2, SIMPLE_SANITIZER_VESU_V1_DELEGATIONS, SenseiStrategies, SenseiVault, type SenseiVaultSettings, type SingleActionAmount, type SingleTokenInfo, StandardMerkleTree, type StandardMerkleTreeData, Store, type StoreConfig, type SupportedPosition, type Swap, type SwapInfo, TelegramGroupNotif, TelegramNotif, type TokenAmount, type TokenInfo, UNIVERSAL_ADAPTERS, UNIVERSAL_MANAGE_IDS, UniversalLstMultiplierStrategy, type UniversalManageCall, UniversalStrategies, UniversalStrategy, type UniversalStrategySettings, VESU_SINGLETON, VESU_V2_MODIFY_POSITION_SANITIZER, type VaultPosition, VesuAdapter, type VesuAdapterConfig, type VesuAmount, VesuAmountDenomination, VesuAmountType, type VesuDefiSpringRewardsCallParams, type VesuModifyDelegationCallParams, type VesuModifyPositionCallParams, type VesuMultiplyCallParams, VesuPools, VesuRebalance, type VesuRebalanceSettings, VesuRebalanceStrategies, Web3Number, ZkLend, assert, extensionMap, getAPIUsingHeadlessBrowser, getContractDetails, getDefaultStoreConfig, getMainnetConfig, getNoRiskTags, getRiskColor, getRiskExplaination, getTrovesEndpoint, getVesuSingletonAddress, highlightTextWithLinks, type i257, logger, toBigInt };