@zyfai/sdk 0.2.6 → 0.2.8

package/README.md

@@ -466,8 +466,80 @@ The SDK provides access to various analytics and data endpoints:
 const user = await sdk.getUserDetails();
 console.log("Smart Wallet:", user.user.smartWallet);
 console.log("Active Chains:", user.user.chains);
+console.log("Active Protocols:", user.user.protocols);
 ```
 
+#### Pause Agent
+
+Pause the agent by clearing all protocols. This effectively stops automated operations:
+
+```typescript
+// Pause the agent (clears all protocols)
+const result = await sdk.pauseAgent();
+
+if (result.success) {
+  console.log("Agent paused successfully");
+  console.log("User ID:", result.userId);
+}
+
+// Verify the agent is paused
+const userDetails = await sdk.getUserDetails();
+console.log("Active protocols:", userDetails.user.protocols.length); // Should be 0
+```
+
+**Note**:
+- User must be authenticated (automatically done via `connectAccount()`)
+- This sets the user's protocols to an empty array
+- To resume operations, call `updateUserProfile()` with the desired protocols
+
+#### Splitting Management
+
+Control how deposits are split across multiple protocols for diversification.
+
+**Enable Splitting:**
+
+```typescript
+// Enable splitting with minimum 3 protocols
+const result = await sdk.enableSplitting(3);
+
+if (result.success) {
+  console.log("Splitting enabled with min splits: 3");
+}
+
+// Verify splitting is enabled
+const userDetails = await sdk.getUserDetails();
+console.log("Splitting enabled:", userDetails.user.splitting); // true
+console.log("Min splits:", userDetails.user.minSplits); // 3
+```
+
+**Disable Splitting:**
+
+```typescript
+// Disable splitting
+const result = await sdk.disableSplitting();
+
+if (result.success) {
+  console.log("Splitting disabled");
+}
+```
+
+**Update Minimum Splits:**
+
+```typescript
+// Update minimum number of protocols to split across
+const result = await sdk.updateMinSplits(5);
+
+if (result.success) {
+  console.log("Minimum splits updated to 5");
+}
+```
+
+**Note**:
+- User must be authenticated (automatically done via `connectAccount()`)
+- When splitting is enabled, deposits are distributed across multiple protocols based on `minSplits`
+- `minSplits` must be at least 1
+- Splitting helps with diversification and risk management
+
 #### Get TVL & Volume
 
 ```typescript
@@ -653,26 +725,27 @@ All examples are available in the `examples/` directory:
 7. **`get-protocols.ts`** - Fetch available protocols for a chain
 8. **`get-positions.ts`** - Get active positions for a wallet
 9. **`get-user-details.ts`** - Get authenticated user details
-10. **`get-tvl-volume.ts`** - Get TVL and trading volume
-11. **`get-active-wallets.ts`** - Get active wallets by chain
-12. **`get-smart-wallets-by-eoa.ts`** - Get smart wallets by EOA
-13. **`get-first-topup.ts`** - Get first deposit information
-14. **`get-history.ts`** - Get transaction history
+10. **`pause-agent.ts`** - Pause agent by clearing all protocols
+11. **`get-tvl-volume.ts`** - Get TVL and trading volume
+12. **`get-active-wallets.ts`** - Get active wallets by chain
+13. **`get-smart-wallets-by-eoa.ts`** - Get smart wallets by EOA
+14. **`get-first-topup.ts`** - Get first deposit information
+15. **`get-history.ts`** - Get transaction history
 
 ### Analytics & Earnings
 
-15. **`get-onchain-earnings.ts`** - Get/calculate onchain earnings
-16. **`get-daily-earnings.ts`** - Get daily earnings breakdown
-17. **`get-apy-history.ts`** - Get daily APY history with weighted averages
+16. **`get-onchain-earnings.ts`** - Get/calculate onchain earnings
+17. **`get-daily-earnings.ts`** - Get daily earnings breakdown
+18. **`get-apy-history.ts`** - Get daily APY history with weighted averages
 
 ### Opportunities & Rebalancing
 
