Enum solana_sdk::commitment_config::CommitmentLevel

pub enum CommitmentLevel {
    Max,
    Recent,
    Root,
    Single,
    SingleGossip,
    Processed,
    Confirmed,
    Finalized,
}

An attribute of a slot. It describes how finalized a block is at some point in time. For example, a slot is said to be at the max level immediately after the cluster recognizes the block at that slot as finalized. When querying the ledger state, use lower levels of commitment to report progress and higher levels to ensure state changes will not be rolled back.

Variants

Max

👎 Deprecated since 1.5.5:

Please use CommitmentLevel::Finalized instead

(DEPRECATED) The highest slot having reached max vote lockout, as recognized by a supermajority of the cluster.

Recent

👎 Deprecated since 1.5.5:

Please use CommitmentLevel::Processed instead

(DEPRECATED) The highest slot of the heaviest fork. Ledger state at this slot is not derived from a finalized block, but if multiple forks are present, is from the fork the validator believes is most likely to finalize.

Root

👎 Deprecated since 1.5.5:

Please use CommitmentLevel::Finalized instead

(DEPRECATED) The highest slot having reached max vote lockout.

Single

👎 Deprecated since 1.5.5:

Please use CommitmentLevel::Confirmed instead

(DEPRECATED) The highest slot having reached 1 confirmation by supermajority of the cluster.

SingleGossip

👎 Deprecated since 1.5.5:

Please use CommitmentLevel::Confirmed instead

(DEPRECATED) The highest slot that has been voted on by supermajority of the cluster This differs from single in that:

1. It incorporates votes from gossip and replay.
2. It does not count votes on descendants of a block, only direct votes on that block.
3. This confirmation level also upholds “optimistic confirmation” guarantees in release 1.3 and onwards.

Processed

The highest slot of the heaviest fork processed by the node. Ledger state at this slot is not derived from a confirmed or finalized block, but if multiple forks are present, is from the fork the validator believes is most likely to finalize.

Confirmed

The highest slot that has been voted on by supermajority of the cluster, ie. is confirmed. Confirmation incorporates votes from gossip and replay. It does not count votes on descendants of a block, only direct votes on that block, and upholds “optimistic confirmation” guarantees in release 1.3 and onwards.

Finalized

The highest slot having reached max vote lockout, as recognized by a supermajority of the cluster.

Trait Implementations

impl Clone for CommitmentLevel

fn clone(&self) -> CommitmentLevel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CommitmentLevel

impl Debug for CommitmentLevel

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

Formats the value using the given formatter.

impl Default for CommitmentLevel

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommitmentLevel

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

Deserialize this value from the given Serde deserializer.

impl Display for CommitmentLevel

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

Formats the value using the given formatter.

impl Eq for CommitmentLevel

impl FromStr for CommitmentLevel

type Err = ParseCommitmentLevelError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CommitmentLevel

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<CommitmentLevel> for CommitmentLevel

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

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

#[must_use]

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

This method tests for !=.

impl Serialize for CommitmentLevel

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

Serialize this value into the given Serde serializer.

impl StructuralEq for CommitmentLevel

impl StructuralPartialEq for CommitmentLevel