Skip to main content

EpochManager

Struct EpochManager 

Source
pub struct EpochManager { /* private fields */ }
Expand description

Primary state machine managing the current epoch’s lifecycle and archiving completed epochs.

Uses parking_lot::RwLock for interior mutability (start.md Hard Requirement 12). Read operations allow concurrent access; write operations block all other access.

Implementations§

Source§

impl EpochManager

Source

pub fn new( network_id: Bytes32, genesis_l1_height: u32, initial_state_root: Bytes32, ) -> Self

Creates an EpochManager at epoch 0 with empty history and a fresh Pending competition.

network_id and genesis_l1_height are immutable for the lifetime of this manager. The initial EpochInfo starts at GENESIS_HEIGHT in BlockProduction phase.

Source

pub fn current_epoch(&self) -> u64

Returns the current epoch number.

Source

pub fn current_epoch_info(&self) -> EpochInfo

Returns a clone of the current epoch’s full state.

Source

pub fn current_phase(&self) -> EpochPhase

Returns the current phase of the current epoch.

Source

pub fn genesis_l1_height(&self) -> u32

Returns the network’s genesis L1 height.

Source

pub fn network_id(&self) -> Bytes32

Returns the network ID.

Source

pub fn epoch_for_l1_height(&self, l1_height: u32) -> u64

Maps an L1 height to its epoch number using genesis_l1_height.

Heights before genesis map to epoch 0.

Source

pub fn l1_range_for_epoch(&self, epoch: u64) -> (u32, u32)

Returns (start_l1, end_l1) for the given epoch.

Source

pub fn update_phase(&self, l1_height: u32) -> Option<PhaseTransition>

Recalculates the phase from l1_height. Returns Some(PhaseTransition) if the phase changed, None if unchanged.

Source

pub fn should_advance(&self, _l1_height: u32) -> bool

Returns true when the current phase is Complete.

Source

pub fn record_block(&self, fees: u64, tx_count: u64) -> Result<(), EpochError>

Records a block in the current epoch.

Returns Err(PhaseMismatch) if not in BlockProduction.

Source

pub fn set_current_epoch_chain_totals(&self, blocks: u32, fees: u64, txns: u64)

Overwrites the current epoch’s block production statistics.

Used for resync / correction. No phase restriction; values are replaced, not incremented.

Source

pub fn set_current_epoch_dfsp_close_snapshot( &self, snap: DfspCloseSnapshot, ) -> Result<(), EpochError>

Applies DFSP close values to the current epoch before advance.

Returns Err(PhaseMismatch) if not in Finalization.

Source

pub fn advance_epoch( &self, _l1_height: u32, state_root: Bytes32, ) -> Result<u64, EpochError>

Archives the current epoch and transitions to epoch + 1.

Preconditions:

  • Current phase is Complete.
  • Current competition is Finalized.

Both preconditions are checked before any state mutation.

Source

pub fn get_epoch_info(&self) -> EpochInfo

Returns a clone of the current EpochInfo.

Source

pub fn get_epoch_summary(&self, epoch: u64) -> Option<EpochSummary>

Returns the EpochSummary for a specific completed epoch, or None.

Source

pub fn recent_summaries(&self, n: usize) -> Vec<EpochSummary>

Returns the last n summaries from the tail, preserving epoch order.

Source

pub fn total_stats(&self) -> EpochStats

Aggregate statistics across all completed epochs plus the current one.

Source

pub fn get_rewards(&self, epoch: u64) -> Option<RewardDistribution>

Returns the RewardDistribution for epoch, or None.

Source

pub fn store_rewards(&self, distribution: RewardDistribution)

Archives a RewardDistribution keyed by its epoch field.

Source

pub fn competition(&self) -> CheckpointCompetition

Returns a clone of the current competition. Read-only.

Source

pub fn start_checkpoint_competition(&self) -> Result<(), EpochError>

Transitions the current competition from Pending to Collecting.

Phase-gated to Checkpoint. Delegates to CheckpointCompetition::start for the state transition.

Source

pub fn submit_checkpoint( &self, submission: CheckpointSubmission, ) -> Result<bool, EpochError>

Records a checkpoint submission against the current epoch’s competition.

Phase-gated to Checkpoint. Returns Ok(true) when the submission becomes the new leader, Ok(false) is never returned (non-leading submissions return Err(ScoreNotHigher)). Delegates scoring to CheckpointCompetition::submit.

Source

pub fn finalize_competition( &self, epoch: u64, l1_height: u32, ) -> Result<Option<Checkpoint>, EpochError>

Finalizes the competition for epoch at l1_height, transitioning status to Finalized and setting the winning checkpoint on the current EpochInfo.

Phase-gated to Finalization when epoch matches the current epoch. Returns the winning checkpoint on success, or Ok(None) if no winner was selected.

Source

pub fn get_competition(&self, epoch: u64) -> Option<CheckpointCompetition>

Returns a clone of the competition for epoch.

Only the current epoch’s competition is tracked; returns None for past or future epochs.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more