@lodestar/beacon-node 1.39.0-dev.b37f2bd1bd → 1.39.0-dev.c151a164f2

package/src/eth1/utils/eth1Data.ts

@@ -1,100 +0,0 @@
-import {Root, phase0} from "@lodestar/types";
-import {DepositTree} from "../../db/repositories/depositDataRoot.js";
-import {binarySearchLte} from "../../util/binarySearch.js";
-import {Eth1Error, Eth1ErrorCode} from "../errors.js";
-import {Eth1Block} from "../interface.js";
-
-type BlockNumber = number;
-
-/**
- * Appends partial eth1 data (depositRoot, depositCount) in a sequence of blocks
- * eth1 data deposit is inferred from sparse eth1 data obtained from the deposit logs
- */
-export async function getEth1DataForBlocks(
-  blocks: Eth1Block[],
-  depositDescendingStream: AsyncIterable<phase0.DepositEvent>,
-  depositRootTree: DepositTree,
-  lastProcessedDepositBlockNumber: BlockNumber | null
-): Promise<(phase0.Eth1Data & Eth1Block)[]> {
-  // Exclude blocks for which there is no valid eth1 data deposit
-  if (lastProcessedDepositBlockNumber !== null) {
-    blocks = blocks.filter((block) => block.blockNumber <= lastProcessedDepositBlockNumber);
-  }
-
-  // A valid block can be constructed using previous `state.eth1Data`, don't throw
-  if (blocks.length === 0) {
-    return [];
-  }
-
-  // Collect the latest deposit of each blockNumber in a block number range
-  const fromBlock = blocks[0].blockNumber;
-  const toBlock = blocks.at(-1)?.blockNumber as number;
-  const depositsByBlockNumber = await getDepositsByBlockNumber(fromBlock, toBlock, depositDescendingStream);
-  if (depositsByBlockNumber.length === 0) {
-    throw new Eth1Error({code: Eth1ErrorCode.NO_DEPOSITS_FOR_BLOCK_RANGE, fromBlock, toBlock});
-  }
-
-  // Precompute a map of depositCount => depositRoot (from depositRootTree)
-  const depositCounts = depositsByBlockNumber.map((event) => event.index + 1);
-  const depositRootByDepositCount = getDepositRootByDepositCount(depositCounts, depositRootTree);
-
-  const eth1Datas: (phase0.Eth1Data & Eth1Block)[] = [];
-  for (const block of blocks) {
-    const deposit = binarySearchLte(depositsByBlockNumber, block.blockNumber, (event) => event.blockNumber);
-    const depositCount = deposit.index + 1;
-    const depositRoot = depositRootByDepositCount.get(depositCount);
-    if (depositRoot === undefined) {
-      throw new Eth1Error({code: Eth1ErrorCode.NO_DEPOSIT_ROOT, depositCount});
-    }
-    eth1Datas.push({...block, depositCount, depositRoot});
-  }
-  return eth1Datas;
-}
-
-/**
- * Collect depositCount by blockNumber from a stream matching a block number range
- * For a given blockNumber it's depositCount is equal to the index + 1 of the
- * closest deposit event whose deposit.blockNumber <= blockNumber
- * @returns array ascending by blockNumber
- */
-export async function getDepositsByBlockNumber(
-  fromBlock: BlockNumber,
-  toBlock: BlockNumber,
-  depositEventDescendingStream: AsyncIterable<phase0.DepositEvent>
-): Promise<phase0.DepositEvent[]> {
-  const depositCountMap = new Map<BlockNumber, phase0.DepositEvent>();
-  // Take blocks until the block under the range lower bound (included)
-  for await (const deposit of depositEventDescendingStream) {
-    if (deposit.blockNumber <= toBlock && !depositCountMap.has(deposit.blockNumber)) {
-      depositCountMap.set(deposit.blockNumber, deposit);
-    }
-    if (deposit.blockNumber < fromBlock) {
-      break;
-    }
-  }
-
-  return Array.from(depositCountMap.values()).sort((a, b) => a.blockNumber - b.blockNumber);
-}
-
-/**
- * Precompute a map of depositCount => depositRoot from a depositRootTree filled beforehand
- */
-export function getDepositRootByDepositCount(depositCounts: number[], depositRootTree: DepositTree): Map<number, Root> {
-  // Unique + sort numerically in descending order
-  depositCounts = [...new Set(depositCounts)].sort((a, b) => b - a);
-
-  if (depositCounts.length > 0) {
-    const maxIndex = depositCounts[0] - 1;
-    const treeLength = depositRootTree.length - 1;
-    if (maxIndex > treeLength) {
-      throw new Eth1Error({code: Eth1ErrorCode.NOT_ENOUGH_DEPOSIT_ROOTS, index: maxIndex, treeLength});
-    }
-  }
-
-  const depositRootByDepositCount = new Map<number, Root>();
-  for (const depositCount of depositCounts) {
-    depositRootTree = depositRootTree.sliceTo(depositCount - 1);
-    depositRootByDepositCount.set(depositCount, depositRootTree.hashTreeRoot());
-  }
-  return depositRootByDepositCount;
-}

