@obolnetwork/obol-sdk 2.7.0 → 2.8.1

package/dist/cjs/test/splits/splits.spec.js

@@ -0,0 +1,239 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const src_1 = require("../../src");
+const constants_1 = require("../../src/constants");
+const splitHelpers_1 = require("../../src/splits/splitHelpers");
+const utils_1 = require("../../src/utils");
+const fixtures_1 = require("../fixtures");
+// Mock the split helpers
+jest.mock('../../src/splits/splitHelpers', () => ({
+    formatRecipientsForSplitV2: jest.fn(),
+    predictSplitV2Address: jest.fn(),
+    isSplitV2Deployed: jest.fn(),
+    deployOVMContract: jest.fn(),
+    deployOVMAndSplitV2: jest.fn(),
+}));
+// Mock the utils
+jest.mock('../../src/utils', () => ({
+    isContractAvailable: jest.fn(),
+}));
+// Mock the validation
+jest.mock('../../src/ajv', () => ({
+    validatePayload: jest.fn(data => data),
+}));
+// Type the mocked functions
+const mockFormatRecipientsForSplitV2 = splitHelpers_1.formatRecipientsForSplitV2;
+const mockPredictSplitV2Address = splitHelpers_1.predictSplitV2Address;
+const mockIsSplitV2Deployed = splitHelpers_1.isSplitV2Deployed;
+const mockDeployOVMAndSplitV2 = splitHelpers_1.deployOVMAndSplitV2;
+const mockDeployOVMContract = splitHelpers_1.deployOVMContract;
+const mockIsContractAvailable = utils_1.isContractAvailable;
+describe('ObolSplits', () => {
+    let client;
+    let mockSigner;
+    let mockProvider;
+    beforeEach(() => {
+        // Clear all mocks before each test
+        jest.clearAllMocks();
+        mockSigner = {
+            getAddress: jest
+                .fn()
+                .mockResolvedValue('0x1234567890123456789012345678901234567890'),
+            signTypedData: jest.fn().mockResolvedValue('0xsigned'),
+            provider: {
+                getCode: jest.fn().mockResolvedValue('0x123456'),
+            },
+        };
+        mockProvider = {
+            getCode: jest.fn().mockResolvedValue('0x123456'),
+        };
+        client = new src_1.Client({ chainId: 1 }, mockSigner, mockProvider);
+    });
+    describe('createValidatorManagerAndRewardsSplit', () => {
+        const mockRewardsSplitPayload = {
+            rewardSplitRecipients: [
+                { address: fixtures_1.TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
+                { address: fixtures_1.TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
+            ],
+            OVMOwnerAddress: fixtures_1.TEST_ADDRESSES.OVM_OWNER,
+            splitOwnerAddress: fixtures_1.TEST_ADDRESSES.SPLIT_OWNER,
+            principalRecipient: fixtures_1.TEST_ADDRESSES.PRINCIPAL_RECIPIENT,
+            distributorFeePercent: 0,
+        };
+        it('should create rewards-only split successfully', () => __awaiter(void 0, void 0, void 0, function* () {
+            // Mock helper functions
+            mockFormatRecipientsForSplitV2.mockReturnValue([
+                { address: fixtures_1.TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
+                { address: fixtures_1.TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
+                {
+                    address: '0xDe5aE4De36c966747Ea7DF13BD9589642e2B1D0d',
+                    percentAllocation: 1,
+                },
+            ]);
+            mockPredictSplitV2Address.mockResolvedValue('0xRewardsSplitAddress');
+            mockIsSplitV2Deployed.mockResolvedValue(false);
+            mockDeployOVMAndSplitV2.mockResolvedValue('0xOVMAddress');
+            mockIsContractAvailable.mockResolvedValue(true);
+            const result = yield client.splits.createValidatorManagerAndRewardsSplit(mockRewardsSplitPayload);
+            expect(result).toEqual({
+                withdrawal_address: '0xOVMAddress',
+                fee_recipient_address: '0xRewardsSplitAddress',
+            });
+            expect(mockFormatRecipientsForSplitV2).toHaveBeenCalled();
+            expect(mockPredictSplitV2Address).toHaveBeenCalled();
+            expect(mockIsSplitV2Deployed).toHaveBeenCalled();
+            expect(mockDeployOVMAndSplitV2).toHaveBeenCalled();
+        }));
+        it('should throw error when signer is not provided', () => __awaiter(void 0, void 0, void 0, function* () {
+            const clientWithoutSigner = new src_1.Client({ chainId: 1 }, undefined, mockProvider);
+            yield expect(clientWithoutSigner.splits.createValidatorManagerAndRewardsSplit(mockRewardsSplitPayload)).rejects.toThrow('Signer is required in createValidatorManagerAndRewardsSplit');
+        }));
+        it('should throw error when chain is not supported', () => __awaiter(void 0, void 0, void 0, function* () {
+            const clientUnsupportedChain = new src_1.Client({ chainId: 999 }, mockSigner, mockProvider);
+            yield expect(clientUnsupportedChain.splits.createValidatorManagerAndRewardsSplit(mockRewardsSplitPayload)).rejects.toThrow('Splitter configuration is not supported on 999 chain');
+        }));
+        it('should throw error when OVM factory is not configured', () => __awaiter(void 0, void 0, void 0, function* () {
+            // Mock chain configuration without OVM factory
+            const originalConfig = constants_1.CHAIN_CONFIGURATION[1];
+            // Create a new config object without OVM_FACTORY_CONTRACT
+            const configWithoutOVM = Object.assign({}, originalConfig);
+            delete configWithoutOVM.OVM_FACTORY_CONTRACT;
+            constants_1.CHAIN_CONFIGURATION[1] = configWithoutOVM;
+            yield expect(client.splits.createValidatorManagerAndRewardsSplit(mockRewardsSplitPayload)).rejects.toThrow('OVM contract factory is not configured for chain 1');
+            // Restore original config
+            constants_1.CHAIN_CONFIGURATION[1] = originalConfig;
+        }));
+    });
+    describe('createValidatorManagerAndTotalSplit', () => {
+        const mockTotalSplitPayload = {
+            rewardSplitRecipients: [
+                { address: fixtures_1.TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
+                { address: fixtures_1.TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
+            ],
+            principalSplitRecipients: [
+                {
+                    address: fixtures_1.TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
+                    percentAllocation: 60,
+                },
+                {
+                    address: fixtures_1.TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
+                    percentAllocation: 40,
+                },
+            ],
+            OVMOwnerAddress: fixtures_1.TEST_ADDRESSES.OVM_OWNER,
+            splitOwnerAddress: fixtures_1.TEST_ADDRESSES.SPLIT_OWNER,
+            distributorFeePercent: 0,
+        };
+        it('should create total split successfully', () => __awaiter(void 0, void 0, void 0, function* () {
+            // Mock helper functions
+            mockFormatRecipientsForSplitV2
+                .mockReturnValueOnce([
+                // rewards recipients
+                { address: fixtures_1.TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
+                { address: fixtures_1.TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
+                {
+                    address: '0xDe5aE4De36c966747Ea7DF13BD9589642e2B1D0d',
+                    percentAllocation: 1,
+                },
+            ])
+                .mockReturnValueOnce([
+                // principal recipients
+                {
+                    address: fixtures_1.TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
+                    percentAllocation: 60,
+                },
+                {
+                    address: fixtures_1.TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
+                    percentAllocation: 40,
+                },
+            ]);
+            mockPredictSplitV2Address
+                .mockResolvedValueOnce('0xRewardsSplitAddress')
+                .mockResolvedValueOnce('0xPrincipalSplitAddress');
+            mockIsSplitV2Deployed
+                .mockResolvedValueOnce(false) // rewards split not deployed
+                .mockResolvedValueOnce(false); // principal split not deployed
+            mockDeployOVMAndSplitV2.mockResolvedValue('0xOVMAddress');
+            mockIsContractAvailable.mockResolvedValue(true);
+            const result = yield client.splits.createValidatorManagerAndTotalSplit(mockTotalSplitPayload);
+            expect(result).toEqual({
+                withdrawal_address: '0xOVMAddress',
+                fee_recipient_address: '0xRewardsSplitAddress',
+            });
+            expect(mockFormatRecipientsForSplitV2).toHaveBeenCalledTimes(2);
+            expect(mockPredictSplitV2Address).toHaveBeenCalledTimes(2);
+            expect(mockIsSplitV2Deployed).toHaveBeenCalledTimes(2);
+            expect(mockDeployOVMAndSplitV2).toHaveBeenCalled();
+        }));
+        it('should handle case when both splits are already deployed', () => __awaiter(void 0, void 0, void 0, function* () {
+            // Mock helper functions
+            mockFormatRecipientsForSplitV2
+                .mockReturnValueOnce([
+                // rewards recipients
+                { address: fixtures_1.TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
+                { address: fixtures_1.TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
+                {
+                    address: '0xDe5aE4De36c966747Ea7DF13BD9589642e2B1D0d',
+                    percentAllocation: 1,
+                },
+            ])
+                .mockReturnValueOnce([
+                // principal recipients
+                {
+                    address: fixtures_1.TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
+                    percentAllocation: 60,
+                },
+                {
+                    address: fixtures_1.TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
+                    percentAllocation: 40,
+                },
+            ]);
+            mockPredictSplitV2Address
+                .mockResolvedValueOnce('0xRewardsSplitAddress')
+                .mockResolvedValueOnce('0xPrincipalSplitAddress');
+            mockIsSplitV2Deployed
+                .mockResolvedValueOnce(true) // rewards split deployed
+                .mockResolvedValueOnce(true); // principal split deployed
+            mockDeployOVMContract.mockResolvedValue('0xOVMAddress');
+            mockIsContractAvailable.mockResolvedValue(true);
+            const result = yield client.splits.createValidatorManagerAndTotalSplit(mockTotalSplitPayload);
+            expect(result).toEqual({
+                withdrawal_address: '0xOVMAddress',
+                fee_recipient_address: '0xRewardsSplitAddress',
+            });
+            expect(mockDeployOVMContract).toHaveBeenCalledWith({
+                OVMOwnerAddress: mockTotalSplitPayload.OVMOwnerAddress,
+                principalRecipient: '0xPrincipalSplitAddress',
+                rewardRecipient: '0xRewardsSplitAddress',
+                principalThreshold: mockTotalSplitPayload.principalThreshold,
+                signer: mockSigner,
+                chainId: 1,
+            });
+        }));
+        it('should throw error when signer is not provided', () => __awaiter(void 0, void 0, void 0, function* () {
+            const clientWithoutSigner = new src_1.Client({ chainId: 1 }, undefined, mockProvider);
+            yield expect(clientWithoutSigner.splits.createValidatorManagerAndTotalSplit(mockTotalSplitPayload)).rejects.toThrow('Signer is required in createValidatorManagerAndTotalSplit');
+        }));
+        it('should throw error when chain is not supported', () => __awaiter(void 0, void 0, void 0, function* () {
+            const clientUnsupportedChain = new src_1.Client({ chainId: 999 }, mockSigner, mockProvider);
+            yield expect(clientUnsupportedChain.splits.createValidatorManagerAndTotalSplit(mockTotalSplitPayload)).rejects.toThrow('Splitter configuration is not supported on 999 chain');
+        }));
+    });
+    describe('constructor', () => {
+        it('should create Client instance with splits property', () => {
+            const testClient = new src_1.Client({ chainId: 1 }, mockSigner, mockProvider);
+            expect(testClient.splits).toBeDefined();
+            expect(testClient.splits.chainId).toBe(1);
+            expect(testClient.splits.provider).toBe(mockProvider);
+        });
+    });
+});

package/dist/esm/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@obolnetwork/obol-sdk",
-    "version": "2.7.0",
+    "version": "2.8.1",
     "description": "A package for creating Distributed Validators using the Obol API.",
     "bugs": {
         "url": "https://github.com/obolnetwork/obol-sdk/issues"