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

package/src/constants.ts

@@ -1,304 +0,0 @@
-import { type TypedMessage } from '@metamask/eth-sig-util';
-import { type TypedDataDomain } from 'ethers';
-import pjson from '../package.json';
-import { type ChainConfig, FORK_MAPPING } from './types';
-import {
-  HOLESKY_MULTICALL3_BYTECODE,
-  HOLESKY_OWR_FACTORY_BYTECODE,
-  HOLESKY_SPLITMAIN_BYTECODE,
-  HOODI_MULTICALL3_BYTECODE,
-  HOODI_OVM_FACTORY_BYTECODE,
-  HOODI_OWR_FACTORY_BYTECODE,
-  HOODI_SPLIT_V2_FACTORY_BYTECODE,
-  HOODI_SPLITMAIN_BYTECODE,
-  HOODI_WAREHOUSE_BYTECODE,
-  MAINNET_MULTICALL3_BYTECODE,
-  MAINNET_OVM_FACTORY_BYTECODE,
-  MAINNET_OWR_FACTORY_BYTECODE,
-  MAINNET_SPLIT_V2_FACTORY_BYTECODE,
-  MAINNET_SPLITMAIN_BYTECODE,
-  MAINNET_WAREHOUSE_BYTECODE,
-} from './bytecodes';
-
-import * as dotenv from 'dotenv';
-dotenv.config();
-
-export const CONFLICT_ERROR_MSG = 'Conflict';
-
-export const EIP712_DOMAIN_NAME = 'Obol';
-export const EIP712_DOMAIN_VERSION = '1';
-export const CreatorConfigHashSigningTypes = {
-  CreatorConfigHash: [{ name: 'creator_config_hash', type: 'string' }],
-};
-export const TermsAndConditionsSigningTypes = {
-  TermsAndConditions: [
-    { name: 'terms_and_conditions_hash', type: 'string' },
-    { name: 'version', type: 'uint256' },
-  ],
-};
-
-const EIP712Domain = [
-  { name: 'name', type: 'string' },
-  { name: 'version', type: 'string' },
-  { name: 'chainId', type: 'uint256' },
-];
-
-export const Domain = (chainId?: number): TypedDataDomain => {
-  const typeDataDomain: any = {
-    name: EIP712_DOMAIN_NAME,
-    version: EIP712_DOMAIN_VERSION,
-  };
-  if (chainId) {
-    typeDataDomain.chainId = chainId;
-  }
-  return typeDataDomain;
-};
-
-export const CreatorTypedMessage = {
-  EIP712Domain,
-  ...CreatorConfigHashSigningTypes,
-};
-
-// A conflict once updateDefinition is merged
-export const EnrSigningTypes = {
-  ENR: [{ name: 'enr', type: 'string' }],
-};
-
-export const OperatorConfigHashSigningTypes = {
-  OperatorConfigHash: [{ name: 'operator_config_hash', type: 'string' }],
-};
-
-export const OperatorTypedMessage = {
-  EIP712Domain,
-  ...OperatorConfigHashSigningTypes,
-};
-
-export const ENRTypedMessage = {
-  EIP712Domain,
-  ...EnrSigningTypes,
-};
-
-export const signCreatorConfigHashPayload = (
-  payload: { creator_config_hash: string },
-  chainId: number,
-): TypedMessage<typeof CreatorTypedMessage> => {
-  return {
-    types: CreatorTypedMessage,
-    primaryType: 'CreatorConfigHash',
-    domain: {
-      name: EIP712_DOMAIN_NAME,
-      version: EIP712_DOMAIN_VERSION,
-      chainId,
-    },
-    message: payload,
-  };
-};
-
-export const signOperatorConfigHashPayload = (
-  payload: { operator_config_hash: string },
-  chainId: number,
-): TypedMessage<typeof OperatorTypedMessage> => {
-  return {
-    types: OperatorTypedMessage,
-    primaryType: 'OperatorConfigHash',
-    domain: {
-      name: EIP712_DOMAIN_NAME,
-      version: EIP712_DOMAIN_VERSION,
-      chainId,
-    },
-    message: payload,
-  };
-};
-
-export const signEnrPayload = (
-  payload: { enr: string },
-  chainId: number,
-): TypedMessage<typeof ENRTypedMessage> => {
-  return {
-    types: ENRTypedMessage,
-    primaryType: 'ENR',
-    domain: {
-      name: EIP712_DOMAIN_NAME,
-      version: EIP712_DOMAIN_VERSION,
-      chainId,
-    },
-    message: payload,
-  };
-};
-
-export const DKG_ALGORITHM = 'default';
-
-export const CONFIG_VERSION = 'v1.10.0';
-
-export const SDK_VERSION = pjson.version;
-
-export const DOMAIN_APPLICATION_BUILDER = '00000001';
-export const DOMAIN_DEPOSIT = '03000000';
-export const GENESIS_VALIDATOR_ROOT =
-  '0000000000000000000000000000000000000000000000000000000000000000';
-
-// Flow used to create definition
-export enum DefinitionFlow {
-  Group = 'LP-Group',
-  Solo = 'LP-Solo',
-  Charon = 'Charon-Command',
-}
-
-export const DEFAULT_BASE_URL = 'https://api.obol.tech';
-export const DEFAULT_BASE_VERSION = 'v1';
-export const DEFAULT_CHAIN_ID = 17000;
-
-export const ETHER_TO_GWEI = 10 ** 9;
-
-export const TERMS_AND_CONDITIONS_VERSION = 1;
-export const TERMS_AND_CONDITIONS_URL =
-  TERMS_AND_CONDITIONS_VERSION === 1
-    ? 'https://obol.org/terms.pdf'
-    : `https://obol.org/${TERMS_AND_CONDITIONS_VERSION as number}/terms.pdf`;
-export const TERMS_AND_CONDITIONS_HASH =
-  '0xd33721644e8f3afab1495a74abe3523cec12d48b8da6cb760972492ca3f1a273';
-
-export const AVAILABLE_SPLITTER_CHAINS = {
-  [FORK_MAPPING['0x00000000']]: true, // Mainnet
-  [FORK_MAPPING['0x01017000']]: true, // Holesky
-  [FORK_MAPPING['0x10000910']]: true, // Hoodi
-} as const;
-
-export const isChainSupportedForSplitters = (chainId: number): boolean => {
-  return chainId in AVAILABLE_SPLITTER_CHAINS;
-};
-
-export const CHAIN_CONFIGURATION: Record<number, ChainConfig> = {
-  [FORK_MAPPING['0x00000000']]: {
-    SPLITMAIN_CONTRACT: {
-      address: '0x2ed6c4B5dA6378c7897AC67Ba9e43102Feb694EE',
-      bytecode: MAINNET_SPLITMAIN_BYTECODE,
-    },
-    MULTICALL3_CONTRACT: {
-      address: '0xcA11bde05977b3631167028862bE2a173976CA11',
-      bytecode: MAINNET_MULTICALL3_BYTECODE,
-    },
-    OWR_FACTORY_CONTRACT: {
-      address: '0x119acd7844cbdd5fc09b1c6a4408f490c8f7f522',
-      bytecode: MAINNET_OWR_FACTORY_BYTECODE,
-    },
-    RETROACTIVE_FUNDING_CONTRACT: {
-      address: '0xDe5aE4De36c966747Ea7DF13BD9589642e2B1D0d',
-      bytecode: '',
-    },
-    // OVM and SplitV2 Contract Addresses
-    OVM_FACTORY_CONTRACT: {
-      address: '0xdfe2d8b26806583cf03b3cb623b0752f8670e93e',
-      bytecode: MAINNET_OVM_FACTORY_BYTECODE,
-    },
-    WAREHOUSE_CONTRACT: {
-      address: '0x8fb66F38cF86A3d5e8768f8F1754A24A6c661Fb8',
-      bytecode: MAINNET_WAREHOUSE_BYTECODE,
-    },
-    SPLIT_V2_FACTORY_CONTRACT: {
-      address: '0x5cbA88D55Cec83caD5A105Ad40C8c9aF20bE21d1',
-      bytecode: MAINNET_SPLIT_V2_FACTORY_BYTECODE,
-    },
-    EOA_WITHDRAWAL_CONTRACT: {
-      address: '0x00000961Ef480Eb55e80D19ad83579A64c007002',
-    },
-    BATCH_DEPOSIT_CONTRACT: {
-      address: '0xcD7a6C118Ac8F6544BC5076F2D8Fb86D2C546756',
-    },
-  },
-  [FORK_MAPPING['0x01017000']]: {
-    SPLITMAIN_CONTRACT: {
-      address: '0xfC8a305728051367797DADE6Aa0344E0987f5286',
-      bytecode: HOLESKY_SPLITMAIN_BYTECODE,
-    },
-    MULTICALL3_CONTRACT: {
-      address: '0xcA11bde05977b3631167028862bE2a173976CA11',
-      bytecode: HOLESKY_MULTICALL3_BYTECODE,
-    },
-    OWR_FACTORY_CONTRACT: {
-      address: '0xc0961353fcc43a99e3041db07ac646720e116256',
-      bytecode: HOLESKY_OWR_FACTORY_BYTECODE,
-    },
-    RETROACTIVE_FUNDING_CONTRACT: {
-      address: '0x43F641fA70e09f0326ac66b4Ef0C416EaEcBC6f5',
-      bytecode: '',
-    },
-    EOA_WITHDRAWAL_CONTRACT: {
-      address: '0x00000961Ef480Eb55e80D19ad83579A64c007002',
-    },
-  },
-  [FORK_MAPPING['0x10000910']]: {
-    SPLITMAIN_CONTRACT: {
-      address: '0xc05ae267291705ac16F75283572294ed2a91CBc7',
-      bytecode: HOODI_SPLITMAIN_BYTECODE,
-    },
-    MULTICALL3_CONTRACT: {
-      address: '0xcA11bde05977b3631167028862bE2a173976CA11',
-      bytecode: HOODI_MULTICALL3_BYTECODE,
-    },
-    OWR_FACTORY_CONTRACT: {
-      address: '0x9ff0c649d0bf5fe7efa4d72e94bed7302ed5c8d7',
-      bytecode: HOODI_OWR_FACTORY_BYTECODE,
-    },
-    RETROACTIVE_FUNDING_CONTRACT: {
-      address: '0x43F641fA70e09f0326ac66b4Ef0C416EaEcBC6f5',
-      bytecode: '',
-    },
-    // OVM and SplitV2 Contract Addresses
-    OVM_FACTORY_CONTRACT: {
-      address: '0x6F13d929C783a420AE4DC71C1dcc27A02038Ed09',
-      bytecode: HOODI_OVM_FACTORY_BYTECODE,
-    },
-    WAREHOUSE_CONTRACT: {
-      address: '0x8fb66F38cF86A3d5e8768f8F1754A24A6c661Fb8',
-      bytecode: HOODI_WAREHOUSE_BYTECODE,
-    },
-    SPLIT_V2_FACTORY_CONTRACT: {
-      address: '0x5cbA88D55Cec83caD5A105Ad40C8c9aF20bE21d1',
-      bytecode: HOODI_SPLIT_V2_FACTORY_BYTECODE,
-    },
-    EOA_WITHDRAWAL_CONTRACT: {
-      address: '0x00000961Ef480Eb55e80D19ad83579A64c007002',
-    },
-    BATCH_DEPOSIT_CONTRACT: {
-      address: '0x4c9506eE2fCd962f03022D9d8ebf6f7828abEfaf',
-    },
-  },
-};
-
-export const DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT = 1;
-
-export const DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT = 0.1;
-
-// OVM and SplitV2 Default Constants
-export const SPLITS_V2_SALT =
-  '0x2fa740d39f3b04b2c7ef4e9f9e1a6e38f4c72c1a91d8595d5d31a3adf17c6b12';
-export const PRINCIPAL_THRESHOLD = 16;
-
-export const OBOL_SDK_EMAIL = 'sdk@dvlabs.tech';
-
-export const PROVIDER_MAP: Record<number, string> = {
-  1: `${process.env.RPC_MAINNET}`, // Mainnet
-  17000: `${process.env.RPC_HOLESKY}`, // Holesky
-  11155111: `${process.env.RPC_SEPOLIA}`, // Sepolia
-  100: `${process.env.RPC_GNOSIS}`, // Gnosis
-  560048: `${process.env.RPC_HOODI}`, // Hoodi
-};
-
-/**
- * Maps base fork versions to their corresponding Capella fork versions.
- * Example: Mainnet Capella fork version.
- */
-export const CAPELLA_FORK_MAPPING: Record<string, string> = {
-  '0x00000000': '0x03000000', // Mainnet
-  '0x00001020': '0x03001020', // Goerli
-  '0x00000064': '0x03000064', // Gnosis
-  '0x90000069': '0x90000072', // Sepolia
-  '0x01017000': '0x04017000', // Holesky
-  '0x10000910': '0x40000910', // Hoodi
-};
-
-export const CHAIN_PUBLIC_RPC_URL: Record<number, string> = {
-  1: 'https://ethereum-rpc.publicnode.com', // Mainnet
-  560048: 'https://ethereum-hoodi-rpc.publicnode.com', // Hoodi
-};

