ovm methods

Author: HananINouman

.gitignore

@@ -5,4 +5,9 @@ node_modules
 .DS_Store
 
 # Local
-dist
+dist
+
+# Environment variables
+.env
+.env.local
+.env.*.local

TS-Example/env.example

@@ -0,0 +1,26 @@
+# ============================================================================
+# REQUIRED ENVIRONMENT VARIABLES
+# ============================================================================
+
+# Your Ethereum private key (required for signing transactions)
+# IMPORTANT: Never commit your actual private key to version control!
+# Add your private key here (with or without 0x prefix)
+PRIVATE_KEY=
+
+# ============================================================================
+# OPTIONAL ENVIRONMENT VARIABLES (with defaults)
+# ============================================================================
+
+# Network Configuration
+CHAIN_ID=560048
+BASE_URL=https://obol-api-nonprod-dev.dev.obol.tech
+RPC_HOODI=https://ethereum-hoodi-rpc.publicnode.com
+RPC_URL=https://ethereum-hoodi-rpc.publicnode.com
+
+# Cluster Names
+CLUSTER_NAME_REWARDS_SPLIT=testOVMRewardsSplit
+CLUSTER_NAME_TOTAL_SPLIT=testOVMTotalSplit
+
+# Cluster Configuration
+NUM_VALIDATORS=3
+NUM_OPERATORS=4

TS-Example/index.ts

@@ -1,6 +1,6 @@
-import { ethers } from "ethers";
+import { ethers, JsonRpcProvider } from "ethers";
 import { Client, validateClusterLock, ClusterDefinition, ClusterLock, OperatorPayload, RewardsSplitPayload, ClusterValidator, TotalSplitPayload, ClaimIncentivesResponse, SignerType } from "@obolnetwork/obol-sdk";
