@obolnetwork/obol-sdk 2.10.2 → 2.11.0

package/dist/cjs/src/constants.js

@@ -146,9 +146,9 @@ exports.CHAIN_CONFIGURATION = {
             address: '0x2ed6c4B5dA6378c7897AC67Ba9e43102Feb694EE',
             bytecode: bytecodes_1.MAINNET_SPLITMAIN_BYTECODE,
         },
-        MULTICALL_CONTRACT: {
-            address: '0xeefba1e63905ef1d7acba5a8513c70307c1ce441',
-            bytecode: bytecodes_1.MAINNET_MULTICALL_BYTECODE,
+        MULTICALL3_CONTRACT: {
+            address: '0xcA11bde05977b3631167028862bE2a173976CA11',
+            bytecode: bytecodes_1.MAINNET_MULTICALL3_BYTECODE,
         },
         OWR_FACTORY_CONTRACT: {
             address: '0x119acd7844cbdd5fc09b1c6a4408f490c8f7f522',
@@ -174,15 +174,18 @@ exports.CHAIN_CONFIGURATION = {
         EOA_WITHDRAWAL_CONTRACT: {
             address: '0x00000961Ef480Eb55e80D19ad83579A64c007002',
         },
+        BATCH_DEPOSIT_CONTRACT: {
+            address: '0xcD7a6C118Ac8F6544BC5076F2D8Fb86D2C546756',
+        },
     },
     [types_1.FORK_MAPPING['0x01017000']]: {
         SPLITMAIN_CONTRACT: {
             address: '0xfC8a305728051367797DADE6Aa0344E0987f5286',
             bytecode: bytecodes_1.HOLESKY_SPLITMAIN_BYTECODE,
         },
-        MULTICALL_CONTRACT: {
+        MULTICALL3_CONTRACT: {
             address: '0xcA11bde05977b3631167028862bE2a173976CA11',
-            bytecode: bytecodes_1.HOLESKY_MULTICALL_BYTECODE,
+            bytecode: bytecodes_1.HOLESKY_MULTICALL3_BYTECODE,
         },
         OWR_FACTORY_CONTRACT: {
             address: '0xc0961353fcc43a99e3041db07ac646720e116256',
@@ -201,9 +204,9 @@ exports.CHAIN_CONFIGURATION = {
             address: '0xc05ae267291705ac16F75283572294ed2a91CBc7',
             bytecode: bytecodes_1.HOODI_SPLITMAIN_BYTECODE,
         },
-        MULTICALL_CONTRACT: {
+        MULTICALL3_CONTRACT: {
             address: '0xcA11bde05977b3631167028862bE2a173976CA11',
-            bytecode: bytecodes_1.HOODI_MULTICALL_BYTECODE,
+            bytecode: bytecodes_1.HOODI_MULTICALL3_BYTECODE,
         },
         OWR_FACTORY_CONTRACT: {
             address: '0x9ff0c649d0bf5fe7efa4d72e94bed7302ed5c8d7',
@@ -229,6 +232,9 @@ exports.CHAIN_CONFIGURATION = {
         EOA_WITHDRAWAL_CONTRACT: {
             address: '0x00000961Ef480Eb55e80D19ad83579A64c007002',
         },
+        BATCH_DEPOSIT_CONTRACT: {
+            address: '0x4c9506eE2fCd962f03022D9d8ebf6f7828abEfaf',
+        },
     },
 };
 exports.DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT = 1;

package/dist/cjs/src/eoa/eoa.js

@@ -79,5 +79,53 @@ class EOA {
             });
         });
     }
+    /**
+     * Deposits to batch deposit contract.
+     *
+     * This method allows depositing multiple validators to the Ethereum beacon chain
+     * using the Pier Two batch deposit contract for gas efficiency.
+     * Each deposit includes validator public key, withdrawal credentials, signature, and amount.
+     *
+     * @remarks
+     * **⚠️ Important:**  If you're storing the private key in an `.env` file, ensure it is securely managed
+     * and not pushed to version control.
+     *
+     * **⚠️ Gas Limit:** Due to EVM constraints, it is recommended to deposit in batches of up to 500 at a time.
+     *
+     * @param {EOADepositPayload} payload - Data needed to deposit to batch contract
+     * @returns {Promise<{txHashes: string[]}>} Array of transaction hashes for all batches
+     * @throws Will throw an error if the signer is not provided, contract is not configured, or the deposit fails
+     *
+     * An example of how to use deposit:
+     * ```typescript
+     * const result = await client.eoa.deposit({
+     *   deposits: [{
+     *     pubKey: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+     *     withdrawalCredentials: '0x1234567890123456789012345678901234567890',
+     *     signature: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+     *     amount: '32000000000000000000' // 32 ETH in wei
+     *   }]
+     * });
+     * console.log('Deposits completed:', result.txHashes);
+     * ```
+     */
+    deposit(payload) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.signer) {
+                throw new Error('Signer is required in deposit');
+            }
+            const chainConfig = constants_1.CHAIN_CONFIGURATION[this.chainId];
+            if (!((_a = chainConfig === null || chainConfig === void 0 ? void 0 : chainConfig.BATCH_DEPOSIT_CONTRACT) === null || _a === void 0 ? void 0 : _a.address)) {
+                throw new Error(`Batch deposit contract is not configured for chain ${this.chainId}`);
+            }
+            const validatedPayload = (0, ajv_1.validatePayload)(payload, schema_1.eoaDepositPayloadSchema);
+            return yield (0, eoaHelpers_1.submitEOABatchDeposit)({
+                deposits: validatedPayload.deposits,
+                batchDepositContractAddress: chainConfig.BATCH_DEPOSIT_CONTRACT.address,
+                signer: this.signer,
+            });
+        });
+    }
 }
 exports.EOA = EOA;

