@obolnetwork/obol-sdk 2.1.0 → 2.1.2

package/dist/cjs/package.json

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

package/dist/cjs/src/abi/OWR.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OWRFactoryContract = void 0;
+exports.OWRContract = exports.OWRFactoryContract = void 0;
 exports.OWRFactoryContract = {
     abi: [
         {
@@ -131,3 +131,174 @@ exports.OWRFactoryContract = {
         },
     ],
 };
+exports.OWRContract = {
+    abi: [
+        { inputs: [], stateMutability: 'nonpayable', type: 'constructor' },
+        { inputs: [], name: 'InvalidDistribution_TooLarge', type: 'error' },
+        {
+            inputs: [],
+            name: 'InvalidTokenRecovery_InvalidRecipient',
+            type: 'error',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'principalPayout',
+                    type: 'uint256',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'rewardPayout',
+                    type: 'uint256',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'pullFlowFlag',
+                    type: 'uint256',
+                },
+            ],
+            name: 'DistributeFunds',
+            type: 'event',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'amount',
+                    type: 'uint256',
+                },
+            ],
+            name: 'ReceiveETH',
+            type: 'event',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'recoveryAddressToken',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'recipient',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'amount',
+                    type: 'uint256',
+                },
+            ],
+            name: 'RecoverNonOWRecipientFunds',
+            type: 'event',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'account',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'amount',
+                    type: 'uint256',
+                },
+            ],
+            name: 'Withdrawal',
+            type: 'event',
+        },
+        {
+            inputs: [],
+            name: 'claimedPrincipalFunds',
+            outputs: [{ internalType: 'uint128', name: '', type: 'uint128' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'distributeFunds',
+            outputs: [],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'distributeFundsPull',
+            outputs: [],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'fundsPendingWithdrawal',
+            outputs: [{ internalType: 'uint128', name: '', type: 'uint128' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [{ internalType: 'address', name: 'account', type: 'address' }],
+            name: 'getPullBalance',
+            outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getTranches',
+            outputs: [
+                {
+                    internalType: 'address',
+                    name: 'principalRecipient',
+                    type: 'address',
+                },
+                { internalType: 'address', name: 'rewardRecipient', type: 'address' },
+                {
+                    internalType: 'uint256',
+                    name: 'amountOfPrincipalStake',
+                    type: 'uint256',
+                },
+            ],
+            stateMutability: 'pure',
+            type: 'function',
+        },
+        {
+            inputs: [
+                { internalType: 'address', name: 'nonOWRToken', type: 'address' },
+                { internalType: 'address', name: 'recipient', type: 'address' },
+            ],
+            name: 'recoverFunds',
+            outputs: [],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'recoveryAddress',
+            outputs: [{ internalType: 'address', name: '', type: 'address' }],
+            stateMutability: 'pure',
+            type: 'function',
+        },
+        {
+            inputs: [{ internalType: 'address', name: 'account', type: 'address' }],
+            name: 'withdraw',
+            outputs: [],
+            stateMutability: 'nonpayable',
+            type: 'function',
+        },
+    ],
+};

package/dist/cjs/src/index.js

@@ -74,6 +74,7 @@ class Client extends base_js_1.Base {
                     address,
                     version: constants_js_1.TERMS_AND_CONDITIONS_VERSION,
                     terms_and_conditions_hash: termsAndConditionsHash,
+                    fork_version: this.fork_version,
                 };
                 const termsAndConditionsSignature = yield this.signer.signTypedData((0, constants_js_1.Domain)(), constants_js_1.TermsAndConditionsSigningTypes, {
                     terms_and_conditions_hash: termsAndConditionsHash,
@@ -239,6 +240,26 @@ class Client extends base_js_1.Base {
             };
         });
     }
+    /**
+     * Read OWR Tranches.
+     *
+     * @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 {ETH_ADDRESS} owrAddress - Address of the Deployed OWR Contract
+     * @returns {Promise<OWRTranches>} owr tranch information about principal and reward reciepient, as well as the principal amount
+     *
+     */
+    getOWRTranches(owrAddress) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.signer) {
+                throw new Error('Signer is required in getOWRTranches');
+            }
+            const signer = this.signer;
+            return yield (0, splitHelpers_js_1.getOWRTranches)({ owrAddress, signer });
+        });
+    }
     /**
      * Creates a cluster definition which contains cluster configuration.
      * @param {ClusterPayload} newCluster - The new unique cluster.

package/dist/cjs/src/splitHelpers.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.multicall = exports.deploySplitterAndOWRContracts = exports.deploySplitterContract = exports.handleDeployOWRAndSplitter = exports.predictSplitterAddress = exports.formatSplitRecipients = void 0;
+exports.multicall = exports.getOWRTranches = exports.deploySplitterAndOWRContracts = exports.deploySplitterContract = exports.handleDeployOWRAndSplitter = exports.predictSplitterAddress = exports.formatSplitRecipients = void 0;
 const ethers_1 = require("ethers");
 const OWR_1 = require("./abi/OWR");
 const SplitMain_1 = require("./abi/SplitMain");
@@ -152,6 +152,16 @@ const deploySplitterAndOWRContracts = ({ owrArgs, splitterArgs, signer, chainId,
     }
 });
 exports.deploySplitterAndOWRContracts = deploySplitterAndOWRContracts;
+const getOWRTranches = ({ owrAddress, signer, }) => __awaiter(void 0, void 0, void 0, function* () {
+    const owrContract = new ethers_1.Contract(owrAddress, OWR_1.OWRContract.abi, signer);
+    const res = yield owrContract.getTranches();
+    return {
+        principalRecipient: res.principalRecipient,
+        rewardRecipient: res.rewardRecipient,
+        amountOfPrincipalStake: res.amountOfPrincipalStake,
+    };
+});
+exports.getOWRTranches = getOWRTranches;
 const multicall = (calls, signer, multicallAddress) => __awaiter(void 0, void 0, void 0, function* () {
     const multiCallContractInstance = new ethers_1.Contract(multicallAddress, Multicall_1.MultiCallContract.abi, signer);
     const tx = yield multiCallContractInstance.aggregate(calls);

package/dist/esm/package.json

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

package/dist/esm/src/abi/OWR.js

@@ -128,3 +128,174 @@ export const OWRFactoryContract = {
         },
     ],
 };
+export const OWRContract = {
+    abi: [
+        { inputs: [], stateMutability: 'nonpayable', type: 'constructor' },
+        { inputs: [], name: 'InvalidDistribution_TooLarge', type: 'error' },
+        {
+            inputs: [],
+            name: 'InvalidTokenRecovery_InvalidRecipient',
+            type: 'error',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'principalPayout',
+                    type: 'uint256',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'rewardPayout',
+                    type: 'uint256',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'pullFlowFlag',
+                    type: 'uint256',
+                },
+            ],
+            name: 'DistributeFunds',
+            type: 'event',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'amount',
+                    type: 'uint256',
+                },
+            ],
+            name: 'ReceiveETH',
+            type: 'event',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'recoveryAddressToken',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'recipient',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'amount',
+                    type: 'uint256',
+                },
+            ],
+            name: 'RecoverNonOWRecipientFunds',
+            type: 'event',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'account',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'amount',
+                    type: 'uint256',
+                },
+            ],
+            name: 'Withdrawal',
+            type: 'event',
+        },
+        {
+            inputs: [],
+            name: 'claimedPrincipalFunds',
+            outputs: [{ internalType: 'uint128', name: '', type: 'uint128' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'distributeFunds',
+            outputs: [],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'distributeFundsPull',
+            outputs: [],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'fundsPendingWithdrawal',
+            outputs: [{ internalType: 'uint128', name: '', type: 'uint128' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [{ internalType: 'address', name: 'account', type: 'address' }],
+            name: 'getPullBalance',
+            outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getTranches',
+            outputs: [
+                {
+                    internalType: 'address',
+                    name: 'principalRecipient',
+                    type: 'address',
+                },
+                { internalType: 'address', name: 'rewardRecipient', type: 'address' },
+                {
+                    internalType: 'uint256',
+                    name: 'amountOfPrincipalStake',
+                    type: 'uint256',
+                },
+            ],
+            stateMutability: 'pure',
+            type: 'function',
+        },
+        {
+            inputs: [
+                { internalType: 'address', name: 'nonOWRToken', type: 'address' },
+                { internalType: 'address', name: 'recipient', type: 'address' },
+            ],
+            name: 'recoverFunds',
+            outputs: [],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'recoveryAddress',
+            outputs: [{ internalType: 'address', name: '', type: 'address' }],
+            stateMutability: 'pure',
+            type: 'function',
+        },
+        {
+            inputs: [{ internalType: 'address', name: 'account', type: 'address' }],
+            name: 'withdraw',
+            outputs: [],
+            stateMutability: 'nonpayable',
+            type: 'function',
+        },
+    ],
+};

package/dist/esm/src/index.js

@@ -15,7 +15,7 @@ import { ConflictError } from './errors.js';
 import { clusterConfigOrDefinitionHash } from './verification/common.js';
 import { validatePayload } from './ajv.js';
 import { definitionSchema, operatorPayloadSchema, rewardsSplitterPayloadSchema, totalSplitterPayloadSchema, } from './schema.js';
-import { deploySplitterContract, formatSplitRecipients, handleDeployOWRAndSplitter, predictSplitterAddress, } from './splitHelpers.js';
+import { deploySplitterContract, formatSplitRecipients, handleDeployOWRAndSplitter, predictSplitterAddress, getOWRTranches, } from './splitHelpers.js';
 import { isContractAvailable } from './utils.js';
 export * from './types.js';
 export * from './services.js';
@@ -57,6 +57,7 @@ export class Client extends Base {
                     address,
                     version: TERMS_AND_CONDITIONS_VERSION,
                     terms_and_conditions_hash: termsAndConditionsHash,
+                    fork_version: this.fork_version,
                 };
                 const termsAndConditionsSignature = yield this.signer.signTypedData(Domain(), TermsAndConditionsSigningTypes, {
                     terms_and_conditions_hash: termsAndConditionsHash,
@@ -222,6 +223,26 @@ export class Client extends Base {
             };
         });
     }
+    /**
+     * Read OWR Tranches.
+     *
+     * @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 {ETH_ADDRESS} owrAddress - Address of the Deployed OWR Contract
+     * @returns {Promise<OWRTranches>} owr tranch information about principal and reward reciepient, as well as the principal amount
+     *
+     */
+    getOWRTranches(owrAddress) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.signer) {
+                throw new Error('Signer is required in getOWRTranches');
+            }
+            const signer = this.signer;
+            return yield getOWRTranches({ owrAddress, signer });
+        });
+    }
     /**
      * Creates a cluster definition which contains cluster configuration.
      * @param {ClusterPayload} newCluster - The new unique cluster.

package/dist/esm/src/splitHelpers.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { Contract, Interface, parseEther, ZeroAddress, } from 'ethers';
-import { OWRFactoryContract } from './abi/OWR';
+import { OWRContract, OWRFactoryContract } from './abi/OWR';
 import { splitMainEthereumAbi } from './abi/SplitMain';
 import { MultiCallContract } from './abi/Multicall';
 import { CHAIN_CONFIGURATION } from './constants';
@@ -144,6 +144,15 @@ export const deploySplitterAndOWRContracts = ({ owrArgs, splitterArgs, signer, c
         throw e;
     }
 });
+export const getOWRTranches = ({ owrAddress, signer, }) => __awaiter(void 0, void 0, void 0, function* () {
+    const owrContract = new Contract(owrAddress, OWRContract.abi, signer);
+    const res = yield owrContract.getTranches();
+    return {
+        principalRecipient: res.principalRecipient,
+        rewardRecipient: res.rewardRecipient,
+        amountOfPrincipalStake: res.amountOfPrincipalStake,
+    };
+});
 export const multicall = (calls, signer, multicallAddress) => __awaiter(void 0, void 0, void 0, function* () {
     const multiCallContractInstance = new Contract(multicallAddress, MultiCallContract.abi, signer);
     const tx = yield multiCallContractInstance.aggregate(calls);

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

@@ -50,3 +50,47 @@ export declare const OWRFactoryContract: {
         anonymous?: undefined;
     })[];
 };
+export declare const OWRContract: {
+    abi: ({
+        inputs: never[];
+        stateMutability: string;
+        type: string;
+        name?: undefined;
+        anonymous?: undefined;
+        outputs?: undefined;
+    } | {
+        inputs: never[];
+        name: string;
+        type: string;
+        stateMutability?: undefined;
+        anonymous?: undefined;
+        outputs?: undefined;
+    } | {
+        anonymous: boolean;
+        inputs: {
+            indexed: boolean;
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        name: string;
+        type: string;
+        stateMutability?: undefined;
+        outputs?: undefined;
+    } | {
+        inputs: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        name: string;
+        outputs: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        stateMutability: string;
+        type: string;
+        anonymous?: undefined;
+    })[];
+};

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

@@ -1,6 +1,6 @@
 import { type Signer } from 'ethers';
 import { Base } from './base.js';
-import { type RewardsSplitPayload, type ClusterDefinition, type ClusterLock, type ClusterPayload, type OperatorPayload, type TotalSplitPayload, type ClusterValidator } from './types.js';
+import { type RewardsSplitPayload, type ClusterDefinition, type ClusterLock, type ClusterPayload, type OperatorPayload, type TotalSplitPayload, type ClusterValidator, type ETH_ADDRESS, type OWRTranches } from './types.js';
 export * from './types.js';
 export * from './services.js';
 /**
@@ -59,6 +59,18 @@ export declare class Client extends Base {
      * [createObolTotalSplit](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L168)
      */
     createObolTotalSplit({ splitRecipients, ObolRAFSplit, distributorFee, controllerAddress, }: TotalSplitPayload): Promise<ClusterValidator>;
