Struct aptos_types::block_metadata::BlockMetadata

pub struct BlockMetadata { /* private fields */ }

Struct that will be persisted on chain to store the information of the current block.

The flow will look like following:

1. The executor will pass this struct to VM at the end of a block proposal.
2. The VM will use this struct to create a special system transaction that will emit an event represents the information of the current block. This transaction can’t be emitted by regular users and is generated by each of the validators on the fly. Such transaction will be executed before all of the user-submitted transactions in the blocks.
3. Once that special resource is modified, the other user transactions can read the consensus info by calling into the read method of that resource, which would thus give users the information such as the current leader.

Implementations

impl BlockMetadata

pub fn new(
    id: HashValue,
    epoch: u64,
    round: u64,
    proposer: AccountAddress,
    proposer_index: Option<u32>,
    previous_block_votes: Vec<bool>,
    failed_proposer_indices: Vec<u32>,
    timestamp_usecs: u64
) -> Self

pub fn id(&self) -> HashValue

pub fn get_prologue_move_args(self, signer: AccountAddress) -> Vec<MoveValue>

pub fn timestamp_usecs(&self) -> u64

pub fn proposer(&self) -> AccountAddress

pub fn proposer_index(&self) -> Option<u32>

pub fn previous_block_votes(&self) -> &Vec<bool>

pub fn failed_proposer_indices(&self) -> &Vec<u32>

pub fn epoch(&self) -> u64

pub fn round(&self) -> u64

Trait Implementations

impl Clone for BlockMetadata

fn clone(&self) -> BlockMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockMetadata

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<BlockMetadata> for BlockMetadata

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

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

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

This method tests for !=.

impl Serialize for BlockMetadata

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 BlockMetadata

impl StructuralEq for BlockMetadata

impl StructuralPartialEq for BlockMetadata