arc-malachitebft-core-state-machine 0.7.0-pre

Core state-machine for the Malachite BFT consensus engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! A transition taken by the state machine after processing an input.

use malachitebft_core_types::Context;

use crate::output::Output;
use crate::state::State;

/// A transition taken by the state machine after processing an input.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Transition<Ctx>
where
    Ctx: Context,
{
    /// The next state to transition to.
    pub next_state: State<Ctx>,
    /// The output to emit.
    pub output: Option<Output<Ctx>>,
    /// Whether the transition is valid or not.
    pub valid: bool,
}

impl<Ctx> Transition<Ctx>
where
    Ctx: Context,
{
    /// Build a new valid transition to the given next state.
    pub fn to(next_state: State<Ctx>) -> Self {
        Self {
            next_state,
            output: None,
            valid: true,
        }
    }

    /// Build a new invalid transition to the given next state.
    pub fn invalid(next_state: State<Ctx>) -> Self {
        Self {
            next_state,
            output: None,
            valid: false,
        }
    }

    /// Set the output of the transition.
    pub fn with_output(mut self, output: Output<Ctx>) -> Self {
        self.output = Some(output);
        self
    }
}