package/src/eoa/eoa.ts

@@ -1,153 +0,0 @@
-import {
-  submitEOAWithdrawalRequest,
-  submitEOABatchDeposit,
-} from './eoaHelpers';
-import { validatePayload } from '../ajv';
-import { eoaWithdrawalPayloadSchema, eoaDepositPayloadSchema } from '../schema';
-import { CHAIN_CONFIGURATION } from '../constants';
-import {
-  type ProviderType,
-  type SignerType,
-  type EOAWithdrawalPayload,
-  type EOADepositPayload,
-} from '../types';
-
-/**
- * EOA can be used for managing EOA (Externally Owned Account) operations like withdrawals.
- * @class
- * @internal Access it through Client.eoa.
- * @example
- * const obolClient = new Client(config);
- * await obolClient.eoa.requestWithdrawal(EOAWithdrawalPayload);
- */
-export class EOA {
-  private readonly signer: SignerType | undefined;
-  public readonly chainId: number;
-  public readonly provider: ProviderType | undefined | null;
-
-  constructor(
-    signer: SignerType | undefined,
-    chainId: number,
-    provider: ProviderType | undefined | null,
-  ) {
-    this.signer = signer;
-    this.chainId = chainId;
-    this.provider = provider;
-  }
-
-  /**
-   * Requests withdrawal from an EOA contract.
-   *
-   * This method allows requesting withdrawal of validator funds.
-   * The withdrawal request includes validator public key and corresponding withdrawal 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 {EOAWithdrawalPayload} 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 or the request fails
-   *
-   * An example of how to use requestWithdrawal:
-   * ```typescript
-   * const result = await client.eoa.requestWithdrawal({
-   *   pubkey: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
-   *   allocation: 32, // 32 ETH
-   *   requiredFee: '1' // in wei
-   * });
-   * console.log('Withdrawal requested:', result.txHash);
-   * ```
-   */
-  async requestWithdrawal(
-    payload: EOAWithdrawalPayload,
-  ): Promise<{ txHash: string | null }> {
-    if (!this.signer) {
-      throw new Error('Signer is required in requestWithdrawal');
-    }
-
-    if (!this.provider) {
-      throw new Error('Provider is required in requestWithdrawal');
-    }
-
-    const chainConfig = CHAIN_CONFIGURATION[this.chainId];
-    if (!chainConfig?.EOA_WITHDRAWAL_CONTRACT?.address) {
-      throw new Error(
-        `EOA withdrawal contract is not configured for chain ${this.chainId}`,
-      );
-    }
-
-    const validatedPayload = validatePayload<EOAWithdrawalPayload>(
-      payload,
-      eoaWithdrawalPayloadSchema,
-    );
-
-    const withdrawalAddress = await this.signer.getAddress();
-
-    return await submitEOAWithdrawalRequest({
-      pubkey: validatedPayload.pubkey,
-      allocation: validatedPayload.allocation,
-      withdrawalAddress,
-      withdrawalContractAddress: chainConfig.EOA_WITHDRAWAL_CONTRACT.address,
-      requiredFee: validatedPayload.requiredFee,
-      chainId: this.chainId,
-      signer: this.signer,
-      provider: this.provider,
-    });
-  }
-
-  /**
-   * Deposits to batch deposit contract.
-   *
-   * This method allows depositing multiple validators to the Ethereum beacon chain
-   * using the Pier Two batch deposit contract for gas efficiency.
-   * Each deposit includes validator public key, withdrawal credentials, signature, 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.
-   *
-   * **⚠️ Gas Limit:** Due to EVM constraints, it is recommended to deposit in batches of up to 500 at a time.
-   *
-   * @param {EOADepositPayload} payload - Data needed to deposit to batch contract
-   * @returns {Promise<{txHashes: string[]}>} Array of transaction hashes for all batches
-   * @throws Will throw an error if the signer is not provided, contract is not configured, or the deposit fails
-   *
-   * An example of how to use deposit:
-   * ```typescript
-   * const result = await client.eoa.deposit({
-   *   deposits: [{
-   *     pubkey: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
-   *     withdrawal_credentials: '0x1234567890123456789012345678901234567890',
-   *     deposit_data_root: '0x1234567890123456789012345678901234567890123456789012345678901234',
-   *     signature: '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
-   *     amount: '32000000000000000000' // 32 ETH in wei
-   *   }]
-   * });
-   * console.log('Deposits completed:', result.txHashes);
-   * ```
-   */
-  async deposit(payload: EOADepositPayload): Promise<{ txHashes: string[] }> {
-    if (!this.signer) {
-      throw new Error('Signer is required in deposit');
-    }
-
-    const chainConfig = CHAIN_CONFIGURATION[this.chainId];
-    if (!chainConfig?.BATCH_DEPOSIT_CONTRACT?.address) {
-      throw new Error(
-        `Batch deposit contract is not configured for chain ${this.chainId}`,
-      );
-    }
-
-    const validatedPayload = validatePayload<EOADepositPayload>(
-      payload,
-      eoaDepositPayloadSchema,
-    );
-
-    return await submitEOABatchDeposit({
-      deposits: validatedPayload.deposits,
-      batchDepositContractAddress: chainConfig.BATCH_DEPOSIT_CONTRACT.address,
-      signer: this.signer,
-    });
-  }
-}