package/src/eth1/utils/eth1DepositEvent.ts

@@ -1,12 +0,0 @@
-/**
- * Assert that an array of deposits are consecutive and ascending
- */
-export function assertConsecutiveDeposits(depositEvents: {index: number}[]): void {
-  for (let i = 0; i < depositEvents.length - 1; i++) {
-    const indexLeft = depositEvents[i].index;
-    const indexRight = depositEvents[i + 1].index;
-    if (indexLeft !== indexRight - 1) {
-      throw Error(`Non consecutive deposits. deposit[${i}] = ${indexLeft}, deposit[${i + 1}] ${indexRight}`);
-    }
-  }
-}

package/src/eth1/utils/eth1Vote.ts

@@ -1,142 +0,0 @@
-import {ChainForkConfig} from "@lodestar/config";
-import {EPOCHS_PER_ETH1_VOTING_PERIOD, SLOTS_PER_EPOCH, isForkPostElectra} from "@lodestar/params";
-import {BeaconStateAllForks, BeaconStateElectra, computeTimeAtSlot} from "@lodestar/state-transition";
-import {RootHex, phase0} from "@lodestar/types";
-import {toRootHex} from "@lodestar/utils";
-
-export type Eth1DataGetter = ({
-  timestampRange,
-}: {
-  timestampRange: {gte: number; lte: number};
-}) => Promise<phase0.Eth1Data[]>;
-
-export async function getEth1VotesToConsider(
-  config: ChainForkConfig,
-  state: BeaconStateAllForks,
-  eth1DataGetter: Eth1DataGetter
-): Promise<phase0.Eth1Data[]> {
-  const fork = config.getForkName(state.slot);
-  if (isForkPostElectra(fork)) {
-    const {eth1DepositIndex, depositRequestsStartIndex} = state as BeaconStateElectra;
-    if (eth1DepositIndex === Number(depositRequestsStartIndex)) {
-      return state.eth1DataVotes.getAllReadonly();
-    }
-  }
-
-  const periodStart = votingPeriodStartTime(config, state);
-  const {SECONDS_PER_ETH1_BLOCK, ETH1_FOLLOW_DISTANCE} = config;
-
-  // Modified version of the spec function to fetch the required range directly from the DB
-  return (
-    await eth1DataGetter({
-      timestampRange: {
-        // Spec v0.12.2
-        // is_candidate_block =
-        //   block.timestamp + SECONDS_PER_ETH1_BLOCK * ETH1_FOLLOW_DISTANCE <= period_start &&
-        //   block.timestamp + SECONDS_PER_ETH1_BLOCK * ETH1_FOLLOW_DISTANCE * 2 >= period_start
-        lte: periodStart - SECONDS_PER_ETH1_BLOCK * ETH1_FOLLOW_DISTANCE,
-        gte: periodStart - SECONDS_PER_ETH1_BLOCK * ETH1_FOLLOW_DISTANCE * 2,
-      },
-    })
-  ).filter((eth1Data) => eth1Data.depositCount >= state.eth1Data.depositCount);
-}
-
-export function pickEth1Vote(state: BeaconStateAllForks, votesToConsider: phase0.Eth1Data[]): phase0.Eth1Data {
-  const votesToConsiderKeys = new Set<string>();
-  for (const eth1Data of votesToConsider) {
-    votesToConsiderKeys.add(getEth1DataKey(eth1Data));
-  }
-
-  const eth1DataHashToEth1Data = new Map<RootHex, phase0.Eth1Data>();
-  const eth1DataVoteCountByRoot = new Map<RootHex, number>();
-  const eth1DataVotesOrder: RootHex[] = [];
-
-  // BeaconStateAllForks is always represented as a tree with a hashing cache.
-  // To check equality its cheaper to use hashTreeRoot as keys.
-  // However `votesToConsider` is an array of values since those are read from DB.
-  // TODO: Optimize cache of known votes, to prevent re-hashing stored values.
-  // Note: for low validator counts it's not very important, since this runs once per proposal
-  const eth1DataVotes = state.eth1DataVotes.getAllReadonly();
-  for (const eth1DataVote of eth1DataVotes) {
-    const rootHex = getEth1DataKey(eth1DataVote);
-
-    if (votesToConsiderKeys.has(rootHex)) {
-      const prevVoteCount = eth1DataVoteCountByRoot.get(rootHex);
-      eth1DataVoteCountByRoot.set(rootHex, 1 + (prevVoteCount ?? 0));
-
-      // Cache eth1DataVote to root Map only once per root
-      if (prevVoteCount === undefined) {
-        eth1DataHashToEth1Data.set(rootHex, eth1DataVote);
-        eth1DataVotesOrder.push(rootHex);
-      }
-    }
-  }
-
-  const eth1DataRootsMaxVotes = getKeysWithMaxValue(eth1DataVoteCountByRoot);
-
-  // No votes, vote for the last valid vote
-  if (eth1DataRootsMaxVotes.length === 0) {
-    return votesToConsider.at(-1) ?? state.eth1Data;
-  }
-
-  // If there's a single winning vote with a majority vote that one
-  if (eth1DataRootsMaxVotes.length === 1) {
-    return eth1DataHashToEth1Data.get(eth1DataRootsMaxVotes[0]) ?? state.eth1Data;
-  }
-
-  // If there are multiple winning votes, vote for the latest one
-  const latestMostVotedRoot =
-    eth1DataVotesOrder[Math.max(...eth1DataRootsMaxVotes.map((root) => eth1DataVotesOrder.indexOf(root)))];
-  return eth1DataHashToEth1Data.get(latestMostVotedRoot) ?? state.eth1Data;
-}
-
-/**
- * Returns the array of keys with max value. May return 0, 1 or more keys
- */
-function getKeysWithMaxValue<T>(map: Map<T, number>): T[] {
-  const entries = Array.from(map.entries());
-  let keysMax: T[] = [];
-  let valueMax = -Infinity;
-
-  for (const [key, value] of entries) {
-    if (value > valueMax) {
-      keysMax = [key];
-      valueMax = value;
-    } else if (value === valueMax) {
-      keysMax.push(key);
-    }
-  }
-
-  return keysMax;
-}
-
-/**
- * Key-ed by fastSerializeEth1Data(). votesToConsider is read from DB as struct and always has a length of 2048.
- * `state.eth1DataVotes` has a length between 0 and ETH1_FOLLOW_DISTANCE with an equal probability of each value.
- * So to get the average faster time to key both votesToConsider and state.eth1DataVotes it's better to use
- * fastSerializeEth1Data(). However, a long term solution is to cache valid votes in memory and prevent having
- * to recompute their key on every proposal.
- *
- * With `fastSerializeEth1Data()`: avg time 20 ms/op
- * ✓ pickEth1Vote - no votes                                             233.0587 ops/s    4.290764 ms/op        -        121 runs   1.02 s
- * ✓ pickEth1Vote - max votes                                            29.21546 ops/s    34.22845 ms/op        -         25 runs   1.38 s
- *
- * With `toHexString(ssz.phase0.Eth1Data.hashTreeRoot(eth1Data))`: avg time 23 ms/op
- * ✓ pickEth1Vote - no votes                                             46.12341 ops/s    21.68096 ms/op        -        133 runs   3.40 s
- * ✓ pickEth1Vote - max votes                                            37.89912 ops/s    26.38583 ms/op        -         29 runs   1.27 s
- */
-function getEth1DataKey(eth1Data: phase0.Eth1Data): string {
-  return fastSerializeEth1Data(eth1Data);
-}
-
-/**
- * Serialize eth1Data types to a unique string ID. It is only used for comparison.
- */
-export function fastSerializeEth1Data(eth1Data: phase0.Eth1Data): string {
-  return toRootHex(eth1Data.blockHash) + eth1Data.depositCount.toString(16) + toRootHex(eth1Data.depositRoot);
-}
-
-export function votingPeriodStartTime(config: ChainForkConfig, state: BeaconStateAllForks): number {
-  const eth1VotingPeriodStartSlot = state.slot - (state.slot % (EPOCHS_PER_ETH1_VOTING_PERIOD * SLOTS_PER_EPOCH));
-  return computeTimeAtSlot(config, eth1VotingPeriodStartSlot, state.genesisTime);
-}

