Add rustfmt::skip as needed

In preparation for enabling `rustfmt` crate wide add various skip statements and do minor format fixes. Note, for some reason adding `rustfmt::skip` to the `sha256t_hash_newtype` causes build to fail due to ambiguous naming (we have the exact same macro in `bitcoin_hashes`). The macros are identical except for the `rust-bitcoin` version adds docs to the created structs. Until that can be pushed upstream to `bitcoin_hashes` I've renamed the macro to `_sha256t_hash_newtype` and added a comment.
rust-bitcoin · Apr 20, 2022 · 0859daf · 0859daf
1 parent a898797
commit 0859daf
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 30 deletions.
diff --git a/src/blockdata/script.rs b/src/blockdata/script.rs
@@ -1258,14 +1258,15 @@ mod test {
     }
 
     #[test]
+    #[rustfmt::skip]
     fn scriptint_round_trip() {
         assert_eq!(build_scriptint(-1), vec![0x81]);
         assert_eq!(build_scriptint(255), vec![255, 0]);
         assert_eq!(build_scriptint(256), vec![0, 1]);
         assert_eq!(build_scriptint(257), vec![1, 1]);
         assert_eq!(build_scriptint(511), vec![255, 1]);
-        for &i in [10, 100, 255, 256, 1000, 10000, 25000, 200000, 5000000, 1000000000,
-                             (1 << 31) - 1, -((1 << 31) - 1)].iter() {
+        for &i in [10, 100, 255, 256, 1000, 10000, 25000, 200000, 5000000, 1000000000, (1 << 31) - 1, -((1 << 31) - 1)].iter()
+        {
             assert_eq!(Ok(i), read_scriptint(&build_scriptint(i)));
             assert_eq!(Ok(-i), read_scriptint(&build_scriptint(-i)));
         }

diff --git a/src/lib.rs b/src/lib.rs
@@ -112,6 +112,7 @@ pub mod network;
 pub mod blockdata;
 pub mod util;
 pub mod consensus;
+#[rustfmt::skip] // `hash_newtype` statements are easier to read on a single line.
 pub mod hash_types;
 pub mod policy;
 
@@ -173,6 +174,7 @@ mod io_extras {
     }
 }
 
+#[rustfmt::skip] // One line use statements to reduce number of cfg statements required.
 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};

diff --git a/src/network/address.rs b/src/network/address.rs
@@ -301,14 +301,16 @@ mod test {
     use consensus::encode::{deserialize, serialize};
 
     #[test]
+    #[rustfmt::skip]
     fn serialize_address_test() {
-        assert_eq!(serialize(&Address {
-            services: ServiceFlags::NETWORK,
-            address: [0, 0, 0, 0, 0, 0xffff, 0x0a00, 0x0001],
-            port: 8333
-        }),
-        vec![1u8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-             0, 0, 0, 0xff, 0xff, 0x0a, 0, 0, 1, 0x20, 0x8d]);
+        assert_eq!(
+            serialize(&Address {
+                services: ServiceFlags::NETWORK,
+                address: [0, 0, 0, 0, 0, 0xffff, 0x0a00, 0x0001],
+                port: 8333
+            }),
+            vec![1u8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+                 0, 0, 0, 0xff, 0xff, 0x0a, 0, 0, 1, 0x20, 0x8d]);
     }
 
     #[test]

diff --git a/src/network/message.rs b/src/network/message.rs
@@ -507,45 +507,51 @@ mod test {
     }
 
     #[test]
+    #[rustfmt::skip]
     fn serialize_verack_test() {
         assert_eq!(serialize(&RawNetworkMessage { magic: 0xd9b4bef9, payload: NetworkMessage::Verack }),
-                             vec![0xf9, 0xbe, 0xb4, 0xd9, 0x76, 0x65, 0x72, 0x61,
-                                  0x63, 0x6B, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-                                  0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2]);
+                   vec![0xf9, 0xbe, 0xb4, 0xd9, 0x76, 0x65, 0x72, 0x61,
+                        0x63, 0x6B, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+                        0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2]);
     }
 
     #[test]
