Struct CheckpointSummary

pub struct CheckpointSummary {
    pub bcs: Option<Bcs>,
    pub digest: Option<String>,
    pub epoch: Option<u64>,
    pub sequence_number: Option<u64>,
    pub total_network_transactions: Option<u64>,
    pub content_digest: Option<String>,
    pub previous_digest: Option<String>,
    pub epoch_rolling_gas_cost_summary: Option<GasCostSummary>,
    pub timestamp: Option<Timestamp>,
    pub commitments: Vec<CheckpointCommitment>,
    pub end_of_epoch_data: Option<EndOfEpochData>,
    pub version_specific_data: Option<Bytes>,
}

A header for a checkpoint on the Sui blockchain.

On the Sui network, checkpoints define the history of the blockchain. They are quite similar to the concept of blocks used by other blockchains like Bitcoin or Ethereum. The Sui blockchain, however, forms checkpoints after transaction execution has already happened to provide a certified history of the chain, instead of being formed before execution.

Checkpoints commit to a variety of state, including but not limited to:

• The hash of the previous checkpoint.
• The set of transaction digests, their corresponding effects digests, as well as the set of user signatures that authorized its execution.
• The objects produced by a transaction.
• The set of live objects that make up the current state of the chain.
• On epoch transitions, the next validator committee.

CheckpointSummarys themselves don’t directly include all of the previous information but they are the top-level type by which all the information is committed to transitively via cryptographic hashes included in the summary. CheckpointSummarys are signed and certified by a quorum of the validator committee in a given epoch to allow verification of the chain’s state.

Fields

bcs: Option<Bcs>

This CheckpointSummary serialized as BCS.

digest: Option<String>

The digest of this CheckpointSummary.

epoch: Option<u64>

Epoch that this checkpoint belongs to.

sequence_number: Option<u64>

The height of this checkpoint.

total_network_transactions: Option<u64>

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

content_digest: Option<String>

The hash of the CheckpointContents for this checkpoint.

previous_digest: Option<String>

The hash of the previous CheckpointSummary.

This will be None only for the first, or genesis, checkpoint.

epoch_rolling_gas_cost_summary: Option<GasCostSummary>

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

timestamp: Option<Timestamp>

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

commitments: Vec<CheckpointCommitment>

Commitments to checkpoint-specific state.

end_of_epoch_data: Option<EndOfEpochData>

Extra data only present in the final checkpoint of an epoch.

version_specific_data: Option<Bytes>

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

Implementations

impl CheckpointSummary

pub fn digest(&self) -> &str

Returns the value of digest, or the default value if digest is unset.

pub fn epoch(&self) -> u64

Returns the value of epoch, or the default value if epoch is unset.

pub fn sequence_number(&self) -> u64

Returns the value of sequence_number, or the default value if sequence_number is unset.

pub fn total_network_transactions(&self) -> u64

Returns the value of total_network_transactions, or the default value if total_network_transactions is unset.

pub fn content_digest(&self) -> &str

Returns the value of content_digest, or the default value if content_digest is unset.

pub fn previous_digest(&self) -> &str

Returns the value of previous_digest, or the default value if previous_digest is unset.

pub fn version_specific_data(&self) -> &[u8]

Returns the value of version_specific_data, or the default value if version_specific_data is unset.

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 Default for CheckpointSummary

fn default() -> Self

Returns the “default value” for a type.

impl From<CheckpointSummary> for CheckpointSummary

fn from(summary: CheckpointSummary) -> Self

Converts to this type from the input type.

impl Message for CheckpointSummary

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for CheckpointSummary

const FIELDS: &'static [&'static MessageField]

impl MessageMerge<&CheckpointSummary> for CheckpointSummary

fn merge(&mut self, source: &CheckpointSummary, mask: &FieldMaskTree)

impl MessageMerge<CheckpointSummary> for CheckpointSummary

fn merge(&mut self, source: CheckpointSummary, mask: &FieldMaskTree)

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 TryFrom<&CheckpointSummary> for CheckpointSummary

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(_: &CheckpointSummary) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for CheckpointSummary