@obolnetwork/obol-sdk 2.5.1 → 2.6.0

package/src/types.ts

@@ -352,3 +352,126 @@ export type SignerType = Signer | JsonRpcSigner | Wallet;
  * claimIncentives Response
  */
 export type ClaimIncentivesResponse = { txHash: string | null };
+
+/**
+ * Represents the structure of an Ethereum operator for exit validation, primarily their ENR.
+ */
+export interface ExitOperator {
+  /** The operator's Ethereum Node Record (ENR). */
+  enr: string;
+}
+
+/**
+ * Represents the core definition of a cluster relevant for exit validation.
+ */
+export interface ExitClusterDefinition {
+  /** The cluster nodes operators with their ENRs. */
+  operators: ExitOperator[];
+
+  /** The cluster fork version. */
+  fork_version: string;
+
+  /** The distributed validator threshold. */
+  threshold: number;
+}
+
+/**
+ * Represents a distributed validator's information relevant for exit validation.
+ */
+export interface ExitDistributedValidator {
+  /** The public key of the distributed validator. */
+  distributed_public_key: string;
+
+  /** The public key shares of the distributed validator. */
+  public_shares: string[];
+}
+
+/**
+ * Combined cluster information needed for exit validation in the SDK.
+ */
+export interface ExitClusterConfig {
+  /** The cluster definition with operators, fork version and threshold. */
+  definition: ExitClusterDefinition;
+
+  /** The cluster distributed validators. */
+  distributed_validators: ExitDistributedValidator[];
+}
+
+/**
+ * Represents the message part of a signed exit for exit validation.
+ */
+export interface ExitValidationMessage {
+  /** The epoch at which the validator wishes to exit. */
+  epoch: string;
+
+  /** The index of the validator in the beacon chain. */
+  validator_index: string;
+}
+
+/**
+ * Represents a signed exit message for exit validation.
+ */
+export interface SignedExitValidationMessage {
+  /** The exit message containing epoch and validator index. */
+  message: ExitValidationMessage;
+
+  /** BLS signature of the exit message. */
+  signature: string;
+}
+
+/**
+ * Represents a single partial exit blob for exit validation.
+ */
+export interface ExitValidationBlob {
+  /** The public key of the validator to exit. */
+  public_key: string;
+
+  /** The signed exit message for the validator. */
+  signed_exit_message: SignedExitValidationMessage;
+}
+
+/**
+ * Represents the overall exit payload structure for exit validation.
+ */
+export interface ExitValidationPayload {
+  /** Array of partial exits for validators. */
+  partial_exits: ExitValidationBlob[];
+
+  /** Operator's share index (1-based). */
+  share_idx: number;
+
+  /** Signature of the ExitValidationPayload by the operator. */
+  signature: string;
+}
+
+/**
+ * Represents the data structure for an already existing exit blob for exit validation.
+ */
+export interface ExistingExitValidationBlobData {
+  /** The public key of the validator to exit. */
+  public_key: string;
+
+  /** The epoch at which the validator wishes to exit. */
+  epoch: string;
+
+  /** The index of the validator in the beacon chain. */
+  validator_index: string;
+
+  /** Collection of partial exit signatures from different shares. */
+  shares_exit_data: Array<Record<string, { partial_exit_signature: string }>>;
+}
+
+/**
+ * Generic HTTP request function type.
+ * Args:
+ *  url: string - The URL to request.
+ *  config?: Record<string, any> - Optional request configuration (e.g., method, headers, body for POST).
+ * Returns:
+ *  Promise<any> - The response data.
+ */
+export type HttpRequestFunc = (
+  url: string,
+  config?: Record<string, any>,
+) => Promise<any>;
+
+// Add other SDK-specific types below or import from other type files

package/dist/cjs/src/splitHelpers.js

