@obolnetwork/obol-sdk 2.11.4 → 2.11.5-rc.0

package/dist/esm/src/splits/splits.js

@@ -1,362 +0,0 @@
-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());
-    });
-};
-import { formatRecipientsForSplitV2, predictSplitV2Address, isSplitV2Deployed, deployOVMContract, deployOVMAndSplitV2, requestWithdrawalFromOVM, depositWithMulticall3, } from './splitHelpers';
-import { CHAIN_CONFIGURATION, SPLITS_V2_SALT, DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT, isChainSupportedForSplitters, } from '../constants';
-import { ovmRewardsSplitPayloadSchema, ovmTotalSplitPayloadSchema, ovmRequestWithdrawalPayloadSchema, ovmDepositPayloadSchema, } from '../schema';
-import { validatePayload } from '../ajv';
-import { isContractAvailable } from '../utils';
-/**
- * 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 class ObolSplits {
-    constructor(signer, chainId, provider) {
-        this.signer = signer;
-        this.chainId = chainId;
-        this.provider = provider;
-    }
-    /**
-     * 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) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const salt = SPLITS_V2_SALT;
-            if (!this.signer) {
-                throw new Error('Signer is required in createValidatorManagerAndRewardsSplit');
-            }
-            const validatedPayload = validatePayload(payload, ovmRewardsSplitPayloadSchema);
-            if (!isChainSupportedForSplitters(this.chainId)) {
-                throw new Error(`Splitter configuration is not supported on ${this.chainId} chain`);
-            }
-            const chainConfig = CHAIN_CONFIGURATION[this.chainId];
-            if (!(chainConfig === null || chainConfig === void 0 ? void 0 : chainConfig.OVM_FACTORY_CONTRACT)) {
-                throw new Error(`OVM contract factory is not configured for chain ${this.chainId}`);
-            }
-            if (!this.provider) {
-                throw new Error('Provider is required to check OVM factory contract availability');
-            }
-            const ovmFactoryConfig = chainConfig.OVM_FACTORY_CONTRACT;
-            const splitV2FactoryConfig = chainConfig.SPLIT_V2_FACTORY_CONTRACT;
-            const multiCall3Config = chainConfig.MULTICALL3_CONTRACT;
-            if (!(ovmFactoryConfig === null || ovmFactoryConfig === void 0 ? void 0 : ovmFactoryConfig.address) ||
-                !(ovmFactoryConfig === null || ovmFactoryConfig === void 0 ? void 0 : ovmFactoryConfig.bytecode) ||
-                !(splitV2FactoryConfig === null || splitV2FactoryConfig === void 0 ? void 0 : splitV2FactoryConfig.address) ||
-                !(splitV2FactoryConfig === null || splitV2FactoryConfig === void 0 ? void 0 : splitV2FactoryConfig.bytecode) ||
-                !(multiCall3Config === null || multiCall3Config === void 0 ? void 0 : multiCall3Config.address) ||
-                !(multiCall3Config === null || multiCall3Config === void 0 ? void 0 : multiCall3Config.bytecode)) {
-                throw new Error(`Contracts configuration is incomplete for chain ${this.chainId}`);
-            }
-            const checkOVMFactoryContract = yield isContractAvailable(ovmFactoryConfig.address, this.provider, ovmFactoryConfig.bytecode);
-            const checkSplitV2FactoryContract = yield isContractAvailable(splitV2FactoryConfig.address, this.provider, splitV2FactoryConfig.bytecode);
-            const checkMultiCall3Contract = yield isContractAvailable(multiCall3Config.address, this.provider, multiCall3Config.bytecode);
-            if (!checkOVMFactoryContract ||
-                !checkSplitV2FactoryContract ||
-                !checkMultiCall3Contract) {
-                throw new Error(`Splitter contract is not deployed or available on chain ${this.chainId}`);
-            }
-            const retroActiveFundingRecipient = {
-                address: chainConfig.RETROACTIVE_FUNDING_CONTRACT.address,
-                percentAllocation: DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT,
-            };
-            const copiedRewardsSplitRecipients = [
-                ...validatedPayload.rewardSplitRecipients,
-            ];
-            copiedRewardsSplitRecipients.push(retroActiveFundingRecipient);
-            // Format recipients for SplitV2
-            const rewardRecipients = formatRecipientsForSplitV2(copiedRewardsSplitRecipients);
-            const predictedSplitAddress = yield predictSplitV2Address({
-                splitOwnerAddress: validatedPayload.splitOwnerAddress,
-                recipients: rewardRecipients,
-                distributorFeePercent: validatedPayload.distributorFeePercent,
-                salt,
-                signer: this.signer,
-                chainId: this.chainId,
-            });
-            const isRewardSplitterDeployed = yield isSplitV2Deployed({
-                splitOwnerAddress: validatedPayload.splitOwnerAddress,
-                recipients: rewardRecipients,
-                distributorFeePercent: validatedPayload.distributorFeePercent,
-                salt,
-                signer: this.signer,
-                chainId: this.chainId,
-            });
-            if (isRewardSplitterDeployed) {
-                const ovmAddress = yield deployOVMContract({
-                    OVMOwnerAddress: validatedPayload.OVMOwnerAddress,
-                    principalRecipient: validatedPayload.principalRecipient,
-                    rewardRecipient: predictedSplitAddress,
-                    principalThreshold: validatedPayload.principalThreshold,
-                    signer: this.signer,
-                    chainId: this.chainId,
-                });
-                return {
-                    withdrawal_address: ovmAddress,
-                    fee_recipient_address: predictedSplitAddress,
-                };
-            }
-            else {
-                const ovmAddress = yield deployOVMAndSplitV2({
-                    ovmArgs: {
-                        OVMOwnerAddress: validatedPayload.OVMOwnerAddress,
-                        rewardRecipient: predictedSplitAddress,
-                        principalRecipient: validatedPayload.principalRecipient,
-                        principalThreshold: validatedPayload.principalThreshold,
-                    },
-                    rewardRecipients,
-                    isRewardsSplitterDeployed: isRewardSplitterDeployed,
-                    distributorFeePercent: validatedPayload.distributorFeePercent,
-                    salt,
-                    signer: this.signer,
-                    chainId: this.chainId,
-                    splitOwnerAddress: validatedPayload.splitOwnerAddress,
-                });
-                return {
-                    withdrawal_address: ovmAddress,
-                    fee_recipient_address: predictedSplitAddress,
-                };
-            }
-        });
-    }
-    /**
-     * 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) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const salt = SPLITS_V2_SALT;
-            if (!this.signer) {
-                throw new Error('Signer is required in createValidatorManagerAndTotalSplit');
-            }
-            const validatedPayload = validatePayload(payload, ovmTotalSplitPayloadSchema);
-            if (!isChainSupportedForSplitters(this.chainId)) {
-                throw new Error(`Splitter configuration is not supported on ${this.chainId} chain`);
-            }
-            const chainConfig = CHAIN_CONFIGURATION[this.chainId];
-            if (!(chainConfig === null || chainConfig === void 0 ? void 0 : chainConfig.OVM_FACTORY_CONTRACT)) {
-                throw new Error(`OVM contract factory is not configured for chain ${this.chainId}`);
-            }
-            if (!this.provider) {
-                throw new Error('Provider is required to check OVM factory contract availability');
-            }
-            const ovmFactoryConfig = chainConfig.OVM_FACTORY_CONTRACT;
-            const splitV2FactoryConfig = chainConfig.SPLIT_V2_FACTORY_CONTRACT;
-            const multiCall3Config = chainConfig.MULTICALL3_CONTRACT;
-            if (!(ovmFactoryConfig === null || ovmFactoryConfig === void 0 ? void 0 : ovmFactoryConfig.address) ||
-                !(ovmFactoryConfig === null || ovmFactoryConfig === void 0 ? void 0 : ovmFactoryConfig.bytecode) ||
-                !(splitV2FactoryConfig === null || splitV2FactoryConfig === void 0 ? void 0 : splitV2FactoryConfig.address) ||
-                !(splitV2FactoryConfig === null || splitV2FactoryConfig === void 0 ? void 0 : splitV2FactoryConfig.bytecode) ||
-                !(multiCall3Config === null || multiCall3Config === void 0 ? void 0 : multiCall3Config.address) ||
-                !(multiCall3Config === null || multiCall3Config === void 0 ? void 0 : multiCall3Config.bytecode)) {
-                throw new Error(`Contracts configuration is incomplete for chain ${this.chainId}`);
-            }
-            const checkOVMFactoryContract = yield isContractAvailable(ovmFactoryConfig.address, this.provider, ovmFactoryConfig.bytecode);
-            const checkSplitV2FactoryContract = yield isContractAvailable(splitV2FactoryConfig.address, this.provider, splitV2FactoryConfig.bytecode);
-            const checkMultiCall3Contract = yield isContractAvailable(multiCall3Config.address, this.provider, multiCall3Config.bytecode);
-            if (!checkOVMFactoryContract ||
-                !checkSplitV2FactoryContract ||
-                !checkMultiCall3Contract) {
-                throw new Error(`Splitter contract is not deployed or available on chain ${this.chainId}`);
-            }
-            const retroActiveFundingRecipient = {
-                address: chainConfig.RETROACTIVE_FUNDING_CONTRACT.address,
-                percentAllocation: DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT,
-            };
-            const copiedRewardsSplitRecipients = [
-                ...validatedPayload.rewardSplitRecipients,
-            ];
-            copiedRewardsSplitRecipients.push(retroActiveFundingRecipient);
-            const rewardsRecipients = formatRecipientsForSplitV2(copiedRewardsSplitRecipients);
-            const principalSplitRecipients = formatRecipientsForSplitV2(validatedPayload.principalSplitRecipients);
-            const predictedRewardsSplitAddress = yield predictSplitV2Address({
-                splitOwnerAddress: validatedPayload.splitOwnerAddress,
-                recipients: rewardsRecipients,
-                distributorFeePercent: validatedPayload.distributorFeePercent,
-                salt,
-                signer: this.signer,
-                chainId: this.chainId,
-            });
-            const predictedPrincipalSplitAddress = yield predictSplitV2Address({
-                splitOwnerAddress: validatedPayload.splitOwnerAddress,
-                recipients: principalSplitRecipients,
-                distributorFeePercent: validatedPayload.distributorFeePercent,
-                salt,
-                signer: this.signer,
-                chainId: this.chainId,
-            });
-            const isRewardsSplitterDeployed = yield isSplitV2Deployed({
-                splitOwnerAddress: validatedPayload.splitOwnerAddress,
-                recipients: rewardsRecipients,
-                distributorFeePercent: validatedPayload.distributorFeePercent,
-                salt,
-                signer: this.signer,
-                chainId: this.chainId,
-            });
-            const isPrincipalSplitterDeployed = yield isSplitV2Deployed({
-                splitOwnerAddress: validatedPayload.splitOwnerAddress,
-                recipients: principalSplitRecipients,
-                distributorFeePercent: validatedPayload.distributorFeePercent,
-                salt,
-                signer: this.signer,
-                chainId: this.chainId,
-            });
-            if (isRewardsSplitterDeployed && isPrincipalSplitterDeployed) {
-                const ovmAddress = yield deployOVMContract({
-                    OVMOwnerAddress: validatedPayload.OVMOwnerAddress,
-                    principalRecipient: predictedPrincipalSplitAddress,
-                    rewardRecipient: predictedRewardsSplitAddress,
-                    principalThreshold: validatedPayload.principalThreshold,
-                    signer: this.signer,
-                    chainId: this.chainId,
-                });
-                return {
-                    withdrawal_address: ovmAddress,
-                    fee_recipient_address: predictedRewardsSplitAddress,
-                };
-            }
-            else {
-                // Use multicall3 to deploy any contracts that aren't deployed
-                const ovmAddress = yield deployOVMAndSplitV2({
-                    ovmArgs: {
-                        OVMOwnerAddress: validatedPayload.OVMOwnerAddress,
-                        rewardRecipient: predictedRewardsSplitAddress,
-                        principalRecipient: predictedPrincipalSplitAddress,
-                        principalThreshold: validatedPayload.principalThreshold,
-                    },
-                    rewardRecipients: rewardsRecipients,
-                    distributorFeePercent: validatedPayload.distributorFeePercent,
-                    salt,
-                    signer: this.signer,
-                    chainId: this.chainId,
-                    principalSplitRecipients,
-                    isPrincipalSplitDeployed: isPrincipalSplitterDeployed,
-                    splitOwnerAddress: validatedPayload.splitOwnerAddress,
-                });
-                return {
-                    withdrawal_address: ovmAddress,
-                    fee_recipient_address: predictedRewardsSplitAddress,
-                };
-            }
-        });
-    }
-    /**
-     * Requests withdrawal from an OVM contract.
-     *
-     * This method allows requesting withdrawal of validator funds from an OVM contract.
-     * The withdrawal request includes OVM address, validator public keys and corresponding withdrawal amounts.
-     *
-     * @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 {OVMRequestWithdrawalPayload} payload - Data needed to request withdrawal
-     * @returns {Promise<{txHash: string}>} Transaction hash of the withdrawal request
-     * @throws Will throw an error if the signer is not provided, OVM address is invalid, or the request fails
-     *
-     * An example of how to use requestWithdrawal:
-     * ```typescript
-     * const result = await client.splits.requestWithdrawal({
-     *   ovmAddress: '0x1234567890123456789012345678901234567890',
-     *   pubKeys: ['0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456'],
-     *   amounts: ['32000000000'] // 32 ETH in gwei
-     * });
-     * console.log('Withdrawal requested:', result.txHash);
-     * ```
-     */
-    requestWithdrawal(payload) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.signer) {
-                throw new Error('Signer is required in requestWithdrawal');
-            }
-            // [TBD] need to move ovm verification to sdk method and use it here
-            const validatedPayload = validatePayload(payload, ovmRequestWithdrawalPayloadSchema);
-            return yield requestWithdrawalFromOVM({
-                ovmAddress: validatedPayload.ovmAddress,
-                pubKeys: validatedPayload.pubKeys,
-                amounts: validatedPayload.amounts,
-                withdrawalFees: validatedPayload.withdrawalFees,
-                signer: this.signer,
-            });
-        });
-    }
-    /**
-     * Deposits to OVM contract using multicall3 for batch operations.
-     *
-     * This method allows depositing to an OVM contract using multicall3 for efficient batch processing.
-     * Each deposit includes validator public key, withdrawal credentials, signature, deposit data root, and amount.
-     *
-     * @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 {OVMDepositPayload} payload - Data needed to deposit to OVM
-     * @returns {Promise<{txHashes: string[]}>} Array of transaction hashes for all batches
-     * @throws Will throw an error if the signer is not provided, OVM address is invalid, or the deposit fails
-     *
-     * An example of how to use deposit:
-     * ```typescript
-     * const result = await client.splits.deposit({
-     *   ovmAddress: '0x1234567890123456789012345678901234567890',
-     *   deposits: [{
-     *     pubkey: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
-     *     withdrawal_credentials: '0x1234567890123456789012345678901234567890',
-     *     signature: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
-     *     deposit_data_root: '0x1234567890123456789012345678901234567890123456789012345678901234',
-     *     amount: '32000000000000000000' // 32 ETH in wei
-     *   }]
-     * });
-     * console.log('Deposits completed:', result.txHashes);
-     * ```
-     */
-    deposit(payload) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.signer) {
-                throw new Error('Signer is required in deposit');
-            }
-            const validatedPayload = validatePayload(payload, ovmDepositPayloadSchema);
-            return yield depositWithMulticall3({
-                ovmAddress: validatedPayload.ovmAddress,
-                deposits: validatedPayload.deposits,
-                signer: this.signer,
-                chainId: this.chainId,
-            });
-        });
-    }
-}

