@zyfai/sdk 0.2.4 → 0.2.6

package/dist/index.d.mts

@@ -356,6 +356,70 @@ interface AddWalletToSdkResponse {
     success: boolean;
     message: string;
 }
+interface WalletTVL {
+    walletAddress: Address;
+    tvl: number;
+    positions?: {
+        chainId: number;
+        protocol: string;
+        amount: number;
+    }[];
+}
+interface SdkKeyTVLResponse {
+    success: boolean;
+    allowedWallets: Address[];
+    totalTvl: number;
+    tvlByWallet: WalletTVL[];
+    metadata?: {
+        sdkKeyId: string;
+        clientName: string;
+        walletsCount: number;
+    };
+}
+interface OpportunityPosition {
+    protocol: string;
+    pool: string;
+    apy: number;
+    tvl?: number;
+}
+interface BestOpportunityDetails {
+    protocol: string;
+    pool: string;
+    apy: number;
+    tvl: number;
+    zyfiTvl?: number;
+    poolApy?: number;
+    rewardsApy?: number;
+    protocolApy?: number;
+}
+interface BestOpportunityResponse {
+    success: boolean;
+    error?: string;
+    wallet?: Address;
+    chainId?: number;
+    strategy?: string;
+    token?: {
+        symbol: string;
+        address: string;
+        decimals: number;
+    };
+    currentPosition?: OpportunityPosition | null;
+    bestOpportunity?: BestOpportunityDetails | null;
+    shouldRebalance?: boolean;
+    apyImprovement?: number | null;
+    allOpportunities?: Array<{
+        protocol: string;
+        pool: string;
+        apy: number;
+        tvl: number;
+        zyfiTvl?: number;
+    }>;
+    userConfig?: {
+        autoSelectProtocols: boolean;
+        enabledProtocols: string[];
+    };
+    enabledChains?: number[];
+}
 interface PolicyData {
     policy: Address;
     initData: Hex;
@@ -872,6 +936,69 @@ declare class ZyfaiSDK {
      * ```
      */
     getRebalanceFrequency(walletAddress: string): Promise<RebalanceFrequencyResponse>;
+    /**
+     * Get allowed wallets for the current SDK API key
+     * Returns the list of smart wallet addresses created via this SDK key
+     *
+     * @returns List of allowed wallet addresses with metadata
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.getSdkAllowedWallets();
+     * console.log("Allowed wallets:", result.allowedWallets);
+     * console.log("Total count:", result.metadata.walletsCount);
+     * ```
+     */
+    getSdkAllowedWallets(): Promise<{
+        success: boolean;
+        allowedWallets: Address[];
+        metadata: {
+            sdkKeyId: string;
+            clientName: string;
+            walletsCount: number;
+        };
+    }>;
+    /**
+     * Get total TVL for all wallets under the current SDK API key
+     * This method calculates the total value locked across all wallets created via this SDK key
+     *
+     * @returns SDK key TVL information including allowed wallets and their individual/total TVL
+     *
+     * @example
+     * ```typescript
+     * const sdkTvl = await sdk.getSdkKeyTVL();
+     * console.log("Total TVL across all SDK wallets:", sdkTvl.totalTvl);
+     * console.log("Number of wallets:", sdkTvl.allowedWallets.length);
+     * console.log("TVL by wallet:", sdkTvl.tvlByWallet);
+     * ```
+     */
+    getSdkKeyTVL(): Promise<SdkKeyTVLResponse>;
+    /**
+     * Get the best yield opportunity for a registered wallet.
+     *
+     * Returns the highest-APY opportunity available based on the wallet's strategy
+     * and enabled protocols. This reflects what the rebalance engine would select.
+     *
+     * @param walletAddress - The smart wallet address (must be registered)
+     * @param chainId - The chain ID to check opportunities on
+     * @returns Best opportunity details with comparison to current position
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.getBestOpportunity(walletAddress, 8453);
+     *
+     * console.log("Current position:", result.currentPosition);
+     * console.log("Best opportunity:", result.bestOpportunity);
+     * console.log("Should rebalance:", result.shouldRebalance);
+     * console.log("APY improvement:", result.apyImprovement);
+     *
+     * // List all available opportunities
+     * result.allOpportunities?.forEach(opp => {
+     *   console.log(`${opp.protocol} - ${opp.pool}: ${opp.apy}%`);
+     * });
+     * ```
+     */
+    getBestOpportunity(walletAddress: Address, chainId: SupportedChainId): Promise<BestOpportunityResponse>;
 }
 
-export { type APYPerStrategy, type APYPerStrategyResponse, type ActionData, type ActiveWallet, type ActiveWalletsResponse, type AddWalletToSdkResponse, type Address, type ChainConfig, type ChainPortfolio, DEFAULT_TOKEN_ADDRESSES, type DailyApyEntry, type DailyApyHistoryResponse, type DailyEarning, type DailyEarningsResponse, type DebankPortfolioResponse, type DeploySafeResponse, type DepositResponse, type ERC7739Context, type ERC7739Data, type FirstTopupResponse, type Hex, type HistoryEntry, type HistoryPosition, type HistoryResponse, type OnchainEarnings, type OnchainEarningsResponse, type OpportunitiesResponse, type Opportunity, type PolicyData, type Pool, type PortfolioToken, type Position, type PositionSlot, type PositionsResponse, type Protocol, type ProtocolsResponse, type RebalanceFrequencyResponse, type SDKConfig, type Session, type SessionKeyResponse, type SmartWalletByEOAResponse, type SmartWalletResponse, type Strategy, type SupportedChainId, type TVLResponse, type UserDetails, type UserDetailsResponse, type VolumeResponse, type WithdrawResponse, ZyfaiSDK, getChainConfig, getDefaultTokenAddress, getSupportedChainIds, isSupportedChain };
+export { type APYPerStrategy, type APYPerStrategyResponse, type ActionData, type ActiveWallet, type ActiveWalletsResponse, type AddWalletToSdkResponse, type Address, type BestOpportunityDetails, type BestOpportunityResponse, type ChainConfig, type ChainPortfolio, DEFAULT_TOKEN_ADDRESSES, type DailyApyEntry, type DailyApyHistoryResponse, type DailyEarning, type DailyEarningsResponse, type DebankPortfolioResponse, type DeploySafeResponse, type DepositResponse, type ERC7739Context, type ERC7739Data, type FirstTopupResponse, type Hex, type HistoryEntry, type HistoryPosition, type HistoryResponse, type OnchainEarnings, type OnchainEarningsResponse, type OpportunitiesResponse, type Opportunity, type OpportunityPosition, type PolicyData, type Pool, type PortfolioToken, type Position, type PositionSlot, type PositionsResponse, type Protocol, type ProtocolsResponse, type RebalanceFrequencyResponse, 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 };

package/dist/index.d.ts

@@ -356,6 +356,70 @@ interface AddWalletToSdkResponse {
     success: boolean;
     message: string;
 }
+interface WalletTVL {
+    walletAddress: Address;
+    tvl: number;
+    positions?: {
+        chainId: number;
+        protocol: string;
+        amount: number;
+    }[];
+}
+interface SdkKeyTVLResponse {
+    success: boolean;
+    allowedWallets: Address[];
+    totalTvl: number;
+    tvlByWallet: WalletTVL[];
+    metadata?: {
+        sdkKeyId: string;
+        clientName: string;
+        walletsCount: number;
+    };
+}
+interface OpportunityPosition {
+    protocol: string;
+    pool: string;
+    apy: number;
+    tvl?: number;
+}
+interface BestOpportunityDetails {
+    protocol: string;
+    pool: string;
+    apy: number;
+    tvl: number;
+    zyfiTvl?: number;
+    poolApy?: number;
+    rewardsApy?: number;
+    protocolApy?: number;
+}
+interface BestOpportunityResponse {
+    success: boolean;
+    error?: string;
+    wallet?: Address;
+    chainId?: number;
+    strategy?: string;
+    token?: {
+        symbol: string;
+        address: string;
+        decimals: number;
+    };
+    currentPosition?: OpportunityPosition | null;
+    bestOpportunity?: BestOpportunityDetails | null;
+    shouldRebalance?: boolean;
+    apyImprovement?: number | null;
+    allOpportunities?: Array<{
+        protocol: string;
+        pool: string;
+        apy: number;
+        tvl: number;
+        zyfiTvl?: number;
+    }>;
+    userConfig?: {
+        autoSelectProtocols: boolean;
+        enabledProtocols: string[];
+    };
+    enabledChains?: number[];
+}
 interface PolicyData {
     policy: Address;
     initData: Hex;
@@ -872,6 +936,69 @@ declare class ZyfaiSDK {
      * ```
      */
     getRebalanceFrequency(walletAddress: string): Promise<RebalanceFrequencyResponse>;
+    /**
+     * Get allowed wallets for the current SDK API key
+     * Returns the list of smart wallet addresses created via this SDK key
+     *
+     * @returns List of allowed wallet addresses with metadata
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.getSdkAllowedWallets();
+     * console.log("Allowed wallets:", result.allowedWallets);
+     * console.log("Total count:", result.metadata.walletsCount);
+     * ```
+     */
+    getSdkAllowedWallets(): Promise<{
+        success: boolean;
+        allowedWallets: Address[];
+        metadata: {
+            sdkKeyId: string;
+            clientName: string;
+            walletsCount: number;
+        };
+    }>;
+    /**
+     * Get total TVL for all wallets under the current SDK API key
+     * This method calculates the total value locked across all wallets created via this SDK key
+     *
+     * @returns SDK key TVL information including allowed wallets and their individual/total TVL
+     *
+     * @example
+     * ```typescript
+     * const sdkTvl = await sdk.getSdkKeyTVL();
+     * console.log("Total TVL across all SDK wallets:", sdkTvl.totalTvl);
+     * console.log("Number of wallets:", sdkTvl.allowedWallets.length);
+     * console.log("TVL by wallet:", sdkTvl.tvlByWallet);
+     * ```
+     */
+    getSdkKeyTVL(): Promise<SdkKeyTVLResponse>;
+    /**
+     * Get the best yield opportunity for a registered wallet.
+     *
+     * Returns the highest-APY opportunity available based on the wallet's strategy
+     * and enabled protocols. This reflects what the rebalance engine would select.
+     *
+     * @param walletAddress - The smart wallet address (must be registered)
+     * @param chainId - The chain ID to check opportunities on
+     * @returns Best opportunity details with comparison to current position
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.getBestOpportunity(walletAddress, 8453);
+     *
+     * console.log("Current position:", result.currentPosition);
+     * console.log("Best opportunity:", result.bestOpportunity);
+     * console.log("Should rebalance:", result.shouldRebalance);
+     * console.log("APY improvement:", result.apyImprovement);
+     *
+     * // List all available opportunities
+     * result.allOpportunities?.forEach(opp => {
+     *   console.log(`${opp.protocol} - ${opp.pool}: ${opp.apy}%`);
+     * });
+     * ```
+     */
+    getBestOpportunity(walletAddress: Address, chainId: SupportedChainId): Promise<BestOpportunityResponse>;
 }
 
-export { type APYPerStrategy, type APYPerStrategyResponse, type ActionData, type ActiveWallet, type ActiveWalletsResponse, type AddWalletToSdkResponse, type Address, type ChainConfig, type ChainPortfolio, DEFAULT_TOKEN_ADDRESSES, type DailyApyEntry, type DailyApyHistoryResponse, type DailyEarning, type DailyEarningsResponse, type DebankPortfolioResponse, type DeploySafeResponse, type DepositResponse, type ERC7739Context, type ERC7739Data, type FirstTopupResponse, type Hex, type HistoryEntry, type HistoryPosition, type HistoryResponse, type OnchainEarnings, type OnchainEarningsResponse, type OpportunitiesResponse, type Opportunity, type PolicyData, type Pool, type PortfolioToken, type Position, type PositionSlot, type PositionsResponse, type Protocol, type ProtocolsResponse, type RebalanceFrequencyResponse, type SDKConfig, type Session, type SessionKeyResponse, type SmartWalletByEOAResponse, type SmartWalletResponse, type Strategy, type SupportedChainId, type TVLResponse, type UserDetails, type UserDetailsResponse, type VolumeResponse, type WithdrawResponse, ZyfaiSDK, getChainConfig, getDefaultTokenAddress, getSupportedChainIds, isSupportedChain };
+export { type APYPerStrategy, type APYPerStrategyResponse, type ActionData, type ActiveWallet, type ActiveWalletsResponse, type AddWalletToSdkResponse, type Address, type BestOpportunityDetails, type BestOpportunityResponse, type ChainConfig, type ChainPortfolio, DEFAULT_TOKEN_ADDRESSES, type DailyApyEntry, type DailyApyHistoryResponse, type DailyEarning, type DailyEarningsResponse, type DebankPortfolioResponse, type DeploySafeResponse, type DepositResponse, type ERC7739Context, type ERC7739Data, type FirstTopupResponse, type Hex, type HistoryEntry, type HistoryPosition, type HistoryResponse, type OnchainEarnings, type OnchainEarningsResponse, type OpportunitiesResponse, type Opportunity, type OpportunityPosition, type PolicyData, type Pool, type PortfolioToken, type Position, type PositionSlot, type PositionsResponse, type Protocol, type ProtocolsResponse, type RebalanceFrequencyResponse, 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 };

package/dist/index.js

@@ -55,6 +55,7 @@ var ENDPOINTS = {
   USER_ME: "/users/me",
   USER_WITHDRAW: "/users/withdraw",
   PARTIAL_WITHDRAW: "/users/partial-withdraw",
+  LOG_DEPOSIT: "/users/log_deposit",
   // Safe Deployment (single endpoint)
   SAFE_DEPLOY: "/users/safe-deploy",
   // Session Keys
@@ -70,7 +71,12 @@ var ENDPOINTS = {
   DATA_FIRST_TOPUP: (walletAddress, chainId) => `/data/first-topup?walletAddress=${walletAddress}&chainId=${chainId}`,
   DATA_ACTIVE_WALLETS: (chainId) => `/data/active-wallets?chainId=${chainId}`,
   DATA_BY_EOA: (address) => `/data/by-eoa?address=${address}`,
-  DATA_REBALANCE_FREQUENCY: (walletAddress) => `/data/rebalance-frequency?walletAddress=${walletAddress}`
+  DATA_REBALANCE_FREQUENCY: (walletAddress) => `/data/rebalance-frequency?walletAddress=${walletAddress}`,
+  // SDK Keys
+  SDK_ALLOWED_WALLETS: "/data/sdk-allowed-wallets",
+  SDK_TVL: "/data/sdk-tvl",
+  // Best Opportunity
+  BEST_OPPORTUNITY: (walletAddress, chainId) => `/data/best-opportunity?walletAddress=${walletAddress}&chainId=${chainId}`
 };
 var DATA_ENDPOINTS = {
   // User Initialization
@@ -1384,6 +1390,16 @@ var ZyfaiSDK = class {
       const receipt = await chainConfig.publicClient.waitForTransactionReceipt({
         hash: txHash
       });
+      try {
+        await this.httpClient.post(ENDPOINTS.LOG_DEPOSIT, {
+          chainId,
+          transaction: txHash,
+          token,
+          amount
+        });
+      } catch (logError) {
+        console.warn("Failed to log deposit:", logError.message);
+      }
       if (receipt.status !== "success") {
         throw new Error("Deposit transaction failed");
       }
@@ -2178,6 +2194,113 @@ var ZyfaiSDK = class {
       );
     }
   }
+  // ============================================================================
+  // SDK Key Methods
+  // ============================================================================
+  /**
+   * Get allowed wallets for the current SDK API key
+   * Returns the list of smart wallet addresses created via this SDK key
+   *
+   * @returns List of allowed wallet addresses with metadata
+   *
+   * @example
+   * ```typescript
+   * const result = await sdk.getSdkAllowedWallets();
+   * console.log("Allowed wallets:", result.allowedWallets);
+   * console.log("Total count:", result.metadata.walletsCount);
+   * ```
+   */
+  async getSdkAllowedWallets() {
+    try {
+      const response = await this.httpClient.get(
+        ENDPOINTS.SDK_ALLOWED_WALLETS
+      );
+      return {
+        success: response.success || true,
+        allowedWallets: response.allowedWallets || [],
+        metadata: response.metadata || {
+          sdkKeyId: "",
+          clientName: "",
+          walletsCount: 0
+        }
+      };
+    } catch (error) {
+      throw new Error(
+        `Failed to get SDK allowed wallets: ${error.message}`
+      );
+    }
+  }
+  /**
+   * Get total TVL for all wallets under the current SDK API key
+   * This method calculates the total value locked across all wallets created via this SDK key
+   *
+   * @returns SDK key TVL information including allowed wallets and their individual/total TVL
+   *
+   * @example
+   * ```typescript
+   * const sdkTvl = await sdk.getSdkKeyTVL();
+   * console.log("Total TVL across all SDK wallets:", sdkTvl.totalTvl);
+   * console.log("Number of wallets:", sdkTvl.allowedWallets.length);
+   * console.log("TVL by wallet:", sdkTvl.tvlByWallet);
+   * ```
+   */
+  async getSdkKeyTVL() {
+    try {
+      const response = await this.httpClient.get(ENDPOINTS.SDK_TVL);
+      return {
+        success: response.success || true,
+        allowedWallets: response.allowedWallets || [],
+        totalTvl: response.totalTvl || 0,
+        tvlByWallet: response.tvlByWallet || [],
+        metadata: response.metadata || {
+          sdkKeyId: "",
+          clientName: "",
+          walletsCount: 0
+        }
+      };
+    } catch (error) {
+      throw new Error(
+        `Failed to get SDK key TVL: ${error.message}`
+      );
+    }
+  }
+  /**
+   * Get the best yield opportunity for a registered wallet.
+   *
+   * Returns the highest-APY opportunity available based on the wallet's strategy
+   * and enabled protocols. This reflects what the rebalance engine would select.
+   *
+   * @param walletAddress - The smart wallet address (must be registered)
+   * @param chainId - The chain ID to check opportunities on
+   * @returns Best opportunity details with comparison to current position
+   *
+   * @example
+   * ```typescript
+   * const result = await sdk.getBestOpportunity(walletAddress, 8453);
+   *
+   * console.log("Current position:", result.currentPosition);
+   * console.log("Best opportunity:", result.bestOpportunity);
+   * console.log("Should rebalance:", result.shouldRebalance);
+   * console.log("APY improvement:", result.apyImprovement);
+   *
+   * // List all available opportunities
+   * result.allOpportunities?.forEach(opp => {
+   *   console.log(`${opp.protocol} - ${opp.pool}: ${opp.apy}%`);
+   * });
+   * ```
+   */
+  async getBestOpportunity(walletAddress, chainId) {
+    try {
+      const response = await this.httpClient.get(
+        ENDPOINTS.BEST_OPPORTUNITY(walletAddress, chainId)
+      );
+      return response;
+    } catch (error) {
+      throw new Error(
+        `Failed to get best opportunity: ${error.message}`
+      );
+    }
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.mjs

@@ -14,6 +14,7 @@ var ENDPOINTS = {
   USER_ME: "/users/me",
   USER_WITHDRAW: "/users/withdraw",
   PARTIAL_WITHDRAW: "/users/partial-withdraw",
+  LOG_DEPOSIT: "/users/log_deposit",
   // Safe Deployment (single endpoint)
   SAFE_DEPLOY: "/users/safe-deploy",
   // Session Keys
@@ -29,7 +30,12 @@ var ENDPOINTS = {
   DATA_FIRST_TOPUP: (walletAddress, chainId) => `/data/first-topup?walletAddress=${walletAddress}&chainId=${chainId}`,
   DATA_ACTIVE_WALLETS: (chainId) => `/data/active-wallets?chainId=${chainId}`,
   DATA_BY_EOA: (address) => `/data/by-eoa?address=${address}`,
-  DATA_REBALANCE_FREQUENCY: (walletAddress) => `/data/rebalance-frequency?walletAddress=${walletAddress}`
+  DATA_REBALANCE_FREQUENCY: (walletAddress) => `/data/rebalance-frequency?walletAddress=${walletAddress}`,
+  // SDK Keys
+  SDK_ALLOWED_WALLETS: "/data/sdk-allowed-wallets",
+  SDK_TVL: "/data/sdk-tvl",
+  // Best Opportunity
+  BEST_OPPORTUNITY: (walletAddress, chainId) => `/data/best-opportunity?walletAddress=${walletAddress}&chainId=${chainId}`
 };
 var DATA_ENDPOINTS = {
   // User Initialization
@@ -1361,6 +1367,16 @@ var ZyfaiSDK = class {
       const receipt = await chainConfig.publicClient.waitForTransactionReceipt({
         hash: txHash
       });
+      try {
+        await this.httpClient.post(ENDPOINTS.LOG_DEPOSIT, {
+          chainId,
+          transaction: txHash,
+          token,
+          amount
+        });
+      } catch (logError) {
+        console.warn("Failed to log deposit:", logError.message);
+      }
       if (receipt.status !== "success") {
         throw new Error("Deposit transaction failed");
       }
@@ -2155,6 +2171,113 @@ var ZyfaiSDK = class {
       );
     }
   }
+  // ============================================================================
+  // SDK Key Methods
+  // ============================================================================
+  /**
+   * Get allowed wallets for the current SDK API key
+   * Returns the list of smart wallet addresses created via this SDK key
+   *
+   * @returns List of allowed wallet addresses with metadata
+   *
+   * @example
+   * ```typescript
+   * const result = await sdk.getSdkAllowedWallets();
+   * console.log("Allowed wallets:", result.allowedWallets);
+   * console.log("Total count:", result.metadata.walletsCount);
+   * ```
+   */
+  async getSdkAllowedWallets() {
+    try {
+      const response = await this.httpClient.get(
+        ENDPOINTS.SDK_ALLOWED_WALLETS
+      );
+      return {
+        success: response.success || true,
+        allowedWallets: response.allowedWallets || [],
+        metadata: response.metadata || {
+          sdkKeyId: "",
+          clientName: "",
+          walletsCount: 0
+        }
+      };
+    } catch (error) {
+      throw new Error(
+        `Failed to get SDK allowed wallets: ${error.message}`
+      );
+    }
+  }
+  /**
+   * Get total TVL for all wallets under the current SDK API key
+   * This method calculates the total value locked across all wallets created via this SDK key
+   *
+   * @returns SDK key TVL information including allowed wallets and their individual/total TVL
+   *
+   * @example
+   * ```typescript
+   * const sdkTvl = await sdk.getSdkKeyTVL();
+   * console.log("Total TVL across all SDK wallets:", sdkTvl.totalTvl);
+   * console.log("Number of wallets:", sdkTvl.allowedWallets.length);
+   * console.log("TVL by wallet:", sdkTvl.tvlByWallet);
+   * ```
+   */
+  async getSdkKeyTVL() {
+    try {
+      const response = await this.httpClient.get(ENDPOINTS.SDK_TVL);
+      return {
+        success: response.success || true,
+        allowedWallets: response.allowedWallets || [],
+        totalTvl: response.totalTvl || 0,
+        tvlByWallet: response.tvlByWallet || [],
+        metadata: response.metadata || {
+          sdkKeyId: "",
+          clientName: "",
+          walletsCount: 0
+        }
+      };
+    } catch (error) {
+      throw new Error(
+        `Failed to get SDK key TVL: ${error.message}`
+      );
+    }
+  }
+  /**
+   * Get the best yield opportunity for a registered wallet.
+   *
+   * Returns the highest-APY opportunity available based on the wallet's strategy
+   * and enabled protocols. This reflects what the rebalance engine would select.
+   *
+   * @param walletAddress - The smart wallet address (must be registered)
+   * @param chainId - The chain ID to check opportunities on
+   * @returns Best opportunity details with comparison to current position
+   *
+   * @example
+   * ```typescript
+   * const result = await sdk.getBestOpportunity(walletAddress, 8453);
+   *
+   * console.log("Current position:", result.currentPosition);
+   * console.log("Best opportunity:", result.bestOpportunity);
+   * console.log("Should rebalance:", result.shouldRebalance);
+   * console.log("APY improvement:", result.apyImprovement);
+   *
+   * // List all available opportunities
+   * result.allOpportunities?.forEach(opp => {
+   *   console.log(`${opp.protocol} - ${opp.pool}: ${opp.apy}%`);
+   * });
+   * ```
+   */
+  async getBestOpportunity(walletAddress, chainId) {
+    try {
+      const response = await this.httpClient.get(
+        ENDPOINTS.BEST_OPPORTUNITY(walletAddress, chainId)
+      );
+      return response;
+    } catch (error) {
+      throw new Error(
+        `Failed to get best opportunity: ${error.message}`
+      );
+    }
+  }
 };
 export {
   DEFAULT_TOKEN_ADDRESSES,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyfai/sdk",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "TypeScript SDK for Zyfai Yield Optimization Engine - Deploy Safe smart wallets, manage session keys, and interact with DeFi protocols",
   "main": "dist/index.js",
   "module": "dist/index.mjs",