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