package/dist/esm/src/types.js

@@ -1,26 +0,0 @@
-/**
- * Permitted ChainID's
- */
-export var FORK_MAPPING;
-(function (FORK_MAPPING) {
-    /** Mainnet. */
-    FORK_MAPPING[FORK_MAPPING["0x00000000"] = 1] = "0x00000000";
-    /** Goerli/Prater. */
-    FORK_MAPPING[FORK_MAPPING["0x00001020"] = 5] = "0x00001020";
-    /** Gnosis Chain. */
-    FORK_MAPPING[FORK_MAPPING["0x00000064"] = 100] = "0x00000064";
-    /** Holesky. */
-    FORK_MAPPING[FORK_MAPPING["0x01017000"] = 17000] = "0x01017000";
-    /** Sepolia. */
-    FORK_MAPPING[FORK_MAPPING["0x90000069"] = 11155111] = "0x90000069";
-    /** Hoodi Chain. */
-    FORK_MAPPING[FORK_MAPPING["0x10000910"] = 560048] = "0x10000910";
-})(FORK_MAPPING || (FORK_MAPPING = {}));
-export const FORK_NAMES = {
-    [FORK_MAPPING['0x00000000']]: 'mainnet',
-    [FORK_MAPPING['0x00001020']]: 'goerli',
-    [FORK_MAPPING['0x00000064']]: 'gnosis',
-    [FORK_MAPPING['0x01017000']]: 'holesky',
-    [FORK_MAPPING['0x90000069']]: 'sepolia',
-    [FORK_MAPPING['0x10000910']]: 'hoodi',
-};

