updateMinSplits - Zyfai Documentation

Update the minimum number of splits for the user’s account. This controls across how many protocols deposits should be distributed. Requires SIWE authentication.

Signature

updateMinSplits(minSplits: number): Promise<UpdateUserProfileResponse>

Parameters

Parameter	Type	Required	Description
minSplits	number	Yes	Minimum number of protocols to split across (must be at least 1)

Returns

Response indicating success and updated user details

Return Type

interface UpdateUserProfileResponse {
  success: boolean;
  userId: string;
  smartWallet?: Address;
  chains?: number[];
  strategy?: string;
  protocols?: string[];
  autoSelectProtocols?: boolean;
  omniAccount?: boolean;
  autocompounding?: boolean;
  agentName?: string;
  crosschainStrategy?: boolean;
  executorProxy?: boolean;
  splitting?: boolean;
  minSplits?: number;
  customization?: Record<string, any>;
}

Example

await sdk.connectAccount(privateKey, chainId);

// Update minimum splits to 5
const result = await sdk.updateMinSplits(5);
console.log("Min splits updated:", result.success);

// Verify the update
const userDetails = await sdk.getUserDetails();
console.log("Min splits:", userDetails.minSplits); // 5

Notes

User must be authenticated (automatically done via connectAccount())
minSplits must be at least 1
Throws an error if minSplits is less than 1
This setting is only effective when splitting is enabled