+    #[rustfmt::skip]
     fn serialize_ping_test() {
         assert_eq!(serialize(&RawNetworkMessage { magic: 0xd9b4bef9, payload: NetworkMessage::Ping(100) }),
-                             vec![0xf9, 0xbe, 0xb4, 0xd9, 0x70, 0x69, 0x6e, 0x67,
-                                  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-                                  0x08, 0x00, 0x00, 0x00, 0x24, 0x67, 0xf1, 0x1d,
-                                  0x64, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
+                   vec![0xf9, 0xbe, 0xb4, 0xd9, 0x70, 0x69, 0x6e, 0x67,
+                        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+                        0x08, 0x00, 0x00, 0x00, 0x24, 0x67, 0xf1, 0x1d,
+                        0x64, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
     }
 
 
     #[test]
+    #[rustfmt::skip]
     fn serialize_mempool_test() {
         assert_eq!(serialize(&RawNetworkMessage { magic: 0xd9b4bef9, payload: NetworkMessage::MemPool }),
-                             vec![0xf9, 0xbe, 0xb4, 0xd9, 0x6d, 0x65, 0x6d, 0x70,
-                                  0x6f, 0x6f, 0x6c, 0x00, 0x00, 0x00, 0x00, 0x00,
-                                  0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2]);
+                   vec![0xf9, 0xbe, 0xb4, 0xd9, 0x6d, 0x65, 0x6d, 0x70,
+                        0x6f, 0x6f, 0x6c, 0x00, 0x00, 0x00, 0x00, 0x00,
+                        0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2]);
     }
 
     #[test]
+    #[rustfmt::skip]
     fn serialize_getaddr_test() {
         assert_eq!(serialize(&RawNetworkMessage { magic: 0xd9b4bef9, payload: NetworkMessage::GetAddr }),
-                             vec![0xf9, 0xbe, 0xb4, 0xd9, 0x67, 0x65, 0x74, 0x61,
-                                  0x64, 0x64, 0x72, 0x00, 0x00, 0x00, 0x00, 0x00,
-                                  0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2]);
+                   vec![0xf9, 0xbe, 0xb4, 0xd9, 0x67, 0x65, 0x74, 0x61,
+                        0x64, 0x64, 0x72, 0x00, 0x00, 0x00, 0x00, 0x00,
+                        0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2]);
     }
 
     #[test]
     fn deserialize_getaddr_test() {
+        #[rustfmt::skip]
         let msg = deserialize(
             &[0xf9, 0xbe, 0xb4, 0xd9, 0x67, 0x65, 0x74, 0x61,
-                0x64, 0x64, 0x72, 0x00, 0x00, 0x00, 0x00, 0x00,
-                0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2]);
+              0x64, 0x64, 0x72, 0x00, 0x00, 0x00, 0x00, 0x00,
+              0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2]);
+
         let preimage = RawNetworkMessage { magic: 0xd9b4bef9, payload: NetworkMessage::GetAddr };
         assert!(msg.is_ok());
         let msg : RawNetworkMessage = msg.unwrap();
