Merge rust-bitcoin#4625: units: Fix up the api test

2b07f59 units: Fix up the api test (Tobin C. Harding)
a6ab5c9 Implement Arbitrary for result types (Tobin C. Harding)

Pull request description:

  A lot has changed over the last few months. Fix up the API integration test to match the current state of the crate.
  
  Includes a patch to implement `Arbitrary` for types from the new private `result` module.


ACKs for top commit:
  apoelstra:
    ACK 2b07f59; successfully ran local tests


Tree-SHA512: fa9bd5b67ea6217cfb11a985183d2d83ae126678fa9fbe5b540fcec31efc0fbafb3e6010c7e831c84c9161300ad5ccc771f848875fdcfe09e072bb0d2881a104

Author: apoelstra

Cargo-minimal.lock

@@ -77,6 +77,7 @@ name = "bitcoin-fuzz"
 version = "0.0.1"
 dependencies = [
  "bitcoin",
+ "bitcoin-p2p-messages",
  "honggfuzz",
  "serde",
  "serde_json",
@@ -109,6 +110,15 @@ dependencies = [
 [[package]]
 name = "bitcoin-p2p-messages"
 version = "0.1.0"
+dependencies = [
+ "bitcoin",
+ "bitcoin-internals",
+ "bitcoin-io 0.2.0",
+ "bitcoin-units",
+ "bitcoin_hashes 0.16.0",
+ "hex-conservative 0.3.0",
+ "hex_lit",
+]
 
 [[package]]
 name = "bitcoin-primitives"

Cargo-recent.lock

@@ -76,6 +76,7 @@ name = "bitcoin-fuzz"
 version = "0.0.1"
 dependencies = [
  "bitcoin",
+ "bitcoin-p2p-messages",
  "honggfuzz",
  "serde",
  "serde_json",
@@ -108,6 +109,15 @@ dependencies = [
 [[package]]
 name = "bitcoin-p2p-messages"
 version = "0.1.0"
+dependencies = [
+ "bitcoin",
+ "bitcoin-internals",
+ "bitcoin-io 0.2.0",
+ "bitcoin-units",
+ "bitcoin_hashes 0.16.0",
+ "hex-conservative 0.3.0",
+ "hex_lit",
+]
 
 [[package]]
 name = "bitcoin-primitives"

bitcoin/Cargo.toml

@@ -56,10 +56,6 @@ rustdoc-args = ["--cfg", "docsrs"]
 [[example]]
 name = "bip32"
 
-[[example]]
-name = "handshake"
-required-features = ["rand-std"]
-
 [[example]]
 name = "ecdsa-psbt"
 required-features = ["std", "bitcoinconsensus"]

bitcoin/src/bip32.rs

@@ -193,6 +193,29 @@ impl ChildNumber {
             ChildNumber::Hardened { index: idx } => ChildNumber::from_hardened_idx(idx + 1),
         }
     }
+
+    /// Formats the child number using the provided formatting function.
+    ///
+    /// For hardened child numbers appends a `'` or `hardened_alt_suffix`
+    /// depending on the formatter.
+    fn format_with<F>(
+        &self,
+        f: &mut fmt::Formatter,
+        format_fn: F,
+        hardened_alt_suffix: &str,
+    ) -> fmt::Result
+    where
+        F: Fn(&u32, &mut fmt::Formatter) -> fmt::Result,
+    {
+        match *self {
+            ChildNumber::Hardened { index } => {
+                format_fn(&index, f)?;
+                let alt = f.alternate();
+                f.write_str(if alt { hardened_alt_suffix } else { "'" })
+            }
+            ChildNumber::Normal { index } => format_fn(&index, f),
+        }
+    }
 }
 
 impl From<u32> for ChildNumber {
@@ -216,14 +239,31 @@ impl From<ChildNumber> for u32 {
 
 impl fmt::Display for ChildNumber {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        match *self {
-            ChildNumber::Hardened { index } => {
-                fmt::Display::fmt(&index, f)?;
-                let alt = f.alternate();
-                f.write_str(if alt { "h" } else { "'" })
-            }
-            ChildNumber::Normal { index } => fmt::Display::fmt(&index, f),
-        }
+        self.format_with(f, fmt::Display::fmt, "h")
+    }
+}
+
+impl fmt::LowerHex for ChildNumber {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        self.format_with(f, fmt::LowerHex::fmt, "h")
+    }
+}
+
+impl fmt::UpperHex for ChildNumber {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        self.format_with(f, fmt::UpperHex::fmt, "H")
+    }
+}
+
+impl fmt::Octal for ChildNumber {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        self.format_with(f, fmt::Octal::fmt, "h")
+    }
+}
+
+impl fmt::Binary for ChildNumber {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        self.format_with(f, fmt::Binary::fmt, "h")
     }
 }
 
@@ -1123,6 +1163,54 @@ mod tests {
         assert_eq!(format!("{:#}", path), "84h/0h/0h/0/0");
     }
 
+    #[test]
+    fn test_lowerhex_formatting() {
+        let normal = Normal { index: 42 };
+        let hardened = Hardened { index: 42 };
+
+        assert_eq!(format!("{:x}", normal), "2a");
+        assert_eq!(format!("{:#x}", normal), "0x2a");
+
+        assert_eq!(format!("{:x}", hardened), "2a'");
+        assert_eq!(format!("{:#x}", hardened), "0x2ah");
+    }
+
+    #[test]
+    fn test_upperhex_formatting() {
+        let normal = Normal { index: 42 };
+        let hardened = Hardened { index: 42 };
+        
+        assert_eq!(format!("{:X}", normal), "2A");
+        assert_eq!(format!("{:#X}", normal), "0x2A");
+
+        assert_eq!(format!("{:X}", hardened), "2A'");
+        assert_eq!(format!("{:#X}", hardened), "0x2AH");
+    }
+
+    #[test]
+    fn test_octal_formatting() {
+        let normal = Normal { index: 42 };
+        let hardened = Hardened { index: 42 };
+
+        assert_eq!(format!("{:o}", normal), "52");
+        assert_eq!(format!("{:#o}", normal), "0o52");
+
+        assert_eq!(format!("{:o}", hardened), "52'");
+        assert_eq!(format!("{:#o}", hardened), "0o52h");
+    }
+
+    #[test]
+    fn test_binary_formatting() {
+        let normal = Normal { index: 42 };
+        let hardened = Hardened { index: 42 };
+
+        assert_eq!(format!("{:b}", normal), "101010");
+        assert_eq!(format!("{:#b}", normal), "0b101010");
+
+        assert_eq!(format!("{:b}", hardened), "101010'");
+        assert_eq!(format!("{:#b}", hardened), "0b101010h");
+    }
+
     #[test]
     fn parse_derivation_path_out_of_range() {
         let invalid_path = "2147483648";

bitcoin/src/lib.rs

@@ -94,7 +94,6 @@ extern crate serde;
 mod internal_macros;
 
 #[macro_use]
-pub mod p2p;
 pub mod address;
 pub mod bip152;
 pub mod bip158;