Merge #54: Introduce rustfmt

e5030e7 Run formatter in CI (Tobin C. Harding)
5a8ec75 Introduce rustfmt (Tobin C. Harding)

Pull request description:

  As we did in `rust-bitcoin` introduce `rustfmt` by adding configuration options in `rustfmt.toml`.

  Run `rustfmt` on the whole crate.

ACKs for top commit:
  apoelstra:
    ACK e5030e7

Tree-SHA512: 078a75d153e63923e59e23af7851c6829122101f8c660e688ab94c5ac9ce836a9a8bddd95e395b699c2ce06578a85ec4200c218153b0e4b9e4f21a9fbb6328d8

Author: apoelstra

.github/workflows/rust.yml

@@ -104,3 +104,19 @@ jobs:
         with:
           command: clippy
           args: --all-targets -- -D warnings
+
+  Fmt:
+    name: Fmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: true
+      - run: rustup component add rustfmt
+      - uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --check

build.rs

@@ -51,9 +51,7 @@ fn main() {
                 .define("USE_SCALAR_4X64", "1")
                 .define("HAVE___INT128", "1");
         } else {
-            base_config
-                .define("USE_FIELD_10X26", "1")
-                .define("USE_SCALAR_8X32", "1");
+            base_config.define("USE_FIELD_10X26", "1").define("USE_SCALAR_8X32", "1");
         }
     }
 

rustfmt.toml

@@ -1 +1,79 @@
-disable_all_formatting = true
+ignore = []
+
+hard_tabs = false
+tab_spaces = 4
+newline_style = "Auto"
+indent_style = "Block"
+
+max_width = 100 # This is number of characters.
+# `use_small_heuristics` is ignored if the granular width config values are explicitly set.
+use_small_heuristics = "Max"    # "Max" == All granular width settings same as `max_width`.
+# # Granular width configuration settings. These are percentages of `max_width`.
+# fn_call_width = 60
+# attr_fn_like_width = 70
+# struct_lit_width = 18
+# struct_variant_width = 35
+# array_width = 60
+# chain_width = 60
+# single_line_if_else_max_width = 50
+
+wrap_comments = false
+format_code_in_doc_comments = false
+comment_width = 100             # Default 80
+normalize_comments = false
+normalize_doc_attributes = false
+format_strings = false
+format_macro_matchers = false
+format_macro_bodies = true
+hex_literal_case = "Preserve"
+empty_item_single_line = true
+struct_lit_single_line = true
+fn_single_line = true           # Default false
+where_single_line = false
+imports_indent = "Block"
+imports_layout = "Mixed"
+imports_granularity = "Module"     # Default "Preserve"
+group_imports = "StdExternalCrate" # Default "Preserve"
+reorder_imports = true
+reorder_modules = true
+reorder_impl_items = false
+type_punctuation_density = "Wide"
+space_before_colon = false
+space_after_colon = true
+spaces_around_ranges = false
+binop_separator = "Front"
+remove_nested_parens = true
+combine_control_expr = true
+overflow_delimited_expr = false
+struct_field_align_threshold = 0
+enum_discrim_align_threshold = 0
+match_arm_blocks = false        # Default true
+match_arm_leading_pipes = "Never"
+force_multiline_blocks = false
+fn_args_layout = "Tall"
+brace_style = "SameLineWhere"
+control_brace_style = "AlwaysSameLine"
+trailing_semicolon = true
+trailing_comma = "Vertical"
+match_block_trailing_comma = false
+blank_lines_upper_bound = 1
+blank_lines_lower_bound = 0
+edition = "2018"
+version = "One"
+inline_attribute_width = 0
+format_generated_files = true
+merge_derives = true
+use_try_shorthand = false
+use_field_init_shorthand = false
+force_explicit_abi = true
+condense_wildcard_suffixes = false
+color = "Auto"
+required_version = "1.5.1"
+unstable_features = false
+disable_all_formatting = false
+skip_children = false
+hide_parse_errors = false
+error_on_line_overflow = false
+error_on_unformatted = false
+emit_mode = "Files"
+make_backup = false

src/lib.rs

@@ -19,9 +19,10 @@
 
 extern crate libc;
 
-use libc::{c_int,c_uchar, c_uint};
 use core::fmt;
 
