Trait safety_rules::TSafetyRules

source · 
pub trait TSafetyRules {
    // Required methods
    fn consensus_state(&mut self) -> Result<ConsensusState, Error>;
    fn initialize(&mut self, proof: &EpochChangeProof) -> Result<(), Error>;
    fn construct_and_sign_vote(
        &mut self,
        vote_proposal: &MaybeSignedVoteProposal
    ) -> Result<Vote, Error>;
    fn sign_proposal(
        &mut self,
        block_data: &BlockData
    ) -> Result<Ed25519Signature, Error>;
    fn sign_timeout(
        &mut self,
        timeout: &Timeout
    ) -> Result<Ed25519Signature, Error>;
    fn sign_timeout_with_qc(
        &mut self,
        timeout: &TwoChainTimeout,
        timeout_cert: Option<&TwoChainTimeoutCertificate>
    ) -> Result<Ed25519Signature, Error>;
    fn construct_and_sign_vote_two_chain(
        &mut self,
        vote_proposal: &MaybeSignedVoteProposal,
        timeout_cert: Option<&TwoChainTimeoutCertificate>
    ) -> Result<Vote, Error>;
    fn sign_commit_vote(
        &mut self,
        ledger_info: LedgerInfoWithSignatures,
        new_ledger_info: LedgerInfo
    ) -> Result<Ed25519Signature, Error>;
}
Expand description

Interface for SafetyRules

Required Methods§

source

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.

source

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.

source

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

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

source

fn sign_proposal( &mut self, block_data: &BlockData ) -> Result<Ed25519Signature, 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.

source

fn sign_timeout(&mut self, timeout: &Timeout) -> Result<Ed25519Signature, 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.

source

fn sign_timeout_with_qc( &mut self, timeout: &TwoChainTimeout, timeout_cert: Option<&TwoChainTimeoutCertificate> ) -> Result<Ed25519Signature, Error>

Sign the timeout together with highest qc for 2-chain protocol.

source

fn construct_and_sign_vote_two_chain( &mut self, vote_proposal: &MaybeSignedVoteProposal, timeout_cert: Option<&TwoChainTimeoutCertificate> ) -> Result<Vote, Error>

Sign the vote with 2-chain protocol.

source

fn sign_commit_vote( &mut self, ledger_info: LedgerInfoWithSignatures, new_ledger_info: LedgerInfo ) -> Result<Ed25519Signature, Error>

As the holder of the private key, SafetyRules also signs a commit vote. This returns the signature for the commit vote.

Implementors§