From: Matt Corallo <649246+TheBlueMatt@users.noreply.github.com> Date: Thu, 26 Jul 2018 15:54:17 +0000 (-0400) Subject: Merge pull request #84 from savil/sort_outputs X-Git-Tag: v0.0.12~364 X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=fe9bb1d97028d1c0c98972809d12e7129d18356d;hp=27d655fde1ea578b2f0bcc597f3fe0f1cda5518f;p=rust-lightning Merge pull request #84 from savil/sort_outputs [RFC][Tx Sort] Implement sorting of inputs --- diff --git a/Cargo.toml b/Cargo.toml index 2509901a..8add037f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -28,3 +28,6 @@ cc = "1.0" [dev-dependencies.bitcoin] version = "0.13" features = ["bitcoinconsensus"] + +[dev-dependencies] +hex = "0.3.2" diff --git a/src/lib.rs b/src/lib.rs index c0132177..a5e291d3 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,9 +1,10 @@ #![crate_name = "lightning"] extern crate bitcoin; -extern crate secp256k1; -extern crate rand; extern crate crypto; +extern crate rand; +extern crate secp256k1; +#[cfg(test)] extern crate hex; pub mod chain; pub mod ln; diff --git a/src/util/transaction_utils.rs b/src/util/transaction_utils.rs index 8ecd78ac..9ad0b824 100644 --- a/src/util/transaction_utils.rs +++ b/src/util/transaction_utils.rs @@ -1,19 +1,212 @@ -use bitcoin::blockdata::transaction::TxOut; +use bitcoin::blockdata::transaction::{TxIn, TxOut}; use std::cmp::Ordering; -pub fn sort_outputs(outputs: &mut Vec<(TxOut, T)>) { //TODO: Make static and put it in some utils somewhere (+inputs sorting) +pub fn sort_outputs(outputs: &mut Vec<(TxOut, T)>) { outputs.sort_unstable_by(|a, b| { if a.0.value < b.0.value { Ordering::Less } else if b.0.value < a.0.value { Ordering::Greater - } else if a.0.script_pubkey[..] < b.0.script_pubkey[..] { //TODO: ordering of scripts shouldn't be len-based + } else if a.0.script_pubkey[..] < b.0.script_pubkey[..] { Ordering::Less - } else if b.0.script_pubkey[..] < a.0.script_pubkey[..] { //TODO: ordering of scripts shouldn't be len-based + } else if b.0.script_pubkey[..] < a.0.script_pubkey[..] { Ordering::Greater } else { Ordering::Equal } }); } + +pub fn sort_inputs(inputs: &mut Vec<(TxIn, T)>) { + inputs.sort_unstable_by(|a, b| { + if a.0.prev_hash.into_le() < b.0.prev_hash.into_le() { + Ordering::Less + } else if b.0.prev_hash.into_le() < a.0.prev_hash.into_le() { + Ordering::Greater + } else if a.0.prev_index < b.0.prev_index { + Ordering::Less + } else if b.0.prev_index < a.0.prev_index { + Ordering::Greater + } else { + Ordering::Equal + } + }); +} + +#[cfg(test)] +mod tests { + use super::*; + + use bitcoin::blockdata::script::{Script, Builder}; + use bitcoin::blockdata::transaction::TxOut; + use bitcoin::util::hash::Sha256dHash; + + use hex::decode; + + #[test] + fn sort_output_by_value() { + let txout1 = TxOut { + value: 100, + script_pubkey: Builder::new().push_int(0).into_script() + }; + let txout1_ = txout1.clone(); + + let txout2 = TxOut { + value: 99, + script_pubkey: Builder::new().push_int(0).into_script() + }; + let txout2_ = txout2.clone(); + + let mut outputs = vec![(txout1, "ignore"), (txout2, "ignore")]; + sort_outputs(&mut outputs); + + assert_eq!( + &outputs, + &vec![(txout2_, "ignore"), (txout1_, "ignore")] + ); + } + + #[test] + fn sort_output_by_script_pubkey() { + let txout1 = TxOut { + value: 100, + script_pubkey: Builder::new().push_int(3).into_script(), + }; + let txout1_ = txout1.clone(); + + let txout2 = TxOut { + value: 100, + script_pubkey: Builder::new().push_int(1).push_int(2).into_script() + }; + let txout2_ = txout2.clone(); + + let mut outputs = vec![(txout1, "ignore"), (txout2, "ignore")]; + sort_outputs(&mut outputs); + + assert_eq!( + &outputs, + &vec![(txout2_, "ignore"), (txout1_, "ignore")] + ); + } + + #[test] + fn sort_output_by_bip_test() { + let txout1 = TxOut { + value: 100000000, + script_pubkey: script_from_hex("41046a0765b5865641ce08dd39690aade26dfbf5511430ca428a3089261361cef170e3929a68aee3d8d4848b0c5111b0a37b82b86ad559fd2a745b44d8e8d9dfdc0cac") + }; + let txout1_ = txout1.clone(); + + // doesn't deserialize cleanly: + let txout2 = TxOut { + value: 2400000000, + script_pubkey: script_from_hex("41044a656f065871a353f216ca26cef8dde2f03e8c16202d2e8ad769f02032cb86a5eb5e56842e92e19141d60a01928f8dd2c875a390f67c1f6c94cfc617c0ea45afac") + }; + let txout2_ = txout2.clone(); + + let mut outputs = vec![(txout1, "ignore"), (txout2, "ignore")]; + sort_outputs(&mut outputs); + + assert_eq!(&outputs, &vec![(txout1_, "ignore"), (txout2_, "ignore")]); + } + + fn script_from_hex(hex_str: &str) -> Script { + Script::from(decode(hex_str).unwrap()) + } + + macro_rules! bip_txout_tests { + ($($name:ident: $value:expr,)*) => { + $( + #[test] + fn $name() { + let expected_raw: Vec<(u64, &str)> = $value; + let expected: Vec<(TxOut, &str)> = expected_raw.iter() + .map(|txout_raw| TxOut { + value: txout_raw.0, + script_pubkey: script_from_hex(txout_raw.1) + }).map(|txout| (txout, "ignore")) + .collect(); + + let mut outputs = expected.clone(); + outputs.reverse(); // prep it + + // actually do the work! + sort_outputs(&mut outputs); + + assert_eq!(outputs, expected); + } + )* + } + } + + const TXOUT1: [(u64, &str); 2] = [ + (400057456, "76a9144a5fba237213a062f6f57978f796390bdcf8d01588ac"), + (40000000000, "76a9145be32612930b8323add2212a4ec03c1562084f8488ac"), + ]; + const TXOUT2: [(u64, &str); 2] = [ + (100000000, "41046a0765b5865641ce08dd39690aade26dfbf5511430ca428a3089261361cef170e3929a68aee3d8d4848b0c5111b0a37b82b86ad559fd2a745b44d8e8d9dfdc0cac"), + (2400000000, "41044a656f065871a353f216ca26cef8dde2f03e8c16202d2e8ad769f02032cb86a5eb5e56842e92e19141d60a01928f8dd2c875a390f67c1f6c94cfc617c0ea45afac"), + ]; + bip_txout_tests! { + bip69_txout_test_1: TXOUT1.to_vec(), + bip69_txout_test_2: TXOUT2.to_vec(), + } + + macro_rules! bip_txin_tests { + ($($name:ident: $value:expr,)*) => { + $( + #[test] + fn $name() { + let expected_raw: Vec<(&str, u32)> = $value; + let expected: Vec<(TxIn, &str)> = expected_raw.iter().map( + |txin_raw| TxIn { + prev_hash: Sha256dHash::from_hex(txin_raw.0).unwrap(), + prev_index: txin_raw.1, + script_sig: Script::new(), + sequence: 0, + witness: vec![] + } + ).map(|txin| (txin, "ignore")).collect(); + + let mut inputs = expected.clone(); + inputs.reverse(); + + sort_inputs(&mut inputs); + + assert_eq!(expected, inputs); + } + )* + } + } + + const TXIN1_BIP69: [(&str, u32); 17] = [ + ("0e53ec5dfb2cb8a71fec32dc9a634a35b7e24799295ddd5278217822e0b31f57", 0), + ("26aa6e6d8b9e49bb0630aac301db6757c02e3619feb4ee0eea81eb1672947024", 1), + ("28e0fdd185542f2c6ea19030b0796051e7772b6026dd5ddccd7a2f93b73e6fc2", 0), + ("381de9b9ae1a94d9c17f6a08ef9d341a5ce29e2e60c36a52d333ff6203e58d5d", 1), + ("3b8b2f8efceb60ba78ca8bba206a137f14cb5ea4035e761ee204302d46b98de2", 0), + ("402b2c02411720bf409eff60d05adad684f135838962823f3614cc657dd7bc0a", 1), + ("54ffff182965ed0957dba1239c27164ace5a73c9b62a660c74b7b7f15ff61e7a", 1), + ("643e5f4e66373a57251fb173151e838ccd27d279aca882997e005016bb53d5aa", 0), + ("6c1d56f31b2de4bfc6aaea28396b333102b1f600da9c6d6149e96ca43f1102b1", 1), + ("7a1de137cbafb5c70405455c49c5104ca3057a1f1243e6563bb9245c9c88c191", 0), + ("7d037ceb2ee0dc03e82f17be7935d238b35d1deabf953a892a4507bfbeeb3ba4", 1), + ("a5e899dddb28776ea9ddac0a502316d53a4a3fca607c72f66c470e0412e34086", 0), + ("b4112b8f900a7ca0c8b0e7c4dfad35c6be5f6be46b3458974988e1cdb2fa61b8", 0), + ("bafd65e3c7f3f9fdfdc1ddb026131b278c3be1af90a4a6ffa78c4658f9ec0c85", 0), + ("de0411a1e97484a2804ff1dbde260ac19de841bebad1880c782941aca883b4e9", 1), + ("f0a130a84912d03c1d284974f563c5949ac13f8342b8112edff52971599e6a45", 0), + ("f320832a9d2e2452af63154bc687493484a0e7745ebd3aaf9ca19eb80834ad60", 0), + ]; + + + const TXIN2_BIP69: [(&str, u32); 2] = [ + ("35288d269cee1941eaebb2ea85e32b42cdb2b04284a56d8b14dcc3f5c65d6055", 0), + ("35288d269cee1941eaebb2ea85e32b42cdb2b04284a56d8b14dcc3f5c65d6055", 1), + ]; + bip_txin_tests! { + bip69_txin_test_1: TXIN1_BIP69.to_vec(), + bip69_txin_test_2: TXIN2_BIP69.to_vec(), + } +}