@obolnetwork/obol-sdk 2.7.0 → 2.8.1

package/src/abi/splitV2FactoryAbi.ts

@@ -0,0 +1,417 @@
+export const splitV2FactoryAbi = [
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: '_splitsWarehouse',
+        type: 'address',
+      },
+    ],
+    stateMutability: 'nonpayable',
+    type: 'constructor',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'split',
+        type: 'address',
+      },
+      {
+        components: [
+          {
+            internalType: 'address[]',
+            name: 'recipients',
+            type: 'address[]',
+          },
+          {
+            internalType: 'uint256[]',
+            name: 'allocations',
+            type: 'uint256[]',
+          },
+          {
+            internalType: 'uint256',
+            name: 'totalAllocation',
+            type: 'uint256',
+          },
+          {
+            internalType: 'uint16',
+            name: 'distributionIncentive',
+            type: 'uint16',
+          },
+        ],
+        indexed: false,
+        internalType: 'struct SplitV2Lib.Split',
+        name: 'splitParams',
+        type: 'tuple',
+      },
+      {
+        indexed: false,
+        internalType: 'address',
+        name: 'owner',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        internalType: 'address',
+        name: 'creator',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        internalType: 'bytes32',
+        name: 'salt',
+        type: 'bytes32',
+      },
+    ],
+    name: 'SplitCreated',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'split',
+        type: 'address',
+      },
+      {
+        components: [
+          {
+            internalType: 'address[]',
+            name: 'recipients',
+            type: 'address[]',
+          },
+          {
+            internalType: 'uint256[]',
+            name: 'allocations',
+            type: 'uint256[]',
+          },
+          {
+            internalType: 'uint256',
+            name: 'totalAllocation',
+            type: 'uint256',
+          },
+          {
+            internalType: 'uint16',
+            name: 'distributionIncentive',
+            type: 'uint16',
+          },
+        ],
+        indexed: false,
+        internalType: 'struct SplitV2Lib.Split',
+        name: 'splitParams',
+        type: 'tuple',
+      },
+      {
+        indexed: false,
+        internalType: 'address',
+        name: 'owner',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        internalType: 'address',
+        name: 'creator',
+        type: 'address',
+      },
+    ],
+    name: 'SplitCreated',
+    type: 'event',
+  },
+  {
+    inputs: [],
+    name: 'SPLIT_WALLET_IMPLEMENTATION',
+    outputs: [
+      {
+        internalType: 'address',
+        name: '',
+        type: 'address',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        components: [
+          {
+            internalType: 'address[]',
+            name: 'recipients',
+            type: 'address[]',
+          },
+          {
+            internalType: 'uint256[]',
+            name: 'allocations',
+            type: 'uint256[]',
+          },
+          {
+            internalType: 'uint256',
+            name: 'totalAllocation',
+            type: 'uint256',
+          },
+          {
+            internalType: 'uint16',
+            name: 'distributionIncentive',
+            type: 'uint16',
+          },
+        ],
+        internalType: 'struct SplitV2Lib.Split',
+        name: '_splitParams',
+        type: 'tuple',
+      },
+      {
+        internalType: 'address',
+        name: '_owner',
+        type: 'address',
+      },
+      {
+        internalType: 'address',
+        name: '_creator',
+        type: 'address',
+      },
+    ],
+    name: 'createSplit',
+    outputs: [
+      {
+        internalType: 'address',
+        name: 'split',
+        type: 'address',
+      },
+    ],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        components: [
+          {
+            internalType: 'address[]',
+            name: 'recipients',
+            type: 'address[]',
+          },
+          {
+            internalType: 'uint256[]',
+            name: 'allocations',
+            type: 'uint256[]',
+          },
+          {
+            internalType: 'uint256',
+            name: 'totalAllocation',
+            type: 'uint256',
+          },
+          {
+            internalType: 'uint16',
+            name: 'distributionIncentive',
+            type: 'uint16',
+          },
+        ],
+        internalType: 'struct SplitV2Lib.Split',
+        name: '_splitParams',
+        type: 'tuple',
+      },
+      {
+        internalType: 'address',
+        name: '_owner',
+        type: 'address',
+      },
+      {
+        internalType: 'address',
+        name: '_creator',
+        type: 'address',
+      },
+      {
+        internalType: 'bytes32',
+        name: '_salt',
+        type: 'bytes32',
+      },
+    ],
+    name: 'createSplitDeterministic',
+    outputs: [
+      {
+        internalType: 'address',
+        name: 'split',
+        type: 'address',
+      },
+    ],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        components: [
+          {
+            internalType: 'address[]',
+            name: 'recipients',
+            type: 'address[]',
+          },
+          {
+            internalType: 'uint256[]',
+            name: 'allocations',
+            type: 'uint256[]',
+          },
+          {
+            internalType: 'uint256',
+            name: 'totalAllocation',
+            type: 'uint256',
+          },
+          {
+            internalType: 'uint16',
+            name: 'distributionIncentive',
+            type: 'uint16',
+          },
+        ],
+        internalType: 'struct SplitV2Lib.Split',
+        name: '_splitParams',
+        type: 'tuple',
+      },
+      {
+        internalType: 'address',
+        name: '_owner',
+        type: 'address',
+      },
+      {
+        internalType: 'bytes32',
+        name: '_salt',
+        type: 'bytes32',
+      },
+    ],
+    name: 'isDeployed',
+    outputs: [
+      {
+        internalType: 'address',
+        name: 'split',
+        type: 'address',
+      },
+      {
+        internalType: 'bool',
+        name: 'exists',
+        type: 'bool',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'bytes32',
+        name: '_hash',
+        type: 'bytes32',
+      },
+    ],
+    name: 'nonces',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        components: [
+          {
+            internalType: 'address[]',
+            name: 'recipients',
+            type: 'address[]',
+          },
+          {
+            internalType: 'uint256[]',
+            name: 'allocations',
+            type: 'uint256[]',
+          },
+          {
+            internalType: 'uint256',
+            name: 'totalAllocation',
+            type: 'uint256',
+          },
+          {
+            internalType: 'uint16',
+            name: 'distributionIncentive',
+            type: 'uint16',
+          },
+        ],
+        internalType: 'struct SplitV2Lib.Split',
+        name: '_splitParams',
+        type: 'tuple',
+      },
+      {
+        internalType: 'address',
+        name: '_owner',
+        type: 'address',
+      },
+    ],
+    name: 'predictDeterministicAddress',
+    outputs: [
+      {
+        internalType: 'address',
+        name: '',
+        type: 'address',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        components: [
+          {
+            internalType: 'address[]',
+            name: 'recipients',
+            type: 'address[]',
+          },
+          {
+            internalType: 'uint256[]',
+            name: 'allocations',
+            type: 'uint256[]',
+          },
+          {
+            internalType: 'uint256',
+            name: 'totalAllocation',
+            type: 'uint256',
+          },
+          {
+            internalType: 'uint16',
+            name: 'distributionIncentive',
+            type: 'uint16',
+          },
+        ],
+        internalType: 'struct SplitV2Lib.Split',
+        name: '_splitParams',
+        type: 'tuple',
+      },
+      {
+        internalType: 'address',
+        name: '_owner',
+        type: 'address',
+      },
+      {
+        internalType: 'bytes32',
+        name: '_salt',
+        type: 'bytes32',
+      },
+    ],
+    name: 'predictDeterministicAddress',
+    outputs: [
+      {
+        internalType: 'address',
+        name: '',
+        type: 'address',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+];

package/src/ajv.ts

@@ -2,8 +2,9 @@ import addFormats from 'ajv-formats';
 import addKeywords from 'ajv-keywords';
 import { parseUnits } from 'ethers';
 import {
+  type OVMRewardsSplitPayload,
+  type OVMTotalSplitPayload,
   type RewardsSplitPayload,
-  type SplitRecipient,
   type TotalSplitPayload,
 } from './types';
 import Ajv from 'ajv';
@@ -24,18 +25,31 @@ export const VALID_NON_COMPOUNDING_AMOUNTS = [
   parseUnits('32', 'gwei').toString(),
 ];
 
-// They dont see defaults set in schema
+const calculateTotalPercentage = (
+  recipients: Array<{ percentAllocation: number }>,
+): number => {
+  return recipients.reduce((acc, curr) => acc + curr.percentAllocation, 0);
+};
+
+const validateTotalPercentage = (totalPercentage: number): boolean => {
+  return totalPercentage === 100;
+};
+
+const validateTotalPercentageWithRAF = (
+  totalPercentage: number,
+  rafPercentage: number,
+): boolean => {
+  return totalPercentage + rafPercentage === 100;
+};
+
 const validateRewardsSplitRecipients = (
   _: boolean,
   data: RewardsSplitPayload,
 ): boolean => {
   const obolRAFSplit =
-    data.ObolRAFSplit ?? DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT;
-  const splitPercentage = data.splitRecipients.reduce(
-    (acc: number, curr: SplitRecipient) => acc + curr.percentAllocation,
-    0,
-  );
-  return splitPercentage + obolRAFSplit === 100;
+    data?.ObolRAFSplit ?? DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT;
+  const splitPercentage = calculateTotalPercentage(data.splitRecipients);
+  return validateTotalPercentageWithRAF(splitPercentage, obolRAFSplit);
 };
 
 const validateTotalSplitRecipients = (
@@ -44,11 +58,8 @@ const validateTotalSplitRecipients = (
 ): boolean => {
   const obolRAFSplit =
     data.ObolRAFSplit ?? DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT;
-  const splitPercentage = data.splitRecipients.reduce(
-    (acc: number, curr: SplitRecipient) => acc + curr.percentAllocation,
-    0,
-  );
-  return splitPercentage + obolRAFSplit === 100;
+  const splitPercentage = calculateTotalPercentage(data.splitRecipients);
+  return validateTotalPercentageWithRAF(splitPercentage, obolRAFSplit);
 };
 
 const validateUniqueAddresses = (
@@ -77,6 +88,25 @@ const validateUniqueAddresses = (
   return isUnique;
 };
 
+const validateOVMRewardsSplitRecipients = (
+  _: boolean,
+  data: OVMRewardsSplitPayload,
+): boolean => {
+  const obolRAFSplit = DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT;
+  const splitPercentage = calculateTotalPercentage(data.rewardSplitRecipients);
+  return validateTotalPercentageWithRAF(splitPercentage, obolRAFSplit);
+};
+
+const validateOVMTotalSplitRecipients = (
+  _: boolean,
+  data: OVMTotalSplitPayload,
+): boolean => {
+  const splitPercentage = calculateTotalPercentage(
+    data.principalSplitRecipients,
+  );
+  return validateTotalPercentage(splitPercentage);
+};
+
 const ajv = new Ajv({
   allErrors: true,
   useDefaults: true,
@@ -104,6 +134,18 @@ ajv.addKeyword({
   schemaType: 'boolean',
 });
 
+ajv.addKeyword({
+  keyword: 'validateOVMRewardsSplitRecipients',
+  validate: validateOVMRewardsSplitRecipients,
+  schemaType: 'boolean',
+});
+
+ajv.addKeyword({
+  keyword: 'validateOVMTotalSplitRecipients',
+  validate: validateOVMTotalSplitRecipients,
+  schemaType: 'boolean',
+});
+
 export function validatePayload<T>(data: unknown, schema: object): T {
   const validate = ajv.compile<T>(schema);
   const valid = validate(data);