use crate::{ BlockProcessingError, BlockSignatureStrategy, ConsensusContext, SlotProcessingError, VerifyBlockRoot, per_block_processing, per_epoch_processing::EpochProcessingSummary, per_slot_processing, }; use itertools::Itertools; use std::iter::Peekable; use std::marker::PhantomData; use types::{ BeaconState, BeaconStateError, BlindedPayload, ChainSpec, EthSpec, Hash256, SignedBeaconBlock, Slot, }; pub type PreBlockHook<'a, E, Error> = Box< dyn FnMut(&mut BeaconState, &SignedBeaconBlock>) -> Result<(), Error> + 'a, >; pub type PostBlockHook<'a, E, Error> = PreBlockHook<'a, E, Error>; pub type PreSlotHook<'a, E, Error> = Box) -> Result<(), Error> + 'a>; pub type PostSlotHook<'a, E, Error> = Box< dyn FnMut(&mut BeaconState, Option>, bool) -> Result<(), Error> + 'a, >; pub type StateRootIterDefault = std::iter::Empty>; /// Efficiently apply blocks to a state while configuring various parameters. /// /// Usage follows a builder pattern. pub struct BlockReplayer< 'a, Spec: EthSpec, Error = BlockReplayError, StateRootIter: Iterator> = StateRootIterDefault, > { state: BeaconState, spec: &'a ChainSpec, block_sig_strategy: BlockSignatureStrategy, verify_block_root: Option, pre_block_hook: Option>, post_block_hook: Option>, pre_slot_hook: Option>, post_slot_hook: Option>, pub(crate) state_root_iter: Option>, state_root_miss: bool, _phantom: PhantomData, } #[derive(Debug)] pub enum BlockReplayError { SlotProcessing(SlotProcessingError), BlockProcessing(BlockProcessingError), BeaconState(BeaconStateError), } impl From for BlockReplayError { fn from(e: SlotProcessingError) -> Self { Self::SlotProcessing(e) } } impl From for BlockReplayError { fn from(e: BlockProcessingError) -> Self { Self::BlockProcessing(e) } } impl From for BlockReplayError { fn from(e: BeaconStateError) -> Self { Self::BeaconState(e) } } impl<'a, E, Error, StateRootIter> BlockReplayer<'a, E, Error, StateRootIter> where E: EthSpec, StateRootIter: Iterator>, Error: From, { /// Create a new replayer that will apply blocks upon `state`. /// /// Defaults: /// /// - Full (bulk) signature verification /// - Accurate state roots /// - Full block root verification pub fn new(state: BeaconState, spec: &'a ChainSpec) -> Self { Self { state, spec, block_sig_strategy: BlockSignatureStrategy::VerifyBulk, verify_block_root: Some(VerifyBlockRoot::True), pre_block_hook: None, post_block_hook: None, pre_slot_hook: None, post_slot_hook: None, state_root_iter: None, state_root_miss: false, _phantom: PhantomData, } } /// Set the replayer's block signature verification strategy. pub fn block_signature_strategy(mut self, block_sig_strategy: BlockSignatureStrategy) -> Self { self.block_sig_strategy = block_sig_strategy; self } /// Disable signature verification during replay. /// /// If you are truly _replaying_ blocks then you will almost certainly want to disable /// signature checks for performance. pub fn no_signature_verification(self) -> Self { self.block_signature_strategy(BlockSignatureStrategy::NoVerification) } /// Verify only the block roots of the initial few blocks, and trust the rest. pub fn minimal_block_root_verification(mut self) -> Self { self.verify_block_root = None; self } /// Supply a state root iterator to accelerate slot processing. /// /// If possible the state root iterator should return a state root for every slot from /// `self.state.slot` to the `target_slot` supplied to `apply_blocks` (inclusive of both /// endpoints). pub fn state_root_iter(mut self, iter: StateRootIter) -> Self { self.state_root_iter = Some(iter.peekable()); self } /// Run a function immediately before each block that is applied during `apply_blocks`. /// /// This can be used to inspect the state as blocks are applied. pub fn pre_block_hook(mut self, hook: PreBlockHook<'a, E, Error>) -> Self { self.pre_block_hook = Some(hook); self } /// Run a function immediately after each block that is applied during `apply_blocks`. /// /// This can be used to inspect the state as blocks are applied. pub fn post_block_hook(mut self, hook: PostBlockHook<'a, E, Error>) -> Self { self.post_block_hook = Some(hook); self } /// Run a function immediately before slot processing advances the state to the next slot. pub fn pre_slot_hook(mut self, hook: PreSlotHook<'a, E, Error>) -> Self { self.pre_slot_hook = Some(hook); self } /// Run a function immediately after slot processing has advanced the state to the next slot. /// /// The hook receives the state and a bool indicating if this state corresponds to a skipped /// slot (i.e. it will not have a block applied). pub fn post_slot_hook(mut self, hook: PostSlotHook<'a, E, Error>) -> Self { self.post_slot_hook = Some(hook); self } /// Compute the state root for `self.state` as efficiently as possible. /// /// This function MUST only be called when `self.state` is a post-state, i.e. it MUST not be /// called between advancing a state with `per_slot_processing` and applying the block for that /// slot. /// /// The `blocks` should be the full list of blocks being applied and `i` should be the index of /// the next block that will be applied, or `blocks.len()` if all blocks have already been /// applied. /// /// If the state root is not available from the state root iterator or the blocks then it will /// be computed from `self.state` and a state root iterator miss will be recorded. fn get_state_root( &mut self, blocks: &[SignedBeaconBlock>], i: usize, ) -> Result { let slot = self.state.slot(); // If a state root iterator is configured, use it to find the root. if let Some(ref mut state_root_iter) = self.state_root_iter { let opt_root = state_root_iter .peeking_take_while(|res| res.as_ref().map_or(true, |(_, s)| *s <= slot)) .find(|res| res.as_ref().map_or(true, |(_, s)| *s == slot)) .transpose()?; if let Some((root, _)) = opt_root { return Ok(root); } } // Otherwise try to source a root from the previous block. if let Some(prev_i) = i.checked_sub(1) && let Some(prev_block) = blocks.get(prev_i) && prev_block.slot() == slot { return Ok(prev_block.state_root()); } self.state_root_miss = true; let state_root = self .state .update_tree_hash_cache() .map_err(BlockReplayError::from)?; Ok(state_root) } /// Apply `blocks` atop `self.state`, taking care of slot processing. /// /// If `target_slot` is provided then the state will be advanced through to `target_slot` /// after the blocks have been applied. pub fn apply_blocks( mut self, blocks: Vec>>, target_slot: Option, ) -> Result { for (i, block) in blocks.iter().enumerate() { // Allow one additional block at the start which is only used for its state root. if i == 0 && block.slot() <= self.state.slot() { continue; } while self.state.slot() < block.slot() { let state_root = self.get_state_root(&blocks, i)?; if let Some(ref mut pre_slot_hook) = self.pre_slot_hook { pre_slot_hook(state_root, &mut self.state)?; } let summary = per_slot_processing(&mut self.state, Some(state_root), self.spec) .map_err(BlockReplayError::from)?; if let Some(ref mut post_slot_hook) = self.post_slot_hook { let is_skipped_slot = self.state.slot() < block.slot(); post_slot_hook(&mut self.state, summary, is_skipped_slot)?; } } if let Some(ref mut pre_block_hook) = self.pre_block_hook { pre_block_hook(&mut self.state, block)?; } // If no explicit policy is set, verify only the first 1 or 2 block roots. let verify_block_root = self.verify_block_root.unwrap_or(if i <= 1 { VerifyBlockRoot::True } else { VerifyBlockRoot::False }); // Proposer index was already checked when this block was originally processed, we // can omit recomputing it during replay. let mut ctxt = ConsensusContext::new(block.slot()) .set_proposer_index(block.message().proposer_index()); per_block_processing( &mut self.state, block, self.block_sig_strategy, verify_block_root, &mut ctxt, self.spec, ) .map_err(BlockReplayError::from)?; if let Some(ref mut post_block_hook) = self.post_block_hook { post_block_hook(&mut self.state, block)?; } } if let Some(target_slot) = target_slot { while self.state.slot() < target_slot { let state_root = self.get_state_root(&blocks, blocks.len())?; if let Some(ref mut pre_slot_hook) = self.pre_slot_hook { pre_slot_hook(state_root, &mut self.state)?; } let summary = per_slot_processing(&mut self.state, Some(state_root), self.spec) .map_err(BlockReplayError::from)?; if let Some(ref mut post_slot_hook) = self.post_slot_hook { // No more blocks to apply (from our perspective) so we consider these slots // skipped. let is_skipped_slot = true; post_slot_hook(&mut self.state, summary, is_skipped_slot)?; } } } Ok(self) } /// After block application, check if a state root miss occurred. pub fn state_root_miss(&self) -> bool { self.state_root_miss } /// Convert the replayer into the state that was built. pub fn into_state(self) -> BeaconState { self.state } } impl BlockReplayer<'_, E, Error, StateRootIterDefault> where E: EthSpec, Error: From, { /// If type inference fails to infer the state root iterator type you can use this method /// to hint that no state root iterator is desired. pub fn no_state_root_iter(self) -> Self { self } }