hotshot_types/
consensus.rs

1// Copyright (c) 2021-2024 Espresso Systems (espressosys.com)
2// This file is part of the HotShot repository.
3
4// You should have received a copy of the MIT License
5// along with the HotShot repository. If not, see <https://mit-license.org/>.
6
7//! Provides the core consensus types
8
9use std::{
10    collections::{BTreeMap, HashMap},
11    mem::ManuallyDrop,
12    ops::{Deref, DerefMut},
13    sync::Arc,
14};
15
16use async_lock::{RwLock, RwLockReadGuard, RwLockUpgradableReadGuard, RwLockWriteGuard};
17use committable::{Commitment, Committable};
18use hotshot_utils::anytrace::*;
19use tracing::instrument;
20use vec1::Vec1;
21
22pub use crate::utils::{View, ViewInner};
23use crate::{
24    data::{
25        Leaf2, QuorumProposalWrapper, VidCommitment, VidDisperse, VidDisperseAndDuration,
26        VidDisperseShare,
27    },
28    drb::DrbResults,
29    epoch_membership::EpochMembershipCoordinator,
30    error::HotShotError,
31    event::{HotShotAction, LeafInfo},
32    message::{Proposal, UpgradeLock},
33    simple_certificate::{
34        DaCertificate2, LightClientStateUpdateCertificate, NextEpochQuorumCertificate2,
35        QuorumCertificate2,
36    },
37    simple_vote::HasEpoch,
38    traits::{
39        block_contents::{BlockHeader, BuilderFee},
40        metrics::{Counter, Gauge, Histogram, Metrics, NoMetrics},
41        node_implementation::{ConsensusTime, NodeType, Versions},
42        signature_key::SignatureKey,
43        BlockPayload, ValidatedState,
44    },
45    utils::{
46        epoch_from_block_number, is_epoch_root, is_epoch_transition, is_ge_epoch_root,
47        is_last_block, is_transition_block, option_epoch_from_block_number, BuilderCommitment,
48        LeafCommitment, StateAndDelta, Terminator,
49    },
50    vote::{Certificate, HasViewNumber},
51};
52
53/// A type alias for `HashMap<Commitment<T>, T>`
54pub type CommitmentMap<T> = HashMap<Commitment<T>, T>;
55
56/// A type alias for `BTreeMap<T::Time, HashMap<T::SignatureKey, BTreeMap<T::Epoch, Proposal<T, VidDisperseShare<T>>>>>`
57pub type VidShares<TYPES> = BTreeMap<
58    <TYPES as NodeType>::View,
59    HashMap<
60        <TYPES as NodeType>::SignatureKey,
61        BTreeMap<Option<<TYPES as NodeType>::Epoch>, Proposal<TYPES, VidDisperseShare<TYPES>>>,
62    >,
63>;
64
65/// Type alias for consensus state wrapped in a lock.
66pub type LockedConsensusState<TYPES> = Arc<RwLock<Consensus<TYPES>>>;
67
68/// A thin wrapper around `LockedConsensusState` that helps debugging locks
69#[derive(Clone, Debug)]
70pub struct OuterConsensus<TYPES: NodeType> {
71    /// Inner `LockedConsensusState`
72    pub inner_consensus: LockedConsensusState<TYPES>,
73}
74
75impl<TYPES: NodeType> OuterConsensus<TYPES> {
76    /// Create a new instance of `OuterConsensus`, hopefully uniquely named
77    pub fn new(consensus: LockedConsensusState<TYPES>) -> Self {
78        Self {
79            inner_consensus: consensus,
80        }
81    }
82
83    /// Locks inner consensus for reading and leaves debug traces
84    #[instrument(skip_all, target = "OuterConsensus")]
85    pub async fn read(&self) -> ConsensusReadLockGuard<'_, TYPES> {
86        tracing::trace!("Trying to acquire read lock on consensus");
87        let ret = self.inner_consensus.read().await;
88        tracing::trace!("Acquired read lock on consensus");
89        ConsensusReadLockGuard::new(ret)
90    }
91
92    /// Locks inner consensus for writing and leaves debug traces
93    #[instrument(skip_all, target = "OuterConsensus")]
94    pub async fn write(&self) -> ConsensusWriteLockGuard<'_, TYPES> {
95        tracing::trace!("Trying to acquire write lock on consensus");
96        let ret = self.inner_consensus.write().await;
97        tracing::trace!("Acquired write lock on consensus");
98        ConsensusWriteLockGuard::new(ret)
99    }
100
101    /// Tries to acquire write lock on inner consensus and leaves debug traces
102    #[instrument(skip_all, target = "OuterConsensus")]
103    pub fn try_write(&self) -> Option<ConsensusWriteLockGuard<'_, TYPES>> {
104        tracing::trace!("Trying to acquire write lock on consensus");
105        let ret = self.inner_consensus.try_write();
106        if let Some(guard) = ret {
107            tracing::trace!("Acquired write lock on consensus");
108            Some(ConsensusWriteLockGuard::new(guard))
109        } else {
110            tracing::trace!("Failed to acquire write lock");
111            None
112        }
113    }
114
115    /// Acquires upgradable read lock on inner consensus and leaves debug traces
116    #[instrument(skip_all, target = "OuterConsensus")]
117    pub async fn upgradable_read(&self) -> ConsensusUpgradableReadLockGuard<'_, TYPES> {
118        tracing::trace!("Trying to acquire upgradable read lock on consensus");
119        let ret = self.inner_consensus.upgradable_read().await;
120        tracing::trace!("Acquired upgradable read lock on consensus");
121        ConsensusUpgradableReadLockGuard::new(ret)
122    }
123
124    /// Tries to acquire read lock on inner consensus and leaves debug traces
125    #[instrument(skip_all, target = "OuterConsensus")]
126    pub fn try_read(&self) -> Option<ConsensusReadLockGuard<'_, TYPES>> {
127        tracing::trace!("Trying to acquire read lock on consensus");
128        let ret = self.inner_consensus.try_read();
129        if let Some(guard) = ret {
130            tracing::trace!("Acquired read lock on consensus");
131            Some(ConsensusReadLockGuard::new(guard))
132        } else {
133            tracing::trace!("Failed to acquire read lock");
134            None
135        }
136    }
137}
138
139/// A thin wrapper around `RwLockReadGuard` for `Consensus` that leaves debug traces when the lock is freed
140pub struct ConsensusReadLockGuard<'a, TYPES: NodeType> {
141    /// Inner `RwLockReadGuard`
142    lock_guard: RwLockReadGuard<'a, Consensus<TYPES>>,
143}
144
145impl<'a, TYPES: NodeType> ConsensusReadLockGuard<'a, TYPES> {
146    /// Creates a new instance of `ConsensusReadLockGuard` with the same name as parent `OuterConsensus`
147    #[must_use]
148    pub fn new(lock_guard: RwLockReadGuard<'a, Consensus<TYPES>>) -> Self {
149        Self { lock_guard }
150    }
151}
152
153impl<TYPES: NodeType> Deref for ConsensusReadLockGuard<'_, TYPES> {
154    type Target = Consensus<TYPES>;
155    fn deref(&self) -> &Self::Target {
156        &self.lock_guard
157    }
158}
159
160impl<TYPES: NodeType> Drop for ConsensusReadLockGuard<'_, TYPES> {
161    #[instrument(skip_all, target = "ConsensusReadLockGuard")]
162    fn drop(&mut self) {
163        tracing::trace!("Read lock on consensus dropped");
164    }
165}
166
167/// A thin wrapper around `RwLockWriteGuard` for `Consensus` that leaves debug traces when the lock is freed
168pub struct ConsensusWriteLockGuard<'a, TYPES: NodeType> {
169    /// Inner `RwLockWriteGuard`
170    lock_guard: RwLockWriteGuard<'a, Consensus<TYPES>>,
171}
172
173impl<'a, TYPES: NodeType> ConsensusWriteLockGuard<'a, TYPES> {
174    /// Creates a new instance of `ConsensusWriteLockGuard` with the same name as parent `OuterConsensus`
175    #[must_use]
176    pub fn new(lock_guard: RwLockWriteGuard<'a, Consensus<TYPES>>) -> Self {
177        Self { lock_guard }
178    }
179}
180
181impl<TYPES: NodeType> Deref for ConsensusWriteLockGuard<'_, TYPES> {
182    type Target = Consensus<TYPES>;
183    fn deref(&self) -> &Self::Target {
184        &self.lock_guard
185    }
186}
187
188impl<TYPES: NodeType> DerefMut for ConsensusWriteLockGuard<'_, TYPES> {
189    fn deref_mut(&mut self) -> &mut Self::Target {
190        &mut self.lock_guard
191    }
192}
193
194impl<TYPES: NodeType> Drop for ConsensusWriteLockGuard<'_, TYPES> {
195    #[instrument(skip_all, target = "ConsensusWriteLockGuard")]
196    fn drop(&mut self) {
197        tracing::debug!("Write lock on consensus dropped");
198    }
199}
200
201/// A thin wrapper around `RwLockUpgradableReadGuard` for `Consensus` that leaves debug traces when the lock is freed or upgraded
202pub struct ConsensusUpgradableReadLockGuard<'a, TYPES: NodeType> {
203    /// Inner `RwLockUpgradableReadGuard`
204    lock_guard: ManuallyDrop<RwLockUpgradableReadGuard<'a, Consensus<TYPES>>>,
205    /// A helper bool to indicate whether inner lock has been unsafely taken or not
206    taken: bool,
207}
208
209impl<'a, TYPES: NodeType> ConsensusUpgradableReadLockGuard<'a, TYPES> {
210    /// Creates a new instance of `ConsensusUpgradableReadLockGuard` with the same name as parent `OuterConsensus`
211    #[must_use]
212    pub fn new(lock_guard: RwLockUpgradableReadGuard<'a, Consensus<TYPES>>) -> Self {
213        Self {
214            lock_guard: ManuallyDrop::new(lock_guard),
215            taken: false,
216        }
217    }
218
219    /// Upgrades the inner `RwLockUpgradableReadGuard` and leaves debug traces
220    #[instrument(skip_all, target = "ConsensusUpgradableReadLockGuard")]
221    pub async fn upgrade(mut guard: Self) -> ConsensusWriteLockGuard<'a, TYPES> {
222        let inner_guard = unsafe { ManuallyDrop::take(&mut guard.lock_guard) };
223        guard.taken = true;
224        tracing::debug!("Trying to upgrade upgradable read lock on consensus");
225        let ret = RwLockUpgradableReadGuard::upgrade(inner_guard).await;
226        tracing::debug!("Upgraded upgradable read lock on consensus");
227        ConsensusWriteLockGuard::new(ret)
228    }
229}
230
231impl<TYPES: NodeType> Deref for ConsensusUpgradableReadLockGuard<'_, TYPES> {
232    type Target = Consensus<TYPES>;
233
234    fn deref(&self) -> &Self::Target {
235        &self.lock_guard
236    }
237}
238
239impl<TYPES: NodeType> Drop for ConsensusUpgradableReadLockGuard<'_, TYPES> {
240    #[instrument(skip_all, target = "ConsensusUpgradableReadLockGuard")]
241    fn drop(&mut self) {
242        if !self.taken {
243            unsafe { ManuallyDrop::drop(&mut self.lock_guard) }
244            tracing::debug!("Upgradable read lock on consensus dropped");
245        }
246    }
247}
248
249/// A bundle of views that we have most recently performed some action
250#[derive(Debug, Clone, Copy)]
251struct HotShotActionViews<T: ConsensusTime> {
252    /// View we last proposed in to the Quorum
253    proposed: T,
254    /// View we last voted in for a QuorumProposal
255    voted: T,
256    /// View we last proposed to the DA committee
257    da_proposed: T,
258    /// View we lasted voted for DA proposal
259    da_vote: T,
260}
261
262impl<T: ConsensusTime> Default for HotShotActionViews<T> {
263    fn default() -> Self {
264        let genesis = T::genesis();
265        Self {
266            proposed: genesis,
267            voted: genesis,
268            da_proposed: genesis,
269            da_vote: genesis,
270        }
271    }
272}
273impl<T: ConsensusTime> HotShotActionViews<T> {
274    /// Create HotShotActionViews from a view number
275    fn from_view(view: T) -> Self {
276        Self {
277            proposed: view,
278            voted: view,
279            da_proposed: view,
280            da_vote: view,
281        }
282    }
283}
284/// A reference to the consensus algorithm
285///
286/// This will contain the state of all rounds.
287#[derive(derive_more::Debug, Clone)]
288pub struct Consensus<TYPES: NodeType> {
289    /// The validated states that are currently loaded in memory.
290    validated_state_map: BTreeMap<TYPES::View, View<TYPES>>,
291
292    /// All the VID shares we've received for current and future views.
293    vid_shares: VidShares<TYPES>,
294
295    /// All the DA certs we've received for current and future views.
296    /// view -> DA cert
297    saved_da_certs: HashMap<TYPES::View, DaCertificate2<TYPES>>,
298
299    /// View number that is currently on.
300    cur_view: TYPES::View,
301
302    /// Epoch number that is currently on.
303    cur_epoch: Option<TYPES::Epoch>,
304
305    /// Last proposals we sent out, None if we haven't proposed yet.
306    /// Prevents duplicate proposals, and can be served to those trying to catchup
307    last_proposals: BTreeMap<TYPES::View, Proposal<TYPES, QuorumProposalWrapper<TYPES>>>,
308
309    /// last view had a successful decide event
310    last_decided_view: TYPES::View,
311
312    /// The `locked_qc` view number
313    locked_view: TYPES::View,
314
315    /// Map of leaf hash -> leaf
316    /// - contains undecided leaves
317    /// - includes the MOST RECENT decided leaf
318    saved_leaves: CommitmentMap<Leaf2<TYPES>>,
319
320    /// Bundle of views which we performed the most recent action
321    /// visibible to the network.  Actions are votes and proposals
322    /// for DA and Quorum
323    last_actions: HotShotActionViews<TYPES::View>,
324
325    /// Saved payloads.
326    ///
327    /// Encoded transactions for every view if we got a payload for that view.
328    saved_payloads: BTreeMap<TYPES::View, Arc<PayloadWithMetadata<TYPES>>>,
329
330    /// the highqc per spec
331    high_qc: QuorumCertificate2<TYPES>,
332
333    /// The high QC for the next epoch
334    next_epoch_high_qc: Option<NextEpochQuorumCertificate2<TYPES>>,
335
336    /// A reference to the metrics trait
337    pub metrics: Arc<ConsensusMetricsValue>,
338
339    /// Number of blocks in an epoch, zero means there are no epochs
340    pub epoch_height: u64,
341
342    /// Number of iterations for the DRB calculation, taken from HotShotConfig
343    pub drb_difficulty: u64,
344
345    /// Number of iterations for the DRB calculation post-difficulty upgrade, taken from HotShotConfig
346    pub drb_upgrade_difficulty: u64,
347
348    /// Tables for the DRB seeds and results.
349    pub drb_results: DrbResults<TYPES>,
350
351    /// The transition QC for the current epoch
352    transition_qc: Option<(
353        QuorumCertificate2<TYPES>,
354        NextEpochQuorumCertificate2<TYPES>,
355    )>,
356
357    /// The highest block number that we have seen
358    pub highest_block: u64,
359    /// The light client state update certificate
360    pub state_cert: Option<LightClientStateUpdateCertificate<TYPES>>,
361}
362
363/// This struct holds a payload and its metadata
364#[derive(Debug, Clone, Hash, Eq, PartialEq)]
365pub struct PayloadWithMetadata<TYPES: NodeType> {
366    pub payload: TYPES::BlockPayload,
367    pub metadata: <TYPES::BlockPayload as BlockPayload<TYPES>>::Metadata,
368}
369
370/// Contains several `ConsensusMetrics` that we're interested in from the consensus interfaces
371#[derive(Clone, Debug)]
372pub struct ConsensusMetricsValue {
373    /// The number of last synced block height
374    pub last_synced_block_height: Box<dyn Gauge>,
375    /// The number of last decided view
376    pub last_decided_view: Box<dyn Gauge>,
377    /// The number of the last voted view
378    pub last_voted_view: Box<dyn Gauge>,
379    /// Number of timestamp for the last decided time
380    pub last_decided_time: Box<dyn Gauge>,
381    /// The current view
382    pub current_view: Box<dyn Gauge>,
383    /// Number of views that are in-flight since the last decided view
384    pub number_of_views_since_last_decide: Box<dyn Gauge>,
385    /// Number of views that are in-flight since the last anchor view
386    pub number_of_views_per_decide_event: Box<dyn Histogram>,
387    /// Duration of views as leader
388    pub view_duration_as_leader: Box<dyn Histogram>,
389    /// Number of invalid QCs we've seen since the last commit.
390    pub invalid_qc: Box<dyn Gauge>,
391    /// Number of outstanding transactions
392    pub outstanding_transactions: Box<dyn Gauge>,
393    /// Memory size in bytes of the serialized transactions still outstanding
394    pub outstanding_transactions_memory_size: Box<dyn Gauge>,
395    /// Number of views that timed out
396    pub number_of_timeouts: Box<dyn Counter>,
397    /// Number of views that timed out as leader
398    pub number_of_timeouts_as_leader: Box<dyn Counter>,
399    /// The number of empty blocks that have been proposed
400    pub number_of_empty_blocks_proposed: Box<dyn Counter>,
401    /// Number of events in the hotshot event queue
402    pub internal_event_queue_len: Box<dyn Gauge>,
403    /// Time from proposal creation to decide time
404    pub proposal_to_decide_time: Box<dyn Histogram>,
405    /// Time from proposal received to proposal creation
406    pub previous_proposal_to_proposal_time: Box<dyn Histogram>,
407    /// Finalized bytes per view
408    pub finalized_bytes: Box<dyn Histogram>,
409    /// The duration of the validate and apply header
410    pub validate_and_apply_header_duration: Box<dyn Histogram>,
411    /// The duration of update leaf
412    pub update_leaf_duration: Box<dyn Histogram>,
413    /// The time it took to calculate the disperse
414    pub vid_disperse_duration: Box<dyn Histogram>,
415}
416
417impl ConsensusMetricsValue {
418    /// Create a new instance of this [`ConsensusMetricsValue`] struct, setting all the counters and gauges
419    #[must_use]
420    pub fn new(metrics: &dyn Metrics) -> Self {
421        Self {
422            last_synced_block_height: metrics
423                .create_gauge(String::from("last_synced_block_height"), None),
424            last_decided_view: metrics.create_gauge(String::from("last_decided_view"), None),
425            last_voted_view: metrics.create_gauge(String::from("last_voted_view"), None),
426            last_decided_time: metrics.create_gauge(String::from("last_decided_time"), None),
427            current_view: metrics.create_gauge(String::from("current_view"), None),
428            number_of_views_since_last_decide: metrics
429                .create_gauge(String::from("number_of_views_since_last_decide"), None),
430            number_of_views_per_decide_event: metrics
431                .create_histogram(String::from("number_of_views_per_decide_event"), None),
432            view_duration_as_leader: metrics
433                .create_histogram(String::from("view_duration_as_leader"), None),
434            invalid_qc: metrics.create_gauge(String::from("invalid_qc"), None),
435            outstanding_transactions: metrics
436                .create_gauge(String::from("outstanding_transactions"), None),
437            outstanding_transactions_memory_size: metrics
438                .create_gauge(String::from("outstanding_transactions_memory_size"), None),
439            number_of_timeouts: metrics.create_counter(String::from("number_of_timeouts"), None),
440            number_of_timeouts_as_leader: metrics
441                .create_counter(String::from("number_of_timeouts_as_leader"), None),
442            number_of_empty_blocks_proposed: metrics
443                .create_counter(String::from("number_of_empty_blocks_proposed"), None),
444            internal_event_queue_len: metrics
445                .create_gauge(String::from("internal_event_queue_len"), None),
446            proposal_to_decide_time: metrics
447                .create_histogram(String::from("proposal_to_decide_time"), None),
448            previous_proposal_to_proposal_time: metrics
449                .create_histogram(String::from("previous_proposal_to_proposal_time"), None),
450            finalized_bytes: metrics.create_histogram(String::from("finalized_bytes"), None),
451            validate_and_apply_header_duration: metrics.create_histogram(
452                String::from("validate_and_apply_header_duration"),
453                Some("seconds".to_string()),
454            ),
455            update_leaf_duration: metrics.create_histogram(
456                String::from("update_leaf_duration"),
457                Some("seconds".to_string()),
458            ),
459            vid_disperse_duration: metrics.create_histogram(
460                String::from("vid_disperse_duration"),
461                Some("seconds".to_string()),
462            ),
463        }
464    }
465}
466
467impl Default for ConsensusMetricsValue {
468    fn default() -> Self {
469        Self::new(&*NoMetrics::boxed())
470    }
471}
472
473impl<TYPES: NodeType> Consensus<TYPES> {
474    /// Constructor.
475    #[allow(clippy::too_many_arguments)]
476    pub fn new(
477        validated_state_map: BTreeMap<TYPES::View, View<TYPES>>,
478        vid_shares: Option<VidShares<TYPES>>,
479        cur_view: TYPES::View,
480        cur_epoch: Option<TYPES::Epoch>,
481        locked_view: TYPES::View,
482        last_decided_view: TYPES::View,
483        last_actioned_view: TYPES::View,
484        last_proposals: BTreeMap<TYPES::View, Proposal<TYPES, QuorumProposalWrapper<TYPES>>>,
485        saved_leaves: CommitmentMap<Leaf2<TYPES>>,
486        saved_payloads: BTreeMap<TYPES::View, Arc<PayloadWithMetadata<TYPES>>>,
487        high_qc: QuorumCertificate2<TYPES>,
488        next_epoch_high_qc: Option<NextEpochQuorumCertificate2<TYPES>>,
489        metrics: Arc<ConsensusMetricsValue>,
490        epoch_height: u64,
491        state_cert: Option<LightClientStateUpdateCertificate<TYPES>>,
492        drb_difficulty: u64,
493        drb_upgrade_difficulty: u64,
494    ) -> Self {
495        let transition_qc = if let Some(ref next_epoch_high_qc) = next_epoch_high_qc {
496            if high_qc
497                .data
498                .block_number
499                .is_some_and(|bn| is_transition_block(bn, epoch_height))
500            {
501                if high_qc.data.leaf_commit == next_epoch_high_qc.data.leaf_commit {
502                    Some((high_qc.clone(), next_epoch_high_qc.clone()))
503                } else {
504                    tracing::error!("Next epoch high QC has different leaf commit to high QC");
505                    None
506                }
507            } else {
508                None
509            }
510        } else {
511            None
512        };
513        Consensus {
514            validated_state_map,
515            vid_shares: vid_shares.unwrap_or_default(),
516            saved_da_certs: HashMap::new(),
517            cur_view,
518            cur_epoch,
519            last_decided_view,
520            last_proposals,
521            last_actions: HotShotActionViews::from_view(last_actioned_view),
522            locked_view,
523            saved_leaves,
524            saved_payloads,
525            high_qc,
526            next_epoch_high_qc,
527            metrics,
528            epoch_height,
529            drb_results: DrbResults::new(),
530            transition_qc,
531            highest_block: 0,
532            state_cert,
533            drb_difficulty,
534            drb_upgrade_difficulty,
535        }
536    }
537
538    /// Get the current view.
539    pub fn cur_view(&self) -> TYPES::View {
540        self.cur_view
541    }
542
543    /// Get the current epoch.
544    pub fn cur_epoch(&self) -> Option<TYPES::Epoch> {
545        self.cur_epoch
546    }
547
548    /// Get the last decided view.
549    pub fn last_decided_view(&self) -> TYPES::View {
550        self.last_decided_view
551    }
552
553    /// Get the locked view.
554    pub fn locked_view(&self) -> TYPES::View {
555        self.locked_view
556    }
557
558    /// Get the high QC.
559    pub fn high_qc(&self) -> &QuorumCertificate2<TYPES> {
560        &self.high_qc
561    }
562
563    /// Get the transition QC.
564    pub fn transition_qc(
565        &self,
566    ) -> Option<&(
567        QuorumCertificate2<TYPES>,
568        NextEpochQuorumCertificate2<TYPES>,
569    )> {
570        self.transition_qc.as_ref()
571    }
572
573    ///Update the highest block number
574    pub fn update_highest_block(&mut self, block_number: u64) {
575        if block_number > self.highest_block {
576            self.highest_block = block_number;
577            return;
578        }
579
580        if is_epoch_transition(block_number, self.epoch_height) {
581            let new_epoch = epoch_from_block_number(block_number, self.epoch_height);
582            let high_epoch = epoch_from_block_number(self.highest_block, self.epoch_height);
583            if new_epoch >= high_epoch {
584                self.highest_block = block_number;
585            }
586        }
587    }
588
589    /// Update the transition QC.
590    pub fn update_transition_qc(
591        &mut self,
592        qc: QuorumCertificate2<TYPES>,
593        next_epoch_qc: NextEpochQuorumCertificate2<TYPES>,
594    ) {
595        if next_epoch_qc.data.leaf_commit != qc.data().leaf_commit {
596            tracing::error!(
597                "Next epoch QC for view {} has different leaf commit {:?} to {:?}",
598                qc.view_number(),
599                next_epoch_qc.data.leaf_commit,
600                qc.data().leaf_commit
601            );
602            return;
603        }
604        if let Some((transition_qc, _)) = &self.transition_qc {
605            if transition_qc.view_number() >= qc.view_number() {
606                return;
607            }
608        }
609        self.transition_qc = Some((qc, next_epoch_qc));
610    }
611
612    /// Get the current light client state certificate
613    pub fn state_cert(&self) -> Option<&LightClientStateUpdateCertificate<TYPES>> {
614        self.state_cert.as_ref()
615    }
616
617    /// Get the next epoch high QC.
618    pub fn next_epoch_high_qc(&self) -> Option<&NextEpochQuorumCertificate2<TYPES>> {
619        self.next_epoch_high_qc.as_ref()
620    }
621
622    /// Get the validated state map.
623    pub fn validated_state_map(&self) -> &BTreeMap<TYPES::View, View<TYPES>> {
624        &self.validated_state_map
625    }
626
627    /// Get the saved leaves.
628    pub fn saved_leaves(&self) -> &CommitmentMap<Leaf2<TYPES>> {
629        &self.saved_leaves
630    }
631
632    /// Get the saved payloads.
633    pub fn saved_payloads(&self) -> &BTreeMap<TYPES::View, Arc<PayloadWithMetadata<TYPES>>> {
634        &self.saved_payloads
635    }
636
637    /// Get the vid shares.
638    pub fn vid_shares(&self) -> &VidShares<TYPES> {
639        &self.vid_shares
640    }
641
642    /// Get the saved DA certs.
643    pub fn saved_da_certs(&self) -> &HashMap<TYPES::View, DaCertificate2<TYPES>> {
644        &self.saved_da_certs
645    }
646
647    /// Get the map of our recent proposals
648    pub fn last_proposals(
649        &self,
650    ) -> &BTreeMap<TYPES::View, Proposal<TYPES, QuorumProposalWrapper<TYPES>>> {
651        &self.last_proposals
652    }
653
654    /// Update the current view.
655    /// # Errors
656    /// Can return an error when the new view_number is not higher than the existing view number.
657    pub fn update_view(&mut self, view_number: TYPES::View) -> Result<()> {
658        ensure!(
659            view_number > self.cur_view,
660            debug!("New view isn't newer than the current view.")
661        );
662        self.cur_view = view_number;
663        Ok(())
664    }
665
666    /// Get the parent Leaf Info from a given leaf and our public key.
667    /// Returns None if we don't have the data in out state
668    pub async fn parent_leaf_info(
669        &self,
670        leaf: &Leaf2<TYPES>,
671        public_key: &TYPES::SignatureKey,
672    ) -> Option<LeafInfo<TYPES>> {
673        let parent_view_number = leaf.justify_qc().view_number();
674        let parent_epoch = leaf.justify_qc().epoch();
675        let parent_leaf = self
676            .saved_leaves
677            .get(&leaf.justify_qc().data().leaf_commit)?;
678        let parent_state_and_delta = self.state_and_delta(parent_view_number);
679        let (Some(state), delta) = parent_state_and_delta else {
680            return None;
681        };
682
683        let parent_vid = self
684            .vid_shares()
685            .get(&parent_view_number)
686            .and_then(|key_map| key_map.get(public_key))
687            .and_then(|epoch_map| epoch_map.get(&parent_epoch))
688            .map(|prop| prop.data.clone());
689
690        let state_cert = if parent_leaf.with_epoch
691            && is_epoch_root(parent_leaf.block_header().block_number(), self.epoch_height)
692        {
693            match self.state_cert() {
694                // Sanity check that the state cert is for the same view as the parent leaf
695                Some(state_cert)
696                    if state_cert.light_client_state.view_number == parent_view_number.u64() =>
697                {
698                    Some(state_cert.clone())
699                },
700                _ => None,
701            }
702        } else {
703            None
704        };
705
706        Some(LeafInfo {
707            leaf: parent_leaf.clone(),
708            state,
709            delta,
710            vid_share: parent_vid,
711            state_cert,
712        })
713    }
714
715    /// Update the current epoch.
716    /// # Errors
717    /// Can return an error when the new epoch_number is not higher than the existing epoch number.
718    pub fn update_epoch(&mut self, epoch_number: TYPES::Epoch) -> Result<()> {
719        ensure!(
720            self.cur_epoch.is_none() || Some(epoch_number) > self.cur_epoch,
721            debug!("New epoch isn't newer than the current epoch.")
722        );
723        tracing::trace!(
724            "Updating epoch from {:?} to {}",
725            self.cur_epoch,
726            epoch_number
727        );
728        self.cur_epoch = Some(epoch_number);
729        Ok(())
730    }
731
732    /// Update the last actioned view internally for votes and proposals
733    ///
734    /// Returns true if the action is for a newer view than the last action of that type
735    pub fn update_action(&mut self, action: HotShotAction, view: TYPES::View) -> bool {
736        let old_view = match action {
737            HotShotAction::Vote => &mut self.last_actions.voted,
738            HotShotAction::Propose => &mut self.last_actions.proposed,
739            HotShotAction::DaPropose => &mut self.last_actions.da_proposed,
740            HotShotAction::DaVote => {
741                if view > self.last_actions.da_vote {
742                    self.last_actions.da_vote = view;
743                }
744                // TODO Add logic to prevent double voting.  For now the simple check if
745                // the last voted view is less than the view we are trying to vote doesn't work
746                // because the leader of view n + 1 may propose to the DA (and we would vote)
747                // before the leader of view n.
748                return true;
749            },
750            _ => return true,
751        };
752        if view > *old_view {
753            *old_view = view;
754            return true;
755        }
756        false
757    }
758
759    /// reset last actions to genesis so we can resend events in tests
760    pub fn reset_actions(&mut self) {
761        self.last_actions = HotShotActionViews::default();
762    }
763
764    /// Update the last proposal.
765    ///
766    /// # Errors
767    /// Can return an error when the new view_number is not higher than the existing proposed view number.
768    pub fn update_proposed_view(
769        &mut self,
770        proposal: Proposal<TYPES, QuorumProposalWrapper<TYPES>>,
771    ) -> Result<()> {
772        ensure!(
773            proposal.data.view_number()
774                > self
775                    .last_proposals
776                    .last_key_value()
777                    .map_or(TYPES::View::genesis(), |(k, _)| { *k }),
778            debug!("New view isn't newer than the previously proposed view.")
779        );
780        self.last_proposals
781            .insert(proposal.data.view_number(), proposal);
782        Ok(())
783    }
784
785    /// Update the last decided view.
786    ///
787    /// # Errors
788    /// Can return an error when the new view_number is not higher than the existing decided view number.
789    pub fn update_last_decided_view(&mut self, view_number: TYPES::View) -> Result<()> {
790        ensure!(
791            view_number > self.last_decided_view,
792            debug!("New view isn't newer than the previously decided view.")
793        );
794        self.last_decided_view = view_number;
795        Ok(())
796    }
797
798    /// Update the locked view.
799    ///
800    /// # Errors
801    /// Can return an error when the new view_number is not higher than the existing locked view number.
802    pub fn update_locked_view(&mut self, view_number: TYPES::View) -> Result<()> {
803        ensure!(
804            view_number > self.locked_view,
805            debug!("New view isn't newer than the previously locked view.")
806        );
807        self.locked_view = view_number;
808        Ok(())
809    }
810
811    /// Update the validated state map with a new view_number/view combo.
812    ///
813    /// # Errors
814    /// Can return an error when the new view contains less information than the existing view
815    /// with the same view number.
816    pub fn update_da_view(
817        &mut self,
818        view_number: TYPES::View,
819        epoch: Option<TYPES::Epoch>,
820        payload_commitment: VidCommitment,
821    ) -> Result<()> {
822        let view = View {
823            view_inner: ViewInner::Da {
824                payload_commitment,
825                epoch,
826            },
827        };
828        self.update_validated_state_map(view_number, view)
829    }
830
831    /// Update the validated state map with a new view_number/view combo.
832    ///
833    /// # Errors
834    /// Can return an error when the new view contains less information than the existing view
835    /// with the same view number.
836    pub fn update_leaf(
837        &mut self,
838        leaf: Leaf2<TYPES>,
839        state: Arc<TYPES::ValidatedState>,
840        delta: Option<Arc<<TYPES::ValidatedState as ValidatedState<TYPES>>::Delta>>,
841    ) -> Result<()> {
842        let view_number = leaf.view_number();
843        let epoch = option_epoch_from_block_number::<TYPES>(
844            leaf.with_epoch,
845            leaf.height(),
846            self.epoch_height,
847        );
848        let view = View {
849            view_inner: ViewInner::Leaf {
850                leaf: leaf.commit(),
851                state,
852                delta,
853                epoch,
854            },
855        };
856        self.update_validated_state_map(view_number, view)?;
857        self.update_saved_leaves(leaf);
858        Ok(())
859    }
860
861    /// Update the validated state map with a new view_number/view combo.
862    ///
863    /// # Errors
864    /// Can return an error when the new view contains less information than the existing view
865    /// with the same view number.
866    fn update_validated_state_map(
867        &mut self,
868        view_number: TYPES::View,
869        new_view: View<TYPES>,
870    ) -> Result<()> {
871        if let Some(existing_view) = self.validated_state_map().get(&view_number) {
872            if let ViewInner::Leaf {
873                delta: ref existing_delta,
874                ..
875            } = existing_view.view_inner
876            {
877                if let ViewInner::Leaf {
878                    delta: ref new_delta,
879                    ..
880                } = new_view.view_inner
881                {
882                    ensure!(
883                        new_delta.is_some() || existing_delta.is_none(),
884                        debug!(
885                            "Skipping the state update to not override a `Leaf` view with `Some` \
886                             state delta."
887                        )
888                    );
889                } else {
890                    bail!(
891                        "Skipping the state update to not override a `Leaf` view with a \
892                         non-`Leaf` view."
893                    );
894                }
895            }
896        }
897        self.validated_state_map.insert(view_number, new_view);
898        Ok(())
899    }
900
901    /// Update the saved leaves with a new leaf.
902    fn update_saved_leaves(&mut self, leaf: Leaf2<TYPES>) {
903        self.saved_leaves.insert(leaf.commit(), leaf);
904    }
905
906    /// Update the saved payloads with a new encoded transaction.
907    ///
908    /// # Errors
909    /// Can return an error when there's an existing payload corresponding to the same view number.
910    pub fn update_saved_payloads(
911        &mut self,
912        view_number: TYPES::View,
913        payload: Arc<PayloadWithMetadata<TYPES>>,
914    ) -> Result<()> {
915        ensure!(
916            !self.saved_payloads.contains_key(&view_number),
917            "Payload with the same view already exists."
918        );
919        self.saved_payloads.insert(view_number, payload);
920        Ok(())
921    }
922
923    /// Update the high QC if given a newer one.
924    /// # Errors
925    /// Can return an error when the provided high_qc is not newer than the existing entry.
926    pub fn update_high_qc(&mut self, high_qc: QuorumCertificate2<TYPES>) -> Result<()> {
927        if self.high_qc == high_qc {
928            return Ok(());
929        }
930        // make sure the we don't update the high QC unless is't a higher view
931        ensure!(
932            high_qc.view_number > self.high_qc.view_number,
933            debug!("High QC with an equal or higher view exists.")
934        );
935        tracing::debug!("Updating high QC");
936        self.high_qc = high_qc;
937
938        Ok(())
939    }
940
941    /// Update the next epoch high QC if given a newer one.
942    /// # Errors
943    /// Can return an error when the provided high_qc is not newer than the existing entry.
944    /// # Panics
945    /// It can't actually panic. If the option is None, we will not call unwrap on it.
946    pub fn update_next_epoch_high_qc(
947        &mut self,
948        high_qc: NextEpochQuorumCertificate2<TYPES>,
949    ) -> Result<()> {
950        if self.next_epoch_high_qc.as_ref() == Some(&high_qc) {
951            return Ok(());
952        }
953        if let Some(next_epoch_high_qc) = self.next_epoch_high_qc() {
954            ensure!(
955                high_qc.view_number > next_epoch_high_qc.view_number,
956                debug!("Next epoch high QC with an equal or higher view exists.")
957            );
958        }
959        tracing::debug!("Updating next epoch high QC");
960        self.next_epoch_high_qc = Some(high_qc);
961
962        Ok(())
963    }
964
965    /// Resets high qc and next epoch qc to the provided transition qc.
966    /// # Errors
967    /// Can return an error when the provided high_qc is not newer than the existing entry.
968    pub fn reset_high_qc(
969        &mut self,
970        high_qc: QuorumCertificate2<TYPES>,
971        next_epoch_qc: NextEpochQuorumCertificate2<TYPES>,
972    ) -> Result<()> {
973        ensure!(
974            high_qc.data.leaf_commit == next_epoch_qc.data.leaf_commit,
975            error!("High QC's and next epoch QC's leaf commits do not match.")
976        );
977        if self.high_qc == high_qc {
978            return Ok(());
979        }
980        let same_epoch = high_qc.data.block_number.is_some_and(|bn| {
981            let current_qc = self.high_qc();
982            let Some(high_bn) = current_qc.data.block_number else {
983                return false;
984            };
985            epoch_from_block_number(bn + 1, self.epoch_height)
986                == epoch_from_block_number(high_bn + 1, self.epoch_height)
987        });
988        ensure!(
989            high_qc
990                .data
991                .block_number
992                .is_some_and(|bn| is_transition_block(bn, self.epoch_height))
993                && same_epoch,
994            error!("Provided QC is not a transition QC.")
995        );
996        tracing::debug!("Resetting high QC and next epoch high QC");
997        self.high_qc = high_qc;
998        self.next_epoch_high_qc = Some(next_epoch_qc);
999
1000        Ok(())
1001    }
1002
1003    /// Update the light client state update certificate if given a newer one.
1004    /// # Errors
1005    /// Can return an error when the provided state_cert is not newer than the existing entry.
1006    pub fn update_state_cert(
1007        &mut self,
1008        state_cert: LightClientStateUpdateCertificate<TYPES>,
1009    ) -> Result<()> {
1010        if let Some(existing_state_cert) = &self.state_cert {
1011            ensure!(
1012                state_cert.epoch > existing_state_cert.epoch,
1013                debug!(
1014                    "Light client state update certification with an equal or higher epoch exists."
1015                )
1016            );
1017        }
1018        tracing::debug!("Updating light client state update certification");
1019        self.state_cert = Some(state_cert);
1020
1021        Ok(())
1022    }
1023
1024    /// Add a new entry to the vid_shares map.
1025    pub fn update_vid_shares(
1026        &mut self,
1027        view_number: TYPES::View,
1028        disperse: Proposal<TYPES, VidDisperseShare<TYPES>>,
1029    ) {
1030        self.vid_shares
1031            .entry(view_number)
1032            .or_default()
1033            .entry(disperse.data.recipient_key().clone())
1034            .or_default()
1035            .insert(disperse.data.target_epoch(), disperse);
1036    }
1037
1038    /// Add a new entry to the da_certs map.
1039    pub fn update_saved_da_certs(&mut self, view_number: TYPES::View, cert: DaCertificate2<TYPES>) {
1040        self.saved_da_certs.insert(view_number, cert);
1041    }
1042
1043    /// gather information from the parent chain of leaves
1044    /// # Errors
1045    /// If the leaf or its ancestors are not found in storage
1046    pub fn visit_leaf_ancestors<F>(
1047        &self,
1048        start_from: TYPES::View,
1049        terminator: Terminator<TYPES::View>,
1050        ok_when_finished: bool,
1051        mut f: F,
1052    ) -> std::result::Result<(), HotShotError<TYPES>>
1053    where
1054        F: FnMut(
1055            &Leaf2<TYPES>,
1056            Arc<<TYPES as NodeType>::ValidatedState>,
1057            Option<Arc<<<TYPES as NodeType>::ValidatedState as ValidatedState<TYPES>>::Delta>>,
1058        ) -> bool,
1059    {
1060        let mut next_leaf = if let Some(view) = self.validated_state_map.get(&start_from) {
1061            view.leaf_commitment().ok_or_else(|| {
1062                HotShotError::InvalidState(format!(
1063                    "Visited failed view {start_from} leaf. Expected successful leaf"
1064                ))
1065            })?
1066        } else {
1067            return Err(HotShotError::InvalidState(format!(
1068                "View {start_from} leaf does not exist in state map "
1069            )));
1070        };
1071
1072        while let Some(leaf) = self.saved_leaves.get(&next_leaf) {
1073            let view = leaf.view_number();
1074            if let (Some(state), delta) = self.state_and_delta(view) {
1075                if let Terminator::Exclusive(stop_before) = terminator {
1076                    if stop_before == view {
1077                        if ok_when_finished {
1078                            return Ok(());
1079                        }
1080                        break;
1081                    }
1082                }
1083                next_leaf = leaf.parent_commitment();
1084                if !f(leaf, state, delta) {
1085                    return Ok(());
1086                }
1087                if let Terminator::Inclusive(stop_after) = terminator {
1088                    if stop_after == view {
1089                        if ok_when_finished {
1090                            return Ok(());
1091                        }
1092                        break;
1093                    }
1094                }
1095            } else {
1096                return Err(HotShotError::InvalidState(format!(
1097                    "View {view} state does not exist in state map"
1098                )));
1099            }
1100        }
1101        Err(HotShotError::MissingLeaf(next_leaf))
1102    }
1103
1104    /// Garbage collects based on state change right now, this removes from both the
1105    /// `saved_payloads` and `validated_state_map` fields of `Consensus`.
1106    /// # Panics
1107    /// On inconsistent stored entries
1108    pub fn collect_garbage(&mut self, old_anchor_view: TYPES::View, new_anchor_view: TYPES::View) {
1109        // Nothing to collect
1110        if new_anchor_view <= old_anchor_view {
1111            return;
1112        }
1113        let gc_view = TYPES::View::new(new_anchor_view.saturating_sub(1));
1114        // state check
1115        let anchor_entry = self
1116            .validated_state_map
1117            .iter()
1118            .next()
1119            .expect("INCONSISTENT STATE: anchor leaf not in state map!");
1120        if **anchor_entry.0 != old_anchor_view.saturating_sub(1) {
1121            tracing::info!(
1122                "Something about GC has failed. Older leaf exists than the previous anchor leaf."
1123            );
1124        }
1125        // perform gc
1126        self.saved_da_certs
1127            .retain(|view_number, _| *view_number >= old_anchor_view);
1128        self.validated_state_map
1129            .range(..gc_view)
1130            .filter_map(|(_view_number, view)| view.leaf_commitment())
1131            .for_each(|leaf| {
1132                self.saved_leaves.remove(&leaf);
1133            });
1134        self.validated_state_map = self.validated_state_map.split_off(&gc_view);
1135        self.saved_payloads = self.saved_payloads.split_off(&gc_view);
1136        self.vid_shares = self.vid_shares.split_off(&gc_view);
1137        self.last_proposals = self.last_proposals.split_off(&gc_view);
1138    }
1139
1140    /// Gets the last decided leaf.
1141    ///
1142    /// # Panics
1143    /// if the last decided view's leaf does not exist in the state map or saved leaves, which
1144    /// should never happen.
1145    #[must_use]
1146    pub fn decided_leaf(&self) -> Leaf2<TYPES> {
1147        let decided_view_num = self.last_decided_view;
1148        let view = self.validated_state_map.get(&decided_view_num).unwrap();
1149        let leaf = view
1150            .leaf_commitment()
1151            .expect("Decided leaf not found! Consensus internally inconsistent");
1152        self.saved_leaves.get(&leaf).unwrap().clone()
1153    }
1154
1155    pub fn undecided_leaves(&self) -> Vec<Leaf2<TYPES>> {
1156        self.saved_leaves.values().cloned().collect::<Vec<_>>()
1157    }
1158
1159    /// Gets the validated state with the given view number, if in the state map.
1160    #[must_use]
1161    pub fn state(&self, view_number: TYPES::View) -> Option<&Arc<TYPES::ValidatedState>> {
1162        match self.validated_state_map.get(&view_number) {
1163            Some(view) => view.state(),
1164            None => None,
1165        }
1166    }
1167
1168    /// Gets the validated state and state delta with the given view number, if in the state map.
1169    #[must_use]
1170    pub fn state_and_delta(&self, view_number: TYPES::View) -> StateAndDelta<TYPES> {
1171        match self.validated_state_map.get(&view_number) {
1172            Some(view) => view.state_and_delta(),
1173            None => (None, None),
1174        }
1175    }
1176
1177    /// Gets the last decided validated state.
1178    ///
1179    /// # Panics
1180    /// If the last decided view's state does not exist in the state map, which should never
1181    /// happen.
1182    #[must_use]
1183    pub fn decided_state(&self) -> Arc<TYPES::ValidatedState> {
1184        let decided_view_num = self.last_decided_view;
1185        self.state_and_delta(decided_view_num)
1186            .0
1187            .expect("Decided state not found! Consensus internally inconsistent")
1188    }
1189
1190    /// Associated helper function:
1191    /// Takes `LockedConsensusState` which will be updated; locks it for read and write accordingly.
1192    /// Calculates `VidDisperse` based on the view, the txns and the membership,
1193    /// and updates `vid_shares` map with the signed `VidDisperseShare` proposals.
1194    /// Returned `Option` indicates whether the update has actually happened or not.
1195    #[instrument(skip_all, target = "Consensus", fields(view = *view))]
1196    pub async fn calculate_and_update_vid<V: Versions>(
1197        consensus: OuterConsensus<TYPES>,
1198        view: <TYPES as NodeType>::View,
1199        target_epoch: Option<<TYPES as NodeType>::Epoch>,
1200        membership_coordinator: EpochMembershipCoordinator<TYPES>,
1201        private_key: &<TYPES::SignatureKey as SignatureKey>::PrivateKey,
1202        upgrade_lock: &UpgradeLock<TYPES, V>,
1203    ) -> Option<()> {
1204        let payload_with_metadata = Arc::clone(consensus.read().await.saved_payloads().get(&view)?);
1205        let epoch = consensus
1206            .read()
1207            .await
1208            .validated_state_map()
1209            .get(&view)?
1210            .view_inner
1211            .epoch()?;
1212
1213        let VidDisperseAndDuration {
1214            disperse: vid,
1215            duration: disperse_duration,
1216        } = VidDisperse::calculate_vid_disperse::<V>(
1217            &payload_with_metadata.payload,
1218            &membership_coordinator,
1219            view,
1220            target_epoch,
1221            epoch,
1222            &payload_with_metadata.metadata,
1223            upgrade_lock,
1224        )
1225        .await
1226        .ok()?;
1227
1228        let shares = VidDisperseShare::from_vid_disperse(vid);
1229        let mut consensus_writer = consensus.write().await;
1230        consensus_writer
1231            .metrics
1232            .vid_disperse_duration
1233            .add_point(disperse_duration.as_secs_f64());
1234        for share in shares {
1235            if let Some(prop) = share.to_proposal(private_key) {
1236                consensus_writer.update_vid_shares(view, prop);
1237            }
1238        }
1239
1240        Some(())
1241    }
1242    /// Returns true if a given leaf is for the epoch transition
1243    pub fn is_epoch_transition(&self, leaf_commit: LeafCommitment<TYPES>) -> bool {
1244        let Some(leaf) = self.saved_leaves.get(&leaf_commit) else {
1245            tracing::trace!("We don't have a leaf corresponding to the leaf commit");
1246            return false;
1247        };
1248        let block_height = leaf.height();
1249        is_epoch_transition(block_height, self.epoch_height)
1250    }
1251
1252    /// Returns true if our high QC is for one of the epoch transition blocks
1253    pub fn is_high_qc_for_epoch_transition(&self) -> bool {
1254        let Some(block_height) = self.high_qc().data.block_number else {
1255            return false;
1256        };
1257        is_epoch_transition(block_height, self.epoch_height)
1258    }
1259
1260    /// Returns true if the `parent_leaf` formed an eQC for the previous epoch to the `proposed_leaf`
1261    pub fn check_eqc(&self, proposed_leaf: &Leaf2<TYPES>, parent_leaf: &Leaf2<TYPES>) -> bool {
1262        if parent_leaf.view_number() == TYPES::View::genesis() {
1263            return true;
1264        }
1265        let new_epoch = epoch_from_block_number(proposed_leaf.height(), self.epoch_height);
1266        let old_epoch = epoch_from_block_number(parent_leaf.height(), self.epoch_height);
1267
1268        new_epoch - 1 == old_epoch && is_last_block(parent_leaf.height(), self.epoch_height)
1269    }
1270
1271    /// Returns true if our high QC is for the block equal or greater than the root epoch block
1272    pub fn is_high_qc_ge_root_block(&self) -> bool {
1273        let Some(leaf) = self.saved_leaves.get(&self.high_qc().data.leaf_commit) else {
1274            tracing::trace!("We don't have a leaf corresponding to the high QC");
1275            return false;
1276        };
1277        let block_height = leaf.height();
1278        is_ge_epoch_root(block_height, self.epoch_height)
1279    }
1280}
1281
1282/// Alias for the block payload commitment and the associated metadata. The primary data
1283/// needed in order to submit a proposal.
1284#[derive(Eq, PartialEq, Debug, Clone)]
1285pub struct CommitmentAndMetadata<TYPES: NodeType> {
1286    /// Vid Commitment
1287    pub commitment: VidCommitment,
1288    /// Builder Commitment
1289    pub builder_commitment: BuilderCommitment,
1290    /// Metadata for the block payload
1291    pub metadata: <TYPES::BlockPayload as BlockPayload<TYPES>>::Metadata,
1292    /// Builder fee data
1293    pub fees: Vec1<BuilderFee<TYPES>>,
1294    /// View number this block is for
1295    pub block_view: TYPES::View,
1296}
hotshot_types/consensus.rs

hotshot_types/
consensus.rs
