@obolnetwork/obol-sdk 2.8.1 → 2.9.1

package/dist/cjs/package.json

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

package/dist/cjs/src/ajv.js

@@ -67,6 +67,24 @@ const validateOVMTotalSplitRecipients = (_, data) => {
     const splitPercentage = calculateTotalPercentage(data.principalSplitRecipients);
     return validateTotalPercentage(splitPercentage);
 };
+const validateOVMRequestWithdrawalPayload = (_, data) => {
+    if (!data.pubKeys || !data.amounts) {
+        return false;
+    }
+    if (data.pubKeys.length !== data.amounts.length) {
+        return false;
+    }
+    // // Validate that all amounts are at least 1,000,000 gwei
+    // const minAmount = BigInt(1000000);
+    // for (const amountStr of data.amounts) {
+    //   const minAmount = BigInt(1000000);
+    //   const amount = BigInt(amountStr);
+    //   if (amount < minAmount) {
+    //     return false;
+    //   }
+    // }
+    return true;
+};
 const ajv = new ajv_1.default({
     allErrors: true,
     useDefaults: true,
@@ -100,6 +118,11 @@ ajv.addKeyword({
     validate: validateOVMTotalSplitRecipients,
     schemaType: 'boolean',
 });
+ajv.addKeyword({
+    keyword: 'validateOVMRequestWithdrawalPayload',
+    validate: validateOVMRequestWithdrawalPayload,
+    schemaType: 'boolean',
+});
 function validatePayload(data, schema) {
     var _a;
     const validate = ajv.compile(schema);

package/dist/cjs/src/schema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ovmTotalSplitPayloadSchema = exports.ovmRewardsSplitPayloadSchema = exports.ovmBaseSplitPayload = exports.rewardsSplitterPayloadSchema = exports.totalSplitterPayloadSchema = exports.definitionSchema = exports.operatorPayloadSchema = void 0;
+exports.ovmRequestWithdrawalPayloadSchema = exports.ovmTotalSplitPayloadSchema = exports.ovmRewardsSplitPayloadSchema = exports.ovmBaseSplitPayload = exports.rewardsSplitterPayloadSchema = exports.totalSplitterPayloadSchema = exports.definitionSchema = exports.operatorPayloadSchema = void 0;
 const ethers_1 = require("ethers");
 const constants_1 = require("./constants");
 const ajv_1 = require("./ajv");
@@ -209,3 +209,34 @@ exports.ovmTotalSplitPayloadSchema = {
         'OVMOwnerAddress',
     ],
 };
+exports.ovmRequestWithdrawalPayloadSchema = {
+    type: 'object',
+    properties: {
+        withdrawalFees: {
+            type: 'string',
+            pattern: '^[0-9]+$',
+        },
+        ovmAddress: {
+            type: 'string',
+            pattern: '^0x[a-fA-F0-9]{40}$',
+        },
+        pubKeys: {
+            type: 'array',
+            minItems: 1,
+            items: {
+                type: 'string',
+                pattern: '^0x[a-fA-F0-9]{96}$', // 48 bytes = 96 hex chars + 0x prefix
+            },
+        },
+        amounts: {
+            type: 'array',
+            minItems: 1,
+            items: {
+                type: 'string',
+                pattern: '^[0-9]+$',
+            },
+        },
+    },
+    validateOVMRequestWithdrawalPayload: true,
+    required: ['ovmAddress', 'pubKeys', 'amounts', 'withdrawalFees'],
+};

package/dist/cjs/src/splits/splitHelpers.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deployOVMAndSplitV2 = exports.deployOVMContract = exports.isSplitV2Deployed = exports.predictSplitV2Address = exports.formatRecipientsForSplitV2 = exports.multicall = exports.getOWRTranches = exports.deploySplitterAndOWRContracts = exports.deploySplitterContract = exports.handleDeployOWRAndSplitter = exports.predictSplitterAddress = exports.formatSplitRecipients = void 0;
+exports.requestWithdrawalFromOVM = exports.deployOVMAndSplitV2 = exports.deployOVMContract = exports.isSplitV2Deployed = exports.predictSplitV2Address = exports.formatRecipientsForSplitV2 = exports.multicall = exports.getOWRTranches = exports.deploySplitterAndOWRContracts = exports.deploySplitterContract = exports.handleDeployOWRAndSplitter = exports.predictSplitterAddress = exports.formatSplitRecipients = void 0;
 const ethers_1 = require("ethers");
 const OWR_1 = require("../abi/OWR");
 const OVMFactory_1 = require("../abi/OVMFactory");
@@ -499,3 +499,28 @@ const getChainConfig = (chainId) => {
     }
     return config;
 };
+/**
+ * Requests withdrawal from an OVM contract
+ * @param ovmAddress - The address of the OVM contract
+ * @param pubKeys - Array of validator public keys in bytes format
+ * @param amounts - Array of withdrawal amounts in wei (uint64)
+ * @param signer - The signer to use for the transaction
+ * @returns Promise that resolves to the transaction hash
+ */
+const requestWithdrawalFromOVM = ({ ovmAddress, pubKeys, amounts, withdrawalFees, signer, }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _15;
+    try {
+        // Convert string amounts to bigint
+        const bigintAmounts = amounts.map(amount => BigInt(amount));
+        const ovmContract = new ethers_1.Contract(ovmAddress, OVMFactory_1.OVMContract.abi, signer);
+        const tx = yield ovmContract.requestWithdrawal(pubKeys, bigintAmounts, {
+            value: BigInt(withdrawalFees),
+        });
+        const receipt = yield tx.wait();
+        return { txHash: receipt.hash };
+    }
+    catch (error) {
+        throw new Error(`Failed to request withdrawal from OVM: ${(_15 = error.message) !== null && _15 !== void 0 ? _15 : 'Request withdrawal failed'}`);
+    }
+});
+exports.requestWithdrawalFromOVM = requestWithdrawalFromOVM;