package/src/eoa/eoaHelpers.ts

@@ -1,112 +0,0 @@
-import { ETHER_TO_GWEI } from '../constants';
-import { type SignerType, type ProviderType } from '../types';
-import { Contract } from 'ethers';
-import { BatchDepositContract } from '../abi/BatchDeposit';
-
-/**
- * Helper function to submit withdrawal request for EOA
- */
-export async function submitEOAWithdrawalRequest({
-  pubkey,
-  allocation,
-  withdrawalAddress,
-  withdrawalContractAddress,
-  requiredFee,
-  chainId,
-  signer,
-  provider,
-}: {
-  pubkey: string;
-  allocation: number;
-  withdrawalAddress: string;
-  withdrawalContractAddress: string;
-  requiredFee: string;
-  chainId: number;
-  signer: SignerType;
-  provider: ProviderType;
-}): Promise<{ txHash: string | null }> {
-  if (!withdrawalAddress) throw new Error('No withdrawal address provided');
-  if (!allocation) throw new Error('No allocation provided');
-
-  const amountInGwei = BigInt(Math.floor(Number(allocation) * ETHER_TO_GWEI));
-  const data = `0x${pubkey.slice(2)}${amountInGwei.toString(16).padStart(16, '0')}`;
-
-  const tx = await signer.sendTransaction({
-    to: withdrawalContractAddress,
-    chainId,
-    value: BigInt(requiredFee),
-    data: data as `0x${string}`,
-  });
-
-  const receipt = await tx.wait();
-  if (!receipt) return { txHash: null };
-  return { txHash: receipt.hash };
-}
-
-/**
- * Helper function to submit batch deposit request for EOA
- */
-export async function submitEOABatchDeposit({
-  deposits,
-  batchDepositContractAddress,
-  signer,
-}: {
-  deposits: Array<{
-    pubkey: string;
-    withdrawal_credentials: string;
-    signature: string;
-    deposit_data_root: string;
-    amount: string;
-  }>;
-  batchDepositContractAddress: string;
-  signer: SignerType;
-}): Promise<{ txHashes: string[] }> {
-  if (!deposits || deposits.length === 0) {
-    throw new Error('No deposits provided');
-  }
-
-  // Create contract instance
-  const batchDepositContract = new Contract(
-    batchDepositContractAddress,
-    BatchDepositContract.abi,
-    signer,
-  );
-
-  const BATCH_SIZE = 500;
-  const txHashes: string[] = [];
-
-  try {
-    // Process deposits in batches of 500
-    for (let i = 0; i < deposits.length; i += BATCH_SIZE) {
-      const batchDeposits = deposits.slice(i, i + BATCH_SIZE);
-
-      // Calculate total value needed for this batch
-      const totalValue = batchDeposits.reduce(
-        (sum, deposit) => sum + BigInt(deposit.amount),
-        BigInt(0),
-      );
-
-      // Prepare deposit data for this batch
-      const depositData = batchDeposits.map(deposit => ({
-        pubKey: deposit.pubkey,
-        withdrawalCredentials: deposit.withdrawal_credentials,
-        signature: deposit.signature,
-        depositDataRoot: deposit.deposit_data_root,
-        amount: BigInt(deposit.amount),
-      }));
-
-      // Execute batch deposit for this batch
-      const tx = await batchDepositContract.batchDeposit(depositData, {
-        value: totalValue,
-      });
-
-      const receipt = await tx.wait();
-      if (receipt?.hash) {
-        txHashes.push(receipt.hash);
-      }
-    }
-    return { txHashes };
-  } catch (error: any) {
-    throw new Error("Failed to submit batch deposit'}");
-  }
-}

