braidpool · Sansh2356 · Apr 26, 2025 · Apr 24, 2025 · Apr 26, 2025 · Apr 26, 2025
diff --git a/.actrc b/.actrc
diff --git a/.cargo/mutants.toml b/.cargo/mutants.toml
@@ -4,12 +4,13 @@ exclude_globs = [
     "units/src/amount/verification.rs" # kani tests
 ]
 exclude_re = [
-    "impl Debug",
     "impl Arbitrary",
-    "impl Display",
+    "impl Debug",
+    "impl fmt::Debug",
     ".*Error",
     "deserialize", # Skip serde mutation tests
     "Iterator", # Mutating operations in an iterator can result in an infinite loop
+    "match arm", "match guard", # New addition in cargo-mutants 25.0.1 deletes match arms and replaces match guards even in excluded functions
 
     # ----------------------------------Crate-specific exclusions----------------------------------
     # Units
@@ -21,6 +22,9 @@ exclude_re = [
     "Time::to_consensus_u32", # Mutant from replacing | with ^, this returns the same value since the XOR is taken against the u16 with an all-zero bitmask
     "FeeRate::fee_vb", # Deprecated
     "FeeRate::fee_wu", # Deprecated
+    "SignedAmount::checked_abs", # Deprecated
+    "NumberOfBlocks::value", # Deprecated
+    "NumberOf512Seconds::to_consensus_u32", # Deprecated
 
     # primitives
     "Sequence::from_512_second_intervals", # Mutant from replacing | with ^, this returns the same value since the XOR is taken against the u16 with an all-zero bitmask

diff --git a/.github/workflows/cargo-semver-checks-version b/.github/workflows/cargo-semver-checks-version
@@ -1 +1 @@
-0.40.0
+0.41.0
diff --git a/.github/workflows/cron-daily-fuzz.yml b/.github/workflows/cron-daily-fuzz.yml
@@ -27,6 +27,7 @@ jobs:
           bitcoin_deserialize_witness,
           bitcoin_deser_net_msg,
           bitcoin_outpoint_string,
+          bitcoin_p2p_address_roundtrip,
           bitcoin_script_bytes_to_asm_fmt,
           hashes_json,
           hashes_ripemd160,

diff --git a/.github/workflows/cron-weekly-rustfmt.yml b/.github/workflows/cron-weekly-rustfmt.yml
@@ -13,7 +13,8 @@ jobs:
         with:
           components: rustfmt
       - name: Run Nightly rustfmt
-        run: cargo +nightly fmt
+        # Run the formatter and manually remove trailing whitespace.
+        run: cargo +nightly fmt && find . -type f -name '*.rs' -exec sed -i 's/ $//' {} \;
       - name: Get the current date
         run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_ENV
       - name: Create Pull Request

diff --git a/.github/workflows/stable-version b/.github/workflows/stable-version
@@ -1 +1 @@
-1.85.1
+1.87.0
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,6 +16,7 @@ changes to this document in a pull request.
 - [Contribution workflow](#contribution-workflow)
   * [Preparing PRs](#preparing-prs)
   * [Peer review](#peer-review)
+  * [CI and Merging](#merging)
   * [Repository maintainers](#repository-maintainers)
 - [Coding conventions](#coding-conventions)
   * [Naming conventions](#naming-conventions)
@@ -145,23 +146,20 @@ test out the patch set and opine on the technical merits of the patch. Please,
 first review PR on the conceptual level before focusing on code style or
 grammar fixes.
 
-### API changes
-
-The API of the following crates is almost stable. Changing it is supposed to be non-trivial. To
-assist in this effort ll PRs that change the public API of any these crates must include a patch to
-the `api/` text files. This should be a separate final patch to the PR that is the diff created by
-running `just check-api`.
+### CI and Merging
 
-- `hashes`
-- `io`
-- `primitives`
-- `units`
+We use GitHub for CI as well to test the final state of each PR.
 
-Check the [API text files](api/README.md) for more information
-on how to install the dependencies and create the text files.
+Also we use a local CI box which runs a large matrix of feature combinations as
+well as testing each patch in a PR. This box is often very backlogged, sometimes
+by multiple days. Please be patient, we will get to merging your PRs when the
+backlog clears.
 
 ### Repository maintainers
 
+Like all open source projects our maintainers are busy. Please take it easy on
+them and only bump if you get no response for a week or two.
+
 Pull request merge requirements:
 - all CI test should pass,
 - at least one "accepts"/ACKs from the repository maintainers
@@ -421,7 +419,7 @@ hacking on this codebase. Consider the following format, not all sections will b
 ///
 /// ### Relevant BIPs
 ///
-/// * [BIP X - FooBar in Bitcoin](https://github.com/bitcoin/bips/blob/master/bip-0000.mediawiki)
+/// * [BIP X - FooBar in Bitcoin](https://github.com/bitcoin/bips/blob/master/bip-0001.mediawiki)
 pub struct FooBar {
     /// The version in use.
     pub version: Version

diff --git a/Cargo-minimal.lock b/Cargo-minimal.lock
@@ -106,11 +106,16 @@ dependencies = [
  "bitcoin_hashes 0.16.0",
 ]
 
+[[package]]
+name = "bitcoin-p2p-messages"
+version = "0.1.0"
+
 [[package]]
 name = "bitcoin-primitives"
 version = "0.101.0"
 dependencies = [
  "arbitrary",
+ "arrayvec",
  "bincode",
  "bitcoin-internals",
  "bitcoin-units",
@@ -149,7 +154,6 @@ dependencies = [
  "bitcoin-internals",
  "hex-conservative 0.3.0",
  "serde",
- "serde_json",
  "serde_test",
 ]
 
@@ -182,7 +186,7 @@ checksum = "d4c819a1287eb618df47cc647173c5c4c66ba19d888a6e50d605672aed3140de"
 
 [[package]]
 name = "chacha20-poly1305"
-version = "0.1.1"
+version = "0.1.2"
 dependencies = [
  "hex-conservative 0.3.0",
 ]
@@ -214,6 +218,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "4afe881d0527571892c4034822e59bb10c6c991cce6abe8199b6f5cf10766f55"
 dependencies = [
  "arrayvec",
+ "serde",
 ]
 
 [[package]]

diff --git a/Cargo-recent.lock b/Cargo-recent.lock
@@ -105,11 +105,16 @@ dependencies = [
  "bitcoin_hashes 0.16.0",
 ]
 
+[[package]]
+name = "bitcoin-p2p-messages"
+version = "0.1.0"
+
 [[package]]
 name = "bitcoin-primitives"
 version = "0.101.0"
 dependencies = [
  "arbitrary",
+ "arrayvec",
  "bincode",
  "bitcoin-internals",
  "bitcoin-units",
@@ -148,7 +153,6 @@ dependencies = [
  "bitcoin-internals",
  "hex-conservative 0.3.0",
  "serde",
- "serde_json",
  "serde_test",
 ]
 
@@ -184,7 +188,7 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
 [[package]]
 name = "chacha20-poly1305"
-version = "0.1.1"
+version = "0.1.2"
 dependencies = [
  "hex-conservative 0.3.0",
 ]
@@ -216,6 +220,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "4afe881d0527571892c4034822e59bb10c6c991cce6abe8199b6f5cf10766f55"
 dependencies = [
  "arrayvec",
+ "serde",
 ]
 
 [[package]]

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,27 +1,9 @@
 [workspace]
-members = ["addresses", "base58", "bitcoin", "chacha20_poly1305", "fuzz", "hashes", "internals", "io", "primitives", "units"]
+members = ["addresses", "base58", "bitcoin", "chacha20_poly1305", "fuzz", "hashes", "internals", "io", "p2p", "primitives", "units"]
 resolver = "2"
 
-[patch.crates-io.bitcoin-addresses]
-path = "addresses"
-
-[patch.crates-io.base58ck]
-path = "base58"
-
-[patch.crates-io.bitcoin]
-path = "bitcoin"
-
+# Keep this patch for hashes because secp256k1 depends on bitcoin-hashes via crates.io
+# This allows testing changes to hashes with secp256k1
+# See https://github.com/rust-bitcoin/rust-bitcoin/pull/4284#pullrequestreview-2714442229
 [patch.crates-io.bitcoin_hashes]
 path = "hashes"
-
-[patch.crates-io.bitcoin-internals]
-path = "internals"
-
-[patch.crates-io.bitcoin-io]
-path = "io"
-
-[patch.crates-io.bitcoin-primitives]
-path = "primitives"
-
-[patch.crates-io.bitcoin-units]
-path = "units"
diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ trustworthiness of each of your dependencies, including this one.
 This library **must not** be used for consensus code (i.e. fully validating blockchain data). It
 technically supports doing this, but doing so is very ill-advised because there are many deviations,
 known and unknown, between this library and the Bitcoin Core reference implementation. In a
-consensus based cryptocurrency such as Bitcoin it is critical that all parties are using the same
+consensus based cryptocurrency, such as Bitcoin, it is critical that all parties are using the same
 rules to validate data, and this library is simply unable to implement the same rules as Core.
 
 Given the complexity of both C++ and Rust, it is unlikely that this will ever be fixed, and there
@@ -68,11 +68,11 @@ and to expand on existing docs would be extremely appreciated.
 
 Contributions are generally welcome. If you intend to make larger changes please discuss them in an
 issue before PRing them to avoid duplicate work and architectural mismatches. If you have any
-questions or ideas you want to discuss please join us in
+questions or ideas you want to discuss, please join us in
 [#bitcoin-rust](https://web.libera.chat/?channel=#bitcoin-rust) on
 [libera.chat](https://libera.chat).
 
-For more information please see [`CONTRIBUTING.md`](./CONTRIBUTING.md).
+For more information, please see [`CONTRIBUTING.md`](./CONTRIBUTING.md).
 
 ## Minimum Supported Rust Version (MSRV)
 
@@ -83,7 +83,7 @@ Use `Cargo-minimal.lock` to build the MSRV by copying to `Cargo.lock` and buildi
 ## External dependencies
 
 We integrate with a few external libraries, most notably `serde`. These
-are available via feature flags. To ensure compatibility and MSRV stability we
+are available via feature flags. To ensure compatibility and MSRV stability, we
 provide two lock files as a means of inspecting compatible versions:
 `Cargo-minimal.lock` containing minimal versions of dependencies and
 `Cargo-recent.lock` containing recent versions of dependencies tested in our CI.
@@ -152,8 +152,8 @@ developers, especially new contributors looking for something to work on, we do:
 - Mutation testing with [`cargo-mutants`](https://github.com/sourcefrog/cargo-mutants)
 - Code verification with [`Kani`](https://github.com/model-checking/kani)
 
-There are always more tests to write and more bugs to find, contributions to our testing efforts
-extremely welcomed. Please consider testing code a first class citizen, we definitely do take PRs
+There are always more tests to write and more bugs to find. PRs are extremely welcomed.
+Please consider testing code as a first-class citizen. We definitely do take PRs
 improving and cleaning up test code.
 
 ### Unit/Integration tests
@@ -178,7 +178,7 @@ We have started using [kani](https://github.com/model-checking/kani), install wi
 
 ## Pull Requests
 
-Every PR needs at least two reviews to get merged. During the review phase maintainers and
+Every PR needs at least two reviews to get merged. During the review phase, maintainers and
 contributors are likely to leave comments and request changes. Please try to address them, otherwise
 your PR might get closed without merging after a longer time of inactivity. If your PR isn't ready
 for review yet please mark it by prefixing the title with `WIP: `.
@@ -201,7 +201,7 @@ to your githooks folder or run `just githooks-install` to copy them all.
 
 Since the altcoin landscape includes projects which [frequently appear and disappear, and are poorly
 designed anyway](https://download.wpsoftware.net/bitcoin/alts.pdf) we do not support any altcoins.
-Supporting Bitcoin properly is already difficult enough and we do not want to increase the
+Supporting Bitcoin properly is already difficult enough, and we do not want to increase the
 maintenance burden and decrease API stability by adding support for other coins.
 
 Our code is public domain so by all means fork it and go wild :)

diff --git a/addresses/src/lib.rs b/addresses/src/lib.rs
@@ -21,6 +21,7 @@
 // Exclude lints we don't think are valuable.
 #![allow(clippy::needless_question_mark)] // https://github.com/rust-bitcoin/rust-bitcoin/pull/2134
 #![allow(clippy::manual_range_contains)] // More readable than clippy's format.
+#![allow(clippy::uninlined_format_args)] // Allow `format!("{}", x)`instead of enforcing `format!("{x}")`
 
 extern crate alloc;
 

diff --git a/base58/Cargo.toml b/base58/Cargo.toml
@@ -18,8 +18,8 @@ std = ["alloc", "hashes/std", "internals/std"]
 alloc = ["hashes/alloc", "internals/alloc"]
 
 [dependencies]
-hashes = { package = "bitcoin_hashes", version = "0.16.0", default-features = false }
-internals = { package = "bitcoin-internals", version = "0.4.0" }
+hashes = { package = "bitcoin_hashes", path = "../hashes", default-features = false }
+internals = { package = "bitcoin-internals", path = "../internals" }
 
 [dev-dependencies]
 hex = { package = "hex-conservative", version = "0.3.0", default-features = false, features = ["alloc"] }

diff --git a/base58/src/error.rs b/base58/src/error.rs
@@ -141,7 +141,7 @@ impl fmt::Display for TooShortError {
 #[cfg(feature = "std")]
 impl std::error::Error for TooShortError {}
 
-/// Found a invalid ASCII byte while decoding base58 string.
+/// Found an invalid ASCII byte while decoding base58 string.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct InvalidCharacterError(pub(super) InvalidCharacterErrorInner);
 

diff --git a/base58/src/lib.rs b/base58/src/lib.rs
@@ -21,6 +21,7 @@
 #![allow(clippy::needless_question_mark)] // https://github.com/rust-bitcoin/rust-bitcoin/pull/2134
 #![allow(clippy::manual_range_contains)] // More readable than clippy's format.
 #![allow(clippy::incompatible_msrv)] // Has FPs and we're testing it which is more reliable anyway.
+#![allow(clippy::uninlined_format_args)] // Allow `format!("{}", x)`instead of enforcing `format!("{x}")`
 
 extern crate alloc;
 
@@ -113,7 +114,8 @@ pub fn decode(data: &str) -> Result<Vec<u8>, InvalidCharacterError> {
 /// Decodes a base58check-encoded string into a byte vector verifying the checksum.
 pub fn decode_check(data: &str) -> Result<Vec<u8>, Error> {
     let mut ret: Vec<u8> = decode(data)?;
-    let (remaining, &data_check) = ret.split_last_chunk::<4>().ok_or(TooShortError { length: ret.len() })?;
+    let (remaining, &data_check) =
+        ret.split_last_chunk::<4>().ok_or(TooShortError { length: ret.len() })?;
 
     let hash_check = *sha256d::Hash::hash(remaining).as_byte_array().sub_array::<0, 4>();
 
@@ -251,7 +253,7 @@ where
 mod tests {
     use alloc::vec;
 
-    use hex::test_hex_unwrap as hex;
+    use hex::FromHex as _;
 
     use super::*;
 
@@ -280,7 +282,7 @@ mod tests {
         assert_eq!(&res, exp);
 
         // Addresses
-        let addr = hex!("00f8917303bfa8ef24f292e8fa1419b20460ba064d");
+        let addr = Vec::from_hex("00f8917303bfa8ef24f292e8fa1419b20460ba064d").unwrap();
         assert_eq!(&encode_check(&addr[..]), "1PfJpZsjreyVrqeoAfabrRwwjQyoSQMmHH");
     }
 
@@ -299,7 +301,7 @@ mod tests {
         // Addresses
         assert_eq!(
             decode_check("1PfJpZsjreyVrqeoAfabrRwwjQyoSQMmHH").ok(),
-            Some(hex!("00f8917303bfa8ef24f292e8fa1419b20460ba064d"))
+            Some(Vec::from_hex("00f8917303bfa8ef24f292e8fa1419b20460ba064d").unwrap())
         );
         // Non Base58 char.
         assert_eq!(decode("¢").unwrap_err(), InvalidCharacterError::new(194));