+    /**
+     * Read OWR Tranches.
+     *
+     * @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 {ETH_ADDRESS} owrAddress - Address of the Deployed OWR Contract
+     * @returns {Promise<OWRTranches>} owr tranch information about principal and reward reciepient, as well as the principal amount
+     *
+     */
+    getOWRTranches(owrAddress: ETH_ADDRESS): Promise<OWRTranches>;
     /**
      * Creates a cluster definition which contains cluster configuration.
      * @param {ClusterPayload} newCluster - The new unique cluster.

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

@@ -1,4 +1,4 @@
-import { type ClusterValidator, type ETH_ADDRESS, type SplitRecipient } from './types';
+import { type OWRTranches, type ClusterValidator, type ETH_ADDRESS, type SplitRecipient } from './types';
 import { type Signer } from 'ethers';
 type Call = {
     target: ETH_ADDRESS;
@@ -58,5 +58,9 @@ export declare const deploySplitterAndOWRContracts: ({ owrArgs, splitterArgs, si
     owrAddress: ETH_ADDRESS;
     splitterAddress: ETH_ADDRESS;
 }>;
+export declare const getOWRTranches: ({ owrAddress, signer, }: {
+    owrAddress: ETH_ADDRESS;
+    signer: Signer;
+}) => Promise<OWRTranches>;
 export declare const multicall: (calls: Call[], signer: Signer, multicallAddress: string) => Promise<any>;
 export {};

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

@@ -121,6 +121,17 @@ 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;
 }
+/**
+ * OWR Tranches
+ */
+export type OWRTranches = {
+    /** Address that will reclaim validator principal after exit. */
+    principalRecipient: ETH_ADDRESS;
+    /** Address that will reclaim validator rewards during operation. */
+    rewardRecipient: ETH_ADDRESS;
+    /** Amount of principal staked. */
+    amountOfPrincipalStake: number;
+};
 /**
  * Unsigned DV Builder Registration Message
  */

