sigil-consensus · view_change

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum ViewChangeReason {
    /// The proposer did not produce a block within the timeout.
    Timeout,
    /// The proposed block was invalid.
    InvalidBlock,
    /// The expected proposer is offline or unreachable.
    MissingProposer,
}

pub fn signing_tag(self) -> &'static [u8];

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ViewChangeMessage {
/// DID of the requesting validator.

pub validator_did: String,
/// Block height where the view change is requested.

pub height: u64,
/// View this validator is leaving.

pub from_view: u64,
/// New view number being requested.

pub view: u64,
/// Why this validator is requesting a view change.

pub reason: ViewChangeReason,
/// Ed25519 signature over (height || epoch || from_view || view || reason).

pub signature: Vec<u8>
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ViewChangeCertificate {
/// Block height where the view change is requested.

pub height: u64,
/// Epoch for signature payloads.

pub epoch: u64,
/// New view certified by the messages.

pub view: u64,
/// Signed view-change messages forming the quorum certificate.

pub messages: Vec<ViewChangeMessage>
}

pub fn digest(&self) -> [u8; 32];

pub fn verify(
        &self,
        current_view: u64,
        validator_set: &ValidatorSet,
    ) -> Result<(), ConsensusError>;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct NewViewMessage {
/// DID of the proposer for the certified new view.

pub proposer_did: String,
/// Block height where the view change applies.

pub height: u64,
/// Certified view number.

pub view: u64,
/// Quorum certificate authorizing the view change.

pub certificate: ViewChangeCertificate,
/// Ed25519 signature over the new-view envelope and certificate digest.

pub signature: Vec<u8>
}

pub struct ViewChangeTracker {

}

pub fn new(height: u64, epoch: u64, current_view: u64, validator_set: ValidatorSet) -> Self;

pub fn add_view_change(&mut self, msg: ViewChangeMessage) -> Result<bool, ConsensusError>;

pub fn should_change_view(&self) -> bool;

pub fn ready_view(&self) -> Option<u64>;

pub fn view_change_certificate(&self) -> Option<ViewChangeCertificate>;

pub fn current_view(&self) -> u64;

pub fn message_count(&self) -> usize;

pub fn view_change_stake(&self) -> u64;

pub fn view_change_stake_for_view(&self, view: u64) -> Option<u64>;

pub fn advance_view(&mut self);

pub fn advance_to_view(&mut self, new_view: u64);

pub fn reset(&mut self, new_height: u64, new_epoch: u64);

pub fn next_proposer_after_view_change(
    validator_set: &ValidatorSet,
    config: &ElectionConfig,
    height: u64,
    new_view: u64,
    epoch_seed: &SigilHash,
) -> String;