Merge rust-bitcoin#5363: Release tracking PR: units v1.0.0-rc.3

apoelstra · apoelstra · commit a89b52d6a49f · 2025-12-09T17:12:04.000Z
41a9734 Release tracking PR: `units v1.0.0-rc.3` (Tobin C. Harding) 3b70bda units: Pin RC dependency (Tobin C. Harding) d19605c units: Set TBD in deprecate attribute (Tobin C. Harding) e8f1100 units: Stop using deprecated types (Tobin C. Harding) 4abc454 units: Remove deprecated calls in absolute locktime code (Tobin C. Harding) Pull request description: Do another RC round. Added changelog entry for the `Amount` string value separator PR. Bumped version and updated crates that depend on `units` to use it. Updated lock files. Ran: `cargo publish --dry-run -p bitcoin-units` ACKs for top commit: apoelstra: ACK 41a9734; successfully ran local tests Tree-SHA512: 363f52bf5cb79e22c64768a0b7520be90bd016c6cc63df8782de1ad90e5aaf960ee6593b033a6c0650d7b36c4e81902da110a1f6b68f05ea0b5cfd9fffd3034f
diff --git a/Cargo-minimal.lock b/Cargo-minimal.lock
@@ -152,7 +152,7 @@ dependencies = [
 
 [[package]]
 name = "bitcoin-units"
-version = "1.0.0-rc.2"
+version = "1.0.0-rc.3"
 dependencies = [
  "arbitrary",
  "bincode",
diff --git a/Cargo-recent.lock b/Cargo-recent.lock
@@ -151,7 +151,7 @@ dependencies = [
 
 [[package]]
 name = "bitcoin-units"
-version = "1.0.0-rc.2"
+version = "1.0.0-rc.3"
 dependencies = [
  "arbitrary",
  "bincode",
diff --git a/bitcoin/Cargo.toml b/bitcoin/Cargo.toml
@@ -33,7 +33,7 @@ internals = { package = "bitcoin-internals", path = "../internals", version = "0
 io = { package = "bitcoin-io", path = "../io", version = "0.3.0", default-features = false, features = ["alloc", "hashes"] }
 primitives = { package = "bitcoin-primitives", path = "../primitives", version = "1.0.0-rc.0", default-features = false, features = ["alloc", "hex"] }
 secp256k1 = { version = "0.32.0-beta.2", default-features = false, features = ["alloc"] }
-units = { package = "bitcoin-units", path = "../units", version = "1.0.0-rc.2", default-features = false, features = ["alloc"] }
+units = { package = "bitcoin-units", path = "../units", version = "1.0.0-rc.3", default-features = false, features = ["alloc"] }
 
 arbitrary = { version = "1.4.1", optional = true }
 base64 = { version = "0.22.0", optional = true, default-features = false, features = ["alloc"] }
diff --git a/p2p/Cargo.toml b/p2p/Cargo.toml
@@ -24,7 +24,7 @@ hashes = { package = "bitcoin_hashes", version = "0.18.0", path = "../hashes", d
 hex = { package = "hex-conservative", version = "0.3.0", default-features = false }
 internals = { package = "bitcoin-internals", path = "../internals", default-features = false }
 io = { package = "bitcoin-io", path = "../io", default-features = false }
-units = { package = "bitcoin-units", path = "../units", version = "1.0.0-rc.2", default-features = false }
+units = { package = "bitcoin-units", path = "../units", version = "1.0.0-rc.3", default-features = false }
 
 arbitrary = { version = "1.4.1", optional = true }
 
diff --git a/primitives/Cargo.toml b/primitives/Cargo.toml
@@ -24,7 +24,7 @@ hex = ["dep:hex-stable", "dep:hex-unstable", "hashes/hex", "internals/hex"]
 encoding = { package = "bitcoin-consensus-encoding", path = "../consensus_encoding", version = "1.0.0-rc.1", default-features = false }
 hashes = { package = "bitcoin_hashes", path = "../hashes", version = "0.18.0", default-features = false }
 internals = { package = "bitcoin-internals", path = "../internals", version = "0.4.1" }
-units = { package = "bitcoin-units", path = "../units", version = "1.0.0-rc.2", default-features = false, features = [ "encoding" ] }
+units = { package = "bitcoin-units", path = "../units", version = "1.0.0-rc.3", default-features = false, features = [ "encoding" ] }
 arrayvec = { version = "0.7.2", default-features = false }
 
 arbitrary = { version = "1.4.1", optional = true }
diff --git a/units/CHANGELOG.md b/units/CHANGELOG.md
@@ -7,6 +7,7 @@ This changelog is a rolling description of everything that will eventually end u
 * Introduce limit to `Amount`
   * Prepare to enforce `MAX_MONEY` invariant [#4164](https://github.com/rust-bitcoin/rust-bitcoin/pull/4164)
   * Enforce `MAX_MONEY` invariant in amount types [#4157](https://github.com/rust-bitcoin/rust-bitcoin/pull/4157)
+* Allow underscores as separators in `Amount` values [#5309](https://github.com/rust-bitcoin/rust-bitcoin/pull/5309)
 * New `NumOpResult` type
   * Introduce monadic `NumOpResult` type [#4007](https://github.com/rust-bitcoin/rust-bitcoin/pull/4007)
   * Add impls for `NumOpResult` div and mul [#4337](https://github.com/rust-bitcoin/rust-bitcoin/pull/4337)
diff --git a/units/Cargo.toml b/units/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bitcoin-units"
-version = "1.0.0-rc.2"
+version = "1.0.0-rc.3"
 authors = ["Andrew Poelstra <apoelstra@wpsoftware.net>", "Tobin C. Harding <me@tobin.cc>"]
 license = "CC0-1.0"
 repository = "https://github.com/rust-bitcoin/rust-bitcoin/"
@@ -18,7 +18,7 @@ std = ["alloc", "internals/std", "encoding?/std"]
 alloc = ["internals/alloc", "serde?/alloc", "encoding?/alloc"]
 
 [dependencies]
-encoding = { package = "bitcoin-consensus-encoding", path = "../consensus_encoding", version = "1.0.0-rc.2", default-features = false, optional = true }
+encoding = { package = "bitcoin-consensus-encoding", path = "../consensus_encoding", version = "=1.0.0-rc.2", default-features = false, optional = true }
 internals = { package = "bitcoin-internals", path = "../internals", version = "0.4.1" }
 
 serde = { version = "1.0.195", default-features = false, features = ["derive"], optional = true }
diff --git a/units/src/amount/signed.rs b/units/src/amount/signed.rs
@@ -360,7 +360,7 @@ impl SignedAmount {
     ///
     /// Returns [`None`] if overflow occurred. (`self == i64::MIN`)
     #[must_use]
-    #[deprecated(since = "TBD", note = "Never returns none, use `abs()` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "Never returns none, use `abs()` instead")]
     #[allow(clippy::unnecessary_wraps)] // To match stdlib function definition.
     pub const fn checked_abs(self) -> Option<Self> { Some(self.abs()) }
 
diff --git a/units/src/fee_rate/mod.rs b/units/src/fee_rate/mod.rs
@@ -190,7 +190,7 @@ impl FeeRate {
     ///
     /// This is equivalent to `Self::mul_by_weight(weight).ok()`.
     #[must_use]
-    #[deprecated(since = "TBD", note = "use `to_fee()` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `to_fee()` instead")]
     pub fn fee_wu(self, weight: Weight) -> Option<Amount> { self.mul_by_weight(weight).ok() }
 
     /// Calculates the fee by multiplying this fee rate by weight, in virtual bytes, returning [`None`]
@@ -199,7 +199,7 @@ impl FeeRate {
     /// This is equivalent to converting `vb` to [`Weight`] using [`Weight::from_vb`] and then calling
     /// [`Self::to_fee`].
     #[must_use]
-    #[deprecated(since = "TBD", note = "use Weight::from_vb and then `to_fee()` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use Weight::from_vb and then `to_fee()` instead")]
     pub fn fee_vb(self, vb: u64) -> Option<Amount> { Weight::from_vb(vb).map(|w| self.to_fee(w)) }
 
     /// Checked weight multiplication.
diff --git a/units/src/lib.rs b/units/src/lib.rs
@@ -66,6 +66,6 @@ pub use self::{
     weight::Weight
 };
 
-#[deprecated(since = "TBD", note = "use `BlockHeightInterval` instead")]
+#[deprecated(since = "1.0.0-rc.0", note = "use `BlockHeightInterval` instead")]
 #[doc(hidden)]
 pub type BlockInterval = BlockHeightInterval;
diff --git a/units/src/locktime/absolute/mod.rs b/units/src/locktime/absolute/mod.rs
@@ -208,7 +208,7 @@ impl LockTime {
     }
 
     #[inline]
-    #[deprecated(since = "TBD", note = "use `from_mtp` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `from_mtp` instead")]
     #[doc(hidden)]
     pub fn from_time(n: u32) -> Result<Self, ConversionError> { Self::from_mtp(n) }
 
@@ -543,11 +543,11 @@ impl Height {
     /// If the input string is not a valid hex representation of a block height.
     pub fn from_hex(s: &str) -> Result<Self, ParseHeightError> { parse_hex(s, Self::from_u32) }
 
-    #[deprecated(since = "TBD", note = "use `from_u32` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `from_u32` instead")]
     #[doc(hidden)]
     pub const fn from_consensus(n: u32) -> Result<Self, ConversionError> { Self::from_u32(n) }
 
-    #[deprecated(since = "TBD", note = "use `to_u32` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `to_u32` instead")]
     #[doc(hidden)]
     pub const fn to_consensus_u32(self) -> u32 { self.to_u32() }
 
@@ -607,7 +607,7 @@ impl fmt::Display for Height {
 
 parse_int::impl_parse_str!(Height, ParseHeightError, parser(Height::from_u32));
 
-#[deprecated(since = "TBD", note = "use `MedianTimePast` instead")]
+#[deprecated(since = "1.0.0-rc.0", note = "use `MedianTimePast` instead")]
 #[doc(hidden)]
 pub type Time = MedianTimePast;
 
@@ -655,11 +655,11 @@ impl MedianTimePast {
     /// If the input string is not a valid hex representation of a block time.
     pub fn from_hex(s: &str) -> Result<Self, ParseTimeError> { parse_hex(s, Self::from_u32) }
 
-    #[deprecated(since = "TBD", note = "use `from_u32` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `from_u32` instead")]
     #[doc(hidden)]
     pub const fn from_consensus(n: u32) -> Result<Self, ConversionError> { Self::from_u32(n) }
 
-    #[deprecated(since = "TBD", note = "use `to_u32` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `to_u32` instead")]
     #[doc(hidden)]
     pub const fn to_consensus_u32(self) -> u32 { self.to_u32() }
 
diff --git a/units/src/locktime/relative/mod.rs b/units/src/locktime/relative/mod.rs
@@ -400,7 +400,7 @@ impl<'de> serde::Deserialize<'de> for LockTime {
     }
 }
 
-#[deprecated(since = "TBD", note = "use `NumberOfBlocks` instead")]
+#[deprecated(since = "1.0.0-rc.0", note = "use `NumberOfBlocks` instead")]
 #[doc(hidden)]
 pub type Height = NumberOfBlocks;
 
@@ -430,14 +430,14 @@ impl NumberOfBlocks {
     /// Returns the inner `u16` value.
     #[inline]
     #[must_use]
-    #[deprecated(since = "TBD", note = "use `to_height` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `to_height` instead")]
     #[doc(hidden)]
     pub const fn value(self) -> u16 { self.0 }
 
     /// Returns the `u32` value used to encode this locktime in an nSequence field or
     /// argument to `OP_CHECKSEQUENCEVERIFY`.
     #[deprecated(
-        since = "TBD",
+        since = "1.0.0-rc.0",
         note = "use `LockTime::from` followed by `to_consensus_u32` instead"
     )]
     pub const fn to_consensus_u32(self) -> u32 {
@@ -479,7 +479,7 @@ impl fmt::Display for NumberOfBlocks {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Display::fmt(&self.0, f) }
 }
 
-#[deprecated(since = "TBD", note = "use `NumberOf512Seconds` instead")]
+#[deprecated(since = "1.0.0-rc.0", note = "use `NumberOf512Seconds` instead")]
 #[doc(hidden)]
 pub type Time = NumberOf512Seconds;
 
@@ -552,14 +552,14 @@ impl NumberOf512Seconds {
     /// Returns the inner `u16` value.
     #[inline]
     #[must_use]
-    #[deprecated(since = "TBD", note = "use `to_512_second_intervals` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `to_512_second_intervals` instead")]
     #[doc(hidden)]
     pub const fn value(self) -> u16 { self.0 }
 
     /// Returns the `u32` value used to encode this locktime in an nSequence field or
     /// argument to `OP_CHECKSEQUENCEVERIFY`.
     #[deprecated(
-        since = "TBD",
+        since = "1.0.0-rc.0",
         note = "use `LockTime::from` followed by `to_consensus_u32` instead"
     )]
     pub const fn to_consensus_u32(self) -> u32 {
@@ -866,10 +866,10 @@ mod tests {
     #[test]
     #[allow(deprecated_in_future)]
     fn sanity_check() {
-        assert_eq!(NumberOfBlocks::MAX.to_consensus_u32(), u32::from(u16::MAX));
-        assert_eq!(NumberOf512Seconds::from_512_second_intervals(100).value(), 100u16);
+        assert_eq!(LockTime::from(NumberOfBlocks::MAX).to_consensus_u32(), u32::from(u16::MAX));
+        assert_eq!(NumberOf512Seconds::from_512_second_intervals(100).to_512_second_intervals(), 100u16);
         assert_eq!(
-            NumberOf512Seconds::from_512_second_intervals(100).to_consensus_u32(),
+            LockTime::from(NumberOf512Seconds::from_512_second_intervals(100)).to_consensus_u32(),
             4_194_404u32
         ); // 0x400064
         assert_eq!(NumberOf512Seconds::from_512_second_intervals(1).to_seconds(), 512);
diff --git a/units/src/sequence.rs b/units/src/sequence.rs
@@ -50,7 +50,7 @@ impl Sequence {
     pub const ENABLE_LOCKTIME_NO_RBF: Self = Self::MIN_NO_RBF;
     /// The sequence number that enables replace-by-fee and absolute lock time but
     /// disables relative lock time.
-    #[deprecated(since = "TBD", note = "use `ENABLE_LOCKTIME_AND_RBF` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `ENABLE_LOCKTIME_AND_RBF` instead")]
     pub const ENABLE_RBF_NO_LOCKTIME: Self = Self(0xFFFF_FFFD);
     /// The maximum sequence number that enables replace-by-fee and absolute lock time but
     /// disables relative lock time.
@@ -203,7 +203,7 @@ impl Sequence {
     /// Gets the hex representation of this [`Sequence`].
     #[cfg(feature = "alloc")]
     #[inline]
-    #[deprecated(since = "TBD", note = "use `format!(\"{var:x}\")` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `format!(\"{var:x}\")` instead")]
     pub fn to_hex(self) -> alloc::string::String { alloc::format!("{:x}", self) }
 
     /// Constructs a new [`relative::LockTime`] from this [`Sequence`] number.
diff --git a/units/src/weight.rs b/units/src/weight.rs
@@ -82,7 +82,7 @@ impl Weight {
     /// # Panics
     ///
     /// If the conversion from virtual bytes overflows.
-    #[deprecated(since = "TBD", note = "use `from_vb_unchecked` instead")]
+    #[deprecated(since = "1.0.0-rc.0", note = "use `from_vb_unchecked` instead")]
     pub const fn from_vb_unwrap(vb: u64) -> Self {
         match vb.checked_mul(Self::WITNESS_SCALE_FACTOR) {
             Some(weight) => Self::from_wu(weight),
@@ -96,15 +96,15 @@ impl Weight {
     }
 
     /// Constructs a new [`Weight`] from witness size.
-    #[deprecated(since = "TBD", note = "use `from_wu` instead")]
+    #[deprecated(since = "1.0.0-rc.1", note = "use `from_wu` instead")]
     pub const fn from_witness_data_size(witness_size: u64) -> Self { Self::from_wu(witness_size) }
 
     /// Constructs a new [`Weight`] from non-witness size.
     ///
     /// # Panics
     ///
     /// If the conversion from virtual bytes overflows.
-    #[deprecated(since = "TBD", note = "use `from_vb` or `from_vb_unchecked` instead")]
+    #[deprecated(since = "1.0.0-rc.1", note = "use `from_vb` or `from_vb_unchecked` instead")]
     pub const fn from_non_witness_data_size(non_witness_size: u64) -> Self {
         Self::from_wu(non_witness_size * Self::WITNESS_SCALE_FACTOR)
     }
diff --git a/units/tests/api.rs b/units/tests/api.rs
@@ -158,7 +158,7 @@ fn api_can_use_modules_from_crate_root() {
 #[test]
 fn api_can_use_types_from_crate_root() {
     use bitcoin_units::{
-        Amount, BlockHeight, BlockHeightInterval, BlockInterval, BlockMtp, BlockMtpInterval,
+        Amount, BlockHeight, BlockHeightInterval, BlockMtp, BlockMtpInterval,
         BlockTime, FeeRate, NumOpResult, SignedAmount, Weight,
     };
 }
@@ -210,8 +210,7 @@ fn api_can_use_all_types_from_module_locktime_relative() {
         InvalidHeightError as _, InvalidTimeError as _, TimeOverflowError as _,
     };
     use bitcoin_units::locktime::relative::{
-        Height, InvalidHeightError, InvalidTimeError, NumberOf512Seconds, NumberOfBlocks, Time,
-        TimeOverflowError,
+        InvalidHeightError, InvalidTimeError, NumberOf512Seconds, NumberOfBlocks, TimeOverflowError,
     };
 }
 
diff --git a/units/tests/serde.rs b/units/tests/serde.rs
@@ -7,7 +7,7 @@
 
 use bincode::serialize;
 use bitcoin_units::{
-    amount, fee_rate, Amount, BlockHeight, BlockInterval, FeeRate, SignedAmount, Weight,
+    amount, fee_rate, Amount, BlockHeight, BlockHeightInterval, FeeRate, SignedAmount, Weight,
 };
 use serde::{Deserialize, Serialize};
 
@@ -46,7 +46,7 @@ struct Serde {
     opt_kwu: Option<FeeRate>,
 
     a: BlockHeight,
-    b: BlockInterval,
+    b: BlockHeightInterval,
     c: Weight,
 }
 
@@ -75,7 +75,7 @@ impl Serde {
             opt_kwu: Some(FeeRate::BROADCAST_MIN),
 
             a: BlockHeight::MAX,
-            b: BlockInterval::MAX,
+            b: BlockHeightInterval::MAX,
             c: Weight::MAX,
         }
     }
diff --git a/units/tests/str.rs b/units/tests/str.rs
@@ -4,7 +4,7 @@
 
 use bitcoin_units::amount::Denomination;
 use bitcoin_units::locktime::{absolute, relative};
-use bitcoin_units::{Amount, BlockHeight, BlockInterval, SignedAmount, Weight};
+use bitcoin_units::{Amount, BlockHeight, BlockHeightInterval, SignedAmount, Weight};
 
 macro_rules! check {
     ($($test_name:ident, $ty:path, $val:path, $str:literal);* $(;)?) => {
@@ -34,8 +34,8 @@ check! {
     block_height_min, BlockHeight, BlockHeight::MIN, "0";
     block_height_max, BlockHeight, BlockHeight::MAX, "4294967295";
 
-    block_interval_min, BlockInterval, BlockInterval::MIN, "0";
-    block_interval_max, BlockInterval, BlockInterval::MAX, "4294967295";
+    block_interval_min, BlockHeightInterval, BlockHeightInterval::MIN, "0";
+    block_interval_max, BlockHeightInterval, BlockHeightInterval::MAX, "4294967295";
 
     lock_by_height_absolute_min, absolute::Height, absolute::Height::MIN, "0";
     lock_by_height_absolute_max, absolute::Height, absolute::Height::MAX, "499999999";
