Enum BlockHeader

pub enum BlockHeader {
    V1(BlockHeaderV1),
    V2(BlockHeaderV2),
}

The versioned header portion of a block. It encapsulates different variants of the BlockHeader struct.

Variants

V1(BlockHeaderV1)

The legacy, initial version of the header portion of a block.

V2(BlockHeaderV2)

The version 2 of the header portion of a block.

Implementations

impl BlockHeader

pub fn block_hash(&self) -> BlockHash

Returns the hash of this block header.

pub fn parent_hash(&self) -> &BlockHash

Returns the parent block’s hash.

pub fn state_root_hash(&self) -> &Digest

Returns the root hash of global state after the deploys in this block have been executed.

pub fn body_hash(&self) -> &Digest

Returns the hash of the block’s body.

pub fn random_bit(&self) -> bool

Returns a random bit needed for initializing a future era.

pub fn accumulated_seed(&self) -> &Digest

Returns a seed needed for initializing a future era.

pub fn clone_era_end(&self) -> Option<EraEnd>

Returns the EraEnd of a block if it is a switch block.

pub fn maybe_equivocators(&self) -> Option<&[PublicKey]>

Returns equivocators if the header is of a switch block.

pub fn maybe_inactive_validators(&self) -> Option<&[PublicKey]>

Returns equivocators if the header is of a switch block.

pub fn timestamp(&self) -> Timestamp

Returns the timestamp from when the block was proposed.

pub fn era_id(&self) -> EraId

Returns the era ID in which this block was created.

pub fn next_block_era_id(&self) -> EraId

Returns the era ID in which the next block would be created (i.e. this block’s era ID, or its successor if this is a switch block).

pub fn height(&self) -> u64

Returns the height of this block, i.e. the number of ancestors.

pub fn protocol_version(&self) -> ProtocolVersion

Returns the protocol version of the network from when this block was created.

pub fn is_switch_block(&self) -> bool

Returns true if this block is the last one in the current era.

pub fn next_era_validator_weights(&self) -> Option<&BTreeMap<PublicKey, U512>>

Returns the validators for the upcoming era and their respective weights (if this is a switch block).

pub fn is_genesis(&self) -> bool

Returns true if this block is the Genesis block, i.e. has height 0 and era 0.

pub fn is_last_block_before_activation( &self, protocol_config: &ProtocolConfig, ) -> bool

Available on crate feature std only.

Returns true if this block belongs to the last block before the upgrade to the current protocol version.

Trait Implementations

impl Clone for BlockHeader

fn clone(&self) -> BlockHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSize for BlockHeader

where BlockHeaderV1: DataSize, BlockHeaderV2: DataSize,

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for BlockHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockHeader

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockHeader

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

Formats the value using the given formatter.

impl From<BlockHeaderV1> for BlockHeader

fn from(header: BlockHeaderV1) -> Self

Converts to this type from the input type.

impl From<BlockHeaderV2> for BlockHeader

fn from(header: BlockHeaderV2) -> Self

Converts to this type from the input type.

impl FromBytes for BlockHeader

fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl JsonSchema for BlockHeader

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for BlockHeader

fn eq(&self, other: &BlockHeader) -> 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 BlockHeader

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToBytes for BlockHeader

fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

impl Eq for BlockHeader

impl StructuralPartialEq for BlockHeader