add historical summaries (#3865)

* add historical summaries

* fix tree hash caching, disable the sanity slots test with fake crypto

* add ssz static HistoricalSummary

* only store historical summaries after capella

* Teach `UpdatePattern` about Capella

* Tidy EF tests

* Clippy

Co-authored-by: Michael Sproul <michael@sigmaprime.io>

consensus/state_processing/src/per_epoch_processing.rs

@@ -3,14 +3,16 @@
 pub use epoch_processing_summary::EpochProcessingSummary;
 use errors::EpochProcessingError as Error;
 pub use justification_and_finalization_state::JustificationAndFinalizationState;
-pub use registry_updates::process_registry_updates;
 use safe_arith::SafeArith;
-pub use slashings::process_slashings;
 use types::{BeaconState, ChainSpec, EthSpec};
+
+pub use registry_updates::process_registry_updates;
+pub use slashings::process_slashings;
 pub use weigh_justification_and_finalization::weigh_justification_and_finalization;
 
 pub mod altair;
 pub mod base;
+pub mod capella;
 pub mod effective_balance_updates;
 pub mod epoch_processing_summary;
 pub mod errors;
@@ -37,10 +39,8 @@ pub fn process_epoch<T: EthSpec>(
 
     match state {
         BeaconState::Base(_) => base::process_epoch(state, spec),
-        BeaconState::Altair(_)
-        | BeaconState::Merge(_)
-        | BeaconState::Capella(_)
-        | BeaconState::Eip4844(_) => altair::process_epoch(state, spec),
+        BeaconState::Altair(_) | BeaconState::Merge(_) => altair::process_epoch(state, spec),
+        BeaconState::Capella(_) | BeaconState::Eip4844(_) => capella::process_epoch(state, spec),
     }
 }
 

consensus/state_processing/src/per_epoch_processing/capella.rs

@@ -0,0 +1,78 @@
+use super::altair::inactivity_updates::process_inactivity_updates;
+use super::altair::justification_and_finalization::process_justification_and_finalization;
+use super::altair::participation_cache::ParticipationCache;
+use super::altair::participation_flag_updates::process_participation_flag_updates;
+use super::altair::rewards_and_penalties::process_rewards_and_penalties;
+use super::altair::sync_committee_updates::process_sync_committee_updates;
+use super::{process_registry_updates, process_slashings, EpochProcessingSummary, Error};
+use crate::per_epoch_processing::{
+    effective_balance_updates::process_effective_balance_updates,
+    resets::{process_eth1_data_reset, process_randao_mixes_reset, process_slashings_reset},
+};
+use types::{BeaconState, ChainSpec, EthSpec, RelativeEpoch};
+
+pub use historical_summaries_update::process_historical_summaries_update;
+
+mod historical_summaries_update;
+
+pub fn process_epoch<T: EthSpec>(
+    state: &mut BeaconState<T>,
+    spec: &ChainSpec,
+) -> Result<EpochProcessingSummary<T>, Error> {
+    // Ensure the committee caches are built.
+    state.build_committee_cache(RelativeEpoch::Previous, spec)?;
+    state.build_committee_cache(RelativeEpoch::Current, spec)?;
+    state.build_committee_cache(RelativeEpoch::Next, spec)?;
+
+    // Pre-compute participating indices and total balances.
+    let participation_cache = ParticipationCache::new(state, spec)?;
+    let sync_committee = state.current_sync_committee()?.clone();
+
+    // Justification and finalization.
+    let justification_and_finalization_state =
+        process_justification_and_finalization(state, &participation_cache)?;
+    justification_and_finalization_state.apply_changes_to_state(state);
+
+    process_inactivity_updates(state, &participation_cache, spec)?;
+
+    // Rewards and Penalties.
+    process_rewards_and_penalties(state, &participation_cache, spec)?;
+
+    // Registry Updates.
+    process_registry_updates(state, spec)?;
+
+    // Slashings.
+    process_slashings(
+        state,
+        participation_cache.current_epoch_total_active_balance(),
+        spec,
+    )?;
+
+    // Reset eth1 data votes.
+    process_eth1_data_reset(state)?;
+
+    // Update effective balances with hysteresis (lag).
+    process_effective_balance_updates(state, spec)?;
+
+    // Reset slashings
+    process_slashings_reset(state)?;
+
+    // Set randao mix
+    process_randao_mixes_reset(state)?;
+
+    // Set historical summaries accumulator
+    process_historical_summaries_update(state)?;
+
+    // Rotate current/previous epoch participation
+    process_participation_flag_updates(state)?;
+
+    process_sync_committee_updates(state, spec)?;
+
+    // Rotate the epoch caches to suit the epoch transition.
+    state.advance_caches(spec)?;
+
+    Ok(EpochProcessingSummary::Altair {
+        participation_cache,
+        sync_committee,
+    })
+}

consensus/state_processing/src/per_epoch_processing/capella/historical_summaries_update.rs

@@ -0,0 +1,23 @@
+use crate::EpochProcessingError;
+use safe_arith::SafeArith;
+use types::historical_summary::HistoricalSummary;
+use types::{BeaconState, EthSpec};
+
+pub fn process_historical_summaries_update<T: EthSpec>(
+    state: &mut BeaconState<T>,
+) -> Result<(), EpochProcessingError> {
+    // Set historical block root accumulator.
+    let next_epoch = state.next_epoch()?;
+    if next_epoch
+        .as_u64()
+        .safe_rem((T::slots_per_historical_root() as u64).safe_div(T::slots_per_epoch())?)?
+        == 0
+    {
+        let summary = HistoricalSummary::new(state);
+        return state
+            .historical_summaries_mut()?
+            .push(summary)
+            .map_err(Into::into);
+    }
+    Ok(())
+}

consensus/state_processing/src/upgrade/capella.rs

@@ -1,3 +1,4 @@
+use ssz_types::VariableList;
 use std::mem;
 use types::{BeaconState, BeaconStateCapella, BeaconStateError as Error, ChainSpec, EthSpec, Fork};
 
@@ -55,9 +56,10 @@ pub fn upgrade_to_capella<E: EthSpec>(
         next_sync_committee: pre.next_sync_committee.clone(),
         // Execution
         latest_execution_payload_header: pre.latest_execution_payload_header.upgrade_to_capella(),
-        // Withdrawals
+        // Capella
         next_withdrawal_index: 0,
         next_withdrawal_validator_index: 0,
+        historical_summaries: VariableList::default(),
         // Caches
         total_active_balance: pre.total_active_balance,
         committee_caches: mem::take(&mut pre.committee_caches),

consensus/state_processing/src/upgrade/eip4844.rs

@@ -57,9 +57,10 @@ pub fn upgrade_to_eip4844<E: EthSpec>(
         next_sync_committee: pre.next_sync_committee.clone(),
         // Execution
         latest_execution_payload_header: pre.latest_execution_payload_header.upgrade_to_eip4844(),
-        // Withdrawals
+        // Capella
         next_withdrawal_index: pre.next_withdrawal_index,
         next_withdrawal_validator_index: pre.next_withdrawal_validator_index,
+        historical_summaries: pre.historical_summaries.clone(),
         // Caches
         total_active_balance: pre.total_active_balance,
         committee_caches: mem::take(&mut pre.committee_caches),