@zyfai/sdk 0.2.22 → 0.2.24

package/dist/index.d.ts

@@ -28,17 +28,16 @@ interface UpdateUserProfileRequest {
     protocols?: string[];
     autoSelectProtocols?: boolean;
     omniAccount?: boolean;
+    chains?: number[];
     autocompounding?: boolean;
     agentName?: string;
     crosschainStrategy?: boolean;
     splitting?: boolean;
     minSplits?: number;
-    customization?: Record<string, any>;
+    asset?: "usdc" | "eth";
 }
-/** @internal */
 interface UpdateUserProfileResponse {
     success: boolean;
-    userId: string;
     smartWallet?: Address;
     chains?: number[];
     strategy?: string;
@@ -49,9 +48,11 @@ interface UpdateUserProfileResponse {
     agentName?: string;
     crosschainStrategy?: boolean;
     executorProxy?: boolean;
+    hasActiveSessionKey?: boolean;
     splitting?: boolean;
     minSplits?: number;
     customization?: Record<string, any>;
+    asset?: "usdc" | "eth";
 }
 /** @internal */
 interface AddSessionKeyResponse {
@@ -129,6 +130,19 @@ interface Portfolio {
     splitting?: boolean;
     minSplits?: number;
     executorProxy?: boolean;
+    assetTypeSettings?: AssetTypeSettings;
+}
+interface AssetTypeSettings {
+    [assetType: string]: {
+        rebalanceStrategy?: string;
+        autocompounding?: boolean;
+        crosschainStrategy?: boolean;
+        splitting?: boolean;
+        minSplits?: number;
+        chains?: number[];
+        autoSelectProtocols?: boolean;
+        protocols?: string[];
+    };
 }
 interface PositionSlot {
     chain?: string;
@@ -149,44 +163,9 @@ interface PortfolioResponse {
     userAddress: string;
     portfolio: Portfolio;
 }
-interface UserDetails {
-    id: string;
-    address: string;
-    smartWallet: string;
-    chains: number[];
-    protocols: Protocol[];
-    hasActiveSessionKey: boolean;
-    email?: string;
-    strategy?: string;
-    telegramId?: string;
-    walletType?: string;
-    autoSelectProtocols: boolean;
-    autocompounding?: boolean;
-    omniAccount?: boolean;
-    crosschainStrategy?: boolean;
-    agentName?: string;
-    customization?: Record<string, any>;
-    executorProxy?: boolean;
-    splitting?: boolean;
-    minSplits?: number;
-    registered?: boolean;
-}
-interface UserDetailsResponse {
-    success: boolean;
-    user: UserDetails;
-}
-interface TVLBreakdown {
-    chain_id: number;
-    protocol_id: string | null;
-    protocol_name: string | null;
-    pool: string | null;
-    total_balance: number;
-}
 interface TVLResponse {
     success: boolean;
     totalTvl: number;
-    byChain?: Record<number, number>;
-    breakdown?: TVLBreakdown[];
 }
 interface APYPerStrategy {
     id: string;
@@ -201,8 +180,12 @@ interface APYPerStrategy {
     total_rebalances: number;
     created_at: string;
     strategy: string;
+    token_symbol?: string;
     average_apy_with_fee: number;
     average_apy_with_rzfi_with_fee: number;
+    average_apy_without_fee?: number;
+    average_apy_with_rzfi_without_fee?: number;
+    events_average_apy?: Record<string, number>;
 }
 interface APYPerStrategyResponse {
     success: boolean;
@@ -271,15 +254,15 @@ interface HistoryResponse {
     data: HistoryEntry[];
     total: number;
 }
+type TokenEarnings = Record<string, string>;
 interface OnchainEarnings {
     walletAddress: string;
-    totalEarnings: number;
-    currentEarnings: number;
-    lifetimeEarnings: number;
-    unrealizedEarnings?: number;
-    currentEarningsByChain?: Record<string, number>;
-    unrealizedEarningsByChain?: Record<string, number>;
+    totalEarningsByToken: TokenEarnings;
+    lifetimeEarningsByToken: TokenEarnings;
+    currentEarningsByChain: Record<string, TokenEarnings>;
+    unrealizedEarnings: Record<string, TokenEarnings>;
     lastCheckTimestamp?: string;
+    lastLogDate?: Record<string, string | null>;
 }
 interface OnchainEarningsResponse {
     success: boolean;
@@ -288,14 +271,14 @@ interface OnchainEarningsResponse {
 interface DailyEarning {
     wallet_address?: string;
     snapshot_date: string;
-    total_current_earnings: number;
-    total_lifetime_earnings: number;
-    total_unrealized_earnings: number;
-    total_earnings: number;
-    daily_current_delta: number;
-    daily_lifetime_delta: number;
-    daily_unrealized_delta: number;
-    daily_total_delta: number;
+    current_earnings_by_token: TokenEarnings;
+    lifetime_earnings_by_token: TokenEarnings;
+    unrealized_earnings_by_token: TokenEarnings;
+    total_earnings_by_token: TokenEarnings;
+    daily_current_delta_by_token: TokenEarnings;
+    daily_lifetime_delta_by_token: TokenEarnings;
+    daily_unrealized_delta_by_token: TokenEarnings;
+    daily_total_delta_by_token: TokenEarnings;
     created_at?: string;
 }
 interface DailyEarningsResponse {
@@ -345,13 +328,23 @@ interface OpportunitiesResponse {
     strategyType: "conservative" | "aggressive";
     data: Opportunity[];
 }
-interface DailyApyEntry {
-    date: string;
+interface ApyPosition {
     apy: number;
-    weightedApy?: number;
-    balance?: number;
-    protocol?: string;
-    pool?: string;
+    balance: number;
+    chainId: number;
+    protocol: string;
+    pool: string;
+    strategy: string;
+    tokenSymbol?: string;
+}
+type TokenApy = Record<string, number>;
+interface DailyApyEntry {
+    positions: ApyPosition[];
+    weighted_apy: TokenApy;
+    fee: TokenApy;
+    weighted_apy_after_fee: TokenApy;
+    rzfi_merkl_apr: TokenApy;
+    final_weighted_apy: TokenApy;
 }
 interface DailyApyHistoryResponse {
     success: boolean;
@@ -359,8 +352,8 @@ interface DailyApyHistoryResponse {
     history: Record<string, DailyApyEntry>;
     totalDays: number;
     requestedDays?: number;
-    weightedApyWithRzfiAfterFee?: number;
-    weightedApyAfterFee?: number;
+    weightedApyWithRzfiAfterFee?: TokenApy;
+    weightedApyAfterFee?: TokenApy;
 }
 interface RebalanceFrequencyResponse {
     success: boolean;
@@ -375,6 +368,10 @@ interface DepositResponse {
     smartWallet: string;
     amount: string;
 }
+interface LogDepositResponse {
+    success: boolean;
+    message: string;
+}
 interface WithdrawResponse {
     success: boolean;
     message: string;
@@ -512,7 +509,7 @@ interface ChainConfig {
     publicClient: PublicClient;
 }
 declare const DEFAULT_TOKEN_ADDRESSES: Record<SupportedChainId, string>;
-declare const getDefaultTokenAddress: (chainId: SupportedChainId) => string;
+declare const getDefaultTokenAddress: (chainId: SupportedChainId, asset?: string) => string;
 /**
  * Get chain configuration for a given chain ID.
  *
@@ -588,23 +585,23 @@ declare class ZyfaiSDK {
      */
     pauseAgent(): Promise<UpdateUserProfileResponse>;
     /**
-   * Pause the agent by clearing all protocols
-   * Sets the user's protocols to an empty array, effectively pausing automated operations
-   *
-   * @returns Response indicating success and updated user details
-   *
-   * @example
-   * ```typescript
-   * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
-   *
-   * // Connect account first
-   * await sdk.connectAccount();
-   *
-   * // Pause the agent
-   * const result = await sdk.pauseAgent();
-   * console.log('Agent paused:', result.success);
-   * ```
-   */
+     * Resume the agent by restoring protocols based on user's strategy for each asset
+     * Fetches available protocols and assigns them based on each asset's strategy
+     *
+     * @returns Response indicating success and updated user details
+     *
+     * @example
+     * ```typescript
+     * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+     *
+     * // Connect account first
+     * await sdk.connectAccount();
+     *
+     * // Resume the agent
+     * const result = await sdk.resumeAgent();
+     * console.log('Agent resumed:', result.success);
+     * ```
+     */
     resumeAgent(): Promise<UpdateUserProfileResponse>;
     /**
      * Enable splitting for the user's account
@@ -807,7 +804,47 @@ declare class ZyfaiSDK {
      * );
      * ```
      */
-    depositFunds(userAddress: string, chainId: SupportedChainId, amount: string): Promise<DepositResponse>;
+    depositFunds(userAddress: string, chainId: SupportedChainId, amount: string, asset?: string): Promise<DepositResponse>;
+    /**
+     * Log a deposit that was executed client-side
+     *
+     * Use this method when you execute the deposit transaction yourself (e.g., with Privy,
+     * sponsored transactions, or any custom wallet implementation) and need to register
+     * the deposit with the Zyfai backend for tracking and yield optimization.
+     *
+     * This is useful for partners who:
+     * - Use sponsored/gasless transactions (Privy, Biconomy, etc.)
+     * - Have custom wallet implementations
+     * - Need more control over transaction execution
+     *
+     * Token is automatically selected based on chain if not provided:
+     * - Base (8453) and Arbitrum (42161): USDC
+     * - Plasma (9745): USDT
+     *
+     * @param chainId - Chain ID where the deposit was made
+     * @param txHash - Transaction hash of the deposit
+     * @param amount - Amount in least decimal units (e.g., "100000000" for 100 USDC with 6 decimals)
+     * @param tokenAddress - Optional: Token address (auto-selected based on chain if not provided)
+     * @returns Log deposit response with success status
+     *
+     * @example
+     * ```typescript
+     * // Execute deposit with Privy (sponsored transaction)
+     * const txHash = await privyWallet.sendTransaction({
+     *   to: safeAddress,
+     *   data: transferData,
+     * });
+     *
+     * // Log the deposit to Zyfai backend
+     * const result = await sdk.logDeposit(
+     *   8453,           // chainId
+     *   txHash,         // transaction hash from Privy
+     *   "100000000"     // 100 USDC
+     * );
+     * console.log(result.success); // true
+     * ```
+     */
+    logDeposit(chainId: SupportedChainId, txHash: string, amount: string, tokenAddress?: string): Promise<LogDepositResponse>;
     /**
      * Withdraw funds from Safe smart wallet
      * Initiates a withdrawal request to the Zyfai API
@@ -833,7 +870,7 @@ declare class ZyfaiSDK {
      * );
      * ```
      */
-    withdrawFunds(userAddress: string, chainId: SupportedChainId, amount?: string): Promise<WithdrawResponse>;
+    withdrawFunds(userAddress: string, chainId: SupportedChainId, amount?: string, tokenSymbol?: string): Promise<WithdrawResponse>;
     /**
      * Get available DeFi protocols and pools for a specific chain
      *
@@ -880,7 +917,7 @@ declare class ZyfaiSDK {
      * console.log("Chains:", user.user.chains);
      * ```
      */
-    getUserDetails(): Promise<UserDetailsResponse>;
+    getUserDetails(asset?: "usdc" | "eth"): Promise<UpdateUserProfileResponse>;
     /**
      * Get total value locked (TVL) across all Zyfai accounts
      *
@@ -899,15 +936,17 @@ declare class ZyfaiSDK {
      * @param crossChain - Whether to get cross-chain APY (true = omni account, false = simple account)
      * @param days - Time period: 7, 14, or 30
      * @param strategy - Strategy type: "conservative" (default) or "aggressive"
+     * @param chainId - Optional chain ID filter
+     * @param tokenSymbol - Optional token symbol filter (e.g. "USDC", "WETH", "WBTC")
      * @returns APY per strategy for a specific chain
      *
      * @example
      * ```typescript
-     * const apyPerStrategy = await sdk.getAPYPerStrategy(false, 7, "conservative");
+     * const apyPerStrategy = await sdk.getAPYPerStrategy(false, 7, "conservative", 8453, "USDC");
      * console.log("APY per strategy per chain:", apyPerStrategy.data);
      * ```
      */
-    getAPYPerStrategy(crossChain?: boolean, days?: number, strategy?: Strategy): Promise<APYPerStrategyResponse>;
+    getAPYPerStrategy(crossChain?: boolean, days?: number, strategy?: Strategy, chainId?: number, tokenSymbol?: string): Promise<APYPerStrategyResponse>;
     /**
      * Get total volume across all Zyfai accounts
      *
@@ -919,7 +958,7 @@ declare class ZyfaiSDK {
      * console.log("Total Volume:", volume.volumeInUSD);
      * ```
      */
-    getVolume(): Promise<VolumeResponse>;
+    getVolume(assetType?: "usdc" | "eth"): Promise<VolumeResponse>;
     /**
      * Get active wallets for a specific chain
      *
@@ -984,12 +1023,12 @@ declare class ZyfaiSDK {
      * Get onchain earnings for a wallet
      *
      * @param walletAddress - Smart wallet address
-     * @returns Onchain earnings data including total, current, and lifetime
+     * @returns Onchain earnings data with per-token breakdowns
      *
      * @example
      * ```typescript
      * const earnings = await sdk.getOnchainEarnings("0x...");
-     * console.log("Total earnings:", earnings.data.totalEarnings);
+     * console.log("Total USDC:", earnings.data.totalEarningsByToken["USDC"]);
      * ```
      */
     getOnchainEarnings(walletAddress: string): Promise<OnchainEarningsResponse>;
@@ -998,12 +1037,12 @@ declare class ZyfaiSDK {
      * This triggers a recalculation of earnings on the backend
      *
      * @param walletAddress - Smart wallet address
-     * @returns Updated onchain earnings data
+     * @returns Updated onchain earnings data with per-token breakdowns
      *
      * @example
      * ```typescript
      * const earnings = await sdk.calculateOnchainEarnings("0x...");
-     * console.log("Calculated earnings:", earnings.data.totalEarnings);
+     * console.log("Total USDC:", earnings.data.totalEarningsByToken["USDC"]);
      * ```
      */
     calculateOnchainEarnings(walletAddress: string): Promise<OnchainEarningsResponse>;
@@ -1018,55 +1057,44 @@ declare class ZyfaiSDK {
      * @example
      * ```typescript
      * const daily = await sdk.getDailyEarnings("0x...", "2024-01-01", "2024-01-31");
-     * daily.data.forEach(d => console.log(d.date, d.earnings));
+     * daily.data.forEach(d => console.log(d.snapshot_date, d.total_earnings_by_token));
      * ```
      */
     getDailyEarnings(walletAddress: string, startDate?: string, endDate?: string): Promise<DailyEarningsResponse>;
-    /**
-     * Get Debank portfolio for a wallet across multiple chains
-     * Note: This is a paid endpoint and may require authorization
-     *
-     * @param walletAddress - Smart wallet address
-     * @returns Multi-chain portfolio data
-     *
-     * @example
-     * ```typescript
-     * const portfolio = await sdk.getDebankPortfolio("0x...");
-     * console.log("Total value:", portfolio.totalValueUsd);
-     * ```
-     */
-    getDebankPortfolio(walletAddress: string): Promise<DebankPortfolioResponse>;
     /**
      * Get conservative (low-risk) yield opportunities
      *
      * @param chainId - Optional chain ID filter
+     * @param asset - Optional asset filter (e.g. "USDC", "WETH", "WBTC")
      * @returns List of conservative yield opportunities
      *
      * @example
      * ```typescript
-     * const opportunities = await sdk.getConservativeOpportunities(8453);
+     * const opportunities = await sdk.getConservativeOpportunities(8453, "USDC");
      * opportunities.data.forEach(o => console.log(o.protocolName, o.apy));
      * ```
      */
-    getConservativeOpportunities(chainId?: number): Promise<OpportunitiesResponse>;
+    getConservativeOpportunities(chainId?: number, asset?: string, status?: "live" | "not_live"): Promise<OpportunitiesResponse>;
     /**
      * Get aggressive (high-risk, high-reward) yield opportunities
      *
      * @param chainId - Optional chain ID filter
+     * @param asset - Optional asset filter (e.g. "USDC", "WETH", "WBTC")
      * @returns List of aggressive opportunities
      *
      * @example
      * ```typescript
-     * const opportunities = await sdk.getAggressiveOpportunities(8453);
+     * const opportunities = await sdk.getAggressiveOpportunities(8453, "WETH");
      * opportunities.data.forEach(o => console.log(o.protocolName, o.apy));
      * ```
      */
-    getAggressiveOpportunities(chainId?: number): Promise<OpportunitiesResponse>;
+    getAggressiveOpportunities(chainId?: number, asset?: string, status?: "live" | "not_live"): Promise<OpportunitiesResponse>;
     /**
      * Get active conservative opportunities (status = "live") with risk and utilization data
      * Returns pool info, liquidity depth (true if > 1M), utilization rate, stability metrics, avg APY, and collateral
      *
      * @param chainId - Optional chain ID filter
+     * @param asset - Optional asset filter (e.g. "USDC", "WETH", "WBTC")
      * @returns Active conservative opportunities with risk data
      *
      * @example
@@ -1075,12 +1103,13 @@ declare class ZyfaiSDK {
      * console.log(JSON.stringify(opps, null, 2));
      * ```
      */
-    getActiveConservativeOppsRisk(chainId?: number): Promise<any>;
+    getActiveConservativeOppsRisk(chainId?: number, asset?: string): Promise<any>;
     /**
      * Get active aggressive opportunities (status = "live") with risk and utilization data
      * Returns pool info, liquidity depth (true if > 1M), utilization rate, stability metrics, avg APY, and collateral
      *
      * @param chainId - Optional chain ID filter
+     * @param asset - Optional asset filter (e.g. "USDC", "WETH", "WBTC")
      * @returns Active aggressive opportunities with risk data
      *
      * @example
@@ -1089,35 +1118,37 @@ declare class ZyfaiSDK {
      * console.log(JSON.stringify(opps, null, 2));
      * ```
      */
-    getActiveAggressiveOppsRisk(chainId?: number): Promise<any>;
+    getActiveAggressiveOppsRisk(chainId?: number, asset?: string): Promise<any>;
     /**
      * Get conservative pool status with derived health, risk, APY trend, and yield consistency
      * Builds on getActiveConservativeOppsRisk and computes higher-level status indicators
      *
      * @param chainId - Optional chain ID filter
+     * @param asset - Optional asset filter (e.g. "USDC", "WETH", "WBTC")
      * @returns Conservative pools with status data
      */
-    getConservativePoolStatus(chainId?: number): Promise<any>;
+    getConservativePoolStatus(chainId?: number, asset?: string): Promise<any>;
     /**
      * Get aggressive pool status with derived health, risk, APY trend, and yield consistency
      * Builds on getActiveAggressiveOppsRisk and computes higher-level status indicators
      *
      * @param chainId - Optional chain ID filter
+     * @param asset - Optional asset filter (e.g. "USDC", "WETH", "WBTC")
      * @returns Aggressive pools with status data
      */
-    getAggressivePoolStatus(chainId?: number): Promise<any>;
+    getAggressivePoolStatus(chainId?: number, asset?: string): Promise<any>;
     private derivePoolStatus;
     /**
      * Get daily APY history with weighted average for a wallet
      *
      * @param walletAddress - Smart wallet address
      * @param days - Period: "7D", "14D", or "30D" (default: "7D")
-     * @returns Daily APY history with weighted averages
+     * @returns Daily APY history with per-position breakdowns and weighted averages
      *
      * @example
      * ```typescript
      * const apyHistory = await sdk.getDailyApyHistory("0x...", "30D");
-     * console.log("Average APY:", apyHistory.averageWeightedApy);
+     * console.log("Weighted APY after fee:", apyHistory.weightedApyAfterFee); // { "USDC": 4.64, "WETH": 1.94 }
      * ```
      */
     getDailyApyHistory(walletAddress: string, days?: "7D" | "14D" | "30D"): Promise<DailyApyHistoryResponse>;
@@ -1283,4 +1314,4 @@ declare class ZyfaiSDK {
     registerAgentOnIdentityRegistry(smartWallet: string, chainId: SupportedChainId): Promise<RegisterAgentResponse>;
 }
 
-export { type APYPerStrategy, type APYPerStrategyResponse, type ActionData, type ActiveWallet, type ActiveWalletsResponse, type AddWalletToSdkResponse, type Address, type BestOpportunityDetails, type BestOpportunityResponse, type ChainConfig, type ChainPortfolio, type CustomizationConfig, type CustomizeBatchRequest, type CustomizeBatchResponse, DEFAULT_TOKEN_ADDRESSES, type DailyApyEntry, type DailyApyHistoryResponse, type DailyEarning, type DailyEarningsResponse, type DebankPortfolioResponse, type DeploySafeResponse, type DepositResponse, type ERC7739Context, type ERC7739Data, type FirstTopupResponse, type GetPoolsResponse, type GetSelectedPoolsResponse, type Hex, type HistoryEntry, type HistoryPosition, type HistoryResponse, type OnchainEarnings, type OnchainEarningsResponse, type OpportunitiesResponse, type Opportunity, type OpportunityPosition, type PolicyData, type Pool, type Portfolio, type PortfolioResponse, type PortfolioToken, type PositionSlot, type Protocol, type ProtocolsResponse, type RebalanceFrequencyResponse, type RegisterAgentResponse, type SDKConfig, type SdkKeyTVLResponse, type Session, type SessionKeyResponse, type SmartWalletByEOAResponse, type SmartWalletResponse, type Strategy, type SupportedChainId, type TVLResponse, type UserDetails, type UserDetailsResponse, type VolumeResponse, type WalletTVL, type WithdrawResponse, ZyfaiSDK, getChainConfig, getDefaultTokenAddress, getSupportedChainIds, isSupportedChain };
+export { type APYPerStrategy, type APYPerStrategyResponse, type ActionData, type ActiveWallet, type ActiveWalletsResponse, type AddWalletToSdkResponse, type Address, type ApyPosition, type BestOpportunityDetails, type BestOpportunityResponse, type ChainConfig, type ChainPortfolio, type CustomizationConfig, type CustomizeBatchRequest, type CustomizeBatchResponse, DEFAULT_TOKEN_ADDRESSES, type DailyApyEntry, type DailyApyHistoryResponse, type DailyEarning, type DailyEarningsResponse, type DebankPortfolioResponse, type DeploySafeResponse, type DepositResponse, type ERC7739Context, type ERC7739Data, type FirstTopupResponse, type GetPoolsResponse, type GetSelectedPoolsResponse, type Hex, type HistoryEntry, type HistoryPosition, type HistoryResponse, type LogDepositResponse, type OnchainEarnings, type OnchainEarningsResponse, type OpportunitiesResponse, type Opportunity, type OpportunityPosition, type PolicyData, type Pool, type Portfolio, type PortfolioResponse, type PortfolioToken, type PositionSlot, type Protocol, type ProtocolsResponse, type RebalanceFrequencyResponse, type RegisterAgentResponse, type SDKConfig, type SdkKeyTVLResponse, type Session, type SessionKeyResponse, type SmartWalletByEOAResponse, type SmartWalletResponse, type Strategy, type SupportedChainId, type TVLResponse, type TokenApy, type TokenEarnings, type VolumeResponse, type WalletTVL, type WithdrawResponse, ZyfaiSDK, getChainConfig, getDefaultTokenAddress, getSupportedChainIds, isSupportedChain };