@strkfarm/sdk 1.1.8 → 1.1.10

package/dist/index.d.ts

@@ -26,6 +26,11 @@ declare class _Web3Number<T extends _Web3Number<T>> extends BigNumber {
     private getStandardString;
     minimum(value: string | number | T): T;
     maximum(value: string | number | T): T;
+    abs(): T;
+    toI129(): {
+        mag: bigint;
+        sign: 0 | 1;
+    };
 }
 
 declare class Web3Number extends _Web3Number<Web3Number> {
@@ -138,6 +143,7 @@ interface IStrategyMetadata<T> {
         name: string;
         logo: string;
     };
+    isPreview?: boolean;
 }
 interface IInvestmentFlow {
     id?: string;
@@ -338,28 +344,6 @@ declare class AvnuWrapper {
     static buildZeroSwap(tokenToSell: ContractAddr, address: string): SwapInfo;
 }
 
-declare class FatalError extends Error {
-    constructor(message: string, err?: Error);
-}
-/** Contains globally useful functions.
- * - fatalError: Things to do when a fatal error occurs
- */
-declare class Global {
-    static cache: Record<string, {
-        value: any;
-        ttl: number;
-        timestamp: number;
-    }>;
-    static fatalError(message: string, err?: Error): void;
-    static httpError(url: string, err: Error, message?: string): void;
-    static getDefaultTokens(): TokenInfo[];
-    static getTokens(): Promise<TokenInfo[]>;
-    static assert(condition: any, message: string): void;
-    static getTokenInfoFromAddr(addr: ContractAddr): Promise<TokenInfo>;
-    static setGlobalCache(key: string, data: any, ttl?: number): void;
-    static getGlobalCache<T>(key: string): T | null;
-}
-
 declare class AutoCompounderSTRK {
     readonly config: IConfig;
     readonly addr: ContractAddr;
@@ -919,7 +903,7 @@ declare class BaseAdapter extends CacheClass {
         target: ContractAddr;
         method: string;
         packedArguments: bigint[];
-    }): LeafData;
+    }, sanitizer?: ContractAddr): LeafData;
 }
 
 interface FlashloanCallParams {
@@ -1002,11 +986,60 @@ interface VesuAdapterConfig {
     vaultAllocator: ContractAddr;
     id: string;
 }
+interface TokenAmount {
+    token: ContractAddr;
+    amount: Web3Number;
+}
+interface Swap {
+    route: RouteNode[];
+    token_amount: TokenAmount;
+}
+interface RouteNode {
+    pool_key: EkuboPoolKey;
+    sqrt_ratio_limit: Web3Number;
+    skip_ahead: Web3Number;
+}
+interface IncreaseLeverParams {
+    pool_id: ContractAddr;
+    collateral_asset: ContractAddr;
+    debt_asset: ContractAddr;
+    user: ContractAddr;
+    add_margin: Web3Number;
+    margin_swap: Swap[];
+    margin_swap_limit_amount: Web3Number;
+    lever_swap: Swap[];
+    lever_swap_limit_amount: Web3Number;
+}
+interface DecreaseLeverParams {
+    pool_id: ContractAddr;
+    collateral_asset: ContractAddr;
+    debt_asset: ContractAddr;
+    user: ContractAddr;
+    sub_margin: Web3Number;
+    recipient: ContractAddr;
+    lever_swap: Swap[];
+    lever_swap_limit_amount: Web3Number;
+    lever_swap_weights: Web3Number[];
+    withdraw_swap: Swap[];
+    withdraw_swap_limit_amount: Web3Number;
+    withdraw_swap_weights: Web3Number[];
+    close_position: boolean;
+}
+interface VesuMultiplyCallParams {
+    increaseParams?: Omit<IncreaseLeverParams, 'user' | 'pool_id' | 'collateral_asset' | 'debt_asset'>;
+    decreaseParams?: Omit<DecreaseLeverParams, 'user' | 'pool_id' | 'collateral_asset' | 'debt_asset' | 'recipient'>;
+    isIncrease: boolean;
+}
+interface VesuModifyDelegationCallParams {
+    delegation: boolean;
+}
 declare const VesuPools: {
     Genesis: ContractAddr;
+    Re7xSTRK: ContractAddr;
 };
 declare class VesuAdapter extends BaseAdapter {
     VESU_SINGLETON: ContractAddr;
+    VESU_MULTIPLY: ContractAddr;
     config: VesuAdapterConfig;
     networkConfig: IConfig | undefined;
     pricer: PricerBase | undefined;
@@ -1036,6 +1069,10 @@ declare class VesuAdapter extends BaseAdapter {
         };
     };
     getModifyPositionCall: (params: VesuModifyPositionCallParams) => ManageCall;
+    getMultiplyAdapter: () => AdapterLeafType<VesuMultiplyCallParams>;
+    getMultiplyCall: (params: VesuMultiplyCallParams) => ManageCall;
+    getVesuModifyDelegationAdapter: (id: string) => LeafAdapterFn<VesuModifyDelegationCallParams>;
+    getVesuModifyDelegationCall: (params: VesuModifyDelegationCallParams) => ManageCall;
     getDefispringRewardsAdapter: (id: string) => () => AdapterLeafType<VesuDefiSpringRewardsCallParams>;
     getDefiSpringClaimCall: () => GenerateCallFn<VesuDefiSpringRewardsCallParams>;
     formatAmountTypeEnum(amountType: VesuAmountType): CairoCustomEnum;
@@ -1057,6 +1094,11 @@ declare class VesuAdapter extends BaseAdapter {
     static getVesuPools(retry?: number): Promise<VesuPoolsInfo>;
 }
 
+interface UniversalManageCall {
+    proofs: string[];
+    manageCall: ManageCall;
+    step: UNIVERSAL_MANAGE_IDS;
+}
 interface UniversalStrategySettings {
     vaultAddress: ContractAddr;
     manager: ContractAddr;
@@ -1129,6 +1171,8 @@ declare class UniversalStrategy<S extends UniversalStrategySettings> extends Bas
         usdValue: number;
     }>;
     getUnusedBalance(): Promise<SingleTokenInfo>;
+    protected getVesuAUM(adapter: VesuAdapter): Promise<Web3Number>;
+    getPrevAUM(): Promise<Web3Number>;
     getAUM(): Promise<{
         net: SingleTokenInfo;
         prevAum: Web3Number;
@@ -1137,7 +1181,9 @@ declare class UniversalStrategy<S extends UniversalStrategySettings> extends Bas
             aum: Web3Number;
         }[];
     }>;