package/dist/cjs/src/splits/splits.js

@@ -279,5 +279,45 @@ class ObolSplits {
             }
         });
     }
+    /**
+     * Requests withdrawal from an OVM contract.
+     *
+     * This method allows requesting withdrawal of validator funds from an OVM contract.
+     * The withdrawal request includes OVM address, validator public keys and corresponding withdrawal amounts.
+     *
+     * @remarks
+     * **⚠️ Important:**  If you're storing the private key in an `.env` file, ensure it is securely managed
+     * and not pushed to version control.
+     *
+     * @param {OVMRequestWithdrawalPayload} payload - Data needed to request withdrawal
+     * @returns {Promise<{txHash: string}>} Transaction hash of the withdrawal request
+     * @throws Will throw an error if the signer is not provided, OVM address is invalid, or the request fails
+     *
+     * An example of how to use requestWithdrawal:
+     * ```typescript
+     * const result = await client.splits.requestWithdrawal({
+     *   ovmAddress: '0x1234567890123456789012345678901234567890',
+     *   pubKeys: ['0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456'],
+     *   amounts: ['32000000000'] // 32 ETH in gwei
+     * });
+     * console.log('Withdrawal requested:', result.txHash);
+     * ```
+     */
+    requestWithdrawal(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.signer) {
+                throw new Error('Signer is required in requestWithdrawal');
+            }
+            // [TBD] need to move ovm verification to sdk method and use it here
+            const validatedPayload = (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema);
+            return yield (0, splitHelpers_1.requestWithdrawalFromOVM)({
+                ovmAddress: validatedPayload.ovmAddress,
+                pubKeys: validatedPayload.pubKeys,
+                amounts: validatedPayload.amounts,
+                withdrawalFees: validatedPayload.withdrawalFees,
+                signer: this.signer,
+            });
+        });
+    }
 }
 exports.ObolSplits = ObolSplits;

package/dist/cjs/test/client/ajv.spec.js

@@ -267,3 +267,54 @@ describe('validatePayload - OVM Schemas', () => {
         });
     });
 });
