@obolnetwork/obol-sdk 2.10.2 → 2.11.2

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

@@ -14,3 +14,19 @@ export declare function submitEOAWithdrawalRequest({ pubkey, allocation, withdra
 }): Promise<{
     txHash: string | null;
 }>;
+/**
+ * Helper function to submit batch deposit request for EOA
+ */
+export declare function submitEOABatchDeposit({ deposits, batchDepositContractAddress, signer, }: {
+    deposits: Array<{
+        pubkey: string;
+        withdrawal_credentials: string;
+        signature: string;
+        deposit_data_root: string;
+        amount: string;
+    }>;
+    batchDepositContractAddress: string;
+    signer: SignerType;
+}): Promise<{
+    txHashes: string[];
+}>;

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

@@ -370,3 +370,83 @@ export declare const eoaWithdrawalPayloadSchema: {
     };
     required: string[];
 };
+export declare const ovmDepositPayloadSchema: {
+    type: string;
+    properties: {
+        ovmAddress: {
+            type: string;
+            pattern: string;
+        };
+        deposits: {
+            type: string;
+            minItems: number;
+            items: {
+                type: string;
+                properties: {
+                    pubkey: {
+                        type: string;
+                        pattern: string;
+                    };
+                    withdrawal_credentials: {
+                        type: string;
+                        pattern: string;
+                        description: string;
+                    };
+                    signature: {
+                        type: string;
+                        pattern: string;
+                        description: string;
+                    };
+                    deposit_data_root: {
+                        type: string;
+                        pattern: string;
+                    };
+                    amount: {
+                        type: string;
+                        pattern: string;
+                    };
+                };
+                required: string[];
+            };
+        };
+    };
+    required: string[];
+};
+export declare const eoaDepositPayloadSchema: {
+    type: string;
+    properties: {
+        deposits: {
+            type: string;
+            minItems: number;
+            items: {
+                type: string;
+                properties: {
+                    pubkey: {
+                        type: string;
+                        pattern: string;
+                    };
+                    withdrawal_credentials: {
+                        type: string;
+                        pattern: string;
+                        description: string;
+                    };
+                    signature: {
+                        type: string;
+                        pattern: string;
+                        description: string;
+                    };
+                    deposit_data_root: {
+                        type: string;
+                        pattern: string;
+                    };
+                    amount: {
+                        type: string;
+                        pattern: string;
+                    };
+                };
+                required: string[];
+            };
+        };
+    };
+    required: string[];
+};

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

@@ -61,7 +61,7 @@ export declare const getOWRTranches: ({ owrAddress, signer, }: {
     owrAddress: ETH_ADDRESS;
     signer: SignerType;
 }) => Promise<OWRTranches>;
-export declare const multicall: (calls: Call[], signer: SignerType, chainId: number) => Promise<any>;
+export declare const multicall3: (calls: Call[], signer: SignerType, chainId: number) => Promise<any>;
 export declare const formatRecipientsForSplitV2: (splitRecipients: SplitRecipient[] | SplitV2Recipient[]) => SplitV2Recipient[];
 export declare const predictSplitV2Address: ({ splitOwnerAddress, recipients, distributorFeePercent, salt, signer, chainId, }: {
     splitOwnerAddress: string;
@@ -116,4 +116,25 @@ export declare const requestWithdrawalFromOVM: ({ ovmAddress, pubKeys, amounts,
 }) => Promise<{
     txHash: string;
 }>;
+/**
+ * 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
+ */
+export declare const depositWithMulticall3: ({ ovmAddress, deposits, signer, chainId, }: {
+    ovmAddress: string;
+    deposits: Array<{
+        pubkey: string;
+        withdrawal_credentials: string;
+        signature: string;
+        deposit_data_root: string;
+        amount: string;
+    }>;
+    signer: SignerType;
+    chainId: number;
+}) => Promise<{
+    txHashes: 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, type OVMRequestWithdrawalPayload } from '../types';
+import { type ClusterValidator, type ProviderType, type SignerType, type OVMRewardsSplitPayload, type OVMTotalSplitPayload, type OVMRequestWithdrawalPayload, type OVMDepositPayload } from '../types';
 /**
  * ObolSplits can be used for creating and managing Obol splits.
  * @class
@@ -75,4 +75,36 @@ export declare class ObolSplits {
     requestWithdrawal(payload: OVMRequestWithdrawalPayload): Promise<{
         txHash: string;
     }>;
+    /**
+     * 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: OVMDepositPayload): Promise<{
+        txHashes: string[];
+    }>;
 }

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

@@ -447,7 +447,7 @@ export type ChainConfig = {
         address: string;
         bytecode: string;
     };
-    MULTICALL_CONTRACT: {
+    MULTICALL3_CONTRACT: {
         address: string;
         bytecode: string;
     };
@@ -474,6 +474,9 @@ export type ChainConfig = {
     EOA_WITHDRAWAL_CONTRACT?: {
         address: string;
     };
+    BATCH_DEPOSIT_CONTRACT?: {
+        address: string;
+    };
 };
 /**
  * Payload for requesting withdrawal from OVM contract
@@ -499,3 +502,41 @@ export type EOAWithdrawalPayload = {
     /** Required fee in wei */
     requiredFee: string;
 };
+/**
+ * Payload for depositing to OVM contract with multicall3
+ */
+export type OVMDepositPayload = {
+    /** OVM contract address */
+    ovmAddress: string;
+    /** Array of deposit objects */
+    deposits: Array<{
+        /** Validator public key in hex format (48 bytes) */
+        pubkey: string;
+        /** Withdrawal credentials in hex format */
+        withdrawal_credentials: string;
+        /** Deposit signature in hex format */
+        signature: string;
+        /** Deposit data root in hex format (32 bytes) */
+        deposit_data_root: string;
+        /** Deposit amount in wei as string */
+        amount: string;
+    }>;
+};
+/**
+ * Payload for depositing to batch deposit contract
+ */
+export type EOADepositPayload = {
+    /** Array of deposit objects */
+    deposits: Array<{
+        /** Validator public key in hex format (48 bytes) */
+        pubkey: string;
+        /** Withdrawal credentials in hex format */
+        withdrawal_credentials: string;
+        /** Deposit signature in hex format */
+        signature: string;
+        /** Deposit data root in hex format (32 bytes) */
+        deposit_data_root: string;
+        /** Deposit amount in wei as string */
+        amount: string;
+    }>;
+};

package/package.json

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

package/src/abi/BatchDeposit.ts

@@ -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/src/abi/Multicall3.ts

@@ -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',
+    },
+  ],
+};