rust-bitcoin · tcharding · Jan 5, 2022 · Jan 10, 2022 · Jan 10, 2022 · thomaseizinger
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,60 +1,3 @@
-[package]
-name = "bitcoin"
-version = "0.27.0"
-authors = ["Andrew Poelstra <apoelstra@wpsoftware.net>"]
-license = "CC0-1.0"
-homepage = "https://github.com/rust-bitcoin/rust-bitcoin/"
-repository = "https://github.com/rust-bitcoin/rust-bitcoin/"
-documentation = "https://docs.rs/bitcoin/"
-description = "General purpose library for using and interoperating with Bitcoin and other cryptocurrencies."
-keywords = [ "crypto", "bitcoin" ]
-readme = "README.md"
-exclude = ["./test_data"]
-
-# Please don't forget to add relevant features to docs.rs below
-[features]
-default = [ "std", "secp-recovery" ]
-base64 = [ "base64-compat" ]
-unstable = []
-rand = ["secp256k1/rand-std"]
-use-serde = ["serde", "bitcoin_hashes/serde", "secp256k1/serde"]
-secp-lowmemory = ["secp256k1/lowmemory"]
-secp-recovery = ["secp256k1/recovery"]
-
-# At least one of std, no-std must be enabled.
-#
-# The no-std feature doesn't disable std - you need to turn off the std feature for that by disabling default.
-# Instead no-std enables additional features required for this crate to be usable without std.
-# As a result, both can be enabled without conflict.
-std = ["secp256k1/std", "bitcoin_hashes/std", "bech32/std"]
-no-std = ["hashbrown", "core2/alloc", "bitcoin_hashes/alloc", "secp256k1/alloc"]
-
-[package.metadata.docs.rs]
-features = [ "std", "secp-recovery", "base64", "rand", "use-serde", "bitcoinconsensus" ]
-rustdoc-args = ["--cfg", "docsrs"]
-
-[dependencies]
-bech32 = { version = "0.8.1", default-features = false }
-bitcoin_hashes = { version = "0.10.0", default-features = false }
-secp256k1 = { version = "0.21.2", default-features = false }
-core2 = { version = "0.3.0", optional = true, default-features = false }
-
-base64-compat = { version = "1.0.0", optional = true }
-bitcoinconsensus = { version = "0.19.0-3", optional = true }
-serde = { version = "1", features = [ "derive" ], optional = true }
-hashbrown = { version = "0.8", optional = true }
-
-[dev-dependencies]
-serde_json = "<1.0.45"
-serde_test = "1"
-secp256k1 = { version = "0.21.2", features = [ "recovery", "rand-std" ] }
-bincode = "1.3.1"
-# We need to pin ryu (transitive dep from serde_json) to stay compatible with Rust 1.22.0
-ryu = "<1.0.5"
-
-[[example]]
-name = "bip32"
-
-[[example]]
-name = "handshake"
-required-features = ["std"]
+[workspace]
+members = ["bitcoin", "bitcoin-str"]
+exclude = ["embedded", "fuzz"]
diff --git a/bitcoin-str/Cargo.toml b/bitcoin-str/Cargo.toml
@@ -0,0 +1,41 @@
+[package]
+name = "bitcoin-str"
+version = "0.27.0"
-version = "0.27.0"
+version = "0.1.0"
-version = "0.27.0"
+version = "0.1.0"
+authors = ["Andrew Poelstra <apoelstra@wpsoftware.net>"]
+license = "CC0-1.0"
+homepage = "https://github.com/rust-bitcoin/rust-bitcoin/"
+repository = "https://github.com/rust-bitcoin/rust-bitcoin/"
+documentation = "https://docs.rs/bitcoin/"
+description = "The string encodings used by rust-bitcoin (base58, base58check, bech32, bech32m, base64, hex)."
+keywords = [ "crypto", "bitcoin" ]
+readme = "https://github.com/rust-bitcoin/rust-bitcoin/README.md"
+
+# Please don't forget to add relevant features to docs.rs below
+[features]
+default = ["std"]
+unstable = []
+base64 = ["base64-compat"]
+use-serde = ["serde", "bitcoin_hashes/serde"]
+
+# At least one of std, no-std must be enabled.
+#
+# The no-std feature doesn't disable std - you need to turn off the std feature for that by disabling default.
+# Instead no-std enables additional features required for this crate to be usable without std.
+# As a result, both can be enabled without conflict.
+std = ["bitcoin_hashes/std", "bech32/std"]
+no-std = ["core2/alloc", "bitcoin_hashes/alloc"]
+
+[package.metadata.docs.rs]
+features = [ "std", "secp-recovery", "base64", "rand", "use-serde", "bitcoinconsensus" ]
+rustdoc-args = ["--cfg", "docsrs"]
+
+[dependencies]
+bech32 = { version = "0.8.1", default-features = false }
+bitcoin_hashes = { version = "0.10.0", default-features = false }
+
+serde = { version = "1", features = [ "derive" ], optional = true }      # Typically enabled with `use-serde`.
+base64-compat = { version = "1.0.0", optional = true }                   # Typically enabled with `base64`.
+core2 = { version = "0.3.0", default-features = false, optional = true } # Typically enabled with `no-std`.
+
+[dev-dependencies]
+
diff --git a/src/util/base58.rs → bitcoin-str/src/base58.rs b/src/util/base58.rs → bitcoin-str/src/base58.rs
@@ -23,9 +23,7 @@ use prelude::*;
 use core::{fmt, str, iter, slice};
 
 use hashes::{sha256d, Hash};
