npm - @obolnetwork/obol-sdk - Versions diffs - 2.7.0 → 2.8.1 - Mend

@obolnetwork/obol-sdk 2.7.0 → 2.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (56) hide show

package/dist/cjs/package.json +1 -1
package/dist/cjs/src/abi/OVMFactory.js +620 -0
package/dist/cjs/src/abi/splitV2FactoryAbi.js +420 -0
package/dist/cjs/src/ajv.js +33 -6
package/dist/cjs/src/bytecodes.js +10 -1
package/dist/cjs/src/constants.js +71 -15
package/dist/cjs/src/index.js +21 -9
package/dist/cjs/src/schema.js +70 -1
package/dist/cjs/src/splits/splitHelpers.js +188 -14
package/dist/cjs/src/splits/splits.js +283 -0
package/dist/cjs/src/types.js +0 -1
package/dist/cjs/test/client/ajv.spec.js +269 -0
package/dist/cjs/test/client/methods.spec.js +418 -0
package/dist/cjs/test/fixtures.js +13 -1
package/dist/cjs/test/splits/splits.spec.js +239 -0
package/dist/esm/package.json +1 -1
package/dist/esm/src/abi/OVMFactory.js +617 -0
package/dist/esm/src/abi/splitV2FactoryAbi.js +417 -0
package/dist/esm/src/ajv.js +33 -6
package/dist/esm/src/bytecodes.js +9 -0
package/dist/esm/src/constants.js +70 -15
package/dist/esm/src/index.js +20 -9
package/dist/esm/src/schema.js +70 -1
package/dist/esm/src/splits/splitHelpers.js +182 -13
package/dist/esm/src/splits/splits.js +279 -0
package/dist/esm/src/types.js +0 -1
package/dist/esm/test/client/ajv.spec.js +267 -0
package/dist/esm/test/client/methods.spec.js +393 -0
package/dist/esm/test/fixtures.js +12 -0
package/dist/esm/test/splits/splits.spec.js +237 -0
package/dist/types/src/abi/OVMFactory.d.ts +662 -0
package/dist/types/src/abi/splitV2FactoryAbi.d.ts +60 -0
package/dist/types/src/bytecodes.d.ts +9 -0
package/dist/types/src/constants.d.ts +10 -21
package/dist/types/src/exits/verificationHelpers.d.ts +1 -0
package/dist/types/src/index.d.ts +7 -0
package/dist/types/src/schema.d.ts +145 -0
package/dist/types/src/splits/splitHelpers.d.ts +39 -2
package/dist/types/src/splits/splits.d.ts +51 -0
package/dist/types/src/types.d.ts +87 -2
package/dist/types/src/verification/common.d.ts +1 -0
package/dist/types/test/client/ajv.spec.d.ts +1 -0
package/dist/types/test/client/methods.spec.d.ts +1 -0
package/dist/types/test/fixtures.d.ts +10 -0
package/dist/types/test/splits/splits.spec.d.ts +1 -0
package/package.json +1 -1
package/src/abi/OVMFactory.ts +617 -0
package/src/abi/splitV2FactoryAbi.ts +417 -0
package/src/ajv.ts +55 -13
package/src/bytecodes.ts +19 -0
package/src/constants.ts +84 -16
package/src/index.ts +36 -15
package/src/schema.ts +79 -0
package/src/splits/splitHelpers.ts +373 -18
package/src/splits/splits.ts +406 -0
package/src/types.ts +100 -3

package/dist/esm/src/abi/splitV2FactoryAbi.js ADDED Viewed

@@ -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/dist/esm/src/ajv.js CHANGED Viewed

@@ -13,18 +13,26 @@ export const VALID_NON_COMPOUNDING_AMOUNTS = [
     parseUnits('1', 'gwei').toString(),
     parseUnits('32', 'gwei').toString(),
 ];
-// They dont see defaults set in schema
+const calculateTotalPercentage = (recipients) => {
+    return recipients.reduce((acc, curr) => acc + curr.percentAllocation, 0);
+};
+const validateTotalPercentage = (totalPercentage) => {
+    return totalPercentage === 100;
+};
+const validateTotalPercentageWithRAF = (totalPercentage, rafPercentage) => {
+    return totalPercentage + rafPercentage === 100;
+};
 const validateRewardsSplitRecipients = (_, data) => {
     var _a;
-    const obolRAFSplit = (_a = data.ObolRAFSplit) !== null && _a !== void 0 ? _a : DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT;
-    const splitPercentage = data.splitRecipients.reduce((acc, curr) => acc + curr.percentAllocation, 0);
-    return splitPercentage + obolRAFSplit === 100;
+    const obolRAFSplit = (_a = data === null || data === void 0 ? void 0 : data.ObolRAFSplit) !== null && _a !== void 0 ? _a : DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT;
+    const splitPercentage = calculateTotalPercentage(data.splitRecipients);
+    return validateTotalPercentageWithRAF(splitPercentage, obolRAFSplit);
 };
 const validateTotalSplitRecipients = (_, data) => {
     var _a;
     const obolRAFSplit = (_a = data.ObolRAFSplit) !== null && _a !== void 0 ? _a : DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT;
-    const splitPercentage = data.splitRecipients.reduce((acc, curr) => acc + curr.percentAllocation, 0);
-    return splitPercentage + obolRAFSplit === 100;
+    const splitPercentage = calculateTotalPercentage(data.splitRecipients);
+    return validateTotalPercentageWithRAF(splitPercentage, obolRAFSplit);
 };
 const validateUniqueAddresses = (_, operators) => {
     if (!operators) {
@@ -44,6 +52,15 @@ const validateUniqueAddresses = (_, operators) => {
     const isUnique = uniqueAddresses.size === addresses.length;
     return isUnique;
 };
+const validateOVMRewardsSplitRecipients = (_, data) => {
+    const obolRAFSplit = DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT;
+    const splitPercentage = calculateTotalPercentage(data.rewardSplitRecipients);
+    return validateTotalPercentageWithRAF(splitPercentage, obolRAFSplit);
+};
+const validateOVMTotalSplitRecipients = (_, data) => {
+    const splitPercentage = calculateTotalPercentage(data.principalSplitRecipients);
+    return validateTotalPercentage(splitPercentage);
+};
 const ajv = new Ajv({
     allErrors: true,
     useDefaults: true,
@@ -67,6 +84,16 @@ ajv.addKeyword({
     validate: validateUniqueAddresses,
     schemaType: 'boolean',
 });
+ajv.addKeyword({
+    keyword: 'validateOVMRewardsSplitRecipients',
+    validate: validateOVMRewardsSplitRecipients,
+    schemaType: 'boolean',
+});
+ajv.addKeyword({
+    keyword: 'validateOVMTotalSplitRecipients',
+    validate: validateOVMTotalSplitRecipients,
+    schemaType: 'boolean',
+});
 export function validatePayload(data, schema) {
     var _a;
     const validate = ajv.compile(schema);