Merge rust-bitcoin#4462: Do lock time renames

dca4266 units: Fix rustdoc column width (Tobin C. Harding)
d557caf Run the formatter (Tobin C. Harding)
7c2115b Rename MtpInterval to NumberOf512Seconds (Tobin C. Harding)
3a97ea2 Rename HeightInterval to NumberOfBlocks (Tobin C. Harding)
c3b7457 Rename Mtp to MedianTimePast (Tobin C. Harding)
b38d225 Run the formatter (Tobin C. Harding)

Pull request description:

  Naming things is hard, naming lock time things is _really_ hard. This is another attempt at improving the very low level types in the `units::locktime` modules.

  Formatting done separately so that the diffs are easier to tab through.

ACKs for top commit:
  apoelstra:
    ACK dca4266; successfully ran local tests

Tree-SHA512: 24d1b0cae3d7f926622177f00aedc50c53164e04f9d400f9c2c009157f36fd1f55ac2d1b70ceb10b0a165130ffe7eef25d64dc6ea5e6f3caec812c39ab0bbd66

Author: apoelstra

bitcoin/src/blockdata/block.rs

@@ -30,9 +30,7 @@ use crate::transaction::{Transaction, TransactionExt as _, Wtxid};
 #[doc(inline)]
 pub use primitives::block::{Block, Checked, Unchecked, Validation, Version, BlockHash, Header, WitnessCommitment};
 #[doc(inline)]
-pub use units::block::{
-    BlockHeight, BlockHeightInterval, TooBigForRelativeBlockHeightIntervalError,
-};
+pub use units::block::{BlockHeight, BlockHeightInterval, TooBigForRelativeHeightError};
 
 #[deprecated(since = "TBD", note = "use `BlockHeightInterval` instead")]
 #[doc(hidden)]

bitcoin/src/blockdata/mod.rs

