Fix total_effective_balance=0 in PreEpochCache (#9106)

Fix a **consensus fault** in `PreEpochCache` 🙀

Fortunately it's only reachable on a network with `total_active_balance=0`, i.e. a network that's already completely dead. As such this PR is not time-sensitive in any way.


  Add the floor on `total_effective_balance` when converting from `PreEpochCache` to `EpochCache`. An alternative would be to add the floor inside `PreEpochCache::get_total_active_balance`, however that would be redundant, as the only place this function is called outside this file is in single-pass epoch processing:

176cce585c/consensus/state_processing/src/per_epoch_processing/single_pass.rs (L461-L462)

The `set_total_active_balance` call already handles the floor.

A regression test is included.


Co-Authored-By: Michael Sproul <michael@sigmaprime.io>
This commit is contained in:
Michael Sproul
2026-04-20 10:59:39 +10:00
committed by GitHub
parent b561b59549
commit 9b08e1ad63

View File

@@ -74,6 +74,8 @@ impl PreEpochCache {
}
}
/// Note: the spec-mandated floor (max with EFFECTIVE_BALANCE_INCREMENT) is applied in
/// `into_epoch_cache` and `set_total_active_balance`. This returns the raw sum.
pub fn get_total_active_balance(&self) -> u64 {
self.total_active_balance
}
@@ -84,7 +86,12 @@ impl PreEpochCache {
spec: &ChainSpec,
) -> Result<EpochCache, EpochCacheError> {
let epoch = self.epoch_key.epoch;
let total_active_balance = self.total_active_balance;
// Apply the spec-mandated floor from `get_total_balance`:
// max(EFFECTIVE_BALANCE_INCREMENT, sum(...))
// This prevents division by zero in base reward calculation when all
// validators have zero effective balance.
let total_active_balance =
std::cmp::max(self.total_active_balance, spec.effective_balance_increment);
let sqrt_total_active_balance = SqrtTotalActiveBalance::new(total_active_balance);
let base_reward_per_increment = BaseRewardPerIncrement::new(total_active_balance, spec)?;
@@ -176,3 +183,40 @@ pub fn initialize_epoch_cache<E: EthSpec>(
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use types::Epoch;
/// Regression test for division-by-zero when all validators have zero effective balance.
///
/// When `process_effective_balance_updates` drops all effective balances to 0, the
/// `PreEpochCache` accumulates `total_active_balance = 0`. Without the spec-mandated floor
/// of `max(EFFECTIVE_BALANCE_INCREMENT, sum)`, `BaseRewardPerIncrement::new()` would divide
/// by `integer_sqrt(0) = 0`.
#[test]
fn into_epoch_cache_zero_total_active_balance() {
let spec = ChainSpec::minimal();
let cache = PreEpochCache {
epoch_key: EpochCacheKey {
epoch: Epoch::new(1),
decision_block_root: Hash256::zero(),
},
effective_balances: vec![0, 0, 0, 0],
total_active_balance: 0,
};
// Verify the raw total is zero.
assert_eq!(cache.get_total_active_balance(), 0);
// This should succeed, not panic with division by zero.
let epoch_cache = cache
.into_epoch_cache(ActivationQueue::default(), &spec)
.expect("into_epoch_cache should not fail with zero total_active_balance");
// Base reward for validator index 0 should be 0.
assert_eq!(epoch_cache.get_base_reward(0).unwrap(), 0);
}
}