package/src/errors.ts

@@ -1,8 +0,0 @@
-export class ConflictError extends Error {
-  name = 'ConflictError';
-
-  constructor() {
-    super('This Cluster has been already posted.');
-    Object.setPrototypeOf(this, ConflictError.prototype);
-  }
-}

package/src/exits/ethUtils.ts

@@ -1,49 +0,0 @@
-import { CAPELLA_FORK_MAPPING } from '../constants';
-
-/**
- * Retrieves the Capella fork version for a given base fork version.
- * @param fork_version - The base fork version string (e.g., '0x00000000' for mainnet).
- * @returns A promise that resolves to the Capella fork version string, or null if not found.
- */
-export async function getCapellaFork(
-  fork_version: string,
-): Promise<string | null> {
-  // Ensure the CAPELLA_FORK_MAPPING uses the base fork_version as key
-  if (CAPELLA_FORK_MAPPING[fork_version]) {
-    return CAPELLA_FORK_MAPPING[fork_version];
-  }
-  return null;
-}
-
-/**
- * Fetches the genesis validators root from a beacon node.
- * @param beaconNodeApiUrl - The base URL of the beacon node API (e.g., http://localhost:5052).
- * @returns A promise that resolves to the genesis_validators_root string, or null on error.
- * @throws Will throw an error if the network corresponding to the fork_version is not supported or if the HTTP request fails.
- */
-export async function getGenesisValidatorsRoot(
-  beaconNodeApiUrl: string,
-): Promise<string | null> {
-  const genesisEndpoint = `${beaconNodeApiUrl}/eth/v1/beacon/genesis`;
-
-  try {
-    const response = await fetch(genesisEndpoint, {
-      method: 'GET',
-    });
-
-    const json = await response.json();
-
-    if (json.data?.genesis_validators_root) {
-      return json.data.genesis_validators_root;
-    }
-    console.error('Invalid response structure from genesis endpoint', json);
-    return null;
-  } catch (e: any) {
-    console.error(
-      `Error fetching genesis validators root from ${genesisEndpoint}:`,
-      e,
-    );
-    const errorMessage = e instanceof Error ? e.message : String(e);
-    throw new Error(`Failed to fetch genesis validators root: ${errorMessage}`);
-  }
-}