@zyfai/sdk 0.2.7 → 0.2.8

package/README.md

@@ -492,6 +492,54 @@ console.log("Active protocols:", userDetails.user.protocols.length); // Should b
 - 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

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;
@@ -529,6 +534,65 @@ declare class ZyfaiSDK {
      * ```
      */
     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;
@@ -529,6 +534,65 @@ declare class ZyfaiSDK {
      * ```
      */
     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

@@ -821,6 +821,96 @@ var ZyfaiSDK = class {
       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

@@ -798,6 +798,96 @@ var ZyfaiSDK = class {
       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.7",
+  "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",