Merge rust-bitcoin#5090: consensus_encoding: fix consensus-encoding package name

apoelstra · apoelstra · commit bb76eb7910d8 · 2025-10-12T18:09:31.000Z
a98abc5 Run just check-api (jrakibi) da60364 consensus_encoding: fix `consensus-encoding` package name (jrakibi) Pull request description: Updated the package name to match the crate name: https://crates.io/crates/bitcoin-consensus-encoding Closes rust-bitcoin#5069 ACKs for top commit: apoelstra: ACK a98abc5; successfully ran local tests tcharding: ACK a98abc5 Tree-SHA512: 5dcb970a34fd809e94131d863878e9a7e9cba9285948ee5e0dc8f48f4846955b7cd8beac7a30273124e4348bb3bea42161b56fd46ba7e0ef9cc6688bdb55c9a2
diff --git a/Cargo-minimal.lock b/Cargo-minimal.lock
@@ -72,6 +72,14 @@ dependencies = [
 name = "bitcoin-addresses"
 version = "0.0.0"
 
+[[package]]
+name = "bitcoin-consensus-encoding"
+version = "0.1.0"
+dependencies = [
+ "bitcoin-internals",
+ "bitcoin_hashes 0.16.0",
+]
+
 [[package]]
 name = "bitcoin-fuzz"
 version = "0.0.1"
@@ -129,10 +137,10 @@ dependencies = [
  "arbitrary",
  "arrayvec",
  "bincode",
+ "bitcoin-consensus-encoding",
  "bitcoin-internals",
  "bitcoin-units",
  "bitcoin_hashes 0.16.0",
- "consensus-encoding",
  "hex-conservative 0.3.0",
  "serde",
  "serde_json",
@@ -144,8 +152,8 @@ version = "1.0.0-rc.0"
 dependencies = [
  "arbitrary",
  "bincode",
+ "bitcoin-consensus-encoding",
  "bitcoin-internals",
- "consensus-encoding",
  "serde",
  "serde_json",
  "serde_test",
@@ -205,14 +213,6 @@ dependencies = [
  "hex-conservative 0.3.0",
 ]
 
-[[package]]
-name = "consensus-encoding"
-version = "0.0.0"
-dependencies = [
- "bitcoin-internals",
- "bitcoin_hashes 0.16.0",
-]
-
 [[package]]
 name = "getrandom"
 version = "0.2.0"
diff --git a/Cargo-recent.lock b/Cargo-recent.lock
@@ -71,6 +71,14 @@ dependencies = [
 name = "bitcoin-addresses"
 version = "0.0.0"
 
+[[package]]
+name = "bitcoin-consensus-encoding"
+version = "0.1.0"
+dependencies = [
+ "bitcoin-internals",
+ "bitcoin_hashes 0.16.0",
+]
+
 [[package]]
 name = "bitcoin-fuzz"
 version = "0.0.1"
@@ -128,10 +136,10 @@ dependencies = [
  "arbitrary",
  "arrayvec",
  "bincode",
+ "bitcoin-consensus-encoding",
  "bitcoin-internals",
  "bitcoin-units",
  "bitcoin_hashes 0.16.0",
- "consensus-encoding",
  "hex-conservative 0.3.0",
  "serde",
  "serde_json",
@@ -143,8 +151,8 @@ version = "1.0.0-rc.0"
 dependencies = [
  "arbitrary",
  "bincode",
+ "bitcoin-consensus-encoding",
  "bitcoin-internals",
- "consensus-encoding",
  "serde",
  "serde_json",
  "serde_test",
@@ -207,14 +215,6 @@ dependencies = [
  "hex-conservative 0.3.0",
 ]
 
-[[package]]
-name = "consensus-encoding"
-version = "0.0.0"
-dependencies = [
- "bitcoin-internals",
- "bitcoin_hashes 0.16.0",
-]
-
 [[package]]
 name = "getrandom"
 version = "0.2.15"
diff --git a/api/units/all-features.txt b/api/units/all-features.txt
@@ -12,6 +12,26 @@
 #[non_exhaustive] pub struct bitcoin_units::locktime::absolute::error::ConversionError
 #[non_exhaustive] pub struct bitcoin_units::parse_int::ParseIntError
 #[non_exhaustive] pub struct bitcoin_units::result::NumOpError(_)
+impl bitcoin_consensus_encoding::decode::Decodable for bitcoin_units::Amount
+impl bitcoin_consensus_encoding::decode::Decodable for bitcoin_units::BlockTime
+impl bitcoin_consensus_encoding::decode::Decodable for bitcoin_units::block::BlockHeight
+impl bitcoin_consensus_encoding::decode::Decodable for bitcoin_units::locktime::absolute::LockTime
+impl bitcoin_consensus_encoding::decode::Decodable for bitcoin_units::sequence::Sequence
+impl bitcoin_consensus_encoding::decode::Decoder for bitcoin_units::amount::AmountDecoder
+impl bitcoin_consensus_encoding::decode::Decoder for bitcoin_units::block::BlockHeightDecoder
+impl bitcoin_consensus_encoding::decode::Decoder for bitcoin_units::locktime::absolute::LockTimeDecoder
+impl bitcoin_consensus_encoding::decode::Decoder for bitcoin_units::sequence::SequenceDecoder
+impl bitcoin_consensus_encoding::decode::Decoder for bitcoin_units::time::BlockTimeDecoder
+impl bitcoin_consensus_encoding::encode::Encodable for bitcoin_units::Amount
+impl bitcoin_consensus_encoding::encode::Encodable for bitcoin_units::BlockTime
+impl bitcoin_consensus_encoding::encode::Encodable for bitcoin_units::block::BlockHeight
+impl bitcoin_consensus_encoding::encode::Encodable for bitcoin_units::locktime::absolute::LockTime
+impl bitcoin_consensus_encoding::encode::Encodable for bitcoin_units::sequence::Sequence
+impl bitcoin_consensus_encoding::encode::Encoder for bitcoin_units::amount::AmountEncoder
+impl bitcoin_consensus_encoding::encode::Encoder for bitcoin_units::block::BlockHeightEncoder
+impl bitcoin_consensus_encoding::encode::Encoder for bitcoin_units::locktime::absolute::LockTimeEncoder
+impl bitcoin_consensus_encoding::encode::Encoder for bitcoin_units::sequence::SequenceEncoder
+impl bitcoin_consensus_encoding::encode::Encoder for bitcoin_units::time::BlockTimeEncoder
 impl bitcoin_units::Amount
 impl bitcoin_units::BlockTime
 impl bitcoin_units::FeeRate
@@ -51,26 +71,6 @@ impl bitcoin_units::result::NumOpError
 impl bitcoin_units::sequence::Sequence
 impl bitcoin_units::sequence::SequenceDecoder
 impl bitcoin_units::time::BlockTimeDecoder
-impl consensus_encoding::decode::Decodable for bitcoin_units::Amount
-impl consensus_encoding::decode::Decodable for bitcoin_units::BlockTime
-impl consensus_encoding::decode::Decodable for bitcoin_units::block::BlockHeight
-impl consensus_encoding::decode::Decodable for bitcoin_units::locktime::absolute::LockTime
-impl consensus_encoding::decode::Decodable for bitcoin_units::sequence::Sequence
-impl consensus_encoding::decode::Decoder for bitcoin_units::amount::AmountDecoder
-impl consensus_encoding::decode::Decoder for bitcoin_units::block::BlockHeightDecoder
-impl consensus_encoding::decode::Decoder for bitcoin_units::locktime::absolute::LockTimeDecoder
-impl consensus_encoding::decode::Decoder for bitcoin_units::sequence::SequenceDecoder
-impl consensus_encoding::decode::Decoder for bitcoin_units::time::BlockTimeDecoder
-impl consensus_encoding::encode::Encodable for bitcoin_units::Amount
-impl consensus_encoding::encode::Encodable for bitcoin_units::BlockTime
-impl consensus_encoding::encode::Encodable for bitcoin_units::block::BlockHeight
-impl consensus_encoding::encode::Encodable for bitcoin_units::locktime::absolute::LockTime
-impl consensus_encoding::encode::Encodable for bitcoin_units::sequence::Sequence
-impl consensus_encoding::encode::Encoder for bitcoin_units::amount::AmountEncoder
-impl consensus_encoding::encode::Encoder for bitcoin_units::block::BlockHeightEncoder
-impl consensus_encoding::encode::Encoder for bitcoin_units::locktime::absolute::LockTimeEncoder
-impl consensus_encoding::encode::Encoder for bitcoin_units::sequence::SequenceEncoder
-impl consensus_encoding::encode::Encoder for bitcoin_units::time::BlockTimeEncoder
 impl core::clone::Clone for bitcoin_units::Amount
 impl core::clone::Clone for bitcoin_units::BlockTime
 impl core::clone::Clone for bitcoin_units::FeeRate
diff --git a/consensus_encoding/Cargo.toml b/consensus_encoding/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
-name = "consensus-encoding"
-version = "0.0.0"
+name = "bitcoin-consensus-encoding"
+version = "0.1.0"
 authors = ["Andrew Poelstra <apoelstra@wpsoftware.net>", "Tobin C. Harding <me@tobin.cc>"]
 license = "CC0-1.0"
 repository = "https://github.com/rust-bitcoin/rust-bitcoin/"
diff --git a/consensus_encoding/examples/encoder.rs b/consensus_encoding/examples/encoder.rs
@@ -2,7 +2,7 @@
 
 //! Example of creating an encoder that encodes a slice of encodable objects.
 
-use consensus_encoding as encoding;
+use bitcoin_consensus_encoding as encoding;
 use encoding::{ArrayEncoder, BytesEncoder, CompactSizeEncoder, Encodable, Encoder2, SliceEncoder};
 
 fn main() {
diff --git a/consensus_encoding/tests/composition.rs b/consensus_encoding/tests/composition.rs
@@ -2,7 +2,7 @@
 
 //! Test composition of encoders and decoders.
 
-use consensus_encoding::{
+use bitcoin_consensus_encoding::{
     ArrayDecoder, ArrayEncoder, Decodable, Decoder, Decoder2, Decoder6, Encodable, Encoder,
     Encoder2, Encoder6, UnexpectedEofError,
 };
diff --git a/consensus_encoding/tests/decode.rs b/consensus_encoding/tests/decode.rs
@@ -2,7 +2,7 @@
 
 //! Integration tests for decode module.
 
-use consensus_encoding::{ArrayDecoder, Decoder, UnexpectedEofError};
+use bitcoin_consensus_encoding::{ArrayDecoder, Decoder, UnexpectedEofError};
 
 const EMPTY: &[u8] = &[];
 
diff --git a/consensus_encoding/tests/encode.rs b/consensus_encoding/tests/encode.rs
@@ -5,7 +5,7 @@
 #[cfg(feature = "std")]
 use std::io::{Cursor, Write};
 
-use consensus_encoding::{ArrayEncoder, BytesEncoder, Encodable, Encoder};
+use bitcoin_consensus_encoding::{ArrayEncoder, BytesEncoder, Encodable, Encoder};
 
 // Simple test type that implements Encodable.
 #[cfg(feature = "alloc")]
@@ -43,7 +43,7 @@ fn encode_std_writer() {
     let data = TestData(0x1234_5678);
 
     let mut cursor = Cursor::new(Vec::new());
-    consensus_encoding::encode_to_writer(&data, &mut cursor).unwrap();
+    bitcoin_consensus_encoding::encode_to_writer(&data, &mut cursor).unwrap();
 
     let result = cursor.into_inner();
     assert_eq!(result, vec![0x78, 0x56, 0x34, 0x12]);
@@ -53,15 +53,15 @@ fn encode_std_writer() {
 #[cfg(feature = "alloc")]
 fn encode_vec() {
     let data = TestData(0xDEAD_BEEF);
-    let vec = consensus_encoding::encode_to_vec(&data);
+    let vec = bitcoin_consensus_encoding::encode_to_vec(&data);
     assert_eq!(vec, vec![0xEF, 0xBE, 0xAD, 0xDE]);
 }
 
 #[test]
 #[cfg(feature = "alloc")]
 fn encode_vec_empty_data() {
     let data = EmptyData;
-    let result = consensus_encoding::encode_to_vec(&data);
+    let result = bitcoin_consensus_encoding::encode_to_vec(&data);
     assert!(result.is_empty());
 }
 
@@ -70,7 +70,7 @@ fn encode_vec_empty_data() {
 fn encode_std_writer_empty_data() {
     let data = EmptyData;
     let mut cursor = Cursor::new(Vec::new());
-    consensus_encoding::encode_to_writer(&data, &mut cursor).unwrap();
+    bitcoin_consensus_encoding::encode_to_writer(&data, &mut cursor).unwrap();
 
     let result = cursor.into_inner();
     assert!(result.is_empty());
@@ -93,7 +93,7 @@ fn encode_std_writer_io_error() {
     let data = TestData(0x1234_5678);
     let mut writer = FailingWriter;
 
-    let result = consensus_encoding::encode_to_writer(&data, &mut writer);
+    let result = bitcoin_consensus_encoding::encode_to_writer(&data, &mut writer);
 
     assert!(result.is_err());
     assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::Other);
@@ -103,10 +103,10 @@ fn encode_std_writer_io_error() {
 fn encode_newtype_lifetime_flexibility() {
     // Test that the encoder_newtype macro allows different lifetime names.
 
-    consensus_encoding::encoder_newtype! {
+    bitcoin_consensus_encoding::encoder_newtype! {
         pub struct CustomEncoder<'data>(BytesEncoder<'data>);
     }
-    consensus_encoding::encoder_newtype! {
+    bitcoin_consensus_encoding::encoder_newtype! {
         pub struct NoLifetimeEncoder(ArrayEncoder<4>);
     }
 
diff --git a/consensus_encoding/tests/wrappers.rs b/consensus_encoding/tests/wrappers.rs
@@ -2,7 +2,7 @@
 
 #![cfg(feature = "std")]
 
-use consensus_encoding as encoding;
+use bitcoin_consensus_encoding as encoding;
 use encoding::{ArrayEncoder, BytesEncoder, CompactSizeEncoder, Encodable, Encoder2, SliceEncoder};
 
 encoding::encoder_newtype! {
diff --git a/primitives/Cargo.toml b/primitives/Cargo.toml
@@ -23,7 +23,7 @@ arbitrary = ["dep:arbitrary", "units/arbitrary"]
 hex = ["dep:hex", "hashes/hex", "internals/hex"]
 
 [dependencies]
-encoding = { package = "consensus-encoding", path = "../consensus_encoding", default-features = false }
+encoding = { package = "bitcoin-consensus-encoding", path = "../consensus_encoding", default-features = false }
 hashes = { package = "bitcoin_hashes", path = "../hashes", default-features = false }
 internals = { package = "bitcoin-internals", path = "../internals" }
 units = { package = "bitcoin-units", path = "../units", default-features = false, features = [ "encoding" ] }
diff --git a/units/Cargo.toml b/units/Cargo.toml
@@ -18,7 +18,7 @@ std = ["alloc", "internals/std", "encoding?/std"]
 alloc = ["internals/alloc", "serde?/alloc", "encoding?/alloc"]
 
 [dependencies]
-encoding = { package = "consensus-encoding", path = "../consensus_encoding", default-features = false, optional = true }
+encoding = { package = "bitcoin-consensus-encoding", path = "../consensus_encoding", default-features = false, optional = true }
 internals = { package = "bitcoin-internals", path = "../internals", version = "0.4.0" }
 
 serde = { version = "1.0.195", default-features = false, features = ["derive"], optional = true }