-use secp256k1;
-
-use util::{endian, key};
+use endian;
 
 /// An error that might occur during base58 decoding
 #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone)]
@@ -44,8 +42,6 @@ pub enum Error {
     InvalidAddressVersion(u8),
     /// Checked data was less than 4 bytes
     TooShort(usize),
-    /// Secp256k1 error while parsing a secret key
-    Secp256k1(secp256k1::Error),
 }
 
 impl fmt::Display for Error {
@@ -57,7 +53,6 @@ impl fmt::Display for Error {
             Error::InvalidAddressVersion(ref v) => write!(f, "address version {} is invalid for this base58 type", v),
             Error::InvalidExtendedKeyVersion(ref v) => write!(f, "extended key version {:#04x?} is invalid for this base58 type", v),
             Error::TooShort(_) => write!(f, "base58ck data not even long enough for a checksum"),
-            Error::Secp256k1(ref e) => fmt::Display::fmt(&e, f),
         }
     }
 }
@@ -249,16 +244,6 @@ pub fn check_encode_slice_to_fmt(fmt: &mut fmt::Formatter, data: &[u8]) -> fmt::
     format_iter(fmt, iter)
 }
 
-#[doc(hidden)]
-impl From<key::Error> for Error {
-    fn from(e: key::Error) -> Self {
-        match e {
-            key::Error::Secp256k1(e) => Error::Secp256k1(e),
-            key::Error::Base58(e) => e,
-        }
-    }
-}
-
 #[cfg(test)]
 mod tests {
     use super::*;

diff --git a/src/util/endian.rs → bitcoin-str/src/endian.rs b/src/util/endian.rs → bitcoin-str/src/endian.rs
@@ -1,3 +1,5 @@
+#![allow(missing_docs)]         // TODO: Work out how to add valid docs during macro implementation of functions.
+
 macro_rules! define_slice_to_be {
     ($name: ident, $type: ty) => {
         #[inline]

diff --git a/bitcoin-str/src/lib.rs b/bitcoin-str/src/lib.rs
@@ -0,0 +1,91 @@
+// Rust Bitcoin Library
+// Written in 2014 by
+//   Andrew Poelstra <apoelstra@wpsoftware.net>
+//
+// To the extent possible un
F438
der law, the author(s) have dedicated all
+// copyright and related and neighboring rights to this software to
+// the public domain worldwide. This software is distributed without
+// any warranty.
+//
+// You should have received a copy of the CC0 Public Domain Dedication
+// along with this software.
+// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
+//
+
+//! # Rust Bitcoin String Encoding/Decoding.
+//!
+//! This library provides encoding and decoding into/from various string formats used by Bitcoin.
+//!
+//! - base58
+//! - bech32
+//! - bech32m
+//! - hex
+//! - base64 (optional)
+//!
+
+#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
+
+// Experimental features we need
+#![cfg_attr(all(test, feature = "unstable"), feature(test))]
+
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
+// Coding conventions
+#![forbid(unsafe_code)]
+#![deny(non_upper_case_globals)]
+#![deny(non_camel_case_types)]
+#![deny(non_snake_case)]
+#![deny(unused_mut)]
+#![deny(dead_code)]
+#![deny(unused_imports)]
+#![deny(missing_docs)]
+#![deny(unused_must_use)]
+#![deny(broken_intra_doc_links)]
+
+#[cfg(not(any(feature = "std", feature = "no-std")))]
+compile_error!("at least one of the `std` or `no-std` features must be enabled");
+
+// Disable 16-bit support at least for now as we can't guarantee it yet.
+#[cfg(target_pointer_width = "16")]
+compile_error!("rust-bitcoin currently only supports architectures with pointers wider
+                than 16 bits, let us know if you want 16-bit support. Note that we do
+                NOT guarantee that we will implement it!");
+
+#[cfg(feature = "no-std")]
+#[macro_use]
+extern crate alloc;
+#[cfg(feature = "no-std")]
+extern crate core2;
+
+#[cfg(any(feature = "std", test))]
+extern crate core; // for Rust 1.29 and no-std tests
+
+// Re-exported dependencies.
+pub extern crate bech32;
+pub extern crate bitcoin_hashes as hashes;
+
+#[cfg(feature = "base64")]
+#[cfg_attr(docsrs, doc(cfg(feature = "base64")))]
+pub extern crate base64;
+
+pub mod base58;
+pub mod endian;
+
+pub mod hex {
+    //! Re-exports hex de/serialization code from `bitcoin_hashes`.
+    //!
+    // There is a chicken and the egg problem with putting _all_ the en/decoding code in a single crate.
+    // Hashing cannot be separated totally from en/decoding because base58 -> hashing -> hex.
+
+    pub use hashes::hex::{Error, ToHex, FromHex, HexIterator, format_hex, format_hex_reverse};
+    // TODO: This doesn't work with Rust 1.29 (same problem trying to use macros from hashes in ../bitcoin)
+    pub use hashes::hex_fmt_impl;
+}
+
+mod prelude {
+    #[cfg(all(not(feature = "std"), not(test)))]
+    pub use alloc::{string::{String, ToString}, vec::Vec, boxed::Box, borrow::{Cow, ToOwned}, slice, rc, sync};
+
+    #[cfg(any(feature = "std", test))]
+    pub use std::{string::{String, ToString}, vec::Vec, boxed::Box, borrow::{Cow, ToOwned}, slice, rc, sync};
+}
diff --git a/bitcoin/Cargo.toml b/bitcoin/Cargo.toml
@@ -0,0 +1,59 @@
+[package]
+name = "bitcoin"
+version = "0.27.0"
+authors = ["Andrew Poelstra <apoelstra@wpsoftware.net>"]
+license = "CC0-1.0"
+homepage = "https://github.com/rust-bitcoin/rust-bitcoin/"
+repository = "https://github.com/rust-bitcoin/rust-bitcoin/"
+documentation = "https://docs.rs/bitcoin/"
+description = "General purpose library for using and interoperating with Bitcoin and other cryptocurrencies."
+keywords = [ "crypto", "bitcoin" ]
+readme = "https://github.com/rust-bitcoin/rust-bitcoin/README.md"
+exclude = ["./test_data"]
+
+# Please don't forget to add relevant features to docs.rs below
+[features]
+default = [ "std", "secp-recovery" ]
+base64 = [ "bitcoin-str/base64" ]
+unstable = []
+rand = ["secp256k1/rand-std"]
+use-serde = ["serde", "secp256k1/serde"]
+secp-lowmemory = ["secp256k1/lowmemory"]
+secp-recovery = ["secp256k1/recovery"]
+
+# At least one of std, no-std must be enabled.
+#
+# The no-std feature doesn't disable std - you need to turn off the std feature for that by disabling default.
+# Instead no-std enables additional features required for this crate to be usable without std.
+# As a result, both can be enabled without conflict.
+std = ["bitcoin-str/std", "secp256k1/std"]
+no-std = ["bitcoin-str/no-std", "hashbrown", "core2/alloc", "secp256k1/alloc"]
+
+[package.metadata.docs.rs]
+features = [ "std", "secp-recovery", "base64", "rand", "use-serde", "bitcoinconsensus" ]
+rustdoc-args = ["--cfg", "docsrs"]
+
+[dependencies]
+bitcoin-str = { path = "../bitcoin-str", default-features = false }
+
+secp256k1 = { version = "0.21.2", default-features = false }
+core2 = { version = "0.3.0", optional = true, default-features = false }
+
+bitcoinconsensus = { version = "0.19.0-3", optional = true }
+serde = { version = "1", features = [ "derive" ], optional = true }
+hashbrown = { version = "0.8", optional = true }
+
+[dev-dependencies]
+serde_json = "<1.0.45"
+serde_test = "1"
+secp256k1 = { version = "0.21.2", features = [ "recovery", "rand-std" ] }
+bincode = "1.3.1"
+# We need to pin ryu (transitive dep from serde_json) to stay compatible with Rust 1.22.0
+ryu = "<1.0.5"
+
+[[example]]
+name = "bip32"
+
+[[example]]
+name = "handshake"
+required-features = ["std"]
diff --git a/examples/bip32.rs → bitcoin/examples/bip32.rs b/examples/bip32.rs → bitcoin/examples/bip32.rs
diff --git a/examples/handshake.rs → bitcoin/examples/handshake.rs b/examples/handshake.rs → bitcoin/examples/handshake.rs
diff --git a/src/blockdata/block.rs → bitcoin/src/blockdata/block.rs b/src/blockdata/block.rs → bitcoin/src/blockdata/block.rs
@@ -36,6 +36,7 @@ use blockdata::transaction::Transaction;
 use blockdata::constants::{max_target, WITNESS_SCALE_FACTOR};
 use blockdata::script;
 use VarInt;
+use endian;
 
 /// A block header, which contains all the block's information except
 /// the actual transactions
@@ -138,7 +139,7 @@ impl BlockHeader {
         }
         let block_hash = self.block_hash();
         let mut ret = [0u64; 4];
-        util::endian::bytes_to_u64_slice_le(block_hash.as_inner(), &mut ret);
+        endian::bytes_to_u64_slice_le(block_hash.as_inner(), &mut ret);
         let hash = &Uint256(ret);
         if hash <= target { Ok(block_hash) } else { Err(BlockBadProofOfWork) }
     }
@@ -293,7 +294,7 @@ impl Block {
                 // Expand the push to exactly 8 bytes (LE).
                 let mut full = [0; 8];
                 full[0..b.len()].copy_from_slice(b);
-                Ok(util::endian::slice_to_u64_le(&full))
+                Ok(endian::slice_to_u64_le(&full))
             }
             script::Instruction::PushBytes(b) if b.len() > 8 => {
                 Err(Bip34Error::UnexpectedPush(b.to_vec()))

diff --git a/src/blockdata/constants.rs → bitcoin/src/blockdata/constants.rs b/src/blockdata/constants.rs → bitcoin/src/blockdata/constants.rs
diff --git a/src/blockdata/mod.rs → bitcoin/src/blockdata/mod.rs b/src/blockdata/mod.rs → bitcoin/src/blockdata/mod.rs
diff --git a/src/blockdata/opcodes.rs → bitcoin/src/blockdata/opcodes.rs b/src/blockdata/opcodes.rs → bitcoin/src/blockdata/opcodes.rs
diff --git a/src/blockdata/script.rs → bitcoin/src/blockdata/script.rs b/src/blockdata/script.rs → bitcoin/src/blockdata/script.rs
diff --git a/src/blockdata/transaction.rs → bitcoin/src/blockdata/transaction.rs b/src/blockdata/transaction.rs → bitcoin/src/blockdata/transaction.rs
@@ -32,7 +32,7 @@ use core::{fmt, str, default::Default};
 use hashes::{self, Hash, sha256d};
 use hashes::hex::FromHex;
 
-use util::endian;
+use endian;
 use blockdata::constants::WITNESS_SCALE_FACTOR;
 #[cfg(feature="bitcoinconsensus")] use blockdata::script;
 use blockdata::script::Script;

diff --git a/src/blockdata/witness.rs → bitcoin/src/blockdata/witness.rs b/src/blockdata/witness.rs → bitcoin/src/blockdata/witness.rs
diff --git a/src/consensus/encode.rs → bitcoin/src/consensus/encode.rs b/src/consensus/encode.rs → bitcoin/src/consensus/encode.rs
@@ -37,7 +37,7 @@ use hash_types::{BlockHash, FilterHash, TxMerkleNode, FilterHeader};
 
 use io::{self, Cursor, Read};
 
-use util::endian;
+use endian;
 use util::psbt;
 use util::taproot::TapLeafHash;
 use hashes::hex::ToHex;
@@ -789,7 +789,7 @@ mod tests {
     use super::{deserialize, serialize, Error, CheckedData, VarInt};
     use super::{Transaction, BlockHash, FilterHash, TxMerkleNode, TxOut, TxIn};
     use consensus::{Encodable, deserialize_partial, Decodable};
-    use util::endian::{u64_to_array_le, u32_to_array_le, u16_to_array_le};
+    use endian::{u64_to_array_le, u32_to_array_le, u16_to_array_le};
     use secp256k1::rand::{thread_rng, Rng};
     #[cfg(feature = "std")]
     use network::{Address, message_blockdata::Inventory};

diff --git a/src/consensus/mod.rs → bitcoin/src/consensus/mod.rs b/src/consensus/mod.rs → bitcoin/src/consensus/mod.rs
diff --git a/src/consensus/params.rs → bitcoin/src/consensus/params.rs b/src/consensus/params.rs → bitcoin/src/consensus/params.rs
diff --git a/src/hash_types.rs → bitcoin/src/hash_types.rs b/src/hash_types.rs → bitcoin/src/hash_types.rs
@@ -20,7 +20,9 @@
 //! hash).
 //!
 
-use hashes::{Hash, sha256, sha256d, hash160};
+use hashes::{Hash, sha256, sha256d, hash160, hash_newtype};
+// TODO: These 'hidden' macros should use fully qualified paths in bitcoin_hashes.
+use hashes::{index_impl, hex_fmt_impl, serde_impl, borrow_slice_impl};
 
 macro_rules! impl_hashencode {
     ($hashtype:ident) => {

diff --git a/src/internal_macros.rs → bitcoin/src/internal_macros.rs b/src/internal_macros.rs → bitcoin/src/internal_macros.rs