+    protected getRewardsAUM(prevAum: Web3Number): Promise<Web3Number>;
     getVesuAdapters(): VesuAdapter[];
+    getVesuPositions(): Promise<VaultPosition[]>;
     getVaultPositions(): Promise<VaultPosition[]>;
     getSetManagerCall(strategist: ContractAddr, root?: string): Call;
     getManageCall(proofIds: string[], manageCalls: ManageCall[]): Call;
@@ -1146,11 +1192,7 @@ declare class UniversalStrategy<S extends UniversalStrategySettings> extends Bas
         isDeposit: boolean;
         depositAmount: Web3Number;
         debtAmount: Web3Number;
-    }): {
-        proofs: string[];
-        manageCall: ManageCall;
-        step: UNIVERSAL_MANAGE_IDS;
-    }[];
+    }): UniversalManageCall[];
     getTag(): string;
     getVesuHealthFactors(): Promise<number[]>;
     computeRebalanceConditionAndReturnCalls(): Promise<Call[]>;
@@ -1163,7 +1205,7 @@ declare class UniversalStrategy<S extends UniversalStrategySettings> extends Bas
      * @returns
      */
     private getLegRebalanceAmount;
-    getVesuMultiplyCall(params: {
+    getVesuModifyPositionCall(params: {
         isDeposit: boolean;
         leg1DepositAmount: Web3Number;
     }): Promise<Call>;
@@ -1197,8 +1239,105 @@ declare enum UNIVERSAL_ADAPTERS {
     VESU_LEG1 = "vesu_leg1_adapter",
     VESU_LEG2 = "vesu_leg2_adapter"
 }
+declare function getContractDetails(settings: UniversalStrategySettings): {
+    address: ContractAddr;
+    name: string;
+}[];
 declare const UniversalStrategies: IStrategyMetadata<UniversalStrategySettings>[];
 
+declare class UniversalLstMultiplierStrategy extends UniversalStrategy<UniversalStrategySettings> {
+    private quoteAmountToFetchPrice;
+    constructor(config: IConfig, pricer: PricerBase, metadata: IStrategyMetadata<UniversalStrategySettings>);
+    getVesuAdapters(): VesuAdapter[];
+    protected getRewardsAUM(prevAum: Web3Number): Promise<Web3Number>;
+    getLSTDexPrice(): Promise<number>;
+    /**
+     * Uses vesu's multiple call to create leverage on LST
+     * Deposit amount is in LST
+     * @param params
+     */
+    getVesuMultiplyCall(params: {
+        isDeposit: boolean;
+        leg1DepositAmount: Web3Number;
+    }): Promise<Call[]>;
+    getLSTUnderlyingTokenInfo(): TokenInfo;
+    getLSTExchangeRate(): Promise<number>;
+    /**
+     *
+     * @param params marginAmount is in LST, debtAmount is in underlying
+     */
+    getModifyLeverCall(params: {
+        marginAmount: Web3Number;
+        debtAmount: Web3Number;
+        isIncrease: boolean;
+    }): Promise<Call[]>;
+}
+declare const HyperLSTStrategies: IStrategyMetadata<UniversalStrategySettings>[];
+
+interface EkuboRouteNode {
+    pool_key: {
+        token0: string;
+        token1: string;
+        fee: string;
+        tick_spacing: number;
+        extension: string;
+    };
+    sqrt_ratio_limit: string;
+    skip_ahead: number;
+}
+interface EkuboSplit {
+    amount_specified: string;
+    amount_calculated: string;
+    route: EkuboRouteNode[];
+}
+interface EkuboQuote {
+    total_calculated: string;
+    price_impact: number;
+    splits: EkuboSplit[];
+}
+declare class EkuboQuoter {
+    private readonly config;
+    ENDPOINT: string;
+    constructor(config: IConfig);
+    /**
+     *
+     * @param fromToken
+     * @param toToken
+     * @param amount Can be negative too, which would mean to get exact amount out
+     * @returns
+     */
+    getQuote(fromToken: string, toToken: string, amount: Web3Number): Promise<EkuboQuote>;
+    /**
+     * Formats Ekubo response for Vesu multiple use
+     * @param quote
+     * @param fromTokenInfo
+     * @returns
+     */
+    getVesuMultiplyQuote(quote: EkuboQuote, fromTokenInfo: TokenInfo, toTokenInfo: TokenInfo): Swap[];
+}
+
+declare class FatalError extends Error {
+    constructor(message: string, err?: Error);
+}
+/** Contains globally useful functions.
+ * - fatalError: Things to do when a fatal error occurs
+ */
+declare class Global {
+    static cache: Record<string, {
+        value: any;
+        ttl: number;
+        timestamp: number;
+    }>;
+    static fatalError(message: string, err?: Error): void;
+    static httpError(url: string, err: Error, message?: string): void;
+    static getDefaultTokens(): TokenInfo[];
+    static getTokens(): Promise<TokenInfo[]>;
+    static assert(condition: any, message: string): void;
+    static getTokenInfoFromAddr(addr: ContractAddr): Promise<TokenInfo>;
+    static setGlobalCache(key: string, data: any, ttl?: number): void;
+    static getGlobalCache<T>(key: string): T | null;
+}
+
 declare class TelegramNotif {
     private subscribers;
     readonly bot: TelegramBot;
@@ -1331,4 +1470,4 @@ declare class PasswordJsonCryptoUtil {
     decrypt(encryptedData: string, password: string): any;
 }
 
-export { AUMTypes, type AccountInfo, type AdapterLeafType, type AllAccountsStore, type ApproveCallParams, AutoCompounderSTRK, type AvnuSwapCallParams, AvnuWrapper, BaseAdapter, BaseStrategy, type CLVaultStrategySettings, CommonAdapter, type CommonAdapterConfig, ContractAddr, Deployer, type DualActionAmount, type DualTokenInfo, ERC20, type EkuboBounds, EkuboCLVault, EkuboCLVaultStrategies, type EkuboPoolKey, type FAQ, FatalError, type FlashloanCallParams, FlowChartColors, type GenerateCallFn, Global, type IConfig, type IInvestmentFlow, ILending, type ILendingMetadata, type ILendingPosition, type IProtocol, type IStrategyMetadata, Initializable, type LeafAdapterFn, type LeafData, type LendingToken, type ManageCall, MarginType, Network, PasswordJsonCryptoUtil, Pragma, type PriceInfo, Pricer, PricerFromApi, PricerRedis, Protocols, type RequiredFields, type RequiredKeys, type RequiredStoreConfig, type RiskFactor, RiskType, type Route, SenseiStrategies, SenseiVault, type SenseiVaultSettings, type SingleActionAmount, type SingleTokenInfo, StandardMerkleTree, type StandardMerkleTreeData, Store, type StoreConfig, type SwapInfo, TelegramNotif, type TokenInfo, UNIVERSAL_ADAPTERS, UNIVERSAL_MANAGE_IDS, UniversalStrategies, UniversalStrategy, type UniversalStrategySettings, type VaultPosition, VesuAdapter, type VesuAdapterConfig, type VesuAmount, VesuAmountDenomination, VesuAmountType, type VesuDefiSpringRewardsCallParams, type VesuModifyPositionCallParams, VesuPools, VesuRebalance, type VesuRebalanceSettings, VesuRebalanceStrategies, Web3Number, ZkLend, assert, getAPIUsingHeadlessBrowser, getDefaultStoreConfig, getMainnetConfig, getNoRiskTags, getRiskColor, getRiskExplaination, getTrovesEndpoint, highlightTextWithLinks, type i257, logger };
+export { AUMTypes, 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 IConfig, type IInvestmentFlow, ILending, type ILendingMetadata, type ILendingPosition, type IProtocol, type IStrategyMetadata, type IncreaseLeverParams, Initializable, type LeafAdapterFn, type LeafData, type LendingToken, type ManageCall, MarginType, Network, PasswordJsonCryptoUtil, Pragma, type PriceInfo, Pricer, PricerFromApi, PricerRedis, Protocols, type RequiredFields, type RequiredKeys, type RequiredStoreConfig, type RiskFactor, RiskType, type Route, type RouteNode, SenseiStrategies, SenseiVault, type SenseiVaultSettings, type SingleActionAmount, type SingleTokenInfo, StandardMerkleTree, type StandardMerkleTreeData, Store, type StoreConfig, type Swap, type SwapInfo, TelegramNotif, type TokenAmount, type TokenInfo, UNIVERSAL_ADAPTERS, UNIVERSAL_MANAGE_IDS, UniversalLstMultiplierStrategy, type UniversalManageCall, UniversalStrategies, UniversalStrategy, type UniversalStrategySettings, 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, getAPIUsingHeadlessBrowser, getContractDetails, getDefaultStoreConfig, getMainnetConfig, getNoRiskTags, getRiskColor, getRiskExplaination, getTrovesEndpoint, highlightTextWithLinks, type i257, logger };