+use libc::{c_int, c_uchar, c_uint};
+
 /// Errors returned by `libbitcoinconsensus` (see github.com/bitcoin/bitcoin/doc/shared-libraries.md).
 #[allow(non_camel_case_types)]
 #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
@@ -38,7 +39,7 @@ pub enum Error {
     /// Input amount is required if WITNESS is used.
     ERR_AMOUNT_REQUIRED,
     /// Script verification `flags` are invalid (i.e. not part of the libconsensus interface).
-    ERR_INVALID_FLAGS
+    ERR_INVALID_FLAGS,
 }
 
 impl fmt::Display for Error {
@@ -63,33 +64,33 @@ impl std::error::Error for Error {
         use self::Error::*;
 
         match *self {
-            ERR_SCRIPT
-            | ERR_TX_INDEX
-            | ERR_TX_SIZE_MISMATCH
-            | ERR_TX_DESERIALIZE
-            | ERR_AMOUNT_REQUIRED
-            | ERR_INVALID_FLAGS => None,
+            ERR_SCRIPT | ERR_TX_INDEX | ERR_TX_SIZE_MISMATCH | ERR_TX_DESERIALIZE
+            | ERR_AMOUNT_REQUIRED | ERR_INVALID_FLAGS => None,
         }
     }
 }
 
 /// Do not enable any verification.
-pub const VERIFY_NONE : c_uint = 0;
+pub const VERIFY_NONE: c_uint = 0;
 /// Evaluate P2SH (BIP16) subscripts.
-pub const VERIFY_P2SH : c_uint = 1 << 0;
+pub const VERIFY_P2SH: c_uint = 1 << 0;
 /// Enforce strict DER (BIP66) compliance.
-pub const VERIFY_DERSIG : c_uint = 1 << 2;
+pub const VERIFY_DERSIG: c_uint = 1 << 2;
 /// Enforce NULLDUMMY (BIP147).
-pub const VERIFY_NULLDUMMY : c_uint = 1 << 4;
+pub const VERIFY_NULLDUMMY: c_uint = 1 << 4;
 /// Enable CHECKLOCKTIMEVERIFY (BIP65).
-pub const VERIFY_CHECKLOCKTIMEVERIFY : c_uint = 1 << 9;
+pub const VERIFY_CHECKLOCKTIMEVERIFY: c_uint = 1 << 9;
 /// Enable CHECKSEQUENCEVERIFY (BIP112).
-pub const VERIFY_CHECKSEQUENCEVERIFY : c_uint = 1 << 10;
+pub const VERIFY_CHECKSEQUENCEVERIFY: c_uint = 1 << 10;
 /// Enable WITNESS (BIP141).
-pub const VERIFY_WITNESS : c_uint = 1 << 11;
+pub const VERIFY_WITNESS: c_uint = 1 << 11;
 
-pub const VERIFY_ALL : c_uint = VERIFY_P2SH | VERIFY_DERSIG | VERIFY_NULLDUMMY |
-    VERIFY_CHECKLOCKTIMEVERIFY | VERIFY_CHECKSEQUENCEVERIFY | VERIFY_WITNESS;
+pub const VERIFY_ALL: c_uint = VERIFY_P2SH
+    | VERIFY_DERSIG
+    | VERIFY_NULLDUMMY
+    | VERIFY_CHECKLOCKTIMEVERIFY
+    | VERIFY_CHECKSEQUENCEVERIFY
+    | VERIFY_WITNESS;
 
 extern "C" {
     /// Returns `libbitcoinconsensus` version.
@@ -98,14 +99,15 @@ extern "C" {
     /// Verifies that the transaction input correctly spends the previous
     /// output, considering any additional constraints specified by flags.
     pub fn bitcoinconsensus_verify_script_with_amount(
-        script_pubkey:  *const c_uchar,
+        script_pubkey: *const c_uchar,
         script_pubkeylen: c_uint,
         amount: u64,
         tx_to: *const c_uchar,
         tx_tolen: c_uint,
         n_in: c_uint,
         flags: c_uint,
-        err: *mut Error) -> c_int;
+        err: *mut Error,
+    ) -> c_int;
 }
 
 /// Computes flags for soft fork activation heights on the Bitcoin network.
@@ -132,9 +134,7 @@ pub fn height_to_flags(height: u32) -> u32 {
 }
 
 /// Returns `libbitcoinconsensus` version.