package/src/eth1/utils/groupDepositEventsByBlock.ts

@@ -1,19 +0,0 @@
-import {phase0} from "@lodestar/types";
-import {BatchDepositEvents} from "../interface.js";
-
-/**
- * Return deposit events of blocks grouped/sorted by block number and deposit index
- * Blocks without events are omitted
- * @param depositEvents range deposit events
- */
-export function groupDepositEventsByBlock(depositEvents: phase0.DepositEvent[]): BatchDepositEvents[] {
-  depositEvents.sort((event1, event2) => event1.index - event2.index);
-  const depositsByBlockMap = new Map<number, phase0.DepositEvent[]>();
-  for (const deposit of depositEvents) {
-    depositsByBlockMap.set(deposit.blockNumber, [...(depositsByBlockMap.get(deposit.blockNumber) || []), deposit]);
-  }
-  return Array.from(depositsByBlockMap.entries()).map(([blockNumber, depositEvents]) => ({
-    blockNumber,
-    depositEvents,
-  }));
-}

package/src/eth1/utils/optimizeNextBlockDiffForGenesis.ts

@@ -1,18 +0,0 @@
-import {ChainConfig} from "@lodestar/config";
-
-/**
- * Utility for fetching genesis min genesis time block
- * Returns an approximation of the next block diff to fetch to progressively
- * get closer to the block that satisfies min genesis time condition
- */
-export function optimizeNextBlockDiffForGenesis(
-  lastFetchedBlock: {timestamp: number},
-  params: Pick<ChainConfig, "MIN_GENESIS_TIME" | "GENESIS_DELAY" | "SECONDS_PER_ETH1_BLOCK">
-): number {
-  const timeToGenesis = params.MIN_GENESIS_TIME - params.GENESIS_DELAY - lastFetchedBlock.timestamp;
-  const numBlocksToGenesis = Math.floor(timeToGenesis / params.SECONDS_PER_ETH1_BLOCK);
-  if (numBlocksToGenesis <= 2) {
-    return 1;
-  }
-  return Math.max(1, Math.floor(numBlocksToGenesis / 2));
-}