@obolnetwork/obol-sdk 2.9.0 → 2.10.0

package/src/schema.ts

@@ -233,6 +233,10 @@ export const ovmTotalSplitPayloadSchema = {
 export const ovmRequestWithdrawalPayloadSchema = {
   type: 'object',
   properties: {
+    withdrawalFees: {
+      type: 'string',
+      pattern: '^[0-9]+$',
+    },
     ovmAddress: {
       type: 'string',
       pattern: '^0x[a-fA-F0-9]{40}$',
@@ -255,5 +259,24 @@ export const ovmRequestWithdrawalPayloadSchema = {
     },
   },
   validateOVMRequestWithdrawalPayload: true,
-  required: ['ovmAddress', 'pubKeys', 'amounts'],
+  required: ['ovmAddress', 'pubKeys', 'amounts', 'withdrawalFees'],
+};
+
+export const eoaWithdrawalPayloadSchema = {
+  type: 'object',
+  properties: {
+    pubkey: {
+      type: 'string',
+      pattern: '^0x[a-fA-F0-9]{96}$', // 48 bytes = 96 hex chars + 0x prefix
+    },
+    allocation: {
+      type: 'number',
+      minimum: 0,
+    },
+    requiredFee: {
+      type: 'string',
+      pattern: '^[0-9]+$',
+    },
+  },
+  required: ['pubkey', 'allocation', 'requiredFee'],
 };

package/src/splits/splitHelpers.ts

@@ -13,7 +13,7 @@ import { OWRContract, OWRFactoryContract } from '../abi/OWR';
 import { OVMFactoryContract, OVMContract } from '../abi/OVMFactory';
 import { splitMainEthereumAbi } from '../abi/SplitMain';
 import { MultiCallContract } from '../abi/Multicall';
-import { CHAIN_CONFIGURATION } from '../constants';
+import { CHAIN_CONFIGURATION, ETHER_TO_GWEI } from '../constants';
 import { splitV2FactoryAbi } from '../abi/splitV2FactoryAbi';
 
 const splitMainContractInterface = new Interface(splitMainEthereumAbi);
@@ -742,7 +742,7 @@ export const deployOVMContract = async ({
       OVMOwnerAddress,
       principalRecipient,
       rewardRecipient,
-      principalThreshold,
+      principalThreshold * ETHER_TO_GWEI,
     );
 
     const receipt = await tx.wait();
@@ -837,7 +837,7 @@ export const deployOVMAndSplitV2 = async ({
       ovmArgs.OVMOwnerAddress,
       ovmArgs.principalRecipient,
       ovmArgs.rewardRecipient,
-      ovmArgs.principalThreshold,
+      ovmArgs.principalThreshold * ETHER_TO_GWEI,
     );
 
     executeCalls.push({
@@ -923,11 +923,13 @@ export const requestWithdrawalFromOVM = async ({
   ovmAddress,
   pubKeys,
   amounts,
+  withdrawalFees,
   signer,
 }: {
   ovmAddress: string;
   pubKeys: string[];
   amounts: string[];
+  withdrawalFees: string;
   signer: SignerType;
 }): Promise<{ txHash: string }> => {
   try {
@@ -936,7 +938,9 @@ export const requestWithdrawalFromOVM = async ({
 
     const ovmContract = new Contract(ovmAddress, OVMContract.abi, signer);
 
-    const tx = await ovmContract.requestWithdrawal(pubKeys, bigintAmounts);
+    const tx = await ovmContract.requestWithdrawal(pubKeys, bigintAmounts, {
+      value: BigInt(withdrawalFees),
+    });
     const receipt = await tx.wait();
 
     return { txHash: receipt.hash };

package/src/splits/splits.ts

@@ -447,6 +447,7 @@ export class ObolSplits {
       ovmAddress: validatedPayload.ovmAddress,
       pubKeys: validatedPayload.pubKeys,
       amounts: validatedPayload.amounts,
+      withdrawalFees: validatedPayload.withdrawalFees,
       signer: this.signer,
     });
   }

package/src/types.ts

@@ -214,7 +214,7 @@ export type OVMBaseSplitPayload = {
   /** Owner address for the splitter contracts. */
   splitOwnerAddress?: string;
 
-  /** Principal threshold for OVM contract. */
+  /** Principal threshold in ETH for OVM contract. */
   principalThreshold?: number;
 
   /** Distributor fee percentage (0-10). */
@@ -573,7 +573,7 @@ export type OVMArgs = {
   /** Rewards recipient of the cluster. */
   rewardRecipient: string;
 
-  /** Principal threshold for OVM contract. */
+  /** Principal threshold in ETH for OVM contract. */
   principalThreshold: number;
 };
 
@@ -606,12 +606,18 @@ export type ChainConfig = {
     address: string;
     bytecode: string;
   };
+  EOA_WITHDRAWAL_CONTRACT?: {
+    address: string;
+  };
 };
 
 /**
  * Payload for requesting withdrawal from OVM contract
  */
 export type OVMRequestWithdrawalPayload = {
+  /** request withdrawal fees in wei */
+  withdrawalFees: string;
+
   /** OVM contract address */
   ovmAddress: string;
 
@@ -621,3 +627,17 @@ export type OVMRequestWithdrawalPayload = {
   /** Array of withdrawal amounts in gwei (uint64) as strings */
   amounts: string[];
 };
+
+/**
+ * Payload for requesting withdrawal from EOA contract
+ */
+export type EOAWithdrawalPayload = {
+  /** Validator public key in hex format */
+  pubkey: string;
+
+  /** Withdrawal amount in ETH */
+  allocation: number;
+
+  /** Required fee in wei */
+  requiredFee: string;
+};