refactor: move consensus related constants into ethportal-api (#1825)

morph-dev · web-flow · commit c77330552e79 · 2025-05-15T20:10:19.000+03:00
diff --git a/bin/e2hs-writer/src/subcommands/head_generator/e2hs_builder.rs b/bin/e2hs-writer/src/subcommands/head_generator/e2hs_builder.rs
@@ -2,14 +2,14 @@ use std::path::PathBuf;
 
 use anyhow::ensure;
 use e2store::e2hs::{E2HSWriter, BLOCKS_PER_E2HS};
-use ethportal_api::consensus::{beacon_block::BeaconBlockElectra, beacon_state::HistoricalBatch};
+use ethportal_api::consensus::{
+    beacon_block::BeaconBlockElectra, beacon_state::HistoricalBatch,
+    historical_summaries::historical_summary_index,
+};
 use ssz_types::FixedVector;
 use tempfile::TempDir;
 use tracing::info;
-use trin_validation::{
-    constants::{CAPELLA_FORK_EPOCH, SLOTS_PER_EPOCH, SLOTS_PER_HISTORICAL_ROOT},
-    header_validator::HeaderValidator,
-};
+use trin_validation::header_validator::HeaderValidator;
 
 use super::ethereum_api::EthereumApi;
 use crate::{
@@ -19,7 +19,7 @@ use crate::{
 
 struct ProvingAnchors {
     current_historical_batch: HistoricalBatch,
-    current_historical_summaries_index: u64,
+    current_historical_summary_index: usize,
     header_validator: HeaderValidator,
 }
 
@@ -34,7 +34,7 @@ impl ProvingAnchors {
                 block_roots: FixedVector::default(),
                 state_roots: FixedVector::default(),
             },
-            current_historical_summaries_index: 0,
+            current_historical_summary_index: 0,
             header_validator: HeaderValidator::new_with_historical_summaries(Default::default()),
         }
     }
@@ -112,8 +112,9 @@ impl E2HSBuilder {
 
     /// If the historical summaries index has changed, update the proving anchors.
     async fn update_proving_anchors(&mut self, slot: u64) -> anyhow::Result<()> {
-        let historical_summaries_index = historical_summaries_index(slot);
-        if historical_summaries_index == self.proving_anchors.current_historical_summaries_index {
+        let historical_summary_index = historical_summary_index(slot)
+            .expect("Relevant slot must have historical_summary_index");
+        if historical_summary_index == self.proving_anchors.current_historical_summary_index {
             return Ok(());
         }
 
@@ -122,7 +123,7 @@ impl E2HSBuilder {
             .get_state_for_start_of_next_period(slot)
             .await?;
 
-        self.proving_anchors.current_historical_summaries_index = historical_summaries_index;
+        self.proving_anchors.current_historical_summary_index = historical_summary_index;
         self.proving_anchors.header_validator =
             HeaderValidator::new_with_historical_summaries(state.historical_summaries);
         self.proving_anchors.current_historical_batch = HistoricalBatch {
@@ -155,8 +156,3 @@ impl E2HSBuilder {
         })
     }
 }
-
-/// Calculate the historical summaries index for a given slot.
-pub fn historical_summaries_index(slot: u64) -> u64 {
-    (slot - CAPELLA_FORK_EPOCH * SLOTS_PER_EPOCH) / SLOTS_PER_HISTORICAL_ROOT
-}
diff --git a/bin/e2hs-writer/src/subcommands/head_generator/ethereum_api.rs b/bin/e2hs-writer/src/subcommands/head_generator/ethereum_api.rs
@@ -1,11 +1,13 @@
 use anyhow::{anyhow, bail, ensure};
 use ethportal_api::{
-    consensus::{beacon_block::SignedBeaconBlockElectra, beacon_state::BeaconStateElectra},
+    consensus::{
+        beacon_block::SignedBeaconBlockElectra, beacon_state::BeaconStateElectra,
+        constants::SLOTS_PER_HISTORICAL_ROOT,
+    },
     Receipts,
 };
 use portal_bridge::api::{consensus::ConsensusApi, execution::ExecutionApi};
 use tracing::warn;
-use trin_validation::constants::SLOTS_PER_HISTORICAL_ROOT;
 use url::Url;
 
 pub struct EthereumApi {
diff --git a/bin/e2hs-writer/src/subcommands/head_generator/mod.rs b/bin/e2hs-writer/src/subcommands/head_generator/mod.rs
@@ -12,11 +12,11 @@ use anyhow::{bail, ensure};
 use e2hs_builder::E2HSBuilder;
 use e2store::e2hs::BLOCKS_PER_E2HS;
 use ethereum_api::first_slot_in_a_period;
+use ethportal_api::consensus::constants::SLOTS_PER_EPOCH;
 use humanize_duration::{prelude::DurationExt, Truncate};
 use s3_bucket::S3Bucket;
 use tokio::time::sleep;
 use tracing::{error, info};
-use trin_validation::constants::SLOTS_PER_EPOCH;
 
 use crate::cli::HeadGeneratorConfig;
 
diff --git a/bin/e2hs-writer/src/subcommands/single_generator/provider.rs b/bin/e2hs-writer/src/subcommands/single_generator/provider.rs
@@ -11,7 +11,7 @@ use e2store::{
 use ethportal_api::{
     consensus::{
         beacon_block::SignedBeaconBlock, beacon_state::HistoricalBatch,
-        historical_summaries::HistoricalSummaries,
+        constants::SLOTS_PER_HISTORICAL_ROOT, historical_summaries::HistoricalSummaries,
     },
     types::network_spec::network_spec,
 };
@@ -21,7 +21,6 @@ use reqwest::{
 };
 use tracing::info;
 use trin_execution::era::binary_search::EraBinarySearch;
-use trin_validation::constants::SLOTS_PER_HISTORICAL_ROOT;
 
 pub enum EraSource {
     // processed era1 file
diff --git a/bin/portal-bridge/src/bridge/beacon.rs b/bin/portal-bridge/src/bridge/beacon.rs
@@ -7,7 +7,10 @@ use std::{
 use alloy::primitives::B256;
 use anyhow::bail;
 use ethportal_api::{
-    consensus::historical_summaries::HistoricalSummariesWithProof,
+    consensus::{
+        constants::{SLOTS_PER_EPOCH, SLOTS_PER_HISTORICAL_ROOT},
+        historical_summaries::HistoricalSummariesWithProof,
+    },
     types::{
         consensus::fork::ForkName,
         content_key::beacon::{
@@ -31,7 +34,6 @@ use tokio::{
 use tracing::{error, info, warn, Instrument};
 use trin_beacon::network::BeaconNetwork;
 use trin_metrics::bridge::BridgeMetricsReporter;
-use trin_validation::constants::SLOTS_PER_EPOCH;
 
 use super::{constants::SERVE_BLOCK_TIMEOUT, offer_report::OfferReport};
 use crate::{
@@ -42,9 +44,6 @@ use crate::{
     utils::{duration_until_next_update, expected_current_slot},
 };
 
-/// The number of slots in a sync committee period.
-const SLOTS_PER_PERIOD: u64 = SLOTS_PER_EPOCH * 256;
-
 /// A helper struct to hold the finalized beacon state metadata.
 #[derive(Clone, Debug, Default)]
 pub struct FinalizedBeaconState {
@@ -317,7 +316,7 @@ impl BeaconBridge {
     ) -> anyhow::Result<()> {
         let now = SystemTime::now();
         let expected_current_period =
-            expected_current_slot(BEACON_GENESIS_TIME, now) / SLOTS_PER_PERIOD;
+            expected_current_slot(BEACON_GENESIS_TIME, now) / SLOTS_PER_HISTORICAL_ROOT;
         match expected_current_period.cmp(&*current_period.lock().await) {
             Ordering::Equal => {
                 // We already gossiped the latest data from the current period, no need to serve it
@@ -337,7 +336,8 @@ impl BeaconBridge {
             .get_light_client_updates(expected_current_period, 1)
             .await?
             .remove(0);
-        let finalized_header_period = update.finalized_header.beacon.slot / SLOTS_PER_PERIOD;
+        let finalized_header_period =
+            update.finalized_header.beacon.slot / SLOTS_PER_HISTORICAL_ROOT;
 
         // We don't serve a `LightClientUpdate` if its finalized header slot is not within the
         // expected current period.
diff --git a/bin/portal-bridge/src/types/range.rs b/bin/portal-bridge/src/types/range.rs
@@ -1,6 +1,6 @@
 use std::collections::HashMap;
 
-use trin_validation::constants::SLOTS_PER_HISTORICAL_ROOT;
+use ethportal_api::consensus::constants::SLOTS_PER_HISTORICAL_ROOT;
 
 /// Converts a block range into a mapping of epoch indexes to block ranges.
 ///
diff --git a/bin/trin-execution/src/era/binary_search.rs b/bin/trin-execution/src/era/binary_search.rs
@@ -128,6 +128,6 @@ impl EraBinarySearch {
     }
 
     fn start_slot_index(era_index: u64) -> u64 {
-        (era_index - 1) * SLOTS_PER_HISTORICAL_ROOT as u64
+        (era_index - 1) * SLOTS_PER_HISTORICAL_ROOT
     }
 }
diff --git a/crates/e2store/src/era.rs b/crates/e2store/src/era.rs
@@ -148,7 +148,7 @@ impl Era {
     }
 
     pub fn epoch_index(&self) -> u64 {
-        self.slot_index_state.slot_index.starting_slot / SLOTS_PER_HISTORICAL_ROOT as u64
+        self.slot_index_state.slot_index.starting_slot / SLOTS_PER_HISTORICAL_ROOT
     }
 }
 
@@ -284,25 +284,26 @@ impl From<&SlotIndexBlockEntry> for Entry {
 #[derive(Clone, Eq, PartialEq, Debug)]
 pub struct SlotIndexBlock {
     pub starting_slot: u64,
-    pub indices: [i64; SLOTS_PER_HISTORICAL_ROOT],
+    pub indices: [i64; SLOTS_PER_HISTORICAL_ROOT as usize],
     pub count: u64,
 }
 
 impl SlotIndexBlock {
-    pub const SERIALIZED_SIZE: usize = 8 * (1 + SLOTS_PER_HISTORICAL_ROOT + 1);
+    pub const SERIALIZED_SIZE: usize = 8 * (1 + SLOTS_PER_HISTORICAL_ROOT as usize + 1);
 }
 
 impl TryFrom<Entry> for SlotIndexBlock {
     type Error = anyhow::Error;
 
     fn try_from(entry: Entry) -> Result<Self, Self::Error> {
         let starting_slot = u64::from_le_bytes(entry.value[0..8].try_into()?);
-        let mut indices = [0i64; SLOTS_PER_HISTORICAL_ROOT];
+        let mut indices = [0i64; SLOTS_PER_HISTORICAL_ROOT as usize];
         for (i, index) in indices.iter_mut().enumerate() {
             *index = i64::from_le_bytes(entry.value[(i * 8 + 8)..(i * 8 + 16)].try_into()?);
         }
         let count = u64::from_le_bytes(
-            entry.value[(SLOTS_PER_HISTORICAL_ROOT * 8 + 8)..(SLOTS_PER_HISTORICAL_ROOT * 8 + 16)]
+            entry.value[(SLOTS_PER_HISTORICAL_ROOT * 8 + 8) as usize
+                ..(SLOTS_PER_HISTORICAL_ROOT * 8 + 16) as usize]
                 .try_into()?,
         );
         Ok(Self {
diff --git a/crates/ethportal-api/src/types/consensus/constants.rs b/crates/ethportal-api/src/types/consensus/constants.rs
@@ -1,3 +1,21 @@
-//! Consensus specs values, taken from: https://github.com/ethereum/consensus-specs/blob/d8cfdf2626c1219a40048f8fa3dd103ae8c0b040/presets/mainnet/phase0.yaml
+//! Consensus specs constants.
+//!
+//! Mostly taken from: https://github.com/ethereum/consensus-specs/blob/d8cfdf2626c1219a40048f8fa3dd103ae8c0b040/presets/mainnet/phase0.yaml
+//!
+//! These should eventually be part of the Chain configuration parameters.
 
-pub const SLOTS_PER_HISTORICAL_ROOT: usize = 8192;
+/// Number of slots per Epoch.
+///
+/// 2**5 (= 32) slots 6.4 minutes
+pub const SLOTS_PER_EPOCH: u64 = 32;
+
+/// Number of slots per HistoricalRoot / HistoricalSummary.
+///
+/// 2**13 (= 8,192) slots ~27 hours
+pub const SLOTS_PER_HISTORICAL_ROOT: u64 = 8192;
+
+/// The Epoch of the mainnet Capella fork.
+///
+/// April 12, 2023, 10:27:35pm UTC
+/// Source: https://github.com/ethereum/consensus-specs/blob/d8cfdf2626c1219a40048f8fa3dd103ae8c0b040/configs/mainnet.yaml
+pub const CAPELLA_FORK_EPOCH: u64 = 194_048;
diff --git a/crates/ethportal-api/src/types/consensus/historical_summaries.rs b/crates/ethportal-api/src/types/consensus/historical_summaries.rs
@@ -4,6 +4,8 @@ use ssz_derive::{Decode, Encode};
 use ssz_types::{typenum, FixedVector, VariableList};
 use tree_hash_derive::TreeHash;
 
+use super::constants::{CAPELLA_FORK_EPOCH, SLOTS_PER_EPOCH, SLOTS_PER_HISTORICAL_ROOT};
+
 /// The Generalized Index of the `historical_summaries` field of the
 /// [BeaconState](super::beacon_state::BeaconState), for Electra fork.
 pub const HISTORICAL_SUMMARIES_GINDEX: usize = 91;
@@ -36,3 +38,15 @@ pub struct HistoricalSummariesWithProof {
     pub historical_summaries: HistoricalSummaries,
     pub proof: HistoricalSummariesProof,
 }
+
+/// Calculates the index of a [HistoricalSummary] in [HistoricalSummaries] for a given slot.
+///
+/// Returns `None` is slot is before Capella fork.
+pub fn historical_summary_index(slot: u64) -> Option<usize> {
+    let capella_slot = CAPELLA_FORK_EPOCH * SLOTS_PER_EPOCH;
+    if slot < capella_slot {
+        None
+    } else {
+        Some(((slot - capella_slot) / SLOTS_PER_HISTORICAL_ROOT) as usize)
+    }
+}
diff --git a/crates/ethportal-api/src/types/execution/header_with_proof.rs b/crates/ethportal-api/src/types/execution/header_with_proof.rs
@@ -184,7 +184,7 @@ pub fn build_historical_roots_proof(
     beacon_block: &BeaconBlockBellatrix,
 ) -> BlockProofHistoricalRoots {
     let beacon_block_proof = BeaconBlockProofHistoricalRoots::new(
-        historical_batch.build_block_root_proof(slot as usize % SLOTS_PER_HISTORICAL_ROOT),
+        historical_batch.build_block_root_proof((slot % SLOTS_PER_HISTORICAL_ROOT) as usize),
     )
     .expect("error creating BeaconBlockProofHistoricalRoots");
 
@@ -211,7 +211,7 @@ pub fn build_capella_historical_summaries_proof(
 ) -> BlockProofHistoricalSummariesCapella {
     let beacon_block_proof = build_merkle_proof_for_index(
         block_roots.clone(),
-        slot as usize % SLOTS_PER_HISTORICAL_ROOT,
+        (slot % SLOTS_PER_HISTORICAL_ROOT) as usize,
     );
     let beacon_block_proof = BeaconBlockProofHistoricalSummaries::new(beacon_block_proof)
         .expect("error creating BeaconBlockProofHistoricalSummaries");
@@ -238,7 +238,7 @@ pub fn build_deneb_historical_summaries_proof(
 ) -> BlockProofHistoricalSummariesDeneb {
     let beacon_block_proof = build_merkle_proof_for_index(
         block_roots.clone(),
-        slot as usize % SLOTS_PER_HISTORICAL_ROOT,
+        (slot % SLOTS_PER_HISTORICAL_ROOT) as usize,
     );
     let beacon_block_proof = BeaconBlockProofHistoricalSummaries::new(beacon_block_proof)
         .expect("error creating BeaconBlockProofHistoricalSummaries");
@@ -265,7 +265,7 @@ pub fn build_electra_historical_summaries_proof(
 ) -> BlockProofHistoricalSummariesDeneb {
     let beacon_block_proof = build_merkle_proof_for_index(
         block_roots.clone(),
-        slot as usize % SLOTS_PER_HISTORICAL_ROOT,
+        (slot % SLOTS_PER_HISTORICAL_ROOT) as usize,
     );
     let beacon_block_proof = BeaconBlockProofHistoricalSummaries::new(beacon_block_proof)
         .expect("error creating BeaconBlockProofHistoricalSummaries");
diff --git a/crates/light-client/src/config/client_config.rs b/crates/light-client/src/config/client_config.rs
@@ -1,12 +1,12 @@
 use std::{path::PathBuf, process::exit};
 
 use alloy::primitives::{FixedBytes, B256};
+use ethportal_api::consensus::constants::SLOTS_PER_EPOCH;
 use figment::{
     providers::{Format, Serialized, Toml},
     Figment,
 };
 use serde::Deserialize;
-use trin_validation::constants::SLOTS_PER_EPOCH;
 
 use crate::config::{networks, BaseConfig, ChainConfig, CliConfig, Forks};
 
diff --git a/crates/validation/src/accumulator.rs b/crates/validation/src/accumulator.rs
@@ -5,18 +5,19 @@ use alloy::{
     primitives::{B256, U256},
 };
 use anyhow::anyhow;
-use ethportal_api::types::execution::{
-    accumulator::EpochAccumulator, header_with_proof::BlockProofHistoricalHashesAccumulator,
+use ethportal_api::{
+    consensus::constants::SLOTS_PER_HISTORICAL_ROOT,
+    types::execution::{
+        accumulator::EpochAccumulator, header_with_proof::BlockProofHistoricalHashesAccumulator,
+    },
 };
 use serde::{Deserialize, Serialize};
 use ssz::Decode;
 use ssz_derive::{Decode, Encode};
 use ssz_types::{typenum, VariableList};
 use tree_hash_derive::TreeHash;
 
-use crate::{
-    constants::SLOTS_PER_HISTORICAL_ROOT, merkle::proof::MerkleTree, TrinValidationAssets,
-};
+use crate::{merkle::proof::MerkleTree, TrinValidationAssets};
 
 /// SSZ List[Hash256, max_length = MAX_HISTORICAL_EPOCHS]
 /// List of historical epoch accumulator merkle roots preceding current epoch.
diff --git a/crates/validation/src/constants.rs b/crates/validation/src/constants.rs
@@ -1,18 +1,8 @@
 use alloy::primitives::{b256, B256};
 
-// Execution Layer hard forks https://ethereum.org/en/history/
-pub const CAPELLA_FORK_EPOCH: u64 = 194_048;
-pub const SLOTS_PER_EPOCH: u64 = 32;
-
 /// The default hash of the pre-merge accumulator at the time of the merge block.
 pub const DEFAULT_PRE_MERGE_ACC_HASH: B256 =
     b256!("0x8eac399e24480dce3cfe06f4bdecba51c6e5d0c46200e3e8611a0b44a3a69ff9");
 
-/// Max number of blocks / epoch = 2 ** 13
-pub const SLOTS_PER_HISTORICAL_ROOT: u64 = 8192;
-
-// Max number of epochs = 2 ** 17
-// const MAX_HISTORICAL_EPOCHS: usize = 131072;
-
 // EIP-155 chain ID for Ethereum mainnet
 pub const CHAIN_ID: usize = 1;
diff --git a/crates/validation/src/header_validator.rs b/crates/validation/src/header_validator.rs
@@ -4,7 +4,7 @@ use alloy::{consensus::Header, primitives::B256};
 use alloy_hardforks::EthereumHardforks;
 use anyhow::bail;
 use ethportal_api::{
-    consensus::historical_summaries::HistoricalSummaries,
+    consensus::{constants::SLOTS_PER_HISTORICAL_ROOT, historical_summaries::HistoricalSummaries},
     types::{
         execution::header_with_proof::{
             BeaconBlockProofHistoricalRoots, BeaconBlockProofHistoricalSummaries, BlockHeaderProof,
@@ -21,7 +21,6 @@ use tree_hash::TreeHash;
 
 use crate::{
     accumulator::PreMergeAccumulator,
-    constants::SLOTS_PER_HISTORICAL_ROOT,
     historical_roots_acc::HistoricalRootsAccumulator,
     historical_summaries_provider::{HistoricalSummariesProvider, HistoricalSummariesSource},
     merkle::proof::verify_merkle_proof,
diff --git a/crates/validation/src/historical_summaries_provider.rs b/crates/validation/src/historical_summaries_provider.rs

Original file line number	Diff line number	Diff line change
`@@ -128,6 +128,6 @@ impl EraBinarySearch {`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`fn start_slot_index(era_index: u64) -> u64 {`
`131`		`- (era_index - 1) * SLOTS_PER_HISTORICAL_ROOT as u64`
	`131`	`+ (era_index - 1) * SLOTS_PER_HISTORICAL_ROOT`
`132`	`132`	`}`
`133`	`133`	`}`
Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,7 @@ impl Era {`
`148`	`148`	`}`
`149`	`149`
`150`	`150`	`pub fn epoch_index(&self) -> u64 {`
`151`		`- self.slot_index_state.slot_index.starting_slot / SLOTS_PER_HISTORICAL_ROOT as u64`
	`151`	`+ self.slot_index_state.slot_index.starting_slot / SLOTS_PER_HISTORICAL_ROOT`
`152`	`152`	`}`
`153`	`153`	`}`
`154`	`154`
`@@ -284,25 +284,26 @@ impl From<&SlotIndexBlockEntry> for Entry {`
`284`	`284`	`#[derive(Clone, Eq, PartialEq, Debug)]`
`285`	`285`	`pub struct SlotIndexBlock {`
`286`	`286`	`pub starting_slot: u64,`
`287`		`- pub indices: [i64; SLOTS_PER_HISTORICAL_ROOT],`
	`287`	`+ pub indices: [i64; SLOTS_PER_HISTORICAL_ROOT as usize],`
`288`	`288`	`pub count: u64,`
`289`	`289`	`}`
`290`	`290`
`291`	`291`	`impl SlotIndexBlock {`
`292`		`- pub const SERIALIZED_SIZE: usize = 8 * (1 + SLOTS_PER_HISTORICAL_ROOT + 1);`
	`292`	`+ pub const SERIALIZED_SIZE: usize = 8 * (1 + SLOTS_PER_HISTORICAL_ROOT as usize + 1);`
`293`	`293`	`}`
`294`	`294`
`295`	`295`	`impl TryFrom<Entry> for SlotIndexBlock {`
`296`	`296`	`type Error = anyhow::Error;`
`297`	`297`
`298`	`298`	`fn try_from(entry: Entry) -> Result<Self, Self::Error> {`
`299`	`299`	`let starting_slot = u64::from_le_bytes(entry.value[0..8].try_into()?);`
`300`		`- let mut indices = [0i64; SLOTS_PER_HISTORICAL_ROOT];`
	`300`	`+ let mut indices = [0i64; SLOTS_PER_HISTORICAL_ROOT as usize];`
`301`	`301`	`for (i, index) in indices.iter_mut().enumerate() {`
`302`	`302`	`index = i64::from_le_bytes(entry.value[(i 8 + 8)..(i * 8 + 16)].try_into()?);`
`303`	`303`	`}`
`304`	`304`	`let count = u64::from_le_bytes(`
`305`		`- entry.value[(SLOTS_PER_HISTORICAL_ROOT * 8 + 8)..(SLOTS_PER_HISTORICAL_ROOT * 8 + 16)]`
	`305`	`+ entry.value[(SLOTS_PER_HISTORICAL_ROOT * 8 + 8) as usize`
	`306`	`+ ..(SLOTS_PER_HISTORICAL_ROOT * 8 + 16) as usize]`
`306`	`307`	`.try_into()?,`
`307`	`308`	`);`
`308`	`309`	`Ok(Self {`