-18. **`get-opportunities.ts`** - Get conservative and aggressive yield opportunities
-19. **`get-rebalance-info.ts`** - Get rebalance events and frequency tier
+19. **`get-opportunities.ts`** - Get conservative and aggressive yield opportunities
+20. **`get-rebalance-info.ts`** - Get rebalance events and frequency tier
 
 ### Premium Features
 
-20. **`get-debank-portfolio.ts`** - Get Debank multi-chain portfolio
+21. **`get-debank-portfolio.ts`** - Get Debank multi-chain portfolio
 
 ### Quick Start: Run the End-to-End Example
 

package/dist/index.d.mts

@@ -28,6 +28,9 @@ interface UpdateUserProfileRequest {
     chains?: number[];
     protocols?: string[];
     autoSelectProtocols?: boolean;
+    customization?: Record<string, string[]>;
+    splitting?: boolean;
+    minSplits?: number;
 }
 /** @internal */
 interface UpdateUserProfileResponse {
@@ -141,6 +144,8 @@ interface UserDetails {
     crosschainStrategy?: boolean;
     agentName?: string;
     customization?: Record<string, string[]>;
+    splitting?: boolean;
+    minSplits?: number;
 }
 interface UserDetailsResponse {
     success: boolean;
@@ -510,6 +515,84 @@ declare class ZyfaiSDK {
      * ```
      */
     updateUserProfile(request: UpdateUserProfileRequest): 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);
+     * ```
+     */
+    pauseAgent(): Promise<UpdateUserProfileResponse>;
+    /**
+     * Enable splitting for the user's account
+     * When enabled, deposits are split across multiple protocols based on minSplits setting
+     *
+     * @param minSplits - Optional minimum number of protocols to split across (default: 3)
+     * @returns Response indicating success and updated user details
+     *
+     * @example
+     * ```typescript
+     * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+     *
+     * // Connect account first
+     * await sdk.connectAccount(privateKey, chainId);
+     *
+     * // Enable splitting with minimum 3 protocols
+     * const result = await sdk.enableSplitting(3);
+     * console.log('Splitting enabled:', result.success);
+     * ```
+     */
+    enableSplitting(minSplits?: number): Promise<UpdateUserProfileResponse>;
+    /**
+     * Disable splitting for the user's account
+     * When disabled, deposits will not be split across multiple protocols
+     *
+     * @returns Response indicating success and updated user details
+     *
+     * @example
+     * ```typescript
+     * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+     *
+     * // Connect account first
+     * await sdk.connectAccount(privateKey, chainId);
+     *
+     * // Disable splitting
+     * const result = await sdk.disableSplitting();
+     * console.log('Splitting disabled:', result.success);
+     * ```
+     */
+    disableSplitting(): Promise<UpdateUserProfileResponse>;
+    /**
+     * Update the minimum number of splits for the user's account
+     * This controls across how many protocols deposits should be distributed
+     *
+     * @param minSplits - Minimum number of protocols to split across
+     * @returns Response indicating success and updated user details
+     *
+     * @example
+     * ```typescript
+     * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+     *
+     * // Connect account first
+     * await sdk.connectAccount(privateKey, chainId);
+     *
+     * // Update minimum splits to 5
+     * const result = await sdk.updateMinSplits(5);
+     * console.log('Min splits updated:', result.success);
+     * ```
+     */
+    updateMinSplits(minSplits: number): Promise<UpdateUserProfileResponse>;
     /**
      * Initialize user after Safe deployment
      * This method is automatically called after deploySafe to initialize user state

package/dist/index.d.ts

@@ -28,6 +28,9 @@ interface UpdateUserProfileRequest {
     chains?: number[];
     protocols?: string[];
     autoSelectProtocols?: boolean;
+    customization?: Record<string, string[]>;
+    splitting?: boolean;
+    minSplits?: number;
 }
 /** @internal */
 interface UpdateUserProfileResponse {
@@ -141,6 +144,8 @@ interface UserDetails {
     crosschainStrategy?: boolean;
     agentName?: string;
     customization?: Record<string, string[]>;
+    splitting?: boolean;
+    minSplits?: number;
 }
 interface UserDetailsResponse {
     success: boolean;
@@ -510,6 +515,84 @@ declare class ZyfaiSDK {
      * ```
      */
     updateUserProfile(request: UpdateUserProfileRequest): 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);
+     * ```
+     */
+    pauseAgent(): Promise<UpdateUserProfileResponse>;
+    /**
+     * Enable splitting for the user's account
+     * When enabled, deposits are split across multiple protocols based on minSplits setting
+     *
+     * @param minSplits - Optional minimum number of protocols to split across (default: 3)
+     * @returns Response indicating success and updated user details
+     *
+     * @example
+     * ```typescript
+     * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+     *
+     * // Connect account first
+     * await sdk.connectAccount(privateKey, chainId);
+     *
+     * // Enable splitting with minimum 3 protocols
+     * const result = await sdk.enableSplitting(3);
+     * console.log('Splitting enabled:', result.success);
+     * ```
+     */
+    enableSplitting(minSplits?: number): Promise<UpdateUserProfileResponse>;
+    /**
+     * Disable splitting for the user's account
+     * When disabled, deposits will not be split across multiple protocols
+     *
+     * @returns Response indicating success and updated user details
+     *
+     * @example
+     * ```typescript
+     * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+     *
+     * // Connect account first
+     * await sdk.connectAccount(privateKey, chainId);
+     *
+     * // Disable splitting
+     * const result = await sdk.disableSplitting();
+     * console.log('Splitting disabled:', result.success);
+     * ```
+     */
+    disableSplitting(): Promise<UpdateUserProfileResponse>;
+    /**
+     * Update the minimum number of splits for the user's account
+     * This controls across how many protocols deposits should be distributed
+     *
+     * @param minSplits - Minimum number of protocols to split across
+     * @returns Response indicating success and updated user details
+     *
+     * @example
+     * ```typescript
+     * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+     *
+     * // Connect account first
+     * await sdk.connectAccount(privateKey, chainId);
+     *
+     * // Update minimum splits to 5
+     * const result = await sdk.updateMinSplits(5);
+     * console.log('Min splits updated:', result.success);
+     * ```
+     */
+    updateMinSplits(minSplits: number): Promise<UpdateUserProfileResponse>;
     /**
      * Initialize user after Safe deployment
      * This method is automatically called after deploySafe to initialize user state

package/dist/index.js

@@ -793,6 +793,124 @@ var ZyfaiSDK = class {
       );
     }
   }
+  /**
+   * 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 pauseAgent() {
+    try {
+      const response = await this.updateUserProfile({
+        protocols: []
+      });
+      return response;
+    } catch (error) {
+      throw new Error(`Failed to pause agent: ${error.message}`);
+    }
+  }
+  /**
+   * Enable splitting for the user's account
+   * When enabled, deposits are split across multiple protocols based on minSplits setting
+   *
+   * @param minSplits - Optional minimum number of protocols to split across (default: 3)
+   * @returns Response indicating success and updated user details
+   *
+   * @example
+   * ```typescript
+   * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+   *
+   * // Connect account first
+   * await sdk.connectAccount(privateKey, chainId);
+   *
+   * // Enable splitting with minimum 3 protocols
+   * const result = await sdk.enableSplitting(3);
+   * console.log('Splitting enabled:', result.success);
+   * ```
+   */
+  async enableSplitting(minSplits = 3) {
+    try {
+      const response = await this.updateUserProfile({
+        splitting: true,
+        minSplits
+      });
+      return response;
+    } catch (error) {
+      throw new Error(`Failed to enable splitting: ${error.message}`);
+    }
+  }
+  /**
+   * Disable splitting for the user's account
+   * When disabled, deposits will not be split across multiple protocols
+   *
+   * @returns Response indicating success and updated user details
+   *
+   * @example
+   * ```typescript
+   * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+   *
+   * // Connect account first
+   * await sdk.connectAccount(privateKey, chainId);
+   *
+   * // Disable splitting
+   * const result = await sdk.disableSplitting();
+   * console.log('Splitting disabled:', result.success);
+   * ```
+   */
+  async disableSplitting() {
+    try {
+      const response = await this.updateUserProfile({
+        splitting: false
+      });
+      return response;
+    } catch (error) {
+      throw new Error(`Failed to disable splitting: ${error.message}`);
+    }
+  }
+  /**
+   * Update the minimum number of splits for the user's account
+   * This controls across how many protocols deposits should be distributed
+   *
+   * @param minSplits - Minimum number of protocols to split across
+   * @returns Response indicating success and updated user details
+   *
+   * @example
+   * ```typescript
+   * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+   *
+   * // Connect account first
+   * await sdk.connectAccount(privateKey, chainId);
+   *
+   * // Update minimum splits to 5
+   * const result = await sdk.updateMinSplits(5);
+   * console.log('Min splits updated:', result.success);
+   * ```
+   */
+  async updateMinSplits(minSplits) {
+    try {
+      if (minSplits < 1) {
+        throw new Error("minSplits must be at least 1");
+      }
+      const response = await this.updateUserProfile({
+        minSplits
+      });
+      return response;
+    } catch (error) {
+      throw new Error(`Failed to update min splits: ${error.message}`);
+    }
+  }
   /**
    * Initialize user after Safe deployment
    * This method is automatically called after deploySafe to initialize user state

package/dist/index.mjs

@@ -770,6 +770,124 @@ var ZyfaiSDK = class {
       );
     }
   }
+  /**
+   * 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 pauseAgent() {
+    try {
+      const response = await this.updateUserProfile({
+        protocols: []
+      });
+      return response;
+    } catch (error) {
+      throw new Error(`Failed to pause agent: ${error.message}`);
+    }
+  }
+  /**
+   * Enable splitting for the user's account
+   * When enabled, deposits are split across multiple protocols based on minSplits setting
+   *
+   * @param minSplits - Optional minimum number of protocols to split across (default: 3)
+   * @returns Response indicating success and updated user details
+   *
+   * @example
+   * ```typescript
+   * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+   *
+   * // Connect account first
+   * await sdk.connectAccount(privateKey, chainId);
+   *
+   * // Enable splitting with minimum 3 protocols
+   * const result = await sdk.enableSplitting(3);
+   * console.log('Splitting enabled:', result.success);
+   * ```
+   */
+  async enableSplitting(minSplits = 3) {
+    try {
+      const response = await this.updateUserProfile({
+        splitting: true,
+        minSplits
+      });
+      return response;
+    } catch (error) {
+      throw new Error(`Failed to enable splitting: ${error.message}`);
+    }
+  }
+  /**
+   * Disable splitting for the user's account
+   * When disabled, deposits will not be split across multiple protocols
+   *
+   * @returns Response indicating success and updated user details
+   *
+   * @example
+   * ```typescript
+   * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+   *
+   * // Connect account first
+   * await sdk.connectAccount(privateKey, chainId);
+   *
+   * // Disable splitting
+   * const result = await sdk.disableSplitting();
+   * console.log('Splitting disabled:', result.success);
+   * ```
+   */
+  async disableSplitting() {
+    try {
+      const response = await this.updateUserProfile({
+        splitting: false
+      });
+      return response;
+    } catch (error) {
+      throw new Error(`Failed to disable splitting: ${error.message}`);
+    }
+  }
+  /**
+   * Update the minimum number of splits for the user's account
+   * This controls across how many protocols deposits should be distributed
+   *
+   * @param minSplits - Minimum number of protocols to split across
+   * @returns Response indicating success and updated user details
+   *
+   * @example
+   * ```typescript
+   * const sdk = new ZyfaiSDK({ apiKey: 'your-api-key' });
+   *
+   * // Connect account first
+   * await sdk.connectAccount(privateKey, chainId);
+   *
+   * // Update minimum splits to 5
+   * const result = await sdk.updateMinSplits(5);
+   * console.log('Min splits updated:', result.success);
+   * ```
+   */
+  async updateMinSplits(minSplits) {
+    try {
+      if (minSplits < 1) {
+        throw new Error("minSplits must be at least 1");
+      }
+      const response = await this.updateUserProfile({
+        minSplits
+      });
+      return response;
+    } catch (error) {
+      throw new Error(`Failed to update min splits: ${error.message}`);
+    }
+  }
   /**
    * Initialize user after Safe deployment
    * This method is automatically called after deploySafe to initialize user state

package/package.json

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