package/dist/cjs/src/eoa/eoaHelpers.js

@@ -9,8 +9,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.submitEOAWithdrawalRequest = void 0;
+exports.submitEOABatchDeposit = exports.submitEOAWithdrawalRequest = void 0;
 const constants_1 = require("../constants");
+const ethers_1 = require("ethers");
+const BatchDeposit_1 = require("../abi/BatchDeposit");
 /**
  * Helper function to submit withdrawal request for EOA
  */
@@ -35,3 +37,45 @@ function submitEOAWithdrawalRequest({ pubkey, allocation, withdrawalAddress, wit
     });
 }
 exports.submitEOAWithdrawalRequest = submitEOAWithdrawalRequest;
+/**
+ * Helper function to submit batch deposit request for EOA
+ */
+function submitEOABatchDeposit({ deposits, batchDepositContractAddress, signer, }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!deposits || deposits.length === 0) {
+            throw new Error('No deposits provided');
+        }
+        // Create contract instance
+        const batchDepositContract = new ethers_1.Contract(batchDepositContractAddress, BatchDeposit_1.BatchDepositContract.abi, signer);
+        const BATCH_SIZE = 500;
+        const txHashes = [];
+        try {
+            // Process deposits in batches of 500
+            for (let i = 0; i < deposits.length; i += BATCH_SIZE) {
+                const batchDeposits = deposits.slice(i, i + BATCH_SIZE);
+                // Calculate total value needed for this batch
+                const totalValue = batchDeposits.reduce((sum, deposit) => sum + BigInt(deposit.amount), BigInt(0));
+                // Prepare deposit data for this batch
+                const depositData = batchDeposits.map(deposit => ({
+                    pubKey: deposit.pubKey,
+                    withdrawalCredentials: deposit.withdrawalCredentials,
+                    signature: deposit.signature,
+                    amount: BigInt(deposit.amount),
+                }));
+                // Execute batch deposit for this batch
+                const tx = yield batchDepositContract.batchDeposit(depositData, {
+                    value: totalValue,
+                });
+                const receipt = yield tx.wait();
+                if (receipt === null || receipt === void 0 ? void 0 : receipt.hash) {
+                    txHashes.push(receipt.hash);
+                }
+            }
+            return { txHashes };
+        }
+        catch (error) {
+            throw new Error("Failed to submit batch deposit'}");
+        }
+    });
+}
+exports.submitEOABatchDeposit = submitEOABatchDeposit;

package/dist/cjs/src/index.js