@@ -1,187 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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");
-const Multicall_1 = require("./abi/Multicall");
-const constants_1 = require("./constants");
-const splitMainContractInterface = new ethers_1.Interface(SplitMain_1.splitMainEthereumAbi);
-const owrFactoryContractInterface = new ethers_1.Interface(OWR_1.OWRFactoryContract.abi);
-const formatSplitRecipients = (recipients) => {
-    // Has to be sorted when passed
-    recipients.sort((a, b) => a.account.localeCompare(b.account));
-    const accounts = recipients.map(item => item.account);
-    const percentAllocations = recipients.map(recipient => {
-        const splitTostring = (recipient.percentAllocation * 1e4).toFixed(0);
-        return parseInt(splitTostring);
-    });
-    return { accounts, percentAllocations };
-};
-exports.formatSplitRecipients = formatSplitRecipients;
-const predictSplitterAddress = ({ signer, accounts, percentAllocations, chainId, distributorFee, controllerAddress, }) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        let predictedSplitterAddress;
-        const splitMainContractInstance = new ethers_1.Contract(constants_1.CHAIN_CONFIGURATION[chainId].SPLITMAIN_ADDRESS.address, SplitMain_1.splitMainEthereumAbi, signer);
-        if (controllerAddress === ethers_1.ZeroAddress) {
-            predictedSplitterAddress =
-                yield splitMainContractInstance.predictImmutableSplitAddress(accounts, percentAllocations, distributorFee);
-        }
-        else {
-            // It throws on deployed Immutable splitter
-            predictedSplitterAddress =
-                yield splitMainContractInstance.createSplit.staticCall(accounts, percentAllocations, distributorFee, controllerAddress);
-        }
-        return predictedSplitterAddress;
-    }
-    catch (e) {
-        throw e;
-    }
-});
-exports.predictSplitterAddress = predictSplitterAddress;
-const handleDeployOWRAndSplitter = ({ signer, isSplitterDeployed, predictedSplitterAddress, accounts, percentAllocations, etherAmount, principalRecipient, chainId, distributorFee, controllerAddress, recoveryAddress, }) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        if (isSplitterDeployed) {
-            const owrAddress = yield createOWRContract({
-                owrArgs: {
-                    principalRecipient,
-                    amountOfPrincipalStake: etherAmount,
-                    predictedSplitterAddress,
-                    recoveryAddress,
-                },
-                signer,
-                chainId,
-            });
-            return {
-                withdrawal_address: owrAddress,
-                fee_recipient_address: predictedSplitterAddress,
-            };
-        }
-        else {
-            const { owrAddress, splitterAddress } = yield (0, exports.deploySplitterAndOWRContracts)({
-                owrArgs: {
-                    principalRecipient,
-                    amountOfPrincipalStake: etherAmount,
-                    predictedSplitterAddress,
-                    recoveryAddress,
-                },
-                splitterArgs: {
-                    accounts,
-                    percentAllocations,
-                    distributorFee,
-                    controllerAddress,
-                },
-                signer,
-                chainId,
-            });
-            return {
-                withdrawal_address: owrAddress,
-                fee_recipient_address: splitterAddress,
-            };
-        }
-    }
-    catch (e) {
-        throw e;
-    }
-});
-exports.handleDeployOWRAndSplitter = handleDeployOWRAndSplitter;
-const createOWRContract = ({ owrArgs, signer, chainId, }) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
-    try {
-        const OWRFactoryInstance = new ethers_1.Contract(constants_1.CHAIN_CONFIGURATION[chainId].OWR_FACTORY_ADDRESS.address, OWR_1.OWRFactoryContract.abi, signer);
-        const tx = yield OWRFactoryInstance.createOWRecipient(owrArgs.recoveryAddress, owrArgs.principalRecipient, owrArgs.predictedSplitterAddress, (0, ethers_1.parseEther)(owrArgs.amountOfPrincipalStake.toString()));
-        const receipt = yield tx.wait();
-        const OWRAddressData = (_a = receipt === null || receipt === void 0 ? void 0 : receipt.logs[0]) === null || _a === void 0 ? void 0 : _a.topics[1];
-        const formattedOWRAddress = '0x' + (OWRAddressData === null || OWRAddressData === void 0 ? void 0 : OWRAddressData.slice(26, 66));
-        return formattedOWRAddress;
-    }
-    catch (e) {
-        throw e;
-    }
-});
-const deploySplitterContract = ({ signer, accounts, percentAllocations, chainId, distributorFee, controllerAddress, }) => __awaiter(void 0, void 0, void 0, function* () {
-    var _b;
-    try {
-        const splitMainContractInstance = new ethers_1.Contract(constants_1.CHAIN_CONFIGURATION[chainId].SPLITMAIN_ADDRESS.address, SplitMain_1.splitMainEthereumAbi, signer);
-        const tx = yield splitMainContractInstance.createSplit(accounts, percentAllocations, distributorFee, controllerAddress);
-        const receipt = yield tx.wait();
-        const splitterAddressData = (_b = receipt === null || receipt === void 0 ? void 0 : receipt.logs[0]) === null || _b === void 0 ? void 0 : _b.topics[1];
-        const formattedSplitterAddress = '0x' + (splitterAddressData === null || splitterAddressData === void 0 ? void 0 : splitterAddressData.slice(26, 66));
-        return formattedSplitterAddress;
-    }
-    catch (e) {
-        throw e;
-    }
-});
-exports.deploySplitterContract = deploySplitterContract;
-const deploySplitterAndOWRContracts = ({ owrArgs, splitterArgs, signer, chainId, }) => __awaiter(void 0, void 0, void 0, function* () {
-    var _c, _d;
-    const executeCalls = [];
-    try {
-        const splitTxData = encodeCreateSplitTxData(splitterArgs.accounts, splitterArgs.percentAllocations, splitterArgs.distributorFee, splitterArgs.controllerAddress);
-        const owrTxData = encodeCreateOWRecipientTxData(owrArgs.recoveryAddress, owrArgs.principalRecipient, owrArgs.predictedSplitterAddress, owrArgs.amountOfPrincipalStake);
-        executeCalls.push({
-            target: constants_1.CHAIN_CONFIGURATION[chainId].SPLITMAIN_ADDRESS.address,
-            callData: splitTxData,
-        }, {
-            target: constants_1.CHAIN_CONFIGURATION[chainId].OWR_FACTORY_ADDRESS.address,
-            callData: owrTxData,
-        });
-        const multicallAddess = constants_1.CHAIN_CONFIGURATION[chainId].MULTICALL_ADDRESS.address;
-        const executeMultiCalls = yield (0, exports.multicall)(executeCalls, signer, multicallAddess);
-        const splitAddressData = (_c = executeMultiCalls === null || executeMultiCalls === void 0 ? void 0 : executeMultiCalls.logs[0]) === null || _c === void 0 ? void 0 : _c.topics[1];
-        const formattedSplitterAddress = '0x' + (splitAddressData === null || splitAddressData === void 0 ? void 0 : splitAddressData.slice(26, 66));
-        const owrAddressData = (_d = executeMultiCalls === null || executeMultiCalls === void 0 ? void 0 : executeMultiCalls.logs[1]) === null || _d === void 0 ? void 0 : _d.topics[1];
-        const formattedOwrAddress = '0x' + (owrAddressData === null || owrAddressData === void 0 ? void 0 : owrAddressData.slice(26, 66));
-        return {
-            owrAddress: formattedOwrAddress,
-            splitterAddress: formattedSplitterAddress,
-        };
-    }
-    catch (e) {
-        throw e;
-    }
-});
-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);
-    const receipt = yield tx.wait();
-    return receipt;
-});
-exports.multicall = multicall;
-const encodeCreateSplitTxData = (accounts, percentAllocations, distributorFee, controller) => {
-    return splitMainContractInterface.encodeFunctionData('createSplit', [
-        accounts,
-        percentAllocations,
-        distributorFee,
-        controller,
-    ]);
-};
-const encodeCreateOWRecipientTxData = (recoveryAddress, principalRecipient, rewardRecipient, amountOfPrincipalStake) => {
-    return owrFactoryContractInterface.encodeFunctionData('createOWRecipient', [
-        recoveryAddress,
-        principalRecipient,
-        rewardRecipient,
-        (0, ethers_1.parseEther)(amountOfPrincipalStake.toString()),
-    ]);
-};