Struct diem_types::ledger_info::LedgerInfo

pub struct LedgerInfo { /* fields omitted */ }

This structure serves a dual purpose.

First, if this structure is signed by 2f+1 validators it signifies the state of the ledger at version version – it contains the transaction accumulator at that version which commits to all historical transactions. This structure may be expanded to include other information that is derived from that accumulator (e.g. the current time according to the time contract) to reduce the number of proofs a client must get.

Second, the structure contains a consensus_data_hash value. This is the hash of an internal data structure that represents a block that is voted on in HotStuff. If 2f+1 signatures are gathered on the same ledger info that represents a Quorum Certificate (QC) on the consensus data.

Combining these two concepts, when a validator votes on a block, B it votes for a LedgerInfo with the version being the latest version that will be committed if B gets 2f+1 votes. It sets consensus_data_hash to represent B so that if those 2f+1 votes are gathered a QC is formed on B.

Implementations

impl LedgerInfo

pub fn new(commit_info: BlockInfo, consensus_data_hash: HashValue) -> Self

Constructs a LedgerInfo object based on the given commit info and vote data hash.

pub fn genesis(
    genesis_state_root_hash: HashValue,
    validator_set: ValidatorSet
) -> Self

Create a new LedgerInfo at genesis with the given genesis state and initial validator set.

pub fn commit_info(&self) -> &BlockInfo

The BlockInfo of a committed block.

pub fn epoch(&self) -> u64

A series of wrapper functions for the data stored in the commit info. For the detailed information, please refer to BlockInfo

pub fn next_block_epoch(&self) -> u64

pub fn round(&self) -> Round

pub fn consensus_block_id(&self) -> HashValue

pub fn transaction_accumulator_hash(&self) -> HashValue

pub fn version(&self) -> Version

pub fn timestamp_usecs(&self) -> u64

pub fn next_epoch_state(&self) -> Option<&EpochState>

pub fn ends_epoch(&self) -> bool

pub fn consensus_data_hash(&self) -> HashValue

Returns hash of consensus voting data in this LedgerInfo.

pub fn set_consensus_data_hash(&mut self, consensus_data_hash: HashValue)

Trait Implementations

impl Clone for LedgerInfo

fn clone(&self) -> LedgerInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CryptoHash for LedgerInfo

type Hasher = LedgerInfoHasher

The associated Hasher type which comes with a unique salt for this type.

fn hash(&self) -> HashValue

Hashes the object and produces a HashValue.

impl Debug for LedgerInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LedgerInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for LedgerInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<LedgerInfo> for LedgerInfo

fn eq(&self, other: &LedgerInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LedgerInfo) -> bool

This method tests for !=.

impl Serialize for LedgerInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ LedgerInfo> for TrustedState

type Error = Error

The type returned in the event of a conversion error.

fn try_from(ledger_info: &LedgerInfo) -> Result<Self>

Performs the conversion.

impl Eq for LedgerInfo

impl StructuralEq for LedgerInfo

impl StructuralPartialEq for LedgerInfo