Rename old references to BlockHeaderHash and BlockHeight (#1002)

* rename some references

* Apply suggestions from code review

Co-authored-by: Deirdre Connolly <durumcrustulum@gmail.com>
Co-authored-by: teor <teor@riseup.net>

Co-authored-by: Deirdre Connolly <durumcrustulum@gmail.com>
Co-authored-by: teor <teor@riseup.net>

book/src/dev/rfcs/0002-parallel-verification.md

@@ -79,7 +79,7 @@ the verification in parallel.
 ## Example: BlockHeight
 [block-height]: #block-height
 
-Here's how Zebra can verify the different `BlockHeight` consensus rules in
+Here's how Zebra can verify the different Block Height consensus rules in
 parallel:
 
 **Structural Verification:**
@@ -93,10 +93,10 @@ parallel:
 
 **Semantic Verification: Deferring a Data Dependency:**
 
-3. Verify other consensus rules that depend on BlockHeight, assuming that the
-   BlockHeight is correct. For example, many consensus rules depend on the
-   current Network Upgrade, which is determined by the BlockHeight. We verify
-   these consensus rules, assuming the BlockHeight and Network Upgrade are
+3. Verify other consensus rules that depend on Block Height, assuming that the
+   Block Height is correct. For example, many consensus rules depend on the
+   current Network Upgrade, which is determined by the Block Height. We verify
+   these consensus rules, assuming the Block Height and Network Upgrade are
    correct.
 
 **Contextual Verification:**
@@ -125,11 +125,11 @@ When designing changes to Zebra verification, use these design patterns:
 
 Keep the data dependencies and checks as simple as possible.
 
-For example, Zebra could defer checking both the BlockHeight and Network Upgrade.
+For example, Zebra could defer checking both the Block Height and Network Upgrade.
 
-But since the Network Upgrade depends on the BlockHeight, we only need to defer
-the BlockHeight check. Then we can use all the fields that depend on the
-BlockHeight, as if it is correct. If the final BlockHeight check fails, we will
+But since the Network Upgrade depends on the Block Height, we only need to defer
+the Block Height check. Then we can use all the fields that depend on the
+Block Height, as if it is correct. If the final Block Height check fails, we will
 reject the entire block, including all the verification we perfomed using the
 assumed Network Upgrade.
 
@@ -175,7 +175,7 @@ Verification is implemented by the following traits and services:
     data structures from a byte buffer.
 * **Semantic Verification:**
   * `ChainVerifier`: Provides a verifier service that accepts a `Block` request,
-    performs verification on the block, and responds with a `BlockHeaderHash` on
+    performs verification on the block, and responds with a `block::Hash` on
     success.
   * Internally, the `ChainVerifier` selects between a `CheckpointVerifier` for
     blocks that are within the checkpoint range, and a `BlockVerifier` for

zebra-chain/proptest-regressions/block/tests.txt

@@ -4,4 +4,4 @@
 #
 # It is recommended to check this file in to source control so that
 # everyone who runs the test benefits from these saved cases.
-cc 1fcf1e08caccdafad9c9f51c46cd24b992cf7207f55cae605a54830868527baa # shrinks to header = BlockHeader { previous_block_hash: BlockHeaderHash("0000000000000000000000000000000000000000000000000000000000000000"), merkle_root_hash: MerkleTreeRootHash([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]), final_sapling_root_hash: SaplingNoteTreeRootHash([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]), time: 1969-12-31T23:59:59Z, bits: 0, nonce: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], solution: EquihashSolution("000000000000000000000128fd6ffe028bf9b8e789cf2bf69845f52fddda4066064dd798670fd27ca39ab1a3a363ccd3aab31a6e3aaf168095acafbf6a95f01a651d0c1b799a8c3134838b78de78c7128b4280136f544792764a739e3f152e92a79e849d87db179f8aa6d565b5c9c5cb60f92acd669254c0a454ecc0d74d05e21135f5f9445dd18755bc2bd2af041ba3f903e22ceccf729825b382e95b0d90b6a8657645395caa9041a93e904505c762f57ed042cb8e3b69a7fbee5bb8d174fabd95fbae8e7c01e8ecfe69d32d3954c8bdf75f8a292b08358a74d67a63599c9c97a2af237cfe0a14fbe21d73676a097706836f31bfac1e269e050e8cd95ffa04f24553206df40b559ba59078053a19ca20e51fde2ed9bf3a6f2d64e50985abdb59843738296438fd1e0223f1bac8525f42ccbb8ca128436fd5fb936bf5819b2469334d2082120bcdd62e6b800bb64124dd7472e1a8fc14d8e022a4195ff7be3b93deb24f5cf2c54015fd3ba008d035f57c991dae92eb6ad4ddae0e115ab4bd1f36350688d1bbe44574dcf53f158ab3d2747764b5bbf962d66570ef2b25d9cca5dcca7c692c33d0999f916ec0c4f87816797fdb7d38152110008470755ccd74552d498962297c7f99e4a59aface18dfb626bd106043932d70ccb97aa17152cf2da8d30f252cdb42883376ab048f94b376b9f844a412900a41bb63e11af1ea6cb0387646665cb067ada754335c66f499008bf836a3ee08330e4cef1c8218c0af52cadb7caf11e970737f2b684409921969e5be75a3b3328a98528f1d5af263ba33555a9df47f055f5698ce5f02827e08ec56e17bca426e16ea75474be0c68a02c22a1a095821019e293d79d2cb39baea9d190b9c07b9c2961a1b87a20ca3b6bc078cd7f928062d37b4f39b43057196079a71148ea1c5ce60c78711d314e021dc378c00a66eb4190b19b1804241b01a2bb9577ea4532f31ed3b76772e91313fd2639d1ba0e238035fc1a1dfe3f83caa7b82a9fddbbf15cbf6266ab824bcbfbdd7d8684a1002aaa96d234f5bacc124b7df180fd743d9108848f2cd38fdd96493353b31cac694fba0f502fe8410659fdf77a3774959a3579e66eebe8a190361b7abbd5f761b8b5b3fc78f4f146b3ffb08560589d7d2e12d279f7720e0b4bf72dd396d8628e1a335c2260af81198b32345da6cae3f93f734f7faa8d7a025130443260c8dc0a3640256315839570a9745f3dd4c75a3dcac9ff7b0dd081e072dd2337e3461078ba09c51c477e4e0f64bdf3cf898df0e8add9f94618993242a147e3aa7a879fe8ced8b0e6421c700376757c32c5df309d45b986ea28733a5519f3b1b501951bbad2c4d4dc823b05233a6c957bdd336f74bc803d5cb6b001681eac90e4ce1ee1766419b2f2a1024d81b03c21699d61b0faeeba6325d429c5f338de675a9c0ebd2ef75f4ccd6fd0b46232368c8b59d574be2cf1c7ea01a5fd3f8f30f268ba858a0910bee8ce4345028a6e471fce6f28b98ae64b9609c8235adebd8cca87462cae60349bc4b61a8a86071025d0f6f314a8a00cd98bd2680e19441bdc124722ddc64833d29b26fb5c34819d6315fc05e4c362dd13e3221f78e251869abdf26d728ba0896897348a07407d5822928e724987998101a6d00e39c125b7b0d22f43aed8b7f15080b4d0fa056454392466bcd27e56d7d49dd35a86e0337c0bfb5efb14e3ebf353ee57d6631437881e42ed3da531737d6266550ea4a6ced3f9b53523e6233e95a8b5fa730d321b1618cb67488f82c6fe2b17b6483910e25cc7b6df22560694a185bea249d29ac0699edba45038713077589a3b3058e1a4bf4579f4b224dbe01e1e017c268dafde88a89e9cb29f999b8870ce704275e24861613188555") }
+cc 1fcf1e08caccdafad9c9f51c46cd24b992cf7207f55cae605a54830868527baa # shrinks to header = BlockHeader { previous_block_hash: block::Hash("0000000000000000000000000000000000000000000000000000000000000000"), merkle_root_hash: MerkleTreeRootHash([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]), final_sapling_root_hash: SaplingNoteTreeRootHash([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]), time: 1969-12-31T23:59:59Z, bits: 0, nonce: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], solution: EquihashSolution("000000000000000000000128fd6ffe028bf9b8e789cf2bf69845f52fddda4066064dd798670fd27ca39ab1a3a363ccd3aab31a6e3aaf168095acafbf6a95f01a651d0c1b799a8c3134838b78de78c7128b4280136f544792764a739e3f152e92a79e849d87db179f8aa6d565b5c9c5cb60f92acd669254c0a454ecc0d74d05e21135f5f9445dd18755bc2bd2af041ba3f903e22ceccf729825b382e95b0d90b6a8657645395caa9041a93e904505c762f57ed042cb8e3b69a7fbee5bb8d174fabd95fbae8e7c01e8ecfe69d32d3954c8bdf75f8a292b08358a74d67a63599c9c97a2af237cfe0a14fbe21d73676a097706836f31bfac1e269e050e8cd95ffa04f24553206df40b559ba59078053a19ca20e51fde2ed9bf3a6f2d64e50985abdb59843738296438fd1e0223f1bac8525f42ccbb8ca128436fd5fb936bf5819b2469334d2082120bcdd62e6b800bb64124dd7472e1a8fc14d8e022a4195ff7be3b93deb24f5cf2c54015fd3ba008d035f57c991dae92eb6ad4ddae0e115ab4bd1f36350688d1bbe44574dcf53f158ab3d2747764b5bbf962d66570ef2b25d9cca5dcca7c692c33d0999f916ec0c4f87816797fdb7d38152110008470755ccd74552d498962297c7f99e4a59aface18dfb626bd106043932d70ccb97aa17152cf2da8d30f252cdb42883376ab048f94b376b9f844a412900a41bb63e11af1ea6cb0387646665cb067ada754335c66f499008bf836a3ee08330e4cef1c8218c0af52cadb7caf11e970737f2b684409921969e5be75a3b3328a98528f1d5af263ba33555a9df47f055f5698ce5f02827e08ec56e17bca426e16ea75474be0c68a02c22a1a095821019e293d79d2cb39baea9d190b9c07b9c2961a1b87a20ca3b6bc078cd7f928062d37b4f39b43057196079a71148ea1c5ce60c78711d314e021dc378c00a66eb4190b19b1804241b01a2bb9577ea4532f31ed3b76772e91313fd2639d1ba0e238035fc1a1dfe3f83caa7b82a9fddbbf15cbf6266ab824bcbfbdd7d8684a1002aaa96d234f5bacc124b7df180fd743d9108848f2cd38fdd96493353b31cac694fba0f502fe8410659fdf77a3774959a3579e66eebe8a190361b7abbd5f761b8b5b3fc78f4f146b3ffb08560589d7d2e12d279f7720e0b4bf72dd396d8628e1a335c2260af81198b32345da6cae3f93f734f7faa8d7a025130443260c8dc0a3640256315839570a9745f3dd4c75a3dcac9ff7b0dd081e072dd2337e3461078ba09c51c477e4e0f64bdf3cf898df0e8add9f94618993242a147e3aa7a879fe8ced8b0e6421c700376757c32c5df309d45b986ea28733a5519f3b1b501951bbad2c4d4dc823b05233a6c957bdd336f74bc803d5cb6b001681eac90e4ce1ee1766419b2f2a1024d81b03c21699d61b0faeeba6325d429c5f338de675a9c0ebd2ef75f4ccd6fd0b46232368c8b59d574be2cf1c7ea01a5fd3f8f30f268ba858a0910bee8ce4345028a6e471fce6f28b98ae64b9609c8235adebd8cca87462cae60349bc4b61a8a86071025d0f6f314a8a00cd98bd2680e19441bdc124722ddc64833d29b26fb5c34819d6315fc05e4c362dd13e3221f78e251869abdf26d728ba0896897348a07407d5822928e724987998101a6d00e39c125b7b0d22f43aed8b7f15080b4d0fa056454392466bcd27e56d7d49dd35a86e0337c0bfb5efb14e3ebf353ee57d6631437881e42ed3da531737d6266550ea4a6ced3f9b53523e6233e95a8b5fa730d321b1618cb67488f82c6fe2b17b6483910e25cc7b6df22560694a185bea249d29ac0699edba45038713077589a3b3058e1a4bf4579f4b224dbe01e1e017c268dafde88a89e9cb29f999b8870ce704275e24861613188555") }

zebra-chain/proptest-regressions/types.txt

@@ -4,7 +4,7 @@
 #
 # It is recommended to check this file in to source control so that
 # everyone who runs the test benefits from these saved cases.
-cc 77e4c5adc662baed850ecd3142ba2d61fa50d7dc7f75e56a1cb4ac6307a9a7e2 # shrinks to locktime = Height(BlockHeight(0))
+cc 77e4c5adc662baed850ecd3142ba2d61fa50d7dc7f75e56a1cb4ac6307a9a7e2 # shrinks to locktime = Height(block::Height(0))
 cc dbb060756c70411d81f49af9c742cbea259314ddf03440ff00ef62770047e304 # shrinks to locktime = Time(2019-12-19T19:48:42.288928Z)
 cc 27e82ee1a103b24301abb7f17f4bd5847bc5ae5160513122f3bda5d1047b91d8 # shrinks to locktime = Time(1970-01-01T00:00:00Z)
 cc 8b6898df17cc1f1eeba7d5774b58d6aa64355dec7e378c09ed21252f972f96d2 # shrinks to locktime = Time(2106-02-07T06:28:16Z)

zebra-chain/src/block/hash.rs

@@ -30,7 +30,7 @@ impl fmt::Display for Hash {
 
 impl fmt::Debug for Hash {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        f.debug_tuple("BlockHeaderHash")
+        f.debug_tuple("block::Hash")
             .field(&hex::encode(&self.0))
             .finish()
     }

zebra-chain/src/block/height.rs

@@ -4,7 +4,7 @@ use crate::serialization::SerializationError;
 ///
 /// # Invariants
 ///
-/// Users should not construct block heights greater than `BlockHeight::MAX`.
+/// Users should not construct block heights greater than `Height::MAX`.
 #[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
 pub struct Height(pub u32);
 
@@ -13,34 +13,30 @@ impl std::str::FromStr for Height {
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         match s.parse() {
             Ok(h) if (Height(h) <= Height::MAX) => Ok(Height(h)),
-            Ok(_) => Err(SerializationError::Parse(
-                "BlockHeight exceeds maximum height",
-            )),
-            Err(_) => Err(SerializationError::Parse(
-                "BlockHeight(u32) integer parse error",
-            )),
+            Ok(_) => Err(SerializationError::Parse("Height exceeds maximum height")),
+            Err(_) => Err(SerializationError::Parse("Height(u32) integer parse error")),
         }
     }
 }
 
 impl Height {
-    /// The minimum BlockHeight.
+    /// The minimum Height.
     ///
     /// Due to the underlying type, it is impossible to construct block heights
-    /// less than `BlockHeight::MIN`.
+    /// less than `Height::MIN`.
     ///
-    /// Style note: Sometimes, `BlockHeight::MIN` is less readable than
-    /// `BlockHeight(0)`. Use whichever makes sense in context.
+    /// Style note: Sometimes, `Height::MIN` is less readable than
+    /// `Height(0)`. Use whichever makes sense in context.
     pub const MIN: Height = Height(0);
 
-    /// The maximum BlockHeight.
+    /// The maximum Height.
     ///
-    /// Users should not construct block heights greater than `BlockHeight::MAX`.
+    /// Users should not construct block heights greater than `Height::MAX`.
     pub const MAX: Height = Height(499_999_999);
 
-    /// The maximum BlockHeight as a u32, for range patterns.
+    /// The maximum Height as a u32, for range patterns.
     ///
-    /// `BlockHeight::MAX.0` can't be used in match range patterns, use this
+    /// `Height::MAX.0` can't be used in match range patterns, use this
     /// alias instead.
     pub const MAX_AS_U32: u32 = Self::MAX.0;
 }

zebra-chain/src/block/tests/vectors.rs

@@ -21,7 +21,7 @@ fn blockheaderhash_debug() {
 
     assert_eq!(
         format!("{:?}", hash),
-        "BlockHeaderHash(\"bf46b4b5030752fedac6f884976162bbfb29a9398f104a280b3e34d51b416631\")"
+        "block::Hash(\"bf46b4b5030752fedac6f884976162bbfb29a9398f104a280b3e34d51b416631\")"
     );
 }
 
@@ -33,7 +33,7 @@ fn blockheaderhash_from_blockheader() {
 
     assert_eq!(
         format!("{:?}", hash),
-        "BlockHeaderHash(\"39c92b8c6b582797830827c78d58674c7205fcb21991887c124d1dbe4b97d6d1\")"
+        "block::Hash(\"39c92b8c6b582797830827c78d58674c7205fcb21991887c124d1dbe4b97d6d1\")"
     );
 
     let mut bytes = Cursor::new(Vec::new());

zebra-chain/src/parameters.rs

@@ -10,7 +10,7 @@
 //! block header during the Heartwood upgrade.)
 //!
 //! Typically, consensus parameters are accessed via a function that takes a
-//! `Network` and `BlockHeight`.
+//! `Network` and `block::Height`.
 
 mod network;
 mod network_upgrade;

zebra-chain/src/transaction/lock_time.rs

@@ -12,7 +12,7 @@ use crate::serialization::{SerializationError, ZcashDeserialize, ZcashSerialize}
 /// # Invariants
 ///
 /// Users should not construct a `LockTime` with:
-///   - a `BlockHeight` greater than MAX_BLOCK_HEIGHT,
+///   - a `block::Height` greater than MAX_BLOCK_HEIGHT,
 ///   - a timestamp before 6 November 1985
 ///     (Unix timestamp less than MIN_LOCK_TIMESTAMP), or
 ///   - a timestamp after 5 February 2106

zebra-consensus/src/parameters.rs

@@ -10,7 +10,7 @@
 //! block header during the Heartwood upgrade.)
 //!
 //! Typically, consensus parameters are accessed via a function that takes a
-//! `Network` and `BlockHeight`.
+//! `Network` and `block::Height`.
 
 pub mod genesis;
 pub mod minimum_difficulty;

zebra-network/src/protocol/external/message.rs

@@ -165,7 +165,7 @@ pub enum Message {
         /// Block locators, from newest back to genesis block.
         block_locator_hashes: Vec<block::Hash>,
 
-        /// `BlockHeaderHash` of the last desired block.
+        /// `block::Hash` of the last desired block.
         ///
         /// Set to zero to get as many blocks as possible (500).
         hash_stop: block::Hash,

zebra-state/src/lib.rs

@@ -4,8 +4,8 @@
 //!
 //! zebra-state tracks `Blocks` using two key-value trees
 //!
-//! * BlockHeaderHash -> Block
-//! * BlockHeight -> Block
+//! * block::Hash -> Block
+//! * Height -> Block
 //!
 //! Inserting a block into the service will create a mapping in each tree for that block.
 

zebrad/src/config.rs

@@ -57,7 +57,7 @@ pub struct TracingSection {
     /// `zebra_network` crate.
     ///
     /// ```ascii,no_run
-    /// [block_verify{height=Some\(BlockHeight\(.*000\)\)}]=trace
+    /// [block_verify{height=Some\(block::Height\(.*000\)\)}]=trace
     /// ```
     /// sets `trace` level for all events occurring in the context of a
     /// `block_verify` span whose `height` field ends in `000`, i.e., traces the