-pub fn version () -> u32 {
-    unsafe { bitcoinconsensus_version() as u32 }
-}
+pub fn version() -> u32 { unsafe { bitcoinconsensus_version() as u32 } }
 
 /// Verifies a single spend (input) of a Bitcoin transaction.
 ///
@@ -174,12 +174,23 @@ pub fn version () -> u32 {
 /// should return `Ok(())`.
 ///
 /// **Note** since the spent amount will only be checked for Segwit transactions and the above example is not segwit, `verify` will succeed with any amount.
-pub fn verify (spent_output: &[u8], amount: u64, spending_transaction: &[u8], input_index: usize) -> Result<(), Error> {
-    verify_with_flags (spent_output, amount, spending_transaction, input_index, VERIFY_ALL)
+pub fn verify(
+    spent_output: &[u8],
+    amount: u64,
+    spending_transaction: &[u8],
+    input_index: usize,
+) -> Result<(), Error> {
+    verify_with_flags(spent_output, amount, spending_transaction, input_index, VERIFY_ALL)
 }
 
 /// Same as verify but with flags that turn past soft fork features on or off.
-pub fn verify_with_flags (spent_output_script: &[u8], amount: u64, spending_transaction: &[u8], input_index: usize, flags: u32) -> Result<(), Error> {
+pub fn verify_with_flags(
+    spent_output_script: &[u8],
+    amount: u64,
+    spending_transaction: &[u8],
+    input_index: usize,
+    flags: u32,
+) -> Result<(), Error> {
     unsafe {
         let mut error = Error::ERR_SCRIPT;
 
@@ -191,7 +202,7 @@ pub fn verify_with_flags (spent_output_script: &[u8], amount: u64, spending_tran
             spending_transaction.len() as c_uint,
             input_index as c_uint,
             flags as c_uint,
-            &mut error
+            &mut error,
         );
         if ret != 1 {
             Err(error)
@@ -205,8 +216,8 @@ pub fn verify_with_flags (spent_output_script: &[u8], amount: u64, spending_tran
 mod tests {
     extern crate rustc_serialize as serialize;
 
-    use super::*;
     use self::serialize::hex::FromHex;
+    use super::*;
 
     #[test]
     fn bitcoinconsensus_test() {
@@ -250,15 +261,17 @@ mod tests {
             "010000000001011f97548fbbe7a0db7588a66e18d803d0089315aa7d4cc28360b6ec50ef36718a0100000000ffffffff02df1776000000000017a9146c002a686959067f4866b8fb493ad7970290ab728757d29f0000000000220020701a8d401c84fb13e6baf169d59684e17abd9fa216c8cc5b9fc63d622ff8c58d04004730440220565d170eed95ff95027a69b313758450ba84a01224e1f7f130dda46e94d13f8602207bdd20e307f062594022f12ed5017bbf4a055a06aea91c10110a0e3bb23117fc014730440220647d2dc5b15f60bc37dc42618a370b2a1490293f9e5c8464f53ec4fe1dfe067302203598773895b4b16d37485cbe21b337f4e4b650739880098c592553add7dd4355016952210375e00eb72e29da82b89367947f29ef34afb75e8654f6ea368e0acdfd92976b7c2103a1b26313f430c4b15bb1fdce663207659d8cac749a0e53d70eff01874496feff2103c96d495bfdd5ba4145e3e046fee45e84a8a48ad05bd8dbb395c011a32cf9f88053ae00000000",
             18393430 , 0
         ).is_err());
-
     }
 
-    fn verify_test (spent : &str, spending :&str, amount :u64, input: usize) -> Result<(),Error> {
-        verify (spent.from_hex().unwrap().as_slice(), amount, spending.from_hex().unwrap().as_slice(), input)
+    fn verify_test(spent: &str, spending: &str, amount: u64, input: usize) -> Result<(), Error> {
+        verify(
+            spent.from_hex().unwrap().as_slice(),
+            amount,
+            spending.from_hex().unwrap().as_slice(),
+            input,
+        )
     }
 
     #[test]
-    fn invalid_flags_test() {
-        verify_with_flags(&[], 0, &[], 0, VERIFY_ALL + 1).unwrap_err();
-    }
+    fn invalid_flags_test() { verify_with_flags(&[], 0, &[], 0, VERIFY_ALL + 1).unwrap_err(); }
 }