@@ -41,11 +41,11 @@ pub mod locktime {
 
         /// Re-export everything from the `primitives::locktime::absolute` module.
         #[rustfmt::skip]        // Keep public re-exports separate.
-        pub use primitives::locktime::absolute::{ConversionError, Height, LockTime, ParseHeightError, ParseTimeError, Mtp};
+        pub use primitives::locktime::absolute::{ConversionError, Height, LockTime, ParseHeightError, ParseTimeError, MedianTimePast};
 
-        #[deprecated(since = "TBD", note = "use `Mtp` instead")]
+        #[deprecated(since = "TBD", note = "use `MedianTimePast` instead")]
         #[doc(hidden)]
-        pub type Time = Mtp;
+        pub type Time = MedianTimePast;
 
         impl Encodable for LockTime {
             #[inline]
@@ -71,17 +71,17 @@ pub mod locktime {
 
         /// Re-export everything from the `primitives::locktime::relative` module.
         pub use primitives::locktime::relative::{
-            DisabledLockTimeError, HeightInterval, IncompatibleHeightError, IncompatibleTimeError,
-            LockTime, MtpInterval, TimeOverflowError,
+            DisabledLockTimeError, IncompatibleHeightError, IncompatibleTimeError, LockTime,
+            NumberOf512Seconds, NumberOfBlocks, TimeOverflowError,
         };
 
-        #[deprecated(since = "TBD", note = "use `Mtp` instead")]
+        #[deprecated(since = "TBD", note = "use `NumberOfBlocks` instead")]
         #[doc(hidden)]
-        pub type Height = HeightInterval;
+        pub type Height = NumberOfBlocks;
 
-        #[deprecated(since = "TBD", note = "use `Mtp` instead")]
+        #[deprecated(since = "TBD", note = "use `NumberOf512Seconds` instead")]
         #[doc(hidden)]
-        pub type Time = MtpInterval;
+        pub type Time = NumberOf512Seconds;
     }
 }
 

bitcoin/src/blockdata/transaction.rs

@@ -20,7 +20,7 @@ use primitives::Sequence;
 use super::Weight;
 use crate::consensus::{self, encode, Decodable, Encodable};
 use crate::internal_macros::{impl_consensus_encoding, impl_hashencode};
-use crate::locktime::absolute::{self, Height, Mtp};
+use crate::locktime::absolute::{self, Height, MedianTimePast};
 use crate::prelude::{Borrow, Vec};
 use crate::script::{Script, ScriptBuf, ScriptExt as _, ScriptExtPriv as _};
 #[cfg(doc)]
@@ -295,7 +295,7 @@ pub trait TransactionExt: sealed::Sealed {
     /// By definition if the lock time is not enabled the transaction's absolute timelock is
     /// considered to be satisfied i.e., there are no timelock constraints restricting this
     /// transaction from being mined immediately.
-    fn is_absolute_timelock_satisfied(&self, height: Height, time: Mtp) -> bool;
+    fn is_absolute_timelock_satisfied(&self, height: Height, time: MedianTimePast) -> bool;
 
     /// Returns `true` if this transactions nLockTime is enabled ([BIP-65]).
     ///
@@ -393,7 +393,7 @@ impl TransactionExt for Transaction {
 
     fn is_explicitly_rbf(&self) -> bool { self.input.iter().any(|input| input.sequence.is_rbf()) }
 
-    fn is_absolute_timelock_satisfied(&self, height: Height, time: Mtp) -> bool {
+    fn is_absolute_timelock_satisfied(&self, height: Height, time: MedianTimePast) -> bool {
         if !self.is_lock_time_enabled() {
             return true;
         }

primitives/src/locktime/absolute.rs

@@ -16,11 +16,11 @@ use crate::{absolute, Transaction};
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 #[doc(inline)]
-pub use units::locktime::absolute::{ConversionError, Height, ParseHeightError, ParseTimeError, Mtp, LOCK_TIME_THRESHOLD};
+pub use units::locktime::absolute::{ConversionError, Height, ParseHeightError, ParseTimeError, MedianTimePast, LOCK_TIME_THRESHOLD};
 
-#[deprecated(since = "TBD", note = "use `Mtp` instead")]
+#[deprecated(since = "TBD", note = "use `MedianTimePast` instead")]
 #[doc(hidden)]
-pub type Time = Mtp;
+pub type Time = MedianTimePast;
 
 /// An absolute lock time value, representing either a block height or a UNIX timestamp (seconds
 /// since epoch).
@@ -83,7 +83,7 @@ pub enum LockTime {
     /// assert!(n.is_block_time());
     /// assert_eq!(n.to_consensus_u32(), seconds);
     /// ```
-    Seconds(Mtp),
+    Seconds(MedianTimePast),
 }
 
 impl LockTime {
@@ -147,7 +147,7 @@ impl LockTime {
         if units::locktime::absolute::is_block_height(n) {
             Self::Blocks(Height::from_u32(n).expect("n is valid"))
         } else {
-            Self::Seconds(Mtp::from_u32(n).expect("n is valid"))
+            Self::Seconds(MedianTimePast::from_u32(n).expect("n is valid"))
         }
     }
 
@@ -202,7 +202,7 @@ impl LockTime {
     /// ```
     #[inline]
     pub fn from_mtp(n: u32) -> Result<Self, ConversionError> {
-        let time = Mtp::from_u32(n)?;
+        let time = MedianTimePast::from_u32(n)?;
         Ok(LockTime::Seconds(time))
     }
 
@@ -239,15 +239,15 @@ impl LockTime {
     /// # use bitcoin_primitives::absolute;
     /// // Can be implemented if block chain data is available.
     /// fn get_height() -> absolute::Height { todo!("return the current block height") }
-    /// fn get_time() -> absolute::Mtp { todo!("return the current block time") }
+    /// fn get_time() -> absolute::MedianTimePast { todo!("return the current block time") }
     ///
     /// let n = absolute::LockTime::from_consensus(741521); // `n OP_CHEKCLOCKTIMEVERIFY`.
     /// if n.is_satisfied_by(get_height(), get_time()) {
     ///     // Can create and mine a transaction that satisfies the OP_CLTV timelock constraint.
     /// }
     /// ````
     #[inline]
-    pub fn is_satisfied_by(self, height: Height, time: Mtp) -> bool {
+    pub fn is_satisfied_by(self, height: Height, time: MedianTimePast) -> bool {
         use LockTime as L;
 
         match self {
@@ -333,9 +333,9 @@ impl From<Height> for LockTime {
     fn from(h: Height) -> Self { LockTime::Blocks(h) }
 }
 
-impl From<Mtp> for LockTime {
+impl From<MedianTimePast> for LockTime {
     #[inline]
-    fn from(t: Mtp) -> Self { LockTime::Seconds(t) }
+    fn from(t: MedianTimePast) -> Self { LockTime::Seconds(t) }
 }
 
 impl fmt::Debug for LockTime {
@@ -512,7 +512,7 @@ mod tests {
         let lock_by_height = LockTime::from(height);
 
         let t: u32 = 1_653_195_600; // May 22nd, 5am UTC.
-        let time = Mtp::from_u32(t).unwrap();
+        let time = MedianTimePast::from_u32(t).unwrap();
 
         assert!(!lock_by_height.is_satisfied_by(height_below, time));
         assert!(lock_by_height.is_satisfied_by(height, time));
@@ -521,9 +521,9 @@ mod tests {
 
     #[test]
     fn satisfied_by_time() {
-        let time_before = Mtp::from_u32(1_653_109_200).unwrap(); // "May 21th 2022, 5am UTC.
-        let time = Mtp::from_u32(1_653_195_600).unwrap(); // "May 22nd 2022, 5am UTC.
-        let time_after = Mtp::from_u32(1_653_282_000).unwrap(); // "May 23rd 2022, 5am UTC.
+        let time_before = MedianTimePast::from_u32(1_653_109_200).unwrap(); // "May 21th 2022, 5am UTC.
+        let time = MedianTimePast::from_u32(1_653_195_600).unwrap(); // "May 22nd 2022, 5am UTC.
+        let time_after = MedianTimePast::from_u32(1_653_282_000).unwrap(); // "May 23rd 2022, 5am UTC.
 
         let lock_by_time = LockTime::from(time);