@@ -156,9 +156,9 @@ class Client extends base_js_1.Base {
                 throw new Error(`SPLITMAIN_CONTRACT is not configured for chain ${this.chainId}`);
             }
             const checkSplitMainAddress = yield (0, utils_js_1.isContractAvailable)(chainConfig.SPLITMAIN_CONTRACT.address, this.signer.provider, chainConfig.SPLITMAIN_CONTRACT.bytecode);
-            const checkMulticallAddress = yield (0, utils_js_1.isContractAvailable)(chainConfig.MULTICALL_CONTRACT.address, this.signer.provider, chainConfig.MULTICALL_CONTRACT.bytecode);
+            const checkMulticall3Address = yield (0, utils_js_1.isContractAvailable)(chainConfig.MULTICALL3_CONTRACT.address, this.signer.provider, chainConfig.MULTICALL3_CONTRACT.bytecode);
             const checkOWRFactoryAddress = yield (0, utils_js_1.isContractAvailable)(chainConfig.OWR_FACTORY_CONTRACT.address, this.signer.provider, chainConfig.OWR_FACTORY_CONTRACT.bytecode);
-            if (!checkMulticallAddress ||
+            if (!checkMulticall3Address ||
                 !checkSplitMainAddress ||
                 !checkOWRFactoryAddress) {
                 throw new Error(`Something isn not working as expected, check this issue with obol-sdk team on ${constants_js_1.OBOL_SDK_EMAIL}`);

package/dist/cjs/src/schema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.eoaWithdrawalPayloadSchema = exports.ovmRequestWithdrawalPayloadSchema = exports.ovmTotalSplitPayloadSchema = exports.ovmRewardsSplitPayloadSchema = exports.ovmBaseSplitPayload = exports.rewardsSplitterPayloadSchema = exports.totalSplitterPayloadSchema = exports.definitionSchema = exports.operatorPayloadSchema = void 0;
+exports.eoaDepositPayloadSchema = exports.ovmDepositPayloadSchema = exports.eoaWithdrawalPayloadSchema = 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");
@@ -258,3 +258,85 @@ exports.eoaWithdrawalPayloadSchema = {
     },
     required: ['pubkey', 'allocation', 'requiredFee'],
 };
+exports.ovmDepositPayloadSchema = {
+    type: 'object',
+    properties: {
+        ovmAddress: {
+            type: 'string',
+            pattern: '^0x[a-fA-F0-9]{40}$',
+        },
+        deposits: {
+            type: 'array',
+            minItems: 1,
+            items: {
+                type: 'object',
+                properties: {
+                    pubkey: {
+                        type: 'string',
+                        pattern: '^0x[a-fA-F0-9]{96}$',
+                    },
+                    withdrawal_credentials: {
+                        type: 'string',
+                        pattern: '^0x[a-fA-F0-9]{64}$',
+                        description: '32 bytes withdrawal credentials',
+                    },
+                    signature: {
+                        type: 'string',
+                        pattern: '^0x[a-fA-F0-9]{192}$',
+                        description: '96 bytes signature (190 hex chars + 0x prefix)',
+                    },
+                    deposit_data_root: {
+                        type: 'string',
+                        pattern: '^0x[a-fA-F0-9]{64}$', // 32 bytes = 64 hex chars + 0x prefix
+                    },
+                    amount: {
+                        type: 'string',
+                        pattern: '^[0-9]+$',
+                    },
+                },
+                required: [
+                    'pubkey',
+                    'withdrawal_credentials',
+                    'signature',
+                    'deposit_data_root',
+                    'amount',
+                ],
+            },
+        },
+    },
+    required: ['ovmAddress', 'deposits'],
+};
+exports.eoaDepositPayloadSchema = {
+    type: 'object',
+    properties: {
+        deposits: {
+            type: 'array',
+            minItems: 1,
+            items: {
+                type: 'object',
+                properties: {
+                    pubKey: {
+                        type: 'string',
+                        pattern: '^0x[a-fA-F0-9]{96}$',
+                    },
+                    withdrawalCredentials: {
+                        type: 'string',
+                        pattern: '^0x[a-fA-F0-9]{64}$',
+                        description: '32 bytes withdrawal credentials',
+                    },
+                    signature: {
+                        type: 'string',
+                        pattern: '^0x[a-fA-F0-9]{192}$',
+                        description: '96 bytes signature (190 hex chars + 0x prefix)',
+                    },
+                    amount: {
+                        type: 'string',
+                        pattern: '^[0-9]+$',
+                    },
+                },
+                required: ['pubKey', 'withdrawalCredentials', 'signature', 'amount'],
+            },
+        },
+    },
+    required: ['deposits'],
+};

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

@@ -9,14 +9,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.depositWithMulticall3 = exports.requestWithdrawalFromOVM = exports.deployOVMAndSplitV2 = exports.deployOVMContract = exports.isSplitV2Deployed = exports.predictSplitV2Address = exports.formatRecipientsForSplitV2 = exports.multicall3 = 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");
 const SplitMain_1 = require("../abi/SplitMain");
-const Multicall_1 = require("../abi/Multicall");
 const constants_1 = require("../constants");
 const splitV2FactoryAbi_1 = require("../abi/splitV2FactoryAbi");
+const Multicall3_1 = require("../abi/Multicall3");
 const splitMainContractInterface = new ethers_1.Interface(SplitMain_1.splitMainEthereumAbi);
 const owrFactoryContractInterface = new ethers_1.Interface(OWR_1.OWRFactoryContract.abi);
 const ovmFactoryContractInterface = new ethers_1.Interface(OVMFactory_1.OVMFactoryContract.abi);
@@ -130,7 +130,7 @@ const handleDeployOWRAndSplitter = ({ signer, isSplitterDeployed, predictedSplit
                 splitterAddress = result.splitterAddress;
             }
             catch (error) {
-                throw new Error(`Failed to deploy both splitter and OWR contracts: ${(_e = error.message) !== null && _e !== void 0 ? _e : 'Multicall contract deployment failed'}`);
+                throw new Error(`Failed to deploy both splitter and OWR contracts: ${(_e = error.message) !== null && _e !== void 0 ? _e : 'Multicall3 contract deployment failed'}`);
             }
             return {
                 withdrawal_address: owrAddress,
@@ -249,7 +249,7 @@ const deploySplitterAndOWRContracts = ({ owrArgs, splitterArgs, signer, chainId,
         target: getChainConfig(chainId).OWR_FACTORY_CONTRACT.address,
         callData: owrTxData,
     });
-    const executeMultiCalls = yield (0, exports.multicall)(executeCalls, signer, chainId);
+    const executeMultiCalls = yield (0, exports.multicall3)(executeCalls, signer, chainId);
     const splitAddressData = (_s = executeMultiCalls === null || executeMultiCalls === void 0 ? void 0 : executeMultiCalls.logs[0]) === null || _s === void 0 ? void 0 : _s.topics[1];
     const formattedSplitterAddress = '0x' + (splitAddressData === null || splitAddressData === void 0 ? void 0 : splitAddressData.slice(26, 66));
     const owrAddressData = (_t = executeMultiCalls === null || executeMultiCalls === void 0 ? void 0 : executeMultiCalls.logs[1]) === null || _t === void 0 ? void 0 : _t.topics[1];
@@ -291,42 +291,42 @@ const getOWRTranches = ({ owrAddress, signer, }) => __awaiter(void 0, void 0, vo
     }
 });
 exports.getOWRTranches = getOWRTranches;
-const multicall = (calls, signer, chainId) => __awaiter(void 0, void 0, void 0, function* () {
+const multicall3 = (calls, signer, chainId) => __awaiter(void 0, void 0, void 0, function* () {
     var _w, _x, _y;
     try {
         const chainConfig = getChainConfig(chainId);
-        const multicallAddress = chainConfig.MULTICALL_CONTRACT.address;
-        const multiCallContractInstance = new ethers_1.Contract(multicallAddress, Multicall_1.MultiCallContract.abi, signer);
+        const multicall3Address = chainConfig.MULTICALL3_CONTRACT.address;
+        const multiCall3ContractInstance = new ethers_1.Contract(multicall3Address, Multicall3_1.MultiCall3Contract.abi, signer);
         let tx;
         try {
-            tx = yield multiCallContractInstance.aggregate(calls);
+            tx = yield multiCall3ContractInstance.aggregate(calls);
         }
         catch (error) {
-            throw new Error(`Failed to submit multicall transaction: ${(_w = error.message) !== null && _w !== void 0 ? _w : 'Transaction submission failed'}`);
+            throw new Error(`Failed to submit multicall3 transaction: ${(_w = error.message) !== null && _w !== void 0 ? _w : 'Transaction submission failed'}`);
         }
         let receipt;
         try {
             receipt = yield tx.wait();
         }
         catch (error) {
-            throw new Error(`Multicall transaction failed or was reverted: ${(_x = error.message) !== null && _x !== void 0 ? _x : 'Transaction execution failed'}`);
+            throw new Error(`Multicall3 transaction failed or was reverted: ${(_x = error.message) !== null && _x !== void 0 ? _x : 'Transaction execution failed'}`);
         }
         if (!receipt) {
-            throw new Error('Multicall transaction succeeded but no receipt was returned');
+            throw new Error('Multicall3 transaction succeeded but no receipt was returned');
         }
         return receipt;
     }
     catch (error) {
         // Re-throw if it's already our custom error
         if (error.message.includes('Failed to') ||
-            error.message.includes('Multicall transaction')) {
+            error.message.includes('Multicall3 transaction')) {
             throw error;
         }
         // Handle unexpected errors
-        throw new Error(`Unexpected error in multicall: ${(_y = error.message) !== null && _y !== void 0 ? _y : 'Unknown error during multicall execution'}`);
+        throw new Error(`Unexpected error in multicall3: ${(_y = error.message) !== null && _y !== void 0 ? _y : 'Unknown error during multicall3 execution'}`);
     }
 });
-exports.multicall = multicall;
+exports.multicall3 = multicall3;
 const encodeCreateSplitTxData = (accounts, percentAllocations, distributorFee, controller) => {
     return splitMainContractInterface.encodeFunctionData('createSplit', [
         accounts,
@@ -460,8 +460,8 @@ const deployOVMAndSplitV2 = ({ ovmArgs, rewardRecipients, isRewardsSplitterDeplo
             target: chainConfig.OVM_FACTORY_CONTRACT.address,
             callData: ovmTxData,
         });
-        // Execute multicall
-        const executeMultiCalls = yield (0, exports.multicall)(executeCalls, signer, chainId);
+        // Execute multicall3
+        const executeMultiCalls = yield (0, exports.multicall3)(executeCalls, signer, chainId);
         // Extract addresses from events
         let ovmAddress;
         const logsCount = ((_7 = executeMultiCalls === null || executeMultiCalls === void 0 ? void 0 : executeMultiCalls.logs) === null || _7 === void 0 ? void 0 : _7.length) || 0;
@@ -475,7 +475,7 @@ const deployOVMAndSplitV2 = ({ ovmArgs, rewardRecipients, isRewardsSplitterDeplo
             ovmAddress = '0x' + ((_13 = (_12 = executeMultiCalls === null || executeMultiCalls === void 0 ? void 0 : executeMultiCalls.logs[7]) === null || _12 === void 0 ? void 0 : _12.topics[1]) === null || _13 === void 0 ? void 0 : _13.slice(26, 66));
         }
         if (!ovmAddress) {
-            throw new Error('Failed to extract contract addresses from multicall events');
+            throw new Error('Failed to extract contract addresses from multicall3 events');
         }
         return ovmAddress;
     }
@@ -508,7 +508,6 @@ const getChainConfig = (chainId) => {
  * @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));
@@ -520,7 +519,53 @@ const requestWithdrawalFromOVM = ({ ovmAddress, pubKeys, amounts, withdrawalFees
         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'}`);
+        const errorMessage = error instanceof Error ? error.message : 'Request withdrawal failed';
+        throw new Error(`Failed to request withdrawal from OVM: ${errorMessage}`);
     }
 });
 exports.requestWithdrawalFromOVM = requestWithdrawalFromOVM;
+/**
+ * Deposits to OVM contract using multicall3 for batch operations
+ * @param ovmAddress - The address of the OVM contract
+ * @param deposits - Array of deposit objects with all required parameters
+ * @param signer - The signer to use for the transaction
+ * @returns Promise that resolves to an array of transaction hashes
+ */
+const depositWithMulticall3 = ({ ovmAddress, deposits, signer, chainId, }) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const ovmContract = new ethers_1.Contract(ovmAddress, OVMFactory_1.OVMContract.abi, signer);
+        const chainConfig = getChainConfig(chainId);
+        const multicall3Address = chainConfig.MULTICALL3_CONTRACT.address;
+        const multiCall3ContractInstance = new ethers_1.Contract(multicall3Address, Multicall3_1.MultiCall3Contract.abi, signer);
+        const BATCH_SIZE = 500;
+        const txHashes = [];
+        // Process deposits in batches of 500
+        for (let i = 0; i < deposits.length; i += BATCH_SIZE) {
+            const batchDeposits = deposits.slice(i, i + BATCH_SIZE);
+            // Use Multicall3 aggregate3Value (payable per-call)
+            const callsWithValue = batchDeposits.map(deposit => ({
+                target: ovmAddress,
+                allowFailure: false,
+                callData: ovmContract.interface.encodeFunctionData('deposit', [
+                    deposit.pubkey,
+                    deposit.withdrawal_credentials,
+                    deposit.signature,
+                    deposit.deposit_data_root,
+                ]),
+                value: BigInt(deposit.amount),
+            }));
+            const totalBatchValue = callsWithValue.reduce((sum, c) => sum + c.value, BigInt(0));
+            const tx = yield multiCall3ContractInstance.aggregate3Value(callsWithValue, { value: totalBatchValue });
+            const receipt = yield tx.wait();
+            if (receipt === null || receipt === void 0 ? void 0 : receipt.hash) {
+                txHashes.push(receipt.hash);
+            }
+        }
+        return { txHashes };
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : 'Deposit failed';
+        throw new Error(`Failed to deposit to OVM with multicall3: ${errorMessage}`);
+    }
+});
+exports.depositWithMulticall3 = depositWithMulticall3;

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

@@ -65,21 +65,21 @@ class ObolSplits {
             }
             const ovmFactoryConfig = chainConfig.OVM_FACTORY_CONTRACT;
             const splitV2FactoryConfig = chainConfig.SPLIT_V2_FACTORY_CONTRACT;
-            const multiCallConfig = chainConfig.MULTICALL_CONTRACT;
+            const multiCall3Config = chainConfig.MULTICALL3_CONTRACT;
             if (!(ovmFactoryConfig === null || ovmFactoryConfig === void 0 ? void 0 : ovmFactoryConfig.address) ||
                 !(ovmFactoryConfig === null || ovmFactoryConfig === void 0 ? void 0 : ovmFactoryConfig.bytecode) ||
                 !(splitV2FactoryConfig === null || splitV2FactoryConfig === void 0 ? void 0 : splitV2FactoryConfig.address) ||
                 !(splitV2FactoryConfig === null || splitV2FactoryConfig === void 0 ? void 0 : splitV2FactoryConfig.bytecode) ||
-                !(multiCallConfig === null || multiCallConfig === void 0 ? void 0 : multiCallConfig.address) ||
-                !(multiCallConfig === null || multiCallConfig === void 0 ? void 0 : multiCallConfig.bytecode)) {
+                !(multiCall3Config === null || multiCall3Config === void 0 ? void 0 : multiCall3Config.address) ||
+                !(multiCall3Config === null || multiCall3Config === void 0 ? void 0 : multiCall3Config.bytecode)) {
                 throw new Error(`Contracts configuration is incomplete for chain ${this.chainId}`);
             }
             const checkOVMFactoryContract = yield (0, utils_1.isContractAvailable)(ovmFactoryConfig.address, this.provider, ovmFactoryConfig.bytecode);
             const checkSplitV2FactoryContract = yield (0, utils_1.isContractAvailable)(splitV2FactoryConfig.address, this.provider, splitV2FactoryConfig.bytecode);
-            const checkMultiCallContract = yield (0, utils_1.isContractAvailable)(multiCallConfig.address, this.provider, multiCallConfig.bytecode);
+            const checkMultiCall3Contract = yield (0, utils_1.isContractAvailable)(multiCall3Config.address, this.provider, multiCall3Config.bytecode);
             if (!checkOVMFactoryContract ||
                 !checkSplitV2FactoryContract ||
-                !checkMultiCallContract) {
+                !checkMultiCall3Contract) {
                 throw new Error(`Splitter contract is not deployed or available on chain ${this.chainId}`);
             }
             const retroActiveFundingRecipient = {
@@ -181,21 +181,21 @@ class ObolSplits {
             }
             const ovmFactoryConfig = chainConfig.OVM_FACTORY_CONTRACT;
             const splitV2FactoryConfig = chainConfig.SPLIT_V2_FACTORY_CONTRACT;
-            const multiCallConfig = chainConfig.MULTICALL_CONTRACT;
+            const multiCall3Config = chainConfig.MULTICALL3_CONTRACT;
             if (!(ovmFactoryConfig === null || ovmFactoryConfig === void 0 ? void 0 : ovmFactoryConfig.address) ||
                 !(ovmFactoryConfig === null || ovmFactoryConfig === void 0 ? void 0 : ovmFactoryConfig.bytecode) ||
                 !(splitV2FactoryConfig === null || splitV2FactoryConfig === void 0 ? void 0 : splitV2FactoryConfig.address) ||
                 !(splitV2FactoryConfig === null || splitV2FactoryConfig === void 0 ? void 0 : splitV2FactoryConfig.bytecode) ||
-                !(multiCallConfig === null || multiCallConfig === void 0 ? void 0 : multiCallConfig.address) ||
-                !(multiCallConfig === null || multiCallConfig === void 0 ? void 0 : multiCallConfig.bytecode)) {
+                !(multiCall3Config === null || multiCall3Config === void 0 ? void 0 : multiCall3Config.address) ||
+                !(multiCall3Config === null || multiCall3Config === void 0 ? void 0 : multiCall3Config.bytecode)) {
                 throw new Error(`Contracts configuration is incomplete for chain ${this.chainId}`);
             }
             const checkOVMFactoryContract = yield (0, utils_1.isContractAvailable)(ovmFactoryConfig.address, this.provider, ovmFactoryConfig.bytecode);
             const checkSplitV2FactoryContract = yield (0, utils_1.isContractAvailable)(splitV2FactoryConfig.address, this.provider, splitV2FactoryConfig.bytecode);
-            const checkMultiCallContract = yield (0, utils_1.isContractAvailable)(multiCallConfig.address, this.provider, multiCallConfig.bytecode);
+            const checkMultiCall3Contract = yield (0, utils_1.isContractAvailable)(multiCall3Config.address, this.provider, multiCall3Config.bytecode);
             if (!checkOVMFactoryContract ||
                 !checkSplitV2FactoryContract ||
-                !checkMultiCallContract) {
+                !checkMultiCall3Contract) {
                 throw new Error(`Splitter contract is not deployed or available on chain ${this.chainId}`);
             }
             const retroActiveFundingRecipient = {
@@ -255,7 +255,7 @@ class ObolSplits {
                 };
             }
             else {
-                // Use multicall to deploy any contracts that aren't deployed
+                // Use multicall3 to deploy any contracts that aren't deployed
                 const ovmAddress = yield (0, splitHelpers_1.deployOVMAndSplitV2)({
                     ovmArgs: {
                         OVMOwnerAddress: validatedPayload.OVMOwnerAddress,
@@ -319,5 +319,48 @@ class ObolSplits {
             });
         });
     }
+    /**
+     * Deposits to OVM contract using multicall3 for batch operations.
+     *
+     * This method allows depositing to an OVM contract using multicall3 for efficient batch processing.
+     * Each deposit includes validator public key, withdrawal credentials, signature, deposit data root, and amount.
+     *
+     * @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 {OVMDepositPayload} payload - Data needed to deposit to OVM
+     * @returns {Promise<{txHashes: string[]}>} Array of transaction hashes for all batches
+     * @throws Will throw an error if the signer is not provided, OVM address is invalid, or the deposit fails
+     *
+     * An example of how to use deposit:
+     * ```typescript
+     * const result = await client.splits.deposit({
+     *   ovmAddress: '0x1234567890123456789012345678901234567890',
+     *   deposits: [{
+     *     pubkey: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+     *     withdrawal_credentials: '0x1234567890123456789012345678901234567890',
+     *     signature: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+     *     deposit_data_root: '0x1234567890123456789012345678901234567890123456789012345678901234',
+     *     amount: '32000000000000000000' // 32 ETH in wei
+     *   }]
+     * });
+     * console.log('Deposits completed:', result.txHashes);
+     * ```
+     */
+    deposit(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.signer) {
+                throw new Error('Signer is required in deposit');
+            }
+            const validatedPayload = (0, ajv_1.validatePayload)(payload, schema_1.ovmDepositPayloadSchema);
+            return yield (0, splitHelpers_1.depositWithMulticall3)({
+                ovmAddress: validatedPayload.ovmAddress,
+                deposits: validatedPayload.deposits,
+                signer: this.signer,
+                chainId: this.chainId,
+            });
+        });
+    }
 }
 exports.ObolSplits = ObolSplits;

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

