Struct grin_core::core::block::BlockHeader

source ·
pub struct BlockHeader {
    pub version: HeaderVersion,
    pub height: u64,
    pub prev_hash: Hash,
    pub prev_root: Hash,
    pub timestamp: DateTime<Utc>,
    pub output_root: Hash,
    pub range_proof_root: Hash,
    pub kernel_root: Hash,
    pub total_kernel_offset: BlindingFactor,
    pub output_mmr_size: u64,
    pub kernel_mmr_size: u64,
    pub pow: ProofOfWork,
}
Expand description

Block header, fairly standard compared to other blockchains.

Fields§

§version: HeaderVersion

Version of the block

§height: u64

Height of this block since the genesis block (height 0)

§prev_hash: Hash

Hash of the block previous to this in the chain.

§prev_root: Hash

Root hash of the header MMR at the previous header.

§timestamp: DateTime<Utc>

Timestamp at which the block was built.

§output_root: Hash

Merklish root of all the commitments in the TxHashSet

§range_proof_root: Hash

Merklish root of all range proofs in the TxHashSet

§kernel_root: Hash

Merklish root of all transaction kernels in the TxHashSet

§total_kernel_offset: BlindingFactor

Total accumulated sum of kernel offsets since genesis block. We can derive the kernel offset sum for this block from the total kernel offset of the previous block header.

§output_mmr_size: u64

Total size of the output MMR after applying this block

§kernel_mmr_size: u64

Total size of the kernel MMR after applying this block

§pow: ProofOfWork

Proof of work and related

Implementations§

source§

impl BlockHeader

source

pub fn write_pre_pow<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Write the pre-hash portion of the header

source

pub fn pre_pow(&self) -> Vec<u8>

Return the pre-pow, unhashed Let the cuck(at)oo miner/verifier handle the hashing for consistency with how this call is performed everywhere else

source

pub fn from_pre_pow_and_proof( pre_pow: String, nonce: u64, proof: Proof ) -> Result<Self, Error>

Constructs a header given pre_pow string, nonce, and proof

source

pub fn output_mmr_count(&self) -> u64

Total number of outputs (spent and unspent) based on output MMR size committed to in this block. Note: Not the number of outputs in this block but total up to and including this block. The MMR size is the total number of hashes contained in the full MMR structure. We want the corresponding number of leaves in the MMR given the size.

source

pub fn kernel_mmr_count(&self) -> u64

Total number of kernels based on kernel MMR size committed to in this block. Note: Not the number of kernels in this block but total up to and including this block. The MMR size is the total number of hashes contained in the full MMR structure. We want the corresponding number of leaves in the MMR given the size.

source

pub fn total_difficulty(&self) -> Difficulty

Total difficulty accumulated by the proof of work on this header

source

pub fn overage(&self) -> i64

The “overage” to use when verifying the kernel sums. For a block header the overage is 0 - reward.

source

pub fn total_overage(&self, genesis_had_reward: bool) -> i64

The “total overage” to use when verifying the kernel sums for a full chain state. For a full chain state this is 0 - (height * reward).

source

pub fn total_kernel_offset(&self) -> BlindingFactor

Total kernel offset for the chain state up to and including this block.

Trait Implementations§

source§

impl Clone for BlockHeader

source§

fn clone(&self) -> BlockHeader

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for BlockHeader

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for BlockHeader

source§

fn default() -> BlockHeader

Returns the “default value” for a type. Read more
source§

impl From<UntrustedBlockHeader> for BlockHeader

source§

fn from(header: UntrustedBlockHeader) -> Self

Converts to this type from the input type.
source§

impl PMMRable for BlockHeader

§

type E = HeaderEntry

The type of element actually stored in the MMR data file. This allows us to store Hash elements in the header MMR for variable size BlockHeaders.
source§

fn as_elmt(&self) -> Self::E

Convert the pmmrable into the element to be stored in the MMR data file.
source§

fn elmt_size() -> Option<u16>

Size of each element if “fixed” size. Elements are “variable” size if None.
source§

impl PartialEq for BlockHeader

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Readable for BlockHeader

Deserialization of a block header

source§

fn read<R: Reader>(reader: &mut R) -> Result<BlockHeader, Error>

Reads the data necessary to this Readable from the provided reader
source§

impl Serialize for BlockHeader

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Writeable for BlockHeader

Serialization of a block header

source§

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Write the data held by this Writeable to the provided writer
source§

impl DefaultHashable for BlockHeader

source§

impl StructuralPartialEq for BlockHeader

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneAny for T
where T: Any + Clone,

source§

fn clone_any(&self) -> Box<dyn CloneAny>

source§

fn clone_any_send(&self) -> Box<dyn CloneAny + Send>
where T: Send,

source§

fn clone_any_sync(&self) -> Box<dyn CloneAny + Sync>
where T: Sync,

source§

fn clone_any_send_sync(&self) -> Box<dyn CloneAny + Send + Sync>
where T: Send + Sync,

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<D> Hashed for D
where D: DefaultHashable,

source§

fn hash(&self) -> Hash

Obtain the hash of the object
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> PMMRIndexHashable for T
where T: DefaultHashable,

source§

fn hash_with_index(&self, index: u64) -> Hash

Hash with a given index
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<H> ShortIdentifiable for H
where H: Hashed,

source§

fn short_id(&self, hash: &Hash, nonce: u64) -> ShortId

Generate a short_id via the following -

  • extract k0/k1 from block_hash hashed with the nonce (first two u64 values) * initialize a siphasher24 with k0/k1
    • self.hash() passing in the siphasher24 instance
    • drop the 2 most significant bytes (to return a 6 byte short_id)
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DebugAny for T
where T: Any + Debug,

source§

impl<T> UnsafeAny for T
where T: Any,