@obolnetwork/obol-sdk 2.6.0 → 2.8.0

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

@@ -176,3 +176,148 @@ export declare const rewardsSplitterPayloadSchema: {
     validateRewardsSplitRecipients: boolean;
     required: string[];
 };
+export declare const ovmBaseSplitPayload: {
+    rewardSplitRecipients: {
+        type: string;
+        items: {
+            type: string;
+            properties: {
+                address: {
+                    type: string;
+                    pattern: string;
+                };
+                percentAllocation: {
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+    };
+    OVMOwnerAddress: {
+        type: string;
+        pattern: string;
+    };
+    splitOwnerAddress: {
+        type: string;
+        pattern: string;
+        default: "0x0000000000000000000000000000000000000000";
+    };
+    principalThreshold: {
+        type: string;
+        minimum: number;
+        default: number;
+    };
+    distributorFeePercent: {
+        type: string;
+        minimum: number;
+        maximum: number;
+        default: number;
+    };
+};
+export declare const ovmRewardsSplitPayloadSchema: {
+    type: string;
+    properties: {
+        principalRecipient: {
+            type: string;
+            pattern: string;
+        };
+        rewardSplitRecipients: {
+            type: string;
+            items: {
+                type: string;
+                properties: {
+                    address: {
+                        type: string;
+                        pattern: string;
+                    };
+                    percentAllocation: {
+                        type: string;
+                    };
+                };
+                required: string[];
+            };
+        };
+        OVMOwnerAddress: {
+            type: string;
+            pattern: string;
+        };
+        splitOwnerAddress: {
+            type: string;
+            pattern: string;
+            default: "0x0000000000000000000000000000000000000000";
+        };
+        principalThreshold: {
+            type: string;
+            minimum: number;
+            default: number;
+        };
+        distributorFeePercent: {
+            type: string;
+            minimum: number;
+            maximum: number;
+            default: number;
+        };
+    };
+    validateOVMRewardsSplitRecipients: boolean;
+    required: string[];
+};
+export declare const ovmTotalSplitPayloadSchema: {
+    type: string;
+    properties: {
+        principalSplitRecipients: {
+            type: string;
+            items: {
+                type: string;
+                properties: {
+                    address: {
+                        type: string;
+                        pattern: string;
+                    };
+                    percentAllocation: {
+                        type: string;
+                    };
+                };
+                required: string[];
+            };
+        };
+        rewardSplitRecipients: {
+            type: string;
+            items: {
+                type: string;
+                properties: {
+                    address: {
+                        type: string;
+                        pattern: string;
+                    };
+                    percentAllocation: {
+                        type: string;
+                    };
+                };
+                required: string[];
+            };
+        };
+        OVMOwnerAddress: {
+            type: string;
+            pattern: string;
+        };
+        splitOwnerAddress: {
+            type: string;
+            pattern: string;
+            default: "0x0000000000000000000000000000000000000000";
+        };
+        principalThreshold: {
+            type: string;
+            minimum: number;
+            default: number;
+        };
+        distributorFeePercent: {
+            type: string;
+            minimum: number;
+            maximum: number;
+            default: number;
+        };
+    };
+    validateOVMRewardsSplitRecipients: boolean;
+    validateOVMTotalSplitRecipients: boolean;
+    required: string[];
+};

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

@@ -1,4 +1,5 @@
-import { type OWRTranches, type ClusterValidator, type ETH_ADDRESS, type SplitRecipient, type SignerType } from '../types';
+import { type OWRTranches, type ClusterValidator, type ETH_ADDRESS, type SplitRecipient, type SignerType, type SplitV2Recipient, type OVMArgs } from '../types';
+import { SplitsClient } from '@0xsplits/splits-sdk';
 type Call = {
     target: ETH_ADDRESS;
     callData: string;
@@ -62,4 +63,42 @@ export declare const getOWRTranches: ({ owrAddress, signer, }: {
     signer: SignerType;
 }) => Promise<OWRTranches>;
 export declare const multicall: (calls: Call[], signer: SignerType, multicallAddress: string) => Promise<any>;
+export declare const formatRecipientsForSplitV2: (splitRecipients: SplitRecipient[] | SplitV2Recipient[]) => SplitV2Recipient[];
+export declare const createSplitsClient: (signer: SignerType, chainId: number) => Promise<SplitsClient>;
+export declare const predictSplitV2Address: ({ splitOwnerAddress, recipients, distributorFeePercent, salt, signer, chainId, }: {
+    splitOwnerAddress: string;
+    recipients: SplitV2Recipient[];
+    distributorFeePercent: number;
+    salt: `0x${string}`;
+    signer: SignerType;
+    chainId: number;
+}) => Promise<string>;
+export declare const isSplitV2Deployed: ({ splitOwnerAddress, recipients, distributorFeePercent, salt, signer, chainId, }: {
+    splitOwnerAddress: string;
+    recipients: SplitV2Recipient[];
+    distributorFeePercent: number;
+    salt: `0x${string}`;
+    signer: SignerType;
+    chainId: number;
+}) => Promise<boolean>;
+export declare const deployOVMContract: ({ OVMOwnerAddress, principalRecipient, rewardRecipient, principalThreshold, signer, chainId, }: {
+    OVMOwnerAddress: string;
+    principalRecipient: string;
+    rewardRecipient: string;
+    principalThreshold: number;
+    signer: SignerType;
+    chainId: number;
+}) => Promise<string>;
+export declare const deployOVMAndSplitV2: ({ ovmArgs, rewardRecipients, isRewardsSplitterDeployed, distributorFeePercent, salt, signer, chainId, principalSplitRecipients, isPrincipalSplitDeployed, splitOwnerAddress, }: {
+    ovmArgs: OVMArgs;
+    rewardRecipients: SplitV2Recipient[];
+    isRewardsSplitterDeployed?: boolean | undefined;
+    distributorFeePercent: number;
+    salt: `0x${string}`;
+    signer: SignerType;
+    chainId: number;
+    principalSplitRecipients?: SplitV2Recipient[] | undefined;
+    isPrincipalSplitDeployed?: boolean | undefined;
+    splitOwnerAddress: string;
+}) => Promise<string>;
 export {};

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

@@ -0,0 +1,51 @@
+import { type ClusterValidator, type ProviderType, type SignerType, type OVMRewardsSplitPayload, type OVMTotalSplitPayload } from '../types';
+/**
+ * ObolSplits can be used for creating and managing Obol splits.
+ * @class
+ * @internal Access it through Client.splits.
+ * @example
+ * const obolClient = new Client(config);
+ * await obolClient.splits.createValidatorManagerAndRewardsSplit(OVMRewardsSplitPayload);
+ */
+export declare class ObolSplits {
+    private readonly signer;
+    readonly chainId: number;
+    readonly provider: ProviderType | undefined | null;
+    constructor(signer: SignerType | undefined, chainId: number, provider: ProviderType | undefined | null);
+    /**
+     * Creates an Obol OVM and Pull split configuration for rewards-only scenario.
+     *
+     * This method deploys OVM and SplitV2 contracts for managing validator rewards only.
+     * Principal is handled by a single address, while rewards are split among recipients.
+     *
+     * @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 {OVMRewardsSplitPayload} payload - Data needed to deploy OVM and SplitV2
+     * @returns {Promise<ClusterValidator>} OVM address as withdrawal address and splitter as fee recipient
+     * @throws Will throw an error if the splitter configuration is not supported or deployment fails
+     *
+     * An example of how to use createValidatorManagerAndRewardsSplit:
+     * [createValidatorManagerAndRewardsSplit](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L333)
+     */
+    createValidatorManagerAndRewardsSplit(payload: OVMRewardsSplitPayload): Promise<ClusterValidator>;
+    /**
+     * Creates an Obol OVM and Total split configuration for total split scenario.
+     *
+     * This method deploys OVM and SplitV2 contracts for managing both validator rewards and principal.
+     * Both rewards and principal are split among recipients, with rewards including RAF recipient.
+     *
+     * @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 {OVMTotalSplitPayload} payload - Data needed to deploy OVM and SplitV2
+     * @returns {Promise<ClusterValidator>} OVM address as withdrawal address and splitter as fee recipient
+     * @throws Will throw an error if the splitter configuration is not supported or deployment fails
+     *
+     * An example of how to use createValidatorManagerAndTotalSplit:
+     * [createValidatorManagerAndTotalSplit](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#340)
+     */
+    createValidatorManagerAndTotalSplit(payload: OVMTotalSplitPayload): Promise<ClusterValidator>;
+}

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

@@ -1,4 +1,4 @@
-import { type Wallet, type ethers, type JsonRpcApiProvider, type JsonRpcProvider, type JsonRpcSigner, type Provider, type Signer } from 'ethers';
+import { type Wallet, type ethers, type JsonRpcApiProvider, type JsonRpcProvider, type JsonRpcSigner, type Provider } from 'ethers';
 /**
  * Permitted ChainID's
  */
@@ -139,6 +139,48 @@ export interface RewardsSplitPayload extends TotalSplitPayload {
     /** Address that can control where the owr erc-20 tokens can be pushed, if set to zero it goes to splitter or principal address. */
     recoveryAddress?: string;
 }
+/**
+ * OVM and SplitV2 Base Params
+ */
+export type OVMBaseSplitPayload = {
+    /** The split recipients addresses and splits. */
+    rewardSplitRecipients: SplitV2Recipient[];
+    /** Owner address for the OVM contract. */
+    OVMOwnerAddress: string;
+    /** Owner address for the splitter contracts. */
+    splitOwnerAddress?: string;
+    /** Principal threshold for OVM contract. */
+    principalThreshold?: number;
+    /** Distributor fee percentage (0-10). */
+    distributorFeePercent?: number;
+};
+/**
+ * OVM and SplitV2 Params for rewards-only split
+ */
+export type OVMRewardsSplitPayload = OVMBaseSplitPayload & {
+    /** Principal recipient address (single address for rewards-only split). */
+    principalRecipient: string;
+};
+/**
+ * OVM and SplitV2 Params for total split scenario
+ */
+export type OVMTotalSplitPayload = OVMBaseSplitPayload & {
+    /** Principal recipients addresses and splits (array for total split scenario). */
+    principalSplitRecipients: SplitV2Recipient[];
+};
+/**
+ * Union type for both OVM split scenarios
+ */
+export type OVMSplitPayload = OVMRewardsSplitPayload | OVMTotalSplitPayload;
+/**
+ * SplitV2 Recipient structure
+ */
+export type SplitV2Recipient = {
+    /** Recipient address. */
+    address: string;
+    /** Percentage allocation (0-100 with up to 4 decimals). */
+    percentAllocation: number;
+};
 /**
  * OWR Tranches
  */
@@ -247,7 +289,7 @@ export type SafeRpcUrl = string;
 /**
  * Signer Types
  */
-export type SignerType = Signer | JsonRpcSigner | Wallet;
+export type SignerType = JsonRpcSigner | Wallet;
 /**
  * claimIncentives Response
  */
@@ -332,17 +374,52 @@ export interface ExitValidationPayload {
  * Represents the data structure for an already existing exit blob for exit validation.
  */
 export interface ExistingExitValidationBlobData {
-    /** The public key of the validator to exit. */
+    /**
+     * The BLS public key of the validator in hex format
+     */
     public_key: string;
-    /** The epoch at which the validator wishes to exit. */
+    /**
+     * The epoch number when the exit is scheduled to occur
+     */
     epoch: string;
-    /** The index of the validator in the beacon chain. */
+    /**
+     * The unique index of the validator in the beacon chain
+     */
     validator_index: string;
-    /** Collection of partial exit signatures from different shares. */
+    /**
+     * Array of distributed validator shares exit data, where each share contains
+     * the partial exit signature from each operator in the cluster
+     */
     shares_exit_data: Array<Record<string, {
         partial_exit_signature: string;
     }>>;
 }
+export interface FullExitBlob {
+    /**
+     * The signed voluntary exit message containing the exit details and signature
+     */
+    signed_exit_message: {
+        /**
+         * The voluntary exit message details
+         */
+        message: {
+            /**
+             * The epoch number when the validator exit will be processed
+             */
+            epoch: string;
+            /**
+             * The unique index of the validator requesting to exit
+             */
+            validator_index: string;
+        };
+        /**
+         * The BLS12-381 hex-encoded signature of the exit message
+         */
+        signature: string;
+    };
+    /** The public key of the validator to exit. */
+    public_key: string;
+}
 /**
  * Generic HTTP request function type.
  * Args:
@@ -352,3 +429,42 @@ export interface ExistingExitValidationBlobData {
  *  Promise<any> - The response data.
  */
 export type HttpRequestFunc = (url: string, config?: Record<string, any>) => Promise<any>;
+/**
+ * OVM Arguments for contract creation
+ */
+export type OVMArgs = {
+    /** Owner address for the OVM contract. */
+    OVMOwnerAddress: string;
+    /** Principal recipient address. */
+    principalRecipient: string;
+    /** Rewards recipient of the cluster. */
+    rewardRecipient: string;
+    /** Principal threshold for OVM contract. */
+    principalThreshold: number;
+};
+export type ChainConfig = {
+    SPLITMAIN_ADDRESS: {
+        address: string;
+        bytecode: string;
+    };
+    MULTICALL_ADDRESS: {
+        address: string;
+        bytecode: string;
+    };
+    OWR_FACTORY_ADDRESS: {
+        address: string;
+        bytecode: string;
+    };
+    RETROACTIVE_FUNDING_ADDRESS: {
+        address: string;
+        bytecode: string;
+    };
+    OVM_FACTORY_ADDRESS?: {
+        address: string;
+        bytecode: string;
+    };
+    WAREHOUSE_ADDRESS?: {
+        address: string;
+        bytecode: string;
+    };
+};

package/dist/types/test/client/ajv.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/client/methods.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/fixtures.d.ts

@@ -1,3 +1,13 @@
+export declare const TEST_ADDRESSES: {
+    readonly REWARD_RECIPIENT_1: "0x1234567890123456789012345678901234567890";
+    readonly REWARD_RECIPIENT_2: "0x2345678901234567890123456789012345678901";
+    readonly PRINCIPAL_RECIPIENT_1: "0x3456789012345678901234567890123456789012";
+    readonly PRINCIPAL_RECIPIENT_2: "0x4567890123456789012345678901234567890123";
+    readonly OVM_OWNER: "0x5678901234567890123456789012345678901234";
+    readonly SPLIT_OWNER: "0x6789012345678901234567890123456789012345";
+    readonly PRINCIPAL_RECIPIENT: "0x7890123456789012345678901234567890123456";
+    readonly ZERO_ADDRESS: string;
+};
 export declare const enr = "enr:-HW4QLlrtMjFLGkFT1bwdGbvZQlH8hLi0M2g44JAxEYP3BZmYpcsy9Q56HPPD87fMucjvLv4-obEFacpsg0ehRilbHeAgmlkgnY0iXNlY3AyNTZrMaEDRaa5o2aSgqyFq_ERZcQTztrOij1mFtXX1bJuVI6ieak";
 export declare const clusterLockV1X6: {
     cluster_definition: {

package/dist/types/test/splits/splits.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obolnetwork/obol-sdk",
-  "version": "2.6.0",
+  "version": "2.8.0",
   "description": "A package for creating Distributed Validators using the Obol API.",
   "bugs": {
     "url": "https://github.com/obolnetwork/obol-sdk/issues"
@@ -40,6 +40,7 @@
     "access": "public"
   },
   "dependencies": {
+    "@0xsplits/splits-sdk": "^5.1.0",
     "@chainsafe/bls": "6.0.3",
     "@chainsafe/blst": "^0.2.9",
     "@chainsafe/discv5": "^0.5.1",
@@ -63,7 +64,8 @@
     "pdf-parse": "^1.1.1",
     "semver": "^7.6.0",
     "typescript-eslint": "^7.1.0",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.0",
+    "viem": "^2.31.4"
   },
   "devDependencies": {
     "@release-it/conventional-changelog": "^8.0.1",