Struct iota_types::messages_checkpoint::CheckpointSummary

pub struct CheckpointSummary {
    pub epoch: EpochId,
    pub sequence_number: CheckpointSequenceNumber,
    pub network_total_transactions: u64,
    pub content_digest: CheckpointContentsDigest,
    pub previous_digest: Option<CheckpointDigest>,
    pub epoch_rolling_gas_cost_summary: GasCostSummary,
    pub timestamp_ms: CheckpointTimestamp,
    pub checkpoint_commitments: Vec<CheckpointCommitment>,
    pub end_of_epoch_data: Option<EndOfEpochData>,
    pub version_specific_data: Vec<u8>,
}

Fields

epoch: EpochId

sequence_number: CheckpointSequenceNumber

network_total_transactions: u64

Total number of transactions committed since genesis, including those in this checkpoint.

content_digest: CheckpointContentsDigest

previous_digest: Option<CheckpointDigest>

epoch_rolling_gas_cost_summary: GasCostSummary

The running total gas costs of all transactions included in the current epoch so far until this checkpoint.

timestamp_ms: CheckpointTimestamp

Timestamp of the checkpoint - number of milliseconds from the Unix epoch Checkpoint timestamps are monotonic, but not strongly monotonic - subsequent checkpoints can have same timestamp if they originate from the same underlining consensus commit

checkpoint_commitments: Vec<CheckpointCommitment>

Commitments to checkpoint-specific state (e.g. txns in checkpoint, objects read/written in checkpoint).

end_of_epoch_data: Option<EndOfEpochData>

Present only on the final checkpoint of the epoch.

version_specific_data: Vec<u8>

CheckpointSummary is not an evolvable structure - it must be readable by any version of the code. Therefore, in order to allow extensions to be added to CheckpointSummary, we allow opaque data to be added to checkpoints which can be deserialized based on the current protocol version.

This is implemented with BCS-serialized CheckpointVersionSpecificData.

Implementations

impl CheckpointSummary

pub fn new( protocol_config: &ProtocolConfig, epoch: EpochId, sequence_number: CheckpointSequenceNumber, network_total_transactions: u64, transactions: &CheckpointContents, previous_digest: Option<CheckpointDigest>, epoch_rolling_gas_cost_summary: GasCostSummary, end_of_epoch_data: Option<EndOfEpochData>, timestamp_ms: CheckpointTimestamp, randomness_rounds: Vec<RandomnessRound>, ) -> CheckpointSummary

pub fn verify_epoch(&self, epoch: EpochId) -> IotaResult

pub fn sequence_number(&self) -> &CheckpointSequenceNumber

pub fn timestamp(&self) -> SystemTime

pub fn next_epoch_committee(&self) -> Option<&[(AuthorityName, StakeUnit)]>

pub fn report_checkpoint_age_ms(&self, metrics: &Histogram)

pub fn is_last_checkpoint_of_epoch(&self) -> bool

pub fn version_specific_data( &self, config: &ProtocolConfig, ) -> Result<Option<CheckpointVersionSpecificData>>

Trait Implementations

impl Clone for CheckpointSummary

fn clone(&self) -> CheckpointSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CheckpointSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CheckpointSummary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CheckpointSummary

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

Formats the value using the given formatter.

impl From<CheckpointSummary> for CheckpointSummary

fn from(value: CheckpointSummary) -> Self

Converts to this type from the input type.

impl From<CheckpointSummary> for CheckpointSummary

fn from(value: CheckpointSummary) -> Self

Converts to this type from the input type.

impl Message for CheckpointSummary

type DigestType = CheckpointDigest

const SCOPE: IntentScope = IntentScope::CheckpointSummary

fn digest(&self) -> Self::DigestType

fn scope(&self) -> IntentScope

impl PartialEq for CheckpointSummary

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CheckpointSummary

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CheckpointSummary

impl StructuralPartialEq for CheckpointSummary