@obolnetwork/obol-sdk 2.10.1 → 2.11.0

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

@@ -22,6 +22,7 @@ jest.mock('../../src/splits/splitHelpers', () => ({
     deployOVMContract: jest.fn(),
     deployOVMAndSplitV2: jest.fn(),
     requestWithdrawalFromOVM: jest.fn(),
+    depositWithMulticall3: jest.fn(),
 }));
 // Mock the utils
 jest.mock('../../src/utils', () => ({
@@ -38,6 +39,7 @@ const mockIsSplitV2Deployed = splitHelpers_1.isSplitV2Deployed;
 const mockDeployOVMAndSplitV2 = splitHelpers_1.deployOVMAndSplitV2;
 const mockDeployOVMContract = splitHelpers_1.deployOVMContract;
 const mockRequestWithdrawalFromOVM = splitHelpers_1.requestWithdrawalFromOVM;
+const mockdepositWithMulticall3 = splitHelpers_1.depositWithMulticall3;
 const mockIsContractAvailable = utils_1.isContractAvailable;
 describe('ObolSplits', () => {
     let client;
@@ -307,6 +309,88 @@ describe('ObolSplits', () => {
             });
         }));
     });
+    describe('deposit', () => {
+        const mockOVMAddress = '0x1234567890123456789012345678901234567890';
+        const mockDeposits = [
+            {
+                pubkey: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+                withdrawal_credentials: '0x1234567890123456789012345678901234567890',
+                signature: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+                deposit_data_root: '0x1234567890123456789012345678901234567890123456789012345678901234',
+                amount: '32000000000000000000', // 32 ETH in wei
+            },
+        ];
+        beforeEach(() => {
+            mockdepositWithMulticall3.mockReset();
+        });
+        it('should successfully deposit to OVM with multicall3', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockdepositWithMulticall3.mockResolvedValue({
+                txHashes: [
+                    '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                ],
+            });
+            const result = yield client.splits.deposit({
+                ovmAddress: mockOVMAddress,
+                deposits: mockDeposits,
+            });
+            expect(result).toEqual({
+                txHashes: [
+                    '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                ],
+            });
+            expect(mockdepositWithMulticall3).toHaveBeenCalledWith({
+                ovmAddress: mockOVMAddress,
+                deposits: mockDeposits,
+                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.deposit({
+                ovmAddress: mockOVMAddress,
+                deposits: mockDeposits,
+            })).rejects.toThrow('Signer is required in deposit');
+        }));
+        it('should handle multiple deposits', () => __awaiter(void 0, void 0, void 0, function* () {
+            const multipleDeposits = [
+                {
+                    pubkey: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+                    withdrawal_credentials: '0x1234567890123456789012345678901234567890',
+                    signature: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
+                    deposit_data_root: '0x1234567890123456789012345678901234567890123456789012345678901234',
+                    amount: '32000000000000000000', // 32 ETH in wei
+                },
+                {
+                    pubkey: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+                    withdrawal_credentials: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef',
+                    signature: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+                    deposit_data_root: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+                    amount: '16000000000000000000', // 16 ETH in wei
+                },
+            ];
+            mockdepositWithMulticall3.mockResolvedValue({
+                txHashes: [
+                    '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                ],
+            });
+            const result = yield client.splits.deposit({
+                ovmAddress: mockOVMAddress,
+                deposits: multipleDeposits,
+            });
+            expect(result).toEqual({
+                txHashes: [
+                    '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                ],
+            });
+            expect(mockdepositWithMulticall3).toHaveBeenCalledWith({
+                ovmAddress: mockOVMAddress,
+                deposits: multipleDeposits,
+                signer: mockSigner,
+                chainId: 1,
+            });
+        }));
+    });
     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.10.1",
+    "version": "2.11.0",
     "description": "A package for creating Distributed Validators using the Obol API.",
     "bugs": {
         "url": "https://github.com/obolnetwork/obol-sdk/issues"

package/dist/esm/src/abi/BatchDeposit.js

@@ -0,0 +1,117 @@
+export const BatchDepositContract = {
+    abi: [
+        {
+            inputs: [],
+            name: 'DepositValueGreaterThan2048ETH',
+            type: 'error',
+        },
+        {
+            inputs: [],
+            name: 'DepositValueLessThan1ETH',
+            type: 'error',
+        },
+        {
+            inputs: [],
+            name: 'DepositValueMustBeMultipleOfGwei',
+            type: 'error',
+        },
+        {
+            inputs: [],
+            name: 'InvalidPubKeyLength',
+            type: 'error',
+        },
+        {
+            inputs: [],
+            name: 'InvalidSignatureLength',
+            type: 'error',
+        },
+        {
+            inputs: [],
+            name: 'InvalidWithdrawalCredLength',
+            type: 'error',
+        },
+        {
+            inputs: [],
+            name: 'MsgValueNotEqualToTotalDepositAmount',
+            type: 'error',
+        },
+        {
+            inputs: [],
+            name: 'NoDepositsProvided',
+            type: 'error',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: true,
+                    internalType: 'bytes',
+                    name: 'pubKey',
+                    type: 'bytes',
+                },
+                {
+                    indexed: true,
+                    internalType: 'bytes',
+                    name: 'withdrawalCredentials',
+                    type: 'bytes',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'amount',
+                    type: 'uint256',
+                },
+            ],
+            name: 'ValidatorDeposit',
+            type: 'event',
+        },
+        {
+            inputs: [
+                {
+                    components: [
+                        {
+                            internalType: 'bytes',
+                            name: 'pubKey',
+                            type: 'bytes',
+                        },
+                        {
+                            internalType: 'bytes',
+                            name: 'withdrawalCredentials',
+                            type: 'bytes',
+                        },
+                        {
+                            internalType: 'bytes',
+                            name: 'signature',
+                            type: 'bytes',
+                        },
+                        {
+                            internalType: 'uint256',
+                            name: 'amount',
+                            type: 'uint256',
+                        },
+                    ],
+                    internalType: 'struct IBatchDeposit.Deposit[]',
+                    name: '_deposits',
+                    type: 'tuple[]',
+                },
+            ],
+            name: 'batchDeposit',
+            outputs: [],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'depositContract',
+            outputs: [
+                {
+                    internalType: 'contract IDepositContract',
+                    name: '',
+                    type: 'address',
+                },
+            ],
+            stateMutability: 'view',
+            type: 'function',
+        },
+    ],
+};

package/dist/esm/src/abi/Multicall3.js

@@ -0,0 +1,250 @@
+export const MultiCall3Contract = {
+    abi: [
+        {
+            inputs: [
+                {
+                    components: [
+                        { internalType: 'address', name: 'target', type: 'address' },
+                        { internalType: 'bytes', name: 'callData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Call[]',
+                    name: 'calls',
+                    type: 'tuple[]',
+                },
+            ],
+            name: 'aggregate',
+            outputs: [
+                { internalType: 'uint256', name: 'blockNumber', type: 'uint256' },
+                { internalType: 'bytes[]', name: 'returnData', type: 'bytes[]' },
+            ],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [
+                {
+                    components: [
+                        { internalType: 'address', name: 'target', type: 'address' },
+                        { internalType: 'bool', name: 'allowFailure', type: 'bool' },
+                        { internalType: 'bytes', name: 'callData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Call3[]',
+                    name: 'calls',
+                    type: 'tuple[]',
+                },
+            ],
+            name: 'aggregate3',
+            outputs: [
+                {
+                    components: [
+                        { internalType: 'bool', name: 'success', type: 'bool' },
+                        { internalType: 'bytes', name: 'returnData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Result[]',
+                    name: 'returnData',
+                    type: 'tuple[]',
+                },
+            ],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [
+                {
+                    components: [
+                        { internalType: 'address', name: 'target', type: 'address' },
+                        { internalType: 'bool', name: 'allowFailure', type: 'bool' },
+                        { internalType: 'uint256', name: 'value', type: 'uint256' },
+                        { internalType: 'bytes', name: 'callData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Call3Value[]',
+                    name: 'calls',
+                    type: 'tuple[]',
+                },
+            ],
+            name: 'aggregate3Value',
+            outputs: [
+                {
+                    components: [
+                        { internalType: 'bool', name: 'success', type: 'bool' },
+                        { internalType: 'bytes', name: 'returnData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Result[]',
+                    name: 'returnData',
+                    type: 'tuple[]',
+                },
+            ],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [
+                {
+                    components: [
+                        { internalType: 'address', name: 'target', type: 'address' },
+                        { internalType: 'bytes', name: 'callData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Call[]',
+                    name: 'calls',
+                    type: 'tuple[]',
+                },
+            ],
+            name: 'blockAndAggregate',
+            outputs: [
+                { internalType: 'uint256', name: 'blockNumber', type: 'uint256' },
+                { internalType: 'bytes32', name: 'blockHash', type: 'bytes32' },
+                {
+                    components: [
+                        { internalType: 'bool', name: 'success', type: 'bool' },
+                        { internalType: 'bytes', name: 'returnData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Result[]',
+                    name: 'returnData',
+                    type: 'tuple[]',
+                },
+            ],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getBasefee',
+            outputs: [{ internalType: 'uint256', name: 'basefee', type: 'uint256' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [
+                { internalType: 'uint256', name: 'blockNumber', type: 'uint256' },
+            ],
+            name: 'getBlockHash',
+            outputs: [
+                { internalType: 'bytes32', name: 'blockHash', type: 'bytes32' },
+            ],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getBlockNumber',
+            outputs: [
+                { internalType: 'uint256', name: 'blockNumber', type: 'uint256' },
+            ],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getChainId',
+            outputs: [{ internalType: 'uint256', name: 'chainid', type: 'uint256' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getCurrentBlockCoinbase',
+            outputs: [{ internalType: 'address', name: 'coinbase', type: 'address' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getCurrentBlockDifficulty',
+            outputs: [
+                { internalType: 'uint256', name: 'difficulty', type: 'uint256' },
+            ],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getCurrentBlockGasLimit',
+            outputs: [{ internalType: 'uint256', name: 'gaslimit', type: 'uint256' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getCurrentBlockTimestamp',
+            outputs: [
+                { internalType: 'uint256', name: 'timestamp', type: 'uint256' },
+            ],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [{ internalType: 'address', name: 'addr', type: 'address' }],
+            name: 'getEthBalance',
+            outputs: [{ internalType: 'uint256', name: 'balance', type: 'uint256' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getLastBlockHash',
+            outputs: [
+                { internalType: 'bytes32', name: 'blockHash', type: 'bytes32' },
+            ],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [
+                { internalType: 'bool', name: 'requireSuccess', type: 'bool' },
+                {
+                    components: [
+                        { internalType: 'address', name: 'target', type: 'address' },
+                        { internalType: 'bytes', name: 'callData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Call[]',
+                    name: 'calls',
+                    type: 'tuple[]',
+                },
+            ],
+            name: 'tryAggregate',
+            outputs: [
+                {
+                    components: [
+                        { internalType: 'bool', name: 'success', type: 'bool' },
+                        { internalType: 'bytes', name: 'returnData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Result[]',
+                    name: 'returnData',
+                    type: 'tuple[]',
+                },
+            ],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [
+                { internalType: 'bool', name: 'requireSuccess', type: 'bool' },
+                {
+                    components: [
+                        { internalType: 'address', name: 'target', type: 'address' },
+                        { internalType: 'bytes', name: 'callData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Call[]',
+                    name: 'calls',
+                    type: 'tuple[]',
+                },
+            ],
+            name: 'tryBlockAndAggregate',
+            outputs: [
+                { internalType: 'uint256', name: 'blockNumber', type: 'uint256' },
+                { internalType: 'bytes32', name: 'blockHash', type: 'bytes32' },
+                {
+                    components: [
+                        { internalType: 'bool', name: 'success', type: 'bool' },
+                        { internalType: 'bytes', name: 'returnData', type: 'bytes' },
+                    ],
+                    internalType: 'struct Multicall3.Result[]',
+                    name: 'returnData',
+                    type: 'tuple[]',
+                },
+            ],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+    ],
+};