zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Explain in BlockHeaderHash docstrings block hash vs block header hash

This commit is contained in:
Deirdre Connolly 2019-09-26 22:42:44 -04:00 committed by Deirdre Connolly
parent 35f03dc55d
commit 4e85bdb51b
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
zebra-chain/src/block.rs
View File

@ -13,6 +13,14 @@ use crate::transaction::Transaction;
/// ///
/// This is useful when one block header is pointing to its parent /// This is useful when one block header is pointing to its parent
/// block header in the block chain. ⛓️ /// block header in the block chain. ⛓️
///
/// This is usually called a 'block hash', as it is frequently used
/// to identify the entire block, since the hash preimage includes
/// the merkle root of the transactions in this block. But
/// _technically_, this is just a hash of the block _header_, not
/// the direct bytes of the transactions as well as the header. So
/// for now I want to call it a `BlockHeaderHash` because that's
/// more explicit.
#[derive(Clone, Debug, Eq, PartialEq)] #[derive(Clone, Debug, Eq, PartialEq)]
pub struct BlockHeaderHash([u8; 32]); pub struct BlockHeaderHash([u8; 32]);
@ -37,13 +45,6 @@ pub struct BlockHeader {
/// A SHA-256d hash in internal byte order of the previous block’s /// A SHA-256d hash in internal byte order of the previous block’s
/// header. This ensures no previous block can be changed without /// header. This ensures no previous block can be changed without
/// also changing this block’s header. /// also changing this block’s header.
// This is usually called a 'block hash', as it is frequently used
// to identify the entire block, since the hash preimage includes
// the merkle root of the transactions in this block. But
// _technically_, this is just a hash of the block _header_, not
// the direct bytes of the transactions as well as the header. So
// for now I want to call it a `BlockHeaderHash` because that's
// more explicit.
previous_block_hash: BlockHeaderHash, previous_block_hash: BlockHeaderHash,
/// A SHA-256d hash in internal byte order. The merkle root is /// A SHA-256d hash in internal byte order. The merkle root is