@zyfai/sdk 0.2.15 → 0.2.17

package/dist/index.d.mts

@@ -14,6 +14,7 @@ interface RpcUrlsConfig {
 interface SDKConfig {
     apiKey: string;
     rpcUrls?: RpcUrlsConfig;
+    referralSource?: string;
 }
 interface DeploySafeResponse {
     success: boolean;
@@ -349,7 +350,8 @@ interface DailyApyHistoryResponse {
     history: Record<string, DailyApyEntry>;
     totalDays: number;
     requestedDays?: number;
-    averageWeightedApy?: number;
+    weightedApyWithRzfiAfterFee?: number;
+    weightedApyAfterFee?: number;
 }
 interface RebalanceFrequencyResponse {
     success: boolean;
@@ -531,6 +533,7 @@ declare class ZyfaiSDK {
     private currentProvider;
     private currentChainId;
     private rpcUrls?;
+    private referralSource?;
     constructor(config: SDKConfig | string);
     /**
      * Authenticate user with SIWE (Sign-In with Ethereum) & JWT token
@@ -575,6 +578,25 @@ 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);
+   * ```
+   */
+    resumeAgent(): Promise<UpdateUserProfileResponse>;
     /**
      * Enable splitting for the user's account
      * When enabled, deposits are split across multiple protocols based on minSplits setting
@@ -1142,32 +1164,6 @@ 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>;
     /**
      * Configure protocol and pool customizations in batch.
      *

package/dist/index.d.ts

@@ -14,6 +14,7 @@ interface RpcUrlsConfig {
 interface SDKConfig {
     apiKey: string;
     rpcUrls?: RpcUrlsConfig;
+    referralSource?: string;
 }
 interface DeploySafeResponse {
     success: boolean;
@@ -349,7 +350,8 @@ interface DailyApyHistoryResponse {
     history: Record<string, DailyApyEntry>;
     totalDays: number;
     requestedDays?: number;
-    averageWeightedApy?: number;
+    weightedApyWithRzfiAfterFee?: number;
+    weightedApyAfterFee?: number;
 }
 interface RebalanceFrequencyResponse {
     success: boolean;
@@ -531,6 +533,7 @@ declare class ZyfaiSDK {
     private currentProvider;
     private currentChainId;
     private rpcUrls?;
+    private referralSource?;
     constructor(config: SDKConfig | string);
     /**
      * Authenticate user with SIWE (Sign-In with Ethereum) & JWT token
@@ -575,6 +578,25 @@ 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);
+   * ```
+   */
+    resumeAgent(): Promise<UpdateUserProfileResponse>;
     /**
      * Enable splitting for the user's account
      * When enabled, deposits are split across multiple protocols based on minSplits setting
@@ -1142,32 +1164,6 @@ 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>;
     /**
      * Configure protocol and pool customizations in batch.
      *

package/dist/index.js

@@ -62,7 +62,7 @@ var ENDPOINTS = {
   SESSION_KEYS_CONFIG: "/session-keys/config",
   SESSION_KEYS_ADD: "/session-keys/add",
   // Protocols
-  PROTOCOLS: (chainId) => `/protocols?chainId=${chainId}`,
+  PROTOCOLS: (chainId) => chainId ? `/protocols?chainId=${chainId}` : "/protocols",
   // Data (v1)
   DATA_POSITION: (walletAddress) => `/data/position?walletAddress=${walletAddress}`,
   DATA_HISTORY: (walletAddress, chainId) => `/data/history?walletAddress=${walletAddress}&chainId=${chainId}`,
@@ -75,8 +75,6 @@ var ENDPOINTS = {
   // 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}`,
   // Agent Identity Registry
   AGENT_TOKEN_URI: "/users/me/agent-token-uri",
   // Customization
@@ -685,12 +683,13 @@ var _ZyfaiSDK = class _ZyfaiSDK {
     this.currentProvider = null;
     this.currentChainId = null;
     const sdkConfig = typeof config === "string" ? { apiKey: config } : config;
-    const { apiKey, rpcUrls } = sdkConfig;
+    const { apiKey, rpcUrls, referralSource } = sdkConfig;
     if (!apiKey) {
       throw new Error("API key is required");
     }
     this.httpClient = new HttpClient(apiKey);
     this.rpcUrls = rpcUrls;
+    this.referralSource = referralSource;
   }
   /**
    * Authenticate user with SIWE (Sign-In with Ethereum) & JWT token
@@ -738,7 +737,8 @@ var _ZyfaiSDK = class _ZyfaiSDK {
         ENDPOINTS.AUTH_LOGIN,
         {
           message: messageObj,
-          signature
+          signature,
+          referralSource: this.referralSource
         },
         // Set Origin header in Node.js to match message.uri (required by backend validation)
         isNodeJs ? {
@@ -844,6 +844,49 @@ var _ZyfaiSDK = class _ZyfaiSDK {
       throw new Error(`Failed to pause agent: ${error.message}`);
     }
   }
+  /**
+  * 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);
+  * ```
+  */
+  async resumeAgent() {
+    try {
+      const userDetails = await this.getUserDetails();
+      const userChains = userDetails.user.chains;
+      const strategy = userDetails.user.strategy || "safe_strategy";
+      const convertedStrategy = toInternalStrategy(strategy);
+      const chains = userChains && userChains.length > 0 ? userChains : [8453, 42161];
+      const allProtocols = await this.httpClient.get(
+        ENDPOINTS.PROTOCOLS()
+      );
+      const filteredProtocolIds = allProtocols.filter((protocol) => {
+        const hasMatchingChain = protocol.chains.some(
+          (chain) => chains.includes(chain)
+        );
+        const hasMatchingStrategy = protocol.strategies?.includes(convertedStrategy);
+        return hasMatchingChain && hasMatchingStrategy;
+      }).map((protocol) => protocol.id);
+      const response = await this.updateUserProfile({
+        protocols: filteredProtocolIds
+      });
+      return response;
+    } catch (error) {
+      throw new Error(`Failed to resume agent: ${error.message}`);
+    }
+  }
   /**
    * Enable splitting for the user's account
    * When enabled, deposits are split across multiple protocols based on minSplits setting
@@ -2447,7 +2490,8 @@ var _ZyfaiSDK = class _ZyfaiSDK {
         history: data.history || {},
         totalDays: data.total_days || data.totalDays || 0,
         requestedDays: data.requested_days || data.requestedDays,
-        averageWeightedApy: data.average_final_weighted_apy_after_fee || data.averageWeightedApy || 0
+        weightedApyWithRzfiAfterFee: data.average_final_weighted_apy_after_fee_with_rzfi,
+        weightedApyAfterFee: data.average_final_weighted_apy_after_fee
       };
     } catch (error) {
       throw new Error(
@@ -2563,43 +2607,6 @@ var _ZyfaiSDK = class _ZyfaiSDK {
       );
     }
   }
-  /**
-   * 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}`
-      );
-    }
-  }
   // ============================================================================
   // Protocol/Pool Customization
   // ============================================================================

package/dist/index.mjs

@@ -21,7 +21,7 @@ var ENDPOINTS = {
   SESSION_KEYS_CONFIG: "/session-keys/config",
   SESSION_KEYS_ADD: "/session-keys/add",
   // Protocols
-  PROTOCOLS: (chainId) => `/protocols?chainId=${chainId}`,
+  PROTOCOLS: (chainId) => chainId ? `/protocols?chainId=${chainId}` : "/protocols",
   // Data (v1)
   DATA_POSITION: (walletAddress) => `/data/position?walletAddress=${walletAddress}`,
   DATA_HISTORY: (walletAddress, chainId) => `/data/history?walletAddress=${walletAddress}&chainId=${chainId}`,
@@ -34,8 +34,6 @@ var ENDPOINTS = {
   // 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}`,
   // Agent Identity Registry
   AGENT_TOKEN_URI: "/users/me/agent-token-uri",
   // Customization
@@ -663,12 +661,13 @@ var _ZyfaiSDK = class _ZyfaiSDK {
     this.currentProvider = null;
     this.currentChainId = null;
     const sdkConfig = typeof config === "string" ? { apiKey: config } : config;
-    const { apiKey, rpcUrls } = sdkConfig;
+    const { apiKey, rpcUrls, referralSource } = sdkConfig;
     if (!apiKey) {
       throw new Error("API key is required");
     }
     this.httpClient = new HttpClient(apiKey);
     this.rpcUrls = rpcUrls;
+    this.referralSource = referralSource;
   }
   /**
    * Authenticate user with SIWE (Sign-In with Ethereum) & JWT token
@@ -716,7 +715,8 @@ var _ZyfaiSDK = class _ZyfaiSDK {
         ENDPOINTS.AUTH_LOGIN,
         {
           message: messageObj,
-          signature
+          signature,
+          referralSource: this.referralSource
         },
         // Set Origin header in Node.js to match message.uri (required by backend validation)
         isNodeJs ? {
@@ -822,6 +822,49 @@ var _ZyfaiSDK = class _ZyfaiSDK {
       throw new Error(`Failed to pause agent: ${error.message}`);
     }
   }
+  /**
+  * 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);
+  * ```
+  */
+  async resumeAgent() {
+    try {
+      const userDetails = await this.getUserDetails();
+      const userChains = userDetails.user.chains;
+      const strategy = userDetails.user.strategy || "safe_strategy";
+      const convertedStrategy = toInternalStrategy(strategy);
+      const chains = userChains && userChains.length > 0 ? userChains : [8453, 42161];
+      const allProtocols = await this.httpClient.get(
+        ENDPOINTS.PROTOCOLS()
+      );
+      const filteredProtocolIds = allProtocols.filter((protocol) => {
+        const hasMatchingChain = protocol.chains.some(
+          (chain) => chains.includes(chain)
+        );
+        const hasMatchingStrategy = protocol.strategies?.includes(convertedStrategy);
+        return hasMatchingChain && hasMatchingStrategy;
+      }).map((protocol) => protocol.id);
+      const response = await this.updateUserProfile({
+        protocols: filteredProtocolIds
+      });
+      return response;
+    } catch (error) {
+      throw new Error(`Failed to resume agent: ${error.message}`);
+    }
+  }
   /**
    * Enable splitting for the user's account
    * When enabled, deposits are split across multiple protocols based on minSplits setting
@@ -2425,7 +2468,8 @@ var _ZyfaiSDK = class _ZyfaiSDK {
         history: data.history || {},
         totalDays: data.total_days || data.totalDays || 0,
         requestedDays: data.requested_days || data.requestedDays,
-        averageWeightedApy: data.average_final_weighted_apy_after_fee || data.averageWeightedApy || 0
+        weightedApyWithRzfiAfterFee: data.average_final_weighted_apy_after_fee_with_rzfi,
+        weightedApyAfterFee: data.average_final_weighted_apy_after_fee
       };
     } catch (error) {
       throw new Error(
@@ -2541,43 +2585,6 @@ var _ZyfaiSDK = class _ZyfaiSDK {
       );
     }
   }
-  /**
-   * 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}`
-      );
-    }
-  }
   // ============================================================================
   // Protocol/Pool Customization
   // ============================================================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyfai/sdk",
-  "version": "0.2.15",
+  "version": "0.2.17",
   "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",