_ Git - rust-lightning/blob - src/util/transaction_utils.rs

   1 use bitcoin::blockdata::transaction::{TxIn, TxOut};
   2
   3 use std::cmp::Ordering;
   4
   5 pub fn sort_outputs<T>(outputs: &mut Vec<(TxOut, T)>) {
   6         outputs.sort_unstable_by(|a, b| {
   7                 if a.0.value < b.0.value {
   8                         Ordering::Less
   9                 } else if b.0.value < a.0.value {
  10                         Ordering::Greater
  11                 } else if a.0.script_pubkey[..] < b.0.script_pubkey[..] {
  12                         Ordering::Less
  13                 } else if b.0.script_pubkey[..] < a.0.script_pubkey[..] {
  14                         Ordering::Greater
  15                 } else {
  16                         Ordering::Equal
  17                 }
  18         });
  19 }
  20
  21 pub fn sort_inputs<T>(inputs: &mut Vec<(TxIn, T)>) {
  22         inputs.sort_unstable_by(|a, b| {
  23                 if a.0.previous_output.txid.into_le() < b.0.previous_output.txid.into_le() {
  24                         Ordering::Less
  25                 } else if b.0.previous_output.txid.into_le() < a.0.previous_output.txid.into_le() {
  26                         Ordering::Greater
  27                 } else if a.0.previous_output.vout < b.0.previous_output.vout {
  28                         Ordering::Less
  29                 } else if b.0.previous_output.vout < a.0.previous_output.vout {
  30                         Ordering::Greater
  31                 } else {
  32                         Ordering::Equal
  33                 }
  34         });
  35 }
  36
  37 #[cfg(test)]
  38 mod tests {
  39         use super::*;
  40
  41         use bitcoin::blockdata::script::{Script, Builder};
  42         use bitcoin::blockdata::transaction::{TxOut, OutPoint};
  43         use bitcoin::util::hash::Sha256dHash;
  44
  45         use hex::decode;
  46
  47         #[test]
  48         fn sort_output_by_value() {
  49                 let txout1 = TxOut {
  50                         value:  100,
  51                         script_pubkey: Builder::new().push_int(0).into_script()
  52                 };
  53                 let txout1_ = txout1.clone();
  54
  55                 let txout2 = TxOut {
  56                         value: 99,
  57                         script_pubkey: Builder::new().push_int(0).into_script()
  58                 };
  59                 let txout2_ = txout2.clone();
  60
  61                 let mut outputs = vec![(txout1, "ignore"), (txout2, "ignore")];
  62                 sort_outputs(&mut outputs);
  63
  64                 assert_eq!(
  65                         &outputs,
  66                         &vec![(txout2_, "ignore"), (txout1_, "ignore")]
  67                         );
  68         }
  69
  70         #[test]
  71         fn sort_output_by_script_pubkey() {
  72                 let txout1 = TxOut {
  73                         value:  100,
  74                         script_pubkey: Builder::new().push_int(3).into_script(),
  75                 };
  76                 let txout1_ = txout1.clone();
  77
  78                 let txout2 = TxOut {
  79                         value: 100,
  80                         script_pubkey: Builder::new().push_int(1).push_int(2).into_script()
  81                 };
  82                 let txout2_ = txout2.clone();
  83
  84                 let mut outputs = vec![(txout1, "ignore"), (txout2, "ignore")];
  85                 sort_outputs(&mut outputs);
  86
  87                 assert_eq!(
  88                         &outputs,
  89                         &vec![(txout2_, "ignore"), (txout1_, "ignore")]
  90                         );
  91         }
  92
  93         #[test]
  94         fn sort_output_by_bip_test() {
  95                 let txout1 = TxOut {
  96                         value: 100000000,
  97                         script_pubkey: script_from_hex("41046a0765b5865641ce08dd39690aade26dfbf5511430ca428a3089261361cef170e3929a68aee3d8d4848b0c5111b0a37b82b86ad559fd2a745b44d8e8d9dfdc0cac")
  98                 };
  99                 let txout1_ = txout1.clone();
 100
 101                 // doesn't deserialize cleanly:
 102                 let txout2 = TxOut {
 103                         value: 2400000000,
 104                         script_pubkey: script_from_hex("41044a656f065871a353f216ca26cef8dde2f03e8c16202d2e8ad769f02032cb86a5eb5e56842e92e19141d60a01928f8dd2c875a390f67c1f6c94cfc617c0ea45afac")
 105                 };
 106                 let txout2_ = txout2.clone();
 107
 108                 let mut outputs = vec![(txout1, "ignore"), (txout2, "ignore")];
 109                 sort_outputs(&mut outputs);
 110
 111                 assert_eq!(&outputs, &vec![(txout1_, "ignore"), (txout2_, "ignore")]);
 112         }
 113
 114         fn script_from_hex(hex_str: &str) -> Script {
 115                 Script::from(decode(hex_str).unwrap())
 116         }
 117
 118         macro_rules! bip_txout_tests {
 119                 ($($name:ident: $value:expr,)*) => {
 120                         $(
 121                                 #[test]
 122                                 fn $name() {
 123                                         let expected_raw: Vec<(u64, &str)> = $value;
 124                                         let expected: Vec<(TxOut, &str)> = expected_raw.iter()
 125                                                 .map(|txout_raw| TxOut {
 126                                                         value: txout_raw.0,
 127                                                         script_pubkey: script_from_hex(txout_raw.1)
 128                                                 }).map(|txout| (txout, "ignore"))
 129                                         .collect();
 130
 131                                         let mut outputs = expected.clone();
 132                                         outputs.reverse(); // prep it
 133
 134                                         // actually do the work!
 135                                         sort_outputs(&mut outputs);
 136
 137                                         assert_eq!(outputs, expected);
 138                                 }
 139                         )*
 140                 }
 141         }
 142
 143         const TXOUT1: [(u64, &str); 2] = [
 144                 (400057456, "76a9144a5fba237213a062f6f57978f796390bdcf8d01588ac"),
 145                 (40000000000, "76a9145be32612930b8323add2212a4ec03c1562084f8488ac"),
 146         ];
 147         const TXOUT2: [(u64, &str); 2] = [
 148                 (100000000, "41046a0765b5865641ce08dd39690aade26dfbf5511430ca428a3089261361cef170e3929a68aee3d8d4848b0c5111b0a37b82b86ad559fd2a745b44d8e8d9dfdc0cac"),
 149                 (2400000000, "41044a656f065871a353f216ca26cef8dde2f03e8c16202d2e8ad769f02032cb86a5eb5e56842e92e19141d60a01928f8dd2c875a390f67c1f6c94cfc617c0ea45afac"),
 150         ];
 151         bip_txout_tests! {
 152                 bip69_txout_test_1: TXOUT1.to_vec(),
 153                 bip69_txout_test_2: TXOUT2.to_vec(),
 154         }
 155
 156         macro_rules! bip_txin_tests {
 157                 ($($name:ident: $value:expr,)*) => {
 158                         $(
 159                                 #[test]
 160                                 fn $name() {
 161                                         let expected_raw: Vec<(&str, u32)> = $value;
 162                                         let expected: Vec<(TxIn, &str)> = expected_raw.iter().map(
 163                                                 |txin_raw| TxIn {
 164                                                         previous_output: OutPoint {
 165                                                                 txid: Sha256dHash::from_hex(txin_raw.0).unwrap(),
 166                                                                 vout: txin_raw.1,
 167                                                         },
 168                                                         script_sig: Script::new(),
 169                                                         sequence: 0,
 170                                                         witness: vec![]
 171                                                 }
 172                                                 ).map(|txin| (txin, "ignore")).collect();
 173
 174                                         let mut inputs = expected.clone();
 175                                         inputs.reverse();
 176
 177                                         sort_inputs(&mut inputs);
 178
 179                                         assert_eq!(expected, inputs);
 180                                 }
 181                         )*
 182                 }
 183         }
 184
 185         const TXIN1_BIP69: [(&str, u32); 17] = [
 186                 ("0e53ec5dfb2cb8a71fec32dc9a634a35b7e24799295ddd5278217822e0b31f57", 0),
 187                 ("26aa6e6d8b9e49bb0630aac301db6757c02e3619feb4ee0eea81eb1672947024", 1),
 188                 ("28e0fdd185542f2c6ea19030b0796051e7772b6026dd5ddccd7a2f93b73e6fc2", 0),
 189                 ("381de9b9ae1a94d9c17f6a08ef9d341a5ce29e2e60c36a52d333ff6203e58d5d", 1),
 190                 ("3b8b2f8efceb60ba78ca8bba206a137f14cb5ea4035e761ee204302d46b98de2", 0),
 191                 ("402b2c02411720bf409eff60d05adad684f135838962823f3614cc657dd7bc0a", 1),
 192                 ("54ffff182965ed0957dba1239c27164ace5a73c9b62a660c74b7b7f15ff61e7a", 1),
 193                 ("643e5f4e66373a57251fb173151e838ccd27d279aca882997e005016bb53d5aa", 0),
 194                 ("6c1d56f31b2de4bfc6aaea28396b333102b1f600da9c6d6149e96ca43f1102b1", 1),
 195                 ("7a1de137cbafb5c70405455c49c5104ca3057a1f1243e6563bb9245c9c88c191", 0),
 196                 ("7d037ceb2ee0dc03e82f17be7935d238b35d1deabf953a892a4507bfbeeb3ba4", 1),
 197                 ("a5e899dddb28776ea9ddac0a502316d53a4a3fca607c72f66c470e0412e34086", 0),
 198                 ("b4112b8f900a7ca0c8b0e7c4dfad35c6be5f6be46b3458974988e1cdb2fa61b8", 0),
 199                 ("bafd65e3c7f3f9fdfdc1ddb026131b278c3be1af90a4a6ffa78c4658f9ec0c85", 0),
 200                 ("de0411a1e97484a2804ff1dbde260ac19de841bebad1880c782941aca883b4e9", 1),
 201                 ("f0a130a84912d03c1d284974f563c5949ac13f8342b8112edff52971599e6a45", 0),
 202                 ("f320832a9d2e2452af63154bc687493484a0e7745ebd3aaf9ca19eb80834ad60", 0),
 203         ];
 204
 205
 206         const TXIN2_BIP69: [(&str, u32); 2] = [
 207                 ("35288d269cee1941eaebb2ea85e32b42cdb2b04284a56d8b14dcc3f5c65d6055", 0),
 208                 ("35288d269cee1941eaebb2ea85e32b42cdb2b04284a56d8b14dcc3f5c65d6055", 1),
 209         ];
 210         bip_txin_tests! {
 211                 bip69_txin_test_1: TXIN1_BIP69.to_vec(),
 212                 bip69_txin_test_2: TXIN2_BIP69.to_vec(),
 213         }
 214 }