package/dist/esm/src/utils.js

@@ -1,68 +0,0 @@
-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());
-    });
-};
-import { ethers } from 'ethers';
-import { DefinitionFlow, PROVIDER_MAP } from './constants';
-import { FORK_NAMES } from './types';
-export const hexWithout0x = (hex) => {
-    return hex.slice(2, hex.length);
-};
-export const strToUint8Array = (str) => {
-    return new TextEncoder().encode(str);
-};
-export const definitionFlow = (clusterDefinition) => {
-    if (clusterDefinition.creator.address &&
-        clusterDefinition.creator.config_signature &&
-        clusterDefinition.operators.every(operator => {
-            return (operator.address &&
-                operator.config_signature &&
-                operator.enr &&
-                operator.enr_signature);
-        })) {
-        return DefinitionFlow.Group;
-    }
-    else if (clusterDefinition.creator.address &&
-        clusterDefinition.creator.config_signature &&
-        clusterDefinition.operators.every(operator => {
-            return (!operator.address &&
-                !operator.config_signature &&
-                operator.enr &&
-                !operator.enr_signature);
-        })) {
-        return DefinitionFlow.Solo;
-    }
-    else if (!clusterDefinition.creator.address &&
-        !clusterDefinition.creator.config_signature &&
-        clusterDefinition.operators.every(operator => {
-            return (!operator.address &&
-                !operator.config_signature &&
-                operator.enr &&
-                !operator.enr_signature);
-        })) {
-        return DefinitionFlow.Charon;
-    }
-    return null;
-};
-export const findDeployedBytecode = (contractAddress, provider) => __awaiter(void 0, void 0, void 0, function* () {
-    return yield (provider === null || provider === void 0 ? void 0 : provider.getCode(contractAddress));
-});
-export const isContractAvailable = (contractAddress, provider, bytecode) => __awaiter(void 0, void 0, void 0, function* () {
-    const code = yield findDeployedBytecode(contractAddress, provider);
-    if (bytecode) {
-        return !!code && code === bytecode;
-    }
-    return !!code && code !== '0x' && code !== '0x0';
-});
-export const getProvider = (chainId, rpcUrl) => {
-    const resolvedRpcUrl = rpcUrl !== null && rpcUrl !== void 0 ? rpcUrl : PROVIDER_MAP[chainId];
-    if (chainId && (!resolvedRpcUrl || resolvedRpcUrl === 'undefined')) {
-        throw new Error(`No provider configured for ${FORK_NAMES[chainId]}`);
-    }
-    return new ethers.JsonRpcProvider(resolvedRpcUrl);
-};