pub struct LedgerInfo { /* private fields */ }
Expand description

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§

source§

impl LedgerInfo

source

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.

source

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.

source

pub fn mock_genesis(validator_set: Option<ValidatorSet>) -> Self

source

pub fn commit_info(&self) -> &BlockInfo

The BlockInfo of a committed block.

source

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

source

pub fn next_block_epoch(&self) -> u64

source

pub fn round(&self) -> Round

source

pub fn consensus_block_id(&self) -> HashValue

source

pub fn transaction_accumulator_hash(&self) -> HashValue

source

pub fn version(&self) -> Version

source

pub fn timestamp_usecs(&self) -> u64

source

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

source

pub fn ends_epoch(&self) -> bool

source

pub fn consensus_data_hash(&self) -> HashValue

Returns hash of consensus voting data in this LedgerInfo.

source

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

Trait Implementations§

source§

impl Arbitrary for LedgerInfo

§

type Parameters = (<BlockInfo as Arbitrary>::Parameters, <HashValue as Arbitrary>::Parameters)

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.
§

type Strategy = Map<(<BlockInfo as Arbitrary>::Strategy, <HashValue as Arbitrary>::Strategy), fn(_: (BlockInfo, HashValue)) -> LedgerInfo>

The type of Strategy used to generate values of type Self.
source§

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more
§

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). Read more
source§

impl Clone for LedgerInfo

source§

fn clone(&self) -> LedgerInfo

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl CryptoHash for LedgerInfo

§

type Hasher = LedgerInfoHasher

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

fn hash(&self) -> HashValue

Hashes the object and produces a HashValue.
source§

impl Debug for LedgerInfo

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for LedgerInfo

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq<LedgerInfo> for LedgerInfo

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for LedgerInfo

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for LedgerInfo

source§

impl StructuralEq for LedgerInfo

source§

impl StructuralPartialEq for LedgerInfo

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> TestOnlyHash for Twhere T: Serialize + ?Sized,

source§

fn test_only_hash(&self) -> HashValue

Generates a hash used only for tests.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,