Struct safety_rules::SafetyRules

pub struct SafetyRules { /* private fields */ }

@TODO consider a cache of verified QCs to cut down on verification costs

Implementations

impl SafetyRules

pub fn new( persistent_storage: PersistentSafetyStorage, _verify_vote_proposal_signature: bool, export_consensus_key: bool, vrf_private_key: Option<ConsensusVRFPrivateKey>, author: AccountAddress ) -> Self

Constructs a new instance of SafetyRules with the given persistent storage and the consensus private keys

pub fn extension_check(vote_proposal: &VoteProposal) -> Result<VoteData, Error>

Check if the executed result extends the parent result.

pub fn construct_ledger_info( proposed_block: &Block, consensus_data_hash: HashValue ) -> Result<LedgerInfo, Error>

Produces a LedgerInfo that either commits a block based upon the 3-chain commit rule or an empty LedgerInfo for no commit. The 3-chain commit rule is: B0 and its prefixes can be committed if there exist certified blocks B1 and B2 that satisfy: 1) B0 <- B1 <- B2 <– 2) round(B0) + 1 = round(B1), and 3) round(B1) + 1 = round(B2).

pub fn start_voting(&mut self, initialize: bool) -> Result<(), Error>

pub fn stop_voting(&mut self) -> Result<(), Error>

Trait Implementations

impl TSafetyRules for SafetyRules

fn consensus_state(&mut self) -> Result<ConsensusState, Error>

Provides the internal state of SafetyRules for monitoring / debugging purposes. This does not include sensitive data like private keys.

fn initialize(&mut self, proof: &EpochChangeProof) -> Result<(), Error>

Initialize SafetyRules using an Epoch ending LedgerInfo, this should map to what was provided in consensus_state. It will be used to initialize the ValidatorSet. This uses a EpochChangeProof because there’s a possibility that consensus migrated to a new epoch but SafetyRules did not.

fn construct_and_sign_vote( &mut self, maybe_signed_vote_proposal: &MaybeSignedVoteProposal ) -> Result<Vote, Error>

Attempts to vote for a given proposal following the voting rules.

fn sign_proposal(&mut self, block_data: BlockData) -> Result<Block, Error>

As the holder of the private key, SafetyRules also signs proposals or blocks. A Block is a signed BlockData along with some additional metadata.

fn sign_timeout( &mut self, timeout: &Timeout ) -> Result<ConsensusSignature, Error>

As the holder of the private key, SafetyRules also signs what is effectively a timeout message. This returns the signature for that timeout message.

fn start_voting(&mut self, _initialize: bool) -> Result<(), Error>

Allow the safety rule to start voting with saved secure data from another node.

fn stop_voting(&mut self) -> Result<(), Error>

Stop the safety rule from voting and save secure data.