-import { ClaimableIncentives, ExitClusterConfig, ExitValidationPayload, ProviderType } from "@obolnetwork/obol-sdk/dist/types/src/types";
+import type { ClaimableIncentives, ExitClusterConfig, ExitValidationPayload, ProviderType } from "@obolnetwork/obol-sdk";
 
 //To run the example in terminal, we can create a random privatekey to instanisiate obol-sdk Client
 const clusterConfig = {
@@ -208,6 +208,150 @@ const createObolTotalSplit = async ({
   }
 };
 
+/**
+ * Creates an OVM (One-Withdrawal-Registry) and Rewards Split using the splits class
+ * @param rewardsSplitConfig Configuration for rewards split including recipients, OVM owner, principal recipient, and distributor fee
+ * @returns Object containing withdrawal_address (OVM) and fee_recipient_address (Splitter)
+ */
+const createRewardsSplit = async (rewardsSplitConfig: {
+  rewardSplitRecipients: Array<{ address: string; percentAllocation: number }>;
+  OVMOwnerAddress: string;
+  principalRecipient: string;
+  distributorFeePercent: number;
+  splitOwnerAddress?: string;
+}): Promise<{ withdrawal_address: string; fee_recipient_address: string }> => {
+  try {
+    const result = await client.splits.createValidatorManagerAndRewardsSplit({
+      rewardSplitRecipients: rewardsSplitConfig.rewardSplitRecipients,
+      OVMOwnerAddress: rewardsSplitConfig.OVMOwnerAddress,
+      principalRecipient: rewardsSplitConfig.principalRecipient,
+      distributorFeePercent: rewardsSplitConfig.distributorFeePercent,
+      splitOwnerAddress: rewardsSplitConfig.splitOwnerAddress || rewardsSplitConfig.OVMOwnerAddress,
+    });
+    return {
+      withdrawal_address: result.withdrawal_address,
+      fee_recipient_address: result.fee_recipient_address,
+    };
+  } catch (err) {
+    console.log(err, "err");
+    throw err;
+  }
+};
+
+/**
+ * Creates an OVM (One-Withdrawal-Registry) and Total Split using the splits class
+ * @param totalSplitConfig Configuration for total split including reward and principal recipients, OVM owner, and distributor fee
+ * @returns Object containing withdrawal_address (OVM) and fee_recipient_address (Splitter)
+ */
+const createTotalSplit = async (totalSplitConfig: {
+  rewardSplitRecipients: Array<{ address: string; percentAllocation: number }>;
+  principalSplitRecipients: Array<{ address: string; percentAllocation: number }>;
+  OVMOwnerAddress: string;
+  distributorFeePercent: number;
+  splitOwnerAddress?: string;
+}): Promise<{ withdrawal_address: string; fee_recipient_address: string }> => {
+  try {
+    const result = await client.splits.createValidatorManagerAndTotalSplit({
+      rewardSplitRecipients: totalSplitConfig.rewardSplitRecipients,
+      principalSplitRecipients: totalSplitConfig.principalSplitRecipients,
+      OVMOwnerAddress: totalSplitConfig.OVMOwnerAddress,
+      distributorFeePercent: totalSplitConfig.distributorFeePercent,
+      splitOwnerAddress: totalSplitConfig.splitOwnerAddress || totalSplitConfig.OVMOwnerAddress,
+    });
+    return {
+      withdrawal_address: result.withdrawal_address,
+      fee_recipient_address: result.fee_recipient_address,
+    };
+  } catch (err) {
+    console.log(err, "err");
+    throw err;
+  }
+};
+
+/**
+ * Creates a cluster definition with rewards split configuration
+ * @param clusterName Name of the cluster
+ * @param ovmAddress OVM withdrawal address
+ * @param splitterAddress Splitter fee recipient address
+ * @param numValidators Number of validators in the cluster
+ * @param numOperators Number of operators in the cluster
+ * @returns The config hash of the created cluster definition
+ */
+const createRewardsSplitCluster = async (
+  clusterName: string,
+  ovmAddress: string,
+  splitterAddress: string,
+  numValidators: number = 3,
+  numOperators: number = 4,
+): Promise<string> => {
+  try {
+    // Create operators array with empty addresses for solo cluster
+    const operators = Array.from({ length: numOperators }, () => ({
+      address: "",
+    }));
+
+    // Create validators array - all validators use the same OVM and splitter addresses
+    const validators = Array.from({ length: numValidators }, () => ({
+      withdrawal_address: ovmAddress,
+      fee_recipient_address: splitterAddress,
+    }));
+
+    const clusterConfig = {
+      name: clusterName,
+      operators,
+      validators,
+    };
+
+    const configHash = await client.createClusterDefinition(clusterConfig);
+    return configHash;
+  } catch (err) {
+    console.log(err, "err");
+    throw err;
+  }
+};
+
+/**
+ * Creates a cluster definition with total split configuration
+ * @param clusterName Name of the cluster
+ * @param ovmAddress OVM withdrawal address
+ * @param splitterAddress Splitter fee recipient address
+ * @param numValidators Number of validators in the cluster
+ * @param numOperators Number of operators in the cluster
+ * @returns The config hash of the created cluster definition
+ */
+const createTotalSplitCluster = async (
+  clusterName: string,
+  ovmAddress: string,
+  splitterAddress: string,
+  numValidators: number = 3,
+  numOperators: number = 4,
+): Promise<string> => {
+  try {
+    // Create operators array with empty addresses for solo cluster
+    const operators = Array.from({ length: numOperators }, () => ({
+      address: "",
+    }));
+
+    // Create validators array - all validators use the same OVM and splitter addresses
+    const validators = Array.from({ length: numValidators }, () => ({
+      withdrawal_address: ovmAddress,
+      fee_recipient_address: splitterAddress,
+    }));
+
+    const clusterConfig = {
+      name: clusterName,
+      operators,
+      validators,
+    };
+
+    const configHash = await client.createClusterDefinition(clusterConfig);
+    return configHash;
+  } catch (err) {
+    console.log(err, "err");
+    throw err;
+  }
+};
+
 /**
  * Activates cluster by depositing 32 ethers
  * @param clusterLock The cluster lock that contains the validator to be activated

TS-Example/package.json

@@ -2,18 +2,23 @@
   "name": "ts-example",
   "version": "1.0.0",
   "description": "",
+  "packageManager": "yarn@1.22.22",
   "scripts": {
     "build": "esbuild ./*.ts --outdir=dist --out-extension:.js=.mjs  --format=esm",
-    "start": "node dist/index.mjs"
+    "start": "node dist/index.mjs",
+    "build:test-splits": "esbuild test-splits.ts --outdir=dist --out-extension:.js=.mjs --format=esm --platform=node",
+    "test:splits": "yarn build:test-splits && node dist/test-splits.mjs"
   },
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@types/node": "^20.0.0",
     "esbuild": "^0.18.17",
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@obolnetwork/obol-sdk": "^2.6.0",
+    "@obolnetwork/obol-sdk": "^2.11.8",
+    "dotenv": "^17.2.2",
     "ethers": "^6.4.0"
   }
 }