@obolnetwork/obol-sdk 2.8.0 → 2.9.0

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';
 
 /**
@@ -87,7 +90,7 @@ export class ObolSplits {
     }
 
     const chainConfig = CHAIN_CONFIGURATION[this.chainId];
-    if (!chainConfig?.OVM_FACTORY_ADDRESS) {
+    if (!chainConfig?.OVM_FACTORY_CONTRACT) {
       throw new Error(
         `OVM contract factory is not configured for chain ${this.chainId}`,
       );
@@ -98,28 +101,53 @@ export class ObolSplits {
         'Provider is required to check OVM factory contract availability',
       );
     }
-
-    const ovmFactoryConfig = chainConfig.OVM_FACTORY_ADDRESS;
-    if (!ovmFactoryConfig?.address || !ovmFactoryConfig?.bytecode) {
+    const ovmFactoryConfig = chainConfig.OVM_FACTORY_CONTRACT;
+    const splitV2FactoryConfig = chainConfig.SPLIT_V2_FACTORY_CONTRACT;
+    const multiCallConfig = chainConfig.MULTICALL_CONTRACT;
+
+    if (
+      !ovmFactoryConfig?.address ||
+      !ovmFactoryConfig?.bytecode ||
+      !splitV2FactoryConfig?.address ||
+      !splitV2FactoryConfig?.bytecode ||
+      !multiCallConfig?.address ||
+      !multiCallConfig?.bytecode
+    ) {
       throw new Error(
-        `OVM factory contract configuration is incomplete for chain ${this.chainId}`,
+        `Contracts configuration is incomplete for chain ${this.chainId}`,
       );
     }
 
-    const checkOVMFactoryAddress = await isContractAvailable(
+    const checkOVMFactoryContract = await isContractAvailable(
       ovmFactoryConfig.address,
       this.provider,
       ovmFactoryConfig.bytecode,
     );
 
-    if (!checkOVMFactoryAddress) {
+    const checkSplitV2FactoryContract = await isContractAvailable(
+      splitV2FactoryConfig.address,
+      this.provider,
+      splitV2FactoryConfig.bytecode,
+    );
+
+    const checkMultiCallContract = await isContractAvailable(
+      multiCallConfig.address,
+      this.provider,
+      multiCallConfig.bytecode,
+    );
+
+    if (
+      !checkOVMFactoryContract ||
+      !checkSplitV2FactoryContract ||
+      !checkMultiCallContract
+    ) {
       throw new Error(
-        `OVM factory contract is not deployed or available on chain ${this.chainId}`,
+        `Splitter contract is not deployed or available on chain ${this.chainId}`,
       );
     }
 
     const retroActiveFundingRecipient = {
-      address: chainConfig.RETROACTIVE_FUNDING_ADDRESS.address,
+      address: chainConfig.RETROACTIVE_FUNDING_CONTRACT.address,
       percentAllocation: DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT,
     };
 
@@ -228,7 +256,7 @@ export class ObolSplits {
     }
 
     const chainConfig = CHAIN_CONFIGURATION[this.chainId];
-    if (!chainConfig?.OVM_FACTORY_ADDRESS) {
+    if (!chainConfig?.OVM_FACTORY_CONTRACT) {
       throw new Error(
         `OVM contract factory is not configured for chain ${this.chainId}`,
       );
@@ -240,27 +268,53 @@ export class ObolSplits {
       );
     }
 
-    const ovmFactoryConfig = chainConfig.OVM_FACTORY_ADDRESS;
-    if (!ovmFactoryConfig?.address || !ovmFactoryConfig?.bytecode) {
+    const ovmFactoryConfig = chainConfig.OVM_FACTORY_CONTRACT;
+    const splitV2FactoryConfig = chainConfig.SPLIT_V2_FACTORY_CONTRACT;
+    const multiCallConfig = chainConfig.MULTICALL_CONTRACT;
+
+    if (
+      !ovmFactoryConfig?.address ||
+      !ovmFactoryConfig?.bytecode ||
+      !splitV2FactoryConfig?.address ||
+      !splitV2FactoryConfig?.bytecode ||
+      !multiCallConfig?.address ||
+      !multiCallConfig?.bytecode
+    ) {
       throw new Error(
-        `OVM factory contract configuration is incomplete for chain ${this.chainId}`,
+        `Contracts configuration is incomplete for chain ${this.chainId}`,
       );
     }
 
-    const checkOVMFactoryAddress = await isContractAvailable(
+    const checkOVMFactoryContract = await isContractAvailable(
       ovmFactoryConfig.address,
       this.provider,
       ovmFactoryConfig.bytecode,
     );
 
-    if (!checkOVMFactoryAddress) {
+    const checkSplitV2FactoryContract = await isContractAvailable(
+      splitV2FactoryConfig.address,
+      this.provider,
+      splitV2FactoryConfig.bytecode,
+    );
+
+    const checkMultiCallContract = await isContractAvailable(
+      multiCallConfig.address,
+      this.provider,
+      multiCallConfig.bytecode,
+    );
+
+    if (
+      !checkOVMFactoryContract ||
+      !checkSplitV2FactoryContract ||
+      !checkMultiCallContract
+    ) {
       throw new Error(
-        `OVM factory contract is not deployed or available on chain ${this.chainId}`,
+        `Splitter contract is not deployed or available on chain ${this.chainId}`,
       );
     }
 
     const retroActiveFundingRecipient = {
-      address: chainConfig.RETROACTIVE_FUNDING_ADDRESS.address,
+      address: chainConfig.RETROACTIVE_FUNDING_CONTRACT.address,
       percentAllocation: DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT,
     };
 
@@ -352,4 +406,48 @@ 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,
+      signer: this.signer,
+    });
+  }
 }

package/src/types.ts

@@ -578,28 +578,46 @@ export type OVMArgs = {
 };
 
 export type ChainConfig = {
-  SPLITMAIN_ADDRESS: {
+  SPLITMAIN_CONTRACT: {
     address: string;
     bytecode: string;
   };
-  MULTICALL_ADDRESS: {
+  MULTICALL_CONTRACT: {
     address: string;
     bytecode: string;
   };
-  OWR_FACTORY_ADDRESS: {
+  OWR_FACTORY_CONTRACT: {
     address: string;
     bytecode: string;
   };
-  RETROACTIVE_FUNDING_ADDRESS: {
+  RETROACTIVE_FUNDING_CONTRACT: {
     address: string;
     bytecode: string;
   };
-  OVM_FACTORY_ADDRESS?: {
+  OVM_FACTORY_CONTRACT?: {
     address: string;
     bytecode: string;
   };
-  WAREHOUSE_ADDRESS?: {
+  WAREHOUSE_CONTRACT?: {
     address: string;
     bytecode: string;
   };
+  SPLIT_V2_FACTORY_CONTRACT?: {
+    address: string;
+    bytecode: string;
+  };
+};
+
+/**
+ * Payload for requesting withdrawal from OVM contract
+ */
+export type OVMRequestWithdrawalPayload = {
+  /** 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[];
 };