Merge rust-bitcoin#5342: Depend on primitives instead of bitcoin where type definitions overlap

apoelstra · apoelstra · commit 39d488b37648 · 2025-12-19T15:48:25.000Z
c97d458 Add re-export for primitives to Bitcoin crate (yancy) f81e8d2 Depend on primitives instead of bitcoin where type definitions overlap (yancy) Pull request description: Consolidate dependency tree for downstream crates that depend on `bitcoin-p2p-messages` by reducing overlapping dependencies. For example, consider crate A which depends on `bitcoin-primitives` and `bitcoin-p2p-messages`. For types defined by both `bitcoin-primitives` and `bitcoin`, Crate A may still need to depend on `bitcoin` if a type of `bitcoin-p2p-messages` depends on `bitcoin` instead of `bitcoin-primitives`. Also, see: rust-bitcoin#5331 _After_ this change, the remaining bitcoin dependencies are: ``` examples/handshake.rs:6:use bitcoin::consensus::{encode, Decodable}; src/address.rs:15:use bitcoin::consensus::encode::{self, Decodable, Encodable, ReadExt, WriteExt}; src/address.rs:532: use bitcoin::consensus::encode::{deserialize, serialize}; src/consensus.rs:2:use bitcoin::consensus::encode::WriteExt; src/lib.rs:43:use bitcoin::consensus::encode::{self, Decodable, Encodable}; src/lib.rs:44:use bitcoin::network::{Network, Params, TestnetVersion}; src/lib.rs:489: use bitcoin::consensus::encode::{deserialize, serialize}; src/message.rs:17:use bitcoin::block::HeaderExt; src/message.rs:18:use bitcoin::consensus::encode::{self, Decodable, Encodable, ReadExt, WriteExt}; src/message.rs:19:use bitcoin::merkle_tree::MerkleBlock; src/message.rs:959: use bitcoin::bip152::BlockTransactionsRequest; src/message.rs:960: use bitcoin::bip158::{FilterHash, FilterHeader}; src/message.rs:962: use bitcoin::consensus::encode::{deserialize, deserialize_partial, serialize}; src/message_blockdata.rs:13:use bitcoin::consensus::encode::{self, Decodable, Encodable}; src/message_blockdata.rs:175: use bitcoin::consensus::encode::{deserialize, serialize}; src/message_bloom.rs:11:use bitcoin::consensus::{encode, Decodable, Encodable, ReadExt}; src/message_compact_blocks.rs:8:use bitcoin::bip152; src/message_filter.rs:11:use bitcoin::bip158::{FilterHash, FilterHeader}; src/message_network.rs:15:use bitcoin::consensus::{encode, Decodable, Encodable, ReadExt, WriteExt}; src/message_network.rs:420: use bitcoin::consensus::encode::{deserialize, serialize}; src/network_ext.rs:7:use bitcoin::{Network, TestnetVersion}; ``` I've left bip152 and bip158 for future PRs (rust-bitcoin#5333). I don't think any of the remaining dependencies can be readily moved. ACKs for top commit: apoelstra: ACK c97d458; successfully ran local tests tcharding: ACK c97d458 Tree-SHA512: 389eb09d8b3a75de0cb30baa3722c9e7b03273dfb8547211246349e97ab205c66354aaed2a49415faf6e01fef41a496d114fb68869355f95778f69e2346bb8c6
diff --git a/Cargo-minimal.lock b/Cargo-minimal.lock
@@ -131,6 +131,7 @@ dependencies = [
  "bitcoin-consensus-encoding",
  "bitcoin-internals",
  "bitcoin-io",
+ "bitcoin-primitives",
  "bitcoin-units",
  "bitcoin_hashes",
  "hex-conservative 0.3.0",
diff --git a/Cargo-recent.lock b/Cargo-recent.lock
@@ -130,6 +130,7 @@ dependencies = [
  "bitcoin-consensus-encoding",
  "bitcoin-internals",
  "bitcoin-io",
+ "bitcoin-primitives",
  "bitcoin-units",
  "bitcoin_hashes",
  "hex-conservative 0.3.0",
diff --git a/bitcoin/src/lib.rs b/bitcoin/src/lib.rs
@@ -74,6 +74,9 @@ pub extern crate hex;
 /// Re-export the `bitcoin-io` crate.
 pub extern crate io;
 
+/// Re-export the `primitives` crate.
+pub extern crate primitives;
+
 /// Re-export the `rust-secp256k1` crate.
 ///
 /// Rust wrapper library for Pieter Wuille's libsecp256k1. Implements ECDSA and BIP-0340 signatures
diff --git a/p2p/Cargo.toml b/p2p/Cargo.toml
@@ -14,13 +14,14 @@ exclude = ["tests", "contrib"]
 
 [features]
 default = ["std"]
-std = ["encoding/std", "hashes/std", "hex/std", "internals/std", "io/std", "units/std", "bitcoin/std"]
+std = ["encoding/std", "hashes/std", "hex/std", "internals/std", "io/std", "units/std", "bitcoin/std", "primitives/std"]
 arbitrary = ["dep:arbitrary", "bitcoin/arbitrary"]
 
 [dependencies]
 bitcoin = { path = "../bitcoin/", default-features = false }
 encoding = { package = "bitcoin-consensus-encoding", version = "=1.0.0-rc.2", path = "../consensus_encoding", default-features = false }
 hashes = { package = "bitcoin_hashes", version = "0.18.0", path = "../hashes", default-features = false }
+primitives = { package = "bitcoin-primitives", path = "../primitives", version = "=1.0.0-rc.1", default-features = false }
 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 }
diff --git a/p2p/src/message.rs b/p2p/src/message.rs
@@ -16,7 +16,7 @@ use core::{cmp, fmt};
 use arbitrary::{Arbitrary, Unstructured};
 use bitcoin::consensus::encode::{self, Decodable, Encodable, ReadExt, WriteExt};
 use bitcoin::merkle_tree::MerkleBlock;
-use bitcoin::{block, transaction};
+use primitives::{block, transaction};
 use encoding;
 use hashes::sha256d;
 use internals::ToU64 as _;
@@ -1660,9 +1660,9 @@ mod test {
     use alloc::vec;
     use std::net::Ipv4Addr;
 
-    use bitcoin::block::{Block, BlockHash};
+    use primitives::{Block, BlockHash};
     use bitcoin::consensus::encode::{deserialize, deserialize_partial, serialize};
-    use bitcoin::transaction::{Transaction, Txid};
+    use primitives::transaction::{Transaction, Txid};
     use hex_lit::hex;
     use units::BlockHeight;
 
diff --git a/p2p/src/message_blockdata.rs b/p2p/src/message_blockdata.rs
@@ -9,9 +9,9 @@ use alloc::vec::Vec;
 
 #[cfg(feature = "arbitrary")]
 use arbitrary::{Arbitrary, Unstructured};
-use bitcoin::block::BlockHash;
+use primitives::BlockHash;
 use bitcoin::consensus::encode::{self, Decodable, Encodable};
-use bitcoin::transaction::{Txid, Wtxid};
+use primitives::transaction::{Txid, Wtxid};
 use io::{BufRead, Write};
 
 use crate::consensus::impl_consensus_encoding;
diff --git a/p2p/src/message_filter.rs b/p2p/src/message_filter.rs
@@ -8,7 +8,7 @@ use alloc::vec::Vec;
 
 #[cfg(feature = "arbitrary")]
 use arbitrary::{Arbitrary, Unstructured};
-use bitcoin::block::BlockHash;
+use primitives::BlockHash;
 use hashes::{sha256d, HashEngine};
 use units::BlockHeight;
 