package/package.json

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

package/src/abi/OWR.ts

@@ -128,3 +128,175 @@ export const OWRFactoryContract = {
     },
   ],
 };
+
+export const OWRContract = {
+  abi: [
+    { inputs: [], stateMutability: 'nonpayable', type: 'constructor' },
+    { inputs: [], name: 'InvalidDistribution_TooLarge', type: 'error' },
+    {
+      inputs: [],
+      name: 'InvalidTokenRecovery_InvalidRecipient',
+      type: 'error',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: 'principalPayout',
+          type: 'uint256',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: 'rewardPayout',
+          type: 'uint256',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: 'pullFlowFlag',
+          type: 'uint256',
+        },
+      ],
+      name: 'DistributeFunds',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: 'amount',
+          type: 'uint256',
+        },
+      ],
+      name: 'ReceiveETH',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: false,
+          internalType: 'address',
+          name: 'recoveryAddressToken',
+          type: 'address',
+        },
+        {
+          indexed: false,
+          internalType: 'address',
+          name: 'recipient',
+          type: 'address',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: 'amount',
+          type: 'uint256',
+        },
+      ],
+      name: 'RecoverNonOWRecipientFunds',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: false,
+          internalType: 'address',
+          name: 'account',
+          type: 'address',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: 'amount',
+          type: 'uint256',
+        },
+      ],
+      name: 'Withdrawal',
+      type: 'event',
+    },
+    {
+      inputs: [],
+      name: 'claimedPrincipalFunds',
+      outputs: [{ internalType: 'uint128', name: '', type: 'uint128' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'distributeFunds',
+      outputs: [],
+      stateMutability: 'payable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'distributeFundsPull',
+      outputs: [],
+      stateMutability: 'payable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'fundsPendingWithdrawal',
+      outputs: [{ internalType: 'uint128', name: '', type: 'uint128' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [{ internalType: 'address', name: 'account', type: 'address' }],
+      name: 'getPullBalance',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'getTranches',
+      outputs: [
+        {
+          internalType: 'address',
+          name: 'principalRecipient',
+          type: 'address',
+        },
+        { internalType: 'address', name: 'rewardRecipient', type: 'address' },
+        {
+          internalType: 'uint256',
+          name: 'amountOfPrincipalStake',
+          type: 'uint256',
+        },
+      ],
+      stateMutability: 'pure',
+      type: 'function',
+    },
+    {
+      inputs: [
+        { internalType: 'address', name: 'nonOWRToken', type: 'address' },
+        { internalType: 'address', name: 'recipient', type: 'address' },
+      ],
+      name: 'recoverFunds',
+      outputs: [],
+      stateMutability: 'payable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'recoveryAddress',
+      outputs: [{ internalType: 'address', name: '', type: 'address' }],
+      stateMutability: 'pure',
+      type: 'function',
+    },
+    {
+      inputs: [{ internalType: 'address', name: 'account', type: 'address' }],
+      name: 'withdraw',
+      outputs: [],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+  ],
+};

package/src/index.ts

@@ -28,6 +28,8 @@ import {
   type OperatorPayload,
   type TotalSplitPayload,
   type ClusterValidator,
+  type ETH_ADDRESS,
+  type OWRTranches,
 } from './types.js';
 import { clusterConfigOrDefinitionHash } from './verification/common.js';
 import { validatePayload } from './ajv.js';
@@ -42,6 +44,7 @@ import {
   formatSplitRecipients,
   handleDeployOWRAndSplitter,
   predictSplitterAddress,
+  getOWRTranches,
 } from './splitHelpers.js';
 import { isContractAvailable } from './utils.js';
 export * from './types.js';
@@ -88,6 +91,7 @@ export class Client extends Base {
         address,
         version: TERMS_AND_CONDITIONS_VERSION,
         terms_and_conditions_hash: termsAndConditionsHash,
+        fork_version: this.fork_version,
       };
 
       const termsAndConditionsSignature = await this.signer.signTypedData(
@@ -338,6 +342,26 @@ export class Client extends Base {
     };
   }
 
+  /**
+   * Read OWR Tranches.
+   *
+   * @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 {ETH_ADDRESS} owrAddress - Address of the Deployed OWR Contract
+   * @returns {Promise<OWRTranches>} owr tranch information about principal and reward reciepient, as well as the principal amount
+   *
+   */
+  async getOWRTranches(owrAddress: ETH_ADDRESS): Promise<OWRTranches> {
+    if (!this.signer) {
+      throw new Error('Signer is required in getOWRTranches');
+    }
+
+    const signer = this.signer;
+    return await getOWRTranches({ owrAddress, signer });
+  }
+
   /**
    * Creates a cluster definition which contains cluster configuration.
    * @param {ClusterPayload} newCluster - The new unique cluster.

package/src/splitHelpers.ts

@@ -1,4 +1,5 @@
 import {
+  type OWRTranches,
   type ClusterValidator,
   type ETH_ADDRESS,
   type SplitRecipient,
@@ -10,7 +11,7 @@ import {
   ZeroAddress,
   type Signer,
 } from 'ethers';
-import { OWRFactoryContract } from './abi/OWR';
+import { OWRContract, OWRFactoryContract } from './abi/OWR';
 import { splitMainEthereumAbi } from './abi/SplitMain';
 import { MultiCallContract } from './abi/Multicall';
 import { CHAIN_CONFIGURATION } from './constants';
@@ -237,6 +238,7 @@ export const deploySplitterContract = async ({
     throw e;
   }
 };
+
 export const deploySplitterAndOWRContracts = async ({
   owrArgs,
   splitterArgs,
@@ -297,6 +299,23 @@ export const deploySplitterAndOWRContracts = async ({
   }
 };
 
+export const getOWRTranches = async ({
+  owrAddress,
+  signer,
+}: {
+  owrAddress: ETH_ADDRESS;
+  signer: Signer;
+}): Promise<OWRTranches> => {
+  const owrContract = new Contract(owrAddress, OWRContract.abi, signer);
+  const res = await owrContract.getTranches();
+
+  return {
+    principalRecipient: res.principalRecipient,
+    rewardRecipient: res.rewardRecipient,
+    amountOfPrincipalStake: res.amountOfPrincipalStake,
+  };
+};
+
 export const multicall = async (
   calls: Call[],
   signer: Signer,

package/src/types.ts

@@ -159,6 +159,20 @@ export interface RewardsSplitPayload extends TotalSplitPayload {
   recoveryAddress?: string;
 }
 
+/**
+ * OWR Tranches
+ */
+export type OWRTranches = {
+  /** Address that will reclaim validator principal after exit. */
+  principalRecipient: ETH_ADDRESS;
+
+  /** Address that will reclaim validator rewards during operation. */
+  rewardRecipient: ETH_ADDRESS;
+
+  /** Amount of principal staked. */
+  amountOfPrincipalStake: number;
+};
+
 /**
  * Unsigned DV Builder Registration Message
  */