@strkfarm/sdk 1.0.54 → 1.0.55

package/dist/index.d.ts

@@ -50,7 +50,8 @@ declare enum RiskType {
     SMART_CONTRACT_RISK = "Smart Contract Risk",
     ORACLE_RISK = "Oracle Risk",
     TECHNICAL_RISK = "Technical Risk",
-    COUNTERPARTY_RISK = "Counterparty Risk"
+    COUNTERPARTY_RISK = "Counterparty Risk",// e.g. bad debt
+    DEPEG_RISK = "Depeg Risk"
 }
 interface RiskFactor {
     type: RiskType;
@@ -136,8 +137,8 @@ interface IInvestmentFlow {
     linkedFlows: IInvestmentFlow[];
     style?: any;
 }
-declare function getMainnetConfig(rpcUrl?: string, blockIdentifier?: BlockIdentifier): IConfig;
-declare const getRiskExplaination: (riskType: RiskType) => "The risk of the market moving against the position." | "The temporary loss of value experienced by liquidity providers in AMMs when asset prices diverge compared to simply holding them." | "The risk of losing funds due to the position being liquidated." | "The risk of low liquidity in the pool, which can lead to high slippages or reduced in-abilities to quickly exit the position." | "The risk of the oracle being manipulated or incorrect." | "The risk of the smart contract being vulnerable to attacks." | "The risk of technical issues e.g. backend failure." | "The risk of the counterparty defaulting e.g. bad debt on lending platforms.";
+declare function getMainnetConfig(rpcUrl: string, blockIdentifier?: BlockIdentifier): IConfig;
+declare const getRiskExplaination: (riskType: RiskType) => "The risk of the market moving against the position." | "The temporary loss of value experienced by liquidity providers in AMMs when asset prices diverge compared to simply holding them." | "The risk of losing funds due to the position being liquidated." | "The risk of low liquidity in the pool, which can lead to high slippages or reduced in-abilities to quickly exit the position." | "The risk of the oracle being manipulated or incorrect." | "The risk of the smart contract being vulnerable to attacks." | "The risk of technical issues e.g. backend failure." | "The risk of the counterparty defaulting e.g. bad debt on lending platforms." | "The risk of a token losing its peg to the underlying asset, leading to potential losses for holders.";
 declare const getRiskColor: (risk: RiskFactor) => "light_green_2" | "yellow" | "red";
 declare const getNoRiskTags: (risks: RiskFactor[]) => RiskType[];
 interface HighlightLink {
@@ -372,13 +373,22 @@ interface DualTokenInfo {
     token0: SingleTokenInfo;
     token1: SingleTokenInfo;
 }
+interface CacheData {
+    timestamp: number;
+    ttl: number;
+    data: any;
+}
 declare class BaseStrategy<TVLInfo, ActionInfo> {
     readonly config: IConfig;
+    readonly cache: Map<string, CacheData>;
     constructor(config: IConfig);
     getUserTVL(user: ContractAddr): Promise<TVLInfo>;
     getTVL(): Promise<TVLInfo>;
     depositCall(amountInfo: ActionInfo, receiver: ContractAddr): Promise<Call[]>;
     withdrawCall(amountInfo: ActionInfo, receiver: ContractAddr, owner: ContractAddr): Promise<Call[]>;
+    setCache(key: string, data: any, ttl?: number): void;
+    getCache(key: string): any | null;
+    isCacheValid(key: string): boolean;
 }
 
 interface PoolProps {
@@ -776,6 +786,35 @@ declare class EkuboCLVault extends BaseStrategy<DualTokenInfo, DualActionAmount>
  */
 declare const EkuboCLVaultStrategies: IStrategyMetadata<CLVaultStrategySettings>[];
 
+interface SenseiVaultSettings {
+    mainToken: TokenInfo;
+    secondaryToken: TokenInfo;
+    targetHfBps: number;
+    feeBps: number;
+}
+declare class SenseiVault extends BaseStrategy<SingleTokenInfo, SingleActionAmount> {
+    readonly address: ContractAddr;
+    readonly metadata: IStrategyMetadata<SenseiVaultSettings>;
+    readonly pricer: PricerBase;
+    readonly contract: Contract;
+    constructor(config: IConfig, pricer: PricerBase, metadata: IStrategyMetadata<SenseiVaultSettings>);
+    getUserTVL(user: ContractAddr): Promise<SingleTokenInfo>;
+    getTVL(): Promise<SingleTokenInfo>;
+    depositCall(amountInfo: SingleActionAmount, receiver: ContractAddr): Promise<Call[]>;
+    withdrawCall(amountInfo: SingleActionAmount, receiver: ContractAddr, owner: ContractAddr): Promise<Call[]>;
+    getPositionInfo(): Promise<{
+        collateralXSTRK: Web3Number;
+        collateralUSDValue: Web3Number;
+        debtSTRK: Web3Number;
+        debtUSDValue: Web3Number;
+        xSTRKPrice: number;
+        collateralInSTRK: number;
+    }>;
+    getSecondaryTokenPriceRelativeToMain(retry?: number): Promise<number>;
+    getSettings: () => Promise<starknet.Result>;
+}
+declare const SenseiStrategies: IStrategyMetadata<SenseiVaultSettings>[];
+
 declare class TelegramNotif {
     private subscribers;
     readonly bot: TelegramBot;
@@ -804,6 +843,7 @@ type RequiredKeys<T> = {
     [K in keyof T]-?: {} extends Pick<T, K> ? never : K;
 }[keyof T];
 declare function assert(condition: boolean, message: string): void;
+declare function getTrovesEndpoint(): string;
 
 declare class PricerRedis extends Pricer {
     private redisClient;
@@ -898,4 +938,4 @@ declare class PasswordJsonCryptoUtil {
     decrypt(encryptedData: string, password: string): any;
 }
 
-export { type AccountInfo, type AllAccountsStore, AutoCompounderSTRK, AvnuWrapper, BaseStrategy, type CLVaultStrategySettings, ContractAddr, type DualActionAmount, type DualTokenInfo, ERC20, type EkuboBounds, EkuboCLVault, EkuboCLVaultStrategies, type EkuboPoolKey, type FAQ, FatalError, FlowChartColors, Global, type IConfig, type IInvestmentFlow, ILending, type ILendingMetadata, type ILendingPosition, type IProtocol, type IStrategyMetadata, Initializable, type LendingToken, MarginType, Network, PasswordJsonCryptoUtil, Pragma, type PriceInfo, Pricer, PricerFromApi, PricerRedis, type RequiredFields, type RequiredKeys, type RequiredStoreConfig, type RiskFactor, RiskType, type Route, type SingleActionAmount, type SingleTokenInfo, Store, type StoreConfig, type SwapInfo, TelegramNotif, type TokenInfo, VesuRebalance, type VesuRebalanceSettings, VesuRebalanceStrategies, Web3Number, ZkLend, assert, getAPIUsingHeadlessBrowser, getDefaultStoreConfig, getMainnetConfig, getNoRiskTags, getRiskColor, getRiskExplaination, highlightTextWithLinks, logger };
+export { type AccountInfo, type AllAccountsStore, AutoCompounderSTRK, AvnuWrapper, BaseStrategy, type CLVaultStrategySettings, ContractAddr, type DualActionAmount, type DualTokenInfo, ERC20, type EkuboBounds, EkuboCLVault, EkuboCLVaultStrategies, type EkuboPoolKey, type FAQ, FatalError, FlowChartColors, Global, type IConfig, type IInvestmentFlow, ILending, type ILendingMetadata, type ILendingPosition, type IProtocol, type IStrategyMetadata, Initializable, type LendingToken, MarginType, Network, PasswordJsonCryptoUtil, Pragma, type PriceInfo, Pricer, PricerFromApi, PricerRedis, type RequiredFields, type RequiredKeys, type RequiredStoreConfig, type RiskFactor, RiskType, type Route, SenseiStrategies, SenseiVault, type SenseiVaultSettings, type SingleActionAmount, type SingleTokenInfo, Store, type StoreConfig, type SwapInfo, TelegramNotif, type TokenInfo, VesuRebalance, type VesuRebalanceSettings, VesuRebalanceStrategies, Web3Number, ZkLend, assert, getAPIUsingHeadlessBrowser, getDefaultStoreConfig, getMainnetConfig, getNoRiskTags, getRiskColor, getRiskExplaination, getTrovesEndpoint, highlightTextWithLinks, logger };