@@ -555,6 +561,7 @@ mod test {
 
     #[test]
     fn deserialize_version_test() {
+        #[rustfmt::skip]
         let msg = deserialize::<RawNetworkMessage>(
             &[  0xf9, 0xbe, 0xb4, 0xd9, 0x76, 0x65, 0x72, 0x73,
                 0x69, 0x6f, 0x6e, 0x00, 0x00, 0x00, 0x00, 0x00,
@@ -591,6 +598,7 @@ mod test {
 
     #[test]
     fn deserialize_partial_message_test() {
+        #[rustfmt::skip]
         let data = [  0xf9, 0xbe, 0xb4, 0xd9, 0x76, 0x65, 0x72, 0x73,
             0x69, 0x6f, 0x6e, 0x00, 0x00, 0x00, 0x00, 0x00,
             0x66, 0x00, 0x00, 0x00, 0xbe, 0x61, 0xb8, 0x27,

diff --git a/src/network/stream_reader.rs b/src/network/stream_reader.rs
@@ -70,6 +70,7 @@ mod test {
 
     // First, let's define some byte arrays for sample messages - dumps are taken from live
     // Bitcoin Core node v0.17.1 with Wireshark
+    #[rustfmt::skip]
     const MSG_VERSION: [u8; 126] = [
         0xf9, 0xbe, 0xb4, 0xd9, 0x76, 0x65, 0x72, 0x73,
         0x69, 0x6f, 0x6e, 0x00, 0x00, 0x00, 0x00, 0x00,
@@ -89,19 +90,22 @@ mod test {
         0x2f, 0x93, 0x8c, 0x08, 0x00, 0x01
     ];
 
+    #[rustfmt::skip]
     const MSG_VERACK: [u8; 24] = [
         0xf9, 0xbe, 0xb4, 0xd9, 0x76, 0x65, 0x72, 0x61,
         0x63, 0x6b, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
         0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2
     ];
 
+    #[rustfmt::skip]
     const MSG_PING: [u8; 32] = [
         0xf9, 0xbe, 0xb4, 0xd9, 0x70, 0x69, 0x6e, 0x67,
         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
         0x08, 0x00, 0x00, 0x00, 0x24, 0x67, 0xf1, 0x1d,
         0x64, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     ];
 
+    #[rustfmt::skip]
     const MSG_ALERT: [u8; 192] = [
         0xf9, 0xbe, 0xb4, 0xd9, 0x61, 0x6c, 0x65, 0x72,
         0x74, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
@@ -148,6 +152,7 @@ mod test {
     fn check_alert_msg(msg: &RawNetworkMessage) {
         assert_eq!(msg.magic, 0xd9b4bef9);
         if let NetworkMessage::Alert(ref alert) = msg.payload {
+            #[rustfmt::skip]
             assert_eq!(alert.clone(), [
                 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
                 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff,

diff --git a/src/util/base58.rs b/src/util/base58.rs
@@ -109,6 +109,7 @@ impl<T: Default + Copy> SmallVec<T> {
 
 static BASE58_CHARS: &[u8] = b"123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
 
+#[rustfmt::skip]
 static BASE58_DIGITS: [Option<u8>; 128] = [
     None,     None,     None,     None,     None,     None,     None,     None,     // 0-7
     None,     None,     None,     None,     None,     None,     None,     None,     // 8-15

diff --git a/src/util/bip32.rs b/src/util/bip32.rs
@@ -1112,6 +1112,7 @@ mod tests {
     pub fn encode_fingerprint_chaincode() {
         use serde_json;
         let fp = Fingerprint::from(&[1u8,2,3,42][..]);
+        #[rustfmt::skip]
         let cc = ChainCode::from(
             &[1u8,2,3,4,5,6,7,8,9,0,1,2,3,4,5,6,7,8,9,0,1,2,3,4,5,6,7,8,9,0,1,2][..]
         );

diff --git a/src/util/key.rs b/src/util/key.rs
@@ -555,13 +555,15 @@ mod tests {
             9b6347398505f5ec93826dc61c19f47c66c0283ee9be980e29ce325a0f4679ef\
             87288ed73ce47fc4f5c79d19ebfa57da7cff3aff6e819e4ee971d86b5e61875d\
         ";
+        #[rustfmt::skip]
         static PK_BYTES: [u8; 33] = [
             0x03,
             0x9b, 0x63, 0x47, 0x39, 0x85, 0x05, 0xf5, 0xec,
             0x93, 0x82, 0x6d, 0xc6, 0x1c, 0x19, 0xf4, 0x7c,
             0x66, 0xc0, 0x28, 0x3e, 0xe9, 0xbe, 0x98, 0x0e,
             0x29, 0xce, 0x32, 0x5a, 0x0f, 0x46, 0x79, 0xef,
         ];
+        #[rustfmt::skip]
         static PK_BYTES_U: [u8; 65] = [
             0x04,
             0x9b, 0x63, 0x47, 0x39, 0x85, 0x05, 0xf5, 0xec,

diff --git a/src/util/taproot.rs b/src/util/taproot.rs
@@ -61,9 +61,11 @@ const MIDSTATE_TAPSIGHASH: [u8; 32] = [
 // f504a425d7f8783b1363868ae3e556586eee945dbc7888dd02a6e2c31873fe9f
 
 /// Internal macro to speficy the different taproot tagged hashes.
-macro_rules! sha256t_hash_newtype {
+// Use of _sha256t_hash_newtype because sha256t_hash_newtype clashes with name of macro in bitcoin_hashes.
+#[rustfmt::skip]                // Long argument list.
+macro_rules! _sha256t_hash_newtype {
     ($newtype:ident, $tag:ident, $midstate:ident, $midstate_len:expr, $docs:meta, $reverse: expr) => {
-        sha256t_hash_newtype!($newtype, $tag, $midstate, $midstate_len, $docs, $reverse, stringify!($newtype));
+        _sha256t_hash_newtype!($newtype, $tag, $midstate, $midstate_len, $docs, $reverse, stringify!($newtype));
     };
 
     ($newtype:ident, $tag:ident, $midstate:ident, $midstate_len:expr, $docs:meta, $reverse: expr, $sname:expr) => {
@@ -85,16 +87,20 @@ macro_rules! sha256t_hash_newtype {
 }
 
 // Taproot test vectors from BIP-341 state the hashes without any reversing
-sha256t_hash_newtype!(TapLeafHash, TapLeafTag, MIDSTATE_TAPLEAF, 64,
+#[rustfmt::skip]
+_sha256t_hash_newtype!(TapLeafHash, TapLeafTag, MIDSTATE_TAPLEAF, 64,
     doc="Taproot-tagged hash for tapscript Merkle tree leafs", false
 );
-sha256t_hash_newtype!(TapBranchHash, TapBranchTag, MIDSTATE_TAPBRANCH, 64,
+#[rustfmt::skip]
+_sha256t_hash_newtype!(TapBranchHash, TapBranchTag, MIDSTATE_TAPBRANCH, 64,
     doc="Taproot-tagged hash for tapscript Merkle tree branches", false
 );
-sha256t_hash_newtype!(TapTweakHash, TapTweakTag, MIDSTATE_TAPTWEAK, 64,
+#[rustfmt::skip]
+_sha256t_hash_newtype!(TapTweakHash, TapTweakTag, MIDSTATE_TAPTWEAK, 64,
     doc="Taproot-tagged hash for public key tweaks", false
 );
-sha256t_hash_newtype!(TapSighashHash, TapSighashTag, MIDSTATE_TAPSIGHASH, 64,
+#[rustfmt::skip]
+_sha256t_hash_newtype!(TapSighashHash, TapSighashTag, MIDSTATE_TAPSIGHASH, 64,
     doc="Taproot-tagged hash for the taproot signature hash", false
 );