+describe('ovmRequestWithdrawalPayloadSchema', () => {
+    const validPayload = {
+        ovmAddress: '0x1234567890123456789012345678901234567890',
+        pubKeys: [
+            '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+        ],
+        amounts: ['32000000000'],
+        withdrawalFees: '1',
+    };
+    it('should throw error when OVM address is missing', () => {
+        const payload = {
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+        };
+        expect(() => (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema)).toThrow("Validation failed:  must have required property 'ovmAddress'");
+    });
+    it('should throw error when OVM address is invalid', () => {
+        const payload = {
+            ovmAddress: '0x123', // Too short
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+        };
+        expect(() => (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed:  must have required property \'withdrawalFees\', /ovmAddress must match pattern "^0x[a-fA-F0-9]{40}$"');
+    });
+    it('should throw error when number of public keys does not match number of amounts', () => {
+        const payload = {
+            ovmAddress: validPayload.ovmAddress,
+            pubKeys: validPayload.pubKeys,
+            amounts: ['32000000000', '16000000000'], // 2 amounts, 1 pubKey
+            withdrawalFees: validPayload.withdrawalFees,
+        };
+        expect(() => (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed:  must pass "validateOVMRequestWithdrawalPayload" keyword validation');
+    });
+    it('should throw error when withdrawalFees is missing', () => {
+        const payload = {
+            ovmAddress: validPayload.ovmAddress,
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+        };
+        expect(() => (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema)).toThrow("Validation failed:  must have required property 'withdrawalFees'");
+    });
+    it('should throw error when withdrawalFees is invalid', () => {
+        const payload = {
+            ovmAddress: validPayload.ovmAddress,
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+            withdrawalFees: 'invalid',
+        };
+        expect(() => (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed: /withdrawalFees must match pattern "^[0-9]+$"');
+    });
+});

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

@@ -21,6 +21,7 @@ jest.mock('../../src/splits/splitHelpers', () => ({
     isSplitV2Deployed: jest.fn(),
     deployOVMContract: jest.fn(),
     deployOVMAndSplitV2: jest.fn(),
+    requestWithdrawalFromOVM: jest.fn(),
 }));
 // Mock the utils
 jest.mock('../../src/utils', () => ({
@@ -36,6 +37,7 @@ const mockPredictSplitV2Address = splitHelpers_1.predictSplitV2Address;
 const mockIsSplitV2Deployed = splitHelpers_1.isSplitV2Deployed;
 const mockDeployOVMAndSplitV2 = splitHelpers_1.deployOVMAndSplitV2;
 const mockDeployOVMContract = splitHelpers_1.deployOVMContract;
+const mockRequestWithdrawalFromOVM = splitHelpers_1.requestWithdrawalFromOVM;
 const mockIsContractAvailable = utils_1.isContractAvailable;
 describe('ObolSplits', () => {
     let client;
@@ -44,6 +46,8 @@ describe('ObolSplits', () => {
     beforeEach(() => {
         // Clear all mocks before each test
         jest.clearAllMocks();
+        // Reset the mock to not be called by default
+        mockRequestWithdrawalFromOVM.mockReset();
         mockSigner = {
             getAddress: jest
                 .fn()
@@ -228,6 +232,81 @@ describe('ObolSplits', () => {
             yield expect(clientUnsupportedChain.splits.createValidatorManagerAndTotalSplit(mockTotalSplitPayload)).rejects.toThrow('Splitter configuration is not supported on 999 chain');
         }));
     });
+    describe('requestWithdrawal', () => {
+        const mockOVMAddress = '0x1234567890123456789012345678901234567890';
+        const mockPubKeys = [
+            '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+        ];
+        const mockAmounts = ['32000000000']; // 32 ETH in gwei
+        it('should request withdrawal successfully', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockRequestWithdrawalFromOVM.mockResolvedValue({
+                txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+            });
+            const result = yield client.splits.requestWithdrawal({
+                ovmAddress: mockOVMAddress,
+                pubKeys: mockPubKeys,
+                amounts: mockAmounts,
+                withdrawalFees: '1',
+            });
+            expect(result).toEqual({
+                txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+            });
+            expect(mockRequestWithdrawalFromOVM).toHaveBeenCalledWith({
+                ovmAddress: mockOVMAddress,
+                pubKeys: mockPubKeys,
+                amounts: mockAmounts,
+                withdrawalFees: '1',
+                signer: mockSigner,
+            });
+        }));
+        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.requestWithdrawal({
+                ovmAddress: mockOVMAddress,
+                pubKeys: mockPubKeys,
+                amounts: mockAmounts,
+                withdrawalFees: '1',
+            })).rejects.toThrow('Signer is required in requestWithdrawal');
+        }));
+        // it('should throw error when amount is below minimum (1,000,000 gwei)', async () => {
+        //   await expect(
+        //     client.splits.requestWithdrawal({
+        //       ovmAddress: mockOVMAddress,
+        //       pubKeys: mockPubKeys,
+        //       amounts: ['500000'], // Below minimum of 1,000,000 gwei
+        //     }),
+        //   ).rejects.toThrow('Validation failed');
+        // });
+        it('should handle multiple validators withdrawal request', () => __awaiter(void 0, void 0, void 0, function* () {
+            const multiplePubKeys = [
+                '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+                '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+            ];
+            const multipleAmounts = [
+                '32000000000', // 32 ETH
+                '16000000000', // 16 ETH
+            ];
+            mockRequestWithdrawalFromOVM.mockResolvedValue({
+                txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+            });
+            const result = yield client.splits.requestWithdrawal({
+                ovmAddress: mockOVMAddress,
+                pubKeys: multiplePubKeys,
+                amounts: multipleAmounts,
+                withdrawalFees: '1',
+            });
+            expect(result).toEqual({
+                txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+            });
+            expect(mockRequestWithdrawalFromOVM).toHaveBeenCalledWith({
+                ovmAddress: mockOVMAddress,
+                pubKeys: multiplePubKeys,
+                amounts: multipleAmounts,
+                withdrawalFees: '1',
+                signer: mockSigner,
+            });
+        }));
+    });
     describe('constructor', () => {
         it('should create Client instance with splits property', () => {
             const testClient = new src_1.Client({ chainId: 1 }, mockSigner, mockProvider);

package/dist/esm/package.json

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

package/dist/esm/src/ajv.js

@@ -61,6 +61,24 @@ const validateOVMTotalSplitRecipients = (_, data) => {
     const splitPercentage = calculateTotalPercentage(data.principalSplitRecipients);
     return validateTotalPercentage(splitPercentage);
 };
+const validateOVMRequestWithdrawalPayload = (_, data) => {
+    if (!data.pubKeys || !data.amounts) {
+        return false;
+    }
+    if (data.pubKeys.length !== data.amounts.length) {
+        return false;
+    }
+    // // Validate that all amounts are at least 1,000,000 gwei
+    // const minAmount = BigInt(1000000);
+    // for (const amountStr of data.amounts) {
+    //   const minAmount = BigInt(1000000);
+    //   const amount = BigInt(amountStr);
+    //   if (amount < minAmount) {
+    //     return false;
+    //   }
+    // }
+    return true;
+};
 const ajv = new Ajv({
     allErrors: true,
     useDefaults: true,
@@ -94,6 +112,11 @@ ajv.addKeyword({
     validate: validateOVMTotalSplitRecipients,
     schemaType: 'boolean',
 });
+ajv.addKeyword({
+    keyword: 'validateOVMRequestWithdrawalPayload',
+    validate: validateOVMRequestWithdrawalPayload,
+    schemaType: 'boolean',
+});
 export function validatePayload(data, schema) {
     var _a;
     const validate = ajv.compile(schema);

package/dist/esm/src/schema.js

@@ -206,3 +206,34 @@ export const ovmTotalSplitPayloadSchema = {
         'OVMOwnerAddress',
     ],
 };
+export const ovmRequestWithdrawalPayloadSchema = {
+    type: 'object',
+    properties: {
+        withdrawalFees: {
+            type: 'string',
+            pattern: '^[0-9]+$',
+        },
+        ovmAddress: {
+            type: 'string',
+            pattern: '^0x[a-fA-F0-9]{40}$',
+        },
+        pubKeys: {
+            type: 'array',
+            minItems: 1,
+            items: {
+                type: 'string',
+                pattern: '^0x[a-fA-F0-9]{96}$', // 48 bytes = 96 hex chars + 0x prefix
+            },
+        },
+        amounts: {
+            type: 'array',
+            minItems: 1,
+            items: {
+                type: 'string',
+                pattern: '^[0-9]+$',
+            },
+        },
+    },
+    validateOVMRequestWithdrawalPayload: true,
+    required: ['ovmAddress', 'pubKeys', 'amounts', 'withdrawalFees'],
+};

package/dist/esm/src/splits/splitHelpers.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { Contract, Interface, parseEther, ZeroAddress } from 'ethers';
 import { OWRContract, OWRFactoryContract } from '../abi/OWR';
-import { OVMFactoryContract } from '../abi/OVMFactory';
+import { OVMFactoryContract, OVMContract } from '../abi/OVMFactory';
 import { splitMainEthereumAbi } from '../abi/SplitMain';
 import { MultiCallContract } from '../abi/Multicall';
 import { CHAIN_CONFIGURATION } from '../constants';
@@ -484,3 +484,27 @@ const getChainConfig = (chainId) => {
     }
     return config;
 };
+/**
+ * Requests withdrawal from an OVM contract
+ * @param ovmAddress - The address of the OVM contract
+ * @param pubKeys - Array of validator public keys in bytes format
+ * @param amounts - Array of withdrawal amounts in wei (uint64)
+ * @param signer - The signer to use for the transaction
+ * @returns Promise that resolves to the transaction hash
+ */
+export const requestWithdrawalFromOVM = ({ ovmAddress, pubKeys, amounts, withdrawalFees, signer, }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _15;
+    try {
+        // Convert string amounts to bigint
+        const bigintAmounts = amounts.map(amount => BigInt(amount));
+        const ovmContract = new Contract(ovmAddress, OVMContract.abi, signer);
+        const tx = yield ovmContract.requestWithdrawal(pubKeys, bigintAmounts, {
+            value: BigInt(withdrawalFees),
+        });
+        const receipt = yield tx.wait();
+        return { txHash: receipt.hash };
+    }
+    catch (error) {
+        throw new Error(`Failed to request withdrawal from OVM: ${(_15 = error.message) !== null && _15 !== void 0 ? _15 : 'Request withdrawal failed'}`);
+    }
+});

package/dist/esm/src/splits/splits.js

@@ -7,9 +7,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { formatRecipientsForSplitV2, predictSplitV2Address, isSplitV2Deployed, deployOVMContract, deployOVMAndSplitV2, } from './splitHelpers';
+import { formatRecipientsForSplitV2, predictSplitV2Address, isSplitV2Deployed, deployOVMContract, deployOVMAndSplitV2, requestWithdrawalFromOVM, } from './splitHelpers';
 import { CHAIN_CONFIGURATION, SPLITS_V2_SALT, DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT, isChainSupportedForSplitters, } from '../constants';
-import { ovmRewardsSplitPayloadSchema, ovmTotalSplitPayloadSchema, } from '../schema';
+import { ovmRewardsSplitPayloadSchema, ovmTotalSplitPayloadSchema, ovmRequestWithdrawalPayloadSchema, } from '../schema';
 import { validatePayload } from '../ajv';
 import { isContractAvailable } from '../utils';
 /**
@@ -276,4 +276,44 @@ export class ObolSplits {
             }
         });
     }
+    /**
+     * Requests withdrawal from an OVM contract.
+     *
+     * This method allows requesting withdrawal of validator funds from an OVM contract.
+     * The withdrawal request includes OVM address, validator public keys and corresponding withdrawal amounts.
+     *
+     * @remarks
+     * **⚠️ Important:**  If you're storing the private key in an `.env` file, ensure it is securely managed
+     * and not pushed to version control.
+     *
+     * @param {OVMRequestWithdrawalPayload} payload - Data needed to request withdrawal
+     * @returns {Promise<{txHash: string}>} Transaction hash of the withdrawal request
+     * @throws Will throw an error if the signer is not provided, OVM address is invalid, or the request fails
+     *
+     * An example of how to use requestWithdrawal:
+     * ```typescript
+     * const result = await client.splits.requestWithdrawal({
+     *   ovmAddress: '0x1234567890123456789012345678901234567890',
+     *   pubKeys: ['0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456'],
+     *   amounts: ['32000000000'] // 32 ETH in gwei
+     * });
+     * console.log('Withdrawal requested:', result.txHash);
+     * ```
+     */
+    requestWithdrawal(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.signer) {
+                throw new Error('Signer is required in requestWithdrawal');
+            }
+            // [TBD] need to move ovm verification to sdk method and use it here
+            const validatedPayload = validatePayload(payload, ovmRequestWithdrawalPayloadSchema);
+            return yield requestWithdrawalFromOVM({
+                ovmAddress: validatedPayload.ovmAddress,
+                pubKeys: validatedPayload.pubKeys,
+                amounts: validatedPayload.amounts,
+                withdrawalFees: validatedPayload.withdrawalFees,
+                signer: this.signer,
+            });
+        });
+    }
 }

package/dist/esm/test/client/ajv.spec.js

@@ -1,5 +1,5 @@
 import { validatePayload } from '../../src/ajv';
-import { ovmRewardsSplitPayloadSchema, ovmTotalSplitPayloadSchema, } from '../../src/schema';
+import { ovmRewardsSplitPayloadSchema, ovmTotalSplitPayloadSchema, ovmRequestWithdrawalPayloadSchema, } from '../../src/schema';
 import { TEST_ADDRESSES } from '../fixtures';
 describe('validatePayload - OVM Schemas', () => {
     describe('ovmRewardsSplitPayloadSchema', () => {
@@ -265,3 +265,54 @@ describe('validatePayload - OVM Schemas', () => {
         });
     });
 });
+describe('ovmRequestWithdrawalPayloadSchema', () => {
+    const validPayload = {
+        ovmAddress: '0x1234567890123456789012345678901234567890',
+        pubKeys: [
+            '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+        ],
+        amounts: ['32000000000'],
+        withdrawalFees: '1',
+    };
+    it('should throw error when OVM address is missing', () => {
+        const payload = {
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+        };
+        expect(() => validatePayload(payload, ovmRequestWithdrawalPayloadSchema)).toThrow("Validation failed:  must have required property 'ovmAddress'");
+    });
+    it('should throw error when OVM address is invalid', () => {
+        const payload = {
+            ovmAddress: '0x123', // Too short
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+        };
+        expect(() => validatePayload(payload, ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed:  must have required property \'withdrawalFees\', /ovmAddress must match pattern "^0x[a-fA-F0-9]{40}$"');
+    });
+    it('should throw error when number of public keys does not match number of amounts', () => {
+        const payload = {
+            ovmAddress: validPayload.ovmAddress,
+            pubKeys: validPayload.pubKeys,
+            amounts: ['32000000000', '16000000000'], // 2 amounts, 1 pubKey
+            withdrawalFees: validPayload.withdrawalFees,
+        };
+        expect(() => validatePayload(payload, ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed:  must pass "validateOVMRequestWithdrawalPayload" keyword validation');
+    });
+    it('should throw error when withdrawalFees is missing', () => {
+        const payload = {
+            ovmAddress: validPayload.ovmAddress,
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+        };
+        expect(() => validatePayload(payload, ovmRequestWithdrawalPayloadSchema)).toThrow("Validation failed:  must have required property 'withdrawalFees'");
+    });
+    it('should throw error when withdrawalFees is invalid', () => {
+        const payload = {
+            ovmAddress: validPayload.ovmAddress,
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+            withdrawalFees: 'invalid',
+        };
+        expect(() => validatePayload(payload, ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed: /withdrawalFees must match pattern "^[0-9]+$"');
+    });
+});

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

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { Client } from '../../src';
 import { CHAIN_CONFIGURATION } from '../../src/constants';
-import { formatRecipientsForSplitV2, predictSplitV2Address, isSplitV2Deployed, deployOVMAndSplitV2, deployOVMContract, } from '../../src/splits/splitHelpers';
+import { formatRecipientsForSplitV2, predictSplitV2Address, isSplitV2Deployed, deployOVMAndSplitV2, deployOVMContract, requestWithdrawalFromOVM, } from '../../src/splits/splitHelpers';
 import { isContractAvailable } from '../../src/utils';
 import { TEST_ADDRESSES } from '../fixtures';
 // Mock the split helpers
@@ -19,6 +19,7 @@ jest.mock('../../src/splits/splitHelpers', () => ({
     isSplitV2Deployed: jest.fn(),
     deployOVMContract: jest.fn(),
     deployOVMAndSplitV2: jest.fn(),
+    requestWithdrawalFromOVM: jest.fn(),
 }));
 // Mock the utils
 jest.mock('../../src/utils', () => ({
@@ -34,6 +35,7 @@ const mockPredictSplitV2Address = predictSplitV2Address;
 const mockIsSplitV2Deployed = isSplitV2Deployed;
 const mockDeployOVMAndSplitV2 = deployOVMAndSplitV2;
 const mockDeployOVMContract = deployOVMContract;
+const mockRequestWithdrawalFromOVM = requestWithdrawalFromOVM;
 const mockIsContractAvailable = isContractAvailable;
 describe('ObolSplits', () => {
     let client;
@@ -42,6 +44,8 @@ describe('ObolSplits', () => {
     beforeEach(() => {
         // Clear all mocks before each test
         jest.clearAllMocks();
+        // Reset the mock to not be called by default
+        mockRequestWithdrawalFromOVM.mockReset();
         mockSigner = {
             getAddress: jest
                 .fn()
@@ -226,6 +230,81 @@ describe('ObolSplits', () => {
             yield expect(clientUnsupportedChain.splits.createValidatorManagerAndTotalSplit(mockTotalSplitPayload)).rejects.toThrow('Splitter configuration is not supported on 999 chain');
         }));
     });
+    describe('requestWithdrawal', () => {
+        const mockOVMAddress = '0x1234567890123456789012345678901234567890';
+        const mockPubKeys = [
+            '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+        ];
+        const mockAmounts = ['32000000000']; // 32 ETH in gwei
+        it('should request withdrawal successfully', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockRequestWithdrawalFromOVM.mockResolvedValue({
+                txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+            });
+            const result = yield client.splits.requestWithdrawal({
+                ovmAddress: mockOVMAddress,
+                pubKeys: mockPubKeys,
+                amounts: mockAmounts,
+                withdrawalFees: '1',
+            });
+            expect(result).toEqual({
+                txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+            });
+            expect(mockRequestWithdrawalFromOVM).toHaveBeenCalledWith({
+                ovmAddress: mockOVMAddress,
+                pubKeys: mockPubKeys,
+                amounts: mockAmounts,
+                withdrawalFees: '1',
+                signer: mockSigner,
+            });
+        }));
+        it('should throw error when signer is not provided', () => __awaiter(void 0, void 0, void 0, function* () {
+            const clientWithoutSigner = new Client({ chainId: 1 }, undefined, mockProvider);
+            yield expect(clientWithoutSigner.splits.requestWithdrawal({
+                ovmAddress: mockOVMAddress,
+                pubKeys: mockPubKeys,
+                amounts: mockAmounts,
+                withdrawalFees: '1',
+            })).rejects.toThrow('Signer is required in requestWithdrawal');
+        }));
+        // it('should throw error when amount is below minimum (1,000,000 gwei)', async () => {
+        //   await expect(
+        //     client.splits.requestWithdrawal({
+        //       ovmAddress: mockOVMAddress,
+        //       pubKeys: mockPubKeys,
+        //       amounts: ['500000'], // Below minimum of 1,000,000 gwei
+        //     }),
+        //   ).rejects.toThrow('Validation failed');
+        // });
+        it('should handle multiple validators withdrawal request', () => __awaiter(void 0, void 0, void 0, function* () {
+            const multiplePubKeys = [
+                '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+                '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+            ];
+            const multipleAmounts = [
+                '32000000000', // 32 ETH
+                '16000000000', // 16 ETH
+            ];
+            mockRequestWithdrawalFromOVM.mockResolvedValue({
+                txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+            });
+            const result = yield client.splits.requestWithdrawal({
+                ovmAddress: mockOVMAddress,
+                pubKeys: multiplePubKeys,
+                amounts: multipleAmounts,
+                withdrawalFees: '1',
+            });
+            expect(result).toEqual({
+                txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+            });
+            expect(mockRequestWithdrawalFromOVM).toHaveBeenCalledWith({
+                ovmAddress: mockOVMAddress,
+                pubKeys: multiplePubKeys,
+                amounts: multipleAmounts,
+                withdrawalFees: '1',
+                signer: mockSigner,
+            });
+        }));
+    });
     describe('constructor', () => {
         it('should create Client instance with splits property', () => {
             const testClient = new Client({ chainId: 1 }, mockSigner, mockProvider);

package/dist/types/src/schema.d.ts

@@ -321,3 +321,34 @@ export declare const ovmTotalSplitPayloadSchema: {
     validateOVMTotalSplitRecipients: boolean;
     required: string[];
 };
+export declare const ovmRequestWithdrawalPayloadSchema: {
+    type: string;
+    properties: {
+        withdrawalFees: {
+            type: string;
+            pattern: string;
+        };
+        ovmAddress: {
+            type: string;
+            pattern: string;
+        };
+        pubKeys: {
+            type: string;
+            minItems: number;
+            items: {
+                type: string;
+                pattern: string;
+            };
+        };
+        amounts: {
+            type: string;
+            minItems: number;
+            items: {
+                type: string;
+                pattern: string;
+            };
+        };
+    };
+    validateOVMRequestWithdrawalPayload: boolean;
+    required: string[];
+};

package/dist/types/src/splits/splitHelpers.d.ts

@@ -99,4 +99,21 @@ export declare const deployOVMAndSplitV2: ({ ovmArgs, rewardRecipients, isReward
     isPrincipalSplitDeployed?: boolean | undefined;
     splitOwnerAddress: string;
 }) => Promise<string>;
+/**
+ * Requests withdrawal from an OVM contract
+ * @param ovmAddress - The address of the OVM contract
+ * @param pubKeys - Array of validator public keys in bytes format
+ * @param amounts - Array of withdrawal amounts in wei (uint64)
+ * @param signer - The signer to use for the transaction
+ * @returns Promise that resolves to the transaction hash
+ */
+export declare const requestWithdrawalFromOVM: ({ ovmAddress, pubKeys, amounts, withdrawalFees, signer, }: {
+    ovmAddress: string;
+    pubKeys: string[];
+    amounts: string[];
+    withdrawalFees: string;
+    signer: SignerType;
+}) => Promise<{
+    txHash: string;
+}>;
 export {};

package/dist/types/src/splits/splits.d.ts

@@ -1,4 +1,4 @@
-import { type ClusterValidator, type ProviderType, type SignerType, type OVMRewardsSplitPayload, type OVMTotalSplitPayload } from '../types';
+import { type ClusterValidator, type ProviderType, type SignerType, type OVMRewardsSplitPayload, type OVMTotalSplitPayload, type OVMRequestWithdrawalPayload } from '../types';
 /**
  * ObolSplits can be used for creating and managing Obol splits.
  * @class
@@ -48,4 +48,31 @@ export declare class ObolSplits {
      * [createValidatorManagerAndTotalSplit](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#340)
      */
     createValidatorManagerAndTotalSplit(payload: OVMTotalSplitPayload): Promise<ClusterValidator>;
+    /**
+     * Requests withdrawal from an OVM contract.
+     *
+     * This method allows requesting withdrawal of validator funds from an OVM contract.
+     * The withdrawal request includes OVM address, validator public keys and corresponding withdrawal amounts.
+     *
+     * @remarks
+     * **⚠️ Important:**  If you're storing the private key in an `.env` file, ensure it is securely managed
+     * and not pushed to version control.
+     *
+     * @param {OVMRequestWithdrawalPayload} payload - Data needed to request withdrawal
+     * @returns {Promise<{txHash: string}>} Transaction hash of the withdrawal request
+     * @throws Will throw an error if the signer is not provided, OVM address is invalid, or the request fails
+     *
+     * An example of how to use requestWithdrawal:
+     * ```typescript
+     * const result = await client.splits.requestWithdrawal({
+     *   ovmAddress: '0x1234567890123456789012345678901234567890',
+     *   pubKeys: ['0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456'],
+     *   amounts: ['32000000000'] // 32 ETH in gwei
+     * });
+     * console.log('Withdrawal requested:', result.txHash);
+     * ```
+     */
+    requestWithdrawal(payload: OVMRequestWithdrawalPayload): Promise<{
+        txHash: string;
+    }>;
 }

package/dist/types/src/types.d.ts

@@ -472,3 +472,16 @@ export type ChainConfig = {
         bytecode: string;
     };
 };
+/**
+ * Payload for requesting withdrawal from OVM contract
+ */
+export type OVMRequestWithdrawalPayload = {
+    /** request withdrawal fees in wei */
+    withdrawalFees: string;
+    /** OVM contract address */
+    ovmAddress: string;
+    /** Array of validator public keys in bytes format */
+    pubKeys: string[];
+    /** Array of withdrawal amounts in gwei (uint64) as strings */
+    amounts: string[];
+};

package/package.json

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

package/src/ajv.ts

@@ -6,6 +6,7 @@ import {
   type OVMTotalSplitPayload,
   type RewardsSplitPayload,
   type TotalSplitPayload,
+  type OVMRequestWithdrawalPayload,
 } from './types';
 import Ajv from 'ajv';
 import {
@@ -107,6 +108,31 @@ const validateOVMTotalSplitRecipients = (
   return validateTotalPercentage(splitPercentage);
 };
 
+const validateOVMRequestWithdrawalPayload = (
+  _: boolean,
+  data: OVMRequestWithdrawalPayload,
+): boolean => {
+  if (!data.pubKeys || !data.amounts) {
+    return false;
+  }
+
+  if (data.pubKeys.length !== data.amounts.length) {
+    return false;
+  }
+
+  // // Validate that all amounts are at least 1,000,000 gwei
+  // const minAmount = BigInt(1000000);
+  // for (const amountStr of data.amounts) {
+  //   const minAmount = BigInt(1000000);
+  //   const amount = BigInt(amountStr);
+  //   if (amount < minAmount) {
+  //     return false;
+  //   }
+  // }
+
+  return true;
+};
+
 const ajv = new Ajv({
   allErrors: true,
   useDefaults: true,
@@ -146,6 +172,12 @@ ajv.addKeyword({
   schemaType: 'boolean',
 });
 
+ajv.addKeyword({
+  keyword: 'validateOVMRequestWithdrawalPayload',
+  validate: validateOVMRequestWithdrawalPayload,
+  schemaType: 'boolean',
+});
+
 export function validatePayload<T>(data: unknown, schema: object): T {
   const validate = ajv.compile<T>(schema);
   const valid = validate(data);

package/src/schema.ts

@@ -229,3 +229,35 @@ export const ovmTotalSplitPayloadSchema = {
     'OVMOwnerAddress',
   ],
 };
+
+export const ovmRequestWithdrawalPayloadSchema = {
+  type: 'object',
+  properties: {
+    withdrawalFees: {
+      type: 'string',
+      pattern: '^[0-9]+$',
+    },
+    ovmAddress: {
+      type: 'string',
+      pattern: '^0x[a-fA-F0-9]{40}$',
+    },
+    pubKeys: {
+      type: 'array',
+      minItems: 1,
+      items: {
+        type: 'string',
+        pattern: '^0x[a-fA-F0-9]{96}$', // 48 bytes = 96 hex chars + 0x prefix
+      },
+    },
+    amounts: {
+      type: 'array',
+      minItems: 1,
+      items: {
+        type: 'string',
+        pattern: '^[0-9]+$',
+      },
+    },
+  },
+  validateOVMRequestWithdrawalPayload: true,
+  required: ['ovmAddress', 'pubKeys', 'amounts', 'withdrawalFees'],
+};

package/src/splits/splitHelpers.ts

@@ -10,7 +10,7 @@ import {
 } from '../types';
 import { Contract, Interface, parseEther, ZeroAddress } from 'ethers';
 import { OWRContract, OWRFactoryContract } from '../abi/OWR';
-import { OVMFactoryContract } from '../abi/OVMFactory';
+import { OVMFactoryContract, OVMContract } from '../abi/OVMFactory';
 import { splitMainEthereumAbi } from '../abi/SplitMain';
 import { MultiCallContract } from '../abi/Multicall';
 import { CHAIN_CONFIGURATION } from '../constants';
@@ -910,3 +910,43 @@ const getChainConfig = (chainId: number): ChainConfig => {
   }
   return config;
 };
+
+/**
+ * Requests withdrawal from an OVM contract
+ * @param ovmAddress - The address of the OVM contract
+ * @param pubKeys - Array of validator public keys in bytes format
+ * @param amounts - Array of withdrawal amounts in wei (uint64)
+ * @param signer - The signer to use for the transaction
+ * @returns Promise that resolves to the transaction hash
+ */
+export const requestWithdrawalFromOVM = async ({
+  ovmAddress,
+  pubKeys,
+  amounts,
+  withdrawalFees,
+  signer,
+}: {
+  ovmAddress: string;
+  pubKeys: string[];
+  amounts: string[];
+  withdrawalFees: string;
+  signer: SignerType;
+}): Promise<{ txHash: string }> => {
+  try {
+    // Convert string amounts to bigint
+    const bigintAmounts = amounts.map(amount => BigInt(amount));
+
+    const ovmContract = new Contract(ovmAddress, OVMContract.abi, signer);
+
+    const tx = await ovmContract.requestWithdrawal(pubKeys, bigintAmounts, {
+      value: BigInt(withdrawalFees),
+    });
+    const receipt = await tx.wait();
+
+    return { txHash: receipt.hash };
+  } catch (error: any) {
+    throw new Error(
+      `Failed to request withdrawal from OVM: ${error.message ?? 'Request withdrawal failed'}`,
+    );
+  }
+};

package/src/splits/splits.ts

@@ -4,6 +4,7 @@ import {
   isSplitV2Deployed,
   deployOVMContract,
   deployOVMAndSplitV2,
+  requestWithdrawalFromOVM,
 } from './splitHelpers';
 import {
   CHAIN_CONFIGURATION,
@@ -14,6 +15,7 @@ import {
 import {
   ovmRewardsSplitPayloadSchema,
   ovmTotalSplitPayloadSchema,
+  ovmRequestWithdrawalPayloadSchema,
 } from '../schema';
 import { validatePayload } from '../ajv';
 import { isContractAvailable } from '../utils';
@@ -23,6 +25,7 @@ import {
   type SignerType,
   type OVMRewardsSplitPayload,
   type OVMTotalSplitPayload,
+  type OVMRequestWithdrawalPayload,
 } from '../types';
 
 /**
@@ -403,4 +406,49 @@ export class ObolSplits {
       };
     }
   }
+
+  /**
+   * Requests withdrawal from an OVM contract.
+   *
+   * This method allows requesting withdrawal of validator funds from an OVM contract.
+   * The withdrawal request includes OVM address, validator public keys and corresponding withdrawal amounts.
+   *
+   * @remarks
+   * **⚠️ Important:**  If you're storing the private key in an `.env` file, ensure it is securely managed
+   * and not pushed to version control.
+   *
+   * @param {OVMRequestWithdrawalPayload} payload - Data needed to request withdrawal
+   * @returns {Promise<{txHash: string}>} Transaction hash of the withdrawal request
+   * @throws Will throw an error if the signer is not provided, OVM address is invalid, or the request fails
+   *
+   * An example of how to use requestWithdrawal:
+   * ```typescript
+   * const result = await client.splits.requestWithdrawal({
+   *   ovmAddress: '0x1234567890123456789012345678901234567890',
+   *   pubKeys: ['0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456'],
+   *   amounts: ['32000000000'] // 32 ETH in gwei
+   * });
+   * console.log('Withdrawal requested:', result.txHash);
+   * ```
+   */
+  async requestWithdrawal(
+    payload: OVMRequestWithdrawalPayload,
+  ): Promise<{ txHash: string }> {
+    if (!this.signer) {
+      throw new Error('Signer is required in requestWithdrawal');
+    }
+    // [TBD] need to move ovm verification to sdk method and use it here
+    const validatedPayload = validatePayload<OVMRequestWithdrawalPayload>(
+      payload,
+      ovmRequestWithdrawalPayloadSchema,
+    );
+
+    return await requestWithdrawalFromOVM({
+      ovmAddress: validatedPayload.ovmAddress,
+      pubKeys: validatedPayload.pubKeys,
+      amounts: validatedPayload.amounts,
+      withdrawalFees: validatedPayload.withdrawalFees,
+      signer: this.signer,
+    });
+  }
 }

package/src/types.ts

@@ -607,3 +607,20 @@ export type ChainConfig = {
     bytecode: string;
   };
 };
+
+/**
+ * Payload for requesting withdrawal from OVM contract
+ */
+export type OVMRequestWithdrawalPayload = {
+  /** request withdrawal fees in wei */
+  withdrawalFees: string;
+
+  /** OVM contract address */
+  ovmAddress: string;
+
+  /** Array of validator public keys in bytes format */
+  pubKeys: string[];
+
+  /** Array of withdrawal amounts in gwei (uint64) as strings */
+  amounts: string[];
+};