@zyfai/sdk 0.2.5 → 0.2.6

package/dist/index.d.mts

@@ -376,6 +376,50 @@ interface SdkKeyTVLResponse {
         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;
@@ -929,6 +973,32 @@ declare class ZyfaiSDK {
      * ```
      */
     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 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 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

@@ -376,6 +376,50 @@ interface SdkKeyTVLResponse {
         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;
@@ -929,6 +973,32 @@ declare class ZyfaiSDK {
      * ```
      */
     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 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 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

@@ -74,7 +74,9 @@ var ENDPOINTS = {
   DATA_REBALANCE_FREQUENCY: (walletAddress) => `/data/rebalance-frequency?walletAddress=${walletAddress}`,
   // SDK Keys
   SDK_ALLOWED_WALLETS: "/data/sdk-allowed-wallets",
-  SDK_TVL: "/data/sdk-tvl"
+  SDK_TVL: "/data/sdk-tvl",
+  // Best Opportunity
+  BEST_OPPORTUNITY: (walletAddress, chainId) => `/data/best-opportunity?walletAddress=${walletAddress}&chainId=${chainId}`
 };
 var DATA_ENDPOINTS = {
   // User Initialization
@@ -2262,6 +2264,43 @@ var ZyfaiSDK = class {
       );
     }
   }
+  /**
+   * 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

@@ -33,7 +33,9 @@ var ENDPOINTS = {
   DATA_REBALANCE_FREQUENCY: (walletAddress) => `/data/rebalance-frequency?walletAddress=${walletAddress}`,
   // SDK Keys
   SDK_ALLOWED_WALLETS: "/data/sdk-allowed-wallets",
-  SDK_TVL: "/data/sdk-tvl"
+  SDK_TVL: "/data/sdk-tvl",
+  // Best Opportunity
+  BEST_OPPORTUNITY: (walletAddress, chainId) => `/data/best-opportunity?walletAddress=${walletAddress}&chainId=${chainId}`
 };
 var DATA_ENDPOINTS = {
   // User Initialization
@@ -2239,6 +2241,43 @@ var ZyfaiSDK = class {
       );
     }
   }
+  /**
+   * 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.5",
+  "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",