fix tests

src/ajv.ts

@@ -1,7 +1,7 @@
 import Ajv, { type ErrorObject } from 'ajv';
 import { parseUnits } from 'ethers';
-import { RewardsSplitPayload, SplitRecipient } from './types';
-import { DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT } from './constants';
+import { RewardsSplitPayload, SplitRecipient, TotalSplitPayload } from './types';
+import { DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT, DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT } from './constants';
 
 const validDepositAmounts = (data: boolean, deposits: string[]): boolean => {
   let sum = 0;
@@ -30,13 +30,14 @@ const validDepositAmounts = (data: boolean, deposits: string[]): boolean => {
 
 const validateSplitRecipients = (
   _: boolean,
-  data: RewardsSplitPayload,
+  data: RewardsSplitPayload | TotalSplitPayload,
 ): boolean => {
   const splitPercentage = data.splitRecipients.reduce(
     (acc: number, curr: SplitRecipient) => acc + curr.percentAllocation,
     0,
   );
-  return splitPercentage + (data.ObolRAFSplit || DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT) === 100;
+  const ObolRAFSplitParam = data.ObolRAFSplit || ('principalRecipient' in data ? DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT : DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT)
+  return splitPercentage + ObolRAFSplitParam === 100;
 };
 
 export function validatePayload(

src/constants.ts

@@ -159,3 +159,5 @@ export const CHAIN_CONFIGURATION = {
 };
 
 export const DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT= 1
+
+export const DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT = 0.1;

src/index.ts

@@ -16,6 +16,7 @@ import {
   AVAILABLE_SPLITTER_CHAINS,
   CHAIN_CONFIGURATION,
   DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT,
+  DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT,
 } from './constants.js';
 import { ConflictError } from './errors.js';
 import {
@@ -25,17 +26,20 @@ import {
   type ClusterPayload,
   type OperatorPayload,
   type SplitterReturnedType,
+  TotalSplitPayload,
 } from './types.js';
 import { clusterConfigOrDefinitionHash } from './verification/common.js';
 import { validatePayload } from './ajv.js';
 import {
   definitionSchema,
   operatorPayloadSchema,
   rewardsSplitterPayloadSchema,
+  totalSplitterPayloadSchema,
 } from './schema.js';
 import {
+  deploySplitterContract,
   formatSplitRecipients,
-  handleDeployRewardsSplitter,
+  handleDeployOWRAndSplitter,
   predictSplitterAddress,
 } from './splitHelpers.js';
 import { isContractAvailable } from './utils.js';
@@ -124,7 +128,6 @@ export class Client extends Base {
     ObolRAFSplit = DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT,
     distributorFee = 0,
     controllerAddress = ZeroAddress,
-
   }: RewardsSplitPayload): Promise<SplitterReturnedType> {
     // This method doesnt require T&C signature
     if (!this.signer) {
@@ -150,7 +153,6 @@ export class Client extends Base {
       );
     }
 
-    // Double check the deployed addresses (not sure if needed)
     const checkSplitMainAddress = await isContractAvailable(
       CHAIN_CONFIGURATION[this.chainId].SPLITMAIN_ADDRESS,
       this.signer.provider as Provider,
@@ -187,19 +189,25 @@ export class Client extends Base {
     const { accounts, percentAllocations } = formatSplitRecipients(
       copiedSplitRecipients,
     );
+
     const predictedSplitterAddress = await predictSplitterAddress({
       signer: this.signer,
       accounts,
       percentAllocations,
       chainId: this.chainId,
-      distributorFee
+      distributorFee,
+      controllerAddress
     });
+
+
     const isSplitterDeployed = await isContractAvailable(
       predictedSplitterAddress,
       this.signer.provider as Provider,
     );
+
+
     const { withdrawalAddress, feeRecipientAddress } =
-      await handleDeployRewardsSplitter({
+      await handleDeployOWRAndSplitter({
         signer: this.signer,
         isSplitterDeployed: !!isSplitterDeployed,
         predictedSplitterAddress,
@@ -215,6 +223,96 @@ export class Client extends Base {
     return { withdrawalAddress, feeRecipientAddress };
   }
 
+  /**
+ * Deploys Splitter Proxy.
+ * @param {TotalSplitPayload} totalSplitPayload - Data needed to deploy splitter if it doesnt exist.
+ * @returns {Promise<SplitterReturnedType>} splitter address as withdrawal address and splitter as fee recipient too
+ */
+  // add the example reference
+  async createObolTotalSplit({
+    splitRecipients,
+    ObolRAFSplit = DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT,
+    distributorFee = 0,
+    controllerAddress = ZeroAddress,
+
+  }: TotalSplitPayload): Promise<SplitterReturnedType> {
+    // This method doesnt require T&C signature
+    if (!this.signer) {
+      throw new Error('Signer is required in createObolTotalSplit');
+    }
+
+    validatePayload(
+      {
+        splitRecipients,
+        ObolRAFSplit,
+        distributorFee,
+        controllerAddress
+      },
+      totalSplitterPayloadSchema,
+    );
+
+    // Check if we allow splitters on this chainId
+    if (!AVAILABLE_SPLITTER_CHAINS.includes(this.chainId)) {
+      throw new Error(
+        `Splitter configuration is not supported on ${this.chainId} chain`,
+      );
+    }
+
+    const checkSplitMainAddress = await isContractAvailable(
+      CHAIN_CONFIGURATION[this.chainId].SPLITMAIN_ADDRESS,
+      this.signer.provider as Provider,
+    )
+
+    if (
+      !checkSplitMainAddress
+    ) {
+      throw new Error(
+        'Something isn not working as expected, check this issue with obol-sdk team',
+      );
+    }
+
+    const retroActiveFundingRecipient = {
+      account: CHAIN_CONFIGURATION[this.chainId].RETROACTIVE_FUNDING_ADDRESS,
+      percentAllocation: ObolRAFSplit,
+    };
+
+    const copiedSplitRecipients = [...splitRecipients];
+    copiedSplitRecipients.push(retroActiveFundingRecipient);
+
+    const { accounts, percentAllocations } = formatSplitRecipients(
+      copiedSplitRecipients,
+    );
+    const predictedSplitterAddress = await predictSplitterAddress({
+      signer: this.signer,
+      accounts,
+      percentAllocations,
+      chainId: this.chainId,
+      distributorFee,
+      controllerAddress
+    });
+
+    const isSplitterDeployed = await isContractAvailable(
+      predictedSplitterAddress,
+      this.signer.provider as Provider,
+    );
+
+    if (!isSplitterDeployed) {
+      const splitterAddress =
+        await deploySplitterContract({
+          signer: this.signer,
+          accounts,
+          percentAllocations,
+          chainId: this.chainId,
+          distributorFee,
+          controllerAddress
+        });
+      return { withdrawalAddress: splitterAddress, feeRecipientAddress: splitterAddress };
+
+    }
+
+    return { withdrawalAddress: predictedSplitterAddress, feeRecipientAddress: predictedSplitterAddress };
+  }
+
   /**
    * Creates a cluster definition which contains cluster configuration.
    * @param {ClusterPayload} newCluster - The new unique cluster.

src/schema.ts

@@ -1,3 +1,5 @@
+import { DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT, DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT } from "./constants";
+
 export const operatorPayloadSchema = {
   type: 'object',
   properties: {
@@ -63,7 +65,7 @@ export const definitionSchema = {
   required: ['name', 'operators', 'validators'],
 };
 
-export const rewardsSplitterPayloadSchema = {
+export const totalSplitterPayloadSchema = {
   type: 'object',
   properties: {
     splitRecipients: {
@@ -82,17 +84,9 @@ export const rewardsSplitterPayloadSchema = {
         required: ['account', 'percentAllocation'],
       },
     },
-    principalRecipient: {
-      type: 'string',
-      minLength: 42,
-      maxLength: 42,
-    },
-    validatorsSize: {
-      type: 'number',
-    },
     ObolRAFSplit: {
       type: 'number',
-      minimum: 1
+      minimum: DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT
     },
     distributorFee: {
       type: "number",
@@ -106,5 +100,24 @@ export const rewardsSplitterPayloadSchema = {
     validateSplitRecipients: true,
 
   },
-  required: ['splitRecipients', 'principalRecipient', 'validatorsSize'], 
+  required: ['splitRecipients'],
+}
+
+export const rewardsSplitterPayloadSchema = {
+  ...totalSplitterPayloadSchema,
+  properties: {
+    ...totalSplitterPayloadSchema.properties,
+    ObolRAFSplit: {
+      type: 'number',
+      minimum: DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT
+    },
+    validatorsSize: {
+      type: 'number',
+    },
+    principalRecipient: {
+      type: 'string',
+      pattern: "^0x[a-fA-F0-9]{40}$"
+    }
+  },
+  required: ['splitRecipients', 'principalRecipient', 'validatorsSize'],
 }