Merge rust-bitcoin#4686: Move locktime and sequence to units

029d5c6 units: Add Errors section to rustdocs (Tobin C. Harding)
fa0c968 Move locktime and sequence code to units (Tobin C. Harding)
d20e586 Introduce error modules to locktime (Tobin C. Harding)
fe62307 Move non-pub import into correct place (Tobin C. Harding)
33ac206 Move locktimes to module directories (Tobin C. Harding)
5f3d3a5 Remove Transaction links from sequence docs (Tobin C. Harding)
19e54ee Remove links to TxIn from locktime docs (Tobin C. Harding)
48961dd Remove Transaction links from locktime docs (Tobin C. Harding)

Pull request description:

  In hindsight `units` is a better place for locktimes. `relative` locktime needs `Sequence`.
  
  Move all that over to `units`.
  
  - Patch 1-5 are preparatory cleanup
  - Patch 6 creates public `error` modules as discussed and implemented for `amount` in rust-bitcoin#4683
  - Patch 7 does the actual move
  - Patch 8 does docs fixes because we lint harder in `units` than `primitives`
  
  Close: rust-bitcoin#4678


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


Tree-SHA512: b66786524c9df5b1f048cec6a337016d64e09bc4579f68d2ba4d2e989f9977feac36e2dbc38a725542b9051194379471a1374a60c962c6781f5aa73b4f61861a

Author: apoelstra

bitcoin/src/blockdata/mod.rs

@@ -39,9 +39,9 @@ pub mod locktime {
 
         pub use crate::consensus::encode::{self, Decodable, Encodable};
 
-        /// Re-export everything from the `primitives::locktime::absolute` module.
+        /// Re-export everything from the `units::locktime::absolute` module.
         #[rustfmt::skip]        // Keep public re-exports separate.
-        pub use primitives::locktime::absolute::{ConversionError, Height, LockTime, ParseHeightError, ParseTimeError, MedianTimePast};
+        pub use units::locktime::absolute::{ConversionError, Height, LockTime, ParseHeightError, ParseTimeError, MedianTimePast};
 
         #[deprecated(since = "TBD", note = "use `MedianTimePast` instead")]
         #[doc(hidden)]
@@ -69,8 +69,8 @@ pub mod locktime {
         //! There are two types of lock time: lock-by-height and lock-by-time, distinguished by
         //! whether bit 22 of the `u32` consensus value is set.
 
-        /// Re-export everything from the `primitives::locktime::relative` module.
-        pub use primitives::locktime::relative::{
+        /// Re-export everything from the `units::locktime::relative` module.
+        pub use units::locktime::relative::{
             DisabledLockTimeError, InvalidHeightError, InvalidTimeError, LockTime,
             NumberOf512Seconds, NumberOfBlocks, TimeOverflowError,
         };

primitives/src/lib.rs

@@ -38,13 +38,11 @@ pub mod _export {
 }
 
 pub mod block;
-pub mod locktime;
 pub mod merkle_tree;
 mod opcodes;
 pub mod pow;
 #[cfg(feature = "alloc")]
 pub mod script;
-pub mod sequence;
 pub mod transaction;
 #[cfg(feature = "alloc")]
 pub mod witness;
@@ -54,6 +52,8 @@ pub use units::{
     amount::{self, Amount, SignedAmount},
     block::{BlockHeight, BlockHeightInterval, BlockMtp, BlockMtpInterval},
     fee_rate::{self, FeeRate},
+    locktime::{self, absolute, relative},
+    sequence::{self, Sequence},
     time::{self, BlockTime},
     weight::{self, Weight},
 };
@@ -75,10 +75,8 @@ pub use self::{
 #[doc(inline)]
 pub use self::{
     block::{BlockHash, Header as BlockHeader, Version as BlockVersion, WitnessCommitment},
-    locktime::{absolute, relative},
     merkle_tree::{TxMerkleNode, WitnessMerkleNode},
     pow::CompactTarget,
-    sequence::Sequence,
     transaction::{OutPoint, Txid, Version as TransactionVersion, Wtxid},
 };
 

primitives/src/locktime/mod.rs

@@ -24,20 +24,20 @@ use hashes::sha256d;
 use internals::compact_size;
 #[cfg(feature = "hex")]
 use internals::write_err;
+#[cfg(feature = "alloc")]
+use units::locktime::absolute;
 #[cfg(feature = "hex")]
 use units::parse;
 #[cfg(feature = "alloc")]
+use units::sequence::Sequence;
+#[cfg(feature = "alloc")]
 use units::{Amount, Weight};
 
-#[cfg(feature = "alloc")]
-use crate::locktime::absolute;
 #[cfg(feature = "alloc")]
 use crate::prelude::Vec;
 #[cfg(feature = "alloc")]
 use crate::script::ScriptBuf;
 #[cfg(feature = "alloc")]
-use crate::sequence::Sequence;
-#[cfg(feature = "alloc")]
 use crate::witness::Witness;
 
 /// Bitcoin transaction.

primitives/src/transaction.rs

@@ -163,10 +163,10 @@ struct Default {
 #[derive(Debug, Clone, PartialEq, Eq)] // All public types implement Debug (C-DEBUG).
 struct Errors {
     a: transaction::ParseOutPointError,
-    b: relative::DisabledLockTimeError,
-    c: relative::IsSatisfiedByError,
-    d: relative::IsSatisfiedByHeightError,
-    e: relative::IsSatisfiedByTimeError,
+    b: relative::error::DisabledLockTimeError,
+    c: relative::error::IsSatisfiedByError,
+    d: relative::error::IsSatisfiedByHeightError,
+    e: relative::error::IsSatisfiedByTimeError,
     f: script::RedeemScriptSizeError,
     g: script::WitnessScriptSizeError,
 }
@@ -209,9 +209,10 @@ fn api_can_use_types_from_crate_root() {
 
 #[test]
 fn api_can_use_all_types_from_module_locktime() {
-    use bitcoin_primitives::locktime::relative::{
-        DisabledLockTimeError, InvalidHeightError, InvalidTimeError, LockTime,
+    use bitcoin_primitives::locktime::relative::error::{
+        DisabledLockTimeError, InvalidHeightError, InvalidTimeError,
     };
+    use bitcoin_primitives::locktime::relative::LockTime;
     use bitcoin_primitives::locktime::{absolute, relative};
 }
 

primitives/tests/api.rs

@@ -20,7 +20,7 @@ alloc = ["internals/alloc","serde?/alloc"]
 [dependencies]
 internals = { package = "bitcoin-internals", path = "../internals", version = "0.4.0" }
 
-serde = { version = "1.0.103", default-features = false, optional = true }
+serde = { version = "1.0.103", default-features = false, features = ["derive"], optional = true }
 arbitrary = { version = "1.4", optional = true }
 
 [dev-dependencies]

units/Cargo.toml

@@ -51,6 +51,7 @@ pub mod fee;
 pub mod fee_rate;
 pub mod locktime;
 pub mod parse;
+pub mod sequence;
 pub mod time;
 pub mod weight;
 
@@ -60,7 +61,9 @@ pub use self::{
     amount::{Amount, SignedAmount},
     block::{BlockHeight, BlockHeightInterval, BlockMtp, BlockMtpInterval},
     fee_rate::FeeRate,
+    locktime::{absolute, relative},
     result::{NumOpError, NumOpResult, MathOp},
+    sequence::Sequence,
     time::BlockTime,
     weight::Weight
 };