@@ -14,6 +14,7 @@ const eoaHelpers_1 = require("../../src/eoa/eoaHelpers");
 // Mock the helper function
 jest.mock('../../src/eoa/eoaHelpers', () => ({
     submitEOAWithdrawalRequest: jest.fn(),
+    submitEOABatchDeposit: jest.fn(),
 }));
 describe('EOA', () => {
     let eoa;
@@ -95,4 +96,78 @@ describe('EOA', () => {
             expect(result).toEqual(mockResult);
         }));
     });
+    describe('deposit', () => {
+        const mockDeposits = [
+            {
+                pubKey: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+                withdrawalCredentials: '0x1234567890123456789012345678901234567890123456789012345678901234',
+                signature: '0x121234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012000000000000000000',
+                amount: '32000000000000000000', // 32 ETH in wei
+            },
+        ];
+        it('should successfully deposit to batch contract', () => __awaiter(void 0, void 0, void 0, function* () {
+            const mockPayload = {
+                deposits: mockDeposits,
+            };
+            const mockResult = {
+                txHashes: [
+                    '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                ],
+            };
+            eoaHelpers_1.submitEOABatchDeposit.mockResolvedValue(mockResult);
+            const result = yield eoa.deposit(mockPayload);
+            expect(eoaHelpers_1.submitEOABatchDeposit).toHaveBeenCalledWith({
+                deposits: mockDeposits,
+                batchDepositContractAddress: '0xcD7a6C118Ac8F6544BC5076F2D8Fb86D2C546756',
+                signer: mockSigner,
+            });
+            expect(result).toEqual(mockResult);
+        }));
+        it('should throw error when signer is not provided', () => __awaiter(void 0, void 0, void 0, function* () {
+            const eoaWithoutSigner = new eoa_1.EOA(undefined, 1, mockProvider);
+            const mockPayload = {
+                deposits: mockDeposits,
+            };
+            yield expect(eoaWithoutSigner.deposit(mockPayload)).rejects.toThrow('Signer is required in deposit');
+        }));
+        it('should throw error when batch deposit contract is not configured for chain', () => __awaiter(void 0, void 0, void 0, function* () {
+            const eoaUnsupportedChain = new eoa_1.EOA(mockSigner, 999, mockProvider);
+            const mockPayload = {
+                deposits: mockDeposits,
+            };
+            yield expect(eoaUnsupportedChain.deposit(mockPayload)).rejects.toThrow('Batch deposit contract is not configured for chain 999');
+        }));
+        it('should handle multiple deposits', () => __awaiter(void 0, void 0, void 0, function* () {
+            const multipleDeposits = [
+                {
+                    pubKey: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+                    withdrawalCredentials: '0x1234567890123456789012345678901234567890123456789012345678901234',
+                    signature: '0x121234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012000000000000000000',
+                    amount: '32000000000000000000',
+                },
+                {
+                    pubKey: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdcd',
+                    withdrawalCredentials: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+                    signature: '0x121234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012000000000000000000',
+                    amount: '16000000000000000000',
+                },
+            ];
+            const mockPayload = {
+                deposits: multipleDeposits,
+            };
+            const mockResult = {
+                txHashes: [
+                    '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                ],
+            };
+            eoaHelpers_1.submitEOABatchDeposit.mockResolvedValue(mockResult);
+            const result = yield eoa.deposit(mockPayload);
+            expect(eoaHelpers_1.submitEOABatchDeposit).toHaveBeenCalledWith({
+                deposits: multipleDeposits,
+                batchDepositContractAddress: '0xcD7a6C118Ac8F6544BC5076F2D8Fb86D2C546756',
+                signer: mockSigner,
+            });
+            expect(result).toEqual(mockResult);
+        }));
+    });
 });