Struct CheckpointSummary 

#[non_exhaustive]
pub struct CheckpointSummary {
    pub digest: Option<Digest>,
    pub bcs: Option<BcsData>,
}

A header for a checkpoint on the IOTA blockchain.

On the IOTA 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 IOTA 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 (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

digest: Option<Digest>

The digest of this CheckpointSummary.

bcs: Option<BcsData>

This CheckpointSummary serialized as BCS.

Implementations

impl CheckpointSummary

pub const DIGEST_FIELD: &'static MessageField

pub const BCS_FIELD: &'static MessageField

impl CheckpointSummary

pub fn path_builder() -> CheckpointSummaryFieldPathBuilder

impl CheckpointSummary

pub fn with_digest<T: Into<Digest>>(self, field: T) -> Self

Sets digest with the provided value.

pub fn with_bcs<T: Into<BcsData>>(self, field: T) -> Self

Sets bcs with the provided value.

impl CheckpointSummary

pub fn digest(&self) -> Result<Digest, TryFromProtoError>

Get the digest of this checkpoint summary.

Read mask: "checkpoint.summary.digest" (see CHECKPOINT_SUMMARY_DIGEST).

pub fn summary(&self) -> Result<CheckpointSummary, TryFromProtoError>

Deserialize the checkpoint summary from BCS.

Read mask: "checkpoint.summary.bcs" (see CHECKPOINT_SUMMARY_BCS).

Trait Implementations

impl Clone for CheckpointSummary

fn clone(&self) -> CheckpointSummary

Returns a duplicate 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 Hash for CheckpointSummary

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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]

const ONEOFS: &'static [&'static str] = _

Oneof group names declared in this message.

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

impl StructuralPartialEq for CheckpointSummary