Enum DiskBlockHeader

pub enum DiskBlockHeader {
    FullyValid(Header, u32),
    AssumedValid(Header, u32),
    Orphan(Header),
    HeadersOnly(Header, u32),
    InFork(Header, u32),
    InvalidChain(Header),
}

This enum is used to store a block header in the database. It contains the header along with metadata about the validation state of the block, and, if applicable, also its height.

Variants

FullyValid(Header, u32)

Represents a fully validated block header in the current best chain.

AssumedValid(Header, u32)

Represents an assumed valid block header.

Orphan(Header)

Represents an orphan block header.

HeadersOnly(Header, u32)

Represents a block header in the current best chain whose block is pending validation.

InFork(Header, u32)

Represents a block header in a fork.

InvalidChain(Header)

Represents an invalid chain block header.

Implementations

impl DiskBlockHeader

pub fn block_hash(&self) -> BlockHash

Computes the block hash.

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

Gets the block height or returns None if the block is orphaned or on an invalid chain.

pub fn try_height(&self) -> Result<u32, BlockchainError>

Gets the block height or returns BlockchainError::OrphanOrInvalidBlock if the block is orphaned or on an invalid chain (the height is not stored).

Methods from Deref<Target = BlockHeader>

pub const SIZE: usize = 80usize

pub fn block_hash(&self) -> BlockHash

Returns the block hash.

pub fn target(&self) -> Target

Computes the target (range [0, T] inclusive) that a blockhash must land in to be valid.

pub fn difficulty(&self, params: impl AsRef<Params>) -> u128

Computes the popular “difficulty” measure for mining.

Difficulty represents how difficult the current target makes it to find a block, relative to how difficult it would be at the highest possible target (highest target == lowest difficulty).

pub fn difficulty_float(&self) -> f64

Computes the popular “difficulty” measure for mining and returns a float value of f64.

pub fn validate_pow( &self, required_target: Target, ) -> Result<BlockHash, ValidationError>

Checks that the proof-of-work for the block is valid, returning the block hash.

pub fn work(&self) -> Work

Returns the total work of the block.

Trait Implementations

impl Clone for DiskBlockHeader

fn clone(&self) -> DiskBlockHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DiskBlockHeader

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

Formats the value using the given formatter.

impl Decodable for DiskBlockHeader

Decodable is a trait from bitcoin::consensus::encode that allows decoding of a type from a reader in a consistent manner.

fn consensus_decode<R: Read + ?Sized>(reader: &mut R) -> Result<Self, Error>

Decodes a DiskBlockHeader from a reader.

fn consensus_decode_from_finite_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + ?Sized,

Decode Self from a size-limited reader.

impl Deref for DiskBlockHeader

DiskBlockHeader dereferences to the inner header type.

type Target = Header

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Encodable for DiskBlockHeader

fn consensus_encode<W: Write + ?Sized>(&self, writer: &mut W) -> Result<usize>

Encodes a DiskBlockHeader to a writer using the consensus encoding.

impl PartialEq for DiskBlockHeader

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

impl StructuralPartialEq for DiskBlockHeader